Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

To reserve an account on Monnify, you’ll need to call the reserve account endpoint, see specifications below(remember to also add the authentication header).

...

Reserve Account Request (Get an account for preferred partner bank onlybanks)

Code Block
languagejson
Request Headers
Content-Type:"application/json"
Authorization:"Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"


Request Body
{
	"accountReference": "abc123",
	"accountName": "Test Reserved Account",
	"currencyCode": "NGN",
	"contractCode": "8389328412",
	"customerEmail": "test@tester.com",
	"bvn": "21212121212",
	"customerName": "John Doe", 
    "getAllAvailableBanks": false,
    "preferredBanks": ["035","232","50515","058"]
}

Once an account number has been reserved for a customer, the customer can make payment by initiating a transfer to that account number at any time. Once the transfer hits the partner bank, you will be notified with the transfer details along with the account reference you specified when reserving the account. 

Info

Split payments on Reserved Accounts

incomeSplitConfig allows you to use split payments with your reserved accounts by specifying one or more sub-account(s) and a specific percentage of each payment to be credited into each sub-account. IncomeSplitConfig is an array of objects so you can split into multiple sub-accounts per transaction.

Reserve Account Request with SubAccount

...

Code Block
languagejson
{
    "requestSuccessful": true,
    "responseMessage": "success",
    "responseCode": "0",
    "responseBody": {
        "contractCode": "915483727511222001311614",
        "accountReference": "121614155748257abc1234",
        "accountName": "reservedAccountNameTes",
        "currencyCode": "NGN",
        "customerEmail": "nnaemekapaschal@gmailtest@tester.com",
        "customerName": "PascoolJohn Doe",
        "accounts": [
            {
                "bankCode": "232",
                "bankName": "Sterling bank",
                "accountNumber": "8952095784",
                "accountName": "Tes"
            },
            {
                "bankCode": "035",
                "bankName": "Wema bank 1",
                "accountNumber": "7206930470",
                "accountNumberaccountName": "0000000033Tes"
            },
            {
                "bankCode": "50515",
                "bankName": "Moniepoint Microfinance Bank 2",
                "accountNumber": "6254727989",
                "accountName": "Tes"
            },
            {
                "bankCode": "058",
                "bankName": "GTBank",
                "accountNumber": "0784829227",
                "accountName": "8000021118Tes"
            }
        ],
        "collectionChannel": "RESERVED_ACCOUNT",
        "reservationReference": "V5R4D9JKC9X9GNJR5QLRNWA7DMJ0W2UDK1KN5SLF",
        "reservedAccountType": "GENERAL",
        "status": "ACTIVE",
        "createdOn": "20212023-0204-2414 0912:3504:4939.161034",
        "incomeSplitConfig": [],
        "bvn": "21212121212",
        "restrictPaymentSource": false
    }
}

...