POSTPayment Request Status API

Use Case

Allows merchants to check the status of previously posted payment request (Payment Request ID) in the Paytm EDC Queue.You can do this wirelessly from your Billing POS system.

Request Attributes

Content Type : JSON

Head

Attribute	Description
clientId string mandatory	Unique key for each merchant Example: ABCD
reqHash string mandatory	reqHash will be (cpayId + mid + txnDate) Example: {reqHash}

Response Attributes

Content Type : JSON

Head

Attribute	Description
responseTimestamp string	Date Time value when the response is being returned. Format - yyyy-MM-dd HH:mm:ss Example: 2023-06-19 15:10:07

Body

Attribute

Description

resultStatus

string

Response status

Example: SUCCESS, FAIL

resultCodeId

string

Result code ids representing various messages

Example: EDC_0000, EDC_0016, EDC_0007, EDC_0017, EDC_0021

resultCode

string

Response status code

Example: S, F

resultMsg

string

Response message

Example: Success, Not able to generate Payment Request ID (CPay), Request parameters are not valid, JWT authentication fails, Merchant not configured

txnStatus

string

Can return status for multiple orders

Example: IN_QUEUE, PENDING, FAILED, COMPLETED, EXPIRED, CANCELLED

Orders

string

Order Details

Orders

Attribute

Description

orderId

string

Merchant transaction ID

Example: 54321396Alpha71

status

string

Transaction Status for each order id

aid

string

AID (For Cards)

Example: A0000000031010

payMethod

string

Payment method

Example: EMI

cardType

string

Card Type

Example: CREDIT_CARD

cardScheme

string

Card Scheme Type

Example: RUPAY

productManufacturer

string

Product Manufacturer

Example: Apple

productCategory

string

Product Category

Example: Smart Phones

productSerialNoType

string

Product Serial Number Type

Example: Serial No./ IMEI

productSerialNoValue

string

Product Serial Number Value

Example: 27364747382

productName

string

Product Name

Example: Test Product Apple_73

emiTxnType

string

EMI Transaction Type

Example: brandEmi

emiTenure

string

EMI Tenure

Example: 3

emiInterestRate

string

EMI Interest Rate

Example: 4.0

emiMonthlyAmount

string

EMI Monthly Amount (In Paisa)

Example: 159765

emiTotalAmount

string

EMI Total Amount (In Paisa)

Example: 504345

bankOfferApplied

string

Offer Applied or not

Example: true

bankOfferType

string

Bank Offer Type

Example: null

bankOfferAmount

string

Bank Offer Amount (In Paisa)

Example: null

subventionCreated

string

Subvention created or not

Example: true

subventionType

string

Subvention type

Example: SUBVENTION

subventionOfferAmount

string

Subvention Offer Amount (In Paisa)

Example: 25050

merchantId

string

Paytm MID

Example: FUNCEM51406669278318

tid

string

Paytm TID

Example: 97006101

txnDate

string

Transaction Date and Time

Example: 2023-09-22 11:46:02

merchantTransactionId

string

Merchant Transaction ID

Example: 54321396Alpha71

merchantReferenceNo

string

Merchant Reference Number

Example: 54321396Alpha71

amount

string

Transaction Amount (In Paisa)

Example: 501000

txnID

string

Acquirement ID

Example: 20230922010850000911971559508559995

rrn

string

RRN number (for cards)

Example: 204018810351

authCode

string

Auth Code

Example: 204018810351

cardNo

string

Card Number

Example: ************0001

issuingBank

string

Issuing Bank Name

Example: ICICI Bank

bankResponseCode

string

Bank Response Code

Example: 00

bankResponseMessage

object

Bank Response Message

bankResponseMessage

Attribute	Description
resultStatus string	Bank Response Result Status Example: 01
resultCode string	Bank Response Result Code Example: SUCCESS
resultCodeId string	Bank Response Result Code ID Example: 00
resultMsg string	Bank Response Result Message Example: SUCCESSFUL/APPROVED

bankMid

string

Bank MID

Example: 5PT000000001296

bankTid

string

Bank TID

Example: 6P135903

acquiringBank

string

Acquiring Bank Name

Example: Paytm Payments Bank

merchantExtendedInfo

string

Merchant Extended Info

Example: null

extendedInfo

string

Sale API Extended Info

Example: null

totalAmount

string

Total Amount (In Paisa)

Example: 501000

originalAmount

string

Original Amount (In Paisa)

Example: 501000

resultInfo

object

PG Result Information

resultinfo

Attribute	Description
resultStatus string	PG Result Status Example: SUCCESS
resultCode string	PG Result Code Example: S
resultMsg string	PG Result Message Example: Success
resultCodeId string	PG Result Code ID Example: EDC_0000

virtualPaymentAddress

string

VPA for UPI

Example: upi********t@okhdfcbank

Response Codes & Messages

resultCode	resultStatus	resultMsg
EDC_0000	SUCCESS	Success
EDC_0016	FAIL	Not able to update txn status
EDC_0019	FAIL	Merchant not configured
EDC_0007	FAIL	Request parameters are not valid
EDC_0014	FAIL	JWT authentication fails

⇾

Staging

Production

https://securegw-stage.paytm.in/edc-integration-service/txn/status?cpayId={cpayId}&storeId={storeId}&txnDate={txnDate} copy icon

REQUEST

RESPONSE

CURL

curl --location --globoff 'https://securegw-stage.paytm.in/edc-integration-service/txn/status?cpayId={cpayId}&storeId={storeId}&txnDate={txnDate}' \
--header 'Content-Type: application/json' \
--data '{"head": {"clientId": "abcd","reqHash": "YFymAA3KvswYjLEkRRoqGofJqyMxiqHmPc9noS4fvMc"}}