Sign in

v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB
Balances

List Balances Transactions

Returns a list of transactions that have contributed to your account balance, including charges, fees, and other adjustments. You can filter the results by specifying a time range. If no time range is provided, or only the end date is specified, the response will include transactions from the past 30 days up to today or the specified end date.

get/v1/balances/transactions

Query parameters

page_sizeinteger required
Example:10

The maximum number of items to return per page. This number can be between 1 - 100

page_numberinteger required
Example:1

The page number to retrieve the next set of items. The number has to be greater than 1.

start_timestring
Example:2024-03-01T00:00:00+08:00

Exclusive start time used to filter by create_time. ISO 8601 format.

end_timestring
Example:2024-03-02T00:00:00+08:00

Exclusive end time used to filter by create_time. ISO 8601 format.

currencystring
Example:USD

Specifies the currency for which transactions are retrieved. Currency codes follow the ISO 4217 standard.

transaction_type'ALL' | 'PAYIN' | 'DEPOSIT' | 'PAYOUT' | 'TRANSFER' | 'CONVERSION' | 'FEE' | 'REFUND' | 'ADJUSTMENT' | 'INVOICE'
Example:PAYOUT

Transaction type.

  • ALL: Includes all types of financial transactions in the system.
  • PAYIN: Incoming payment received from external sources.
  • DEPOSIT: Funds added directly to an account through bank transfer or other means.
  • PAYOUT: Outgoing payment sent to external beneficiaries.
  • TRANSFER: Movement of funds between internal accounts.
  • CONVERSION: Currency exchange between different currencies.
  • FEE: Service charges or transaction fees.
  • REFUND: Reversal of a previous payment or transaction.
  • ADJUSTMENT: Manual or automated correction to account balance.
  • INVOICE: Invoice transaction.
transaction_status'ALL' | 'COMPLETED' | 'PENDING' | 'FAILED'
Example:COMPLETED

Transaction status.

  • ALL: Represents all possible transaction statuses.
  • COMPLETED: Transaction has been successfully processed and finalized.
  • PENDING: Transaction is currently being processed and awaiting completion.
  • FAILED: Transaction could not be completed due to an error or rejection.

Headers

x-on-behalf-ofstring

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts API. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

Response

OK - Balances transactions returned successfully.

total_pagesinteger

The total pages of available items.

total_itemsinteger

The total counts of available items.

Example response

{
  "total_pages": 10,
  "total_items": 105,
  "data": [
    {
      "transaction_id": "5135e6cc-28b6-4889-81dc-3b86a09e1395",
      "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
      "balance_id": "72970a7c-7921-431c-b95f-3438724ba16f",
      "transaction_type": "DEPOSIT",
      "currency": "USD",
      "amount": "100.02",
      "credit_debit_type": "C",
      "create_time": "2024-03-01T00:00:00+08:00",
      "complete_time": "2024-03-01T00:00:00+08:00",
      "reference_id": "b52aaed6-1274-41b8-999e-f036085a6da8",
      "transaction_status": "PENDING",
      "transaction_way": "API"
    }
  ]
}