Refund Transaction API

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 }"

Success Scenarios

• On successful processing from PayU, the response is similar to the following:

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

• On successful processing from PayU end for captured transactions, the response is similar to the following:

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

On successful processing at PayU end for auth transactions, the response is similar to the following:

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

Failure scenarios

• If token is missing, the response is similar to the following:

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

• If amount is missing, the response is similar to the following:

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

• If the transaction is not found, the response is similar to the following:

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

• If failed to refund, the response is similar to the following:

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

• If capture is done on the same day, the response is similar to the following:

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
)

• If the token is invalid, the response is similar to the following:

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

• If failed to cancel a transaction, the response is similar to the following:

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

📘

Notes:

• The response for Refund Transaction API in Test Environment is similar to the following as it is the limitation with Test Environment:
  • Regular Merchant

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

  • Merchant with Split transaction enabled

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

• 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.

📘

Note:

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.

The Refund Details parameter of the response is in JSON format and the parameters in this JSON are described in the following table:

Other request parameters

Other request parameters used for Refund Transaction API (which are not in the below form for Try It experience) are listed in the following table:

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

Sample JSON for var8

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