POSTTransaction Status API
Use Case
This API gets the transaction status corresponding to requested OrderId for specific merchant.
Request Attributes
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. |
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. |
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 “@” “-” “_” “.”. |
txnType string optional | Transaction type of the payment Possible Values: PREAUTH, RELEASE, CAPTURE, WITHDRAW |
Response Attributes
Head
Attribute | Description |
---|---|
version string | Version of the API passed in the request. |
responseTimestamp string | EPOCH timestamp of the time at which response is being sent. |
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. |
Body
Attribute | Description | ||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
resultInfo object | This parameter gives the information about the result of the API response | ||||||||||||||||||||||||||||||||||||||||
ResultInfo +
| |||||||||||||||||||||||||||||||||||||||||
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
CC
,
For Credit Card
DC
,
For Debit Card
NB
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. | ||||||||||||||||||||||||||||||||||||||||
paymentPromoCheckoutData string | Only for SimplifiedPaymentOffers (Bank Offers). | ||||||||||||||||||||||||||||||||||||||||
vanInfo object | VAN account details. This is only provided for bank account transfer paymode. | ||||||||||||||||||||||||||||||||||||||||
vanInfo +
| |||||||||||||||||||||||||||||||||||||||||
sourceAccountDetails object | Remitter/Source account detail information from where the money has been received. This is only provided for bank account transfer. | ||||||||||||||||||||||||||||||||||||||||
sourceAccountDetails +
| |||||||||||||||||||||||||||||||||||||||||
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. | ||||||||||||||||||||||||||||||||||||||||
rrnCode string | Reference number which is also generated by the bank Example: 777001344756752 | ||||||||||||||||||||||||||||||||||||||||
authCode string | Authentication code which comes from the bank Example: 123456 | ||||||||||||||||||||||||||||||||||||||||
merchantUniqueReference string | Merchant's reference text which is sent in the order's request | ||||||||||||||||||||||||||||||||||||||||
cardScheme string | Card Scheme Example: VISA, MASTER | ||||||||||||||||||||||||||||||||||||||||
bin string | First six digit of the card Example: 438106 | ||||||||||||||||||||||||||||||||||||||||
lastFourDigit string | Last four digit of the card Example: 0208 | ||||||||||||||||||||||||||||||||||||||||
dccPaymentDetail object | Details of the payment done through dcc Note: For currency conversion flow only | ||||||||||||||||||||||||||||||||||||||||
DccPaymentDetails +
| |||||||||||||||||||||||||||||||||||||||||
internationalCardPayment boolean | Indicates if the transaction was completed using an international card (issued by a non-indian bank) Note: For currency conversion flow only Possible Values: true | ||||||||||||||||||||||||||||||||||||||||
baseCurrency string | Base currency used for currency conversion and is always INR. Note: For currency conversion flow only Example: INR | ||||||||||||||||||||||||||||||||||||||||
feeRateFactors object | The fee factor DCC indicates that DCC fee/commission is applicable for the given international card transaction. Note: For currency conversion flow only | ||||||||||||||||||||||||||||||||||||||||
FeeRateFactors +
|
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 |
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}"}}'