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

1curl -G https://api-demo.airwallex.com/api/v1/payers \
2  -H 'Authorization: Bearer {{ACCESS_TOKEN}}' \
3  --data-urlencode 'entity_type=COMPANY' \
4  --data-urlencode 'from_date=2017-04-01' \
5  --data-urlencode 'page_num=0' \
6  --data-urlencode 'page_size=100' \
7  --data-urlencode 'to_date=2030-01-01T00:00:00+0000'

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

1{
2  "has_more": false,
3  "items": [
4    {
5      "id": "46c22228-5831-4c53-a4fa-a3ab4954877c",
6      "nickname": "Complete Concrete Pty Ltd",
7      "payer": {
8        "additional_info": {
9          "business_registration_number": "EU300503",
10        },
11        "address": {
12          "city": "Melbourne",
13          "country_code": "AU",
14          "postcode": "3000",
15          "state": "VIC",
16          "street_address": "15 William Street"
17        },
18        "company_name": "Complete Concrete Pty Ltd",
19        "entity_type": "COMPANY"
20      }
21    }
22  ]
23}

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

Shell

1curl -G https://api-demo.airwallex.com/api/v1/payers/{{ID}} \
2  -H 'Authorization: Bearer {{ACCESS_TOKEN}}'

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.

Was this page helpful?