Skip to main content
GET
/
v1
/
cards
JavaScript
import Chron from '@chron/sdk';

const client = new Chron({
  apiKey: 'My API Key',
});

const cards = await client.cards.list({ limit: 100, offset: 0 });

console.log(cards.cards);
{
  "total": 123,
  "limit": 123,
  "offset": 123,
  "cards": [
    {
      "cardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "clientReference": "<string>",
      "status": "WAITING_ACTIVATION",
      "initialBalance": 123,
      "expiryDate": "2023-11-07T05:31:56Z",
      "design": "<string>",
      "metadata": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "currentBalance": 123,
      "activatedAt": "2023-11-07T05:31:56Z",
      "cancelledAt": "2023-11-07T05:31:56Z",
      "cancellationAmount": 123,
      "cancellationAction": "EXPIRY",
      "transactions": [
        {
          "transactionId": "<string>",
          "amount": 123,
          "type": "LOAD",
          "createdAt": "2023-11-07T05:31:56Z"
        }
      ]
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
limit
integer
required

Maximum number of cards per page.

Required range: x <= 100
​
offset
integer
required

Starting index for pagination.

​
status
enum<string>

Filter cards by status.

Available options:
WAITING_ACTIVATION,
ACTIVE,
CANCELLED,
BLOCKED,
REISSUED,
EXPIRED
​
createdDate
string<date>

Filter cards by creation date (YYYY-MM-DD).

​
expiryDate
string<date>

Filter cards by expiry date (YYYY-MM-DD).

​
activationDate
string<date>

Filter cards by activation date (YYYY-MM-DD).

​
updatedDate
string<date>

Filter cards by last updated date (YYYY-MM-DD).

​
metadata
string

Filter on metadata key-value pairs (flat JSON only), e.g., metadata.orderId=12345.

Response

List of cards retrieved successfully.

​
total
integer

Total number of cards matching the filter.

​
limit
integer
​
offset
integer
​
cards
object[]