Search<html-block html=”
“>
| Header Name | Header Value |
|---|---|
Content-Type | application/json |
X-VERIFY | SHA256(base64 encoded payload + “/v3/merchant/payment/options” + salt key) + ### + salt index |
{
"merchantId":"M2306160483220675579140", // String Mandatory
"amount":100, // String Mandatory
"merchantOrderId":"ORDERID", // String Optional
"merchantUserId":"TXX", // String Mandatory
}
{
"request": "eyAgCiAgICJtZXJjaGFudElkIjoiTTIzMDYxNjA0ODMyMjA2NzU1NzkxNDAiLAogICAiYW1vdW50IjoxMDAsCiAgICJtZXJjaGFudE9yZGVySWQiOiJPUkRFUklEIiwKICAgIm1lcmNoYW50VXNlcklkIjoiVFhYIiwKfQ=="
}
<html-block html=”
“>
| Parameter Name | Type | Description | Mandatory |
|---|---|---|---|
merchantId | STRING | Unique MerchantID assigned to the merchant by PhonePe | Yes |
merchantUserId/ userAuthToken | STRING | Token to identify user (generated while linking user) | Yes |
amount | LONG | Transaction amount in Paise | Yes |
merchantOrderId | STRING | Merchant order id | No |
<html-block html=”
“>
| Parameter Name | Type | Description |
|---|---|---|
success | BOOLEAN | Success status of the request |
code | ENUM | See list of response codes below |
data | OBJECT | See the below for more details |
Data will contain list of instruments. Currently supported are wallet, upi, card. This can increase in future to EGV etc. Only enabled instruments must be shown.
- instrumentPriority: This is instrument level priority. Priority 0 being the highest.
- priority: This will be for priority inside an instrument. For eg: If 3 saved cards there, then this denotes which one should be shown in what order.
- deviceMapped : For inline UPI use cases. If deviceId comes in incoming request and UPI is enabled** on that device then this field will be true. (Currently not applicable)
<html-block html=”
“>
| CODE | Despcription |
|---|---|
SUCCESS | Success status of the request |
AUTHORIZATION_FAILED | Value of X-VERIFY is incorrect |
BAD_REQUEST | Some mandatory parameter is missing |
INTERNAL_SERVER_ERROR | Something went wrong |
USER_NOT_FOUND | Cannot resolve user |
INVALID_USER_AUTH_TOKEN | Invalid userAuthToken |
{“method”:”post”,”url”:”/v3/merchant/payment/options”,”auth”:”required”,”apiSetting”:”5ecf9143b5bd210023b3b738″,”examples”:{“codes”:[{“language”:”text”,”code”:””}]},”results”:{“codes”:[{“status”:200,”language”:”json”,”code”:”{ \n \”success\”:true,\n \”code\”:\”SUCCESS\”,\n \”data\”:{ \n \”wallets\”:{ \n \”enabled\”:true,\n \”instrumentPriority\”:1, //instrument level priority\n \”activeWallets\”:[ //future provision for additional wallets\n { \n \”provider\”:\”PHONEPE\”,\n \”availableBalance\”:7675,\n \”usableBalance\”:7675,\n \”priority\”:0\n }\n ]\n },\n \”upi\”:{ \n \”enabled\”:true,\n \”instrumentPriority\”:2,\n \”deviceMapped\”:false, //for inline UPI payments\n \”activeAccounts\”:[ \n { \n \”accountId\”:\”AC1802131629137902917383\”,\n \”priority\”:0, //priority inside each instrument\n \”accountNo\”:\”XXXXXXXXXX55743\”,\n \”accountHolderName\”:\”ABC\”,\n \”bankName\”:\”Test Bank – AABF\”,\n \”offers\”:[ \n { \n \”offerId\”:\”String\”,\n \”displayTitle\”:\”String\”,\n \”description\”:\”String\”,\n \”offerAmount\”:\”Long\”,\n \”offerType\”:\”String\”,\n \”tncLink\”:\”String\”\n }\n ]\n }\n ]\n },\n \”card\”:{ \n \”enabled\”:true,\n \”instrumentPriority\”:0,\n \”savedCards\”:[ \n { \n \”cardId\”:\”C68D688C382F4D12BB963E8D38B9F1D2\”,\n \”cardIssuer\”:\”VISA\”,\n \”priority\”:0,\n \”type\”:\”DEBIT_CARD\”,\n \”cardNumber\”:\”4143XXXXXXXX3449\”,\n \”cardBin\”:\”414312\”,\n \”cardHolderName\”:\”UK\”,\n \”externalCardId\”:\”XXXX\”,\n \”cvvRequired\”:true,\n \”offers\”:[ \n { \n \”offerId\”:\”String\”,\n \”displayTitle\”:\”String\”,\n \”description\”:\”String\”,\n \”offerAmount\”:\”Long\”,\n \”offerType\”:\”String\”,\n \”tncLink\”:\”String\”\n }\n ]\n }\n ]\n }\n }\n}”,”name”:”Success Response”},{“status”:400,”language”:”json”,”code”:”{}”,”name”:””}]},”params”:[{“name”:”request”,”type”:”string”,”enumValues”:””,”default”:””,”desc”:”base64 encoded payload”,”required”:true,”in”:”body”,”ref”:””,”_id”:”5b4c669fbaebd600039559d8″},{“name”:”Content-Type”,”type”:”string”,”enumValues”:””,”default”:”application/json”,”desc”:””,”required”:true,”in”:”header”,”ref”:””,”_id”:”5b4c669fbaebd600039559d7″},{“name”:”X-VERIFY”,”type”:”string”,”enumValues”:””,”default”:””,”desc”:”SHA256(base64 encoded payload + \”/v3/merchant/payment/options\” + salt key) + ### + salt index”,”required”:false,”in”:”header”,”ref”:””,”_id”:”5b4c669fbaebd600039559d6″},{“name”:”X-MERCHANT-DEVICE-ID”,”type”:”string”,”enumValues”:””,”default”:””,”desc”:”Collect encrypted device id from Android app”,”required”:false,”in”:”header”,”ref”:””,”_id”:”5d3ab058806f2e00648860f3″}]}
https://mercury-uat.phonepe.com