List Transactions
GET/api/accounts/:accountId/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.
Request
Path Parameters
accountId linked to transactions
Query Parameters
amount of records to return (max 1000)
cursor to retrieve the next page
Filter for transactions from this date (inclusive). Value should be a ISO 8601 string or RFC 2822 string
Filter for transactions up to this date (inclusive). Value should be a ISO 8601 string or RFC 2822 string
Responses
- 200
- 400
- 403
Successful operation
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
items
object[]
The transaction ID
A description of the transaction
Which account this transaction belongs to
Possible values: [init
, holding
, cleared
, reversed
]
The status of the transaction
Which card this transaction belongs to
The billing amount of the transaction, an integer in the smallest denomination for the given currency
The billing currency of the transaction
The acquirer amount of the transaction, an integer in the smallest denomination for the given currency
The acquirer currency of the transaction
The fee amount of the transaction
The created date formatted in ISO of the transactions
The cleared date formatted in ISO of the transactions
The reference used when making an enquiry through customer support
cardAcceptor
object
required
The city of the card acceptor
The country code of the card acceptor
The name of the card acceptor
Possible values: [credit
, debit
]
Indicates if the transaction was a credit or debit
pageInfo
object
Page info for paginated results, undefined if no page info
Cursor 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",
"feeAmount": "12",
"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": 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": 403,
"statusName": "Forbidden",
"errorCode": "FORBIDDEN",
"reason": "Unauthorized"
}