search

POSTRefund Status API

Use Case

To fetch the status of the refund transaction which has been already initiated.

Request Attributes

Content Type : JSON

Head

AttributeDescription
clientId
string
optional

AI router to use the merchant key on the basis of clientId parameter value. It requires only if the merchant has more than one key.

requestTimeStamp
string
optional

EPOCH timestamp of the time at which request is being sent.
 

Example: 1588402269

signature
string
mandatory

AI router 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.

 Note: Create the signature using the body parameter of the request.

version
string
optional

Version of the API.

Body

AttributeDescription
mid
string
mandatory

This is a unique identifier provided to every merchant by AI router.
 

Example: 216820000002516036253

orderId
string
mandatory

It is a unique reference ID for a transaction passed in the transaction request. Order ID should be passed to raise the refund
 

Example: OREDRID_98765

refId
string
conditional

Unique Reference Id for refund transaction which is generated by merchant. Duplicate REFID will be rejected by the AI router.


Note: Either refId or refundId should be passed

Example: REFUNDID_98765

refundId
string
conditional

This is a unique AI router Refund Id that is issued by AI router for each refund request.


 Note: Either refId or refundId should be passed

Example: 123455081112128XXXXXX68470101509706

Response Attributes

Content Type : JSON

Head

AttributeDescription
cliendId
string

AI router use the merchant key on the basis of clientId parameter value. It requires only if the merchant has more than one key.

responseTimeStamps
string

EPOCH timestamp of the time at which request is being sent.

version
string

Version of the API.
 

Example: v1

signature
string

AI router validates the request and ensures that parameters are not tempered by verifying the signature in the request.

Body

AttributeDescription
resultInfo
Object

This parameter gives the information about the result of the API response

resultInfo
+
AttributeDescription
resultStatus
string

This parameter is the result specific to the phase of the transaction mentioned in the txnType field

resultCode
string

This is the resultCode corresponding to a particular message and is returned to the merchant. It's maximum length is 64.

resultMsg
string

This parameter is the result message which contains information about the result.

mid
string

This is a unique identifier provided to every merchant by AI router.

orderId
string

It is a unique reference ID for a transaction passed in the transaction request. Order ID should be passed to raise the refund
 

Example: OREDRID_98765

txnId
string

transID is AI router payment Transaction Id against which the refund transaction is being placed.
transID is provided in response payload for every payment transaction.
 

Example: 202005081112128XXXXXX68470101509706

txnPaidTime
string

Timestamp of customer to merchant payment transaction.
 

Example: 2020-05-02 12:24:25.0

txnAmount
string

Order value of the transaction in INR.
 

Example: 100.00

totalrefundAmount
string

Amount for which refund was initiated by the merchant. It can be equal to or less than the transaction amount.
 

Example: 3.00

payMethod
string

Payment method used for the transaction

maskedVpa
string

VPA of the customer in masked format

userMobile
string

User's masked mobile number

issuingBankName
string

Name of issuing bank where refund is being credited

cardScheme
string

For credit/debit card refunds, this contains the card scheme where refund is being credited to

maskedCardNumber
string

For credit/debit card refunds, this contains the masked number of the card where the refund is being credited to.

refundInfos
string

Details of refund like masked refund destination, refund amount allocation, RRN Number etc

refundInfos
+
AttributeDescription
refundAmount
string

Amount for which refund was initiated by the merchant. It can be equal to or less than the transaction amount.

refId
string

Merchant's Reference Id unique for every refund transaction. This is REFID for which refund status is being inquired

refundId
string

This is a unique Super router Refund Id that is issued by Super router for each refund request.

refundRaisedStatus
Enum

Contains status if refund was raised successfully or not

refundRaisedTime
string

Timestamp when refund was raised

refundAcceptStatus
string

Status of Paytm accepting the refund

refundAcceptTime
string

Status of Paytm accepting the refund

rrn
string

Reference number with which customers can inquire status with their respective issuing bank. This is generated by acquiring and passed to the issuing bank. This is not available for all the paymodes.

refundType
Enum

Type of refund. TO_SOURCE: Refund is being credited to the same destination through which the payment took place.

userCreditExpectedDate
string

Latest timestamp for customers to realize the refund

refundStatus
Enum

Contains status of refund 
 

Example: SUCCESS

refundCode
string

This is the refundCode corresponding to a particular message and is returned to the merchant. Its maximum length is 64. (Not being used for now)

refundMsg
string

Source of raising the refund

refundSource
string

Source of raising the refund

gatewayResponse
string

Response provided by the gateway during payment or transaction. This is available for Super Router product only.

gatewayResultInfo
object

Gives the information about gateway level result codes and messages

gatewayResultInfo
+
AttributeDescription
resultCode
string

Result code from payment gateways / aggregators

resultMsg
string

Result message from payment gateways / aggregators

Response Codes & Messages

resultCoderesultStatusresultMsg
10TXN_SUCCESSRefund successful
501PENDINGSystem error
601PENDINGRefund request was raised for this transaction. But it is pending state
330TXN_FAILUREChecksum provided is invalid
335TXN_FAILUREMid is invalid
600TXN_FAILUREInvalid refund request
620TXN_FAILUREBALANCE_NOT_ENOUGH
631TXN_FAILURERecord not found
627TXN_FAILUREOrder Details Mismatch
602TXN_FAILUREBank has declined refund request.
227TXN_FAILUREInvalid refund request or restricted by bank.
400PENDINGRefund request was raised for this transaction. But it is pending state
247TXN_FAILUREYour refund cannot be completed. Transaction record not found at bank's end.
698TXN_FAILUREPlease retry the refund.
624TXN_FAILUREParameter illegal
625TXN_FAILUREParameter missing
Staging
Production
https://stage-router.paytm.in/aoa-refund-service/refund/querycopy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
curl --location -g 'https://stage-router.paytm.in/aoa-refund-service/refund/query' \
--header 'Content-Type: application/json' \
--data '{"head": {"clientId": "12345","requestTimeStamp": "2022123456","version": "1.0","signature": "SIGNATURE"},"body": {"mid": "YOUR_MID_HERE","orderId": "P27074440735091120","refId": "refP27074440735091120","refundId": "230508787211359232"}}'

 

copy icon