search

POSTSend Payment Request API

Use Case

To create the payment link for an order and send it to the customer's mobile over SMS.

Request Attributes

Content Type : JSON

Head

AttributeDescription
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

AttributeDescription
mid
string
mandatory

Paytm provides MID as a unique identifier to each merchant.

Example: INTEGR7769XXXXXX93833

merchantOrderId
string
mandatory

Order Id for payment

Example: OREDRID98765

amount
string
mandatory

This parameter contains the amount to be charged to the customer and can have two places of decimal.

 

 

Example: 1303.00

posId
string(50)
mandatory

Point of sale ID.
(Format: Store number_POS number)

Example: S12_123

userPhoneNo
string
mandatory

Phone number of the user to whom payment request has to be sent on SMS

Example: 7777777777

expiry
string
mandatory

Time after which the link will expire and payment cannot be done on the same.
Date Format : yyyy-MM-dd HH:mm:ss

 

 

Example: 2020-01-30 12:30:30

displayName
string(50)
optional

Display name for the payment request

Example: Merchant Brand Name

orderDetails
string
optional

Details of the Order

Example: Grocery Items

invoiceDetails
string
optional

Details of the Invoice/Bill Data associated with the transaction

Example: #INV_ORDERID_98765

comment
string
optional

Transaction Note that customer will see while making the payment

subwalletAmount
object
optional

Cap amount for different user subwallets

Example: {"FOOD": "2"}

Note: The possible values for the User SubWalletType Enum are:

  • FOOD
  • GIFT
  • MULTI_PURPOSE_GIFT
  • TOLL
  • CLOSED_LOOP_WALLET
  • CLOSED_LOOP_SUB_WALLET
  • FUEL
  • INTERNATIONAL_FUNDS_TRANSFER
  • CASHBACK
  • GIFT_VOUCHER
  • COMMUNICATION

Response Attributes

Content Type : JSON

Head

AttributeDescription
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.

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

AttributeDescription
resultInfo
object

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

ResultInfo
+
AttributeDescription
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

resultCoderesultStatusresultMsg
SPR_001SUCCESSPayment request sent successfully
SPR_002FAILUREmerchantOrderid cannot be blank
SPR_002FAILUREMID cannot be blank
SPR_002FAILUREInvalid amount
SPR_002FAILUREInvalid expiry date
SPR_002FAILUREInvalid userPhoneNo
SPR_003FAILUREUPI paymode not enabled on merchant
WM_1011FAILUREDuplicate Order ID
GE_0003FAILUREWe could not get the requested details. Please try again.
DQR_0004FAILUREMerchant's VPA-address not found
RSPR_005FAILUREPreference not enabled on Merchant
SPRO_005FAILURECould not notify user. Either resend notification or try with new orderId
SPRO_006FAILUREPayment has been completed on this order
SPRO_007FAILUREOrderId contains restricted special characters
Staging
Production
https://securegw-stage.paytm.in/order/sendpaymentrequestcopy icon
REQUEST
RESPONSE
CURL
JAVA
NODE
PHP
PYTHON
curl -X POST 'https://securegw-stage.paytm.in/order/sendpaymentrequest' \
--header 'Content-Type: application/json' \
--data '{"body":{"mid":"{mid}","merchantOrderId":"BEKJBJK123","amount":"1303.00","userPhoneNo":"7777777777","posId":"S1234_P1235"},"head":{"clientId":"C11","version":"v1","signature":"{signature}"}}' 
copy icon