POSTVoid API

Use Case

The API is used to cancel the successful sale transaction on the same day the transaction was done.

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) mandatory	Paytm will provide the channel Id to the merchant.
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 (64) optional	client version Example: 1.0

Body

Attribute	Description
paytmTid string (8) mandatory	Terminal Id Example: 12345678
paytmMid string (min=20) mandatory	Merchant Id Example: FINALE32321107827478
merchantTransactionId string (8 - 32) mandatory	Order Id Example: 2091293484338398383
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

Response Attributes

Content Type : JSON

Head

Attribute	Description
responseTimeStamp string (25)	Response Time (yyyy-MM-dd HH:mm:ss). Time when response sent by paytm system. Example: 2019-10-07 13:15:18
channelId string (32)	Request chanelId Example: ABC
version string (16)	Request version Example: 1.0

Body

Attribute

Description

merchantTransactionId

string (8-32)

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

Example: 2091293484338398383

paytmMid

string (min=20)

Paytm generated merchant Id

Example: FINALE32321107827478

paytmTid

string (8)

Paytm generated terminal Id

Example: 12345678

resultInfo

object (999)

response return

Example: "resultInfo":{"resultStatus":"ACCEPTED_SUCCESS", "resultCodeId":"0009", "resultCode":"A", "resultMsg":"ACCEPTED_SUCCESS"}

resultinfo

Attribute	Description
resultStatus string (1)	A- Accepted F- Failed
resultCodeId string (4)	Numeric Status code
resultCode string (1)	Alphabetical status code
resultMsg string	Status Message

Response Codes & Messages

resultCode	resultStatus	resultMsg
0009	ACCEPTED_SUCCESS	ACCEPTED_SUCCESS
0012	FAIL	Internal Server Error. Please retry
0182	FAIL	Multiple Void request not allowed for same terminal..!
0330	FAIL	Invalid checksum
0002	FAIL	Request Parameters are not valid
0007	FAIL	Terminal is not in active state

⇾

Staging

Production

https://securegw-stage.paytm.in/ecr/void copy icon

REQUEST

RESPONSE

CURL

curl --location 'https://securegw-stage.paytm.in/ecr/void' \
--header 'Content-Type: application/json' \
--data '{"head": {"requestTimeStamp": "2019-10-07 13:15:18","channelId": "ABC","checksum": "FFFFFFFFFF2345000004","version": "3.1"},"body": {"paytmMid": "YOUR_MID_HERE","paytmTid": "12346490","merchantTransactionId": "12345XXXX245","transactionDateTime": "2019-10-07 13:15:18"}}'