Sign in
Transactions

List posted transactions

Get paginated list of posted transactions matching the provided filters

get/transactions/posted

Query parameters

is_batchedboolean

If true, only display transactions that are part of a batch payment. Cannot be used with batch_ids.

include_child_transactionsboolean

Include transactions from sub-accounts when listing transactions for a given account

batch_idsstring[]

Batch UUID(s). Multiple UUIDs can be provided as a comma-separated list. Cannot be used with is_batched.

amountinteger
Example:1000

Only return transactions equal to the given amount (in minor currency units, e.g., cents).

from_datestring date

Only display transactions with a posting date greater than from_date

to_datestring date

Only display transactions with a posting date less than or equal to to_date

barcode_numberstring[]

Barcode number(s). Multiple barcode numbers can be provided as a comma-separated list.

digital_wallet_token_idstring[]

Digital Wallet token ID(s). Multiple IDs can be provided as a comma-separated list.

dc_sign'credit' | 'debit'

Debit/Credit sign

cashbackboolean

If true, only transactions with cashback will be returned. If false, only transactions without cashback will be returned. If not provided, all transactions will be returned.

typestring

Only display transactions matching the given type

from_effective_datestring date

Only display transactions with an effective date greater than or equal to from_effective_date. Use date-only format (YYYY-MM-DD). date-time format is supported for backward compatibility.

idempotency_keystring[]

Transaction Idempotency Key(s). Multiple keys can be provided as a comma-separated list.

account_nostring

Account number

to_effective_datestring date

Only display transactions with an effective date less than or equal to to_effective_date. Use date-only format (YYYY-MM-DD). date-time format is supported for backward compatibility.

exclude_jit_transactionsboolean

Hide "JIT funding" transactions from results

uuidstring[]

Transaction UUID(s). Multiple UUIDs can be provided as a comma-separated list.

page_tokenstring

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:a8937a0d
account_idstring[]

Account ID

card_idstring uuid
Example:6dc0397d-1aba-4be9-9582-895a7a887d49

Card ID

reference_idstring

Reference ID

limitinteger

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Example:100
subtypestring

Only display transactions matching the given subtype

uuid_ninstring[]

Transaction UUID(s) to exclude from the query. Multiple UUIDs can be provided as a comma-separated list.

Response

Paginated list of posted transactions

next_page_tokenstring nullable required

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example response

{
  "result": [
    {
      "data": {
        "lines": [
          {
            "account_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
            "tenant": "abcdef_ghijkl"
          }
        ]
      },
      "idemkey": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
      "tenant": "abcdef_ghijkl"
    }
  ]
}

Changes