v1

latestOpenAPI 3.0.22026-07-2667277423.4 KB
Platform Model

Balance: Transactions

Given a currency, view the ledger transactions of the currently authenticated merchant or one of its sub-merchants. Will split ledger transactions into line items when appropriate.

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

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

Query parameters

start_timestring date-time

Query for records created after this time.

end_timestring date-time

Query for records created before this time.

per_pageinteger

How many objects per page.

pageinteger

Page number to query for.

typestring

Response

200 response

resourcestring required

Resource type name for this list, always "list".

start_timestring date-time required

Start of the time range for records in this response.

end_timestring date-time required

End of the time range for records in this response.

totalinteger required

Total number of records matching the query.

pageinteger required

Current page number.

per_pageinteger required

Number of results per page.

last_pageinteger required

Last available page number.