Skip to main content
GET
/
partners
/
merchants
List Merchants
curl --request GET \
  --url https://api-pacb-uat.eximpe.com/partners/merchants/ \
  --header 'X-API-Version: <api-key>' \
  --header 'X-Client-ID: <api-key>' \
  --header 'X-Client-Secret: <api-key>'
{
  "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"
      }
    ]
  }
}

​
Overview

Retrieve a paginated list of all sub-merchants under the authenticated PSP account.

​
Request Parameters

​
Query Parameters

NameTypeRequiredDescription
pageintegerNoPage number (default: 1)
page_sizeintegerNoNumber of results per page (default: 10)
searchstringNoSearch by brand name or legal name
orderingstringNoSort field. Prefix with - for descending. Options: created_at, last_updated_at

​
Response

NameTypeDescription
idstringUnique merchant identifier
brand_namestringBrand/trade name of the sub-merchant
kyc_statusstringCurrent KYC status (PENDING, IN_REVIEW, CHANGES_REQUESTED, APPROVED, REJECTED)
created_atstringISO 8601 timestamp of creation

​
Response Example

{
  "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"
      }
    ]
  }
}

Authorizations

​
X-Client-ID
string
header
required

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-Client-Secret
string
header
required

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-API-Version
string
header
required

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.

Response

A paginated list of merchants.

​
success
boolean
​
message
string
​
data
object