Step by Step on how to creat a beneficiary

In order to create a beneficiary please follow these steps:

Note: Beneficiary creation depends on the eligibility of a customer, please retrieve the countries to which a customer can create beneficiaries from the Get a particular customer detail API

  1. Get countries returns the available countries for offramps
    1. Key considerations: available_methodsfor a particular country
  2. Get method list returns will return all the ids of the methods available in a particular country. A method is essentially the name of the banks / e-wallets available in a particular country. And an indicator if the particular method (which is essentially a bank / e-wallet) has any branch or not.
    1. For some countries there might be only one method available, example of such corridors might be GBR, EUR, etc.
    2. Key considerations: method_id, has_branch -> true / false
  3. Only call if has_branch = true. Get branches returns the branch names, ids and branch_code which is the routing number for a particular branch.
  4. Key considerations: branch_id
  5. Get required fields to create a beneficiary returns all the required fields needed to create a beneficiary
    1. Utilising the data that you have collected from the previous few APIs, you need to define the key beneficiary information and the API will return all the required fieldss.
    2. Key considerations: all the key and validation_rule for you to craft the beneficiary request for the next API - Create a new beneficiary
  6. Create a new beneficiary will allow you to create a beneficiary under a customer using the key values you got in Get required fields to create a beneficiary