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 | Description |
|---|---|
| created | A payment order has been created. |
| sent | A payment order has begun processing and it is sent to the bank. Payment orders will no longer be editable after this point. |
| accepted | A payment order has been accepted by the bank and it is pending to be executed. |
| completed | A payment order has been executed by the bank. |
| rejected | The payment order has been rejected by the bank due to incorrect information |
| failed | A payment order failed to be created. |
| cancelled | A payment order has been cancelled. |
Example notification:
{
"id": "pay_r28xivvv1sb9e1xt1uj0v8aiyc",
"entity_id": "ent_bjec24xmzi4tr4g7m4lliotzz4",
"status": "accepted",
"source_id": "acc_atfgyrg34hws7gidwwxqi2haie",
"amount": {
"value": "100",
"currency": "GBP"
},
"reference": "reference123",
"destination_account": {
"account_holder_details": {
"name": "Jon Doe",
"address": "123 Main St, Anytown, United Kingdom, AB1 2CD",
"email_address": "[email protected]"
},
"bank_details": {
"type": "SCAN",
"account_number": "12345678",
"sort_code": "12-34-56",
"bank_address": "1 High Street, Town, City, AB1 2CD"
}
},
"source_account_id": "acc_buqtzoruk7x44iqdn3zmxt26iu",
"created_at": "2022-10-25T00:00:00.000Z"
}