Paytabs provides you with a collection of API endpoints which 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.


This article is dedicated to the clarification of the  Theme Select (config_id) parameter. Transaction API | Creating Payment Page have the parameter that allows you to choose between your list of themes that have been created on your Paytabs dashboard. This chosen theme will be applied to the created payment page.


To know more about how to create, edit, or remove a theme from your Paytabs Dashboard please check our How to customize the PayPage UI? 



In this article, you will be going to know:


Specifications 


The Parameter Tag/Nameconfig_id
JSON Example
{
     "config_id": 2188
}

Data TypeINT
Required
❌
Validation Rules

Valid Theme ID (from Paytabs dashboard)



Usage Workflow


You will need to get the theme ID from the Paytabs Dashboard under Developer / PayPage settings (Theme)



Along with the required parameters mentioned in our Step 3 - PT2 API Endpoints | Initiating the payment solution article, you will need to set the "config_id" as shown below:




You can notice that the passed "config_id" parameter will NOT be included within the create payment page response object.


Sample Request Payload

    

{
    "profile_id": "987654",
    "tran_type": "sale",
    "tran_class": "ecom",
    "cart_id": "CART#1001",
    "cart_currency": "USD",
    "cart_amount": 500,
    "cart_description": "Description of the items/services",

    "config_id": 2188
}


Sample Response Payload

  

{
    "tran_ref": "TST2231401378006",
    "tran_type": "Sale",
    "cart_id": "CART#1001",
    "cart_description": "Description of the items/services",
    "cart_currency": "USD",
    "cart_amount": "500.00",
    "tran_currency": "",
    "tran_total": "0",
    "return": "none",
    "redirect_url": "https://secure-egypt.paytabs.com/payment/page/599F3E0782E4377D7B2BF74618F752464B553AD8EAB1D33D68640EC8",
    "serviceId": 2,
    "profileId": 81784,
    "merchantId": 31237,
    "trace": "PMNT0404.636CFB1E.000148EE"
}


The Expected Parameter Behaviors


While the payment workflow proceeds with redirecting the customer to the payment page would apply all the PayPage settings (theme) as it had been set on the Paytabs Dashboard.


  • Sample Payment Page


As a result of applying the setting below