Sign in

v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB
Card Lifecycle

List Cards

Returns a list of issuing card objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

get/v1/issuing/cards

Query parameters

page_sizeinteger required
Example:10

The maximum number of items to return per page. This number can be between 1 - 100

page_numberinteger required
Example:1

The page number to retrieve the next set of items. The number has to be greater than 1.

card_numberstring
Example:4096360811214526

The full card number.

card_status'PENDING' | 'ACTIVE' | 'FROZEN' | 'BLOCKED' | 'PRE_CANCEL' | 'CANCELLED' | 'LOST' | 'STOLEN' | 'FAILED'

Card status enum. See the Card lifecycle and statuses guide for more information.

  • PENDING: The request to create the card has been received and is under review.
  • ACTIVE: The request to create the card was successful and the card is ready to use.
  • FROZEN: All incoming authorization requests will be declined. The card can be reactivated to accept new authorizations.
  • BLOCKED: The card was blocked by UQPAY due to suspicious activity.
  • PRE_CANCEL: The card is scheduled for cancellation and is in a waiting period during which all incoming authorization requests are declined. It transitions to CANCELLED when the waiting period ends.
  • CANCELLED: The card cannot be reactivated from this state, all incoming authorization requests will be permanently declined.
  • LOST: The card has been reported as lost to UQPAY.
  • STOLEN: The card has been reported as stolen to UQPAY.
  • FAILED: The request to create a card using Create Card failed.
Example:ACTIVE

Retrieve items with the specified card status. Matches any card status if unspecified.

cardholder_idstring uuid

The cardholder's unique identifier.

Example:7c4ff2cd-1bf6-4aaa-bf16-266771425011

Headers

x-on-behalf-ofstring

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts API. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

Response

OK - Successfully retrieved a list of cards.

total_pagesinteger

The total pages of available items.

total_itemsinteger

The total counts of available items.

Example response

{
  "total_pages": 10,
  "total_items": 105,
  "data": [
    {
      "card_id": "c0cef051-29c5-4796-b86a-cd5b684bfad7",
      "card_bin": "40963608",
      "card_scheme": "VISA",
      "card_currency": "USD",
      "card_number": "************5668",
      "form_factor": "VIRTUAL",
      "mode_type": "SHARE",
      "card_product_id": "3bd1656b-e691-4aab-a76a-3ead39e7a6f6",
      "card_limit": 2100.02,
      "cardholder": {
        "cardholder_id": "7c4ff2cd-1bf6-4aaa-bf16-266771425011",
        "create_time": "2024-05-09 15:52:23",
        "email": "demo@example.com",
        "first_name": "Emily",
        "last_name": "Toy"
      },
      "risk_controls": {
        "enable_3ds": "Y",
        "allow_3ds_transactions": "Y",
        "blocked_mcc": [
          "5999",
          "6011"
        ]
      },
      "network_protection": {
        "enabled": true,
        "card_scheme": "VISA",
        "action_code": "41",
        "definition": "Lost card, pickup",
        "status": "ENROLL_PENDING",
        "submitted_time": "2026-05-14T09:00:00Z"
      },
      "metadata": {
        "key1": "value1",
        "key2": "value2"
      },
      "card_status": "ACTIVE",
      "consumed_amount": "51.00"
    }
  ]
}