Delete Partner API

Deletes an existing partner using its unique partner ID. This endpoint is available to authorized Super Admin and Partner users.

Overview

The Delete Partner API allows authorized users to delete an existing partner record by providing its unique identifier.

HTTP Method: DELETE

Endpoint: /api/v1/partner/{partnerId}

Access Levels: SUPER_ADMIN, PARTNER

Authentication

Include your API key in the request headers.

HeaderValue
X-API-KEYYOUR_API_KEY
Accept*/*

Path Parameters

ParameterTypeRequiredDescription
partnerIdUUID (string)YesThe unique identifier of the partner to delete.

cURL Example

curl -X DELETE "https://app-api.edfapay.com/api/v1/partner/{partnerId}" \
  -H "X-API-KEY: YOUR_API_KEY" \
  -H "Accept: */*"

Replace {partnerId} with the UUID of the partner you want to delete.

Example Request

DELETE /api/v1/partner/3fa85f64-5717-4562-b3fc-2c963f66afa6

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 because of invalid input or another request-related error.

Example response:

{
  "code": 0,
  "message": "string",
  "errorCode": "string",
  "data": {}
}

Implementation Notes

  • Provide a valid UUID in the partnerId path parameter.
  • Ensure the authenticated user has the required access level.
  • Review the response fields code, message, and errorCode to determine the request outcome.
  • The API specification does not state whether deletion is permanent or whether additional business rules apply.

Did this page help you?