API to debit the money directly from PhonePe wallet.

Request Headers

Header NameHeader Value
X-VERIFYSHA256(base64 encoded payload +
' /v3/debit/instant' + salt key) +
'###' + salt index
 "merchantId": "DemoMerchant",
 "transactionId": "TX123456789",
 "amount": 100,
 "merchantOrderId": "OD1234",
 "subMerchant": "DemoMerchant",
 "message": "Payment for order OD1234"
 "request" : "ew0KCeKAnG1lcmNoYW50SWTigJ06IOKAnEpJT+KAnSwNCgnigJx0cmFuc2FjdGlvbklk4oCdOiDigJxUWE4xMjM0NeKAnSwNCgnigJxtZXJjaGFudE9yZGVySWTigJ0gOiDigJxPNDIzODTigJ0sDQoJ4oCcbW9iaWxlTnVtYmVy4oCdOiDigJw5ODc2NTQzMjEw4oCdLA0KCeKAnG1lcmNoYW50VXNlcklk4oCdOiDigJxVU0VSMTIzNDXigJ0sDQoJ4oCcZW1haWw6IOKAnG5pc2hhbnQubUBnbWFpbC5jb23igJ0sDQoJ4oCcc2hvcnROYW1l4oCdIDog4oCcTmlzaGFudCBNaXR0YWzigJ0NCn0="

Request Parameters

Parameter NameTypeDescriptionMandatory
merchantIdstringUnique merchant id assigned to the merchantYes
transactionIdstringUnique Transaction ID generated by the merchant to track this request to PhonePeYes
amountintAmount in paiseYes
mobileNumberstringMobile number on which OTP will be sentYes
merchantOrderIdstringOrder ID for the merchant transactionYes
userAuthTokenstringAuth token generated from otp verifyYes
emailstringEmail id of customerNo
shortNamestringName of customerNo

Response Parameters

Parameter NameTypeDescription
successbooleanDenotes if API call is successful.
codestringSee below for list of values
dataobjectSee below table
messagestringShort message about code

Response Codes

BAD_REQUESTInvalid request payload
INTERNAL_SERVER_ERRORSomething went wrong
INVALID_USER_AUTH_TOKENThe userAuthToken provided is either invalid or not mapped to merchant.
PAYMENT_SUCCESSPayment is successful
PAYMENT_ERRORPayment failed
USER_BLACKLISTEDCustomer is blacklisted on PhonePe side
MERCHANT_USER_NOT_FOUNDNo user exists for merchant id and user id combination.
USER_BLOCKEDUser is blocked for 1 day.
TIMED_OUTPayment timed out (Status check is required)

Response Data

Parameter NameTypeDescription
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
Click Try It! to start a request and see the response here!