> ## Documentation Index > Fetch the complete documentation index at: https://docs.zopay.cash/llms.txt > Use this file to discover all available pages before exploring further. # Get Capabilities > GET /capabilities ## OpenAPI ````yaml GET /capabilities openapi: 3.1.0 info: title: ZoPay Connect API description: >- B2B partner API for crypto custody, deposits, and payouts. Authenticate every request with a Bearer token (``sk_live_…`` for production, ``sk_test_…`` for sandbox). version: v1 servers: - url: https://api.zopay.cash/connect/v1 description: Production - url: https://dev.api.zopay.cash/connect/v1 description: Development security: - BearerAuth: [] tags: - name: capabilities description: >- Static product catalog: which assets, networks, and fiat valuations this tenant can use. Poll on app startup to drive every UI surface (network pickers, fee warnings, fiat selection). - name: addresses description: >- Per-user deposit addresses. Mint with ``external_ref`` to attribute to one of your users; omit for a tenant-treasury (pooled) address. - name: payment-intents description: >- Single-use payment requests. Mint an intent for a specific amount + currency set; we expand it to per-network deposit addresses. Pass ``external_ref`` to attribute the intent to one of your users for downstream webhook reconciliation. - name: balances description: >- Per-user or tenant-wide balance snapshot with multi-fiat valuation (USD, PEN, EUR, MXN, ARS, COP, DOP). - name: transactions description: >- Unified ledger covering deposits, payouts, internal transfers, and (after Phase 4) conversions and ramps. - name: payouts description: >- Outbound money movement: get a signed quote, then execute it. Quote IDs are single-use and expire in 60s. - name: conversions description: '[Coming soon] Crypto-to-crypto conversions.' - name: ramps description: '[Coming soon] Fiat <-> crypto hosted-checkout sessions.' - name: webhooks description: '[Coming soon] Subscribe to event streams + replay past events.' - name: health description: >- Auth + connectivity probe. Use to validate your API key works before depending on a priced endpoint. - name: test-helpers description: >- Sandbox-only simulators. Let you exercise webhook handlers and downstream state transitions without real testnet activity. Routes return 404 to ``sk_live_…`` keys. paths: /capabilities: get: tags: - capabilities summary: Get Capabilities operationId: get_capabilities_capabilities_get parameters: - name: verbose in: query required: false schema: type: boolean description: >- Reserved for future expansion. Accepted today as a forward-compat surface but does not currently add fields to the response. default: false title: Verbose description: >- Reserved for future expansion. Accepted today as a forward-compat surface but does not currently add fields to the response. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ConnectCapabilitiesResponse' '400': description: >- Invalid request. The body or query parameters failed validation. ``error.code`` names the specific failure (e.g. ``invalid_request``, ``catalog_invalid``, ``min_usdt_amount_requires_solana``); ``error.param`` names the offending field when applicable. content: application/json: schema: $ref: '#/components/schemas/ConnectErrorEnvelope' '401': description: >- Authentication failed. ``error.code`` distinguishes ``authentication_required`` (missing / malformed / unknown key) from ``expired_credential`` (key matched but past its ``expires_at``). Rotate the key in the admin panel for the latter. content: application/json: schema: $ref: '#/components/schemas/ConnectErrorEnvelope' '403': description: >- The key is valid but lacks permission for this endpoint. ``error.code`` is ``forbidden_scope`` when the key is missing a scope; ``account_pending_approval`` when the org is not yet active for Connect. content: application/json: schema: $ref: '#/components/schemas/ConnectErrorEnvelope' '404': description: >- Resource not found in this tenant. Same envelope shape is returned for genuinely-missing IDs and for cross-tenant accesses -- existence under other tenants is not leakable. content: application/json: schema: $ref: '#/components/schemas/ConnectErrorEnvelope' '409': description: >- Conflict. Most commonly ``idempotency_conflict`` -- the same ``Idempotency-Key`` was reused with a different body. Generate a fresh key or replay the original body. content: application/json: schema: $ref: '#/components/schemas/ConnectErrorEnvelope' '422': description: >- Validation failed. Runtime translates FastAPI / Pydantic validation errors into the same Connect envelope you see on 400s; this status is emitted when the request shape is structurally wrong (missing required field, wrong type). content: application/json: schema: $ref: '#/components/schemas/ConnectErrorEnvelope' '429': description: >- Rate limited. Back off and retry. ``error.code`` is ``rate_limited``; per-key throughput is documented via ``rate_limit_rps`` on the API key. content: application/json: schema: $ref: '#/components/schemas/ConnectErrorEnvelope' '500': description: >- Internal server error. ``error.code`` is ``internal_error``. The request can usually be safely retried with the same ``Idempotency-Key``. content: application/json: schema: $ref: '#/components/schemas/ConnectErrorEnvelope' '501': description: >- Endpoint is declared in the router but its implementation has not shipped yet (``error.code = not_yet_available``). Pinned in the schema so SDK generators emit the endpoint with a typed error rather than skipping it. content: application/json: schema: $ref: '#/components/schemas/ConnectErrorEnvelope' security: - BearerAuth: [] components: schemas: ConnectCapabilitiesResponse: properties: assets: items: $ref: '#/components/schemas/ConnectCapabilityAsset' type: array title: Assets description: >- Enabled (asset, network) routes for the calling org. Drives partner UI surfaces (network pickers, fee warnings, deposit-screen route listings). ramps: items: $ref: '#/components/schemas/ConnectCapabilityAsset' type: array title: Ramps description: >- Fiat-on/off-ramp routes. Empty for Phase 1a; populated when the ramps surface ships. Kept in the response today so partner code can read the key without a presence check. fiat_currencies: items: type: string type: array title: Fiat Currencies description: >- ISO-4217 codes for the fiat currencies the org has enabled. Drives which valuations show up on /balances. examples: - - USD default_fiat: type: string title: Default Fiat description: >- Single ISO-4217 code: which fiat to default to in partner UI when no per-user preference is set. Always one of the codes in ``fiat_currencies``. examples: - USD type: object required: - default_fiat title: ConnectCapabilitiesResponse description: Top-level response for GET /connect/v1/capabilities. ConnectErrorEnvelope: properties: error: $ref: '#/components/schemas/ConnectErrorBody' description: >- Error details. Always present on a non-2xx response from /connect/v1. type: object required: - error title: ConnectErrorEnvelope description: |- Top-level wrapper for every /connect/v1 failure response. Wire shape:: {"error": {"type": ..., "code": ..., "message": ..., ...}} The wrapper is intentional: it keeps error bodies syntactically distinct from success bodies, so polymorphic partner code paths that read the same JSON for both states can branch on the presence of the ``error`` key. ConnectCapabilityAsset: properties: symbol: type: string title: Symbol description: Asset code, uppercase (USDT, XAUT). examples: - USDT name: type: string title: Name description: Asset display name. examples: - Tether USD networks: items: $ref: '#/components/schemas/ConnectCapabilityNetwork' type: array title: Networks description: >- Networks on which this asset is currently routable for the calling org. Ordered by display preference. convertible_to: items: type: string type: array title: Convertible To description: >- Asset codes this asset can be converted into via the Connect conversions surface. Empty for Phase 1a (conversions are documented but not yet enabled); stays present so partner code can iterate the field without a presence check. type: object required: - symbol - name title: ConnectCapabilityAsset description: |- A single asset block in the top-level ``assets`` list. Groups the per-network rows under their asset for partner-side rendering (one section per asset, networks listed underneath). ConnectErrorBody: properties: type: type: string title: Type description: >- Stripe-style error category. One of: ``invalid_request_error``, ``authentication_error``, ``not_found_error``, ``rate_limit_error``, ``idempotency_error``, ``api_error``. Stable across minor versions; branch on this for top-level error routing. examples: - invalid_request_error code: type: string title: Code description: >- Machine-stable identifier for the specific failure. More specific than ``type``. Examples: ``invalid_request``, ``authentication_required``, ``expired_credential``, ``forbidden_scope``, ``account_pending_approval``, ``resource_not_found``, ``idempotency_conflict``, ``rate_limited``, ``internal_error``, ``not_yet_available``. Match on ``code`` in your client's error handler -- never parse ``message``. examples: - authentication_required message: type: string title: Message description: >- Human-readable explanation. Safe to surface in your own UI but may be reworded between releases -- never branch on the string. examples: - >- Missing or malformed Authorization header. Send: Authorization: Bearer sk_live_... or sk_test_... doc_url: type: string title: Doc Url description: >- Link to docs explaining this ``code``. Constructed as ``https://docs.zopay.cash/errors/``. Surface this in support tickets so we can investigate without a round-trip. examples: - https://docs.zopay.cash/errors/authentication_required param: anyOf: - type: string - type: 'null' title: Param description: >- Names the offending input field when the error is input-shape-related (mostly ``invalid_request_error`` from 400 and 422). Absent on auth, scope, rate-limit, and internal errors. examples: - currencies type: object required: - type - code - message - doc_url title: ConnectErrorBody description: |- The ``error`` object inside every /connect/v1 failure response. Mirrors ``ConnectError.to_envelope()`` in ``app/api/connect/errors.py``. Field set is locked -- adding a new field is a partner-visible contract change and requires a coordinated docs + schema update. ConnectCapabilityNetwork: properties: id: type: string title: Id description: >- Network code, lowercase. Partner-stable across the Connect surface (``solana``, ``ethereum``, ``polygon``, ``tron``, ``base``). examples: - solana name: type: string title: Name description: >- Display name. Use in partner UI; ``id`` is the value to pass to other Connect endpoints. examples: - Solana deposit: $ref: '#/components/schemas/ConnectCapabilityDeposit' description: Deposit-side capabilities for this network. payout: $ref: '#/components/schemas/ConnectCapabilityPayout' description: Payout-side capabilities for this network. fee_warning: anyOf: - type: string - type: 'null' title: Fee Warning description: >- Free-form copy you can surface to your user when the fee on this network is materially higher than a cheaper alternative on the same asset. Present only for over-threshold networks WHEN a cheaper alternative exists; absent otherwise (avoiding noise). type: object required: - id - name - deposit - payout title: ConnectCapabilityNetwork description: A single (asset, network) row inside an asset block. ConnectCapabilityDeposit: properties: enabled: type: boolean title: Enabled description: >- Whether this asset on this network accepts deposits for the calling org. True for every row returned today; reserved for future per-tenant route gating. type: object required: - enabled title: ConnectCapabilityDeposit description: |- ``deposit`` sub-block on a per-network row. Only field today is ``enabled``; reserved for future per-network deposit limits + minimums. ConnectCapabilityPayout: properties: enabled: type: boolean title: Enabled description: >- Whether this asset on this network supports payouts for the calling org. True for every row returned today; reserved for future per-tenant route gating. estimated_fee_usd: anyOf: - type: string - type: 'null' title: Estimated Fee Usd description: >- USD-equivalent fee for a payout on this network, rendered as a decimal string (precision-safe across the JS Number boundary). Absent when no fee is configured for this (asset, network) in the catalog. examples: - '0.50' type: object required: - enabled title: ConnectCapabilityPayout description: |- ``payout`` sub-block on a per-network row. Carries the estimated fee for partner-facing UI ("withdraw via X network for $0.50"). securitySchemes: BearerAuth: type: http scheme: bearer bearerFormat: Connect API key (sk_live_… or sk_test_…) description: >- Paste your Connect API key (sk_live_… for production, sk_test_… for sandbox) without the ``Bearer `` prefix. Mint and rotate keys from the admin panel. ````