Search Merchant Onboarding Requests API
Retrieve and filter merchant onboarding requests using search criteria, business unit hierarchy, status, creation date range, and pagination. Available to authorized Super Admin and Partner users.
Overview
This endpoint retrieves merchant onboarding requests based on the specified search criteria and pagination settings. It supports filtering by text, active status, creation date range, and business unit hierarchy.
HTTP Method: GET
Endpoint: /api/v1/merchant-onboard/search
Access Levels: SUPER_ADMIN, PARTNER
Base URL: https://app-api.edfapay.com
Authentication and Headers
| Header | Value |
|---|---|
X-API-KEY | YOUR_API_KEY |
Accept | */* |
Query Parameters
The endpoint requires two query parameters: pageProperties and searchCriteria. Both are defined as objects in the API specification.
1. pageProperties
pagePropertiesDefines pagination and sorting preferences.
| Field | Type | Example | Description |
|---|---|---|---|
pageNumber | Integer | 0 | Page number to retrieve. |
pageSize | Integer | 10 | Number of records requested per page. |
sortDirection | String | ASC | Sort direction shown in the example. |
sortBy | String | createdAt | Field used for sorting; use a supported field name. |
Example:
{
"pageNumber": 0,
"sortDirection": "ASC",
"pageSize": 10,
"sortBy": "createdAt"
}2. searchCriteria
searchCriteriaDefines the filters used to retrieve onboarding requests.
| Field | Type | Example | Description |
|---|---|---|---|
text | String | "merchant" | Text-based search criterion. The exact fields searched are not specified in the schema. |
active | Boolean | true | Filters by active status. |
createdTimeTo | String (date) | "2026-10-28" | Upper date boundary for creation-time filtering. |
createdTimeFrom | String (date) | "2026-10-01" | Lower date boundary for creation-time filtering. |
businessUnitHierarchies | Array of UUIDs | ["3fa85f64-5717-4562-b3fc-2c963f66afa6"] | Business unit hierarchy identifiers used to filter the results. |
Example:
{
"text": "merchant",
"active": true,
"createdTimeTo": "2026-10-28",
"createdTimeFrom": "2026-10-01",
"businessUnitHierarchies": [
"3fa85f64-5717-4562-b3fc-2c963f66afa6"
]
}Note: The examples above illustrate the structure of each query object. The actual serialization of these objects into URL query parameters must follow the API's implementation. Use Swagger's Try it out feature to confirm the exact request URL and encoding.
cURL Example
The following is a request template. Replace the query string with the exact serialization generated by Swagger for pageProperties and searchCriteria.
curl -X GET \
"https://app-api.edfapay.com/api/v1/merchant-onboard/search" \
-H "X-API-KEY: YOUR_API_KEY" \
-H "Accept: */*"Responses
200 — OK
Returns a response envelope containing pagination metadata and the matching onboarding records.
The documented response structure includes the following fields.
Response Envelope
| Field | Type | Description |
|---|---|---|
code | Number | Response code. |
message | String | Response message. |
errorCode | String | Error identifier, if provided. |
data | Object | Paginated result set. |
Pagination Data
| Field | Type | Description |
|---|---|---|
totalPages | Integer | Total number of pages. |
totalElements | Integer | Total number of matching records. |
size | Integer | Page size reported in the response. |
content | Array | Onboarding records for the current page. The item schema is not expanded in the supplied specification. |
number | Integer | Current page number. |
pageable | Object | Pagination and sorting metadata. |
sort | Array | Sorting information. |
numberOfElements | Integer | Number of records in the current page. |
first | Boolean | Indicates whether this is the first page. |
last | Boolean | Indicates whether this is the last page. |
empty | Boolean | Indicates whether the current page contains no records. |
pageable Object
pageable ObjectThe documented pageable object contains:
offset— Numberpaged— BooleanpageNumber— NumberpageSize— Numbersort— Array of sorting metadataunpaged— Boolean
Each sorting metadata object contains:
direction— StringnullHandling— Stringascending— Booleanproperty— StringignoreCase— Boolean
Example Response
{
"code": 0,
"message": "string",
"errorCode": "string",
"data": {
"totalPages": 0,
"totalElements": 0,
"size": 10,
"content": [],
"number": 0,
"pageable": {
"offset": 0,
"paged": true,
"pageNumber": 0,
"pageSize": 10,
"sort": [],
"unpaged": false
},
"sort": [],
"numberOfElements": 0,
"first": true,
"last": true,
"empty": true
}
}This example illustrates the documented response structure; actual values depend on the search results.
400 — Bad Request
Returned when the request is invalid or cannot be processed.
{
"code": 0,
"message": "string",
"errorCode": "string",
"data": {}
}Implementation Notes
- Provide both
pagePropertiesandsearchCriteriaas required by the API specification. - Use valid UUIDs for entries in
businessUnitHierarchies. - Ensure the date filters follow the documented
YYYY-MM-DDformat. - Check the pagination metadata to determine whether additional pages are available.
- Confirm query-object serialization in Swagger before implementing the request in an application.
- The supplied schema does not define the structure of individual objects inside
content; consult the detailed API schema or a real response to document those fields accurately.
Updated 25 days ago