Paytabs provides you with a collection of API endpoints that are used to process all payments, regardless of if they are through either your own payment pages, the managed payment pages, or if you are using the hosted payment pages.
An invoice is a document you send to your client after purchasing goods or services from you, both as a means of recording the sale and requesting payment from them. You can catch everything you need about PayTabs invoices in our what Paytabs Invoices is? solutions article.
As PayTabs invoices follow our Hosted Payment Page mechanism, it is suitable for merchants with PCI SAQ A or merchants who do not have any PCI levels. To customize the UI of the hosted payment page, check this article, and to know more about the Hosted Payment Page PCI DSS merchant requirements, please check this article.
In this article, we will walk you through how to initiate a payment request via this integration type. You will be introduced to the required parameters that need to be passed to initiate the request, along with all the possible optional parameters as well. We highly recommend that you and your team check the "Step 3.1 - Invoices | Payment Workflow" solution article first to understand the business/logic this integration type relies on. Kindly note that there are two endpoints that you can initiate the invoice with, clarified below:
In this article, you will be going to know about:
- Creating the Invoice
- Sending the Invoice
- Downloading The Invoice
Creating the Invoice
PayTabs provides you with two different endpoints that will enable you to initiate Invoices, You can find below all the details and workflow for these two endpoints:
Via the Invoice endpoint
In this part, we will rely on the PayTabs invoices API Endpoint. Here, we will use an endpoint dedicated to creating invoices only that will also give you a group of invoice-related features that can help you with your business needs. You can learn everything you need about initiating payment with this endpoint in our Initiating the Payment Request Via Invoice Endpoint solution article
Via the Payment endpoint
Another way of initiating invoices is through the normal payment endpoint. However, this comes with some limitations in the invoice itself and in the invoice-related features, which is why we recommend relying on the above invoice endpoint. If you want to learn more about creating invoices via the payment endpoint, you can check our Initiating the Invoice Payment Request via Payment Endpoint solution article.
Sending the Invoice
PayTabs provides you with two ways to send your invoices to your customers. These ways are sending via SMS and Emails. Below you will find these ways clarified in two different articles mentioning the workflow of the sending process.
Send the Invoices via SMS
Reaching this section, your invoice is now ready to be sent to your clients. To do so, you can use your mail provider to send the generated invoices, or even you can use our invoice SMS API to send your invoices via SMS to your clients or even you can send it within the initial creation of the invoice request. You can find the steps you need to send an invoice via SMS in our Send Invoices via SMS solution article.
Send the Invoices via Email
Here, you will be able to use the Notification parameter to provide up to 5 customers' emails and once the invoice is created, it will be sent to the provided email(s). You can find the steps you need to accomplish this clarified in our Send Invoice via Email solution article.
Downloading The Invoice
In this part, we will walk you through the proper way to download the invoice as a PDF byte object using an API endpoint so that you can use it to either download or display it to your customer. To learn more about this feature, check our Download Invoice PDF solution article.
⌂ To get familiar with the whole process and the other steps, kindly navigate to our "The Invoices APIs Integration Manual" solution article.
⇦ And to get familiar with the rest of the steps regarding the previous step "Step 2 - Configure the integration method" kindly click here.
⇦ And to get familiar with the rest of the steps regarding the current step "Step 3 - Initiating the payment" click here.
⇨ And to navigate to the next step in the integration process "Step 4 - Accepting the payment" kindly click here.