Manage beneficiaries

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

Update a beneficiary

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

The list of parameters that can be updated:

• transfer_methods
• nickname
• beneficiary.date_of_birth
• beneficiary.address
• beneficiary.bank_details
• some fields inside beneficiary.additional_info
  • business_phone_number
  • business_registration_number
  • legal_rep_first_name_in_chinese
  • legal_rep_last_name_in_chinese
  • legal_rep_id_number
  • legal_rep_mobile_number
  • legal_rep_bank_account_number
  • personal_email
  • personal_id_number
  • personal_id_type
  • personal_mobile_number

Example request

1curl -X POST https://api-demo.airwallex.com/api/v1/beneficiaries/{{BENEFICIARY_ID}}/update \
2  -H 'Content-Type: application/json' \
3  -H 'Authorization: Bearer {{ACCESS_TOKEN}}' \
4  -d '{
5    "address": {
6      "city": "Seattle",
7      "country_code": "US",
8      "postcode": "98104",
9      "state": "Washington",
10      "street_address": "412 5th Avenue"
11    }
12  }'

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 beneficiary

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

Example request

1curl -X POST https://api-demo.airwallex.com/api/v1/beneficiaries/delete/{{BENEFICIARY_ID}} \
2  -H 'Content-Type: application/json' \
3  -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.