Get Reserved Account Details (V1 Deprecated)

If you want to get the details of a reserved account, you can initiate a GET request to the endpoint below and we will return all the details attached to that account Reference.

This endpoint is protected with OAuth 2.0 Bearer token

Endpoint URL: {{base_url}}/api/v1/bank-transfer/reserved-accounts/{accountReference}

HTTP Method: GET

The {{base_url}} for test is https://sandbox.monnify.com but when you go live, it changes to the live url

Get Reserved Account Details Request

Request Headers Authorization:"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" Request URL GET https://sandbox.monnify.com/api/v1/bank-transfer/reserved-accounts/reference12345

Get Reserved Account Details Response

{ "requestSuccessful": true, "responseMessage": "success", "responseCode": "0", "responseBody": { "contractCode": "797854529434", "accountReference": "reference12345", "accountName": "Test Payment", "currencyCode": "NGN", "customerEmail": "test@tester.com", "accountNumber": "9900725554", "bankName": "Providus Bank", "bankCode": "101", "reservationReference": "NRF72EMEBCGNN6WUKD35", "status": "ACTIVE", "createdOn": "2019-08-07 17:05:50.0", "contract": { "name": "Default Contract", "code": "797854529434", "description": null }, "transactionCount": 0, "incomeSplitConfig": [ { "subAccountCode": "MFY_SUB_319452883228", "feePercentage": 10.50, "feeBearer": true, "splitPercentage": 20.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

Field

Description

accountReference (M)

Your unique reference used to identify this reserved account

accountName 

The name you want to be attached to the reserved account. This will be displayed during name enquiry

currencyCode 

Currency for transactions to this reserved account. Should be “NGN”

contractCode 

Contract Code (See your Monnify dashboard)

customerEmail 

Email address of the customer who the account is being reserved for. This is the 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 

Object containing specifications on how payments to this reserve account should be split.

subAccountCode 

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