For each payment your users receive, your pay-in partner can withhold funds: either directly or to offset the bank costs of the payout. As a result, there can be a discrepancy between the amount settled in your multi pay-in account and the total amount that you want to allocate to your users. In this case, you can top up the balance of your multi pay-in account from your liable balance account by making an internal transfer.
Requirements
Take into account the following requirements for this operation.
| Requirement | Description |
|---|---|
| API credentials | You must have credentials for the Transfers API. |
| Webhooks | Subscribe to any of the following webhooks: |
Top up your balance
To top up the balance of your multi pay-in account, make a POST /transfers request.
In the body of the request, specify the following parameters:
| Parameter | Required | Description |
|---|---|---|
| amount |  |
An object containing the currency and value of the top up. |
| balanceAccountId | |
The unique identifier of your liable balance account. |
| counterparty.balanceAccountId | |
The unique identifier of your multi pay-in account. |
| category | |
Specifies the category of the transfer. Set to internal. |
| description | Your description of the transfer. You can use this to identify the transfer in webhooks and reports. | |
| reference | Your unique reference for the transfer. You can use this to identify the transfer in webhooks and reports. |
The following example shows how to top up your multi pay-in account with USD 2.40. The funds are transferred from your liable balance account.
In the response, the status field shows the whether the top-up was successful (authorised).
If the status is not authorised, check the type field to learn why the request failed. For example, the reason for a refused status can be notEnoughBalance.
We also send webhooks to notify you of the status of the top-up request.
Get notified about balance changes
After you send a request to transfer funds from your liable balance account to your multi pay-in account, we send the following webhooks to notify you of the status of the transfer or transaction:
| Webhook | Description |
|---|---|
| balancePlatform.transfer.created | Notifies you of the incoming and outgoing fund transfer. |
| balancePlatform.transfer.updated | Notifies you of the changes in the status of the transfer. |
| balancePlatform.transaction.created | Notifies you when the funds debited from your liable balance account and are credited to your multi pay-in account. |
Subscribe to the webhooks you want to receive in your Customer Area.
Webhooks for an internal transfer
You can identify transfer webhooks triggered by a request to top up your multi pay-in account by the following values:
| Parameter | Description | Value |
|---|---|---|
| category | Specifies the category of the transfer. | internal |
| direction | Specifies the direction of the transfer. | outgoing for your liable balance account incoming for your multi pay-in account |
| type | Specifies the type of the transfer. | internalTransfer |
The following examples show the webhooks you receive when you top up your multi pay-in account with USD 2.40 from your liable balance account.