Payment webhooks
For information on which payment webhooks Adyen sends for internal transfer-related events, see Payment webhooks (deprecated).
When an internal transfer is triggered between balance accounts in your marketplace, Adyen sends two kinds of webhooks:
- balancePlatform.transfer.created, which informs your server that funds will be transferred between balance accounts in your marketplace.
- balancePlatform.transfer.updated, which informs your server of the transfer status changes.
We send these webhooks for both (source and target) balance accounts involved in the transfer.
To keep track of internal transfer-related events in your marketplace, make sure that:
- Your server can receive and accept webhooks.
- You subscribed to the Transfer webhooks in your Balance Platform Customer Area.
You can identify transfer webhooks triggered by internal transfer events by the following values:
| Parameter | Description | Value |
|---|---|---|
| category | Specifies the category of the transfer. | internal |
| direction | The direction of the transfer based on the balance account. | Source account: outgoing Target account: incoming |
| type | Specifies the type of the transfer. | internalTransfer |
The following sections contain examples of the webhooks you would receive for the following transfer request:
Internal transfer initiated
After a scheduled or manual transfer is triggered, Adyen sends a balancePlatform.transfer.created webhook to inform your server that funds will be transferred between balance accounts in your marketplace. The webhook provides information about the transfer, such as the amount, the transfer and beneficiary references, information on the account holder involved in the transfer, and which are the source and target balance accounts.
When an internal transfer is initiated, Adyen sends a balancePlatform.transfer.created webhook to inform your server that funds will be deducted from a balance account in your marketplace.
Internal transfer authorised
When the internal transfer is authorised, Adyen sends a balancePlatform.transfer.updated webhooks to inform your server that the transfer amount has been reserved on the balance accounts.
Internal transfer booked
When the funds are booked, Adyen sends balancePlatform.transfer.updated webhooks with status booked and the transactionId for both balance accounts.
When the funds are deducted from the source balance account, Adyen sends a balancePlatform.transfer.updated webhook with:
direction: outgoingstatus: bookedcounterparty.balanceAccountId: ID of target balance accounttransactionId: ID of the transaction
Internal transfer returned
If needed, you can return the received funds to the counterparty balance account. The following is an example for a return request.
The following tabs contain examples of the webhooks you would receive for the return request.
When you request a return, the account that previously received the funds now becomes the source balance account. The following subsections show the webhooks that you would receive for the source account.
Return initiated
When a return is initiated, Adyen sends a balancePlatform.transfer.updated webhook to inform your server that funds will be deducted from the source balance account. The return data is included in a new event with modification.type return.
Return authorised
When the return is authorised, Adyen sends a balancePlatform.transfer.updated webhook to inform your server that the return amount has been reserved on the source balance account.
Return booked
When the returned funds are deducted, Adyen sends a balancePlatform.transfer.updated webhook with status booked and the transactionId.