Post Beneficiary

Use this endpoint to create a beneficiary

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

Beneficiary request detail

string
required

The alias to identify this beneficiary

string
required

The beneficiary's bank code.

string

The beneficiary's account number. Required when country is NG, or when ibanNumber is not provided.

string

The beneficiary's bank swift code. Required when country is not NG and ibanNumber is not provided.

string

Bank routing number (optional).

string
enum
required

The beneficiary's country code (e.g., "NG" for Nigeria).

string
enum
required

The type of beneficiary (e.g., "individual" for an individual beneficiary).

Allowed:
string
enum
required

The payment beneficiary classification.

Allowed:
string
required

The name of the beneficiary's company (applicable for business beneficiarys).

string

The registration number of the beneficiary's business (applicable for business beneficiary).

date

The registration date of the beneficiary's business (applicable for business beneficiary).

string

The state where the beneficiary is located.

string

The city where the beneficiary is located.

string

The beneficiary's tax identification number.

string
enum

Required for Nigerian businesses (country = NG).

Allowed:
string
required

The nature of the relationship with the beneficiary (e.g., "trade").

string
required

The beneficiary's address.

string

International Bank Account Number

string
enum

The bank account currency. Required when country is not NG.

string

Required for Kenyan businesses (country = KE). Must be exactly 5 digits.

string

Optional document id returned from the documents upload endpoint.

Responses

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