• Callback Response
  • Getting Started
    • Mobile Integration (Android/IOS)
      Enterprise Solutions
      Retail Solutions
      Accept Payments
      Process Payments
      Disbursals
      API References
      Refunds
      Guides
      Other links
      Mini Program Platform
  • Features for Investments PG
  • post Release 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 transaction other than SUCCESS and FAILED which is returned when the system is not sure whether money has been debited from customer wallet or not. It happens when there are some system errors between two Paytm 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 API and Merchant has to send txn type in the request of Transaction Status API to know the current status of txn.

    Request Attributes


    API Content Type: JSON

    ATTRIBUTE DESCRIPTION
    MID mandatory This 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 MID is available here & production MID will be available once your activation is complete.
    PREAUTH_ID mandatory The Unique ID generated for the blocked amount by Paytm
    TOKEN mandatory This is a unique token linked with user's Paytm wallet and is provided in the response while linking user's Paytm wallet.
    CHECKSUM mandatory Signature encryption for validation. It's value to be sent should be the checksum string created by using Paytm checksum library.
    Note: Create the signature using all the request parameters.

    Response Attributes


    API Content Type: JSON

    ATTRIBUTE DESCRIPTION
    PREAUTH_ID The Unique ID generated for the blocked amount by Paytm
    STATUSstring(20) This parameter indicates the status of API call.
    STATUSMESSAGEstring(30) This parameter is the result message which contains information about the result.

    Response Codes and Messages


    Release Status and Messages


    SCENARIOSTATUSMESSAGESTATUS
    Release (Success)Txn SuccessfulTXN_SUCCESS
    Release(Pending response)Could not complete request. Please retry again.PENDING
    Release Failed(Different MID)Either merchant Id or preAuth Id does not match for requestTXN_FAILURE
    Release Failed(Different PreauthID)Either merchant Id or preAuth Id does not match for requestTXN_FAILURE
    Release(Amount already unblocked)Amount is already unblockedTXN_FAILURE
    Release FailureBalance Account not foundTXN_FAILURE
    Release FailureWe could not get the requested details. Please try againTXN_FAILURE
    Release FailureRequest not uniqueTXN_FAILURE
    Release FailureMerchant does not existTXN_FAILURE
    Release FailureTransaction with the same order Id already existsTXN_FAILURE
    Release FailureUNAUTHORIZED_ACCESSTXN_FAILURE
    Release FailureThis user is blocked at Paytm endTXN_FAILURE

    Release Error Codes and Messages


    ErrorCodeErrorMessage
    305Merchant Id not registered
    330Paytm checksum mismatch
    501System Error
    PREAUTH_ID NOT PRESENTInvalid preAuth Id
    VAER-PF101VAL_PF_MID IS REQUIRED
    VAER-CS103CHECKSUM IS REQUIRED
    ORDER_ID NOT PRESENTORDER_ID IS REQUIRED
    TXN_AMOUNT IS NOT PRESENTTXN_AMOUNT IS REQUIRED
    NO TOKENTOKEN IS REQUIRED
    StagingProduction
    REQUESTRESPONSE
    curl -X POST 'https://securegw-stage.paytm.in/order/release' \
    --header 'Content-Type: application/json' \
    --data '{"MID":"{mid}","PREAUTH_ID":"2020052711121XXXXXXXX68304901660306","TOKEN":"eyJlbmMiOiJBMjU2R0NNIiwiYWxnIjoiZGlyIn0..xxxxxxxxxxx.9iHTtWbCZ0I6qbn2sUnyz5siw1fqbmtEnFMFE7nSIX-yrwCkiGfAC6QmPr9q-tw8LMPOh5-3UXRbpeVZEupQd3wNyaArWybRX2HAxJDRD8mxJ_wxzJM6GZ1ov4O3EIsx2Y_Zr0aHCd3VbnTjRUnlVdxXJPFG8QZs0b_2TVdoAX3_QjZS8_dwcmIWoH8ebDzOIs7MJacETfMtyFGAo8Xc0LjznToUWvTsTbIXQoF1yB0.1fZFAYJVsY61BTv2htLcXQ8800","CHECKSUM":"{checksum}"}'