Delete Merchant API
Deletes an existing merchant using its unique merchant UUID. Supports SUPER_ADMIN, PARTNER, and MERCHANT access levels, subject to the authenticated user's permissions.
1. Overview
The Delete Merchant API allows authorized users to delete an existing merchant by providing its unique merchant ID.
The endpoint accepts the merchant UUID as a path parameter and processes the deletion request.
Access Levels: SUPER_ADMIN, PARTNER, MERCHANT
2. Endpoint Details
| Property | Value |
|---|---|
| API Name | Delete Merchant |
| HTTP Method | DELETE |
| Endpoint | /api/v1/merchant/{merchantId} |
| Production Base URL | https://app-api.edfapay.com |
| Accept | */* |
| Request Body | Not required |
3. Authentication
Include the API key in the request headers.
| Header | Value |
|---|---|
X-API-KEY | YOUR_API_KEY |
Accept | */* |
4. Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
merchantId | UUID string | Yes | Unique identifier of the merchant to delete. |
5. Request Example
Replace {merchantId} with the UUID of the merchant you want to delete.
DELETE /api/v1/merchant/3fa85f64-5717-4562-b3fc-2c963f66afa66. cURL Example
curl --request DELETE \
--url 'https://app-api.edfapay.com/api/v1/merchant/3fa85f64-5717-4562-b3fc-2c963f66afa6' \
--header 'X-API-KEY: YOUR_API_KEY' \
--header 'Accept: */*'7. Responses
7.1 HTTP 200 — OK
Description: The request was processed successfully.
Example response:
{
"code": 0,
"message": "string",
"errorCode": "string",
"data": {}
}7.2 HTTP 400 — Bad Request
Description: The request could not be processed due to invalid request data or another request-related issue.
Example response:
{
"code": 0,
"message": "string",
"errorCode": "string",
"data": {}
}The response values shown are Swagger placeholders. Actual values depend on the API implementation.
8. Implementation Notes
- Provide a valid UUID for the
merchantIdpath parameter. - Use the
DELETEHTTP method. - No request body is required.
- Include the API key in the
X-API-KEYheader. - The documented access levels are
SUPER_ADMIN,PARTNER, andMERCHANT, subject to the authenticated user's permissions. - The documented responses include HTTP
200and400. - The supplied documentation does not specify whether deletion is permanent or soft deletion.
9. Summary
The Delete Merchant API submits a deletion request for a specific merchant using its UUID and returns the result in the standard EdfaPay response envelope.
Updated 25 days ago