Sign in

v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB
Balances

List Issuing Balances Transactions

Returns a list of transactions that have contributed to the issuing account balance (e.g., charges, fee, and so forth).

get/v1/issuing/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.

transaction_type'ISSUING_AUTHORIZATION' | 'ISSUING_REVERSAL' | 'ISSUING_REFUND' | 'CARD_RECHARGE' | 'CARD_WITHDRAW' | 'FEE' | 'DEPOSIT' | 'TRANSFER_IN' | 'TRANSFER_OUT' | 'SETTLEMENT_DEBIT' | 'SETTLEMENT_CREDIT' | 'ADJUSTMENT' | 'FUNDS_TRANSFER_IN' | 'FUNDS_TRANSFER_OUT' | 'FEE_REFUND' | 'FEE_DEDUCTION' | 'MARGIN_PAYMENT' | 'MARGIN_REFUND' | 'OTHER' | 'SETTLEMENT_REVERSAL' | 'REFUND'
Example:DEPOSIT

Transaction type filter for issuing balance transactions.

transaction_status'COMPLETED' | 'PENDING' | 'FAILED'
Example:COMPLETED

Transaction status filter for issuing balance transactions.

currencystring
Example:USD

Currency filter. Three-letter ISO 4217 currency code.

transaction_idstring uuid

Unique Identifier for transaction

Example:5135e6cc-28b6-4889-81dc-3b86a09e1395

Transaction ID filter (long ID).

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",
      "short_transaction_id": "CT2024-03-01",
      "account_id": "72970a7c-7921-431c-b95f-3438724ba16f",
      "balance_id": "72970a7c-7921-431c-b95f-3438724ba16f",
      "transaction_type": "DEPOSIT",
      "currency": "USD",
      "amount": "100.02",
      "create_time": "2024-03-01T00:00:00+08:00",
      "complete_time": "2024-03-01T00:00:00+08:00",
      "transaction_status": "PENDING",
      "ending_balance": "100.02",
      "description": "Creation card, fee"
    }
  ]
}