Used to unlink the PhonePe account with Merchant account of customer. The userAuthToken is also invalidated. This doesn’t involve any UI flow. Merchant needs to implement their own UI.

Request Headers

Header NameHeader Value
Content-Typeapplication/json
X-VERIFYSHA256(base64 encoded payload +
'/v3/merchant/token/unlink' + salt key) +
'###' + salt index
{
 "merchantId": "MID",
 "userAuthToken": "TXN12345"
}
{
 "request" : "ew0KCeKAnG1lcmNoYW50SWTigJ06IOKAnE1JROKAnQ0KCeKAnHVzZXJBdXRoVG9rZW7igJ06IOKAnFRYTjEyMzQ14oCdLA0KfQ0K"
}

Request Parameters

Parameter NameTypeDescription
merchantIdstringUnique merchantId assigned to merchant.
userAuthTokenstringAuth token for the user

Response Parameters

Parameter NameTypeDescription
successbooleanDenotes if API call is successful.
codestringSee below for list of values
dataObjectSee below table

Response Codes

Code ValueDescription
SUCCESSSuccess scenario
AUTHORIZATION_FAILEDValue of X-VERIFY is incorrect
BAD_REQUESTInvalid request payload
INTERNAL_SERVER_ERRORThe server is busy or the server is not responding
USER_BLACKLISTEDCustomer is blacklisted on PhonePe side
INVALID_USER_AUTH_TOKENThe userAuthToken provided is either invalid or not mapped to merchant.

Response Data

Parameter NameTypeDescription
merchantIdstringmerchantId assigned to merchant.
userAuthTokenstringThe disabled Auth token for the user
Language
Click Try It! to start a request and see the response here!