List Cards
GEThttps://api.immersve.com/api/accounts/:accountId/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.
Request
Path Parameters
AccountId linked to transactions
Query Parameters
Number of records to return
Cursor to retrieve the next page of records
Filter by expiry state
Possible values: [created
, active
, cancelled
, shipped
]
Filter by card status
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
Responses
- 200
- 400
- 403
Successful operation
- application/json
- Schema
- Example (from schema)
Schema
items
object[]
pageInfo
object
{
"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
],
"cardProgramId": "91ad6fea3b52ca58d60d7fd310f789ec",
"regionCode": "NZ",
"expiry": "202409",
"panFirst6": "123456",
"panLast4": "1920",
"immersveExpiration": "2022-11-16T03:18:23.431Z"
}
],
"pageInfo": {
"nextCursor": "dGhlIG5leHQgY3Vyc29yIGdvZXMgaGVyZQ=="
}
}
Request fields are invalid
- application/json
- Schema
- Example (from schema)
Schema
errors
object[]
{
"statusCode": 400,
"statusName": "Bad Request",
"errorCode": "INVALID_REQUEST_INPUT",
"errors": [
{
"message": "Invalid type",
"path": "items[1].attributes.invalidField"
}
]
}
No Authorization to access resource.
- application/json
- Schema
- Example (from schema)
Schema
{
"statusCode": 403,
"statusName": "Forbidden",
"errorCode": "FORBIDDEN",
"reason": "Unauthorized"
}
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
curl -L 'https://api.immersve.com/api/accounts/:accountId/cards' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'