GET
/
api
/
v1
/
cardholders
curl 'https://api.sandbox.uqpay.org/api/v1/cardholders?page_num=1&page_size=10' \
-H 'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203' \
-H 'x-client-id: Up1HIsjiETPXLy7gON9PMG'

{
    "code": 200,
    "message": "Success",
    "data": {
        "total_item": 1,
        "total_page": 1,
        "item_list": [
            {
                "card_holder_id": "7c4ff2cd-1bf6-4aaa-bf16-266771425011",
                "card_holder_status": "SUCCESS",
                "card_num": 0,
                "create_time": "2023-09-15T10:02:17+08:00",
                "first_name": "Emily",
                "last_name": "Johnson",
                "update_time": "2023-09-15T10:02:17+08:00"
            }
        ]
    }
}
​
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

​
direct_id
string

Direct Account id this transaction is associated with.

​
account_id
string

The id of the account for the card.

​
card_holder_status
number

Filter on status of cardholder.
One of -1=FAILED, 0-PENDING, 1-SUCCESS, 2-INCOMPLETE

​
holder_name
string

Fuzzy search by name of the cardholder.

​
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/cardholders?page_num=1&page_size=10' \
-H 'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203' \
-H 'x-client-id: Up1HIsjiETPXLy7gON9PMG'

{
    "code": 200,
    "message": "Success",
    "data": {
        "total_item": 1,
        "total_page": 1,
        "item_list": [
            {
                "card_holder_id": "7c4ff2cd-1bf6-4aaa-bf16-266771425011",
                "card_holder_status": "SUCCESS",
                "card_num": 0,
                "create_time": "2023-09-15T10:02:17+08:00",
                "first_name": "Emily",
                "last_name": "Johnson",
                "update_time": "2023-09-15T10:02:17+08:00"
            }
        ]
    }
}