get
https://demo-api.edfapay.com/api/v1/merchant/search
Search & Retrieve Merchants, ACCESS LEVEL: SUPER_ADMIN, PARTNER, MERCHANT
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Overview
Retrieve a paginated list of merchants with optional filtering.
Endpoint
GET https://demo-api.edfapay.com/api/v1/merchant/search
Query Parameters
| Field | Type | Required | Description |
|---|---|---|---|
| pageNumber | Integer | Yes | Page number |
| pageSize | Integer | Yes | Number of records |
| text | String | No | Search by merchant name |
| active | Boolean | No | Filter active merchants |
| createdTimeFrom | Date | No | Filter from date |
| createdTimeTo | Date | No | Filter to date |
| emailAddress | String | No | Filter by email |
Request Example
curl --location 'https://demo-api.edfapay.com/api/v1/merchant/search?pageNumber=0&pageSize=10&text=test&active=true' \
--header 'X-API-KEY: <Your API Key>'Response Body
| Field | Type | Description |
|---|---|---|
| code | Integer | Status |
| message | String | Message |
| data.content | Array | Merchant list |
| data.content[].id | UUID | Merchant ID |
| data.content[].name | String | Merchant name |
| data.content[].nameAR | String | Arabic name |
| data.content[].emailAddress | String | |
| data.content[].registeredMobileNumber | String | Phone |
| data.content[].businessUnitId | UUID | Business unit |
| data.content[].countryCode | String | Country |
| data.content[].cityId | Integer | City |
| data.content[].status | String | Status |
| data.content[].active | Boolean | Active flag |
| data.number | Integer | Page number |
| data.size | Integer | Page size |
| data.totalElements | Integer | Total records |
| data.totalPages | Integer | Total pages |
Response Example
{
"code": 200,
"message": "Success",
"data": {
"content": [
{
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "Test Merchant",
"nameAR": "تاجر",
"emailAddress": "[email protected]",
"registeredMobileNumber": "+966-500000000",
"businessUnitId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"countryCode": "682",
"cityId": 7,
"status": "ACTIVE",
"active": true
}
],
"number": 0,
"size": 10,
"totalElements": 1,
"totalPages": 1
}
}