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

You can get details of all your invoices by making a request to the endpoint below

Endpoint

GET: https://sandbox.monnify.com/api/v1/invoice/all

This endpoint is protected with Basic Authentication

Once you send the request, Monnify will return a paginated list of all your invoices. Here's a sample response

Get Invoice Details Response
{
    "requestSuccessful": true,
    "responseMessage": "success",
    "responseCode": "0",
    "responseBody": {
        "content": [
            {
                "amount": 999.00,
                "invoiceReference": "1566947845773",
                "invoiceStatus": "PENDING",
                "description": "test invoice",
                "contractCode": "4876165459",
                "customerEmail": "blabla@gmail.com",
                "customerName": "blabla",
                "expiryDate": "2019-08-28 12:18:00",
                "createdBy": "MK_TEST_VR7J3UAACH",
                "createdOn": "2019-08-27 23:17:29",
                "accountNumber": "1458456122",
                "bankName": "Providus Bank",
                "bankCode": "101"
            },
            {
                "amount": 999.00,
                "invoiceReference": "1566947667149",
                "invoiceStatus": "PENDING",
                "description": "test invoice",
                "contractCode": "4876165459",
                "customerEmail": "blabla@gmail.com",
                "customerName": "blabla",
                "expiryDate": "2019-10-18 14:48:00",
                "createdBy": "MK_TEST_VR7J3UAACH",
                "createdOn": "2019-08-27 23:14:29",
                "accountNumber": "2219635498",
                "bankName": "Providus Bank",
                "bankCode": "101"
            },
            {
                "amount": 999.00,
                "invoiceReference": "1566906488935",
                "invoiceStatus": "PAID",
                "description": "test invoice",
                "contractCode": "4876165459",
                "customerEmail": "test@gmail.com",
                "customerName": "blabla",
                "expiryDate": "2019-08-28 15:07:45",
                "createdBy": "MK_TEST_VR7J3UAACH",
                "createdOn": "2019-08-27 11:48:09",
                "accountNumber": "1781265694",
                "bankName": "Providus Bank",
                "bankCode": "101"
            },
            {
                "amount": 999.00,
                "invoiceReference": "1566573401623",
                "invoiceStatus": "PENDING",
                "description": "test invoice",
                "contractCode": "4876165459",
                "customerEmail": "test@gmail.com",
                "customerName": "blabla",
                "expiryDate": "2019-08-24 15:07:45",
                "createdBy": "MK_TEST_VR7J3UAACH",
                "createdOn": "2019-08-23 15:16:42",
                "accountNumber": "2791524357",
                "bankName": "Providus Bank",
                "bankCode": "101"
            },
            {
                "amount": 999.00,
                "invoiceReference": "1566573115429",
                "invoiceStatus": "PAID",
                "description": "test invoice",
                "contractCode": "4876165459",
                "customerEmail": "test@gmail.com",
                "customerName": "blabla",
                "expiryDate": "2019-08-24 15:07:45",
                "createdBy": "MK_TEST_VR7J3UAACH",
                "createdOn": "2019-08-23 15:11:56",
                "accountNumber": "1551528118",
                "bankName": "Providus Bank",
                "bankCode": "101"
            },
            {
                "amount": 999.00,
                "invoiceReference": "1566572942632",
                "invoiceStatus": "PENDING",
                "description": "test invoice",
                "contractCode": "4876165459",
                "customerEmail": "test@gmail.com",
                "customerName": "blabla",
                "expiryDate": "2019-08-24 15:07:45",
                "createdBy": "MK_TEST_VR7J3UAACH",
                "createdOn": "2019-08-23 15:09:03",
                "accountNumber": "9737775295",
                "bankName": "Providus Bank",
                "bankCode": "101"
            },
            {
                "amount": 999.00,
                "invoiceReference": "1566407189376",
                "invoiceStatus": "PENDING",
                "description": "test invoice",
                "contractCode": "4876165459",
                "customerEmail": "blabla@gmail.com",
                "customerName": "blabla",
                "expiryDate": "2019-10-18 14:48:00",
                "createdBy": "SYSTEM",
                "createdOn": "2019-08-21 17:06:41",
                "accountNumber": "5589639974",
                "bankName": "Providus Bank",
                "bankCode": "101"
            },
            {
                "amount": 999.00,
                "invoiceReference": "1566405516085",
                "invoiceStatus": "PENDING",
                "description": "test invoice",
                "contractCode": "4876165459",
                "customerEmail": "opeyemionikute@yahoo.com",
                "customerName": "blabla",
                "expiryDate": "2019-10-18 14:48:00",
                "createdBy": "SYSTEM",
                "createdOn": "2019-08-21 16:38:37",
                "accountNumber": "1659721935",
                "bankName": "Providus Bank",
                "bankCode": "101"
            },
            {
                "amount": 999.00,
                "invoiceReference": "1566405106870",
                "invoiceStatus": "PENDING",
                "description": "test invoice",
                "contractCode": "4876165459",
                "customerEmail": "blabla@gmail.com",
                "customerName": "blabla",
                "expiryDate": "2019-10-18 14:48:00",
                "createdBy": "SYSTEM",
                "createdOn": "2019-08-21 16:31:49",
                "accountNumber": "1856311869",
                "bankName": "Providus Bank",
                "bankCode": "101"
            },
            {
                "amount": 1000.00,
                "invoiceReference": "Dynamic-Cookies",
                "invoiceStatus": "PENDING",
                "description": "Test Invoice",
                "accountReference": "1565378112948",
                "contractCode": "4876165459",
                "customerEmail": "johnbull@gmail.com",
                "customerName": "John Bull",
                "expiryDate": "2019-08-11 13:01:58",
                "createdBy": "SYSTEM",
                "createdOn": "2019-08-09 19:15:29",
                "accountNumber": "6457276111",
                "bankName": "Providus Bank",
                "bankCode": "101"
            }
        ],
        "pageable": {
            "sort": {
                "sorted": true,
                "unsorted": false,
                "empty": false
            },
            "pageSize": 10,
            "pageNumber": 0,
            "offset": 0,
            "paged": true,
            "unpaged": false
        },
        "last": false,
        "totalPages": 2,
        "totalElements": 12,
        "sort": {
            "sorted": true,
            "unsorted": false,
            "empty": false
        },
        "first": true,
        "numberOfElements": 10,
        "size": 10,
        "number": 0,
        "empty": false
    }
}


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.
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