Merchant

Delete Merchant

Available on Enterprise Plan

Soft-deletes a merchant by setting deleted_at to now. The caller must own the merchant. If the merchant is already soft-deleted (deleted_at <= now), returns 404 — the merchant does not exist.

Authentication

X-API-KEYstring
API Key authentication via header

Request

This endpoint expects an object.
merchantIdstringRequired

UUID of the merchant to soft-delete. The merchant must be owned by the calling account.

Response

OK
merchantIdstring
UUID of the deleted merchant.
messagestring

Human-readable description of the result.

statusstring

Result status of the operation (e.g. ‘success’).

Errors

400
Delete Merchant Body Bad Request Error
401
Delete Merchant Body Unauthorized Error
403
Delete Merchant Body Forbidden Error
404
Delete Merchant Body Not Found Error
422
Delete Merchant Body Unprocessable Entity Error
500
Delete Merchant Body Internal Server Error