> ## 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. # List Merchants > Retrieve a list of merchants with pagination. ## Overview Retrieve a paginated list of all sub-merchants under the authenticated PSP account. ## Request Parameters #### Query Parameters | Name | Type | Required | Description | | ---------- | ------- | -------- | ------------------------------------------------------------------------------------ | | page | integer | No | Page number (default: 1) | | page\_size | integer | No | Number of results per page (default: 10) | | search | string | No | Search by brand name or legal name | | ordering | string | No | Sort field. Prefix with `-` for descending. Options: `created_at`, `last_updated_at` | ## Response | Name | Type | Description | | ----------- | ------ | ---------------------------------------------------------------------------------------- | | id | string | Unique merchant identifier | | brand\_name | string | Brand/trade name of the sub-merchant | | kyc\_status | string | Current KYC status (`PENDING`, `IN_REVIEW`, `CHANGES_REQUESTED`, `APPROVED`, `REJECTED`) | | created\_at | string | ISO 8601 timestamp of creation | ## Response Example ```json Success theme={null} { "success": true, "message": "Request processed successfully.", "data": { "count": 3, "page": 1, "page_size": 10, "next": null, "previous": null, "results": [ { "id": "6692437779", "brand_name": "Acme", "kyc_status": "PENDING", "created_at": "2026-04-28T07:54:33.468589Z" }, { "id": "6182929449", "brand_name": "GlobalShop", "kyc_status": "APPROVED", "created_at": "2026-04-27T10:30:00.000000Z" }, { "id": "5813168537", "brand_name": "Innovate", "kyc_status": "CHANGES_REQUESTED", "created_at": "2026-04-26T14:20:00.000000Z" } ] } } ``` ```json Empty List theme={null} { "success": true, "message": "Request processed successfully.", "data": { "count": 0, "page": 1, "page_size": 10, "next": null, "previous": null, "results": [] } } ``` ## OpenAPI ````yaml GET /partners/merchants/ 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/: get: tags: - Merchants summary: List Merchants description: Retrieve a list of merchants with pagination. operationId: v1_get_partners_merchants_ responses: '200': description: A paginated list of merchants. content: application/json: schema: $ref: '#/components/schemas/v1_ListMerchantsResponse' example: success: true message: Sub-merchants retrieved successfully data: count: 4 page: 1 page_size: 250 next: null previous: null results: - id: '3604346598' brand_name: InnovateTech Solutions kyc_status: APPROVED created_date: '2024-11-19T18:06:05.523720Z' - id: '8319446548' brand_name: DigitalCraft Enterprises kyc_status: PENDING created_date: '2024-11-19T17:43:25.467834Z' - id: '2343915596' brand_name: CloudSync Technologies kyc_status: APPROVED created_date: '2024-11-19T16:43:53.317062Z' - id: '4455704961' brand_name: NextGen Software Ltd kyc_status: PENDING created_date: '2024-11-19T08:53:22.411374Z' '401': description: Unauthorized - Invalid credentials. content: application/json: schema: $ref: '#/components/schemas/v1_ErrorResponse' example: success: false error: code: ERR_AUTH_000 message: Missing credentials details: authentication: Missing credentials. security: - clientAuth: [] clientSecretAuth: [] apiVersionHeader: [] components: schemas: v1_ListMerchantsResponse: type: object properties: success: type: boolean message: type: string data: type: object properties: count: type: integer page: type: integer page_size: type: integer next: type: string nullable: true previous: type: string nullable: true results: type: array items: $ref: '#/components/schemas/v1_MerchantInList' 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_MerchantInList: type: object properties: id: type: string description: Unique merchant identifier brand_name: type: string description: Brand/trading name of the merchant kyc_status: type: string description: KYC verification status enum: - PENDING - IN_REVIEW - CHANGES_REQUESTED - APPROVED - REJECTED created_date: type: string format: date-time description: Merchant creation timestamp 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 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 ````