> ## Documentation Index
> Fetch the complete documentation index at: https://yn-c9bb3266.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# API overview

> One JSON-over-HTTPS REST API for payments across 100+ providers and every major method.

One JSON-over-HTTPS REST API to orchestrate payments across 100+ providers and every major payment method, in any country Yuno supports. Standard HTTP verbs, predictable URLs, JSON in and out — if you've used Stripe, this will feel familiar.

## Where to start

<CardGroup cols={2}>
  <Card title="New to Yuno?" icon="rocket" href="/api-reference/quickstart">
    Make your first checkout session against sandbox in under 5 minutes.
  </Card>

  <Card title="Know what you need?" icon="compass" href="#build-with-yuno">
    Browse by capability or jump straight to the endpoint reference below.
  </Card>
</CardGroup>

## Install and call

Sandbox: `https://api-sandbox.y.uno` · Production: `https://api.y.uno`

A trivial auth-bearing call to confirm your credentials reach the API. List one customer — side-effect free, returns `200 OK`.

<Tabs>
  <Tab title="cURL">
    ```bash theme={"theme":{"light":"github-dark","dark":"github-dark"}}
    curl "https://api-sandbox.y.uno/v1/customers?limit=1" \
      -H "public-api-key: $YUNO_PUBLIC_API_KEY" \
      -H "private-secret-key: $YUNO_PRIVATE_SECRET_KEY"
    ```
  </Tab>

  <Tab title="Node.js">
    ```js theme={"theme":{"light":"github-dark","dark":"github-dark"}}
    const res = await fetch("https://api-sandbox.y.uno/v1/customers?limit=1", {
      headers: {
        "public-api-key": process.env.YUNO_PUBLIC_API_KEY,
        "private-secret-key": process.env.YUNO_PRIVATE_SECRET_KEY,
      },
    });
    console.log(await res.json());
    ```
  </Tab>

  <Tab title="Python">
    ```python theme={"theme":{"light":"github-dark","dark":"github-dark"}}
    import os, requests
    res = requests.get(
        "https://api-sandbox.y.uno/v1/customers?limit=1",
        headers={
            "public-api-key": os.environ["YUNO_PUBLIC_API_KEY"],
            "private-secret-key": os.environ["YUNO_PRIVATE_SECRET_KEY"],
        },
    )
    print(res.json())
    ```
  </Tab>

  <Tab title="Go">
    ```go theme={"theme":{"light":"github-dark","dark":"github-dark"}}
    req, _ := http.NewRequest("GET", "https://api-sandbox.y.uno/v1/customers?limit=1", nil)
    req.Header.Set("public-api-key", os.Getenv("YUNO_PUBLIC_API_KEY"))
    req.Header.Set("private-secret-key", os.Getenv("YUNO_PRIVATE_SECRET_KEY"))
    res, err := http.DefaultClient.Do(req)
    ```
  </Tab>
</Tabs>

<Accordion title="Sample response (200)">
  List endpoints return a JSON array of resource objects directly — no envelope. An empty account returns `[]`.

  ```json theme={"theme":{"light":"github-dark","dark":"github-dark"}}
  [
    {
      "id": "c9d0e1f2-3a4b-5c6d-7e8f-9a0b1c2d3e4f",
      "merchant_customer_id": "cust-internal-001",
      "first_name": "Maria",
      "last_name": "Silva",
      "email": "maria.silva@example.com",
      "country": "BR",
      "created_at": "2026-05-11T14:32:01.482Z",
      "updated_at": "2026-05-11T14:32:01.482Z"
    }
  ]
  ```
</Accordion>

## Build with Yuno

<CardGroup cols={2}>
  <Card title="Accept payments online" icon="cart-shopping" href="/api-reference/checkout-sessions/object">
    Hosted checkout sessions that render Yuno's SDK and route across providers.
  </Card>

  <Card title="Charge cards server-to-server" icon="credit-card" href="/api-reference/payments/object">
    Direct API payments for custom UIs and headless flows.
  </Card>

  <Card title="Save cards and tokens" icon="floppy-disk" href="/api-reference/payment-methods/object">
    Vault payment methods for one-click checkout and merchant-initiated transactions.
  </Card>

  <Card title="Charge on a schedule" icon="calendar-days" href="/api-reference/subscriptions/object">
    Subscriptions with retry logic and dunning built in.
  </Card>

  <Card title="Offer installments" icon="layer-group" href="/api-reference/installments-plans/list">
    Country-specific installment plans for cards.
  </Card>

  <Card title="Share payment links" icon="link" href="/api-reference/payment-links/object">
    Hosted, single-use checkout URLs you can send by email or chat.
  </Card>

  <Card title="Run a marketplace" icon="store" href="/api-reference/recipients/object">
    Onboard recipients and split payouts across multiple parties.
  </Card>

  <Card title="Embedded finance" icon="building-columns" href="/api-reference/baas/create-entity">
    Open accounts and move funds via Banking as a Service.
  </Card>
</CardGroup>

## Reference and tools

<CardGroup cols={3}>
  <Card title="Authentication" icon="key" href="/getting-started/authentication">
    The two required headers and how to keep secrets server-side.
  </Card>

  <Card title="Environments" icon="server" href="/getting-started/environments">
    Sandbox vs production base URLs and isolation guarantees.
  </Card>

  <Card title="Avoiding duplicates" icon="rotate" href="/core-concepts/idempotency">
    Business keys that make retries safe across every resource.
  </Card>

  <Card title="Errors" icon="triangle-exclamation" href="/core-concepts/error-handling">
    The error envelope, the full code catalog, and how to retry safely.
  </Card>

  <Card title="Webhooks" icon="bell" href="/guides/webhooks/setup">
    Endpoint registration, signature verification, and lifecycle events.
  </Card>

  <Card title="SDKs" icon="code" href="/guides/sdk/overview">
    Web, iOS, Android, Flutter, and framework component libraries.
  </Card>
</CardGroup>

See [Conventions](/api-reference/conventions/pagination) for pagination, status codes, rate limits, and async result behavior.

## For AI coding agents

<CardGroup cols={3}>
  <Card title="OpenAPI 3.1 spec" icon="file-code" href="/api-reference/openapi.json">
    The full machine-readable contract. Drop into openapi-generator, Stainless, or any compatible client generator.
  </Card>

  <Card title="/llms.txt site index" icon="list" href="/llms.txt">
    Plain-markdown index of every documentation page and OpenAPI endpoint, ready for RAG or context loading.
  </Card>

  <Card title="MCP server" icon="robot" href="/ai/llm-mcp-integration">
    Connect Claude Code, Cursor, or any MCP-compatible tool to read these docs and call the API in one session.
  </Card>
</CardGroup>

Combined, these let an agent both read this documentation and call the API in the same session.

## Changelog

<CardGroup cols={2}>
  <Card title="API changelog" icon="rectangle-list" href="/changelog/api">
    New endpoints, field additions, and behavior changes.
  </Card>

  <Card title="Versioning policy" icon="code-branch" href="/changelog/overview">
    How Yuno ships changes and what counts as breaking.
  </Card>
</CardGroup>
