Payment Error (paymentError)

Sent when a payment has been rejected.

Id: paymentError

Event that notifies when a payment has been rejected.

Payload

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

Name	Type	Description
paymentId	string	Our id for the payment
paymentSubmissionId	string	The id of the payment submission
submittedAt	string	The time the payment was submitted to the bank
status	string	Always `rejected` for this event
reference	string	The payment reference
endToEndId	string	Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain.
updatedAt	string	Optional. The time the payment was updated by the bank. This value comes from the bank and, depending on the bank, may be the same as `submittedAt`

Example (JSON format)

{
  "id": "abe168ce-1b2f-4c38-9c92-db5730485cb3",
  "eventType": "paymentError",
  "userId": "5c79210bbac25ecb5e71ac40",
  "payload": {
    "paymentId": "68ef34e0-b8a7-4aa2-ad0a-b3cef33f8e36",
    "paymentSubmissionId": "pv3-966167ee-a63e-464b-90ed-d779fa90c246",
    "submittedAt": "2020-09-21T15:41:20.500Z",
    "reference": "0019f234124a5f70",
    "endToEndId": "1b63a27a",
    "status": "rejected"
  }
}

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.

Updated about 21 hours ago