Webhook Notifications

We will send a status_update webhook to update your application of the status of the payment.

In order to send webhook notifications, you must add the webhook_url parameter to the confirmParams component when the session_id is generated.

confirmParams:

webhook_url: 'https:/www.yourdomain.com/webhook'

status_update webhook:

{
  "webhook_type": "status_update",
  "webhook_id": "113eeb0e-483e-4fc5-b1b3-4de99e3a9a6f",
  "webhook_body": {
    "transaction_id": "10ef7f23-2f7b-46d8-af40-fc9846ff59bf",
    "status": "success",
    "timestamp": 32908394083,
    "order_id": "6112dfb4-81de-460e-ad39-7037677d6148"
  }
}

We will also send a card_new webhook, when a card is successfully created following authorisation.

card_new

{
  "webhook_type": "card_new",
  "webhook_id": "d68a7a29-47ce-43ea-bad3-0e4a35c5f09c",
  "timestamp": 1684254231,
  "webhook_body": {
    "transaction_id": "0e789cf6-7e7a-3c55-870c-e69325975134",
    "status": "success",
    "order_id": "J97C6572ddt223-952",
    "card_id": "77e595b6-686b-724b-6340-6c8ee0123778"
  }
}

For further information on webhooks, including the structure and validating the integrity of a webhook, please view our documentation.