PApayabli
Businesses

Deactivate a business

Changed on

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

delete/v2/businesses/{businessReference}

Request

  • Base URL
    https://api-sandbox.payabli.com/api
  • URL
    https://api-sandbox.payabli.com/api/v2/businesses/{businessReference}
  • Auth
    HTTP bearer

Path parameters

businessReferencestring required

The business reference (businessUuid).

Request body

reasonstring

Optional reason for deactivation (max 500 characters).

Response

Business deactivated.

successboolean required

Whether the request succeeded.

messagestring nullable required

A human-readable result message.

traceIdstring nullable required

The trace identifier for the request, useful for support.

Changes