Response: Invoice ID (invoice_id)

Warning

This parameter ONLY working with those integration types (Invoices, and Invoices(Payment Endpoint)).

In the dynamic world of digital payments, accurate tracking and reference are crucial. PayTabs introduces the invoice_id parameter, a key element designed to simplify invoice management and enhance transaction visibility. This parameter provides merchants with a unique identifier for every invoice created, ensuring precise control and easy retrieval of payment details.

Instead of relying on generic references, the invoice_id parameter empowers merchants to store, search, and manage invoices efficiently. It can be used to fetch invoice details after payment, maintain accurate records in the merchant’s database, and quickly locate transactions in the dashboard.

This functionality not only improves operational efficiency but also strengthens the overall payment experience for both merchants and customers.

---

How this parameter could benefit you?

The invoice_id parameter offers significant advantages for merchants managing multiple profiles. Here’s how it can benefit you:

• Unique Identifier: The invoice_id field is returned in the response only when an invoice is created. It is unique per merchant profile.


• Post-Payment Reference: This ID can be used to retrieve invoice details after payment completion.


• Database Storage: Merchants can store the invoice_id in their database for future reference.


• Dashboard Search: The invoice_id can be used to search for invoices directly in the merchant dashboard.

Name but a few different Businesses/Industries that can benefit from this API parameter:

• Retail & E-commerce: Use invoice_id to track orders and manage refunds.


• Food & Beverage: Link invoice_id to receipts for easy reconciliation.


• Hospitality & Travel: Track bookings and payments using invoice_id.


• Education: Manage tuition and course payments with invoice_id for reporting.

---

How to use ?

• No special way to see this parameter in the response Payload of the invoice intiation. You should normally follow the steps at Invoice | Step 3 - Initiating the payment

• At this point, in the success case, you will receive the invoice_id in the response payload.
  
  

  {
      "invoice_id": 335XXX3,
      "invoice_link": "https://secure.paytabs.sa/payment/request/invoice/335XXXX3/2250EA0B26A34AXXXXXXX684E7FBE435",
      "trace_code": "PMNTXXX1.69XXXE04.000XXXX46"
  }

---

Parameter Specifications

• invoice_id
  
  

  Parameter	invoice_id
  Description	invoice_id is one of the parameters that received from our side in the payload. returned in the success only
  Data Type	INT
  Required	✘
  Min	1
  Max	9999999999
  Sample	{ "invoice_id": "10000010001" }