Update Partner API
Updates an existing partner's profile and configuration details within the EdfaPay platform. Access is restricted to authorized Super Admin and Partner users.
Overview
The Update Partner API allows authorized users to modify the details of an existing partner within the EdfaPay platform.
HTTP Method: PUT
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
The request body is required and must be provided in JSON format.
| Field | Type | Description |
|---|---|---|
id | UUID | Unique identifier of the partner to update. |
logo | Object | Partner logo metadata, including file size, URL, and filename. |
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. |
merchantManagementEnabled | Boolean | Indicates whether merchant management is enabled for the partner. |
feeProfileId | Integer | Identifier of the associated fee profile. |
Example Request Body
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"logo": {
"fileSize": 0,
"fileUrl": "string",
"fileName": "string"
},
"name": "string",
"nameAR": "string",
"emailAddress": "string",
"registeredMobileNumber": "+9197913915454401",
"address": "string",
"domain": "string",
"active": true,
"merchantManagementEnabled": true,
"feeProfileId": 0
}Request Example
curl -X PUT "https://app-api.edfapay.com/api/v1/partner" \
-H "X-API-KEY: YOUR_API_KEY" \
-H "Accept: */*" \
-H "Content-Type: application/json" \
-d '{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"logo": {
"fileSize": 0,
"fileUrl": "string",
"fileName": "string"
},
"name": "string",
"nameAR": "string",
"emailAddress": "string",
"registeredMobileNumber": "+9197913915454401",
"address": "string",
"domain": "string",
"active": true,
"merchantManagementEnabled": true,
"feeProfileId": 0
}'Responses
200 — OK
The request was processed successfully.
Example response:
{
"code": 0,
"message": "string",
"errorCode": "string",
"data": {}
}400 — Bad Request
The request could not be processed due to invalid input or other request-related errors.
Example response:
{
"code": 0,
"message": "string",
"errorCode": "string",
"data": {}
}Notes
- Use a valid partner UUID in the
idfield. - Ensure the authenticated user has the required access level.
- The response examples reflect the Swagger documentation; specific error codes and validation rules are not detailed in the provided schema.
Updated 25 days ago
Did this page help you?