Payers
Get Payers List
Get a list of Payers using criteria passed in the query string. Page through the result set to access all records.
Authorization
bearerAuth AuthorizationBearer <token>
Access token from POST /accesstoken, sent as Authorization: Bearer <token>.
In: header
Query Parameters
from_time_created?string
The start time to search for in a range, using the resource time_created value.
Format
dateto_time_created?string
The end time to search for in a range, using the resource time_created value.
Format
dateid?string
Unique identifier for the Payer on the platform.
Length
1 <= length <= 50reference?string
This is a label set by the integrator to identify the Payer
Length
1 <= length <= 50Header Parameters
X-GP-Version*string
The version of the API to execute the request.
Length
1 <= length <= 50Default
"2021-03-22"Response Body
application/json
curl -X GET "https://example.com/payers" \ -H "X-GP-Version: 2021-03-22"{ "total_record_count": 2, "current_page_size": 2, "merchant_id": "MER_c5d37eaf0e3841e083c232b2318af55c", "merchant_name": "Sandbox_Merchant_4", "account_id": "TKA_c1de85a8a5844c56abd9ca07bbd792c8", "account_name": "tokenization", "filter": { "from_time_created": "2025-08-08T00:00:00.000Z", "to_time_created": "2025-08-11T23:59:59.999Z" }, "paging": { "page_size": 5, "page": 1, "order": "ASC", "order_by": "TIME_CREATED" }, "payers": [ { "id": "PYR_7919a41f45e74ea4b8eada36ec1e1777", "time_created": "2025-08-08T09:24:59.000Z", "time_last_updated": "2025-08-08T09:24:59.000Z", "first_name": "JXXXXXX", "last_name": "MXXXXXXX", "reference": "Testing_Payer_Encrypted" }, { "id": "PYR_2ee5480308664428bef46d1094f22adc", "time_created": "2025-08-11T11:39:03.000Z", "time_last_updated": "2025-08-11T11:46:42.000Z", "first_name": "JXXX", "last_name": "JXXXX", "reference": "Testing_Payer_Encrypted", "payment_methods": [ { "id": "PMT_ffc2fc7e-7292-4f3b-9798-5c231414158a", "default": "YES" } ] } ], "action": { "id": "ACT_uFfh1AV7y6m0RJyu7HaJnwBvYhowkU", "type": "PAYER_LIST", "time_created": "2025-08-11T11:49:37.525Z", "result_code": "SUCCESS", "app_id": "T6og1tbECpHFeO104qUM383oq5bOJ12r", "app_name": "Postman_Collection_Test" }}