Create Beneficiary Profile

Create beneficiaries against which you can map a payment address and then intitate payouts or request settlements.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

API Endpoints


Below are the API endpoints to be used by the platform basis the environments.


Beneficiary Utilisation Behaviour:

  1. A beneficiary profile can be mapped at two distinct levels
    1. Consumer URN
      1. Mapping a beneficiary at this level allows all Virtual Currency Account to utilise the beneficiary profile
    2. Virtual Currency Account
      1. Mapping a beneficiary at this level allows only the specified Virtual Currency Account to utilise the beneficiary profile.
      2. Please pass the virtual_account_number value in the request payload to enforce payouts to the specified beneficiary from the specified virtual currency account.
  2. The Map Payment Address API should be used to map the account details to the beneficiary.
    1. A beneficiary profile can have multiple payment addressed mapped against it but only once payment address can be set as the default account.
🙌

Important Note

Please use only Staging Credentials on each API Reference page to test the APIs directly from our Documentation.

Body Params
string
required
Defaults to test123

A unique identifier assigned by the merchant/client platform for every API request.

string
required
Defaults to CON_423F715E7FF54C3D8B69668DB2F8CCBA

A unique identifier assigned by Decentro during onboarding.

string
required
Defaults to First Last

The full name of the beneficiary

string
required
Defaults to Mobile Number

The mobile number of the beneficiary. Please pass the value without the country dialling code.

string
required
Defaults to email

The e-mail address of the beneficiary.

string

The Virtual (Currency) Account number for which the beneficiary is being created. If no value is passed against this parameter, the beneficiary can be utilised by any Virtual Account mapped to the consumer_urn.

address
object
required

Data block containing the address of the beneficiary

Headers
string
required

The client identifier assigned by Decentro during onboarding.

string
required

The authorisation secret assigned by Decentro during onboarding.

string

Optional header that allows parent merchant to consume the API on behalf of sub-merchant.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json