Payment Status Update Webhook

Webhook Overview

This webhook is called by our payment gateway to inform you of payment status changes, prior to our payments frontend redirecting the customer back to the given return URL, as specified in the initiate-payment-transaction request body.

Event Properties

eventType

• Type: const
• Enum: required
• Description: This will be set to: PaymentStatus

transactionId

• Type: string
• Required: Yes
• Description: A unique ID for the payment transaction.

transactionReference

• Type: string
• Required: Yes
• Description: An 18 character payment transaction reference allocated by us, used/visible on the associated bank transaction.

transactionStatus

• Type: string
• Enum: required
• Description: The payment status of the given payment transaction, specified by the super-transaction_id field above. The payment status can be one of:
  • PaymentSuccess: The payment transaction was successful, money has moved from the customer to your holding account.
  • PaymentCancelled: The payment transaction was cancelled by the customer, in their banking app.
  • PaymentFailed: The payment transaction failed due to a technical error, either on our side or with the customer's bank.
  • PaymentDelayed: The payment transaction was not resolved by the bank within 15 seconds (<2% of transactions). Open banking can take up to 4 hours to resolve. The customer has the funds, but this is usually due to additional fraud checks within the banking system.
  • PaymentAbandoned: The payment transaction was abandoned by the customer. They closed the browser or just left the page open without explicitly clicking cancel.

transactionAmount

• Type: integer
• Required: Yes
• Description: The payment transaction amount in minor units.

externalReference

• Type: string
• Description: Your unique reference for the payment transaction e.g. your orderId.

Response

Return a 200 status to indicate that the data was received successfully, any other response will be deemed a failure and retried.