> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fyatu.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Introduction

> Fyatu API v3 — issue virtual prepaid cards, collect payments, and send payouts programmatically via REST.

# Fyatu API

The Fyatu API lets you embed financial infrastructure directly into your product. Issue virtual Mastercard prepaid cards, accept payments from Fyatu users, and send payouts — all through a single REST API.

<CardGroup cols={2}>
  <Card title="Quick Start" icon="rocket" href="/v3/documentation/quickstart">
    Make your first API call in minutes
  </Card>

  <Card title="Authentication" icon="key" href="/v3/documentation/authentication">
    JWT tokens, scopes, and best practices
  </Card>

  <Card title="API Reference" icon="code" href="/v3/api-reference/overview">
    Browse all endpoints and schemas
  </Card>

  <Card title="Webhooks" icon="webhook" href="/v3/webhooks">
    Receive real-time event notifications
  </Card>
</CardGroup>

## What You Can Build

<AccordionGroup>
  <Accordion title="Virtual Card Issuing" icon="credit-card">
    Issue Mastercard prepaid virtual cards to your cardholders programmatically. Fund them on creation, add balance at any time, freeze or unfreeze, and terminate when no longer needed. Full card details (PAN, CVV, expiry) are available via API.
  </Accordion>

  <Accordion title="Payment Collections" icon="money-bill-transfer">
    Create checkout sessions and accept payments from Fyatu users. Customers are redirected to a hosted checkout page and you receive a webhook notification on completion. Refunds are also supported.
  </Accordion>

  <Accordion title="Payouts & Disbursements" icon="money-bill-wave">
    Send payouts to verified external accounts. Ideal for vendor payments, affiliate disbursements, and salary payouts.
  </Accordion>

  <Accordion title="Cardholder Management" icon="users">
    Create and manage the individuals associated with your issued cards. Collect KYC documents or initiate a hosted KYC verification session before issuing cards.
  </Accordion>
</AccordionGroup>

## Base URL

```
https://api.fyatu.com/api/v3
```

## App-Based Access

Every API call is scoped to an **App** you create in your Business Console. The app type determines which APIs are available:

| App Type           | APIs Available                | Scopes Granted                                                       |
| ------------------ | ----------------------------- | -------------------------------------------------------------------- |
| **Collection App** | Collections, Payouts, Refunds | `collect:write`, `collect:read`, `payout:write`, `payout:read`       |
| **Issuing App**    | Cards, Cardholders            | `cards:write`, `cards:read`, `cardholders:write`, `cardholders:read` |

All app types also have access to the **Account** endpoints (wallet balance, transactions, statement, invoices, pricing).

## Getting Started

<Steps>
  <Step title="Create a Fyatu account">
    Sign up at [web.fyatu.com](https://web.fyatu.com/auth/register) and complete identity verification (KYC).
  </Step>

  <Step title="Upgrade to Business">
    Upgrade your account to Business from the dashboard to access the Business Console.
  </Step>

  <Step title="Create an App">
    In the Business Console, create a **Collection App** or an **Issuing App** depending on what you want to build.
  </Step>

  <Step title="Get your credentials">
    From your app's **Settings → API Keys & Credentials**, copy your `appId` and `secretKey`.
  </Step>

  <Step title="Generate a token and start calling the API">
    Exchange your credentials for a JWT access token and include it as a `Bearer` token on every request.
  </Step>
</Steps>

<Card title="Ready to start?" icon="play" href="/v3/documentation/quickstart">
  Follow the quickstart guide to make your first API call
</Card>

## Key Concepts

| Concept             | Description                                                                                                 |
| ------------------- | ----------------------------------------------------------------------------------------------------------- |
| **JWT tokens**      | Short-lived access tokens (24 h) scoped to your app type. Refresh up to 5 minutes after expiry.             |
| **Scopes**          | Each token carries the permissions granted to its app type. Calls outside the scope return `403`.           |
| **requestId**       | Every response includes a `meta.requestId` — use it when contacting support.                                |
| **Webhooks**        | HMAC-SHA256 signed callbacks for every significant event. Verify the signature before trusting the payload. |
| **Business wallet** | Your USD balance used to fund card issuance, payouts, and fees. Replenish via USDT deposit.                 |

## Need Help?

Click the chat icon in the bottom right corner to talk to our support team, or reach us at [support@fyatu.com](mailto:support@fyatu.com).