Skip to main content
The MerchantStatus enum controls whether a merchant can receive payments. Every call to POST /api/v1/sdk/payments/process checks the merchant’s current status before proceeding.

​
Values

StatusWho Can SetDescription
ACTIVECompany / PlatformNormal operations. Merchant accepts payments.
PAUSEDCompany (self-service)Temporarily suspended by the partner company via Management API or Dashboard.
FROZENPlatform Admin onlyFunds and payment processing locked pending investigation.
BLACKLISTEDPlatform Admin onlyPermanent ban. Used for confirmed fraud or regulatory non-compliance.
SUSPENDEDPlatform Admin onlyTemporary administrative hold placed by TapRails.
When a payment is attempted for a merchant that is not ACTIVE, the backend will return a 403 Forbidden response. Plan your retry logic accordingly.

​
Companies (Self-Service)

Partners can toggle between ACTIVE and PAUSED via:
  • Management API: PATCH /api/v1/management/merchants/{id}/status
  • Dashboard UI: PATCH /api/v1/dashboard/merchants/{id}/status
{ "status": "PAUSED" }
If a merchant has been set to FROZEN, BLACKLISTED, or SUSPENDED by the TapRails platform, self-service status updates will return 403 Forbidden. Contact TapRails support if you believe this is in error.

​
Schema Definition

enum MerchantStatus {
  ACTIVE
  PAUSED
  FROZEN
  BLACKLISTED
  SUSPENDED
}