> ## Documentation Index
> Fetch the complete documentation index at: https://docs.uqpay.org/llms.txt
> Use this file to discover all available pages before exploring further.

# List all cards

> This endpoint get list of cards issued under an account.

### Header

<ParamField header="x-client-id" type="string" required>
  `x-client-id`.
</ParamField>

<ParamField header="x-auth-token" type="string" required>
  Bearer `YOUR_TOKEN_HERE`.
</ParamField>

### Parameters

<ParamField query="page_num" type="number" required>
  Page number, starts from 1.
</ParamField>

<ParamField query="page_size" type="number" required>
  Number of results per page.<br />
  `Maximum 50`
</ParamField>

<ParamField query="card_status" type="number">
  Filter on status of card.<br />
  One of `PENDING`, `ACTIVE`, `INACTIVE`, `BLOCKED`, `LOST`, `STOLEN`, `CLOSED`, `FAILED`
</ParamField>

<ParamField query="card_number" type="string">
  Fuzzy search by card number.
</ParamField>

<ParamField query="card_name" type="string">
  Fuzzy search by name of card.
</ParamField>

### Response

<ResponseField name="code" type="number">
  Indicates whether the call was successful. 200 if successful, 400 if not.
</ResponseField>

<ResponseField name="message" type="string">
  Response Message. "Success" if successful, others not.
</ResponseField>

<ResponseField name="data" type="object">
  <Expandable title="details" defaultOpen>
    <ResponseField name="total_item" type="number">
      Total items.
    </ResponseField>

    <ResponseField name="total_page" type="number">
      Total pages.
    </ResponseField>

    <ResponseField name="item_list" type="array">
      <Expandable title="details" defaultOpen>
        <ResponseField name="card_currency" type="string">
          Currency of card.
        </ResponseField>

        <ResponseField name="card_id" type="string">
          Unique Identifier for card.
        </ResponseField>

        <ResponseField name="card_name" type="string">
          A name for the card.
        </ResponseField>

        <ResponseField name="card_number" type="number">
          Card number.
        </ResponseField>

        <ResponseField name="card_status" type="string">
          Current card status.<br />
          One of `PENDING`, `ACTIVE`, `INACTIVE`, `BLOCKED`, `LOST`, `STOLEN`, `CLOSED`, `FAILED`
        </ResponseField>

        <ResponseField name="create_time" type="string">
          Card issue time.
        </ResponseField>

        <ResponseField name="product_code" type="string">
          Card product code.
        </ResponseField>
      </Expandable>
    </ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
  ```bash cURL Example Request theme={null}
  curl 'https://api.sandbox.uqpay.org/api/v1/cards?page_num=1&page_size=5' \
  -H 'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203' \
  -H 'x-client-id: Up1HIsjiETPXLy7gON9PMG'
  ```
</RequestExample>

<ResponseExample>
  ```json Response theme={null}
  {
      "code": 200,
      "message": "Success",
      "data": {
          "total_item": 15,
          "total_page": 3,
          "item_list": [
              {
                  "card_currency": "USD",
                  "card_id": "4e971801-482f-45f8-9bcd-ee0d31f12be9",
                  "card_name": "testf's card",
                  "card_number": "9333019900054692",
                  "card_status": "ACTIVE",
                  "create_time": "2023-10-12T15:23:25+08:00",
                  "product_code": "IC_VISA_491724"
              },
              {
                  "card_currency": "USD",
                  "card_id": "8a01cace-188e-4f44-9329-f6de3dbd74ed",
                  "card_name": "testf's card",
                  "card_number": "9333019900054676",
                  "card_status": "BLOCKED",
                  "create_time": "2023-10-12T14:34:55+08:00",
                  "product_code": "IC_VISA_491724"
              },
              {
                  "card_currency": "USD",
                  "card_id": "d3827a04-837b-41d5-8fad-8bdfa232bbb3",
                  "card_name": "testf's card",
                  "card_number": "9333019900054650",
                  "card_status": "ACTIVE",
                  "create_time": "2023-10-12T11:52:33+08:00",
                  "product_code": "IC_VISA_491724"
              },
              {
                  "card_currency": "USD",
                  "card_id": "23052ecb-5dd3-4e4f-ab6d-0345896c9b14",
                  "card_name": "testf's card",
                  "card_number": "9333019900054643",
                  "card_status": "ACTIVE",
                  "create_time": "2023-10-12T11:51:03+08:00",
                  "product_code": "IC_VISA_491724"
              },
              {
                  "card_currency": "USD",
                  "card_id": "f5e79cb4-aaf6-43df-bf32-b60e5ba6ea34",
                  "card_name": "testf's card",
                  "card_number": "9333019900054627",
                  "card_status": "ACTIVE",
                  "create_time": "2023-10-12T11:41:13+08:00",
                  "product_code": "IC_VISA_491724"
              }
          ]
      }
  }
  ```
</ResponseExample>