> ## Documentation Index
> Fetch the complete documentation index at: https://docs.eximpe.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Merchant

> Retrieve the details of a specific merchant by its ID.

## Overview

Retrieve the full details of a specific sub-merchant by its ID, including company information, settlement details, and current KYC status.

## Request Parameters

#### Path Parameters

| Name         | Type   | Required | Description                                                    |
| ------------ | ------ | -------- | -------------------------------------------------------------- |
| merchant\_id | string | Yes      | The unique identifier of the sub-merchant (e.g., `6692437779`) |

## Response

The response includes the same fields as [Create Merchant](/api-reference/v1/merchant/create) and [Update Merchant](/api-reference/v1/merchant/update) responses.

| Name                | Type   | Description                                                                                         |
| ------------------- | ------ | --------------------------------------------------------------------------------------------------- |
| id                  | string | Unique merchant identifier                                                                          |
| company\_details    | object | Company registration, business, and contact details                                                 |
| settlement\_details | object | Bank settlement details including settlement currency                                               |
| kyc\_status         | string | Current KYC/onboarding status (`PENDING`, `IN_REVIEW`, `CHANGES_REQUESTED`, `APPROVED`, `REJECTED`) |
| created\_at         | string | ISO 8601 timestamp of creation                                                                      |
| last\_updated\_at   | string | ISO 8601 timestamp of last update                                                                   |

## Response Example

<CodeGroup>
  ```json Success theme={null}
  {
    "success": true,
    "message": "Sub-merchant details retrieved successfully",
    "data": {
      "id": "6692437779",
      "company_details": {
        "legal_name": "Acme Corp Pvt Ltd",
        "brand_name": "Acme",
        "email": "contact@acme.com",
        "phone_number": "+919876543210",
        "registration_number": "U12345MH2020PTC123456",
        "international_org_type": "Private Limited Company",
        "tax_id": "AACCA1234A",
        "website": "https://acme.com",
        "monthly_avg_transaction_volume": "BETWEEN_20_K_AND_50_K",
        "communication_address": "123 Business Park",
        "communication_city": "Mumbai",
        "communication_state": "Maharashtra",
        "communication_country": "India",
        "communication_pincode": "400001",
        "same_as_registered_address": true,
        "registered_address": "123 Business Park",
        "registered_city": "Mumbai",
        "registered_state": "Maharashtra",
        "registered_country": "India",
        "registered_pincode": "400001",
        "business_category": "Digital goods / software / downloads",
        "business_category_other": null,
        "business_mode": "b2b",
        "hs_codes": ["84713010"],
        "description_of_products_and_services": "Software development and IT consulting services",
        "agreement_details": "Service agreement dated 2024-01-15"
      },
      "settlement_details": {
        "bank_account_number": "1234567890",
        "bank_account_name": "Acme Corp",
        "bank_swift_code": "SBININBB",
        "bank_name": "State Bank of India",
        "bank_branch_name": "Main Branch",
        "bank_address": "123 Bank Street",
        "bank_city": "Mumbai",
        "bank_state": "Maharashtra",
        "bank_country": "India",
        "bank_pincode": "400001",
        "routing_number": "SBIN0001234",
        "settlement_currency": "USD"
      },
      "kyc_status": "PENDING",
      "created_at": "2026-04-28T07:54:33.468589Z",
      "last_updated_at": "2026-04-28T09:39:10.007872Z"
    }
  }
  ```

  ```json Not Found theme={null}
  {
    "success": false,
    "error": {
      "code": "ERR_MERCHANT_001",
      "message": "Validation error",
      "details": "Not found."
    }
  }
  ```
</CodeGroup>

## Error Codes

| Code               | Message          | Description                         |
| ------------------ | ---------------- | ----------------------------------- |
| ERR\_MERCHANT\_001 | Validation error | Merchant not found or access denied |


## OpenAPI

````yaml GET /partners/merchants/{merchant_id}/
openapi: 3.0.0
info:
  title: Eximpe Payment Gateway API
  description: >-
    API for payment processing and order management through Eximpe payment
    gateway. This specification includes v1, v2, and v3 API versions.
  license:
    name: Proprietary
  version: 2.0.0
servers:
  - url: https://api-pacb-uat.eximpe.com
    description: Payment Gateway Sandbox URL
security:
  - clientAuth: []
    clientSecretAuth: []
    apiVersionHeader: []
tags:
  - name: Card Tokens
  - name: Merchants
  - name: Orders
  - name: Payment Links
  - name: Payments
  - name: Refunds
  - name: Settlements
  - name: Subscriptions
paths:
  /partners/merchants/{merchant_id}/:
    get:
      tags:
        - Merchants
      summary: Get Merchant
      description: Retrieve the details of a specific merchant by its ID.
      operationId: v1_get_partners_merchants_merchant_id_
      parameters:
        - name: merchant_id
          in: path
          description: The ID of the merchant to retrieve.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Merchant details retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1_GetMerchantResponse'
              example:
                success: true
                message: Sub-merchant details retrieved successfully
                data:
                  id: '3604346598'
                  settlement_details:
                    bank_account_number: '9876543210123456'
                    bank_account_name: InnovateTech Solutions Private Limited
                    bank_swift_code: CHASUS33XXX
                    bank_name: JPMorgan Chase Bank
                    bank_branch_name: Corporate Banking Division
                    bank_address: 270 Park Avenue
                    bank_city: New York
                    bank_state: NY
                    bank_country: United States
                    bank_pincode: '10017'
                    routing_number: '021000021'
                    settlement_currency: USD
                  created_at: '2025-06-19T18:06:05.523720Z'
                  company_details:
                    legal_name: InnovateTech Solutions Private Limited
                    brand_name: InnovateTech Solutions
                    registration_number: US-CORP-2024-IT789456
                    international_org_type: Private Limited Company
                    tax_id: 94-8765432
                    website: https://www.innovatetech.com
                    monthly_avg_transaction_volume: BETWEEN_20_K_AND_50_K
                    communication_address: 123 Tech Street
                    communication_city: San Francisco
                    communication_state: CA
                    communication_country: United States
                    communication_pincode: '94105'
                    same_as_registered_address: true
                    registered_address: 123 Tech Street
                    registered_city: San Francisco
                    registered_state: CA
                    registered_country: United States
                    registered_pincode: '94105'
                    business_category: E-commerce (physical goods & cross-border shipping)
                    business_mode: b2b
                    hs_codes:
                      - '84713010'
                      - '85423100'
                    description_of_products_and_services: >-
                      We provide comprehensive IT solutions including software
                      development, cloud migration, data analytics, and digital
                      transformation services for enterprises. Our solutions
                      help businesses streamline operations, improve efficiency,
                      and accelerate digital adoption.
                    agreement_details: global_company aggrement
                    email: contact@example.com
                    phone_number: '+919876543210'
                    business_category_other: null
                  last_updated_at: '2025-06-19T18:06:05.523752Z'
                  kyc_status: PENDING
        '404':
          description: Merchant not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/v1_ErrorResponse'
      security:
        - clientAuth: []
          clientSecretAuth: []
          apiVersionHeader: []
components:
  schemas:
    v1_GetMerchantResponse:
      type: object
      required:
        - success
        - message
        - data
      properties:
        success:
          type: boolean
        message:
          type: string
        data:
          $ref: '#/components/schemas/v1_MerchantDetails'
    v1_ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          enum:
            - false
          description: >-
            Indicates if the request was successful. Always false for error
            responses.
        error:
          $ref: '#/components/schemas/v1_ErrorDetails'
    v1_MerchantDetails:
      type: object
      required:
        - id
        - settlement_details
        - created_at
        - company_details
        - last_updated_at
        - kyc_status
      properties:
        id:
          type: string
          description: Unique merchant identifier
        settlement_details:
          $ref: '#/components/schemas/v1_SettlementDetails'
        created_at:
          type: string
          format: date-time
          description: Merchant creation timestamp
        company_details:
          $ref: '#/components/schemas/v1_CompanyDetails'
        last_updated_at:
          type: string
          format: date-time
          description: Last updated timestamp
        kyc_status:
          type: string
          enum:
            - PENDING
            - IN_REVIEW
            - CHANGES_REQUESTED
            - APPROVED
            - REJECTED
          description: Current KYC/onboarding status
    v1_ErrorDetails:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
          description: Error code (e.g., ERR_ORDER_002)
        message:
          type: string
          description: Error message
        details:
          type: object
          description: Detailed validation error information with field-specific errors
          additionalProperties:
            type: string
            description: Error message for the specific field
    v1_SettlementDetails:
      type: object
      required:
        - bank_account_number
        - bank_account_name
        - bank_swift_code
        - bank_name
        - bank_branch_name
        - bank_address
        - bank_city
        - bank_state
        - bank_country
        - bank_pincode
        - routing_number
      properties:
        bank_account_number:
          type: string
          description: Bank account number
        bank_account_name:
          type: string
          description: Name on the bank account
        bank_swift_code:
          type: string
          description: Bank SWIFT/BIC code
        bank_name:
          type: string
          description: Name of the bank
        bank_branch_name:
          type: string
          description: Bank branch name
        bank_address:
          type: string
          description: Bank address
        bank_city:
          type: string
          description: Bank city
        bank_state:
          type: string
          description: Bank state
        bank_country:
          type: string
          description: Bank country
        bank_pincode:
          type: string
          description: Bank pincode/postal code
        routing_number:
          type: string
          description: Bank routing number
    v1_CompanyDetails:
      type: object
      required:
        - email
        - phone_number
        - legal_name
        - brand_name
        - registration_number
        - international_org_type
        - tax_id
        - website
        - monthly_avg_transaction_volume
        - business_category
        - business_mode
        - description_of_products_and_services
        - registered_address
        - registered_city
        - registered_state
        - registered_country
        - registered_pincode
        - same_as_registered_address
      properties:
        legal_name:
          type: string
          description: Legal name of the company
        brand_name:
          type: string
          description: Brand/trading name of the company
        registration_number:
          type: string
          description: Company registration number
        international_org_type:
          type: string
          enum:
            - Private Limited Company
            - Public Limited Company
            - Limited Liability Company
            - Joint Stock Company
            - Free Zone Company / Entity
            - Partnership / LLP
            - Sole Proprietorship
            - Other
          description: Type of organization
        tax_id:
          type: string
          description: Tax identification number
        website:
          type: string
          format: uri
          description: Company website URL (must include https://)
        monthly_avg_transaction_volume:
          type: string
          enum:
            - LESS_THAN_5_K
            - BETWEEN_5_K_AND_20_K
            - BETWEEN_20_K_AND_50_K
            - BETWEEN_50_K_AND_100_K
            - BETWEEN_100_K_AND_250_K
            - BETWEEN_250_K_AND_500_K
            - ABOVE_500_K
          description: Expected monthly transaction volume range
        registered_address:
          type: string
          description: Registered address
        registered_city:
          type: string
          description: Registered city
        registered_state:
          type: string
          description: Registered state
        registered_country:
          type: string
          description: Registered country
        registered_pincode:
          type: string
          description: Registered pincode/postal code
        same_as_registered_address:
          type: boolean
          description: >-
            Whether communication address is same as registered address, if
            provided communication address will be ignored
        communication_address:
          type: string
          description: >-
            Communication address, required if same_as_registered_address is
            false or not provided
        communication_city:
          type: string
          description: >-
            Communication city, required if same_as_registered_address is false
            or not provided
        communication_state:
          type: string
          description: >-
            Communication state, required if same_as_registered_address is false
            or not provided
        communication_country:
          type: string
          description: >-
            Communication country, required if same_as_registered_address is
            false or not provided
        communication_pincode:
          type: string
          description: >-
            Communication pincode/postal code, required if
            same_as_registered_address is false or not provided
        business_category:
          type: string
          description: >-
            Business category (comma-separated for multiple). Values: E-commerce
            (physical goods & cross-border shipping), Digital goods / software /
            downloads, SaaS / subscriptions / recurring billing, Services
            (delivered cross-border), Marketplace / platform (multiple sellers),
            Other
        business_mode:
          type: string
          enum:
            - b2b
            - b2c
            - marketplace
          description: Mode of business
        hs_codes:
          type: array
          items:
            type: string
          description: >-
            Harmonized System codes for products/services, required for physical
            goods
        description_of_products_and_services:
          type: string
          description: Detailed description of products and services
        agreement_details:
          type: string
          description: Agreement details
        email:
          type: string
          format: email
          description: Contact email for the sub-merchant
        phone_number:
          type: string
          description: Contact phone number in E.164 format (e.g., +919876543210)
        mcc:
          type: string
          description: Comma-separated 4-digit Merchant Category Codes (e.g., 5411,5812)
        business_category_other:
          type: string
          description: Required when business_category includes Other
  securitySchemes:
    clientAuth:
      type: apiKey
      name: X-Client-ID
      in: header
      description: >-
        **Client Application ID** - Your unique application identifier used to
        authenticate API requests. You can find your Client ID in the Developer
        Settings section of the merchant dashboard.
      x-displayName: Client ID
      x-example: your-client-id
    clientSecretAuth:
      type: apiKey
      name: X-Client-Secret
      in: header
      description: >-
        **Client Secret Key** - Your secret key used alongside the Client ID for
        secure authentication. Keep this confidential and never expose it in
        client-side code. Available in the Developer Settings section of the
        merchant dashboard.
      x-displayName: Client Secret
      x-example: your-client-secret
    apiVersionHeader:
      type: apiKey
      name: X-API-Version
      in: header
      description: >-
        **API Version** - Specifies which version of the API to use (e.g.,
        '1.X.X', '2.X.X', or '3.X.X'). This header allows you to control which
        API version your integration uses. Default version information is
        available in the Developer Settings.
      x-displayName: API Version
      x-example: 3.0.0

````