# Keette Developers

- [Quickstart](https://docs.keette.com/quickstart.md): Authenticate and make your first Keette API request.
- [Introduction](https://docs.keette.com/index.md): Build on Keette’s public API — payments, balances, recipients, and webhooks.
- [Environments](https://docs.keette.com/environments.md): One endpoint. Live and sandbox are selected by your API key.
- [API keys](https://docs.keette.com/auth/api-keys.md): Create, expire, allowlist, and revoke workspace API keys.
- [Authentication](https://docs.keette.com/auth/overview.md): Authenticate public API requests with a secret API key.
- [FX](https://docs.keette.com/guides/fx.md): Indicative rates and firm quotes for payouts and swaps.
- [Swaps](https://docs.keette.com/guides/swaps.md): Exchange between your own currency books.
- [Payins](https://docs.keette.com/guides/payins.md): Collect money into your books from supported sources.
- [Payouts](https://docs.keette.com/guides/payouts.md): Send money from a book to a beneficiary.
- [Balances](https://docs.keette.com/guides/balances.md): Read available and held amounts on each currency book.
- [Corridors](https://docs.keette.com/guides/corridors.md): Discover payout schemes, currencies, and required beneficiary fields.
- [Transactions](https://docs.keette.com/guides/transactions.md): Unified history across payouts, payins, swaps, and more.
- [Beneficiaries](https://docs.keette.com/guides/beneficiaries.md): Create and manage payout recipients before you send.
- [Errors](https://docs.keette.com/guides/errors.md): Public API error envelope and status codes.
- [Webhooks](https://docs.keette.com/webhooks/overview.md): Receive signed callbacks for state changes.
- [Event types](https://docs.keette.com/webhooks/events.md): Catalog of event.* names with descriptions and examples.
- [Signatures](https://docs.keette.com/webhooks/signatures.md): Verify webhook authenticity with the signing secret.
- [Retries](https://docs.keette.com/webhooks/retries.md): Backoff schedule and how to retrigger failed deliveries.
- [Introduction](https://docs.keette.com/api-reference/introduction.md): Interactive Keette API reference generated from OpenAPI.
- [Me](https://docs.keette.com/api-reference/account/me.md): Returns the workspace and environment bound to the API key.
- [Ping](https://docs.keette.com/api-reference/events/ping.md): Persists `event.ping` and queues a delivery when the env webhook is active and subscribed to that type.
- [Events](https://docs.keette.com/api-reference/events/events.md): Returns durable events for the environment bound to the API key (newest first). Use `ending_before` (unix seconds) to page older.
- [Event](https://docs.keette.com/api-reference/events/event.md): Returns one durable event by id for the environment bound to the API key. Use this to fetch a missed delivery when you already have the id (from a webhook body or a prior list poll).
- [Balances](https://docs.keette.com/api-reference/balances/balances.md)
- [Transaction](https://docs.keette.com/api-reference/transactions/transaction.md): Full transaction: timeline, source (`payout` / `inflow` / `swap`), expanded `counterparty` (beneficiary or sender fields), and `quote` (id, rate, currencies, amounts) when FX was locked.
- [Transactions](https://docs.keette.com/api-reference/transactions/transactions.md): List activity. Each row includes `counterparty` (with `id` when the recipient is a saved beneficiary) and `quote.id` when a firm FX quote was used. Amounts are Ledger minor units with `scale`.
- [Beneficiary](https://docs.keette.com/api-reference/beneficiaries/beneficiary.md)
- [Beneficiaries](https://docs.keette.com/api-reference/beneficiaries/beneficiaries.md)
- [Create Beneficiary](https://docs.keette.com/api-reference/beneficiaries/create-beneficiary.md): Save a payout recipient. Scheme and routing keys must match a corridor from `GET /corridors`. Emits `event.beneficiary.created`.
- [Update Beneficiary](https://docs.keette.com/api-reference/beneficiaries/update-beneficiary.md): Update mutable fields only (nickname, email, relationship, address). Routing and scheme cannot change — create a new beneficiary instead.
- [Archive Beneficiary](https://docs.keette.com/api-reference/beneficiaries/archive-beneficiary.md)
- [Corridors](https://docs.keette.com/api-reference/catalog/corridors.md)
- [FX Rate](https://docs.keette.com/api-reference/fx/fx-rate.md)
- [FX Quote](https://docs.keette.com/api-reference/fx/fx-quote.md): Lock a firm rate. Use `purpose: swap` for internal transfers between your books, then pass the returned `id` as `quote_id` to `POST /swaps`. Omit purpose (or leave empty) for a payout quote.
- [Purposes](https://docs.keette.com/api-reference/payouts/purposes.md): Allowed purpose codes (and document rules) for this workspace.
- [Get Payout](https://docs.keette.com/api-reference/payouts/get-payout.md)
- [Payout Fee](https://docs.keette.com/api-reference/payouts/payout-fee.md): Estimate transfer fee before creating a payout.
- [Create Payout](https://docs.keette.com/api-reference/payouts/create-payout.md): Create and authorise a send in one step. The API key replaces the workspace PIN. Requires `Idempotency-Key`. Cross-currency sends need `quote_id` from `POST /fx/quotes`. If maker-checker applies, status is `pending_approval` until a second admin approves in the dashboard.
- [Cancel Payout](https://docs.keette.com/api-reference/payouts/cancel-payout.md): Cancel while awaiting auth or pending approval. Queued sends cannot be cancelled via API.
- [Get Swap](https://docs.keette.com/api-reference/swaps/get-swap.md)
- [Create Swap](https://docs.keette.com/api-reference/swaps/create-swap.md): Move funds between your own books using a firm quote from `POST /fx/quotes` with `purpose: swap`. Requires `Idempotency-Key`. The API key replaces the workspace PIN.
- [Sources](https://docs.keette.com/api-reference/payins/sources.md): Funding options into a target wallet (bank details, momo, Interac, crypto).
- [Get Payin](https://docs.keette.com/api-reference/payins/get-payin.md)
- [Payin Fee](https://docs.keette.com/api-reference/payins/payin-fee.md): Estimate partner + Keette fee before starting a deposit.
- [Create Payin](https://docs.keette.com/api-reference/payins/create-payin.md): Start a partner funding session (`bank_transfer`, momo, Interac, Apple Pay, crypto checkout). Prefer `POST /payins/prepare` for static bank / crypto address instructions. Requires `Idempotency-Key`.
- [Payin Preview](https://docs.keette.com/api-reference/payins/payin-preview.md): Fee + indicative FX before `POST /payins/prepare`. Use the same `mode` and currencies you will send to prepare.
- [Prepare Payin](https://docs.keette.com/api-reference/payins/prepare-payin.md): Open a deposit intent and return receive instructions (bank details, crypto address, momo prompt, or Interac). Requires `Idempotency-Key`. Modes: `bank_details`, `crypto_address`, `momo`, `interac`.

## OpenAPI Specs

- [openapi](/openapi.yaml)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.