Skip to main content

Prerequisites & Configurations

Prerequisites​

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

  1. PSP Merchants Only:

    This features is only available for PSP merchants and those are the merchants who signed up through the bank directly and PayTabs is only a technology provider for the merchant. All other KYCs, transactions monitoring, and updates are controlled and handled by the bank.


  2. Deposit Account Configured in your PayTabs Profile profile:

    Here you must contact your Account Manager or (customercare@paytabs.com) requesting enable and configure you profile for deposit. From there, they will be request to provide the need details and confirm once your configurations is done and you are ready to start your integration process.


  3. Split Payout Configured in your PayTabs Profile profile:

    Here you must contact your Account Manager or (customercare@paytabs.com) requesting enable and configure you profile for Split Payout. From there, they will be request to provide the details needed and confirm once your configurations is done and you are ready to start your integration process.


  4. Two Factor Authentication (2FA) MUST be Enabled in your Account:

    If you have not yet enabled the 2FA option in your account then you must enable it as all Deposit Integration will not be accessible unless you have enabled the 2FA. You can learn how to enable it and all the details related in our How to activate Two Factor Authentication (2FA) on the Merchant/ Reseller Dashboard? tutorial article.

Configurations the Integration​

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

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

    POST{{domain}}/payout/batch/new
    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.

    https://secure.paytabs.sa/payout/batch/new

  2. Next, you will need to provide your API server key.

    curl --location --request POST '{{domain}}/payout/batch/new' \--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. Finally, 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 Payout API endpoints. And now you can move forward in the manual to know how to use this service.