Close a Legal User
Permanently close a user account so it can no longer be used.
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 irreversible
Calling 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 Legal User (SCA).
Closure is only possible if all wallets held by the user are empty. Closure is allowed for both UserCategory OWNER and PAYER and for all types of Legal user (Business, Partnership, Organization, Soletrader).
When a User is closed (whether via this endpoint or by Mangopay):
- The
UserStatuschanges toCLOSED(and theUSER_ACCOUNT_CLOSEDwebhook 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 calls
If 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.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.
Path parameters
Response
No Content – Closure was successful