API Reference
FAQSandbox Portal

Create a Beneficiary

post deprecated
https://api-v3-sandbox.vertofx.com/profile/v2.1/beneficiaries

Create a beneficiary with the correct entity and routing details, store the returned ID, and handle review or RFI states before payout use.

🗓️

This endpoint is deprecated and will be sunset on January 30, 2027. Migrate to the new service-specific route before then — see the Legacy Endpoint Migration Guide for the full mapping.


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.

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.

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

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

Updated 26 days ago

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

Updated 26 days ago

Privacy policy Terms of service

VertoFX Ltd (No. 10973066) designs and operates the VertoFX website and app. VertoFX is authorised by the Financial Conduct Authority under the Electronic Money Regulations 2011, Firm Reference 901073, for the issuing of electronic money. Database rights protect data on VertoFX website(s) (including pricing data).

Please Note: we do NOT and WILL not deal with unregulated exchanges or affiliates as this currently falls outside of our risk appetite.

© Verto 2026

All rights reserved Registered Office: 20-22 Wenlock Road, London, England, N1 7GU