Sign in

v1

latestOpenAPI 3.0.22026-07-2667277423.4 KB
Platform Model

Balance: Show

Given a currency, view the unsettled balance of the currently authenticated merchant or one of its sub-merchants.

get/merchants/{merchant_id}/balances/{currency}

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

Response

200 response

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.

total_balance_centsinteger required

Amount in the lowest denomination of the currency (e.g. cents for USD).

Example response

{
  "currency": "JPY"
}