post
https://demo-api.edfapay.com/api/v1/branches
Create new Branch, 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 branch.
Endpoint
POST https://demo-api.edfapay.com/api/v1/branches
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| name | String | Yes | Branch name |
| nameAR | String | Yes | Arabic name |
| address | String | No | Address |
| countryCode | String | Yes | Country code |
| cityId | Integer | Yes | City ID |
| active | Boolean | Yes | Status |
| parentBusinessUnitId | UUID | Yes | Business unit ID |
Request Example
curl --location 'https://demo-api.edfapay.com/api/v1/branches' \
--header 'X-API-KEY: <Your API Key>' \
--header 'Content-Type: application/json' \
--data '{
"name": "Test Branch",
"nameAR": "فرع",
"address": "Test Address",
"countryCode": "818",
"cityId": 8,
"active": true,
"parentBusinessUnitId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}'Response Body
| Field | Type | Description |
|---|---|---|
| code | Integer | Status |
| message | String | Message |
| data.id | UUID | Created branch ID |
| data.name | String | Branch name |
| data.nameAR | String | Arabic name |
| data.businessUnitId | UUID | Business unit |
| data.address | String | Address |
| data.countryCode | String | Country |
| data.cityId | Integer | City |
| data.active | Boolean | Status |
Response Example
{
"code": 200,
"message": "Success",
"data": {
"id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"name": "Test Branch",
"nameAR": "فرع",
"businessUnitId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"address": "Test Address",
"countryCode": "818",
"cityId": 8,
"active": true
}
}