Merchant Management

Use the Merchant Management API to retrieve and update merchant records after KYB approval. Check merchant status before enabling production traffic, and use the membership endpoints to manage user access to a merchant account.

Where Merchant Management fits

Merchants sit below partners and above locations in the Bead entity hierarchy:

Partner → Merchant → Location → Terminal → Payment

A merchant record is created during the onboarding and KYB process. Once approved, use these endpoints to read and maintain the record, manage locations, and control user access.

Endpoints at a glance

Action	Method and path
Get merchant	GET /Merchants/{id}
Update merchant	PUT /Merchants/{id}
List merchants	GET /Partners/{id}/merchants
List locations	GET /Merchants/{id}/locations
List terminals	GET /Merchants/{id}/terminals
List members	GET /Merchants/{id}/members
Add member	POST /Merchants/{id}/members
Remove member	DELETE /Merchants/{id}/members/{userIssuerId}

Merchant status

Before enabling production payment traffic, confirm the merchant's status field. A merchant must be active to process payments.

Status	Meaning
unverified	KYB not yet completed
active	Approved and able to process payments
locked	Temporarily restricted by Bead
restricted	Operating under specific limitations
inactive	Not currently processing
suspended	Suspended pending review
terminated	Permanently terminated
closed	Account closed

Related pages

• Get Merchant

• Location Management

• Terminal Management