Sign in

v1

latestOpenAPI 3.1.02026-07-14137.8 KB
General

Start a balance transfer

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.

post/balanceTransfer

Request body

descriptionstring

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.

fromMerchantstring required

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

referencestring

A reference for the balance transfer. If you don't provide this in the request, Adyen generates a unique reference. Maximum length: 80 characters.

toMerchantstring required

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

type'tax' | 'fee' | 'terminalSale' | 'credit' | 'debit' | 'adjustment' required

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

Response

OK - the request has succeeded.

createdAtstring date-time required

The date when the balance transfer was requested.

descriptionstring

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.

fromMerchantstring required

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

pspReferencestring required

Adyen's 16-character string reference associated with the balance transfer.

referencestring

A reference for the balance transfer. If you don't provide this in the request, Adyen generates a unique reference. Maximum length: 80 characters.

status'error' | 'failed' | 'notEnoughBalance' | 'transferred' required

The status of the balance transfer. Possible values: transferred, failed, error, and notEnoughBalance.

toMerchantstring required

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

type'tax' | 'fee' | 'terminalSale' | 'credit' | 'debit' | 'adjustment' required

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

All 1 operations