Create Invoice

Creates an Invoice Virtual Account with an expiry date and time. After the expiry or payment of the funds to the account, the NUBAN(Account number) is reallocated for reuse.

Request Body

Field Name	Type	Required	Description
subledgergroupcode	string	TRUE	The unique code identifying the subledger group associated with the invoice.
invoiceReference	string	TRUE	A unique reference for the invoice.
description	string	TRUE	A brief description of the invoice.
customerEmail	string	TRUE	The email address of the customer to be billed.
customerName	string	TRUE	The name of the customer.
expiryDate	string	TRUE	The expiry date and time of the invoice (format: YYYY-MM-DD HH:mm:ss).
amount	decimal	TRUE	The total amount to be invoiced.
callbackUrl	string	TRUE	The URL to which callback notifications will be sent.
callbackPayload	object	TRUE	An object containing additional callback data (e.g., account number, customer email, passcode, etc.).

Response Body

Field Name	Type	Description
subLedgerID	string	The unique identifier assigned to the invoice subledger entry.
description	string	The invoice description.
customerEmail	string	The customer's email address.
customerName	string	The customer's name.
invoiceReference	string	The unique invoice reference.
amount	decimal	The invoice amount.
subledgergroupcode	string	The subledger group code associated with the invoice.
nuban	string	The account number linked to the subledger invoice.
expiryDate	string	The invoice expiry date and time.
callbackUrl	string	The callback URL provided in the request.
callbackPayload	object	The callback payload data as returned in the response.

Request

Body Params application/json

Example

{
    "subledgergroupcode":"8RFVJ70FK4",
    "invoiceReference":"000000111",
    "description":"Test Invoice 111",
    "customerEmail":"mohdolateju@gmail.com",
    "customerName":"Mohammed",
    "expiryDate": "2024-02-02 13:15:00",
    "amount" : 140,
    "callbackUrl":"https://webhook.site/7777c99c-cf66-48f1-8ddc-54e34feb4b4d",
    "callbackPayload":{
        "account_number":"Example Response",
        "customer_email":"mohdolateju@gmail.com",
        "passcode":"c37360ece4c3cd81b14ad5ef787b84f3470b7d1ceb7112b63917d68eb145739fa4ed01bc540bd88810411be7236c9453edb3f1e4b9b6727c45f86db4f987755b"
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Create Invoice

application/json

Body