Versions Compared

Key

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

...

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

...

Sample Reserve Account (Invoice) Request

Code Block
languagejson
{
    "contractCode	"accountReference": "166813296212abc123708",
    	"accountName": "JaneTest Reserved DoeAccount",
    	"currencyCode": "NGN",
	"contractCode":    "accountReference"100693167467",
	"customerEmail": "janedoe12233test@tester.com",
	"customerName": "John Doe",
 	"customerEmailgetAllAvailableBanks": "janedoe@gmail.com"false,
    "customerNamepreferredBanks": "Jane Doe"["035","232","50515"],
    "reservedAccountType": "INVOICE"
}

Sample Reserve Account (Invoice) Response

Code Block
languagejson
{
    "requestSuccessful": true,
    "responseMessage": "success",
    "responseCode": "0",
    "responseBody": {
        "contractCode": "166813296212100693167467",
        "accountReference": "janedoe12233abc123708",
        "accountName": "Jane DoeTes",
        "currencyCode": "NGN",
        "customerEmail": "janedoe@gmailtest@tester.com",
        "customerName": "John Doe",
     "Paschal Ezenwankwo",   "accounts": [
            {
                "bankCode": "50515",
                "bankName": "Moniepoint Microfinance Bank",
                "accountNumber": "6106424552",
         "1122334455",       "accountName": "Tes"
            },
            {
                "bankCode": "232",
                "bankName": "GTBank",Sterling bank",
                "accountNumber": "8947206823",
                "accountName": "Tes"
            },
            {
                "bankCode": "035",
                "bankName": "Wema bank",
                "accountNumber": "7203133878",
                "accountName": "Tes"
            }
        ],
        "collectionChannel": "058RESERVED_ACCOUNT",
        "reservationReference": "KN5PYJ78PLSX7ET2U0M1NB8XNYZASVFTRN9",
        "reservedAccountType": "INVOICE",
        "status": "INACTIVE",
        "createdOn": "20192023-0704-1819 1412:4648:12.591"25.496",
        "incomeSplitConfig": [],
        "bvn": "21212121212",
        "restrictPaymentSource": false
    }
}

Info

The status is INACTIVE because the reserved account is of type INVOICE and no invoice is currently attached to the account. Once an invoice is attached, the account becomes active.


Attaching a Reserved Account to an Invoice

...

Code Block
languagejson
{
    "amount": "999",
    "invoiceReference": "1838913182abc123708",
	"accountReference": "janedoe12233",
    "description": "test invoice",
    "currencyCode": "NGN",
    "contractCode": "38238193818",
    "customerEmail": "janedoe@gmail.com",
    "customerName": "Jane Doe",
    "expiryDate": "2019-10-30 12:00:00"
}

...