Merchant

Delete Merchant

Available on Pro and Enterprise Plans

Deletes a merchant. You can only delete merchants that belong to your account. Requests for any other merchant, or for one that has already been deleted, return 403.

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