v1

latestOpenAPI 3.1.02026-07-26540161.7 KB

Create a beneficiary

This endpoint is used for creating a Beneficiary.

post/profile/beneficiaries/business/{businessID}

businessIDstring required

The unique Identifier of the parent business or sub account

firstNamestring required

The first name or the company name

lastNamestring

The last name

emailstring

The email

phoneNumberstring

The phone/mobile number the beneficiary can be contacted with

accountHolderNamestring required

The name on the account

typestring required

The value for this field is either corporate or indivdual

currencystring required

The currency

paymentDestinationstring required

This is the type of account payments can be made to e.g bank account

destinationAddressstring required

The account number

uniqueIdentifierstring

unique identifier for the beneficiary e.g 2,gh or anything

200

object required