# Koywe Platform Docs

> Accept payments, pay providers, and manage crypto globally

This documentation covers the Koywe Platform API: accepting local payments (PSE, PIX, SPEI, Khipu), paying providers, managing multi-currency virtual accounts, reports, and crypto on/off-ramp across Latin America.

The OpenAPI specification is available at https://docs.koywe.com/openapi.json.

## Getting Started

- [🔑 Sandbox Credentials](https://docs.koywe.com/en/getting-started/credentials)
- [Onboarding & KYB](https://docs.koywe.com/en/getting-started/onboarding-kyb): Registration drafts, onboarding status, and merchant KYB
- [Organization Setup & Invitations](https://docs.koywe.com/en/getting-started/organization-setup): Set up organizations, merchants, users, and API credentials
- [⚡ 5-Minute Quickstart](https://docs.koywe.com/en/getting-started/quickstart): Make your first API call in minutes
- [🏁 Getting Started](https://docs.koywe.com/en/getting-started/setup-guide): Complete integration guide for dashboard users and API developers
- [🧪 Testing in Sandbox](https://docs.koywe.com/en/getting-started/testing): Complete guide to testing all payment scenarios
- [Webhooks & Statuses](https://docs.koywe.com/en/getting-started/webhooks-overview): Configure webhook endpoints and inspect event delivery

## Policies and Passkeys

- [First steps](https://docs.koywe.com/en/policies-and-passkeys): The first things to keep in mind as soon as you log in to your account
- [Passkeys](https://docs.koywe.com/en/policies-and-passkeys/passkeys): How they are created, who approves them, and how each operation is signed
- [User roles](https://docs.koywe.com/en/policies-and-passkeys/roles): What each role can do, at a glance
- [Admin](https://docs.koywe.com/en/policies-and-passkeys/roles/admin): Manages the organization and the approval policy rules. Does not move money
- [API users](https://docs.koywe.com/en/policies-and-passkeys/roles/api-users): Credentials for your system, with different ground rules
- [Operator](https://docs.koywe.com/en/policies-and-passkeys/roles/operator): Runs the day to day. Does not sign or approve
- [Root user](https://docs.koywe.com/en/policies-and-passkeys/roles/root-user): The owner of security. It is not a role, and there is only one per organization
- [Super Admin](https://docs.koywe.com/en/policies-and-passkeys/roles/super-admin): Everything: governance and money. The role of the operational owner
- [Treasury Manager](https://docs.koywe.com/en/policies-and-passkeys/roles/treasury-manager): Moves and approves money. Does not change the approval policy rules
- [Viewer](https://docs.koywe.com/en/policies-and-passkeys/roles/viewer): Only looks. Changes nothing
- [Approval Policy](https://docs.koywe.com/en/policies-and-passkeys/transactional-policy): The rules that decide whether an operation goes through, is denied, or waits for a signature
- [Troubleshooting](https://docs.koywe.com/en/policies-and-passkeys/troubleshooting): What each block really means, how to clear it, and who resolves it

## Core Concepts

- [Core Concepts Overview](https://docs.koywe.com/en/core-concepts): Understanding the Koywe Payments architecture
- [Contacts & Bank Accounts](https://docs.koywe.com/en/core-concepts/contacts-and-bank-accounts): Managing customer and provider information
- [Merchant External Accounts](https://docs.koywe.com/en/core-concepts/merchant-external-accounts): Setting up bank and crypto accounts for receiving funds
- [Orders & Order Types](https://docs.koywe.com/en/core-concepts/orders-and-order-types): Understanding the seven order types and when to use each
- [Organizations & Merchants](https://docs.koywe.com/en/core-concepts/organizations-and-merchants): Understanding the hierarchy and structure
- [Payment Rails](https://docs.koywe.com/en/core-concepts/payment-rails): Declaring how a destination is reachable — Bre-B key or bank account
- [Quotes & Exchange Rates](https://docs.koywe.com/en/core-concepts/quotes-and-exchange-rates): Understanding quotes and rate locking
- [Supported Corridors & Currencies](https://docs.koywe.com/en/core-concepts/supported-corridors): Where Koywe settles, in which currency, over which local rail
- [Virtual Accounts](https://docs.koywe.com/en/core-concepts/virtual-accounts): Managing multi-currency balances

## Accepting Payments

- [Accepting Payments - Overview](https://docs.koywe.com/en/accepting-payments): Understanding PAYIN orders and payment acceptance
- [Accepting Payments - Integration Guide](https://docs.koywe.com/en/accepting-payments/integration-guide): Complete step-by-step integration for production
- [Payment Methods by Country](https://docs.koywe.com/en/accepting-payments/payment-methods): Detailed guide to each payment method
- [Troubleshooting - Accepting Payments](https://docs.koywe.com/en/accepting-payments/troubleshooting): Common issues and solutions

## Paying Providers

- [Paying Providers - Overview](https://docs.koywe.com/en/paying-providers): Understanding PAYOUT orders and provider payments
- [Paying Providers - Integration Guide](https://docs.koywe.com/en/paying-providers/integration-guide): Complete step-by-step integration for payouts

## Balance Management

- [Balance Transfers](https://docs.koywe.com/en/balance-management): Currency exchange between virtual accounts
- [Deposit Accounts](https://docs.koywe.com/en/balance-management/deposit-accounts): Fund your merchant balance with bank deposit account details

## Reports & Reconciliation

- [Reports & Reconciliation](https://docs.koywe.com/en/reports): Financial reporting and account reconciliation
- [Ledger Entry Details](https://docs.koywe.com/en/reports/ledger-entry-details): Transaction receipt and proof
- [Ledger Statement](https://docs.koywe.com/en/reports/ledger-statement): Bank-style account statement
- [Orders Report](https://docs.koywe.com/en/reports/orders-report): Transaction-level order reporting

## Crypto Operations

- [Offramp - Sell Crypto](https://docs.koywe.com/en/crypto-operations/offramp): Convert cryptocurrency to fiat
- [Onramp - Buy Crypto](https://docs.koywe.com/en/crypto-operations/onramp): Convert fiat to cryptocurrency

## CLI Tool

- [Koywe CLI](https://docs.koywe.com/en/cli): Command-line tool for the Koywe Platform API — designed for developers and AI agents
- [API ↔ CLI Cross-Reference](https://docs.koywe.com/en/cli/api-cross-reference): Every Koywe REST endpoint mapped to the CLI command that calls it
- [CLI Command Reference](https://docs.koywe.com/en/cli/reference): Complete catalog of all 142 commands in @koyweforest/cli v0.14.1, generated from the CLI itself

## Advanced Topics

- [Error Code Catalog](https://docs.koywe.com/en/advanced/error-codes): All 690 error codes returned by the Koywe Platform API
- [Error Handling](https://docs.koywe.com/en/advanced/error-handling): How Koywe API errors are structured, how to recover from them, and where to find every code
- [Notifications](https://docs.koywe.com/en/advanced/notifications): In-app and email notifications for merchant users
- [Passkeys & Approvals](https://docs.koywe.com/en/advanced/passkeys-and-approvals): WebAuthn MFA, embedded wallet signing, and transactional policy approvals
- [Security Best Practices](https://docs.koywe.com/en/advanced/security): Secure your Koywe integration
- [Transactional Policy & Approval Schemes](https://docs.koywe.com/en/advanced/transactional-policy): How to model rules, conditions, and multi-party approvals for sensitive money movements
- [Webhooks Deep Dive](https://docs.koywe.com/en/advanced/webhooks): Advanced webhook handling and best practices

## What's new

- [What's new](https://docs.koywe.com/en/release-notes)
- [The documentation has a new design](https://docs.koywe.com/en/release-notes/new-docs-design)
- [Viewing a quote no longer requires payment permissions](https://docs.koywe.com/en/release-notes/quote-without-payment-permission)

## Optional

- [Full documentation (concatenated)](https://docs.koywe.com/llms-full.txt): every page inlined as plain markdown
- [OpenAPI specification](https://docs.koywe.com/openapi.json): machine-readable API reference