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  Customer Reference  (customer_ref) parameter. "customer_ref" is one of the optional parameters that the request may have, which Indicates a reference to the customer at the merchant end to easily relate the transaction. 


Specifications 


The Parameter Tag/Namecustomer_ref
JSON Example
{
    "customer_ref":"cust_2323",
}
JavaScript
Data TypeSTRING 
Required
x
Validation Rules

-

Min Length-
Max Length
512



Usage Workflow


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


You can notice that the passed "customer_ref" 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",

    "customer_ref":"cust_121232",
}
Generic



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",

    "customer_ref":"cust_121232",

    "redirect_url": "https://secure-egypt.paytabs.com/payment/page/599B792482E5A2AB2A3E8373265BA2963700A06113BC510285887ED7",
    "serviceId": 2,
    "profileId": 987654,
    "merchantId": 123456,
    "trace": "PMNT0404.6368BC3D.000BAF4C"
}
Generic