Create a Beneficiary

This service is used to create a beneficiary through the Verto API. Beneficiaries undergo an approval process once they are created. This is subject to the type of business, if you are a money serving business, beneficiaries will go through an approval process in the live environment.

Body Params
string
enum
required

This denotes the type of the beneficiary you intend to add.

Allowed:
string

Conditional

If the beneficiary is an individual in beneficiaryEntityType field, then you'll need to add this value.

string

Conditional

If the beneficiary is an individual in beneficiaryEntityType field, then you'll need to add this value.

string

Conditional

If the beneficiary is a company in beneficiaryEntityType field, then you'll need to add this value.

string

Email of the benficiary.

string
enum
required
length between 3 and 3

3-character ISO 4217 currency code in which a beneficairy is holding their account.

string
required

2-character ISO 3166 country code.

string
required

Indicates the beneficiary account number. Pass phone number in the accountNumber field if isMobileMoney is set to true. e.g. "+254-900888380

string
required

A unique alphanumeric identifier assigned to financial institutions worldwide. It typically consists of 6 to 11 characters and provides essential information about the bank, country, and location.

For examples: Sort code, Swift code, ABA code, BIC code, IFSC code or Routing number.

For Mobile Money, examples are M-Pesa, Tigo and Airtel for TZS and M-Pesa for KES.

string
required

Name of the Beneficiary country.

string

You can pass a client reference to be stored for this beneficiary.

boolean
required

set this field equal to ‘true’ if you’re creating a beneficiary for a mobile money wallet.

Responses

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