Versions Compared

Key

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

...

Info

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

Sample Request

Update Payment Source Sample Request for Regulated Business Categories

Code Block
languagejson
{
	"restrictPaymentSource": true,
    "allowedPaymentSources": {                     
					"bvns": [
                      	"21212121212",
                         "20202020202"
                ]
}

...

Update Payment Source Sample Request

Code Block
languagejson
{
	"restrictPaymentSource": true,
    "allowedPaymentSources": {                     
            "bankAccounts": [
 			{
    			"accountNumber": "0779311422",
    			"bankCode": "044"
    		},
    		{
    			"accountNumber":"0021764889",
    			"bankCode": "221"
    		},
    		{
    			"accountNumber":"0021764889",
    			"bankCode": "221"
    		}
    	],	
		"accountNames": [
    		"Segun Adeponle Patrick"
    	]	
    }
}

...

Update Payment Source Sample Response

Code Block
languagejson
{
    "requestSuccessful": true,
    "responseMessage": "success",
    "responseCode": "0",
    "responseBody": {
        "restrictPaymentSource": true,
        "allowedPaymentSources": {      
					"bvns": [
                      	"21212121212",
                         "20202020202"
                ], 
            "bankAccounts": [
                {
                    "accountNumber": "0068687503",
                    "bankCode": "232"
                },
                {
                    "accountNumber": "2048714015",
                    "bankCode": "057"
                }
            ],
            "accountNames": [
                "DAMILARE OGUNNAIKE SAMUEL"
            ]
        }
    }
}

...

(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

restrictPaymentSource

A boolean value to activate or de-activate restricting of payment sources for a reserved account. If set to true, at least one of bvns or  accountNames or bankAccounts must be supplied.

bvns

List of BVNs that should be validated.  Any account linked to supplied BVN can fund a reserved account. For merchants in the regulated business category,  only BVNs will be used to allow more payment source

bankAccounts

List of account numbers that can fund the reserved account.

accountNumber

10 digit account number from which reserved account can be funded.

bankCode

3 digit CBN code for the account. Click here for a list of banks.

accountNames

List of account names for accounts from which reserved accounts can be funded.

...