---
page_source: https://juspay.io/in/docs/upi-merchant-stack/docs/submerchants/list-specific-sub-merchant-info
page_title: List Specific Sub Merchant Info
---

## API Version: default


# **List Specific Sub Merchant Info** 



This api gives the information of the requested submerchant .## Endpoints:
- Production: http://{{host}}/api/{uri}/merchants/sub/info

## Request Type: 
POST

## Headers:

#### Content-Type:
`application/json`
- Value: application/json
- Tags: string

#### x-version:
- Value: {{version}}
- Tags: string

#### x-merchant-signature:
This is a signature over combination of headers, payload. Refer Signature Calculation section for more details.
- Value: bypass
- Tags: string

#### x-merchant-id:
Will be shared while onboarding.
- Value: {{mid}}
- Tags: string

#### x-merchant-channel-id:
Will be shared while onboarding.
- Value: {{mcid}}
- Tags: string

#### Accept:
`application/json`
- Value: application/json
- Tags: string

#### x-timestamp:
This is an epoch unix timestamp string. For example, `1496918882000`. It can be used by us to invalidate older requests.
- Value: {{$timestamp}}
- Tags: string

#### x-sub-merchant-id:
Provided during on-boarding. To be passed in the apis if it needs to be invoked in sub merchant mode.
- Tags: String, Mandatory

#### x-sub-merchant-channel-id:
Provided during on-boarding. To be passed in the apis if it needs to be invoked in sub merchant mode.
- Tags: String, Mandatory
## Sample Code Snippets:
### Code Snippets:

#### Shell Code Snippet:

```shell
{"success":false,"message":"No Data found for the given path"}
```

### Sample Request and Response:

#### Request:
```json
{"success":false,"message":"No Data found for the given path"}
```

#### Response:
```json
{"success":false,"message":"No Data found for the given path"}
```

## Body Parameters:
### Parameters:

#### subMerchantId:
- Description: Merchant generated sub-merchant id valueAlphanumeric string. Maximum length is 256.
- Tags: String, Mandatory

#### subMerchantChannelId:
- Description: Sub-merchant channel idAlphanumeric string. Maximum length is 256.
- Tags: string, Mandatory

#### udfParameters:
- Description: Merchant Defined Parameters

**Example** : "{\"udf1\":\"value1\",\"udf2\":\"value2\",…}"**Note** : Few special characters are not allowed. Regex for the characters which are not allowed : **^[^/#-()*!%~`]+$** 
- Tags: Stringified JSON, Optional

#### iat:
- Description: Timestamp to be used in JWS.**Constraints:** As passed in the request body
- Tags: String, Mandatory
## API Responses:
### 200:

#### status:
- Description: Status of the API.**Values:** SUCCESS, FAILURE
- Tags: String, Mandatory

#### responseCode:
- Description: SUCCESS if call succeeded. Otherwise shows the error code.**Values:** Refer error code section.
- Tags: String, Mandatory

#### responseMessage:
- Description: SUCCESS if call succeeded. Otherwise shows verbose error.**Values:** Refer error code section.
- Tags: String, Mandatory

#### payload:
- Value:
  - **MerchantId**:
    - Description: Unique id for merchant.**Values:** [As](http://merchant.As) passed in request.
    - Tags: String, Mandatory
  - **MerchantChannelId**:
    - Description: Unique id for the channel via which request is made.**Values:** [As](http://made.As) passed in request.
    - Tags: String, Mandatory
  - **SubMerchantId**:
    - Description: merchantId of the sub-merchant**Values:** As passed while creation.
    - Tags: String, Mandatory
  - **SubMerchantChannelId**:
    - Description: channelId for the sub-merchant**Values:** As passed while creation.
    - Tags: String, Mandatory
  - **Vpa**:
    - Description: VPA for the sub-merchant**Values:** As passed while creation.
    - Tags: String, Mandatory
  - **MaskedAccountNumber**:
    - Description: Masked account number for the sub-merchant**Values:** As passed while creation.
    - Tags: String, Mandatory
  - **Ifsc**:
    - Description: ifsc code of the sub-merchant current bank account**Values:** As passed while creation.
    - Tags: String, Mandatory
  - **Mcc**:
    - Description: mcc code of the sub-merchant**Values:** As passed while creation.
    - Tags: String, Mandatory
  - **Enabled**:
    - Description: Tells whether the sub-merchant is enabled or not**Values:** By default it is false. Initiate Update Sub-merchant to enable it.
    - Tags: String, Mandatory
  - **CallbackUrls**:
    - Description: Callback Urls that are configured for each event**Values:** As passed while creation.
    - Tags: String, Mandatory
  - **UdfParameters**:
    - Description: Stringified json for udf parameters.
    - Tags: JSON, Mandatory
- Tags: String, Mandatory