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
List merchant accounts
Lists merchant accounts.
Lists merchant accounts.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/merchant_accounts - Scope
billing:read - Effect
read— nothing is written. - Collection merchant_accounts
- Query
page_size,page_token - Pagination the answer carries
merchant_accountsand, when there is more,next_page_token
#Request
| Field | Type | What it is |
|---|---|---|
parent | string | The parent to list in. Required. |
page_size | int32 | At most this many; default 50, clamped to 1000. |
page_token | string | next_page_token of the previous page. |
#Response
| Field | Type | What it is |
|---|---|---|
merchant_accounts | MerchantAccount[] | The page. |
next_page_token | string | The token of the next page; empty on the last page. |
#MerchantAccount
| 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. |
#ResourceMeta
| Field | Type | What it is |
|---|---|---|
generation | int64 | Increases by one on every change to spec. Output only. |
etag | string | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only. |
create_time | timestamp | When the Resource was created. Output only. |
update_time | timestamp | When the Resource last changed. Output only. |
delete_time | timestamp | Set while the Resource is being deleted. Output only. |
labels | map<string, string> | Caller-writable, indexed labels (AIP-122 label rules). |
annotations | map<string, string> | Caller-writable, unindexed annotations. |
display_name | string | Caller-writable human-readable name. |
creator | string | The principal that created the Resource. Output only. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.INVALID_FIELD— A field failed validation.PAGE_TOKEN_MISMATCH— A page token was reused with different parameters.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/merchant_accounts" \
-H "Authorization: Bearer $SYLPHX_API_KEY"