search

POSTRelease API

Use Case

Release API is used for void a transaction and return money back to payer. The difference between void and refund is, a paid transaction is applicable for void before it is captured or confirmed by merchant or confirmed by payer, and it is applicable for refund after it is captured or confirmed.

We have PENDING status for release transactions other than SUCCESS and FAILED which is returned when the system is not sure whether money has been debited from the customer wallet/UPI/cards or not. It happens when there are some system errors between systems.


We have internal reconciliation between systems after which this PENDING transaction moves to either SUCCESS or FAILED state.

 

To verify the final Status of transaction Merchant can call Transaction Status API .Merchant has to send txn type in the request of Transaction Status API to know the current status of txn.

Request Attributes

Content Type : JSON

Head

AttributeDescription
version
string
optional

Application version(provided by Paytm)
Example : 1.0.0

channelId
string
optional

The parameter value identifies the Channel for which API call is initiated.

Example: APP, WEB, WAP, SYSTEM

requestTimestamp
string
optional

Unix Timestamp of request

clientId
string
mandatory

Paytm uses the merchant key on the basis of clientId parameter value. It is required only if the merchant has more than one key.

signature
string
mandatory

Checksum string created by using paytm checksum logic/library

Body

AttributeDescription
mid
string
mandatory

This is a unique identifier provided to every merchant by Paytm. MID is part of your account credentials and is different in staging and production environment. Your staging MID is available here & production MID will be available once your activation is complete.

preAuthId
string
mandatory

The Unique ID generated for the blocked amount by Paytm.

paytmSsoToken
string
optional

This is a unique token linked with the user's Paytm wallet and is provided in the response while linking the user's Paytm wallet.

Response Attributes

Content Type : JSON

Head

AttributeDescription
responseTimestamp
string

Timestamp at which response was sent

version
string

Application version(provided by paytm)
Example : 1.0.0

clientId
string

Paytm uses the merchant key on the basis of clientId parameter value. It is required only if the merchant has more than one key.

signature
string

Checksum string created by using paytm checksum logic/library

Body

AttributeDescription
preAuthId
string

The Unique ID generated for the blocked amount by Paytm

status
string(20)

The Unique ID generated for the blocked amount by Paytm

statusMessage
string(30)

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

Response Codes & Messages

statusDescstatusstatusMsg
Release (Success)TXN_SUCCESSTxn Successful
Release(Pending response)PENDINGCould not complete request. Please retry again.
Release Failed(Different MID)TXN_FAILUREEither merchant Id or preAuth Id does not match for request
Release Failed(Different PreauthID)TXN_FAILUREEither merchant Id or preAuth Id does not match for request
Release(Amount already unblocked)TXN_FAILUREAmount is already unblocked
Release FailureTXN_FAILUREBalance Account not found
Release FailureTXN_FAILUREWe could not get the requested details.
Release FailureTXN_FAILURERequest not unique
Release FailureTXN_FAILUREMerchant does not exist
Release FailureTXN_FAILURETransaction with the same order Id already exists
Release FailureTXN_FAILUREUNAUTHORIZED_ACCESS
Release FailureTXN_FAILUREThis user is blocked at Paytm end


Release Error Codes and Messages


ErrorCode ErrorMessage
305 Merchant Id not registered
330 Paytm checksum mismatch
501 System Error
809 Invalid preAuth Id
⇾
Staging
Production
https://securegw-stage.paytm.in/order/v2/releasecopy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
DOTNET
curl -X POST 'https://securegw-stage.paytm.in/order/v2/release' \
--header 'Content-Type: application/json' \
--data '{"head":{"requestTimestamp":"1539601338741","clientId":"c11","version":"v2","channelId":"WEB","signature":"KVQ5YrYS/pcQtZ0gghKLWc="},"body":{"preAuthId":"202005031112128001**********","mid":"{mid}"}}'

 

copy icon