Virtual Account Services
  1. Invoice
Virtual Account Services
  • Introduction
  • Terminologies
  • Webhooks
  • Authentication
  • Account
    • Create Account
      POST
    • Rename Account
      POST
    • Balance Inquiry
      GET
    • Create Bulk Accounts
      POST
    • List Accounts
      GET
  • Transaction
    • Credit Account
      POST
    • Debit Account
      POST
    • Credit Account [Agency Banking]
      POST
    • Debit Account [Agency Banking]
      POST
    • Transaction Query
      GET
    • Transaction Details
      GET
    • Transaction History
      GET
  • Transfer
    • Get Institutions
      GET
    • Name Inquiry
      POST
    • Interbank Transfer
      POST
    • Interbank Transfer [Sync]
      POST
    • Transfer Query
      GET
    • Transfer Enquiry
      GET
    • Virtual Account Intrabank Transfer
      POST
    • Core Banking Intrabank Transfer
      POST
    • Collection Accounts Intrabank Transfer
      POST
  • Invoice
    • Create Invoice
      POST
    • Get Invoice Detail
      GET
    • List Merchant Invoices
      GET
  • Refunds
    • Initiate Refund
    • Get Refund Status
    • Get Refunds
  • Notifications
    • Notification
    • Send Notification
  • Merchant
    • Account
      • Get Account
      • Activate Sub Ledger For Merchant
      • Get SubLedger Callback Urls
      • Set SubLedger Callback Urls
      • Get Collection Accounts
    • Transfer
      • Get Transfer History
      • Get Subledger transfers
      • Get Transfer Details
      • Name Inquiry
    • Refund
      • Refund Details
  • Admin
    • Accounting
      • Get GL Accounts
      • Get Classification Codes
    • Dashboard
      • Dashboard Summary
      • Dashboard Transactions
      • Dashboard Transaction Details
    • Group Codes
      • Get Group Codes
      • Set Collection Account
      • Create Group Code
    • Reporting
      • Get Report Types
      • Get Report Parameters
      • Create Report
      • Get Reports
      • Get Reports Details
  1. Invoice

List Merchant Invoices

GET
/invoicelist/{groupCode}
Retrieves a list of merchant invoices for the specified groupCode.

Request Parameters#

Field NameTypeRequiredDescription
groupCodestringTRUEUnique identifier for the group

Response Body#

Field NameTypeDescription
subLedgerIDstringUnique identifier for the invoice sub-ledger
statusstringStatus of the invoice (e.g., Expired, Pending)
allocatedNubanstringAllocated NUBAN for the transaction
descriptionstringInvoice description (if available)
customerEmailstringEmail of the customer (if available)
customerNamestringName of the customer (if available)
invoiceReferencestringReference for the invoice (if available)
amountintegerAmount for the invoice (if available)
subledgergroupcodestringGroup code associated with the sub-ledger
merchantidintegerMerchant identifier
productIDintegerAssociated product ID (if available)
expiryDatestringExpiry date of the invoice in ISO 8601 format
createdDatestringDate of invoice creation in ISO 8601 format

Request

Path Params

Query Params

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/invoicelist/8RFVJ70FK4?page=3&items=100'

Responses

🟢200List Merchant Invoices
application/json
Body

Example
[
    {
        "subLedgerID": "1110003291",
        "status": "Expired",
        "allocatedNuban": "1110003291"
    },
    {
        "subLedgerID": "1110003277",
        "status": "Expired",
        "allocatedNuban": "1110003277"
    },
    {
        "subLedgerID": "1110003253",
        "status": "Expired",
        "allocatedNuban": "1110003253"
    },
    {
        "subLedgerID": "1110003239",
        "description": "Pay 4600 for electricity - 241208204970",
        "customerEmail": "support@irecharge.com.ng",
        "customerName": "iRecharge",
        "invoiceReference": "241208204970",
        "amount": 4600,
        "subledgergroupcode": "8RFVJ70FK4",
        "merchantid": 24,
        "status": "Pending",
        "allocatedNuban": "1110003239",
        "productID": 105,
        "expiryDate": "2024-12-08T23:59:59Z",
        "createdDate": "2024-12-08T08:24:33Z"
    },
    {
        "subLedgerID": "1110003215",
        "status": "Expired",
        "allocatedNuban": "1110003215"
    },
    {
        "subLedgerID": "1110003198",
        "status": "Expired",
        "allocatedNuban": "1110003198"
    },
    {
        "subLedgerID": "1110003174",
        "status": "Expired",
        "allocatedNuban": "1110003174"
    },
    {
        "subLedgerID": "1110003150",
        "status": "Expired",
        "allocatedNuban": "1110003150"
    },
    {
        "subLedgerID": "1110003136",
        "status": "Expired",
        "allocatedNuban": "1110003136"
    },
    {
        "subLedgerID": "1110003112",
        "status": "Expired",
        "allocatedNuban": "1110003112"
    },
    {
        "subLedgerID": "1110003095",
        "status": "Expired",
        "allocatedNuban": "1110003095"
    },
    {
        "subLedgerID": "1110003071",
        "status": "Expired",
        "allocatedNuban": "1110003071"
    },
    {
        "subLedgerID": "1110003057",
        "status": "Expired",
        "allocatedNuban": "1110003057"
    },
    {
        "subLedgerID": "1110003033",
        "status": "Expired",
        "allocatedNuban": "1110003033"
    },
    {
        "subLedgerID": "1110003019",
        "status": "Expired",
        "allocatedNuban": "1110003019"
    },
    {
        "subLedgerID": "1110002995",
        "status": "Expired",
        "allocatedNuban": "1110002995"
    },
    {
        "subLedgerID": "1110002971",
        "status": "Expired",
        "allocatedNuban": "1110002971"
    },
    {
        "subLedgerID": "1110002957",
        "status": "Expired",
        "allocatedNuban": "1110002957"
    },
    {
        "subLedgerID": "1110002933",
        "description": "Pay 10100 for electricity - 241208746872",
        "customerEmail": "support@irecharge.com.ng",
        "customerName": "iRecharge",
        "invoiceReference": "241208746872",
        "amount": 10100,
        "subledgergroupcode": "8RFVJ70FK4",
        "merchantid": 24,
        "status": "Pending",
        "allocatedNuban": "1110002933",
        "productID": 105,
        "expiryDate": "2024-12-08T23:59:59Z",
        "createdDate": "2024-12-08T08:46:33Z"
    },
    {
        "subLedgerID": "1110002919",
        "status": "Expired",
        "allocatedNuban": "1110002919"
    },
    {
        "subLedgerID": "1110002892",
        "status": "Expired",
        "allocatedNuban": "1110002892"
    },
    {
        "subLedgerID": "1110002878",
        "description": "Pay 15100 for electricity - 241208839142",
        "customerEmail": "support@irecharge.com.ng",
        "customerName": "iRecharge",
        "invoiceReference": "241208839142",
        "amount": 15100,
        "subledgergroupcode": "8RFVJ70FK4",
        "merchantid": 24,
        "status": "Pending",
        "allocatedNuban": "1110002878",
        "productID": 105,
        "expiryDate": "2024-12-08T23:59:59Z",
        "createdDate": "2024-12-08T05:12:54Z"
    },
    {
        "subLedgerID": "1110002854",
        "status": "Expired",
        "allocatedNuban": "1110002854"
    },
    {
        "subLedgerID": "1110002830",
        "status": "Expired",
        "allocatedNuban": "1110002830"
    },
    {
        "subLedgerID": "1110002816",
        "status": "Expired",
        "allocatedNuban": "1110002816"
    },
    {
        "subLedgerID": "1110002799",
        "status": "Expired",
        "allocatedNuban": "1110002799"
    },
    {
        "subLedgerID": "1110002775",
        "status": "Expired",
        "allocatedNuban": "1110002775"
    },
    {
        "subLedgerID": "1110002751",
        "status": "Expired",
        "allocatedNuban": "1110002751"
    },
    {
        "subLedgerID": "1110002737",
        "status": "Expired",
        "allocatedNuban": "1110002737"
    },
    {
        "subLedgerID": "1110002713",
        "status": "Expired",
        "allocatedNuban": "1110002713"
    },
    {
        "subLedgerID": "1110002696",
        "status": "Expired",
        "allocatedNuban": "1110002696"
    },
    {
        "subLedgerID": "1110002672",
        "status": "Expired",
        "allocatedNuban": "1110002672"
    },
    {
        "subLedgerID": "1110002658",
        "status": "Expired",
        "allocatedNuban": "1110002658"
    },
    {
        "subLedgerID": "1110002634",
        "status": "Expired",
        "allocatedNuban": "1110002634"
    },
    {
        "subLedgerID": "1110002610",
        "status": "Expired",
        "allocatedNuban": "1110002610"
    },
    {
        "subLedgerID": "1110002593",
        "status": "Expired",
        "allocatedNuban": "1110002593"
    },
    {
        "subLedgerID": "1110002579",
        "status": "Expired",
        "allocatedNuban": "1110002579"
    },
    {
        "subLedgerID": "1110002555",
        "status": "Expired",
        "allocatedNuban": "1110002555"
    },
    {
        "subLedgerID": "1110002531",
        "status": "Expired",
        "allocatedNuban": "1110002531"
    },
    {
        "subLedgerID": "1110002517",
        "status": "Expired",
        "allocatedNuban": "1110002517"
    },
    {
        "subLedgerID": "1110002490",
        "status": "Expired",
        "allocatedNuban": "1110002490"
    },
    {
        "subLedgerID": "1110002476",
        "status": "Expired",
        "allocatedNuban": "1110002476"
    },
    {
        "subLedgerID": "1110002452",
        "status": "Expired",
        "allocatedNuban": "1110002452"
    },
    {
        "subLedgerID": "1110002438",
        "status": "Expired",
        "allocatedNuban": "1110002438"
    },
    {
        "subLedgerID": "1110002414",
        "status": "Expired",
        "allocatedNuban": "1110002414"
    },
    {
        "subLedgerID": "1110002397",
        "description": "Pay 3100 for electricity - 241208903270",
        "customerEmail": "support@irecharge.com.ng",
        "customerName": "iRecharge",
        "invoiceReference": "241208903270",
        "amount": 3100,
        "subledgergroupcode": "8RFVJ70FK4",
        "merchantid": 24,
        "status": "Pending",
        "allocatedNuban": "1110002397",
        "productID": 105,
        "expiryDate": "2024-12-08T23:59:59Z",
        "createdDate": "2024-12-08T08:27:12Z"
    },
    {
        "subLedgerID": "1110002373",
        "status": "Expired",
        "allocatedNuban": "1110002373"
    },
    {
        "subLedgerID": "1110002359",
        "status": "Expired",
        "allocatedNuban": "1110002359"
    },
    {
        "subLedgerID": "1110002335",
        "status": "Expired",
        "allocatedNuban": "1110002335"
    },
    {
        "subLedgerID": "1110002311",
        "status": "Expired",
        "allocatedNuban": "1110002311"
    },
    {
        "subLedgerID": "1110002294",
        "status": "Expired",
        "allocatedNuban": "1110002294"
    },
    {
        "subLedgerID": "1110002270",
        "status": "Expired",
        "allocatedNuban": "1110002270"
    },
    {
        "subLedgerID": "1110002256",
        "status": "Expired",
        "allocatedNuban": "1110002256"
    },
    {
        "subLedgerID": "1110002232",
        "status": "Expired",
        "allocatedNuban": "1110002232"
    },
    {
        "subLedgerID": "1110002218",
        "status": "Expired",
        "allocatedNuban": "1110002218"
    },
    {
        "subLedgerID": "1110002191",
        "status": "Expired",
        "allocatedNuban": "1110002191"
    },
    {
        "subLedgerID": "1110002177",
        "status": "Expired",
        "allocatedNuban": "1110002177"
    },
    {
        "subLedgerID": "1110002153",
        "status": "Expired",
        "allocatedNuban": "1110002153"
    },
    {
        "subLedgerID": "1110002139",
        "status": "Expired",
        "allocatedNuban": "1110002139"
    },
    {
        "subLedgerID": "1110002115",
        "status": "Expired",
        "allocatedNuban": "1110002115"
    },
    {
        "subLedgerID": "1110002098",
        "status": "Expired",
        "allocatedNuban": "1110002098"
    },
    {
        "subLedgerID": "1110002074",
        "status": "Expired",
        "allocatedNuban": "1110002074"
    },
    {
        "subLedgerID": "1110002050",
        "status": "Expired",
        "allocatedNuban": "1110002050"
    },
    {
        "subLedgerID": "1110002036",
        "status": "Expired",
        "allocatedNuban": "1110002036"
    },
    {
        "subLedgerID": "1110002012",
        "status": "Expired",
        "allocatedNuban": "1110002012"
    },
    {
        "subLedgerID": "1110001998",
        "status": "Expired",
        "allocatedNuban": "1110001998"
    },
    {
        "subLedgerID": "1110001974",
        "status": "Expired",
        "allocatedNuban": "1110001974"
    },
    {
        "subLedgerID": "1110001950",
        "status": "Expired",
        "allocatedNuban": "1110001950"
    },
    {
        "subLedgerID": "1110001936",
        "status": "Expired",
        "allocatedNuban": "1110001936"
    },
    {
        "subLedgerID": "1110001912",
        "description": "Pay 5000 for electricity - 241208692167",
        "customerEmail": "support@irecharge.com.ng",
        "customerName": "iRecharge",
        "invoiceReference": "241208692167",
        "amount": 5000,
        "subledgergroupcode": "8RFVJ70FK4",
        "merchantid": 24,
        "status": "Pending",
        "allocatedNuban": "1110001912",
        "productID": 105,
        "expiryDate": "2024-12-08T23:59:59Z",
        "createdDate": "2024-12-08T07:12:35Z"
    },
    {
        "subLedgerID": "1110001895",
        "status": "Expired",
        "allocatedNuban": "1110001895"
    },
    {
        "subLedgerID": "1110001871",
        "status": "Expired",
        "allocatedNuban": "1110001871"
    },
    {
        "subLedgerID": "1110001857",
        "status": "Expired",
        "allocatedNuban": "1110001857"
    },
    {
        "subLedgerID": "1110001833",
        "status": "Expired",
        "allocatedNuban": "1110001833"
    },
    {
        "subLedgerID": "1110001819",
        "status": "Expired",
        "allocatedNuban": "1110001819"
    },
    {
        "subLedgerID": "1110001792",
        "status": "Expired",
        "allocatedNuban": "1110001792"
    },
    {
        "subLedgerID": "1110001778",
        "status": "Expired",
        "allocatedNuban": "1110001778"
    },
    {
        "subLedgerID": "1110001754",
        "description": "Pay 20100 for electricity - 241208795279",
        "customerEmail": "support@irecharge.com.ng",
        "customerName": "iRecharge",
        "invoiceReference": "241208795279",
        "amount": 20100,
        "subledgergroupcode": "8RFVJ70FK4",
        "merchantid": 24,
        "status": "Pending",
        "allocatedNuban": "1110001754",
        "productID": 105,
        "expiryDate": "2024-12-08T23:59:59Z",
        "createdDate": "2024-12-08T06:48:50Z"
    },
    {
        "subLedgerID": "1110001730",
        "status": "Expired",
        "allocatedNuban": "1110001730"
    },
    {
        "subLedgerID": "1110001716",
        "status": "Expired",
        "allocatedNuban": "1110001716"
    },
    {
        "subLedgerID": "1110001699",
        "status": "Expired",
        "allocatedNuban": "1110001699"
    },
    {
        "subLedgerID": "1110001675",
        "status": "Expired",
        "allocatedNuban": "1110001675"
    },
    {
        "subLedgerID": "1110001651",
        "status": "Expired",
        "allocatedNuban": "1110001651"
    },
    {
        "subLedgerID": "1110001637",
        "status": "Expired",
        "allocatedNuban": "1110001637"
    },
    {
        "subLedgerID": "1110001613",
        "status": "Expired",
        "allocatedNuban": "1110001613"
    },
    {
        "subLedgerID": "1110001596",
        "status": "Expired",
        "allocatedNuban": "1110001596"
    },
    {
        "subLedgerID": "1110001572",
        "status": "Expired",
        "allocatedNuban": "1110001572"
    },
    {
        "subLedgerID": "1110001558",
        "status": "Expired",
        "allocatedNuban": "1110001558"
    },
    {
        "subLedgerID": "1110001534",
        "status": "Expired",
        "allocatedNuban": "1110001534"
    },
    {
        "subLedgerID": "1110001510",
        "status": "Expired",
        "allocatedNuban": "1110001510"
    },
    {
        "subLedgerID": "1110001493",
        "status": "Expired",
        "allocatedNuban": "1110001493"
    },
    {
        "subLedgerID": "1110001479",
        "status": "Expired",
        "allocatedNuban": "1110001479"
    },
    {
        "subLedgerID": "1110001455",
        "status": "Expired",
        "allocatedNuban": "1110001455"
    },
    {
        "subLedgerID": "1110001431",
        "status": "Expired",
        "allocatedNuban": "1110001431"
    },
    {
        "subLedgerID": "1110001417",
        "status": "Expired",
        "allocatedNuban": "1110001417"
    },
    {
        "subLedgerID": "1110001390",
        "status": "Expired",
        "allocatedNuban": "1110001390"
    },
    {
        "subLedgerID": "1110001376",
        "status": "Expired",
        "allocatedNuban": "1110001376"
    },
    {
        "subLedgerID": "1110001352",
        "status": "Expired",
        "allocatedNuban": "1110001352"
    },
    {
        "subLedgerID": "1110001338",
        "description": "Pay 20800 for tv - 241208515600",
        "customerEmail": "support@irecharge.com.ng",
        "customerName": "iRecharge",
        "invoiceReference": "241208515600",
        "amount": 20800,
        "subledgergroupcode": "8RFVJ70FK4",
        "merchantid": 24,
        "status": "Pending",
        "allocatedNuban": "1110001338",
        "productID": 105,
        "expiryDate": "2024-12-08T23:59:59Z",
        "createdDate": "2024-12-08T08:00:59Z"
    },
    {
        "subLedgerID": "1110001314",
        "status": "Expired",
        "allocatedNuban": "1110001314"
    }
]
Modified at 2025-03-17 22:04:58
Previous
Get Invoice Detail
Next
Initiate Refund
Built with