paytm developer docs logoDeveloperDocumentation
search

Reversal Status

Use Case

The webhook is generated after successful reversal of funds has been done in merchant payouts account.

Callback will be triggered for the following cases -

  1. Fresh Reversal (Merchant's callback will be triggered only when refund for this case will be successful as Beneficiary Bank rejected the original transaction)
  2. Credit Adjustment (Merchant's callback will be triggered only when refund for this case will be successful due to beneficiary bank gave real-time success on original transaction but later on, reversed the transaction to remitter bank because it didn't credit the beneficiary account)
  3. Wrong Credit (Merchant's callback will be triggered only when refund for this case will be successful)
  4. Penalty Credit (Merchant's callback will be triggered in case of both success and failure of Penalty Credit Order to wallet)

The sample response is mentioned below.

{
    "status": "FAILURE",
    "statusCode": "DE_685",
    "statusMessage": "Fresh reversal",
    "result": {
        "mid": "bisler43214343241",
        "orderId": "Nef001",
        "paytmOrderId": "3213412321312312333",
        "amount": "21.0",
        "commissionAmount": "1.21",
        "tax": "0.22",
        "rrn": "016100034853",
        "beneficiaryName": "abcdfef",
        "reversalReason": "FRESH_REVERSAL"
    }
}

Note: "reversalReason" will be null if callback is not for Auto Reversal

The parameters are briefly described below.

Response Attributes

ATTRIBUTE DESCRIPTION

Header
x-checksum
string		 Signature encryption for validation. It's value to be sent should be the checksum string created by using Paytm checksum library.
Note: Create the signature using all the request parameters.
Example:
Ec4jwawWFcsOS4lZJ5aClcats/J8c55CJ/DW0MA9gp37MwQ8bcXsMT1mmlbDwgGOzxzba5/kADe7UiALEtZQvKVQ5YrYS/pcQtZ0gghKLWc=

Body
mid
string		 Paytm provides MID as a unique identifier to each merchant.
Example: bisler43214343241
orderId
string		 Unique reference id provided by the merchant for this disbursal request.
Example: Nef001
paytmOrderId
string		 Unique ID generated at paytm end corresponding to each transaction.
Example: 3213412321312312333
amount
string		 Amount in INR requested by the merchant for disbursal. This will contain digits up to two decimal points.
Example: 21.0
commissionAmount
string		 Commission amount in INR payable by the merchant. This will contain digits up to two decimal points.
Example: 1.21
tax
string		 Tax amount in INR payable by the merchant. This will contain digits up to two decimal points.
Example: 0.22
rrn
string		 Unique reference number created by a bank against each transaction.
Example: 016100034853
reversalReason
string		 Reason for reversal of the order
Example: FRESH_REVERSAL
beneficiaryName Name of the customer to whom disbursal is being made.
Example: abcdfef
status Final Status of Order
Example: FAILURE
statusCode Success or Failure status code
Example: DE_685
statusMessage Description of each statusCode
Example: Fresh reversal