Request Headers

Header NameHeader Value
Content-Typeapplication/json
X-VERIFYSHA256(base64 encoded payload + "/v3/credit/deferred/fulfill" +
salt key) + ### + salt index
{
  "merchantId": "DemoMerchant",
  "transactionId": "TX123456789",
  "merchantUserId": "U123456789",
  "amount": 100,
  "merchantOrderId": "OD1234",
  "subMerchant": "DemoMerchant",
  "mobileNumber": "9xxxxxxxxx",
  "message": "refund for cancelled order",
  "email": "amitxxx[email protected]",
  "shortName": "Amit"
}
{
  "request": "eyJtZXJjaGFudE9yZGVySWQiOiAiT0QxMjM0IiwgInN1Yk1lcmNoYW50IjogIkRlbW9NZXJjaGFudCIsICJhbW91bnQiOiAxMDAsICJtZXNzYWdlIjogInJlZnVuZCBmb3IgY2FuY2VsbGVkIG9yZGVyIiwgIm1vYmlsZU51bWJlciI6ICI5eHh4eHh4eHh4IiwgInNob3J0TmFtZSI6ICJBbWl0IiwgInRyYW5zYWN0aW9uSWQiOiAiVFgxMjM0NTY3ODkiLCAibWVyY2hhbnRVc2VySWQiOiAiVTEyMzQ1Njc4OSIsICJtZXJjaGFudElkIjogIkRlbW9NZXJjaGFudCIsICJlbWFpbCI6ICJhbWl0eHh4NzVAZ21haWwuY29tIn0"
}

Request Parameters

Parameter NameTypeDescriptionMandatory
merchantIdStringUnique Merchant ID assigned to the merchant by PhonePeYes
transactionIdStringTransaction ID same as that of credit/deferredAPIYes
merchantUserIdStringUnique ID assigned to the user by the merchant. This is used for linking the user’s PhonePe account.Yes
amountLongTransaction amount in paiseYes
merchantOrderIdStringOrder ID for the merchant transactionYes
subMerchantStringTag to categorize merchant transactionNo
mobileNumberStringMobile number of the userNo
messageStringShort message displayed on success pageNo
emailStringEmail address of the userNo
shortNameStringUser's name for per-filling user registerationNo

Response Parameters

Parameter NameTypeDescription
successBooleanSuccess status of the request
codeENUMTo see list of response codes go here.
messageStringShort message about code
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
statusStringStatus of the request
merchantUserIdStringUnique ID assigned to the user by the merchant. This is used for linking the user’s PhonePe account.
mobileNumberStringMobile number of the user
providerReferenceIdStringPhonePe transaction id
payResponseCodeStringPhonePe internal status code
Language
Click Try It! to start a request and see the response here!