List transactions
List card purchase transactions by account
This API uses cursor-based pagination. Start by making a request without a cursor to get the first page. Use the nextCursor from the pageInfo in the response as the cursor for subsequent requests to retrieve further pages. Continue until nextCursor is undefined, indicating no more data.
Path Parameters
- accountId string required
accountId linked to transactions
Query Parameters
- limit number
amount of records to return (max 1000)
- cursor string
cursor to retrieve the next page
- fromUTC string
Filter for transactions from this date (inclusive). Value should be a ISO 8601 string or RFC 2822 string
- toUTC string
Filter for transactions up to this date (inclusive). Value should be a ISO 8601 string or RFC 2822 string
- 200
- 400
- 403
Successful operation
- application/json
- Schema
- Example (from schema)
Schema
items object[]
Array [id string requiredThe transaction ID
description string requiredA description of the transaction
accountId string requiredWhich account this transaction belongs to
status string requiredPossible values: [
init
,holding
,cleared
,failed
]The status of the transaction
cardId string requiredWhich card this transaction belongs to
amount string requiredThe billing amount of the transaction, an integer in the smallest denomination for the given currency
currency string requiredThe billing currency of the transaction
acquirerAmount string requiredThe acquirer amount of the transaction, an integer in the smallest denomination for the given currency
acquirerCurrency string requiredThe acquirer currency of the transaction
lockedFundCurrency string requiredThe locked funds' currency of the transaction
feeAmount string requiredThe fee amount of the transaction
chain string requiredThe chain of the locked funds on
transactionDate date-time requiredThe created date formatted in ISO of the transactions
processedDate date-timeThe cleared date formatted in ISO of the transactions
reference string requiredThe reference used when making an enquiry through customer support
cardAcceptor object required
city string requiredThe city of the card acceptor
countryCode string requiredThe country code of the card acceptor
name string requiredThe name of the card acceptor
creditDebitIndicator stringPossible values: [
credit
,debit
]Indicates if the transaction was a credit or debit
]pageInfo object
Page info for paginated results, undefined if no page info
nextCursor stringCursor for next page, undefined if no more pages
{
"items": [
{
"id": "1000000178145",
"description": "Air NZ Online Auckland",
"accountId": "225d85e65495722bf6517ea0ba0d6f56",
"status": "init",
"cardId": "6c474aa7a5dc45bff721b5a207cf0f47",
"amount": "31412",
"currency": "USD",
"acquirerAmount": "31412",
"acquirerCurrency": "NZD",
"lockedFundCurrency": "USDC",
"feeAmount": "12",
"chain": "Polygon",
"transactionDate": "2022-11-09T03:24:15.182Z",
"processedDate": "2022-11-09T03:24:15.182Z",
"reference": "1000000178145",
"cardAcceptor": {
"city": "Auckland",
"countryCode": "NZ",
"name": "Air NZ Online"
},
"creditDebitIndicator": "credit"
}
],
"pageInfo": {
"nextCursor": "dGhlIG5leHQgY3Vyc29yIGdvZXMgaGVyZQ=="
}
}
Request fields are invalid
- application/json
- Schema
- Example (from schema)
Schema
- statusCode integer required
- statusName string required
- errorCode string required
- errors string[]
{
"statusCode": 400,
"statusName": "Bad Request",
"errorCode": "BAD_REQUEST",
"errors": [
"Expected string, received number"
]
}
No Authorization to access resource.
- application/json
- Schema
- Example (from schema)
Schema
- statusCode integer required
- statusName string required
- errorCode string required
- reason string
{
"statusCode": 403,
"statusName": "Forbidden",
"errorCode": "FORBIDDEN",
"reason": "Unauthorized"
}