Manage payers

You can perform the following operations on payers after you have created them.

Update a payer

After a payer is created, you can call Update existing payer API to update the saved payer information. Specify the id in the endpoint URL and any parameters you wish to update in your request body. The same schema validation and response body as in Create a new payer API will apply.

Example request

Shell
1curl --request POST \
2--url 'https://api-demo.airwallex.com/api/v1/payers/update/<id>' \
3--header 'Content-Type: application/json' \
4--header 'Authorization: Bearer <your_bearer_token>' \
5--data '{ 
6  "payer": { 
7    "address": { 
8      "city": "Melbourne", 
9      "country_code": "CN", 
10      "postcode": "3000", 
11      "state": "VIC", 
12      "street_address": "15 William Street"
13    }, 
14  } 
15}'
16

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.

Delete a payer

Call Delete existing payer API to delete a payer. Specify the id in the endpoint URL. A successful deletion returns true in the response.

Example request

Shell
1curl --request POST \
2--url 'https://api-demo.airwallex.com/api/v1/payers/delete/<id>' \
3--header 'Content-Type: application/json' \
4--header 'Authorization: Bearer <your_bearer_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.