Prerequisites & Configurations

Prerequisites

Below, you will find a list of all the requirements/prerequisites that you must have ready before starting your Repeat Billing integration journey, so feel free to read them through and check the associated solution articles when needed:

1. Terms & Conditions URL Configured in your Profile:

   To be able to use our agreements API, you need to have a secured terms and conditions URL configured in your PayTabs profile. Therefore, you MUST create this URL and then share it with your RM or customercare@paytabs.com along with the exact profile you want to start using and they will configure it to you.



2. Server Key with Agreements Allowed:

   Here you MUST use a server key that has agreements allowed in it, you can check that by navigating to your merchant dashboard => Developers Menu => Key Management then check your server keys, ensuring that the one you are using has agreements as shown below:

   
   

   

---

Configure the Integration

Below you will find a set of points that MUST be ready before you start your agreements integration process, so navigate trough them one by one to be ready:

1. The first thing you will need to provide the proper endpoint URL to your request, as shown below:
   
   

   POST	{{domain}}/payment/request

   Be Aware Of

   
   

   Please note that not using the proper endpoint URL {domain} will lead to authentication issues within your responses. To find the your proper domain you can read ourWhat is my (Region)/(endpoint URL)?tutorial article.

   KSA

   https://secure.paytabs.sa/payment/request

   UAE

   https://secure.paytabs.com/payment/request

   Egypt

   https://secure-egypt.paytabs.com/payment/request

   Oman

   https://secure-oman.paytabs.com/payment/request

   Jordan

   https://secure-jordan.paytabs.com/payment/request

   Kuwait

   https://secure-kuwait.paytabs.com/payment/request

   Global

   https://secure-global.paytabs.com/payment/request


2. Then you will need to provide your API server key.
   
   

   curl --location --request POST '{{domain}}/payment/request' \--header 'authorization: SJ******MD-J2******L6-99******DZ' \
   You Should Know

   To know how to find your API Server/Client keys we recommend you to check ourHow to get my Authentication/Integration/API Keys?tutorial article.



3. Next, you will need to provide your profile_id within the required parameters that should be sent in the request payload.
   
   

    {profile_id => 2342} 
   You Should Know

   To know how to find your profile_id, we recommend you to check ourHow to get your account information from PT2 Dashboard?tutorial article.

   
   
   you should know

   In order to understand the types of PayTabs merchant profiles, we highly recommend you to check ourWhat is Test Profile vs Live Profile?solution article.

Here you are, done with configuring the PayTabs API endpoints. And now you can go on the ground with your business using the preferred payment methods.