Manage your beneficiaries
To add, query and remove beneficiaries before making a transfer, you can use the following APIs:
- inquiryBeneficiaryTemplate: Obtain the beneficiary template
- bindBeneficiary: Bind a beneficiary to a WorldFirst account.
- editBeneficiary: Edit the beneficiary information.
- removeBeneficiary: Remove a beneficiary from a WorldFirst account.
- inquiryBeneficiaryList: Inquire about all beneficiaries connected to a WorldFirst account.
Workflow
The following graphic shows the general process for managing beneficiaries with WorldFirst APIs.
Figure 1. Workflow to manage beneficiaries with WorldFirst APIs
Procedures
Step 1: Obtain beneficiary templates
Call the inquiryBeneficiaryTemplate API to obtain templates for a beneficiary.
Step 2: Add, edit, inquire or remove a beneficiary
1. Add a beneficiary
Call the bindBeneficiary API to bind the beneficiary's bank card.
2. Edit a beneficiary
Call the editBeneficiary API to edit the beneficiary's information, such as the nickname.
3. Inquire about existing beneficiaries
Call the inquiryBeneficiaryList API to query a list of existing beneficiaries.
4. Remove a beneficiary
Call the removeBeneficiary API to remove a beneficiary.