v1

latestOpenAPI 3.0.02026-08-06112728.7 KB
Card

List organization cards

Requires card.create permission.

get/list

Query parameters

statusstring

Card status filter, comma-separated (init / pending / active / suspend / pending_delete / deleted)

card_aliasstring

Card alias filter

pageinteger

Page number

page_sizeinteger

Page size, max 100

Headers

Datestring

GMT server time, e.g. Tue, 21 Jan 2025 12:00:00 GMT. Required for every request.

Authorizationstring

HMAC-SHA256 Signature header. See the Authentication guide.

Response

Standard response envelope

codeinteger required

Business code. 0 means success.

messagestring required

Response message.

Example response

{
  "data": {
    "cards": [
      {
        "id": "a441831c-a5c7-4bed-8f61-793738afd5bc",
        "mask": "411111******1111",
        "holder_name": "Jane Doe",
        "card_alias": "Travel card",
        "status": "active",
        "currency": "USD",
        "available_balance": "50.25",
        "user_id": "usr_01HXYZ",
        "created_at": 1714464000,
        "updated_at": 1714550400
      }
    ],
    "total": 1,
    "page": 1,
    "page_size": 20,
    "total_pages": 1
  }
}