To reserve an account on Monnify, you’ll need to call the reserve account endpoint providing the information in the table below (remember to also add the authentication header)
...
Info | ||
---|---|---|
| ||
POST: https://sandbox.monnify.com/api/v1/bank-transfer/reserved-accounts/limit |
This endpoint is protected with OAuth 2.0 (Bearer Tokens)
...
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "requestSuccessful": true, "responseMessage": "success", "responseCode": "0", "responseBody": { "contractCode": "915483727511", "accountReference": "ref-007", "accountName": "Kan Yo' Reserved with Limit ", "currencyCode": "NGN", "customerEmail": "KanYo@monnify.com", "customerName": "Kan Yo", "accountNumber": "9907335053", "bankName": "Providus Bank", "bankCode": "101", "reservationReference": "QSD79W83J766XMFYM58L", "status": "ACTIVE", "createdOn": "2019-10-29 13:59:37.983", "incomeSplitConfig": [ { "subAccountCode": "MFY_SUB_319452883228", "feePercentage": 10.5, "feeBearer": true, "splitPercentage": 20 } ], "limitProfileConfig": { "limitProfileCode": "2XKTQ3LE9NH2", "singleTransactionValue": 70000.00, "dailyTransactionVolume": 4000, "dailyTransactionValue": 100000000.00 } } } } } |
Field Reference
(M) indicates fields that are mandatory in the request body. (m) Indicates fields that are mandatory only if the parent object is not empty.
Field | Description |
---|---|
accountReference (M) | Your unique reference used to identify this reserved account |
accountName (M) | The name you want to be attached to the reserved account. This will be displayed during name inquiry |
limitProfileCode(M) | The unique identifier that references the limit profile to associate with the reserved accounts. |
currencyCode (M) | Currency for transactions to this reserved account. Should be “NGN” |
contractCode (M) | Contract Code (See your Monnify dashboard) |
customerEmail (M) | The email address of the customer who the account is being reserved for. This is a unique identifier for each customer. |
customerName | Full name of the customer who the account is being reserved for |
customerBvn | BVN of the customer the account is being reserved for. Please note that if BVN is not supplied there will be low limits on the reserved account. |
incomeSplitConfig | The object containing specifications on how payments to this reserve account should be split. |
subAccountCode (m) | The unique reference for the sub-account that should receive the split. |
feeBearer | Boolean to determine if the sub-account should bear transaction fees or not |
feePercentage | The percentage of the transaction fee to be borne by the sub-account |
splitPercentage | The percentage of the amount paid to be split into the sub-account. |
bankName | Name of the bank where the virtual account was created |
bankCode | Bank code of the bank where the virtual account was created |
accountNumber | virtual account number generated for the accountReference (Reserved account number) |
status | Status of the reserved account number ("ACTIVE" means the account can be used) |
createdOn | Date reserved account was created |
Related Articles
Filter by label (Content by label) | ||||||
---|---|---|---|---|---|---|
|