Listening for Internal Transfer Webhooks

An internal transfer webhook sends real-time notifications to your system about key internal transfer events between Principle and Underlying wallets, such as initiation, completion, or failure, enabling automated updates without manual intervention.

Webhook Types

In the 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
event	The type of event triggering the webhook.
status	The current status of the event.
eventId	A unique identifier for the event.
timestamp	The timestamp of when the event occurred.
data.status	The status of the payment transfer.
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.entity.type	The type of originator entity.
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.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 Examples

For example:

{
    "event":"bvnk:payment:transfer:status-change",
    "status":"successful",
    "eventId":"4d9f2f80-7f4d-11ee-8c99-0242ac120002",
    "timestamp":"2024-10-28 09:25:21.716405",
    "data":{
       "status":"SUCCESSFUL",
       "transactionReference":"fd808a48-7313-4773-8383-fffb62fdc2d7",
       "paymentReference":"GBPCLEAREXTERNALPA",
       "valueDate":"2024-09-12",
       "amount":{
         "value":39,
         "currencyCode":"EUR"
      },
      "fee":{
         "value":0,
         "currencyCode":"EUR"
      },
       "originator":{
          "walletId":"a:24100329448329:gKboHRk:1",
          "entity":{
            "type":"COMPANY",
            "name":"Some Business",  //for company
            "firstName":"John", //for individual
            "lastName":"Doe", //for individual
         }
       },
       "beneficiary":{
          "walletId":"a:24100844912857:Ji108eZ:1",
          "entity":{
            "type":"COMPANY",
            "name":"Some Business",  //for company
            "firstName":"John", //for individual
            "lastName":"Doe", //for individual
         }
       }
    }
 }