POSTPayment Request API

Use Case

Allows merchants to send customer payment request from the Billing POS to Paytm POS machine.

Request Attributes

Content Type : JSON

Head

Attribute	Description
clientId string mandatory	Unique key for each merchant Example: abcd
reqHash string mandatory	A security hash generated by you, using specific fields in a specific order. While generating a hash, the order (sequence) of fields in the request is important. Therefore, the merchant needs to generate the hash in the order of fields as mentioned in the request body. Example: YFymAA3KvswYjLEkRRoqGofJqyMxiqHmPc9noS4fvMc

Body

Attribute

Description

txnDate

string

optional

Date and time of the transaction (Must not have future date/time entry)
Format - yyyy-MM-dd HH:mm:ss

Example: 2023-06-19 15:10:07

merchantTxnId

string

mandatory

Merchant transaction ID

Example: 1234

txnAmount

string

mandatory

Payment amount to be collected. This should be without decimals as the last 2 digits will be considered after decimals. Eg.: 50000 will be considered as Rs 500.00

Example: 2000

merchantReferenceNo

string

optional

Merchant Reference number (if applicable)

Example: 354565

mid

string (20)

optional

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

Paytm Merchant ID (MID)

Example: ABCD123

storeId

string

optional

Merchant Store ID (if applicable)

Example: 1231

additionalInfo

object

optional

Additional information

Additional informations that can be passed in the payment request.

AdditionalInfo

Attribute	Description
paymentMode string optional	The payment mode used by customer for transaction. Payment Mode for the transaction Choose from : CARD / QR / CARDLESS / ALL "ALL"
brandId string optional	Brand Id of the product to be sold "1234"
ean string optional	ean of the product to be sold. "1234"
featureType string optional	Choose Comma separated values to choose the EMI types to be shown on the device. Explanation :- 0 - Default UI 1 - Pay In Full 2 - Brand No Cost EMI 3 - Brand Low Cost EMI 4 - Bank EMI "1,2,3,4"
imei string optional	IMEI number of the product to be sold. "1234"
invoiceNumber string optional	Invoice Number to be used for EMI transaction "ABCD1234"
phoneNumber string optional	Phone Number of the customer "9999999999"
emiTenures string optional	Comma separated values for the EMI tenures. Only EMI of these tenures will be shown on the device if passed. "0,3,6,9"
assuredBuybackProgramProduct string optional	If assured buyback is applicable for this product "true"

gstInformation

object

optional

GST Information for the transaction.

gstInformation

Attribute	Description
gstIn string mandatory	merchant's GSTIN number Example: 08TESTF0078P1ZP
gstBrkUp string mandatory	It will contain the Common GST Amount values break-up of GST Split(pipe “\|” separated) amount. name & value Payer PSP to read this amount and restrict the display to customer Break up of GST amount. Example: CGST:10\|SGST:10\| IGST:10\| CESS:10\| GSTIncentive:10\| GSTPCT:10
invoiceNo string(20) mandatory	Merchant’s invoice number Example: Invoice34234321
invoiceDate GMT Format mandatory	Bill invoice date Example: 2019-06-11T13:21:50+05:30

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 Possible values: SUCCESS, FAILURE
resultCode string	Response status code Possible values: S, F
resultMsg string	Response message Possible values: Success, Failure, Not able to generate Payment Request ID (CPay), Request parameters are not valid, JWT authentication fails, Merchant not configured
resultCodeId string	Result code id Example: EDC_0000, EDC_0016, EDC_0007, EDC_0017, EDC_0021
cpayId string	Payment Request ID (CPay) is a random number generated by the Paytm system Example: 100005

Response Codes & Messages

resultCode	resultStatus	resultMsg
EDC_0000	SUCCESS	Success
EDC_0016	FAIL	Not able to generate cpayId
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/payment/request copy icon

REQUEST

RESPONSE

CURL

curl --location 'https://securegw-stage.paytm.in/edc-integration-service/payment/request' \
--header 'Content-Type: application/json' \
--data '{"head": {"clientId": "abc","reqHash": "YFymAA3KvswYjLEkRRoqGofJqyMxiqHmPc9noS4fvMc"},"body": {"txnDate": "2023-06-1915:10:07","merchantTxnId": "1234","txnAmount": "2000","txnNumber": "354565","mid": "YOUR_MID_HERE"}}'