Webhooks: Payments

Overview

• Payment webhooks allow clients to receive real-time notifications about the status and progression of their payment transactions.
• Once a payment intent is created, the platform will send webhook callbacks to the URLs provided by the client.

Note: We do not modify, transform, or alter in any way the webhook URLs received from clients. The exact URL provided in the intent creation request is the one used for all webhook callbacks.

Type "Payment status updates"

• Sent when a payment status changes (e.g., ACCEPTED, DECLINED, ERROR). Not only terminal statuses, but all. Full status model is available on the link
• Triggered By: Internal processing events after payment intent creation.
• Client must provide URL in: payments[].webhookUrl inside the request: POST /processing/api/v1/intents

Example:

{  
  "transactionType": "PAYMENT",
  "transactionId": "111122223333444455",
	"status": "ACCEPTED"
}

{
  "transactionType": "PAYMENT",
  "transactionId": "111122223333444455",
  "status": "ERROR",
  "errorCode": "CODE_PT0000",
  "errorMessage": "string"
}

Fields Description

Some webhooks may contain additional data. The inclusion of this additional data depends on the payment method and may or may not be present in the request.

{
  "transactionType": "PAYMENT",
  "transactionId": "111122223333444455",
  "status": "CAPTURED",
  "additionalData": {
    "PaymentMethodAdditionalField": "string",
    "PaymentMethodAdditionalField": "string",
    "PaymentMethodAdditionalField": "string"
  }
}