Payment Order webhooks are triggered when the status of a payment changes. This includes the creation of a payment.
We will send you all the payment details so that you have maximum context for powering business processes.
| Event Type | Description |
|---|---|
| payment_order_approval_required | The payment needs to be approved before it is processed. |
| payment_order_approved | The payment has been approved by a user. |
| payment_order_cancelled | The user has cancelled the payment. |
| payment_order_declined | The payment was not approved by a user. |
| payment_order_failed | The payment order failed to be created as the bank had issues. |
| payment_order_completed | The payment order has been executed by the bank. |
| payment_order_rejected | The payment order has been rejected by the bank due to incorrect information |
Example notification:
{
"id": "pay_r28xivvv1sb9e1xt1uj0v8aiyc",
"entity_id": "ent_bjec24xmzi4tr4g7m4lliotzz4",
"source_account_id": "acc_atfgyrg34hws7gidwwxqi2haie",
"amount": {
"value": "100",
"currency": "GBP"
},
"reference": "reference123",
"type": "string",
"destination_account": {
"payee_id": "pye_av5g7vqt4y76ibrqbs5vjslphe"
},
"is_test_payment": true,
"status": "approval_required",
"created_at": "2023-09-19T08:36:20.126Z",
"created_by": "usr_ayd8lpm5z2b0xt6gwqo9yr4afc",
"updated_at": "2023-09-20T08:36:20.126Z",
"updated_by": "usr_ayd7k8l2m5z9b0x6t4w1qo5r7a8c",
"reason": "xyz"
}