Search...
Log inGet started
Airwallex logo
Home
Core API
Payments
Transactional FX
Payouts
Issuing
Back to home
OverviewHow Airwallex Payouts work
Payout network
Use cases
Payers
Create a payerValidate a payerRetrieve payers
Manage payers
Test and go live
Older API versions

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

Shell

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

JSON

Retrieve details of a payer

Call Get a payer by ID API to retrieve details of a specific saved payer, by specifying the payer_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

Shell

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.