Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
On this page
sylphx money merchant_accounts
Every sylphx money merchant_accounts command: its argument, its flags and a run line.
The merchant_accounts commands of Sylphx Money, as the CLI spells them: the same
calls as the merchant_accounts API page, typed for the
shell. Install, sign in and the grammar are on the CLI index.
#get
Gets a merchant account.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx money merchant-accounts get orgs/acme/projects/shop/envs/production/merchant_accounts/merchant-accountGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/merchant_accounts/merchant-account · scope billing:read · effect read · Request, response and examples
#list
Lists merchant accounts.
PARENT — optional: the CLI fills it from the linked project or the
key's scope when it is left out.
CLI
sylphx money merchant-accounts list orgs/acme/projects/shop/envs/productionGET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/merchant_accounts · scope billing:read · effect read · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--page-size | int | At most this many; default 50, clamped to 1000. |
--page-token | string | next_page_token of the previous page. |
#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.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx money merchant-accounts connect orgs/acme/projects/shop/envs/productionPOST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/merchant_accounts:connect · scope billing:write · effect write · Request, response and examples
Flags
| Flag | Type | What it does |
|---|---|---|
--merchant-account-id | string | The merchant account id; default default. |
--return-url | string | Where the browser returns after the processor, with status and, on success, merchant_account in the query. HTTPS only. Required for the OAuth connection; unused, and so optional, with restricted_key. |
--restricted-key | string | A Stripe restricted key (rk_test_… or rk_live_…); when set, no OAuth happens: the account is read and connected at once. Write-only: sealed on write, never returned, never logged. A secret key (sk_…) is refused, because a restricted key can be limited to what payments need. The value is never returned. |
#refresh
Reads the connected account back from the processor.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx money merchant-accounts refresh orgs/acme/projects/shop/envs/production/merchant_accounts/merchant-accountPOST 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
#disconnect
Disconnects the account: Sylphx loses access; checkout is refused.
NAME — the resource's name; a bare id is enough below the linked
project.
CLI
sylphx money merchant-accounts disconnect orgs/acme/projects/shop/envs/production/merchant_accounts/merchant-account --yesPOST 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
Flags
| Flag | Type | What it does |
|---|---|---|
--yes | bool | Do not ask before this destructive call. |