Merchants have an active field that controls whether they can process payments. This field defaults to true when a merchant is created. You can set it to false to prevent processing, then back to true when ready.

Enabling a Merchant

Via API

PATCH /v1/merchants/{merchantId}

Request body:

{
  "active": true
}

Successful response: Returns the updated merchant object with active: true.

Via Dashboard

1. Navigate to Merchant Vault
2. Check the Show Disabled checkbox in the toolbar to view disabled merchants (this checkbox is hidden when advanced filters are active)
3. Locate the merchant and click the actions menu (dropdown button on the row)
4. Select Enable Merchant
5. Confirm the action in the modal

🚧

Dashboard Validation

The Dashboard performs additional validation when enabling a previously disabled merchant:

1. At least one connection required - The merchant must have at least one processor connection configured
2. Plan credential validation - If the merchant has a plan assigned, credentials must be configured for all processors in the plan

If validation fails, you may see one of these errors:

• "Merchant processors not exists!" - No connections configured
• "Merchant Processors credential not exists!" - Missing credentials for a plan processor
• "Merchant Missing Connections. Check Plan Connections." - Plan requires a processor the merchant doesn't have

The API does not perform these checks. Disabling a merchant has no validation requirements.

Disabling a Merchant

Disabling a merchant immediately prevents them from processing new payments.

Via API

PATCH /v1/merchants/{merchantId}

Request body:

{
  "active": false
}

Successful response: Returns the updated merchant object with active: false.

Via Dashboard

1. Navigate to Merchant Vault
2. Locate the merchant in the list
3. Click the actions menu (dropdown button next to edit)
4. Select Disable Merchant
5. Confirm the action in the modal

When a merchant is disabled:

• The disabledOn field records the timestamp
• The disabledBy field records who disabled the merchant
• Connection statuses remain unchanged
• The merchant can be re-enabled at any time

Common Use Cases

Controlling Go-Live Timing

Create merchants with active: false if you need to complete additional steps before allowing processing:

{
  "name": "New Merchant",
  "active": false
}

Enable them when ready by setting active: true.

Temporary Suspension

Disable a merchant to halt processing while maintaining their account and data:

• Investigating activity
• Merchant-requested pause
• Billing or compliance matters

Re-enabling a Merchant

To re-enable a previously disabled merchant, set active: true via the API or Dashboard.