v1
latestOpenAPI 3.1.02026-07-24416405768.8 KBAdd a new beneficiary for the customer
Creates a new beneficiary
Path parameters
Request body
Beneficiary account holder name
Optional. Account type of beneficiary account details.
Beneficiary address1
Beneficiary address2
Alias (some friendly name)
Beneficiary's bank account number
Bank Identification Code(BIC) unique identifier for a specific financial institution
Beneficiary's Bank name
Account Id of Beneficiary's account
Beneficiary's branch code
Beneficiary's city
Beneficiary postal code
Beneficiary's country
Beneficiary's Date of birth must be in form of yyyyMMdd
Beneficiary first/given name
International Bank Account Number unique identifier for a specific customer
Beneficiary identity number
Beneficiary last name
Beneficiary middle name
Beneficiary mobile-money network
Beneficiary mobile number
Optional. If true, the beneficiary will not be created, but the account number will be validated in AVS to confirm its eligibility for the transaction.
Reference (some reference name)
Optional. If true, the beneficiary will be created only if the beneficiary status is ACTIVE.
Beneficiary's state
Beneficiary's wallet-Id
Response
OK
Beneficiary account holder name
Optional. Account type of beneficiary account details.
Beneficiary address1
Beneficiary address2
Alias (some friendly name)
Beneficiary's bank account number
Bank Identification Code(BIC) unique identifier for a specific financial institution
Beneficiary's Bank name
Unique Id of Beneficiary
Beneficiary's branch code
Beneficiary's city
Beneficiary postal code
Beneficiary's country
ISO 8601 date/time of when the record was first created
Id of Customer
Beneficiary's Date of birth must be in form of yyyyMMdd
Beneficiary first/given name
International Bank Account Number unique identifier for a specific customer
Beneficiary identity number
ISO 8601 date/time of when the record was last modified
Beneficiary last name
Beneficiary middle name
Beneficiary mobile-money network
Beneficiary mobile number
Id of Organisation
Reference (some reference name)
Beneficiary's state
Beneficiary's wallet-Id
Example response
{
"created": "2022-03-10T12:15:50-04:00",
"lastModified": "2022-03-10T12:15:50-04:00"
}