Invoice Generation

This endpoint should be consumed in 2 scenarios:

1. You or one of your colleagues uploaded a schedule from our portal but didn't proceed to payment
2. You or one of your colleagues consumed the schedule creation endpoint but invoice could not be generated as a result of communication failure between PayPen and our Payment Gateway

To generate an invoice, you will need to provide your schedule PPID. Note that the invoice details will be returned if already generated for this PPID.

POST - https://paypen.ng/api/employer/invoice/generate

Headers

                
{
    "Content-Type": "application/json"
    "Authorization": "Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.xxxxx"
}
                
            

Sample Payload

                
{
    "ppid": "TX10xxxxxx02"
}
                
            

Sample Response

    
{
    "has_error": false,
    "message": "Operation succeeded.",
    "data": [
        {
            "ppid": "TX10xxxxxx02",
            "amount_payable": 300000,
            "payment_due_date": "2024-05-30 15:45:23",
            "account_name": "John Doe Limited",
            "account_number": 0123456789,
            "bank_name": "Wema Bank",
            "invoice_status": "PENDING",
            "created_by": "John Doe",
            "created_on": "2024-05-20 15:45:23"
        }
    ]
}
    

This response indicates that everything went well and your schedule has uploaded successfully uploaded. This process also triggers an email with your invoice, carrying same information as in the above response.

Field	Description
has_error	Indicates whether or not the request results in an error
message	The operation response message
data	Contains the invoice details to be used for making payment. ppid PayPen ID - used to track or report issue on your schedule. amount_payable EXACT Amount to be paid for the schedule. payment_due_date Indicates when the invoice expires if not paid. account_name The name you want to be attached to the reserved account. account_number Your dedicated virtual account number for the schedule. bank_name Name of the bank where the virtual account was created. invoice_status Indicates the status of your invoice. PENDING means you haven't made payment. created_by The API consumer, as previously authenticated. created_on Date schedule was created.