Create Partner API
Creates a new partner account within the EdfaPay platform using the provided business, contact, and configuration details.
Overview
The Create Partner API enables authorized users to register a new partner within the EdfaPay platform. The request includes the partner's business information, contact details, logo metadata, fee profile, and merchant management settings.
HTTP Method: POST
Endpoint: /api/v1/partner
Access Levels: SUPER_ADMIN, PARTNER
Content-Type: application/json
Authentication
Include the API key in the request header:
X-API-KEY: YOUR_API_KEY
Request Body
A JSON request body is required.
| Field | Type | Description |
|---|---|---|
parentBusinessUnitId | UUID | Identifier of the parent business unit. |
logo | Object | Partner logo metadata. |
logo.fileSize | Number | Size of the logo file. |
logo.fileUrl | String | URL of the logo file. |
logo.fileName | String | Name of the logo file. |
name | String | Partner name. |
nameAR | String | Partner name in Arabic. |
emailAddress | String | Partner email address. |
registeredMobileNumber | String | Registered mobile number. |
address | String | Partner address. |
domain | String | Partner domain. |
active | Boolean | Indicates whether the partner is active. |
feeProfileId | Integer | Identifier of the associated fee profile. |
merchantManagementEnabled | Boolean | Indicates whether merchant management is enabled for the partner. |
Example Request Body
{
"parentBusinessUnitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"logo": {
"fileSize": 0,
"fileUrl": "string",
"fileName": "string"
},
"name": "string",
"nameAR": "string",
"emailAddress": "string",
"registeredMobileNumber": "+7412-496023800564",
"address": "string",
"domain": "string",
"active": true,
"feeProfileId": 0,
"merchantManagementEnabled": true
}cURL Example
curl -X POST "https://app-api.edfapay.com/api/v1/partner" \
-H "X-API-KEY: YOUR_API_KEY" \
-H "Accept: */*" \
-H "Content-Type: application/json" \
-d '{
"parentBusinessUnitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"logo": {
"fileSize": 0,
"fileUrl": "string",
"fileName": "string"
},
"name": "string",
"nameAR": "string",
"emailAddress": "string",
"registeredMobileNumber": "+7412-496023800564",
"address": "string",
"domain": "string",
"active": true,
"feeProfileId": 0,
"merchantManagementEnabled": true
}'Responses
200 — OK
The request was processed successfully.
{
"code": 0,
"message": "string",
"errorCode": "string",
"data": {}
}400 — Bad Request
The request could not be processed because of invalid input or another request-related error.
{
"code": 0,
"message": "string",
"errorCode": "string",
"data": {}
}Implementation Notes
- Provide the parent business unit identifier in a valid UUID format.
- Ensure the authenticated user has the required access permissions.
- Use valid contact information and partner configuration values.
- Refer to the API response for the result of the request.
- Required-field validation rules beyond the request body's required status are not specified in the provided Swagger example.
Updated 25 days ago
Did this page help you?