Sign in
latestOpenAPI 3.0.22026-07-2667277423.4 KB

65483c40ba32

Platform Model

Balance: Transfer

Creates a balance transfer between associated merchants for a given amount and currency.

post/merchants/{merchant_id}/balances/{currency}/transfer

Path parameters

merchant_idstring required

A unique 25-character alphanumeric resource identifier.

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

merchant_idstring

A unique 25-character alphanumeric resource identifier.

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.

tostring required
amountinteger required

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

Example request

{
  "currency": "JPY"
}

Response

200 response

typestring required

The type identifier for this balance 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 balance transfer occurred.

Example response

{
  "currency": "JPY"
}