Skip to main content

Refund Transaction

To refund a transaction means to return/transfer back a transaction amount from your bank account to the customer's bank account. It will be logged as a new separated transaction with this type, and it will be related to the previous "Sale" or "Capture" transaction. In this manual, we walk you through how to use and manage the mentioned endpoint.

Refund request is available ONLY for those Authenticated Sale transactions or Authenticated Capture transactions. In which the tran_type MUST be “refund”, and the requested transaction id to be refunded MUST be passed to the tran_ref parameter in the request.

you should know

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




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

POST{{domain}}/payment/request
Be Aware Of

Please note that not using the proper endpoint URL {domain} will lead to authentication issues within your responses. To find the your proper domain you can read ourWhat is my (Region)/(endpoint URL)?tutorial article.

https://secure.paytabs.sa/payment/request


The Minimum Required Parameters​

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

ParameterData TypeRequired
tran_ref
STRING✔
Indicates the Transaction Reference on the PayTabs Technical Portal side check details on [Response Parameters | tran_ref]
{
    "tran_ref": "TST2234701408XXX"
}


Sample Request Payloads​

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.

be aware of

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

{
  "profile_id": 703XX,
  "tran_type": "refund",
  "tran_class": "ecom",
  "cart_id": "CART#10001",
  "cart_currency": "SAR",
  "cart_amount": 99.99,
  "cart_description": "Refund reason",
  "tran_ref": "TST2016700000XXX"
}
be aware of

Be aware that the tran_type MUST be Refund.



Sample Response Payloads​

{
    "tran_ref": "TST2105900091XXX",
    "tran_type": "Refund"
    "cart_id": "CART#10001",
    "cart_description": "Product/Service description",
    "cart_currency": "SAR",
    "cart_amount": "100",
    "customer_details": {
        "name": "Technical Support",
        "email": "demo@paytabs.com",
        "phone": "+966 55 xxxxxx6",
        "street1": "address street",
        "city": "Jeddah",
        "state": "Makkah",
        "country": "SA",
        "ip": "86.111.XXX.X"
    },
    "payment_result": {
        "response_status": "A",
        "response_code": "G15046",
        "response_message": "Authorised",
        "transaction_time": "2021-02-28T12:24:06Z"
    },
    "payment_info": {
        "card_type": "Credit",
        "card_scheme": "Visa",
        "payment_description": "4111 11## #### 1111"
    }
}