POSTRefund API
Use Case
- To initiate partial or complete refund of transaction
- This is an async process. In the sync response we only notify registration of refund with PG. This does not mean refund has been accepted by PG or processed to customer’s bank account
Request Attributes
Head
Attribute | Description |
---|---|
clientId string(3) optional | Paytm use the merchant key on the basis of clientId parameter value. It requires only if the merchant has more than one key. Example: C11 |
version string(4) optional | Version of the API. Example: v1 |
requestTimestamp string(15) optional | EPOCH timestamp of the time at which request is being sent. |
channelId string(3) optional | The parameter value identifies the Channel for which API call is initiated. Possible values:
WEB
,
For websites, the value to be passed should be "WEB"
WAP
For Mobile websites/App, the value to be passed should be "WAP"
|
signature string(108) mandatory | 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. |
Body
Attribute | Description | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
mid string(20) mandatory | Paytm provides MID as a unique identifier to each merchant. For your staging MID, click here. You get the production MID post the account activation. Example: INTEGR7769XXXXXX9383 | ||||||||||
orderId string(50) mandatory | It is 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(50) mandatory | Unique Reference Id for refund transaction which is generated by merchant. Duplicate REFID will be rejected by the Paytm gateway. | ||||||||||
txnId string(64) mandatory | TXNID is Paytm payment Transaction Id against which the refund transaction is being placed. TXNID is provided in response payload for every payment transaction. Example: 202005081112128XXXXXX68470101509706 | ||||||||||
refundAmount string mandatory | Amount for which refund is to be made. It can be equal to or less than the transaction amount and should be upto two decimal places. Only special character allowed is (".") Example: 1.00 | ||||||||||
txnType string mandatory | Request type Possible Values: REFUND | ||||||||||
comments string(500) optional | Comments can be given by merchant citing the reason for refund. | ||||||||||
preferredDestination string optional | Merchant wants to take instant refund solution from Paytm Possible Values: TO_INSTANT | ||||||||||
disableMerchantDebitRetry boolean optional | If its true, we will not retry in case MPA balance is not sufficient then fail the refund Default- false | ||||||||||
agentInfo object optional | Refund initiator details. These will be available in refund success response and refund report generated from merchant panel | ||||||||||
AgentInfo +
|
Response Attributes
Head
Attribute | Description |
---|---|
clientId string(3) | Paytm use the merchant key on the basis of clientId parameter value. It requires only if the merchant has more than one key. Example: C11 |
version string(2) | Version of the API passed in the request. Example: v1 |
responseTimestamp string(15) | EPOCH timestamp of the time at which response is being sent. |
channelId string(3) | The parameter value identifies the Channel for which API call is initiated. Possible values:
WEB
,
For websites, the value to be passed should be "WEB"
WAP
For Mobile websites/App, the value to be passed should be "WAP"
|
signature string(108) | You should validate the parameter values by verifying the signature comes in the response. It ensures that parameter values not tempered. Signature string can be verified by using Paytm checksum library |
Body
Attribute | Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
resultInfo object | This parameter gives the information about the result of the API response | ||||||||
ResultInfo +
| |||||||||
mid string(20) | Paytm provides MID as a unique identifier to each merchant. For your staging MID, click here. You get the production MID post the account activation. Example: INTEGR7769XXXXXX9383 | ||||||||
orderId string(50) | Order ID is merchant’s unique reference ID for a transaction that has sent in request. Example: OREDRID_98765 | ||||||||
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 | ||||||||
refundAmount string | Amount for which refund is to be made. It can be equal to or less than the transaction amount and should be upto two decimal places. Only special character allowed is (".") Example: 1.00 | ||||||||
refundId string(64) | This is a unique Paytm Refund Id that is issued by Paytm for each refund request. Example: 123455081112128XXXXXX68470101509706 | ||||||||
txnId string(64) | TXNID is Paytm payment Transaction Id against which the refund transaction is being placed. Example: 202005081112128XXXXXX68470101509706 | ||||||||
txnTimestamp string(20) | Timestamp of payment transaction. Example: 2020-05-02 12:24:25.0 |
Response Codes & Messages
resultCode | resultStatus | resultMsg |
---|---|---|
501 | PENDING | System Error |
601 | PENDING | Refund request was raised for this transaction. But it is pending state. |
330 | TXN_FAILURE | Checksum provided is invalid |
335 | TXN_FAILURE | Mid is invalid |
600 | TXN_FAILURE | Invalid refund request. |
607 | TXN_FAILURE | Refund can not be initiated for a cancelled transaction. |
617 | TXN_FAILURE | Refund Already Raised (If merchant repeated their request within the 10 minutes after initiate the first refund request) |
619 | TXN_FAILURE | Invalid refund amount |
626 | TXN_FAILURE | Another Refund on same order is already in Progress, please retry after few minutes |
627 | TXN_FAILURE | Order Details Mismatch |
628 | TXN_FAILURE | Refund request was raised to respective bank. But it is in pending state from bank side. |
629 | TXN_FAILURE | Refund is already Successful |
635 | TXN_FAILURE | Partial Refund under Rupee 1 is not allowed |
curl -X POST 'https://securegw-stage.paytm.in/refund/apply' \
--header 'Content-Type: application/json' \
--data '{"body":{"mid":"{mid}","txnType":"REFUND","orderId":"ORDERID_98765","txnId":"202005081112128XXXXXX68470101509706","refId":"REFUNDID_98765","refundAmount":"1.00"},"head":{"signature":"{signature}"}}'