POSTStatus Enquiry API

Use Case

The API is used to get the status of the transaction (sale and void transactions)

Request Attributes

Content Type : JSON

Head

Attribute	Description
requestTimeStamp string (25) mandatory	Request Time (yyyy-MM-dd HH:mm:ss). Time when request sent to paytm system. Example: 2019-10-07 13:15:18
channelId string (32) optional	Paytm will provide the channel Id to the merchant. Example: ABC
checksum string (108) mandatory	Check sum of whole body. For creating the checksum (signature) refer to the steps given in Checksum Logic. Note: Create the checksum using the body parameter of the request. Example: FFFFFFFFFF2345000004
version string (16) optional	client version Example: 1.0

Body

Attribute	Description
paytmMid string (64) mandatory	Paytm generated merchant Id Example: FINALE32321107827478
paytmTid string (16) mandatory	paytm generated terminal Id Example: 12345678
transactionDateTime string (25) mandatory	Transaction Time(yyyy-MM-dd HH:mm:ss). Time when transaction initiated at client system. Example: 2019-10-07 13:15:18
merchantTransactionId string (8-32) mandatory	merchant system generated Transaction Id(TxnId). It should be unique per merchant. Example: 2091293484338398383
event string conditional	event=VOID should be sent, if merchant want to fetch void transactions status Example: vent = VOID

Response Attributes

Content Type : JSON

Head

Attribute	Description
requestTimeStamp string (25)	Request Time (yyyy-MM-dd HH:mm:ss). Time when request sent to paytm system. Example: 2019-10-07 13:15:18
channelId string (32)	Paytm will provide the channel Id to the merchant. Example: ABC
version string (16)	client version Example: 1.0

Body

Attribute

Description

paytmMid

string (32)

Paytm generated merchant Id

Example: FINALE32321107827478

paytmTid

string (16)

Paytm generated terminal Id

transactionDateTime

string (25)

Transaction Time(yyyy-MM-dd HH:mm:ss). Time when transaction initiated at client system.

Example: 2019-10-07 13:15:18

merchantTransactionId

string (8-32)

Merchant system generated Transaction Id(TxnId). It should be unique per merchant.

merchantRefereneceNo

string (32)

Merchant's system generated Reference number associated with order ID. This is the same number which was sent to Paytm in Payment request.

Example: 2091293484338398383

transactionAmount

string (12)

transaction amount in paise.

Example: 1000

acquirementId

string (64)

Paytm system generated transaction Id

Example: 12346463534353535378270

retrievalReferenceNo

string (32)

RRN number generated by bank

Example: 123432452222

authCode

string (32)

Auth code generated by bank

Example: 1223433

issuerMaskCardNo

string (32)

Card number used by issuer

Example: 765453XXXXXXX2232

issuingBankName

string (32)

Bank name for card holder

Example: axis

bankResponseCode

string (10)

Bank return response code

Example: 52

bankResponseMessage

string (64)

Bank return response message

Example: INCORRECT_PIN

bankMid

string (32)

Bank merchant Id

Example: 5PT000404050503333

bankTid

string (16)

Bank Terminal Id

Example: 5P393003

aid

string

Aid

Example: A0000000031010

payMethod

string

Method used for payment

Example: EMI, CREDIT_CARD, DEBIT_CARD, BALANCE, UPI, PAYTM_DIGITAL_CREDIT

cardType

string

Type of card used for payment

Example: CREDIT_CARD

cardScheme

string

Scheme of card used for payment

Example: VISA

resultInfo

object (999)

Paytm system response result

Example: "resultInfo": { "resultStatus":"01", "resultCodeId":"00", "resultCode":"SUCCESS", "resultMsg":"SUCCESSFUL"}

resultinfo

Attribute	Description
resultStatus string (1)	A- Accepted S- Success F- Failed U- Pending
resultCodeId string (4)	Numeric Status code
resultCode string	Alphabetical status code
resultMsg string	Status message

merchantExtendedInfo

string (999)

Merchant extend info fields sent in payment request will be sent back here.

Example: auto-accept" : "True", "paymentMode" : "ALL", "Brand ID" : "579507"

extendInfo

string (999)

Extend info fields sent in Payment request will be sent back here.

Example: "extendInfo": {"key1": "value1", "key2": "value2"}

productDetails

object (999)

Details of the product in case of brand emi, will be an empty object otherwise

Example: { "manufacturer": "Bosch", "category":"Washing Machine", "productSerialNoType": "Serial No./ IMEI", "productSerialNoValue": "1234567892", "productCode": "51051000100000000046", "modelName": "Test Product Bosch 2" }

emiDetails

object (999)

Emi Details of the product in case of brand emi and bank emi, will be an empty object otherwise

Example: { "txnType": "brandEmi", "baseAmount": "500", "tenure": "3", "emiInterestRate": "12.99", "emiMonthlyAmount": "170", "emiTotalAmount": "500"}

cashbackDetails

object (999)

Cashback Details of the product, will be an empty object in case in not present.

Example: {"bankOfferApplied": "true", "bankOfferType": "cashback", "bankOfferAmount": "100", "subventionCreated":"true", "subventionType": "SUBVENTION", "subventionOfferAmount": "0"}

acquiringBank

string

Acquiring Bank Name for a Payment transaction

Example: Paytm Payments Bank

Response Codes & Messages

resultCode	resultStatus	resultMsg
0010	PENDING	Please check status on machine
0012	FAIL	Internal Server Error. Please retry
0030	PENDING	Please check the status on edc machine
0330	FAIL	Invalid checksum
0404	FAIL	Merchant transaction id does not exits..!
0011	FAIL	The sale txn has failed
0000	SUCCESS	Success
0009	ACCEPTED_SUCCESS	ACCEPTED_SUCCESS
0000	SUCCESS	SUCCESS
0090	FAILED	ECR void failed
0180	FAILED	VOID transaction not found
0030	PENDING	Please check the status on edc machine

⇾

Staging

Production

https://securegw-stage.paytm.in/ecr/V2/payment/status copy icon

REQUEST

RESPONSE

CURL

curl --location 'https://securegw-stage.paytm.in/ecr/V2/payment/status' \
--header 'Content-Type: application/json' \
--data '{"head": {"requestTimeStamp": "2019-10-07 13:15:18","channelId": "RIL","checksum": "FFFFFFFFFF2345000004","version": "3.1"},"body": {"paytmMid": "YOUR_MID_HERE","paytmTid": "102XX943","transactionDateTime": "2019-10-07 13:15:18","merchantTransactionId": "2019101710290XXXXXX112346490"}}'