Response: Invoice Link (invoice_link)

Warning

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

In the fast-paced world of digital payments, convenience is key. PayTabs introduces theinvoice_link parameter, providing a direct URL to the generated invoice for quick access and payment.

Instead of manual sharing, merchants can easily embed or share this link via email, SMS, or apps, ensuring customers complete payments effortlessly.

---

How this parameter could benefit you?

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

• Direct Access: The invoice_link field provides a ready-to-use URL for the generated invoice.


• Easy Sharing: Merchants can share the link via email, SMS, or apps for quick customer payments.


• Improved Experience: Simplifies the payment process by eliminating manual navigation.

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

• Retail & E-commerce: Share invoice_link in emails or SMS for quick customer payments.


• Food & Beverage: Send invoice_link for table or delivery payments without manual steps.


• Hospitality & Travel: Include invoice_link in booking confirmations for easy payment.


• Education: Provide invoice_link in notifications for tuition or course fee payments.

---

How to use ?

• The invoice_link parameter is returned as part of the normal response when you create an invoice. There is no special step required to obtain it—simply follow the standard initiation process described in Invoices | Initiate the payment

• In a successful invoice creation request, you will receive theinvoice_link in the response payload along with other related fields.
  
  

  {
      "invoice_id": 335XXX3,
      "invoice_link": "https://secure.paytabs.sa/payment/request/invoice/335XXXX3/2250EA0B26A34AXXXXXXX684E7FBE435"
  }

---

Parameter Specifications

• invoice_link
  
  

  Parameter	invoice_link
  Description	Indicates the link to which customers should be directed to complete their invoice payment.returned in the success only
  Data Type	STRING
  Required	✘
  Sample	{ "invoice_link": "https://secure.paytabs.com/payment/request/invoice/6745/09D332CFFD0D466186D36E3XXXXXXXXX", }

---

Expected Payment Flow Behavior

Create Invoice

1. During the invoice creation process Invoices | Initiate the payment, a successful response will return both invoice_id andinvoice_link. The invoice_link is a response-only field and is not used in any API request.
   
   

   {
     "invoice_id": 335XXXX,
     "invoice_link": "https://secure.paytabs.com/payment/request/invoice/335XXXX/2250EA0B26A34AXXXXX"
   }


2. The merchant should store the invoice_link or share it with the customer. This link represents the actual URL where the customer is expected to open and complete the invoice payment.


3. Once the customer opens the invoice_link, they are redirected to the hosted invoice payment page. This page displays all invoice details such as amount, line items, merchant information, and description.
   


4. After reviewing the invoice, the customer proceeds by entering their payment information. As long as the invoice remains valid (not expired, cancelled, or paid), the payment can be completed normally.


5. If 3DS/OTP verification is required by the issuer bank, the customer will be redirected to complete authentication, then returned to the success or failure page accordingly.


6. At this stage:
   • A corresponding transaction will appear on the merchant dashboard.
   • The transaction will be linked to the original invoice through theinvoice_id.
   • The invoice_link becomes invalid if the invoice is later cancelled or marked as paid.


7. Important Notes Regarding invoice_link:
   • It appears only in the creation response of the invoice.
   • It serves exclusively as a customer-facing payment URL.
   • If the invoice is cancelled or expires, the link becomes unusable.