Refund Transaction API

The Refund Transaction API (cancel_refund_transaction) can be used for the following purposes:

• Cancel a transaction that is in 'auth' state at the moment
• Refund a transaction that is in a 'captured' state at the moment

To learn more about different payment states, refer to Payment States Explanations.

In this API:

• var1 is the Payu ID (mihpayid) of the transaction
• var2 should contain the Token ID (unique token from the merchant)
• var3 parameter should contain the amount that needs to be refunded

Environment

Sample request

Simple sample request

curl -X POST "https://test.payu.in/merchant/postservice?form=2" \
-H "accept: application/json" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "key=JP***g&command=cancel_refund_transaction&var1=403993715521937565&var2=20201105secrettokenaturend&hash=10"

Sample request with split information JSON

curl -X POST "https://test.payu.in/merchant/postservice?form=2" \
-H "accept: application/json" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "key=JP***g&command=cancel_refund_transaction&var1=403993715521937565&var2=20201105secrettokenaturend&hash=10&var9=child_merchant_key_1:{\"amount\": 100,\"aggregatorRefundAmount\": 40 }"

Sample Responses

Success Scenarios

1. On successful processing from PayU:

Array 
(
      [status] => 1
      [msg] => Cancel Request Queued 
      [txn_update_id] => <Request ID> 
      [bank_ref_num] => <Bank Reference Number> 
      [mihpayid] => <PayU Transaction ID>
)

2. On successful processing for captured transactions:

Array 
(
     [status] => 1
     [msg] => Refund Request Queued 
     [request_id] => Request ID 
     [bank_ref_num] => <Bank Reference Number> 
     [mihpayid] => <PayU Transaction ID>
)

3. On successful processing for auth transactions:

Array 
(
    [status] => 1
    [msg] => Cancel Request Queued 
    [txn_update_id] => <Request ID> 
    [bank_ref_num] => <Bank Reference Number>
)

Failure Scenarios

1. If token is missing:

{
      "status": 0,
      "msg": "token is empty",
      "mihpayid": "403993715521937565"
}

2. If amount is missing:

Array 
(
    [status] => 0
    [msg] => amount is empty 
)

3. If the transaction is not found:

Array 
(
    [status] => 0
    [msg] => transaction not exists 
)

4. If failed to refund:

Array 
(
    [status] => 0
    [msg] => Refund request failed
)

5. If capture is done on the same day:

Array 
(
    [status] => 1
    [msg] => Capture is done today, please check for refund status tomorrow 
    [request_id] => Request ID
    [bank_ref_num] => Bank Reference Number
    [mihpayid] => PayU ID
)

6. If the token is invalid:

Array
(
    [status] => 0
    [msg] => token already used or request pending 
)

7. If failed to cancel a transaction:

Array 
(
    [status] => 0
    [msg] => Cancel request failed
)

📘

Test Environment Responses

The response for Refund Transaction API in Test Environment has specific limitations:

1. For Regular Merchants:

plaintext

Array
(
    [status] => 1
    [msg] => Refund Request Queued
    [request_id] => 136409872
    [bank_ref_num] => 
    [mihpayid] => 403993715530925893
    [error_code] => 102
)

2. For Merchants with Split transaction enabled:

JSON

{
  "status": 236,
  "msg": "Refund Split Info must be of JSON format",
  "mihpayid": "403993715521937565"
}

Important: The error_code value 102 should be treated as success; the rest are failures. For the list of error codes, refer to Error Codes for Refund Initiation.

Response Parameters

📘

Note on Error Codes

The error_code value 102 should be treated as success; the rest are failures. To learn more about the possible error codes and their description, refer to Error Codes.

Request Parameters Reference

Key Request Parameters

Split Transaction Parameters (var8)

The var8 parameter is in JSON format that contains the following fields:

Sample JSON for var8

{
  "child_merchant_key_1": { 
    "amount": 100, 
    "aggregatorRefundAmount": 40 
  }, 
  "child_merchant_key_2": {
    "amount": 20, 
    "aggregatorRefundAmount": 0 
  }
}

📘

Reference

var5 and var8 are optional parameters and not included in the following Try It experience. For more information on description with examples, refer to the Other request parameters subsection.

Example Values for Testing

Use the following sample values while trying out the API:

• var1 (mihpayid): 403993715521937565
• var2 (reference number for a refund provided by merchant): 20201105secrettokenaturend