Request Payment APIs are used when the merchant wants to send a collect payment request to user's PhonePe app against an order.

Request Headers

Header NameHeader Value
X-VERIFYSHA256(base64 encoded payload +
"/v3/charge" + salt key) + ### + salt index
X-CALLBACK-URLCallback Url where a request will be made once user responds
to collect request.
Click here to see about this request.
   "message":"collect for XXX order",
   "email":"[email protected]",
  "request": "eyJtZXJjaGFudE9yZGVySWQiOiAiT0QxMjM0IiwgInN1Yk1lcmNoYW50IjogIkRlbW9NZXJjaGFudCIsICJhbW91bnQiOiAxMDAsICJtZXNzYWdlIjogInJlZnVuZCBmb3IgY2FuY2VsbGVkIG9yZGVyIiwgIm1vYmlsZU51bWJlciI6ICI5eHh4eHh4eHh4IiwgInNob3J0TmFtZSI6ICJBbWl0IiwgInRyYW5zYWN0aW9uSWQiOiAiVFgxMjM0NTY3ODkiLCAibWVyY2hhbnRVc2VySWQiOiAiVTEyMzQ1Njc4OSIsICJtZXJjaGFudElkIjogIkRlbW9NZXJjaGFudCIsICJlbWFpbCI6ICJhbWl0eHh4NzVAZ21haWwuY29tIn0"

Request Parameters

Parameter NameTypeDescriptionMandatory
merchantIdStringUnique Merchant ID assigned to the merchant by PhonePeYes
transactionIdStringUnique Transaction ID generated by the merchant to track this request to PhonePe
transactionId length
Should be unique for each collect request.
should be less than 38 characters.
merchantOrderIdStringUnique Order ID generated by the merchant
merchantOrderId length should be less than 48 characters.
amountLongAmount in PaisaYes
instrumentTypeENUMHas the value MOBILEYes
instrumentReferenceStringMobile number of the userYes
expiresInLongexpire time of payment completion.Payment should be completed with in this time else will be markedfailed. (default 30 days)Yes
messageStringRecommended to pass transaction id, order id and invoice number.No
emailStringEmail Id of UserNo
shortNameStringCustomer NameNo
subMerchantIdStringSub-category of the merchantNo
storeIdStringStore Id of store. Should be unique across.Yes
terminalIdStringTerminal Id of store. Should be unique for a store.No

Response Parameters

Parameter NameTypeDescription
successBOOLEANSuccess status of the request
codeENUMSee below section for list of codes
messageSTRINGShort message about status of request
transactionIdSTRINGUnique Transaction ID generated by the merchant to track this request to PhonePe
merchantIdSTRINGUnique Merchant ID assigned to the merchant by PhonePe
amountLONGTransaction amount in paise
providerReferenceIdSTRINGPhonePe transaction Id
mobileNumberSTRINGMobile Number

Response Codes

The code in the above API response could be:

  • SUCCESS : Collect was successfully sent to VPA
  • INTERNAL_SERVER_ERROR : Something went wrong. Need to validate through check transaction status API first to know the payment status.
  • INVALID_TRANSACTION_ID : TransactionId in request was duplicate
  • BAD_REQUEST : Some mandatory parameter was missing
  • AUTHORIZATION_FAILED : Checksum sent in header was not valid

Sample Codes##

Sample code can be downloaded from the link mentioned below:-

Password: ULG1vOBHxU

Charge Callback

When the user responds to the collect request sent by the merchant, a request is sent to either the URL provided in X-CALLBACK-URL or the merchant's registered callback URL. By default, this is a POST request.


  • The callback would be sent only for success/Failed scenarios. For pending cases, there won't be any callback. For such transactions payment status should be checked with below API.
  • If payment is in pending state, Merchant should display a message "Payment is in progress, please wait for sometime."
  • The payment will always be closed within the expiry time passed in the collect request.
Click Try It! to start a request and see the response here!