Sign in

v1

latestOpenAPI 3.0.22026-07-2667277423.4 KB
Platform Model

Balance: Transfer

Transfers funds from the currently authenticated merchant's balance to another associated merchant for the given currency.

post/balances/{currency}/transfer

Path parameters

currency'JPY' | 'USD' | 'EUR' | 'TWD' | 'KRW' | 'PLN' | 'GBP' | 'HKD' | 'SGD' | 'NZD' | 'AUD' | 'IDR' | 'MYR' | 'PHP' | 'THB' | 'CNY' | 'BRL' | 'CHF' | 'CAD' | 'VND' required

3-letter ISO currency code.

Example:JPY

Request body

amountinteger required

Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).

tostring required

Response

200 response

typestring required

The type identifier for this transfer record.

recipientstring required

Identifier of the merchant receiving the funds.

remitterstring required

Identifier of the merchant sending the funds.

amountinteger required

Amount greater than or equal to 0, in the lowest denomination of the currency (e.g. cents for USD).

currency'JPY' | 'USD' | 'EUR' | 'TWD' | 'KRW' | 'PLN' | 'GBP' | 'HKD' | 'SGD' | 'NZD' | 'AUD' | 'IDR' | 'MYR' | 'PHP' | 'THB' | 'CNY' | 'BRL' | 'CHF' | 'CAD' | 'VND' required

3-letter ISO currency code.

happened_atstring date-time required

Timestamp when the transfer occurred.

Example response

{
  "currency": "JPY"
}