POSTTransaction Status API

Use Case

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

Request Attributes

Content Type : JSON

Head

Attribute	Description
version string optional	Version of the API. Example: v1
channelId string 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"
requestTimestamp string optional	EPOCH timestamp of the time at which request is being sent. Example: 1588402269
clientId string 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
signature string 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. Note: Create the signature using the body parameter of the request.

Body

Attribute	Description
mid string 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 mandatory	The Unique reference ID of the Order. It is alphanumeric and special characters allowed are “@” “-” “_” “.”. Example: OREDRID_98765
txnType string optional	Transaction type of the payment Possible Values: PREAUTH, RELEASE, CAPTURE, WITHDRAW

Response Attributes

Content Type : JSON

Head

Attribute	Description
version string	Version of the API passed in the request. Example: v1
responseTimestamp string	EPOCH timestamp of the time at which response is being sent. Example: 1588402269
channelId string	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"
clientId string	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
signature string	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. Note: Create the signature using the body parameter of the request.

Body

Attribute

Description

resultInfo

object

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

ResultInfo

Attribute	Description
resultCode string	This is the resultCode corresponding to a particular message and is returned to the merchant. It's maximum length is 64. The different result codes corresponding to this API are mentioned below.
resultStatus string	This parameter indicates the status of API call. Possible Values: TXN_SUCCESS, TXN_FAILURE, PENDING
resultMsg string	This parameter is the result message which contains information about the result.The different result messages corresponding to this API are mentioned below.

txnId

string

Transaction Id of the payment

Example: 202005081112128XXXXXX68470101509706

bankTxnId

string

Bank transaction Id from the bank

Example: 77700XXXX215242

orderId

string

Unique reference ID for an Order request generated by merchant for payment.

Example: OREDRID_98765

txnAmount

string

Payment transaction amount

Possible Values: 1.00

txnType

string

Transaction type of the payment

gatewayName

string

Gateway name used in payment

Example: HDFC

bankName

string

Bank Name used in payment

Example: Paytm Payments Bank

Example: ICICI Bank

mid

string

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

paymentMode

string

Payment Mode used in payment

Possible values:

PPI

For Paytm Wallet

UPI

For Bhim Upi

For Credit Card

For Debit Card

For Net Banking

refundAmount

string

refund amount of the payment

Example: 1.00

txnDate

string

Transaction Date

Example: 2020-05-05 14:00:28

subsId

string

Subscription ID - Only Subscription flow

payableAmount

string

Original order value before offer was applied.
Only for SimplifiedPaymentOffers (Bank Offers).

paymentPromoCheckoutData

string

Only for SimplifiedPaymentOffers (Bank Offers).
promocode: Actual promocode which got applied
promotext: Promo message
savings: Benefit amount
redemptionType: discount/cashback

vanInfo

object

VAN account details. This is only provided for bank account transfer paymode.

vanInfo

Attribute

Description

van

string

Virtual Account Number. This is the 16 alphanumeric account number to which customer has initiated the transfer.

Example: PY2222K735789128.

beneficiaryName

string

Beneficiary name of the VAN

ifscCode

string

Ifsc code of van account

Example: PYTM0123456

bankName

string

Bank in which VAN is created

purpose

string

Purpose of the txn

Example: Dont

userDefinedFields

object

Object containing five types of udf passed at the time of VAN creation. This is only provided for bank account transfer.

userDefinedFields

Attribute	Description
udf1 string	User define parameter 1
udf2 string	User define parameter 2
udf3 string	User define parameter 3
udf4 string	User define parameter 4
udf5 string	User define parameter 5

customerDetails

object

Contains details of customer like name/email/mobile passed at the time of VAN creation. This is only provided for bank account transfer.

customerDetails

Attribute	Description
name string	Name of the person who initiated refund Example: Test
email string	Valid email of the user. Example: vaibhav41094@gmail.com
phone string	Phone number of end user

sourceAccountDetails

object

Remitter/Source account detail information from where the money has been received. This is only provided for bank account transfer.

sourceAccountDetails

Attribute	Description
maskedAccountNumber string	Account number of customer Example: 915555**0164
accountHolderName string	Account holder name Example: Srivastava Kumar Prateek1597233845332
ifscCode string	Ifsc code of bank Example: BACB0000003

transferMode

string

Mode by which remitter has made the transfer. Possible values are IMPS, NEFT, RTGS, and XFER. This is only provided for bank account transfer.

utr

string

Unique transaction reference number from bank. This is only provided for bank account transfer.

Example: 5R01IY000V27.

bankTransactionDate

string

Timestamp at which partner bank received the payment. This is only provided for bank account transfer.

Example: 2020-09-25 11:35:07.0.

Response Codes & Messages

resultCode	resultStatus	resultMsg
01	TXN_SUCCESS	Txn Success
227	TXN_FAILURE	Your payment has been declined by your bank. Please contact your bank for any queries. If money has been deducted from your account, your bank will inform us within 48 hrs and we will refund the same.
235	TXN_FAILURE	Wallet balance Insufficient, bankName=WALLET
295	TXN_FAILURE	Your payment failed as the UPI ID entered is incorrect. Please try again by entering a valid VPA or use a different method to complete the payment.
334	TXN_FAILURE	Invalid Order ID
335	TXN_FAILURE	Mid is invalid
400	PENDING	Transaction status not confirmed yet.
401	TXN_FAILURE	Your payment has been declined by your bank. Please contact your bank for any queries. If money has been deducted from your account, your bank will inform us within 48 hrs and we will refund the same.
402	PENDING	Looks like the payment is not complete. Please wait while we confirm the status with your bank.
501	TXN_FAILURE	Server Down
810	TXN_FAILURE	Txn Failed

⇾

Staging

Production

https://securegw-stage.paytm.in/v3/order/status copy icon

REQUEST

RESPONSE

CURL

JAVA

NODE

PHP

PYTHON

DOTNET

curl -X POST 'https://securegw-stage.paytm.in/v3/order/status' \
--header 'Content-Type: application/json' \
--data '{"body":{"mid":"{mid}","orderId":"{order-id}"},"head":{"signature":"{signature}"}}'