Invoice Payments

By using Onion Pay Terminal for order fulfillment, it is possible to generate an invoice that can be used to receive payment.

When customers are allowed to make payment on order fulfillment, also known as Pay on Delivery or Collect on Delivery, it can create difficulties for merchants who need to manually reconcile payments received in the future. This process is not only tedious but also lacks real-time updates on payment status.

However, our Payment Request API solves this problem by enabling you to generate an invoice that can be paid using any of your Onion Pay Terminals. This streamlines the payment process and automates reconciliation, making it easier for you to receive payments and keep track of them in real-time.

Create an invoice

In order to receive payment upon order fulfillment, you must first create an invoice for the customer. Therefore, it is necessary for the customer to already exist in the system before an invoice can be generated.

curl --location -g '{{base_url}}/api/v1/send-invoice'

POST curl --location -g '{{base_url}}/api/v1/switch-environment'

Request Body

Name	Type	Description
--data-raw*	{	"ref": "", "full_name": "Client Name", "email": "[e-mail]", "phone": "[phone]", "address": "Naraguta, Jos\nPL, NG", "order": [ { "name": "School Textbooks", "quantity": 5, "price": 700 }, { "name": "Notebooks", "quantity": 3, "price": 300 }, { "name": "Hairbrush", "quantity": 2, "price": 800 }, { "name": "Stationery", "quantity": 1, "price": 1700 } ] }

200: OK

Body

{
  "success": true,
  "invoice_id": "1680459397572"
}

Headers

X-Powered-By Express

Access-Control-Allow-Origin *

Content-Type application/json; charset=utf-8

Content-Length 1453

ETag W/"5ad-uHtD2uLiTrW/Y9gl8uK+BmEKZdY"

Date Tue, 04 Apr 2023 20:32:29 GMT

Connection keep-alive

Keep-Alive timeout=5

When an invoice is issued, it is sent via email to the client that the invoice is issued to and then they are prompted to pay. When the pay button is clicked, they are directed to a page where they can make payment.

Once payment is made, it would then be classified. A response in form of a receipt is then sent to the client, and the merchant would be notified as well based on preference.