Merchant Onboarding Management APIs
API documentation for managing the merchant onboarding lifecycle, including onboarding approval, request search, and merchant creation workflows for authorized Super Admin and Partner users.
Overview
The Merchant Onboarding Management APIs provide endpoints for managing merchant onboarding requests throughout the onboarding lifecycle. These APIs support authorized users in reviewing onboarding requests, approving merchant creation, and retrieving onboarding records using search and pagination criteria.
This section documents the available endpoints, their required parameters, request payloads, authentication requirements, and response formats.
Available Operations
1. Approve Merchant Creation
Approve a merchant creation request using its onboarding request ID. The endpoint accepts the merchant configuration and onboarding details required by the API.
HTTP Method: POST
Endpoint: /api/v1/merchant-onboard/approve/{id}
Access Levels: SUPER_ADMIN, PARTNER
See the Approve Merchant Creation endpoint documentation for the required request body and response details.
2. Search Merchant Onboarding Requests
Retrieve onboarding requests using configurable search criteria and pagination settings. The documented filters include text, active status, creation date range, and business unit hierarchy.
HTTP Method: GET
Endpoint: /api/v1/merchant-onboard/search
Access Levels: SUPER_ADMIN, PARTNER
See the Search Merchant Onboarding Requests endpoint documentation for query parameters, filtering options, and pagination response details.
Authentication
Authenticate requests using the API key configured for your environment.
| Header | Value |
|---|---|
X-API-KEY | YOUR_API_KEY |
Accept | */* |
Production Base URL: https://app-api.edfapay.com
Use the appropriate credentials and environment configuration for your integration.
Response Format
The documented endpoints use a standard response envelope with fields such as:
code— Response code.message— Response message.errorCode— Error identifier, when provided.data— Response payload, which varies by endpoint.
Refer to each endpoint's documentation for its specific response schema and HTTP status codes.
Access and Usage Guidelines
- Ensure your account has the required access level before calling an endpoint.
- Supply all required path and query parameters.
- Follow the request schema documented for the selected operation.
- Validate API responses and handle unsuccessful requests appropriately.
- Use the endpoint-specific documentation as the authoritative reference for required fields and supported values.
Related Documentation
- Approve Merchant Creation — Review the request structure and approval endpoint details.
- Search Merchant Onboarding Requests — Review search filters, pagination parameters, and response metadata.
Updated 25 days ago