Skip to main content
DELETE
/
v2.01
/
{ClientId}
/
users
/
natural
/
{UserId}
// DELETE has no body parameters

Documentation Index

Fetch the complete documentation index at: https://docs.mangopay.com/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint allows your platform to close a Mangopay Account, as per Mangopay’s terms and conditions, in the event that the agreement between the user and the platform comes to an end.
Caution – Closure is irreversibleCalling this endpoint immediately and permanently changes the UserStatus to CLOSED if the API call is successful. This cannot be undone, even by Mangopay.Your platform can re-register the user using POST Create a Natural User (SCA).
Closure is only possible if all wallets held by the user are empty. Closure is allowed for both UserCategory OWNER and PAYER. When a User is closed (whether via this endpoint or by Mangopay):
  • The UserStatus changes to CLOSED (and the USER_ACCOUNT_CLOSED webhook is sent)
  • The user has inflows and outflows blocked (and the relevant webhooks are sent)
  • The user object remains available via the API and Dashboard for historical purposes
Closing a user account does not affect Mangopay’s data retention obligations or processes. Personal data associated with the closed account will be retained in accordance with Mangopay’s data retention policies.
Note – Do not overuse OAuth token endpoint if automating callsIf you are writing a script to close a set of users, ensure you do not call the OAuth token endpoint before each DELETE call. You must use your authentication for the full duration of its lifetime, as described in the authentication guide.Overuse of the OAuth token endpoint is a security and performance risk and may result in preventative action from Mangopay.

​
Path parameters

​
UserId
string
required
The unique identifier of the user.

​
Responses

204 - No Content

The 204 response code indicates that the closure request was successful.
{
    "Message": "The user cannot be closed as one or several wallets are not empty",
    "Type": "user_closure_not_possible",
    "Id": "bcb91dae-bb4a-4f99-937c-8f8530c14a31#1744636047",
    "Date": 1744636048,
    "errors": null
}

{
    "Message": "An error occurred while closing the user",
    "Type": "user_closure_failed",
    "Id": "8524ae5f-3232-4910-b9db-4ffd7f4be4ee",
    "Date": 1744631045,
    "errors": null
}

// DELETE has no body parameters