---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Merchant accounts"
description: "The `merchant_accounts` collection of Sylphx Money: A Merchant Account is the seller an environment charges as on the web: the customer's own Stripe account, connected through Stripe Connect OAuth, or with a restricted key when OAuth cannot…"
type: reference
product: payments
summary: "A Merchant Account is the seller an environment charges as on the web: the customer's own Stripe account, connected through Stripe Connect…"
updated: 2026-09-28
order: 900
---

A Merchant Account is the seller an environment charges as on the web: the customer's own Stripe account, connected through Stripe Connect OAuth, or with a restricted key when OAuth cannot be used (the platform's own products). Sylphx stores the account id, and for a key connection the key sealed, never in the clear and never returned. `:connect` starts the connection; the processor's redirect completes an OAuth one.

**Service** Sylphx Money · **Resource type** `money.sylphx.com/MerchantAccount` · **Name pattern** `orgs/{org}/projects/{project}/envs/{env}/merchant_accounts/{merchant_account}` · **Shape** `record`

## Fields

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/merchant_accounts/{merchant_account}`; the environment's seller is `default`. |
| `uid` | `string` | `mac_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `processor` | `string` | The processor: `stripe`. Output only. |
| `account_id` | `string` | The connected account id, for example `acct_1Nv…`. Output only. |
| `livemode` | `bool` | Whether the connection is in live mode (false is test mode). Output only. |
| `state` | `string` | `connected` or `disconnected`. Output only. |
| `charges_enabled` | `bool` | Whether the account can take payments now. Output only. |
| `payouts_enabled` | `bool` | Whether the account can be paid out. Output only. |
| `business_name` | `string` | The business name the processor holds for the account. Output only. |
| `region_code` | `string` | ISO 3166-1 alpha-2 country of the account. Output only. |
| `default_currency_code` | `string` | ISO 4217 default currency of the account, upper case. Output only. |
| `refresh_time` | `timestamp` | When the processor last confirmed these fields. Output only. |
| `credential` | `string` | How the account is called at the processor: `connect` (the platform's key acts for a connected account) or `restricted_key` (the account's own key, held sealed). Output only. |

## Methods

Every method of the collection, in the registry's order, with the scope it
needs. The full request, response and examples are one link away.

| Method | Call | What it does |
| --- | --- | --- |
| `GET` | [`get`](/docs/api/merchant_accounts#get) | Gets a merchant account. |
| `GET` | [`list`](/docs/api/merchant_accounts#list) | Lists merchant accounts. |
| `POST` | [`connect`](/docs/api/merchant_accounts#connect) | Starts connecting a Stripe account: returns the processor's authorisation URL for an org owner to open, which the processor's redirect completes. With a restricted key in the request the account connects at once instead, and the connected merchant account comes back in the response. |
| `POST` | [`refresh`](/docs/api/merchant_accounts#refresh) | Reads the connected account back from the processor. |
| `POST` | [`disconnect`](/docs/api/merchant_accounts#disconnect) | Disconnects the account: Sylphx loses access; checkout is refused. |

## get

Gets a merchant account.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/merchant_accounts/merchant-account` · scope `billing:read` · effect `read` · [Request, response and examples](/docs/api/merchant_accounts/get)

## list

Lists merchant accounts.

`GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/merchant_accounts` · scope `billing:read` · effect `read` · paginated · [Request, response and examples](/docs/api/merchant_accounts/list)

## connect

Starts connecting a Stripe account: returns the processor's authorisation URL for an org owner to open, which the processor's redirect completes. With a restricted key in the request the account connects at once instead, and the connected merchant account comes back in the response.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/merchant_accounts:connect` · scope `billing:write` · effect `write` · [Request, response and examples](/docs/api/merchant_accounts/connect)

## refresh

Reads the connected account back from the processor.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/merchant_accounts/merchant-account:refresh` · scope `billing:write` · effect `write` · [Request, response and examples](/docs/api/merchant_accounts/refresh)

## disconnect

Disconnects the account: Sylphx loses access; checkout is refused.

`POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/merchant_accounts/merchant-account:disconnect` · scope `billing:write` · effect `destructive` · [Request, response and examples](/docs/api/merchant_accounts/disconnect)