post
https://demo-api.edfapay.com/api/v1/merchant
Create new Merchant, ACCESS LEVEL: SUPER_ADMIN, PARTNER, MERCHANT
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Overview
Create a new merchant.
Endpoint
POST https://demo-api.edfapay.com/api/v1/merchant
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| emailAddress | String | Yes | Merchant email |
| registeredMobileNumber | String | Yes | Phone |
| country | String | Yes | Country code |
| city | String | Yes | City ID |
| parentBusinessUnitId | UUID | Yes | Parent business |
| businessCategoryId | UUID | Yes | Category |
| currencyCode | String | Yes | Currency |
| name | String | Yes | Name |
| nameAR | String | Yes | Arabic name |
| active | Boolean | Yes | Status |
| logo | Object | No | Logo object |
Request Example
curl --location 'https://demo-api.edfapay.com/api/v1/merchant' \
--header 'X-API-KEY: <Your API Key>' \
--header 'Content-Type: application/json' \
--data '{
"emailAddress": "[email protected]",
"registeredMobileNumber": "+966-500000000",
"country": "682",
"city": "7",
"parentBusinessUnitId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"businessCategoryId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"currencyCode": "682",
"name": "Test Merchant",
"nameAR": "تاجر",
"active": true,
"logo": {
"fileSize": 0,
"fileUrl": "",
"fileName": ""
}
}'Response Body
| Field | Type | Description |
|---|---|---|
| code | Integer | Status |
| message | String | Message |
| data.id | UUID | Merchant ID |
| data.name | String | Name |
| data.emailAddress | String | |
| data.registeredMobileNumber | String | Phone |
| data.status | String | Status |
| data.active | Boolean | Active |
Response Example
{
"code": 200,
"message": "Success",
"data": {
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "Test Merchant",
"emailAddress": "[email protected]",
"registeredMobileNumber": "+966-500000000",
"status": "ACTIVE",
"active": true
}
}