Retrieve payers
Retrieve a list of payers
Call Get list of payers API to retrieve saved payer information. You can specify the time period when the payer was created (from_date, to_date) and the pagination parameters (page_num, page_size) to refine the results. You can also use other filters such as entity_type and nick_name. The response will return a list of payers, each in the same manner as in the response body of Create a payer API.
Example request
If you are registered as a platform account, you can call this endpoint on behalf of your connected accounts by specifying the open ID in the x-on-behalf-of header.
Example response
Retrieve details of a payer
Call Get a payer by ID API to retrieve details of a specific saved payer, by specifying the id in the endpoint URL. A successful request will return the payer details in the same manner as in the response body of Create a new payer API.
Example request
If you are registered as a platform account, you can call this endpoint on behalf of your connected accounts by specifying the open ID in the x-on-behalf-of header.