Merchant Management

Use the Merchant Management API to retrieve and manage merchant records. Merchants sit between partners and locations in the Bead hierarchy and are the primary entity for payment activity, settlement, and reporting.

Partner → Merchant → Location → Terminal → Payment

Endpoints at a glance

Action	Method and path
List merchants	GET /Merchants/all
Get merchant	GET /Merchants/{id}

Merchant status values

The status field reflects the current state of the merchant record.

Status	Meaning
unverified	Merchant created but not yet verified or active
active	Merchant is live and able to process payments
locked	Merchant is temporarily locked
restricted	Merchant has restricted access
inactive	Merchant is inactive
suspended	Merchant has been suspended
terminated	Merchant has been terminated
closed	Merchant account is closed

Check status before enabling production payment traffic. Only active merchants should be processing live payments.

Best practices

• Use GET /Merchants/all with PartnerIds to scope results to the correct partner context.

• Use GET /Merchants/{id} when you need the full merchant record for support, troubleshooting, or reconciliation.

• Check status before routing live payment traffic to a merchant.

• Store id so downstream workflows — locations, terminals, payments, reporting, and settlement — can reference it consistently.

Related pages

• Partner Management

• Location Management

• Terminal Management

• Onboarding

• Reporting

• Settlement