ClickPay 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 Profile ID (profile_id) parameter. "profile_id" is one of the mandatory parameters that the request should have, which indicates the merchant Profile ID you can get from your ClickPay dashboard. For more information please check our How to get your account information from Dashboard? solution article.



Specifications


The Parameter Tag/Nameprofile_id
JSON Example
{    "profile_id": 40677}
Data TypeINT
Required✔
Validation RulesAccept only valid profile numbers.


Usage Workflow


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


You can notice that the passed "profileId" parameter is already included within the response object.



Sample Request Payload


{
    "profile_id": "40111",

    "tran_type": "sale",
    "tran_class": "ecom",
    "cart_id": "16055",
    "cart_currency": "SAR",
    "cart_amount": 100,
    "cart_description": "Description of the items/services",
}


Sample Response Payload


{
    "tran_ref": "TST2231101374414",
    "tran_type": "Sale",
    "cart_id": "CART#1001",
    "cart_description": "Description of the items/services",
    "cart_currency": "USD",
    "cart_amount": "500.00",
    "redirect_url": "https://secure.clickpay.com.sa/payment/page/193F792482E5A2AB2E3E8383265BA2963700A06113BC510285887ED7",
    "serviceId": 2,

    "profileId": 40111,

    "merchantId": 4321,
    "trace": "PMNT0704.636AEC3D.000B014C"
}


..

ClickPay 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 Profile ID (profile_id) parameter. "profile_id" is one of the mandatory parameters that the request should have, which indicates the merchant Profile ID you can get from your ClickPay dashboard. For more information please check our How to get your account information from ClickPay Dashboard? solution article.


Specifications


The Parameter Tag/Name
profile_id
JSON Example
{    "profile_id": 987654}
Data Type
INT
Required
✔
Validation Rules
Accept only valid profile numbers.



Usage Workflow

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

You can notice that the passed "profileId" parameter is already included within the 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",
}

Sample Response Payload

{
    "tran_ref": "TST2231101374414",
    "tran_type": "Sale",
    "cart_id": "CART#1001",
    "cart_description": "Description of the items/services",
    "cart_currency": "USD",
    "cart_amount": "500.00",
    "redirect_url": "https://secure.clickpay.com.sa/payment/page/599B792482E5A2AB2A3E8373265BA2963700A06113BC510285887ED7",
    "serviceId": 2,

    "profileId": 987654,

    "merchantId": 123456,
    "trace": "PMNT0404.6368BC3D.000BAF4C"
}