Void Transaction

PayTabs provides you with the backend packages that make the integrating with PayTabs payment gateway very easy by providing ready-made classes that handle the payment process.

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 below function:

Method Specification

Description	To void a previously authorized/hold amount from a previous auth transaction (that reserved but not yet transferred to the merchant acquirer bank) will be released back to the cardholder's bank account from his own bank side, as it was kept on hold there.
Since	1.0.0
Required	✘
Signature	void(string $tran_ref, string $order_id, float $amount, string $void_description)
Sample	$tran_ref = "TST2016700000692"; $order_id = "cart_11111"; $void_description="Void reason of the items/services." $amount = 500.00; $void = Paypage::void($tran_ref, $order_id, $amount, $void_description); return $void;

Be Aware Of

Void requests are available for ONLY authenticated Auth transactions that are NOT fully captured yet.

Note

Through out the article we will use the transaction types clarified in ourWhat is the "tran_type" (transaction type)?solution article.

---

Method Parameters:

Tran Ref

Name	$tran_ref
Type	STRING
Description	Indicates the reference to the Auth transaction you want to void
Default	-
Validation Rule	Accept only valid Auth transaction references.
Required	✔

---

Order Id

Name	$order_id
Type	STRING
Description	Indicates the cart id to the transaction you want to void
Default	-
Required	✔

---

Amount

Name	$amount
Type	float
Description	Indicates the amount you want to void, either the full amount for a void or partial one for a release.
Default	-
Validation Rule	Accept only float amounts, which must be less than or equal to the authorized amount that has not been captured yet.
Required	✔

---

Void Description

Name	$void_description
Type	STRING
Description	Indicates the cart/order description at your end to easily relate this transaction to. It might contain the reason for the void.
Default	-
Required	✔

---

Sample Request:

To process a void request, you have to pass a tran_type that MUST be void which handed via the method and the transaction reference of the original authenticated Auth transaction that you want to void, as shown in the below sample:

$tran_ref = "TST2016700000692";
$order_id = "cart_11111";
$void_description="Void reason of the items/services."
$amount = 500.00;

$void = Paypage::void($tran_ref, $order_id, $amount, $void_description);
return $void;

---

Sample Response Payload:

The response PayTabs will send to you will be a JSON object that contains the full details regarding this void transaction, as shown below:

{
     "tran_ref": "TST2509502044803",
     "previous_tran_ref": "TST2016700000692",
     "tran_type": "Void",
     "cart_id": "cart_11111",
     "cart_description": "Void reason of the items/services.",
     "cart_currency": "SAR",
     "cart_amount": "500.00",
     "tran_currency": "SAR",
     "tran_total": "500.00",
     "customer_ref":"CUST0101",
     "customer_details": {
          "name": "Technical Support Team",
          "email": "[email protected]",
          "phone": "+966 55 xxxxxx6",
          "street1": "address street",
          "city": "Jeddah",
          "state": "Makkah",
          "country": "SA",
          "zip": "12345"
           "ip": "156.221.244.35"
      },
     "payment_result": {
         "response_status": "A",
         "response_code": "G40178",
         "response_message": "Authorised",
         "transaction_time": "2022-12-14T15:53:58Z"
     },
     "payment_info": {
         "payment_method": "Visa",
         "card_type": "Credit",
         "card_scheme": "Visa",
         "payment_description": "4000 00## #### 0002",
         "expiryMonth": 12,
         "expiryYear": 2026
     },
     "serviceId": 1,
     "paymentChannel": "Transaction API",
     "merchant_id": 31000,
     "profile_id": 81000,
     "trace": "PMNT0402.67F0E000.00108000"
 }