Get user's cards

Sync cards from the card provider and return the list.

GET /api/v1/cards

Get user's cards

cURL

curl --request GET \
  --url https://api.example.com/api/v1/cards \
  --header 'Authorization: Bearer <token>'

200

{
  "cards": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "externalId": "<string>",
      "walletAddress": "<string>",
      "status": "pending",
      "limit": {
        "dailyLimit": 123,
        "dailyUsage": 0,
        "monthlyLimit": 123,
        "monthlyUsage": 0,
        "lifetimeLimit": 123,
        "lifetimeUsage": 0,
        "currency": "EUR"
      },
      "cardData": {
        "nameOnCard": "<string>",
        "paymentSystem": "<string>",
        "lastFour": "<string>",
        "expiryDate": "<string>",
        "format": "virtual",
        "cardName": "<string>"
      },
      "createdAt": "<string>",
      "activated": false,
      "billingAddress": {
        "streetAddress": "<string>",
        "addressLine2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "country": "AF",
        "zip": "<string>"
      },
      "dailySpend": 0,
      "label": "<string>"
    }
  ],
  "total": 123,
  "created": false,
  "kycStatus": "not_started",
  "phoneVerified": false
}

Authorizations

Authorization · string · header · required

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

Headers

x-api-key · string | null

Response

200

application/json

Successful Response

Paginated list of cards.

cards · CardResponse · object[] · required

Show child attributes

total · integer | null

created · boolean · default: false

kycStatus · enum<string> · default: not_started

KYC verification status.

Available options: not_started, requested, incorporating, pending, under_review, approved, rejected

phoneVerified · boolean · default: false