Delete Multiple Merchants API
Deletes multiple merchant records in a single request by accepting an array of merchant UUIDs. Supports SUPER_ADMIN, PARTNER, and MERCHANT access levels, subject to the authenticated user's permissions.
1. Overview
The Delete Multiple Merchants API allows authorized users to delete multiple merchant records in a single request by providing an array of merchant UUIDs.
This endpoint is designed for batch deletion, allowing multiple merchants to be submitted together instead of sending a separate request for each merchant.
Access Levels: SUPER_ADMIN, PARTNER, MERCHANT
2. Endpoint Details
| Property | Value |
|---|---|
| API Name | Delete Multiple Merchants |
| HTTP Method | PATCH |
| Endpoint | /api/v1/merchant/batch-delete |
| Production Base URL | https://app-api.edfapay.com |
| Content-Type | application/json |
| Accept | */* |
| Request Body | Required |
3. Authentication
Include the API key in the request headers.
| Header | Value |
|---|---|
X-API-KEY | YOUR_API_KEY |
Content-Type | application/json |
Accept | */* |
4. Request Body
The request body must be a JSON array containing the UUIDs of the merchants to delete.
Request Schema
| Field | Type | Description |
|---|---|---|
| Request body | Array of UUID strings | List of merchant identifiers to submit for deletion. |
Example Request
[
"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"7b4c5d6e-1234-4567-8901-abcdef123456"
]Each array element represents a merchant UUID. Replace the example identifiers with valid merchant IDs.
5. cURL Example
curl --request PATCH \
--url 'https://app-api.edfapay.com/api/v1/merchant/batch-delete' \
--header 'X-API-KEY: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--data '[
"3fa85f64-5717-4562-b3fc-2c963f66afa6",
"7b4c5d6e-1234-4567-8901-abcdef123456"
]'6. Responses
6.1 HTTP 200 — OK
Description: The request was processed successfully.
Example response:
{
"code": 0,
"message": "string",
"errorCode": "string",
"data": {}
}6.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 examples above reflect the documented Swagger structure. The exact response values and error details depend on the API response.
7. Implementation Notes
- Provide the merchant identifiers as a JSON array of UUID strings.
- Ensure the supplied identifiers correspond to the intended merchant records.
- The endpoint is documented with
PATCHas its HTTP method; use this method when sending the request. - The Swagger documentation lists
SUPER_ADMIN,PARTNER, andMERCHANTas supported access levels. Actual permissions may depend on the authenticated user's assigned role. - The documented responses include HTTP
200and400. - The supplied schema does not specify whether deletion is permanent or soft deletion, whether partial deletion is supported, or how individual merchant failures are reported.
8. Summary
The Delete Multiple Merchants API submits multiple merchant UUIDs in one request for batch deletion. It returns a standard response envelope containing code, message, errorCode, and data.
Updated 25 days ago