Delete User API

Deletes an existing user by their unique user ID. Available to SUPER_ADMIN, PARTNER, MERCHANT, and BRANCH roles.

Overview

The Delete User API deletes an existing user identified by their unique user ID.

  • HTTP Method: DELETE
  • Endpoint: /api/v1/users/user/USERID
  • Access Levels: SUPER_ADMIN, PARTNER, MERCHANT, BRANCH

Authentication

Include your API key in the request headers.

HeaderValue
X-API-KEYYOUR_API_KEY
Accept*/*

Production Base URL: https://app-api.edfapay.com

Path Parameters

ParameterTypeRequiredDescription
userIdUUIDYesThe unique identifier of the user to delete.

Request Example

cURL

curl --request DELETE \
  --url 'https://app-api.edfapay.com/api/v1/users/user/USERID' \
  --header 'X-API-KEY: YOUR_API_KEY' \
  --header 'Accept: */*'

Replace USERID with the UUID of the user you want to delete.

Example URL

https://app-api.edfapay.com/api/v1/users/user/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 due to invalid input or a malformed userId.

Example response:

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

Integration Notes

  • Provide a valid UUID in the userId path parameter.
  • Ensure the API key is valid and the caller has the required access level.
  • Confirm the target user before submitting the deletion request.
  • The provided API specification does not define whether deletion is permanent or soft deletion, nor does it specify a separate response for a user that does not exist.

Did this page help you?