SearchRequest Headers
| Field Name | Value |
|---|---|
| X-Verify | SHA256 (“/v1/submerchant/{merchantId}/{subMerchantId}” + salt key) + ### + salt index |
| Content-Type | “application/json” |
Response
| Case | Response Code & Body |
|---|---|
| Success, if the request is valid & the requested sub-merchant-id is already onboarded. | HTTP Code: 200 { “success”: true, “code”: “SUCCESS”, “message”: , “data”: { “merchantId”: , “subMerchantId”: , “fullName”: , “displayName”: , “mcc”: , “websiteUrl”: , “externalMerchantType”: , “externalOnboardingType”: , “phoneNumber”: , “email”: , “address”: { “building”: , “street”: , “area”: , “locality”: , “city”: , “state”: , “country”: , “pinCode”: , “landmark”: } } } |
| Sub-merchant not found, if the requested sub-merchant-id is not already onboarded. | HTTP Code: 400 { “success”: false, “code”: “SUBMID_NOT_ONBOARDED”, “message”: “Sub-merchant is not onboarded.” } |
| Bad request if the X-Verify authorization header is missing or invalid. | HTTP Code: 400 { “success”: false, “code”: “BAD_REQUEST”, “message”: } |
| Unauthorized, if the aggregator is not authorized to perform the operation. | HTTP Code: 401 { “success”: false, “code”: “AUTHORIZATION_FAILED”, “message”: } |
{“method”:”get”,”url”:”/v1/submerchant/{merchantId}/{subMerchantId}”,”auth”:”required”,”results”:{“codes”:[{“name”:””,”code”:”{ \n \”success\”: true, \n \”code\”: \”SUCCESS\”, \n \”message\”: ,\n \t\”data\”: { \n \t\”merchantId\”: , \n \”subMerchantId\”: , \n \”fullName\”: , \n \”displayName\”: , \n \”mcc\”: , \n \”websiteUrl\”: , \n \”externalMerchantType\”: , \n \”externalOnboardingType\”: , \n \”phoneNumber\”: , \n \”email\”: , \n \”address\”: { \n \t\”building\”: , \n \”street\”: , \n \”area\”: , \n \”locality\”: , \n \”city\”: , \n \”state\”: , \n \”country\”: , \n \”pinCode\”: , \n \”landmark\”: \n \t} \n } \n}”,”language”:”json”,”status”:200},{“name”:””,”code”:”{}”,”language”:”json”,”status”:400}]},”params”:[{“name”:”merchantId”,”type”:”string”,”enumValues”:””,”default”:””,”desc”:”Unique Merchant ID assigned to the merchant by PhonePe”,”required”:false,”in”:”path”,”ref”:””,”_id”:”615bf22aaa7aba0080e98ef3″},{“name”:”subMerchantId”,”type”:”string”,”enumValues”:””,”default”:””,”desc”:”Aggregator Submerchant Id for which status is to be fetched”,”required”:false,”in”:”path”,”ref”:””,”_id”:”615bf22aaa7aba0080e98ef2″},{“name”:”Content-Type”,”type”:”string”,”enumValues”:””,”default”:”application/json”,”desc”:””,”required”:true,”in”:”header”,”ref”:””,”_id”:”615bf22aaa7aba0080e98ef1″},{“name”:”X-VERIFY”,”type”:”string”,”enumValues”:””,”default”:””,”desc”:”SHA256(\”/v1/submerchant/{merchantId}/{subMerchantId}\” + saltKey) + \”###\” + saltIndex”,”required”:true,”in”:”header”,”ref”:””,”_id”:”615bf22aaa7aba0080e98ef0″}],”examples”:{“codes”:[]},”apiSetting”:”5a1563aec32b6d002a16fb67″}
https://api-preprod.phonepe.com/apis/pg-sandbox