Skip to main content
GET
/
v1
/
merchants
List Merchants
curl --request GET \
  --url https://olp-api.nipuntheekshana.com/v1/merchants

Documentation Index

Fetch the complete documentation index at: https://docs-openpay.nipuntheekshana.com/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint requires admin-level authentication. Regular merchants cannot access this endpoint.

​
Query Parameters

​
page
integer
default:"1"
Page number for pagination.
​
limit
integer
default:"20"
Number of merchants per page. Maximum 100.
​
status
string
Filter by merchant status. One of active, pending_verification, suspended, deactivated.
​
search
string
Search merchants by business name or email.

​
Example Response (200)

{
  "data": [
    {
      "id": "merch_abc123",
      "businessName": "Acme Payments Ltd",
      "email": "admin@acmepay.com",
      "businessType": "company",
      "status": "active",
      "createdAt": "2026-03-26T10:00:00Z"
    },
    {
      "id": "merch_def456",
      "businessName": "Island Crafts",
      "email": "hello@islandcrafts.lk",
      "businessType": "individual",
      "status": "pending_verification",
      "createdAt": "2026-03-25T08:15:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 42,
    "totalPages": 3
  }
}

​
Error Responses

403 Forbidden
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Admin access required"
  }
}