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. 

To void a transaction means that the previously authorized/held amount from a previous auth transaction will be released back to the cardholder's bank account from his own bank side, as it was kept on hold there. In this article, we walk you through how to use and manage the mentioned endpoint. 

Void requests are available for ONLY Authenticated Authorized transactions that are not fully captured yet. To process a void request, tran_type should be “void”, and the transaction id of the original Authorize transaction that you want to capture should be passed in the tran_ref  parameter.

Through out the article we will use the transaction types clarified in our What is "tran_type"? solution article.   . 

In this article, you will be going to know about:

• The Endpoint and Related Postman Collection
• The Minimum Required Parameters
  • Sample Request Payload
  • Sample Response Payload

The Endpoint and Related Postman Collection

In this tutorial, we will rely on the PayTabs Void Transaction API Endpoint, mentioned on the PayTabs API endpoints postman collection, which you can access from here. The endpoint will need to be accessed with a POST request on the below-mentioned URL

Please note that not using the proper endpoint URI {{domain}} will lead to authentication issues within your responses. To find the your proper domain you can read our What Is My (Region)/(endpoint URL)? solution article.

The Minimum Required Parameters

To initiate a void payment request, there are minimum required parameters that need to be passed with valid information. The specification of these required parameters is clarified below:

Sample Request Payload

The below sample request payload will show you how you can pass the above-mentioned parameters, which are needed to be passed with valid values to perform a request.   

Void request is ONLY available for successfully Authorized (A) transactions. 

{
    "profile_id": 70303,
    "tran_type": "void",
    "tran_class": "ecom",
    "cart_id": "cart_66666",
    "cart_currency": "{{currency}}",
    "cart_amount": 1.3,
    "cart_description": "Void reason",
    "tran_ref": "TST2016700000692"
}

Note that the "tran_type" MUST be "void".

{
  "tran_ref": "TST2111100150608",
  "tran_type": "Void",
  "cart_id": "cart_11111",
  "cart_description": "Void reason",
  "cart_currency": "EGP",
  "cart_amount": "100.00",
  "customer_details": {
    "name": "first last",
    "email": "[email protected]",
    "phone": "0522222222",
    "street1": "address street",
    "city": "dubai",
    "state": "DU",
    "country": "AE",
    "ip": "196.219.145.121"
  },
  "payment_result": {
    "response_status": "A",    
    "response_code": "G98948",
    "response_message": "Authorised",
    "transaction_time": "2021-04-21T09:55:48Z"
  },
  "payment_info": {
    "card_type": "Credit",
    "card_scheme": "Visa",
    "payment_description": "4111 11## #### 1111"
  }
}

⌂ To get familiar with the whole process and the other steps, kindly navigate to our "The PT2 API Endpoints Integration Manual" solution article. 
	

	
⇦ And to get familiar with the rest of the steps regarding the current step "Step 7 - Manage Transactions" kindly click here.
	

	
⇦ And to navigate to the previous step in the integration process "Step 6 - Handle the post payment responses" kindly click here.