Success Refund

Use Case

The webhook is generated after successful submission of refund to the acquiring bank.

Note: This webhook indicates that the bank has acknowledged the request for refund to customer’s account. It does not indicate that the customer has realised the refund in his/her account.

The sample response is mentioned below.

{
  "head": {
    "signature": "AuCS57JOdq62oSPsxLCWTQupUuN1PPMbe7Gf1BIvO6FK7JnfzDzSm4HCBftanrpPPpT9EAIOWiNZ8LsvwFrTnonldx2qzHfAzizoi1ndhNQ=",
    "version": "v1"
  },
  "body": {
    "source": "MERCHANT",
    "txnId": "202005081112128XXXXXX68470101509706",
    "orderId": "ORDERID_98765",
    "txnAmount": "1.00",
    "mid": "INTEGR7769XXXXXX9383",
    "refundAmount": "1.00",
    "txnTimestamp": "2020-09-03 16:51:41.0",
    "totalRefundAmount": "1.00",
    "acceptRefundTimestamp": "2020-09-03 16:52:10.0",
    "refId": "REFUNDID_98765",
    "merchantRefundRequestTimestamp": "2020-09-03 16:52:08.0",
    "userCreditInitiateTimestamp": "2020-09-03 16:52:10.0",
    "refundId": "20200903XXXXXX801300168821700215705",
    "refundDetailInfoList": [
      {
        "refundType": "TO_SOURCE",
        "payMethod": "CREDIT_CARD",
        "refundAmount": "1.00",
        "rrn": "1735XXXX84",
        "issuingBankName": "HDFC Bank",
        "maskedCardNumber": "5242********3040",
        "cardScheme": "MASTER",
        "userCreditExpectedDate": "2020-09-13"
      }
    ],
    "agentInfo": {
      "employeeId": "Emp-001",
      "name": "Lalit",
      "phoneNo": "7777777777",
      "email": "customer@example.com"
    }
  }
}

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
gatewayInfo	Response provided by the gateway during payment or transaction. This is available for Super Router product only.
totalRefundAmount 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
userCreditInitiateTimestamp string(30)	Timestamp at which Paytm has initiated the refund with the acquirer. Note that this should not be confused with the time customer realizez the money into his account Example: 2020-09-03 16:52:10.0
refundId string(64)	This is a unique Paytm refund identifier that is issued by Paytm for each valid refund request Example: 20200903XXXXXX801300168821700215705
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
refundDetailInfoList object	Details of refund like masked refund destination, refund amount allocation, RRN Number etc Example: 20200903XXXXXX801300168821700215705

RefundDetailInfoList

Name	Description
userMobileNo string (15)	User's masked mobile number Example: 7777777777
refundType string (10)	Type of refund. To_Source: Refund is being credited to the same destination through which the payment took place To_Instant: Refund is being credited to a bank account where refund will be realized instantly by the customer. Example: TO_SOURCE
payMethod string (10)	Payment method through which the refund has happened Example: CREDIT_CARD
issuingBankName string (25)	Issue bank Name Example: HDFC Bank
refundAmount string (10)	Refund amount in INR Example: 1.00
rrn string (10)	rrn number Example: 1735XXXX84
maskedVpa string (15)	masker vpa number Example: ***ya@paytm.com
maskedCardNumber string (25)	For credit/debit card refunds, this constains the masked number of the card where refund is being credited to. Example: 5242********3040
maskedBankAccountNumber string (25)	For To_instant refund type, this constains the masked bank account where refund is being credited to. Example: 489377******2085
cardScheme string (10)	For credit/debit card refunds, this constains the card scheme where refund is being credited to. Example: VISA
userCreditExpectedDate string (50)	Latest date for customer to realize the refund Example: 2020-09-13

Success Refund

Use Case

Response Attributes

Head

Body

RefundDetailInfoList