List cards
Lists cards 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
Number of records to return
- cursor string
Cursor to retrieve the next page of records
- excludeExpired boolean
Filter by expiry state
- status string
Possible values: [
created
,active
,cancelled
,shipped
]Filter by card status
- expiresAfter string
Timestamp to filter out cards with an expiration date after the given time. Value should be an ISO 8601 string or RFC 2822 string. excludeExpired must be false
- 200
- 400
- 403
Successful operation
- application/json
- Schema
- Example (from schema)
Schema
items object[]
Array [id string requiredCard primary identifier
accountId string requiredUser account ID linked to card
type string requiredPossible values: [
virtual
]Type of the card
createdAt string requiredTimestamp of card creation
modifiedAt string requiredTimestamp of card modification
expiresAt string requiredTimestamp of card expiration
isBlocked boolean requiredWhether the card is blocked
status string requiredPossible values: [
active
,cancelled
,created
,shipped
]Status of the card
fundingSourceIds array requiredList of Funding Source IDs linked to the card
expiry stringExpiry date of the card
currency stringThe currency of this card
panFirst6 stringFirst 6 digits of the card's PAN (Primary Account Number)
panLast4 stringLast 4 digits of the card's PAN (Primary Account Number)
immersveExpiration stringDeprecated field, use expiresAt
lockedFundAmount stringLegacy cards only. An integer in the smallest denomination for the given currency
lockedFundCurrency stringLegacy cards only. Currency used to lock funds on card creation
fundingWallet stringLegacy cards only. Address of the wallet used to fund the card
]pageInfo object
Page info for paginated results, undefined if no page info
nextCursor stringCursor for next page, undefined if no more pages
{
"items": [
{
"id": "91ad6fea3b52ca58d60d7fd310f789ec",
"accountId": "057aa15913a57f50577234c8426534c0",
"type": "virtual",
"createdAt": "2022-11-16T03:13:18.142Z",
"modifiedAt": "2022-11-16T03:13:18.142Z",
"expiresAt": "2029-02-28T23:59:59.999Z",
"isBlocked": true,
"status": "active",
"fundingSourceIds": [
null
],
"expiry": "202409",
"currency": "USDC | USD",
"panFirst6": "123456",
"panLast4": "1920",
"immersveExpiration": "2022-11-16T03:18:23.431Z",
"lockedFundAmount": 10,
"lockedFundCurrency": "USDC",
"fundingWallet": "0x7D0b0d249A7fB85A5c5F5A5e3b6A2d6c9A6D684B"
}
],
"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"
}