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 Transaction Type (tran_type) parameter. "tran_type" is one of the mandatory parameters that the request should have, which indicates the type of transaction that will be initiated such as sale, refund, void, or else. 


For more information please check our What is the "tran_type" (transaction type)? solution article.


The Parameter Tag/Nametran_type
JSON Example
    "tran_type": "sale"
Data TypeENUM[sale, auth, void, release, capture, refund, register]
Validation Rules
  • Accept only valid transaction type
Max Length

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 "tran_type" as shown below:

You can notice that the passed "tran_type" 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": "",
    "serviceId": 2,
    "profileId": 987654,
    "merchantId": 123456,
    "trace": "PMNT0404.6368BC3D.000BAF4C"