v2.accounts

Retrieve a connected account (platform key)

Platform keys only. Retrieves one connected account; an account that is not connected to this platform (unknown store, owner not a managed seller, membership disconnected, or another platform's seller) is 404 — never a hint about other platforms. Since Fase 3 the account also carries requirements, payouts_enabled, charges_enabled (read from Stripe, cached for 60 s) and onboarding_state (the API onboarding, when there was one); all four are null when the seller has no Stripe account yet or was not onboarded by API. A sandbox key also retrieves the platform's simulated accounts (created by POST /accounts under the sandbox key): email: null (only the e-mail hash is kept), state: active, empty requirements, payouts_enabled and charges_enabled true, onboarding_state: done, livemode: false; a live key answers 404 for them. Since 2026-09-10 the account also carries business_profile (mcc, product_description, url), null when none is set; POST /accounts/{id} sets it.

get/accounts/{id}

Request

  • Base URL: https://api.cooud.com/v2
  • URL: https://api.cooud.com/v2/accounts/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Connected account id (cooud_acct_<ULID> — the seller's store).

Headers

Cooud-Compat-Datestring date required

Required per-request compat-date. Format: ISO calendar date YYYY-MM-DD. Merchants pinned to an older date have their request and response transformed by every gate whose appliesAfter is strictly greater than this date.

Response

The connected account.

application_fee_cap_bpsinteger required

Ceiling the seller accepted for platform fees, in basis points of the session base amount. application_fee_amount on POST /checkout-sessions may not exceed floor(amount × application_fee_cap_bps / 10000) plus application_fee_cap_fixed_amount when the session base currency is application_fee_cap_currency (Cooud Connect Fase 4, hybrid cap).

application_fee_cap_fixed_amountinteger required

Fixed fee per sale the seller accepted, in cents of application_fee_cap_currency (Cooud Connect Fase 4). Added to the bps ceiling when the session base currency (line_items/prices) is application_fee_cap_currency; in any other currency it does not apply (never converted). 0 for sellers who accepted before the fixed fee existed and for platforms without one.

application_fee_cap_currencystring required

ISO 4217 code, upper case, of application_fee_cap_fixed_amount (for example BRL). The fixed part only caps sessions whose base currency equals it.

livemodeboolean required

true for a real seller; false for a simulated account created under a sandbox key (no user, store, Stripe account or membership exists).

createdinteger required

Unix epoch seconds derived from the store id.

emailstring nullable required

E-mail of the store owner (the seller who accepted the platform invite, or the e-mail sent on the API onboarding). Null for a simulated sandbox account after its 201: Cooud keeps only the e-mail hash.

idstring required
object'account' required
request_idstring required
statestring required

Membership state at the platform (for example onboarding_pending, active). A simulated sandbox account is always active.

payouts_enabledboolean nullable

Stripe payouts_enabled; null without a Stripe account. Retrieve and onboarding 201 only.

charges_enabledboolean nullable

Stripe charges_enabled; null without a Stripe account. Retrieve and onboarding 201 only.

onboarding_state'in_progress' | 'incomplete' | 'done' | 'failed' nullable

State of the API onboarding (in_progress, incomplete, done, failed); null when the seller joined by invite. Retrieve and onboarding 201 only.

metadataobject

The metadata sent on the onboarding (onboarding 201 only).

gateway'cooud' | 'stripe' | 'cooud_llc'

Payment gateway of the account's store. Present only on accounts whose store sells through Cooud LLC (cooud_llc); when absent the store sells through Cooud Brasil and the account is unchanged. Cooud LLC accounts are created by POST /accounts with gateway: cooud_llc on platforms Cooud enabled for it; their checkout sessions follow the Cooud LLC rules of POST /checkout-sessions.

countrystring nullable

Cooud LLC accounts only: country (ISO 3166-1 alpha-2) of the seller's Cooud LLC payout account; null while that account does not exist.

default_currencystring nullable

Cooud LLC accounts only: default currency of the seller's Cooud LLC payout account; null while that account does not exist.

transfers_enabledboolean

Cooud LLC accounts only: true when the Cooud LLC payout account can receive transfers (transfers capability active, as last synced). On Cooud LLC accounts requirements, payouts_enabled, charges_enabled and business_profile describe the Cooud LLC payout account.

requirement_collection'stripe'

Present on the 201 of a Cooud LLC onboarding: stripe — Stripe collects the requirements of the Cooud LLC (Express) account; the seller provides requirements.currently_due through onboarding_session or onboarding_link.

Changes

No recorded changes to this operation across all 1 revision of this API.