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 Types

In the internal transfer workflow you should expect to receive the following webhooks:

EventDescription
bvnk:payment:transfer:status-changeThe transfer has transitioned to a new state.

Data Types

Field

Description

event

The type of event triggering the webhook.

eventId

A unique identifier for the event.

timestamp

The timestamp of when the event occurred.

data.status

The status of the transfer.

data.customerReference

A customer-specific reference for the transaction (optional).

data.transactionReference

A unique reference for the transaction.

data.paymentReference

A reference code for the payment.

data.valueDate

The date the transaction was valued.

data.amount.value

The value of the transaction amount.

data.amount.currencyCode

The currency code of the transaction amount.

data.fee.value

The value of the transaction fee.

data.fee.currencyCode

The currency code of the transaction fee.

data.originator.walletId

The wallet ID of the originator.

data.originator.accountReference

A unique reference for the account of the originator.

data.originator.entity.type

The type of originator entity.

Possible values:

  • INDIVIDUAL
  • COMPANY

data.originator.entity.name

The name of the originator (for companies).

data.originator.entity.firstName

The first name of the originator (for individuals).

data.originator.entity.lastName

The last name of the originator (for individuals).

data.beneficiary.walletId

The wallet ID of the beneficiary.

data.beneficiary.accountReference

A unique reference for the account of the beneficiary.

data.beneficiary.entity.type

The type of beneficiary entity.

data.beneficiary.entity.name

The name of the beneficiary (for companies).

data.beneficiary.entity.firstName

The first name of the beneficiary (for individuals).

data.beneficiary.entity.lastName

The 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"
   }
}