Create Beneficiary

This API is used to create and register a beneficiary to whom payouts or transfers can be made.

(Example: Individual Beneficiary)

The beneficiary creation process is dynamic and consists of multiple steps:

  1. Beneficiary Type & Region Details
    Users select the beneficiary type (Individual or Business) and specify the beneficiary’s country and currency. Based on these selections, the system determines the applicable data requirements.
  2. Additional Details
    Users provide the required beneficiary information, which may include:
    1. Personal or business details (name, email, mobile number)
    2. Address information
    3. Bank account details (account name, account number, account type, IFSC / bank codes)
    4. Service bank and purpose of transaction

The required fields and validations are dynamically generated based on the beneficiary type, country, and currency to ensure compliance with local regulations.

Once successfully created, the beneficiary is saved to the user’s account and can be selected for future payout transactions.

Body Params
string
enum
required
Allowed:
string
required

ISO alpha code - 3

string
required
Defaults to USD
Headers
string
required

Identifies the merchant making the request.

string
required

Public API key associated with the merchant.

string
required

RSA signature generated from the HMAC hash of the request payload.

string
required

Current UNIX timestamp (in seconds). Used to prevent replay attacks.

string
required

Unique UUID per request

Response

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