Different Integration Types Supported by PayTabs APIs
PayTabs offers four different integration types, each designed to meet specific business needs. These are the Hosted Payment Page (HPP), Invoices, Managed Form, and Own Form. Each integration type can be initiated through PayTabs' API endpoints. In this manual, we’ll guide you through the differences between these integration types to help you choose the most suitable option for your business.
Payment Workflow
Understanding how each PayTabs integration type processes payments is crucial for selecting the right option for your business. Each integration type follows a specific workflow, from initiating the payment request to returning the transaction results. Whether you're looking for a simple redirect solution or a fully customized payment form, the following section outlines how payments are processed in each integration type.
1. Hosted Payment Page (HPP)
In the Hosted Payment Page method, you will initiate a transaction API request, which returns a response containing a payment page link. The merchant should redirect the customer to this payment page link, which allows the customer to complete the transaction. Once the payment is finished, PayTabs will redirect the customer back to the merchant’s website using the return URL specified in the API request, and the payment results will be posted to that URL.
To learn more about the Hosted Payment Page workflow, click here.
2. Invoices
To use Invoices, the merchant must create an invoice with valid information. This invoice link can then be sent to the customer via any communication method. The customer can pay the invoice anytime between the activation and expiration date by clicking the "Pay Now" button on the invoice page. After payment is completed, the customer will be redirected to a success page, and the invoice cannot be paid again. Merchants can track invoices through the Merchant Dashboard.
To learn more about the Invoices workflow, click here.
3. PayLinks
PayLinks directs your customers to a secured payment page. When customers click on the link, they are instantly taken to the payment page, ensuring that you receive payments promptly. Since PayLinks are reusable, you can share them with customers multiple times. Additionally, PayLinks can be shared on social media accounts or sent via SMS or WhatsApp for added convenience.
4. Managed Form
With Managed Form, your website will display its own card entry form, but critical fields will be managed by the PayTabs gateway. You will need to integrate a script that replaces sensitive card data with a payment token. When the form is submitted, the paylib.js script will send the card details to PayTabs for token generation. Once generated, the token is inserted into the form data before being sent to your server. The server then processes the payment using the tokenized data, ensuring that sensitive card details are not directly handled by your system.
To learn more about the Managed Form workflow, click here.
5. Own Form
In the Own Form method, your website will display its own card entry form and capture the required details (card number, expiry date, security code, etc.). After submission, the card details will be sent to your server, which then forwards a payment request to PayTabs, including the card details. If the card is enrolled in 3D Secure (3DS), the API response will return a redirect URL where the customer can complete the authentication. For non-3DS cards, the payment result will be returned directly in the API response.
To learn more about the Own Form workflow, click here.
Features and Considerations
| Consideration | Hosted Payment Page (HPP) | Invoices | Managed Form | Own Form | PayLinks |
|---|---|---|---|---|---|
| Integration Manual | Yes | Yes | Yes | Yes | Yes |
| Hosted on PayTabs Server | ✔ | ✔ | ❌ | ❌ | ✔ |
| Managed by PayTabs | ✔ | ✔ | ✔ (On merchant's server) | ❌ | ✔ |
| Access to Card Details | ❌ | ❌ | ❌ | ✔ | ❌ |
| Customize Payment Page Theme | ✔ | ✔ | ✔ (UI control) | ✔ | ✔ |
| Customize Payment Form Fields | ❌ | ❌ | ✔ | ✔ | ❌ |
| One Page Checkout (Iframe) | ✔ | ✔ | ✔ | ✔ | ✔ |
| PCI Requirements | ❌ | ❌ | ✔ (SAQ A-EP) | ✔ (SAQ D-Merchant) | ❌ |
| Supported Payment Methods | All | All | Cards only | Cards only | All |
| Token-Based Transactions | ✔ | ✔ | ✔ | ✔ | ✔ |
| Post Payment Response | ✔ | ✔ | ✔ | ✔ | ✔ |
| Follow-up Transactions | ✔ | ✔ | ✔ | ✔ | ✔ |
| Cancel Before Payment | ❌ | ✔ | ❌ | ❌ | ❌ |
| Send via Email & SMS | ❌ | ✔ | ❌ | ❌ | ✔ |
| Donation Mode | ✔ | ❌ | ❌ | ❌ | ✔ |
| Card Discount | ✔ | ❌ | ❌ | ❌ | ✔ |
| Card Filter | ✔ | ❌ | ❌ | ❌ | ✔ |
PCI Certification
Note: If you are not PCI certified, we highly recommend using the Hosted Payment Page. For businesses that want to avoid redirecting customers outside of their site, PayTabs also provides an Embedded Hosted Payment Page.
You can customize the payment form to fit the look and feel of your business, with the following customization options:
- Hosted Payment Page/Invoices**: Customize colors and labels by following this guide.
- Managed Form**: Since you are creating the form yourself, you can control its UI and fields order, though field names are fixed.
- Own Form**: Full control over the entire payment form, including customization of all UI elements and fields.
🗃️ ◎ Hosted Payment Page
8 items
🗃️ ◎ Invoices
8 items
🗃️ ◎ PayLinks
8 items
🗃️ ◎ Managed Form
8 items
🗃️ ◎ Own Form
8 items
🗃️ ◎ Request & Response Parameters
31 items
🗃️ ◎ Supported Direct Payment Methods
2 items
🗃️ ◎ Supported Features
8 items