API OVERVIEW
CORE
- Auth
- Balances
ISSUING
- Cards
- Products
- Cardholders
- Transactions
PAYOUT
- Payer
- Payout
- Beneficiaries
Webhooks
- Payout
- Beneficiary
Payer
Get list of payers
This endpoint returns a list of payers.
GET
/
api
/
v1
/
payers
Copy
curl 'https://api.sandbox.uqpay.org/api/v1/payers' \
-H 'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203' \
-H 'x-client-id: Up1HIsjiETPXLy7gON9PMG'
Copy
{
"code": 200,
"message": "Success",
"data": [
{
{
"code": 200,
"message": "Success",
"data": [
{
"payer_id": "fcf09fa0-1313-41e8-9c1a-2d2721e4251a",
"entity_type": "individual",
"first_name": "wujing",
"last_name": "lee",
"address": "169 Ayer Rajah Crescent, #01-11 Singapore 413091",
"city": "singapore",
"state_or_province": "singapore",
"country": "SG",
"postal_code": "000000",
"date_of_birth": "1993-10-12",
"identification_type": "passport",
"identification_value": "1003123"
}
]
}
}
]
}
Header
x-client-id
.
Bearer YOUR_TOKEN_HERE
.
Parameters
Response
Indicates whether the call was successful. 200 if successful, 400 if not.
Response Message. “Success” if successful, Others not.
Unique UUID for the payer.
Payer’s entity type - company or individual.
The name of the company (if the payer is a company).
Payer’s first name.
Payer’s last name.
Line of address.
City of the payer.
State or province of the payer.
Country of the payer. Two-letter ISO country code.
Postal code of the payer.
Payer date of birth.
The legal document used to verify the identity of the payer (e.g. passport).
A unique reference code for the identification document, such as a passport number.
Copy
curl 'https://api.sandbox.uqpay.org/api/v1/payers' \
-H 'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203' \
-H 'x-client-id: Up1HIsjiETPXLy7gON9PMG'
Copy
{
"code": 200,
"message": "Success",
"data": [
{
{
"code": 200,
"message": "Success",
"data": [
{
"payer_id": "fcf09fa0-1313-41e8-9c1a-2d2721e4251a",
"entity_type": "individual",
"first_name": "wujing",
"last_name": "lee",
"address": "169 Ayer Rajah Crescent, #01-11 Singapore 413091",
"city": "singapore",
"state_or_province": "singapore",
"country": "SG",
"postal_code": "000000",
"date_of_birth": "1993-10-12",
"identification_type": "passport",
"identification_value": "1003123"
}
]
}
}
]
}
Copy
curl 'https://api.sandbox.uqpay.org/api/v1/payers' \
-H 'x-auth-token: Bearer 0e043e2ec6898b3220a0921466d7c203' \
-H 'x-client-id: Up1HIsjiETPXLy7gON9PMG'
Copy
{
"code": 200,
"message": "Success",
"data": [
{
{
"code": 200,
"message": "Success",
"data": [
{
"payer_id": "fcf09fa0-1313-41e8-9c1a-2d2721e4251a",
"entity_type": "individual",
"first_name": "wujing",
"last_name": "lee",
"address": "169 Ayer Rajah Crescent, #01-11 Singapore 413091",
"city": "singapore",
"state_or_province": "singapore",
"country": "SG",
"postal_code": "000000",
"date_of_birth": "1993-10-12",
"identification_type": "passport",
"identification_value": "1003123"
}
]
}
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.