Payment Status API

Checksum required: YES

Use Case


This API gets the transaction status corresponding to requested OrderId for specific merchant.


Paramater

API Content format: JSON

TYPENAMEDESCRIPTIONREQUIRED
BodyParameterbody NativePaymentStatusRequestPayment Status Request for native flowYes

SecureRequestHeader & SecureResponseHead

NAMEDESCRIPTIONREQUIREDEXAMPLE
clientId StringClientId by which key checksum is created, required to validate the checksum. Eg C11
version stringApplication version(provided by paytm)Nov1
channelId enum (WEB(for web server), WAP(for mobile device))Channel through which call initiatedYesWEB
requestTimestamp stringUNIX timestamp of the time request is being sentNo1525344042691
signature stringSignature encryption for validationYesa

NativePaymentStatusResponseBody

NAMEDESCRIPTIONREQUIRED
resultInfo ResultInfoResultInfo Object contains result related informationYes
txnId Stringtransaction id of the paymentNo
bankTxnId Stringbank transaction id from the bankNo
orderId Stringorder Id of the paymentYes
txnAmount Stringpayment transaction AmountNo
txnType Stringtransaction Type of the paymentNo
gatewayName Stringgateway Name used in paymentNo
bankName StringBank Name used in paymentNo
mId Stringmerchant idYes
paymentMode StringPayment Mode used in paymentNo
refundAmount Stringrefund Amount of the paymentNo
txnDate Stringtransaction DateNo

NativePaymentStatusRequestBody

NAMEDESCRIPTIONREQUIRED
mId Stringmerchant idYes
orderId Stringorder id of the paymentYes
txnType StringTransaction type of the paymentNo

ResultInfo

NAMEDESCRIPTIONREQUIREDEXAMPLE VALUE
resultStatus enum (S(Success), F(Failure), U(Unknown))Result Status of transactionYesS
resultCode StringResult code returned to merchant . Max length of result code can be 64Yes0000
resultMsg StringResult Message corresponding to transactionYesSUCCESS

Initiate Transaction Response Codes

RESPONSEMESSAGESTATUS
01Transaction SuccessTXN_SUCCESS
334Invalid Order IdTXN_FAILURE
335Mid is invalidTXN_FAILURE
501Server DownTXN_FAILURE
402Payment not complete, confirming status from bankPENDING

Endpoints

Testing: http://securegw-stage.paytm.in/merchant-status/api/v1/getPaymentStatus

Production: http://securegw.paytm.in/merchant-status/api/v1/getPaymentStatus

Request CodeResponse JSON
curl -X POST 'https://securegw-stage.paytm.in/merchant-status/api/v1/getPaymentStatus' -H 'Content-Type: application/json' -d '{
"body": {"mid": "xxxxxxxxxxxxxxxxxxxx","orderId": "xxxxxx",},"head": {
    "clientId": "xxxxxxxx-xxxxxxxxxxxxx-xxxxxxx","version": "v1",
    "requestTimestamp": 1553582262,"signature": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"}}'