POSTResend Payment Request API

Use Case

This API can be used to resend the SMS to customers containing the payment request.

Request Attributes

Content Type : JSON

Head

Attribute	Description
clientId string(3) mandatory	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
version string(4) mandatory	Version of the API. Example: v1
requestTimestamp string(15) optional	EPOCH timestamp of the time at which request is being sent. Example: 1588402269
channelId string(3) mandatory	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"
signature string(108) 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. Note: Create the signature using the body parameter of the request.

Body

Attribute	Description
mid string mandatory	Paytm provides MID as a unique identifier to each merchant. Example: INTEGR7769XXXXXX93833
merchantOrderId string mandatory	Order Id for payment Example: OREDRID98765

Note: For re-sending the payment request to customers for a particular order, the merchantorderId has to be the same which was sent in Send Payment Request API to Paytm.

Response Attributes

Content Type : JSON

Head

Attribute	Description
clientId string(3)	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
version string(2)	Version of the API passed in the request. Example: v1
responseTimestamp string(15)	EPOCH timestamp of the time at which response is being sent. Example: 1588402269
signature string(108)	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. Note: Create the signature using the body parameter of the request.

Body

Attribute

Description

resultInfo

object

This parameter gives the information about the result of the API response

ResultInfo

Attribute	Description
resultCode string	This is the resultCode corresponding to a particular message and is returned to the merchant. It's maximum length is 64. The different result codes corresponding to this API are mentioned below.
resultStatus string	This parameter indicates the status of API call. Possible Values: SUCCESS, FAILURE
resultMsg string(256)	This parameter is the result message which contains information about the result.The different result messages corresponding to this API are mentioned below.

paymentUrl

string

Paytm generated payment URL which is sent to the customers over an SMS, and can be used to complete the payment from Paytm or any UPI app.

Response Codes & Messages

resultCode	resultStatus	resultMsg
RSPR_001	SUCCESS	Payment request sent successfully
SPR_002	FAILURE	merchantOrderid cannot be blank
SPR_002	FAILURE	MID cannot be blank
SPRO_002	FAILURE	Order is in success state
SPRO_003	FAILURE	Order is closed
SPRO_004	FAILURE	Order not found
RSPR_002	FAILURE	Payment Request already sent. Please try again later
GE_0003	FAILURE	We could not get the requested details. Please try again.
RSPR_005	FAILURE	Preference not enabled on Merchant
SPRO_005	FAILURE	Could not notify user. Either resend notification or try with new orderId
SPRO_006	FAILURE	Payment has been completed on this order
SPRO_007	FAILURE	OrderId contains restricted special characters

⇾

Staging

Production

https://securegw-stage.paytm.in/order/resendpaymentrequest copy icon

REQUEST

RESPONSE

CURL

JAVA

NODE

PHP

PYTHON

curl -X POST 'https://securegw-stage.paytm.in/order/resendpaymentrequest' \
--header 'Content-Type: application/json' \
--data '{"body":{"mid":"{mid}","merchantOrderId":"BEKJBJK123"},"head":{"clientId":"C11","version":"v1","signature":"{signature}"}}'