Overview
Payunit Invoice provides a restful interface allowing merchants to generate invoices and pay them. The generated link will then be used to make a payment using payunit.
Invoice offers three types of payments :
- Full payment - The client is allowed to pay the invoice fully only
- Pay per installment - Here the client is allowed to pay predefined installments
- Pay at your own pace with a dateline - Here the client is allowed to pay at their own pace with a dateline so he has the flexibility to pay at his own will.
Here below is an example of response from a payunit invoice.
{
"uuid": "bca47276-35e6-4f9d-a441-3d6fbbf5c023",
"created_at": "2024-12-12T11:03:07.224Z",
"lastChangedDateTime": "2024-12-12T11:03:07.224Z",
"isDeleted": null,
"ref": "INV-1734001387224",
"total_amount": "120000",
"amount_paid": "0",
"remaining_amount": "120000",
"sub_total": "120000",
"status": "UNPAID",
"type": "NORMAL",
"partial_payment": false,
"due_date": "2024-05-14T13:53:22.060Z",
"callback_url": "https://webhook.site/697a81e2-6b63-4be1-928f-63b0100ea6bd",
"is_custom_company": true,
"custom_billing_company": {
"logo": "https://static.vecteezy.com/system/resources/thumbnails/047/656/219/small_2x/abstract-logo-design-for-any-corporate-brand-business-company-vector.jpg",
"name": "Alpha Company",
"email": "[email protected]",
"phone_number": "+237678095634"
},
"currency": "XAF",
"client": {
"uuid": "d2614f47-0fab-4c2d-9a62-eecd59553e54",
"created_at": "2024-06-06T12:00:16.677Z",
"lastChangedDateTime": "2024-06-06T12:00:16.677Z",
"isDeleted": null,
"name": "Brooklyn Perry",
"email": "[email protected]",
"phone_number": "(924) 913-0817"
},
"company": {
"uuid": "5aae9972-d428-4c65-ab5a-662b6dc39b61",
"created_at": "2024-06-06T11:44:01.765Z",
"lastChangedDateTime": "2024-06-06T11:44:01.765Z",
"isDeleted": null,
"name": "Edi Fashoion",
"slug": null,
"email": "[email protected]",
"phone_number": "23456734567",
"logo": "https://payunit-public-assets-staging.s3.us-east-2.amazonaws.com/payunit-invoice/4ffbcc14-fedc-4437-8be6-d7975fbd056a/1717674241164.image/png",
"user_id": "4ffbcc14-fedc-4437-8be6-d7975fbd056a",
"application_id": "40dc357d-8f04-4bcf-a511-9207e7cd3156"
},
"payments": [],
"items": [
{
"uuid": "f67e953e-00f7-4a0c-a838-f044f9d61ce1",
"created_at": "2024-12-12T11:03:07.326Z",
"lastChangedDateTime": "2024-12-12T11:03:07.224Z",
"isDeleted": null,
"name": "recovery partial",
"ref": "ITEM1734001387326",
"amount": "30000",
"quantity": "4"
}
],
"installments": []
}Last updated on February 25, 2025