Skip to content

List Card Transactions

GET /openapi/v1/cards/transactions
ItemValue
HTTP methodGET
Request path/openapi/v1/cards/transactions
Request typequery

Request parameters:

FieldTypeRequiredDefaultDescription
cardIdstringYesNoneCard ID.
statusstringNoNoneFilter by raw transaction status from the external provider; additional values may be introduced. Currently known values are pending, success, failed.
currencystringNoNoneTransaction currency, usually a three-letter ISO 4217 code; values are not restricted to a fixed set.
fromTimestringNoNoneStart time, as an ISO 8601 date-time string.
toTimestringNoNoneEnd time, as an ISO 8601 date-time string.
pageintegerNo1Page number, starting at 1.
pageSizeintegerNo20Number of items per page, from 1 to 100.

Response data

FieldTypeDescription
itemsarrayList of transactions.
items[].idstringTransaction ID.
items[].cardIdstringCard ID.
items[].memberIdstringPlatform member ID.
items[].amountstringTransaction amount, as the decimal string returned unchanged by the external provider.
items[].currencystringTransaction currency, usually a three-letter ISO 4217 code; additional values may be introduced.
items[].statusstringRaw transaction status from the external provider; additional values may be introduced. Currently known values are pending, success, failed.
items[].occurredAtstringTransaction occurrence time, as an ISO 8601 date-time string.
items[].providerTransactionIdstringProvider transaction ID.
items[].countryCodestringPurchase country or region code, when supplied by the upstream provider.
items[].merchantNamestringMerchant display name, when supplied by the card network or upstream processor.
items[].merchantCategoryCodestringFour-digit merchant category code (MCC), when supplied by the upstream provider.
items[].feesarrayUCard additional fee orders.
items[].fees[].feeOrderNostringFee order number.
items[].fees[].amountstringFee amount.
items[].fees[].currencystringFee currency.
items[].fees[].statusstringFee order status: CREATED, PROCESSING, UNKNOWN, FROZEN, SUCCESS, or FAILED.
items[].fees[].providerTransferIdstringProvider transfer ID.
items[].fees[].providerStatusstringProvider transfer status.
items[].fees[].completedTimestringFee order completion time.
items[].fees[].itemsarrayFee line items.
items[].fees[].items[].feeCodestringFee code.
items[].fees[].items[].beneficiaryTenantIdstringBeneficiary tenant ID.
items[].fees[].items[].amountstringLine item amount.
items[].fees[].items[].currencystringLine item currency.
pageintegerCurrent page number.
pageSizeintegerNumber of items per page.
totalintegerTotal count.