Manage your beneficiaries

You might consider adding, querying, and removing beneficiaries before making a transfer.

The following graphic illustrates the beneficiary management process:

image

Figure 1. Manage beneficiaries with WorldFirst APIs

  1. 1

    Feature 1. Obtain beneficiary templates

    1 step Collapse all Expand all

    Click on the Expand all button to view steps to obtain beneficiary templates. The template includes descriptions and rules that need to be applied to fields such as the beneficiary's bank account number, routing number/IBAN, etc.

      1. 1. Inquire beneficiary templates

        Mark the card Unmark the card

        Call the inquiryBeneficiaryTemplate API to obtain templates for a beneficiary.

    • 2

      Feature 2. Add, inquire, remove a beneficiary

      3 steps Collapse all Expand all

      Click on the Expand all button to view steps to manage beneficiaries with WorldFirst APIs. 

      1. 1. Add a beneficiary

        Mark the card Unmark the card

        Call the bindBeneficiary API and bind the beneficiary's bank card.

      2. 2. Inquire existing beneficiaries

        Mark the card Unmark the card

        Call the inquiryBeneficiary API to query a list of the existing beneficiaries.

      3. 3. Remove a beneficiary

        Mark the card Unmark the card

        Remove a beneficiary by calling the removeBeneficiary API.