Add Beneficiary
In order to carry out a global remittance or Naira Payout transactions, we appreciate sending fund to an existing beneficiary you have added to your account.
Managing the beneficiary help streamline any error to be encountered or mistakes on information provided while doing transaction. It will also eradicate the process of supplying same information to and you can always send fund to an existing information.
Add Beneficiary
Beneficiary Verification
You can check what required and regex for each field before adding a beneficiary.
POST METHOD
{{baseUrl}}api/v2/beneficiary
{
"beneficiaryType":1,
"beneficiaryEmail":"[email protected]",
"cur":"NGN",
"bankName":"GTBank",
"bankCode":"058",
"accountName":"John Doe",
"accountNo":"0030159712",
"bankRoutingNo":"",
"swift": "",
"iban": "",
"accountType": 1,
"bankAddress" : "Address of Bank",
"bankCity" : "City",
"bankState" : "State",
"bankZipcode" : "State",
"bankCountry" : "NG",
"country":"NG",
"address":"address",
"city":"IBADAN-25181",
"state":"Oyo-NIG32",
"zipcode":"23402",
"cpf": "",
"mobile":"08080635172",
"IDNumber":"",
"IDType": "",
"correspondentBankName": "",
"correspondentBankCode": "",
"correspondentAccountNumber": "",
"correspondentRoutine": ""
}
| Field | Required | Data Type | Description |
|---|---|---|---|
| beneficiaryType | true | Integer | (1 => Individual beneficiary, 2 => Business Beneficiary) |
| beneficiaryEmail | - | Required when adding Business beneficiary i.e beneficiaryType == 2 | |
| cur | true | String | Length: 3, Currency ISO code i.e USD |
| bankName | true | String | Bank Name. You can get List of banks in Nigeria |
| bankCode | true | String | Bank Code. You can get bankCode for Nigeria from List of Nigeria Banks or through IBAN/SWIFT/ROUTINE verification |
| accountName | true | String | Account Name of the Beneficiary |
| accountNo | true | String | Account Number or IBAN of Beneficiary. |
| country | true | String | Country ISO code i.e US |
| bankRoutingNo | - | string | Required if Country is US, CA. You can also verify the Routing Number |
| swift | - | String | Required when Currency is USD |
| iban | - | String | required for International Transaction on GBP or EUR |
| accountType | true | Integer | Beneficiary Account Type. (1 => Savings, 2 => Checking, 3 => Ordinary) |
| bankAddress | - | String | Bank Address |
| bankState | - | String | Bank State |
| bankCity | - | String | Bank City |
| bankZipcode | - | String | Bank Zipcode or Postal Code |
| bankCountry | - | String | Bank Country ISO ( US, CA, NG) |
| address | true | string | Address of the Beneficiary |
| city | true | string | Resident City of Beneficiary. Check City endpoint to get cityID and cityName, supply both cityID and cityName i.e IBADAN-25181 |
| state | true | String | Resident State of Beneficiary. Check State endpoint to get stateID and stateName, supply both stateID and stateName i.e Oyo-NIG32 |
| zipcode | true | string | Zipcode or Postal Code of the Beneficiary |
| country | true | string | Country Code ISO ( US, CA, NG) |
| mobile | true | Tel | Beneficiary Phone Number with Country Code |
| cpf | - | String | Required if Country is Russia |
| IDNumber | false | String | Beneficiary Identification Number |
| IDType | false | String | Beneficiary Identification Type |
| correspondentBankName | false | String | Beneficiary Correspondent Bank Name. Required if Needed |
| correspondentBankCode | false | String | Beneficiary Correspondent Bank Code. Required if Needed |
| correspondentAccountNumber | false | String | Beneficiary Correspondent Bank Account Number. Required if Needed |
| correspondentRoutine | false | String | Beneficiary Correspondent Routing Number. Required if Needed |
Response
{
"status": true,
"content": {
"data": {
"id": 44,
"beneficiaryType": "1",
"cur": "NGN",
"beneficiaryEmail": "[email protected]",
"bankCode": "058",
"bankName": "GTBank",
"bankAddress": "Address of Bank",
"bankState": "State",
"bankCity": "City",
"bankZipcode": "State",
"country": "NG",
"accountName": "John Doe",
"accountNo": "0030159712",
"accountType": 1,
"swift": "",
"bankSortCode": "",
"bankRoutingNo": "",
"state": "Oyo",
"address": "address",
"zipcode": "23402",
"beneficiaryCountry": "NG",
"stateId": "NIG32",
"city": "IBADAN",
"cityId": "25181",
"bankCodeType": "",
"mobile": "08080635172",
"IDType": "",
"IDNumber": "",
"cpf": "",
"correspondentBankName": null,
"correspondentBankCode": null,
"correspondentAccountNumber": null,
"correspondentRoutine": null,
"updated_at": "2023-02-22T17:38:49.000000Z",
"created_at": "2023-02-22T17:38:49.000000Z",
}
}
}
Updated over 1 year ago