Update a Beneficiary

put

https://api-v3-sandbox.vertofx.com/profile/v2.1/beneficiaries/{beneficiaryId}

This service is used to update a beneficiary by specifying by their ID.

Beneficiaries undergo an approval process once they are updated. 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.

Path Params

beneficiaryId

number

required

A unique identifier assigned to the beneficiary of the foreign exchange transaction. This field specifies the recipient of the funds being transferred or converted.

This beneficiaryId is generated in the response object [response.body.account.id] of the Create a Beneficiary.

Body Params

beneficiaryEntityType

string

enum

required

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

Allowed:

beneficiaryFirstName

string

Conditional

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

beneficiaryLastName

string

Conditional

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

beneficiaryCompanyName

string

Conditional

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

beneficiaryEmail

string

Email of the benficiary.

currency

string

enum

required

length between 3 and 3

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

beneficiaryCountryCode

string

required

2-character ISO 3166 country code.

accountNumber

string

required

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

nationalId

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.

country

string

required

Name of the Beneficiary country.

clientReference

string

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

isMobileMoney

boolean

required

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

Responses

200Success

400Bad Request

401Unauthorized

403Forbidden

404Not Found

500Internal Server Error