Skip to content
Console
On this page

Refresh a merchant account

Reads the connected account back from the processor.

Reads the connected account back from the processor.

  • Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/merchant_accounts/merchant-account:refresh
  • Scope billing:write
  • Effect write — a successful call changes state.
  • Collection merchant_accounts

Request

FieldTypeWhat it is
namestringThe merchant account to read back. Required.

Response

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/merchant_accounts/{merchant_account}; the environment's seller is default.
uidstringmac_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
processorstringThe processor: stripe. Output only.
account_idstringThe connected account id, for example acct_1Nv…. Output only.
livemodeboolWhether the connection is in live mode (false is test mode). Output only.
statestringconnected or disconnected. Output only.
charges_enabledboolWhether the account can take payments now. Output only.
payouts_enabledboolWhether the account can be paid out. Output only.
business_namestringThe business name the processor holds for the account. Output only.
region_codestringISO 3166-1 alpha-2 country of the account. Output only.
default_currency_codestringISO 4217 default currency of the account, upper case. Output only.
refresh_timetimestampWhen the processor last confirmed these fields. Output only.
credentialstringHow 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.
automatic_taxboolWhether Stripe computes tax on this merchant's checkouts and usage invoices (its own cost decision: Stripe Tax charges per transaction). Off by default. Writable through UpdateMerchantAccount (update_mask = "automatic_tax"). Turning it on is refused while a live post_tax_settlement credit grant exists.
processor_read_permissionsProcessorReadPermission[]Payouts and Balance read probes. Missing access only delays bookkeeping; it never disconnects this account or prevents checkout. Output only.
processor_permissions_check_timetimestampWhen these probes ran. Unset means not checked yet. Output only.
processor_warningsstring[]Fixed, actionable warnings; never Stripe response bodies or credentials. Output only.

ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong 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_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

ProcessorReadPermission

FieldTypeWhat it is
permissionstringpayouts or balance (Stripe's Payouts and Balance read permissions). Output only.
statestringgranted, missing (403), or unavailable (no conclusion). Output only.

Errors

  • UNAUTHENTICATED — No valid key or token was presented.
  • PERMISSION_DENIED — The key lacks the method's permission.
  • RESOURCE_NOT_FOUND — The named Resource does not exist or is not visible.
  • UNAVAILABLE — The Resource store, the owning service's backend, or the key verifier's snapshot is unavailable; retry after Retry-After.

Every error arrives in the body Errors describes.

Examples

curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/merchant_accounts/merchant-account:refresh" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'