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_methodsnicknamebeneficiary.date_of_birthbeneficiary.addressbeneficiary.bank_details- some fields inside
beneficiary.additional_infobusiness_phone_numberbusiness_registration_numberlegal_rep_first_name_in_chineselegal_rep_last_name_in_chineselegal_rep_id_numberlegal_rep_mobile_numberlegal_rep_bank_account_numberpersonal_emailpersonal_id_numberpersonal_id_typepersonal_mobile_number
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.
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
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.