Refund Status

Use Case


  • To fetch status of refund transaction where real time response was not received of refund request
  • To fetch status of refund transaction where refund transaction status was communicated as pending

Request Attributes:

MID String(20) MandatoryThis is a unique identifier provided to every merchant by Paytm. MID is part of your account credentials and is different on staging and production environment. Your staging MIDs is available here & production MID will be available once your activation is complete
ORDERID String(50) MandatoryOrder ID is merchant’s unique reference ID for a transaction passed in the transaction payload. This is Order ID for which refund status is being inquired
REFID String(50) MandatoryMerchant’s reference ID unique for every refund transaction. This is REFID for which refund status is being inquired
CHECKSUMHASH String(108) MandatorySignature to avoid tampering. Generated using server side checksum utility available here

Response Attributes:

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
BANKTXNID String(100)The transaction ID sent by the bank. In case of Paytm proprietary instruments too, there is unique reference number generated by Paytm's system. In case the transaction does not reach the bank, this will be NULL or empty string. Primary reason for this is user dropping out of the payment flow before the transaction reaches to bank to servers
ORDERID String(50)Order ID is merchant’s unique reference ID for a transaction passed in the transaction payload
TXNAMOUNT String(10)Order value of the transaction in INR
STATUS String(20)This contains the status of refunds. It has following values: TXN_SUCCESS, TXN_FAILURE & PENDING
GATEWAY String(20)Gateway used by Paytm to process the transactions. By payment mode, gateways are provided below
Credit, debit cards UPI - Gateway used to process the transaction. For example, if HDFC gateway has been used to process SBI credit card transactions, the value will be HDFC
Net banking - Issuing Bank
Paytm Wallet - Wallet
RESPCODE String(10)Codes refer to a particular reason of refund failure. These are detailed in the list provided below
RESPMSG String(500)Description message attached with each respcode. These are detailed in the list provided below
MID String(20)This is a unique identifier provided to every merchant by Paytm
PAYMENTMODE String(15)The payment mode used by customer for transaction
Credit card – CC
Debit card - DC
Net banking - NB
UPI - UPI
Paytm wallet – PPI
REFUNDAMOUNT String(10)Amount for which refund is supposed to be made. It can be equal to or lesser than the transaction amount. It should be upto two decimal place. Should not include any separator like (“,”)
TOTALREFUNDAMT String(10)Total cummulative 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
TXNDATE DateTimeDate of payment transaction in the format "yyyy-MM-dd HH:mm:ss.S"
Format - “2015-11-02 11:40:46.0”
REFUNDDATE DateTimeDate of REFUND in the format "yyyy-MM-dd HH:mm:ss.S"
EX- “2015-11- 02 11:40:46.0”
REFID String(50)Merchant’s reference ID unique for every refund transaction. This is REFID for which refund status is being inquired
REFUNDID String(64)This is a unique Paytm refund identifier that is issued by Paytm for each valid refund request

Refund Status Response Codes, Messages and Status

10Refund successfulTXN_SUCCESS
311Invalid refund requestTXN_FAILURE
328Currency not sameTXN_FAILURE
501System errorTXN_FAILURE
600Invalid refund requestTXN_FAILURE
601Refund request was raised for this transaction but it is pending stateTXN_FAILURE
602Bank has declined refund requestTXN_FAILURE
604We are experiencing delays from the bankPENDING
606Checksum generated by paytm payment gateway does not match checksum expected by bankTXN_FAILURE
607Order not exist for current requestTXN_FAILURE
609Refund initiated for a rejected transactionTXN_FAILURE
610Transaction fully refunded alreadyTXN_FAILURE
612This is a valid authorized transactionTXN_FAILURE
617Refund already raisedTXN_FAILURE
619Invalid refund amountTXN_FAILURE
620Refund failedTXN_FAILURE
622No_token-transcation_limitedTXN_FAILURE
640Order is frozenTXN_FAILURE
700Invalid consult requestTXN_FAILURE
701Refund already raised with same refIDTXN_FAILURE
800No record foundTXN_FAILURE

Checksum Generation Utility

For Web:

For App:

Endpoints

Staging: https://securegw-stage.paytm.in/refund/HANDLER_INTERNAL/getRefundStatus

Production: https://securegw.paytm.in/refund/HANDLER_INTERNAL/getRefundStatus

Request CodeResponse JSON
curl -X POST
https://securegw-stage.paytm.in/refund/HANDLER_INTERNAL/getRefundStatus -H
'JsonData={"MID":"rxazcv89315285244163",
"ORDERID":"order1","REFID":"reforder1",
"CHECKSUM":"b%2BhFyBK9XUc8Sa%2BVzv7QFNoOQp%2FepntTjl15SQ%2FssJnJGbDfLAY9RIbLsYM9D5c3P0c44vQeB5b1A3qoGDStO6QjfdwpwxafS4wm8%2B%2B8S6k%3D"}'