POST /balanceTransfer
Starts a balance transfer request between merchant accounts. The following conditions must be met before you can successfully transfer balances:
-
The source and destination merchant accounts must be under the same company account and legal entity.
-
The source merchant account must have sufficient funds.
-
The source and destination merchant accounts must have at least one common processing currency.
When sending multiple API requests with the same source and destination merchant accounts, send the requests sequentially and not in parallel. Some requests may not be processed if the requests are sent in parallel.
Servers
- https://pal-test.adyen.com/pal/servlet/BalanceControl/v1
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
fromMerchant |
String | Yes |
The unique identifier of the source merchant account from which funds are deducted. |
description |
String | No |
A human-readable description for the transfer. You can use alphanumeric characters and hyphens. We recommend sending a maximum of 140 characters, otherwise the description may be truncated. |
amount |
Object | Yes |
The amount of the transfer in minor units. |
amount.value |
Integer | Yes |
The amount of the transaction, in minor units. |
amount.currency |
String | Yes |
The three-character ISO currency code. |
toMerchant |
String | Yes |
The unique identifier of the destination merchant account from which funds are transferred. |
type |
String | Yes |
The type of balance transfer. Possible values: tax, fee, terminalSale, credit, debit, and adjustment. Possible values:
|
reference |
String | No |
A reference for the balance transfer. If you don't provide this in the request, Adyen generates a unique reference. Maximum length: 80 characters. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.