search

Accept Refund

Use Case

The webhook is generated after successful deduction of refund amount from merchant’s due settlement amount. After completion of this step, we have accepted the refund.

 

The sample response is mentioned below.

 

{
  "head": {
    "signature": "Ec4jwawWFcsOS4lZJ5aClcats/J8c55CJ/DW0MA9gp37MwQ8bcXsMT1mmlbDrefundIdwgGOzxzba5/kADe7UiALEtZQvKVQ5YrYS/pcQtZ0gghKLWc=",
    "version": "v1"
  },
  "body": {
    "txnTimestamp": "2020-09-03 16:51:41.0",
    "orderId": "ORDERID_98765",
    "refundAmount": "1.00",
    "refundId": "20200903XXXXXX801300168821700215705",
    "txnAmount": "1.00",
    "txnId": "202005081112128XXXXXX68470101509706",
    "merchantRefundRequestTimestamp": "2020-09-03 16:52:08.0",
    "acceptRefundTimestamp": "2020-09-03 16:52:09.0",
    "refId": "REFUNDID_98765",
    "refundReason": "Sample Refund Reason ",
    "agentInfo": {
      "employeeId": "Emp-001",
      "name": "Lalit",
      "phoneNo": "7777777777",
      "email": "customer@example.com"
    },
    "status": "SUCCESS"
  }
}

The parameters are briefly described below.

Response Attributes

ATTRIBUTE DESCRIPTION

Head

signature
string
Paytm validates the request and ensures that parameters are not tempered by verifying the signature in the request. For creating the checksum (signature) refer to the steps given in Checksum logic.
Example:
Ec4jwawWFcsOS4lZJ5aClcats/J8c55CJ/DW0MA9gp37MwQ8bcXsMT1mmlbDwgGOzxzba5/kADe7UiALEtZQvKVQ5YrYS/pcQtZ0gghKLWc=

Body

txnId
string(64)
This is a unique Paytm transaction ID corresponding to REFID for which status is being checked. TXNID is provided in response payload for every transaction.
Example: 202005081112128XXXXXX68470101509706
orderId
string(50)
Order ID is merchant’s unique reference ID for a transaction passed in the transaction payload.
Example: OREDRID_98765
txnAmount
string(10)
Order value of the transaction in INR
Example: 1.00
txnTimestamp
string(30)
Timestamp of payment transaction
Example: 2020-09-03 16:51:41.0
refundAmount
string(10)
Total cumulative refund amount against this transaction. For example for a transaction with order value as INR 100, there has been two refunds of INR 20 & INR 30 historically, then TOTALREFUNDAMT will be INR 50.
Example: 1.00
acceptRefundTimestamp
string(30)
Timestamp at which Paytm accepted the refund. At the time of acceptance refund amount is deducted from the merchant payable balance.
Example: 2020-09-03 16:52:09.0
refId
string(50)
Merchant’s reference ID unique for every refund transaction. This is REFID for which refund status is being inquired.
Example: REFUNDID_98765
merchantRefundRequestTimestamp
string(30)
Timestamp at which merchant requested the refund
Example: 2020-09-03 16:52:08.0
refundId
string(64)
This is a unique Paytm refund identifier that is issued by Paytm for each valid refund request
Example: 20200903XXXXXX801300168821700215705
refundReason
string
Refund Reason
Example: Sample Refund Reason
agentInfo
object
Refund agent details
Example: {"employeeId": "Emp-001", "name": "Lalit", "phoneNo": "7777777777", "email": "customer@example.com"}
employeeId
string
Employee Id
Example: EMP-001
name
string
Name
Example: Lalit
phoneNo
string
Phone number
Example: 7777777777
email
string
This is a unique Paytm refund identifier that is issued by Paytm for each valid refund request
Example: customer@example.com
status
string
status
Example: FAILED
rejectRefundReasonCode
string
Reject refund reason code. This parameter is available in response only when  the value of "status" is "failed"
Example: 1
rejectRefundReasonMessage
string
Reject refund reason message. This parameter is available in response only when  the value of "status" is "failed"
Example: Insufficient balance in your settlement account