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

Get Invoice Detail

GET
/invoice/{groupCode}/{invoiceReference}
This operation retrieves invoice details using the specified groupCode and invoiceReference, providing key information about the invoice.

Path Parameter#

Field NameTypeRequiredDescription
groupCodestringtrueThe unique code used to identify a subledger group
invoiceReferencestringtrueThe unique reference code used to identify an invoice

Response Body#

When the invoice is PENDING
Field NameTypeDescription
descriptionstringA brief summary or details about the invoice.
customerEmailstringThe email address of the customer associated with the invoice.
customerNamestringThe full name of the customer.
invoiceReferencestringA unique reference identifier for the invoice.
amountdecimalThe total amount of the invoice.
subledgergroupcodestringA classification code for financial sub-ledger grouping.
merchantidintegerThe unique identifier of the merchant issuing the invoice.
statusstringThe current status of the invoice (e.g., "PENDING").
expiryDatestringThe date when the invoice will expire if not paid.
statusDatestringThe timestamp of the last status update for the invoice.
When the invoice is PAID
NameTypeDescription
descriptionstringA brief summary or details about the invoice.
customerEmailstringThe email address of the customer associated with the invoice.
customerNamestringThe full name of the customer.
invoiceReferencestringA unique reference identifier for the invoice.
amountdecimalThe total amount of the invoice.
subledgergroupcodestringA classification code for financial sub-ledger grouping.
merchantidintegerThe unique identifier of the merchant issuing the invoice.
statusstringThe current status of the invoice (e.g., "PAID").
allocatedNubanstringThe NUBAN (Bank Account Number) allocated for the payment.
sourceAccountNumberstringThe account number from which the payment was made.
sourceAccountNamestringThe name associated with the source account.
sourceAccountBankstringThe bank where the source account is held.
sessionIDstringA unique identifier for tracking the transaction session.
expiryDatestringThe date when the invoice was originally set to expire.
statusDatestringThe timestamp of the last status update for the invoice.

Request

Path 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 '/invoice/8RFVJ70FK4/000000048'

Responses

🟢200Get Invoice Detail
application/json
Body

Example
{
    "description": "Test Invoice 00",
    "customerEmail": "mohdolateju@gmail.com",
    "customerName": "Mohammed",
    "invoiceReference": "3838383HGFDDDDD119651",
    "amount": 555,
    "subledgergroupcode": "RBZK2V1C26",
    "merchantid": 1873,
    "status": "Pending",
    "expiryDate": "2023-11-23T12:15:00Z",
    "statusDate": "2023-11-22T15:15:30+00:00"
}
🟢200Get Invoice Detail [Paid]
Modified at 2025-02-28 09:14:05
Previous
Create Invoice
Next
List Merchant Invoices
Built with