Skip to main content
GET
https://api.sandbox.uqpay.org
/
api
/
v1
/
cards
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'

{
    "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"
            }
        ]
    }
}
​
x-client-id
string
required
x-client-id.
​
x-auth-token
string
required
Bearer YOUR_TOKEN_HERE.

​
Parameters

​
page_num
number
required
Page number, starts from 1.
​
page_size
number
required
Number of results per page.
Maximum 50
​
card_status
number
Filter on status of card.
One of PENDING, ACTIVE, INACTIVE, BLOCKED, LOST, STOLEN, CLOSED, FAILED
​
card_number
string
Fuzzy search by card number.
​
card_name
string
Fuzzy search by name of card.

​
Response

​
code
number
Indicates whether the call was successful. 200 if successful, 400 if not.
​
message
string
Response Message. “Success” if successful, others not.
​
data
object
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'

{
    "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"
            }
        ]
    }
}