Page tree
Skip to end of metadata
Go to start of metadata

Monnify allows you Reserve an Account for your customers who you send invoices to. You can then attach these accounts to invoices being generated so the customer always receives the same account number for any invoice he receives. These accounts are slightly different from regular customer reserved accounts as customers cannot pay into these accounts until they are attached to an invoice. Basically, the account number is only active when attached to an invoice.


NB

Only one invoice can be attached to a Reserved Account at a time.


Reserving An Account (Invoice)

To create a reserved account invoice, send a request to the reserved account endpoint.

Endpoint

POST: https://sandbox.monnify.com/api/v1/bank-transfer/reserved-accounts

This endpoint is protected with OAuth 2.0 (Bearer Tokens)


Here is a sample request and response

Reserve Account (Invoice) Request
{
    "contractCode":"166813296212",
    "accountName":"Jane Doe",
    "currencyCode":"NGN",
    "accountReference": "janedoe12233",
    "customerEmail": "janedoe@gmail.com",
    "customerName": "Jane Doe",
    "reservedAccountType": "INVOICE"
}


Reserve Account (Invoice) Response
{
    "requestSuccessful": true,
    "responseMessage": "success",
    "responseCode": "0",
    "responseBody": {
        "contractCode": "166813296212",
        "accountReference": "janedoe12233",
        "accountName": "Jane Doe",
        "currencyCode": "NGN",
        "customerEmail": "janedoe@gmail.com",
        "customerName": "Paschal Ezenwankwo",
        "accountNumber": "1122334455",
        "bankName": "GTBank",
        "bankCode": "058",
        "reservationReference": "KN5PYJ78PLSX7ET",
        "reservedAccountType": "INVOICE",
        "status": "INACTIVE",
        "createdOn": "2019-07-18 14:46:12.591"
    }
}


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

To attach an invoice to a Reserved Account, you simply need to include the accountReference of the reserved account in the create invoice request.

Endpoint

POST: https://sandbox.monnify.com/api/v1/invoice/create

This endpoint is protected with Basic Authentication

When the request is sent, an account number will be returned. The account number that will be returned will be the account number that was reserved using the accountReference specified.

Create Invoice Request
{
    "amount": "999",
    "invoiceReference": "1838913182",
	"accountReference": "janedoe12233",
    "description": "test invoice",
    "currencyCode": "NGN",
    "contractCode": "38238193818",
    "customerEmail": "janedoe@gmail.com",
    "customerName": "Jane Doe",
    "expiryDate": "2019-10-30 12:00:00"
}
Create Invoice Response
{
    "requestSuccessful": true,
    "responseMessage": "success",
    "responseCode": "0",
    "responseBody": {
        "amount": 999,
        "invoiceReference": "1838913182",
        "invoiceStatus": "PENDING",
        "description": "test invoice",
        "contractCode": "4876165459",
        "customerEmail": "janedoe@gmail.com",
        "customerName": "Jane Doe",
        "expiryDate": "2019-10-18 14:48:00",
        "createdBy": "MK_TEST_VR7J3UAACH",
        "createdOn": "2019-08-27 23:14:29",
        "checkoutUrl": "https://sandbox.sdk.monnify.com/checkout/MNFY|20190827231429|000340",
        "accountNumber": "1122334455",
        "accountName": "Jane Doe",
        "bankName": "GTBank",
        "bankCode": "058"
    }
}

Once the invoice is generated, the customer can pay by simply doing a transfer to the virtual account number generated or via their debit card using the checkout URL. Once the customer pays, we will notify you via your Webhook URL. 

Webhook URL

Need help on how to implement your webhook url? Click here

Field Reference

(M) indicates fields that are mandatory in the request body

FieldDescription
amount (M)The amount to be paid by the customer
invoiceStatusStatus of the invoice. Can be either "PAID", "PENDING" or "EXPIRED"
currencyCode (M)The currency of the transaction being initialized. "NGN"
invoiceReference (M)Merchant's Unique reference for the invoice.
accountReference (M)Your unique reference used to identify this reserved account
customerName (M)Full name of the customer
customerEmail (M)Email address of the customer
apiKey (M)Merchant's API Key (Can be found on the Monnify dashboard)
contractCode (M)Merchant's contract code (Can be found on the Monnify dashboard)
description (M)Description for the transaction. Will be used as the account name for bank transfer paymentsd
expiryDate (M)Expiry date for the invoice. After this date, the customer will no longer be able to pay for that invoice. Format is YYYY-MM-DD HH:MM:SS
checkoutUrl A URL which can be used to display the Monnify payment interface where the customer can then pay for the invoice via bank transfer or card. This is especially useful for card transactions as the account number can and SHOULD be displayed on the invoice directly.
accountNumberThe virtual account number generated for the invoice. This is the account number the customer can transfer to, to pay this invoice
accountNameThe name that will be displayed to the customer when he performs name enquiry on the virtual account. Please note there may be Prefixes
bankNameThe name of the bank where the virtual account number was generated. The customer will be expected to select this bank when doing the bank transfer
bankCodeThe bank code of the bank where the virtual account number was generated

  • No labels