Approve Merchant Creation API
Approve a pending merchant creation request by providing the onboarding request ID and the required merchant configuration. Available to authorized Super Admin and Partner users.
Overview
The Approve Merchant Creation API is used to approve a merchant creation request during the onboarding process. It accepts the onboarding request ID in the URL and the merchant configuration in the request body.
HTTP Method: POST
Endpoint: /api/v1/merchant-onboard/approve/{id}
Access Levels: SUPER_ADMIN, PARTNER
Authentication
Include your API key in the request headers.
| Header | Value |
|---|---|
X-API-KEY | YOUR_API_KEY |
Accept | */* |
Content-Type | application/json |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | UUID | Yes | Identifier of the merchant onboarding request to approve. |
Request Body
The request body must be provided in JSON format and contains merchant details, business information, fee configuration, settlement settings, and optional Moyasar configuration.
Merchant Information
| Field | Type | Description |
|---|---|---|
emailAddress | String | Merchant email address. |
registeredMobileNumber | String | Registered mobile number. |
country | String | Merchant's country. |
city | String | Merchant's city. |
parentBusinessUnitId | UUID | Identifier of the parent business unit. |
businessCategoryId | UUID | Identifier of the merchant's business category. |
currencyCode | String | Currency code associated with the merchant. |
name | String | Merchant name. |
nameAR | String | Merchant name in Arabic. |
active | Boolean | Indicates whether the merchant is active. |
feeProfileId | Integer | Identifier of the applicable fee profile. |
Logo Object
The logo object contains the merchant's logo file information.
| Field | Type | Description |
|---|---|---|
fileSize | Number | File size. |
fileUrl | String | File URL. |
fileName | String | File name. |
Fee Configuration
The feeSetup object defines percentage-based and fixed fees for supported payment categories.
Each fee object contains:
| Field | Type | Description |
|---|---|---|
percentageRate | Number | Percentage fee rate. |
fixedAmount | Number | Fixed fee amount. |
Supported fee configuration objects:
madavisaMcapplePayrefund
Settlement and Moyasar Settings
| Field | Type | Description |
|---|---|---|
settlementCycle | String | Settlement cycle. The documented example uses T_PLUS_0. |
enableMoyasar | Boolean | Indicates whether Moyasar integration is enabled. |
moyasar | Object | Moyasar configuration, including business details, payment methods, fees, and documents. |
moyasarFeesPresentWhenEnabled | Boolean | Indicates whether Moyasar fees are present when Moyasar is enabled. |
Moyasar Object
The moyasar object includes the following fields:
| Field | Type | Description |
|---|---|---|
type | String | Business or entity type. |
name | String | Business name. |
country | String | Country. |
email | String | Email address. |
adminEmail | String | Administrator email address. |
ownersCount | Integer | Number of owners. |
signatory | String | Signatory information. |
activityLicenseRequired | Boolean | Indicates whether an activity license is required. |
website | String | Business website. |
publicName | String | Public-facing business name. |
signatoryCount | Integer | Number of signatories. |
timeZone | String | Configured time zone. |
statementDescriptor | String | Statement descriptor. |
enabledSchemes | Array of Strings | Enabled card schemes. |
paymentMethods | Array of Strings | Configured payment methods. |
fees | Array of Objects | Fee configuration for Moyasar. |
taxInclusive | Boolean | Indicates whether fees or prices are tax-inclusive, as defined by the integration. |
documents | Array of Objects | Business documents and associated metadata. |
Each object in the fees array contains:
family— Stringrate— Numberfixed— Numbercap— Number
Each object in the documents array contains:
type— Stringfile— Object containingfileSize,fileUrl, andfileNameinfo— Object containing additional document information
cURL Example
curl -X POST "https://app-api.edfapay.com/api/v1/merchant-onboard/approve/{id}" \
-H "X-API-KEY: YOUR_API_KEY" \
-H "Accept: */*" \
-H "Content-Type: application/json" \
-d '{
"emailAddress": "[email protected]",
"registeredMobileNumber": "+966500000000",
"country": "Saudi Arabia",
"city": "Riyadh",
"parentBusinessUnitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"businessCategoryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"logo": {
"fileSize": 0,
"fileUrl": "https://example.com/logo.png",
"fileName": "logo.png"
},
"currencyCode": "SAR",
"name": "Example Merchant",
"nameAR": "متجر تجريبي",
"active": true,
"feeProfileId": 0,
"feeSetup": {
"mada": {
"percentageRate": 0,
"fixedAmount": 0
},
"visaMc": {
"percentageRate": 0,
"fixedAmount": 0
},
"applePay": {
"percentageRate": 0,
"fixedAmount": 0
},
"refund": {
"percentageRate": 0,
"fixedAmount": 0
}
},
"settlementCycle": "T_PLUS_0",
"enableMoyasar": false,
"moyasarFeesPresentWhenEnabled": false
}'Important: This cURL is an illustrative request template, not a guaranteed valid production payload. Replace the path ID and example values with the actual onboarding request ID and merchant data. The complete request schema includes the moyasar object; provide its fields according to the merchant's configuration and the API's validation requirements.
Responses
200 — OK
The API returns a response envelope containing the response code, message, error code, and data.
Example response:
{
"code": 0,
"message": "string",
"errorCode": "string",
"data": "string"
}| Field | Description |
|---|---|
code | Response code. |
message | Response message. |
errorCode | Error identifier, if provided. |
data | Response data returned by the API. The documented example represents this field as a string. |
400 — Bad Request
Returned when the request cannot be processed, such as when the request data is invalid or fails validation.
Example response:
{
"code": 0,
"message": "string",
"errorCode": "string",
"data": {}
}Implementation Notes
- Use the onboarding request UUID as the
idpath parameter. - Send the request body as JSON.
- Ensure the merchant, business category, parent business unit, fee profile, and fee configuration values match the intended setup.
- Configure Moyasar-related fields according to the intended integration setup.
- The provided API specification does not define the exact approval business rules or the detailed validation requirements for every field. Confirm these requirements against the implementation before using the endpoint in production.
Updated 25 days ago