> For the complete documentation index, see [llms.txt](https://developers.bead.xyz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.bead.xyz/entity-management/merchant-management.md).

# 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](/entity-management/merchant-management/get-merchant.md)
* [Location Management](/entity-management/location-management.md)
* [Terminal Management](/entity-management/terminal-management.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://developers.bead.xyz/entity-management/merchant-management.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.