POST
/
v1
/
cards
curl --request POST \
  --url https://api.chron.com/v1/cards \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "clientReference": "<string>",
  "initialBalance": 123,
  "expiryDate": "2023-11-07T05:31:56Z",
  "design": "<string>",
  "metadata": {}
}'
{
  "cardId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "clientReference": "<string>",
  "status": "WAITING_ACTIVATION",
  "initialBalance": 123,
  "currentBalance": 123,
  "expiryDate": "2023-11-07T05:31:56Z",
  "design": "<string>",
  "metadata": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "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.

Body

application/json
​
clientReference
string
required

A unique identifier provided by the client to prevent duplicate card creation.

​
initialBalance
number
required

The starting balance (e.g., up to AUD 500 or AUD 1000).

​
expiryDate
string
required

The expiry date/time for the card.

​
design
string
required

The design or template chosen for the card.

​
metadata
object
required

Updateable custom data for the card.

Response

200
application/json
Card created successfully.
​
cardId
string
required

Unique identifier for the card.

​
clientReference
string
required

Unique identifier provided by the client to prevent duplication.

​
status
enum<string>
required

Current status of the card.

Available options:
WAITING_ACTIVATION,
ACTIVE,
CANCELLED,
BLOCKED,
REISSUED,
EXPIRED
​
initialBalance
number
required

The starting balance on the card.

​
expiryDate
string
required

The date and time when the card expires.

​
design
string
required

The design or template selected for the card.

​
metadata
object
required

Updateable custom data associated with the card.

​
createdAt
string
required

Timestamp when the card was created.

​
updatedAt
string
required

Timestamp when the card was last updated.

​
currentBalance
number

The current available balance.

​
activatedAt
string

Timestamp when the card was activated (if applicable).

​
cancelledAt
string

Timestamp when the card was cancelled (null if not cancelled).

​
cancellationAmount
number

The amount that was unloaded from the card at cancellation (null if not cancelled).

​
cancellationAction
enum<string>

Action that led to the card's cancellation.

Available options:
EXPIRY,
CANCELLATION,
REISSUE
​
transactions
object[]

A list of transactions associated with the card.