Performs a balance transfer

post/balanceTransfers

API Version

Performs a balance transfer 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.\n\n 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.

Endpoint destination URL

Request Parameters

Required

Optional

The amount of the transfer.

Min length: 1

The unique identifier of the source merchant account from which funds are deducted.

Max length: 80

A reference for the balance transfer. Maximum length: 80 characters.

Min length: 1

The unique identifier of the destination merchant account to which funds are transferred.

The type of balance transfer. Possible values: tax, fee, terminalSale, credit, debit, and adjustment.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

200 - OK
The request has succeeded.
createdAtstring
The date when the balance transfer was performed.
pspReferencestring
Adyen's 16-character string reference associated with the balance transfer.
401
Unauthorized
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.
422 - Unprocessable Content
A request validation error.
detailstring
A human-readable explanation specific to this occurrence of the problem.
errorCodestring
Unique business error code.
instancestring
A URI that identifies the specific occurrence of the problem if applicable.
invalidFieldsarray[object]
Array of fields with validation errors when applicable.
messagestring
Description of the validation error.
namestring
The field that has an invalid value.
valuestring
The invalid value.
requestIdstring
The unique reference for the request.
statusinteger
The HTTP status code.
titlestring
A short, human-readable summary of the problem type.
typestring
A URI that identifies the validation error type. It points to human-readable documentation for the problem type.

Performs a balance transfer

HTTP Responses

200 - OK

401

422 - Unprocessable Content