Payment Submitted (paymentSubmitted)

Sent when a payment has been submitted after the user authorises it.

Id: paymentSubmitted

Event that notifies when a payment has been submitted after the user authorises it.

A submitted payment can still fail later, for example after checks at the bank. Later status changes are sent as paymentPending, paymentCompleted, or paymentError.

Payload

These fields are sent in the payload object of the webhook envelope.

NameTypeDescription
paymentIdstringOur id for the payment
authRequestIdstringThe id of the authorisation request

Example (JSON format)

{
  "id": "abe168ce-1b2f-4c38-9c92-db5730485cb3",
  "eventType": "paymentSubmitted",
  "userId": "5c79210bbac25ecb5e71ac40",
  "payload": {
    "paymentId": "68ef34e0-b8a7-4aa2-ad0a-b3cef33f8e36",
    "authRequestId": "5f3c1a2e-8b44-4d1a-9c77-2a1e0b6d4f21"
  }
}

This example uses the JSON format. JWT webhooks carry the same payload fields in a different envelope, and batched webhooks list events without payloads. See Webhook Format.