> 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/get-merchant.md).

# Get Merchant

Retrieves the complete profile of a single merchant, including company details, tender types, fee settings, and membership list.

#### Endpoint

`GET /Merchants/{id}`

#### Authentication

```http
X-Api-Key: {adminApiKey}
```

#### Path parameters

| Name | Type   | Required | Description                               |
| ---- | ------ | -------- | ----------------------------------------- |
| `id` | string | Yes      | The `merchantId` assigned during boarding |

#### Request headers

| Header      | Value              |
| ----------- | ------------------ |
| `X-Api-Key` | `{adminApiKey}`    |
| `Accept`    | `application/json` |

#### Example request

```bash
curl -X GET "https://api.test.devs.beadpay.io/Merchants/{merchantId}" \
     -H "X-Api-Key: {adminApiKey}"
```

#### Successful response — 200

```json
{
  "id": "mer_123123",
  "created": "2025-06-04T18:41:14.402Z",
  "updated": "2025-06-04T18:41:14.402Z",
  "tenderTypes": ["ethereum"],
  "companyName": "Acme Coffee Roasters",
  "description": "West-coast café chain",
  "companyLogoPath": "https://cdn.bead.xyz/logos/acme.svg",
  "taxNumber": "99-9999999",
  "receivableCurrencyIds": [1],
  "partnerId": "part_e9ab6c82b6d74a4f9c33",
  "maxTransactionAmount": 2500000,
  "externalProps": [
    {
      "system": "cybrid",
      "id": "abca1b69977e69ee0a0725b837ba9d0b",
      "additionalData": {
        "accounts": [
          {
            "id": "acct_fiat_usd",
            "accountType": "fiat",
            "name": "USD settlement",
            "currencyId": 1
          }
        ]
      }
    }
  ],
  "status": "unverified",
  "feeInfo": {
    "crypto": { "feeFactor": 0.015, "fixedFee": 0 },
    "card": { "feeFactor": 0.029, "fixedFee": 30 }
  },
  "settlementBeneficiary": { "type": "self", "partnerId": "part_e9ab6c82b6d74a4f9c33" },
  "memberships": [
    { "userIssuerId": "user_ab12", "role": "admin" },
    { "userIssuerId": "user_cd34", "role": "viewer" }
  ]
}
```

`receivableCurrencyIds` contains integer IDs from the `/currencies` endpoint. `1` represents USD.

#### Key fields

| Field                             | Description                                                                                                     |
| --------------------------------- | --------------------------------------------------------------------------------------------------------------- |
| `tenderTypes`                     | Default rails every child location inherits unless overridden at the location or terminal                       |
| `receivableCurrencyIds`           | Settlement currencies, matched against IDs from `/currencies`                                                   |
| `feeInfo.crypto` / `feeInfo.card` | `feeFactor` is a percentage expressed as a decimal (0.015 = 1.5%). `fixedFee` is in minor units                 |
| `status`                          | Boarding state: `unverified`, `active`, `locked`, `restricted`, `inactive`, `suspended`, `terminated`, `closed` |
| `memberships`                     | Users and roles that manage this merchant in the dashboard                                                      |

#### Error responses

| Code | Condition                                                    |
| ---- | ------------------------------------------------------------ |
| 401  | Missing or invalid API key                                   |
| 403  | Authenticated but not permitted to access this merchant      |
| 404  | Merchant `{id}` does not exist or is not visible to your key |

#### Best practices

* Cache the response for dashboard sessions — merchant profiles rarely change during a user session
* Use the `updated` timestamp to decide when to invalidate local copies
* Check `status` before enabling production payment traffic — the merchant must be `active`
* Respect `maxTransactionAmount` when building POS flows to prevent declines on oversize transactions

#### Related pages

* [Merchant Management](/entity-management/merchant-management.md)
* [List Locations](/entity-management/location-management/list-locations.md)
* [Create Location](/entity-management/location-management/create-location.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/get-merchant.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.