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

# Create Merchant

> Create a new merchant with settlement and company details.



## OpenAPI

````yaml openapi.json post /partners/merchants/
openapi: 3.0.0
info:
  title: Eximpe Payment Gateway API
  description: >-
    API for payment processing and order management through Eximpe payment
    gateway
  license:
    name: Proprietary
  version: 1.0.0
servers:
  - url: https://api-staging.eximpe.com
    description: Staging server
  - url: https://api.eximpe.com
    description: Production server
security:
  - clientAuth: []
    clientSecretAuth: []
paths:
  /partners/merchants/:
    post:
      tags:
        - Merchants
      summary: Create Merchant
      description: Create a new merchant with settlement and company details.
      requestBody:
        description: Merchant details to create
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateMerchantRequest'
            example:
              settlement_details:
                bank_account_number: '1234567890'
                bank_account_name: Example Company Ltd
                bank_swift_code: ABCDUS33
                bank_name: Example Bank
                bank_branch_name: Main Branch
                bank_address: 456 Bank St
                bank_city: New York
                bank_state: NY
                bank_country: United States
                bank_pincode: '10002'
                routing_number: '021000021'
              company_details:
                legal_name: shrine
                brand_name: TechSubshrine
                registration_number: REG123456
                international_org_type: PRIVATE_LIMITED
                tax_id: TAX789012
                website: https://techsub.example.com
                monthly_avg_transaction_value: '50000.00'
                monthly_avg_transaction_volume: '100'
                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: TECHNOLOGY
                business_mode: B2B
                commodity: Software Services
                payment_terms: NET_30
                hs_codes:
                  - '84713010'
                  - '85423100'
                category: E-commerce
                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
                purpose_code: P0101
        required: true
      responses:
        '201':
          description: Merchant created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateMerchantResponse'
              example:
                success: true
                message: Sub-merchant created successfully
                data:
                  id: '6182929449'
                  settlement_details:
                    bank_account_number: '9876543210'
                    bank_account_name: GlobalTech Solutions Inc.
                    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-01-15T10:30:00.000000Z'
                  updated_at: '2025-01-15T10:30:00.000000Z'
                  invoice_file: null
                  company_details:
                    legal_name: GlobalTech Solutions Inc.
                    brand_name: GlobalTech
                    registration_number: US-CORP-99887766
                    international_org_type: PRIVATE_LIMITED
                    tax_id: 94-1234567
                    website: https://www.globaltech.io
                    monthly_avg_transaction_value: '150000.00'
                    monthly_avg_transaction_volume: '300'
                    communication_address: 500 Mission Street, Suite 2400
                    communication_city: San Francisco
                    communication_state: CA
                    communication_country: United States
                    communication_pincode: '94105'
                    same_as_registered_address: false
                    registered_address: 1600 Amphitheatre Parkway
                    registered_city: Mountain View
                    registered_state: CA
                    registered_country: United States
                    registered_pincode: '94043'
                    business_category: TECHNOLOGY
                    business_mode: B2B
                    commodity: Enterprise Software Solutions
                    payment_terms: NET_30
                    hs_codes:
                      - '85234910'
                      - '84715000'
                    category: Enterprise SaaS
                    description_of_products_and_services: >-
                      GlobalTech provides cloud-native enterprise software,
                      including AI-powered analytics platforms, CRM solutions,
                      and infrastructure automation tools. We enable digital
                      transformation for Fortune 500 companies through scalable
                      and secure software systems.
                    agreement_details: >-
                      Master Service Agreement dated 2024-01-10 with Global
                      Clients
                    purpose_code: P0101
        '400':
          description: Bad request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - clientAuth: []
          clientSecretAuth: []
components:
  schemas:
    CreateMerchantRequest:
      type: object
      required:
        - settlement_details
        - company_details
      properties:
        settlement_details:
          $ref: '#/components/schemas/SettlementDetails'
        company_details:
          $ref: '#/components/schemas/CompanyDetails'
    CreateMerchantResponse:
      type: object
      required:
        - success
        - message
        - data
      properties:
        success:
          type: boolean
          description: Indicates if the request was successful
        message:
          type: string
          description: Response message
        data:
          $ref: '#/components/schemas/MerchantDetails'
    ErrorResponse:
      type: object
      required:
        - success
        - error
      properties:
        success:
          type: boolean
          description: Indicates if the request was successful
        error:
          $ref: '#/components/schemas/ErrorDetails'
    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
    CompanyDetails:
      type: object
      required:
        - legal_name
        - brand_name
        - registration_number
        - international_org_type
        - tax_id
        - website
        - monthly_avg_transaction_value
        - monthly_avg_transaction_volume
        - communication_address
        - communication_city
        - communication_state
        - communication_country
        - communication_pincode
        - same_as_registered_address
        - registered_address
        - registered_city
        - registered_state
        - registered_country
        - registered_pincode
        - business_category
        - business_mode
        - commodity
        - payment_terms
        - hs_codes
        - category
        - description_of_products_and_services
        - agreement_details
        - purpose_code
      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
          description: Type of international organization
          enum:
            - PRIVATE_LIMITED
            - PUBLIC_LIMITED
            - PARTNERSHIP
            - SOLE_PROPRIETORSHIP
            - LLC
            - CORPORATION
        tax_id:
          type: string
          description: Tax identification number
        website:
          type: string
          format: uri
          description: Company website URL
        monthly_avg_transaction_value:
          type: string
          description: Average monthly transaction value
        monthly_avg_transaction_volume:
          type: string
          description: Average monthly transaction volume
        communication_address:
          type: string
          description: Communication address
        communication_city:
          type: string
          description: Communication city
        communication_state:
          type: string
          description: Communication state
        communication_country:
          type: string
          description: Communication country
        communication_pincode:
          type: string
          description: Communication pincode/postal code
        same_as_registered_address:
          type: boolean
          description: Whether communication address is same as registered address
        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
        business_category:
          type: string
          description: Business category
          enum:
            - TECHNOLOGY
            - HEALTHCARE
            - FINANCE
            - RETAIL
            - MANUFACTURING
            - EDUCATION
            - ENTERTAINMENT
            - OTHER
        business_mode:
          type: string
          description: Business mode
          enum:
            - B2B
            - B2C
            - B2B2C
        commodity:
          type: string
          description: Primary commodity or service
        payment_terms:
          type: string
          description: Payment terms
          enum:
            - NET_30
            - NET_60
            - NET_90
            - IMMEDIATE
        hs_codes:
          type: array
          items:
            type: string
          description: Harmonized System codes for products/services
        category:
          type: string
          description: Business category description
        description_of_products_and_services:
          type: string
          description: Detailed description of products and services
        agreement_details:
          type: string
          description: Agreement details
        purpose_code:
          type: string
          description: Purpose code for international transactions
    MerchantDetails:
      type: object
      required:
        - id
        - settlement_details
        - created_at
        - updated_at
        - invoice_file
        - company_details
      properties:
        id:
          type: string
          description: Unique merchant identifier
        settlement_details:
          $ref: '#/components/schemas/SettlementDetails'
        created_at:
          type: string
          format: date-time
          description: Merchant creation timestamp
        updated_at:
          type: string
          format: date-time
          description: Merchant update timestamp
        invoice_file:
          type: string
          description: Invoice file URL
        company_details:
          $ref: '#/components/schemas/CompanyDetails'
    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
  securitySchemes:
    clientAuth:
      type: apiKey
      name: X-Client-ID
      in: header
      description: Client app ID. You can find your app id in the merchant dashboard.
    clientSecretAuth:
      type: apiKey
      name: X-Client-Secret
      in: header
      description: Client secret key. You can find your secret in the merchant dashboard.

````