Create open invoice

POST 
/api/v1/open-invoice

To create open invoices instantly and deliver them via link or QR Code

📌 List of open invoice types

Types	Description	Value
Fixed amount	Fixed invoice amount Eg: 100.000 KWD Pass payload value "amountType:"0"	"0"
Open amount	Any amount between two values Eg: Min 50.000 KWD - Max 100.000 KWD Pass payload value "amountType:"1"	"1"

🔋 Fixed invoice - Sample Request Payload

  {
    "merchantCode": "842217", // Pass merchant code
    "title": "Test", // Invoice title
    "amountType": "0", // "0" for fixed amount invoice
    "fixAmount": "100.000", // fixed amount 
    "expiryDate": "2025-01-05",  // "YYYY-MM-DD" 
    "minAmount": "", // Pass empty field if it is fixed amount invoice 
    "maxAmount": "", // Pass empty field if it is fixed amount invoice 
    "description": "testing open invoice" // Invoice description
  }

🎯 Note: Payload must be encrypted before being sent to the server. To access the response data, decrypt it upon receiving the response from the server

⚡️ Fixed invoice payload details

Field Name	Description	Required
merchantCode	Pass the merchant code	✅ Yes
title	Pass the invoice title	✅ Yes
amountType	Pass the invoice type	✅ Yes
fixAmount	Pass the invoice fixed amount	✅ Yes
minAmount	Pass empty field if it is fixed amount invoice	⚠️ Optional
maxAmount	Pass empty field if it is fixed amount invoice	⚠️ Optional
description	Pass the invoice description	⚠️ Optional

🔋 Open invoice - Sample Request Payload

  {
    "merchantCode": "842217", // Pass merchant code
    "title": "Test", // Invoice title
    "amountType": "1", // "1" For open amount invoice
    "fixAmount": "", // Pass empty field if it is open amount invoice 
    "expiryDate": "2025-01-05",  // "YYYY-MM-DD" 
    "minAmount": "50.000", //  Open amount invoice 
    "maxAmount": "100.000", // Open amount invoice 
    "description": "testing open invoice" // Invoice description
  }

⚡️ Open invoice payload details

Field Name	Description	Required
merchantCode	Pass the merchant code	✅ Yes
title	Pass the invoice title	✅ Yes
amountType	Pass the invoice type	✅ Yes
minAmount	Pass the invoice min amount, 🎯 Min amount should not be greater than Max amount	✅ Yes
maxAmount	Pass the invoice max amount	✅ Yes
fixAmount	Pass empty field if it is open amount invoice	⚠️ Optional
description	Pass the invoice description	⚠️ Optional

Request

Responses

200

Invoice created successfully. Decrypt the server response to view the result.

404

Not able to create invoice, Unauthorized or Permission Denied

500

Internal Server Error – An unexpected error occurred on the server while processing the request. This may be due to a temporary issue or a server-side malfunction. Please try again later or contact support if the issue persists.