The
/integrations/vertofx/beneficiaries
endpoint allows creation of new beneficiaries in the VertoFX system.
Method: POST
Request Payload:
Parameter | Type | Description |
---|---|---|
firstName | string | First name of the beneficiary |
lastName | string | Last name of the beneficiary |
string | Email address of the beneficiary | |
bankName | string | Name of the beneficiary’s bank |
accountNumber | string | Bank account number |
currency | string | Currency code (e.g., USD, EUR, NGN) |
beneficiaryCountryCode | string | Country code of the beneficiary |
beneficiaryAddress | string | Address of the beneficiary |
beneficiaryCity | string | City of the beneficiary |
beneficiaryPostcode | string | Postal code of the beneficiary |
beneficiaryEntityType | string | Type of entity (individual, company) |
Authentication
This endpoint requires authentication. Include your bearer token in the Authorization header.Request Body
Request Schema
Field | Type | Required | Description |
---|---|---|---|
firstName | string | ✅ | First name of the beneficiary |
lastName | string | ✅ | Last name of the beneficiary |
email | string | ✅ | Email address of the beneficiary |
bankName | string | ✅ | Name of the beneficiary’s bank |
accountNumber | string | ✅ | Bank account number |
currency | string | ✅ | Currency code (e.g., USD, EUR, NGN) |
beneficiaryCountryCode | string | ✅ | Country code of the beneficiary |
beneficiaryAddress | string | ✅ | Address of the beneficiary |
beneficiaryCity | string | ✅ | City of the beneficiary |
beneficiaryPostcode | string | ❌ | Postal code of the beneficiary |
beneficiaryEntityType | string | ✅ | Type of entity |
beneficiaryCompanyName | string | ❌ | Company name (if entity type is company) |
Responses
✅ 201 - Success
⚠️ 400 - Bad Request
⚠️ 401 - Unauthorized
❌ 500 - Internal Server Error
Tags
VertoFx
Authorizations
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Body
application/json
First name of the beneficiary
Last name of the beneficiary
Email address of the beneficiary
Name of the beneficiary's bank
Bank account number
Currency code (e.g., USD, EUR, NGN)
Country code of the beneficiary
Address of the beneficiary
City of the beneficiary
Type of entity
Available options:
individual
, company
Postal code of the beneficiary
Company name (if entity type is company)