Skip to main content
DELETE
Delete Merchant

Overview

Removes a sub-merchant you no longer want onboarded. Once deleted it no longer appears in List Merchants, and Get Merchant answers 404 for its ID. Deleting sends no webhook and no notification.

When you can delete

A CHANGES_REQUESTED sub-merchant cannot be deleted; fix it with Update Merchant instead. A sub-merchant created through the API in sandbox is approved immediately, so it can never be deleted; the API offers no way to change this. Contact EximPe if you need a sandbox sub-merchant in another status to test with.

Path Parameters

Response

Errors

Authorizations

X-Client-ID
string
header
required

Client Application ID - Your unique application identifier used to authenticate API requests. You can find your Client ID in the Developer Settings section of the merchant dashboard.

X-Client-Secret
string
header
required

Client Secret Key - Your secret key used alongside the Client ID for secure authentication. Keep this confidential and never expose it in client-side code. Available in the Developer Settings section of the merchant dashboard.

X-API-Version
string
header
required

API Version - Specifies which version of the API to use (e.g., '1.X.X', '2.X.X', or '3.X.X'). This header allows you to control which API version your integration uses. Default version information is available in the Developer Settings.

Path Parameters

merchant_id
string
required

The sub-merchant's ID.

Response

Sub-merchant deleted.

success
boolean
required
message
string
required
data
object
required