Skip to navigation
APIPay Ops endpointsBusinesses

Deactivate a business

Beta
View as MarkdownOpen in Claude

Deactivates a business. This is a soft delete: the business moves to Deactivated and the record is kept.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

businessReferencestringRequired

The business reference (businessUuid).

Request

This endpoint expects an object.
reasonstringOptional1-500 characters

Optional reason for deactivation (max 500 characters).

Response

Business deactivated.
successboolean
Whether the request succeeded.
messagestring or null

A human-readable result message.

traceIdstring or null
The trace identifier for the request, useful for support.
dataobject or null
The deactivated business.
warningslist of objects or null

Non-blocking warnings.

Errors

401
Unauthorized Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error