Transfer Notifications
With internal transfer webhook, you can receive real-time notifications to your system about key internal transfer events, such as initiation, completion, or failure, enabling automated updates without manual intervention.
See Create a Webhook Listener to learn how to configure a webhook.
Webhook Type
In the internal transfer workflow you should expect to receive the following webhooks:
Event | Description |
---|---|
bvnk:payment:transfer:status-change | The transfer has transitioned to a new state. |
Data Types
Field | Description |
---|---|
| Type of event triggering the webhook. |
| Unique identifier for the event. |
| Timestamp of when the event occurred. |
| Status of the transfer. |
| Customer-specific reference for the transaction. Optional. |
| Unique reference for the transaction. |
| Reference code for the payment. |
| Date the transaction was valued. |
| Value of the transaction amount. |
| Currency code of the transaction amount. |
| Value of the transaction fee. |
| Currency code of the transaction fee. |
| Wallet ID of the sender / originator. |
| Unique reference for the account of the sender. |
| Type of the sender entity. Possible values:
|
| Name of the sender for companies. |
| First name of the sender for individuals. |
| Last name of the sender for individuals. |
| Wallet ID of the beneficiary (recipient). |
| Unique reference for the account of the beneficiary. |
| Type of beneficiary entity. |
| Name of the beneficiary for companies. |
| First name of the beneficiary for individuals. |
| Last name of the beneficiary for individuals. |
Webhook Example
{
"event": "bvnk:payment:transfer:status-change",
"eventId": "0193ba8c-74f4-7bd3-a2fb-00e43851577c",
"timestamp": "2024-12-12T11:06:27.444216650Z",
"data": {
"fee": {
"value": 0,
"currencyCode": "EUR"
},
"amount": {
"value": 10,
"currencyCode": "EUR"
},
"status": "COMPLETED",
"valueDate": "2024-12-12",
"originator": {
"entity": {
"type": "INDIVIDUAL",
"lastName": "John",
"firstName": "Doe"
},
"walletId": "a:24103136208222:wSFXcWf:1",
"accountReference": "3399c975-e1c1-4acf-9a90-6cfbdcdeaaea"
},
"beneficiary": {
"entity": {
"name": "Test Ltd",
"type": "COMPANY"
},
"walletId": "a:24082935226274:do8hboJ:1",
"accountReference": "3399c975-e1c1-4acf-9a90-6cfbdcdeaaea"
},
"paymentReference": "REF124903",
"transactionReference": "13584355-b879-11ef-982c-e1c33615f5a8"
}
}
Updated about 1 month ago