# CoinVoyage

> CoinVoyage enables seamless crypto payments into your app from any supported chain and coin.

## Docs

- [CoinVoyage: non-custodial cross-chain crypto payments](https://docs.coinvoyage.io/introduction.md): Non-custodial crypto payments platform — users pay with any supported token while you settle in the asset and chain you choose.
- [Quickstart: install CoinVoyage and accept payments](https://docs.coinvoyage.io/quickstart.md): Install @coin-voyage/paykit, configure WalletProvider and PayKitProvider, and render a working PayButton in your React app in minutes.
- [Migrate from v2 to v3](https://docs.coinvoyage.io/resources/migration-v2-to-v3.md): Upgrade a CoinVoyage v2 integration to the v3 API and PayKit SDK surface.
- [How CoinVoyage routes and settles cross-chain payments](https://docs.coinvoyage.io/concepts/how-it-works.md): Learn how CoinVoyage routes payments from any chain to your destination, from order creation through provider chaining to final settlement.
- [Orders: DEPOSIT, SALE, REFUND modes and statuses](https://docs.coinvoyage.io/concepts/pay-orders.md): Understand the CoinVoyage order object at the center of every payment, including modes, statuses, and metadata.
- [Blockchain networks and chain IDs supported by CoinVoyage](https://docs.coinvoyage.io/concepts/supported-networks.md): Complete list of every blockchain CoinVoyage supports for payments and settlement, including chain IDs, testnet availability, and upcoming networks.
- [Fiat off-ramp regions, currencies, and payment rails](https://docs.coinvoyage.io/concepts/supported-regions.md): Learn which fiat currencies CoinVoyage supports for settlement, the payment rails used in each region, settlement timing, and KYC requirements.
- [CoinVoyage integration flows](https://docs.coinvoyage.io/flows/overview.md): Choose the right CoinVoyage flow for wallet deposits, merchant checkout, swaps, optional fiat off-ramp payouts, dashboard invoices, and x402 payments.
- [CoinVoyage invoices](https://docs.coinvoyage.io/invoices/overview.md): Create crypto invoices from the dashboard or API, send hosted payment links, track linked orders, and settle customer payments.
- [Invoices API](https://docs.coinvoyage.io/invoices/api.md): Create, publish, list, retrieve, archive, and delete CoinVoyage invoices through the signed v3 REST API.
- [CoinVoyage PayKit SDK — overview and installation guide](https://docs.coinvoyage.io/sdk/overview.md): Install @coin-voyage/paykit and learn how PayKitProvider, WalletProvider, PayButton, ApiClient, and status hooks fit into your integration.
- [PayKitProvider — set up your global payment context](https://docs.coinvoyage.io/sdk/paykitprovider.md): Configure PayKitProvider with your API key, environment, visual mode, wallet callbacks, and global PayKitOptions to control the payment modal.
- [WalletProvider — configure multi-chain wallet connectors](https://docs.coinvoyage.io/sdk/walletprovider.md): Configure WalletProvider with chain-specific settings for EVM, Solana, Sui, and UTXO wallets including RPC URLs, adapters, and connectors.
- [PayButton — ready-made crypto payment UI component](https://docs.coinvoyage.io/sdk/paybutton.md): Render a pre-styled payment button that opens a CoinVoyage modal for wallet selection, transaction signing, and real-time status tracking.
- [ApiClient - server-side CoinVoyage REST API client](https://docs.coinvoyage.io/sdk/apiclient.md): Initialize ApiClient from @coin-voyage/paykit/server and navigate its order, wallet, swap, on-ramp, off-ramp, invoice, fee, webhook, and type references.
- [ApiClient authentication and authorization signatures](https://docs.coinvoyage.io/sdk/apiclient/authentication.md): Authenticate CoinVoyage ApiClient calls and generate HMAC-SHA256 signatures for privileged v3 API operations.
- [ApiClient order methods](https://docs.coinvoyage.io/sdk/apiclient/orders.md): Create CoinVoyage deposit, sale, and refund orders; list and retrieve orders; quote payments; and generate payment instructions.
- [ApiClient wallet and currency search methods](https://docs.coinvoyage.io/sdk/apiclient/wallets-and-search.md): Search CoinVoyage currencies and retrieve balances for up to ten wallets with ApiClient.
- [ApiClient standalone swap methods](https://docs.coinvoyage.io/sdk/apiclient/swaps.md): Quote and execute standalone cross-chain and same-chain swaps with CoinVoyage ApiClient.
- [ApiClient on-ramp methods](https://docs.coinvoyage.io/sdk/apiclient/on-ramp.md): Use CoinVoyage ApiClient methods for Stripe Link authentication and embedded card-funded crypto on-ramp sessions.
- [ApiClient off-ramp methods](https://docs.coinvoyage.io/sdk/apiclient/off-ramp.md): Manage CoinVoyage off-ramp verification, linked bank accounts, and fiat payout intents with signed ApiClient methods.
- [ApiClient invoice methods](https://docs.coinvoyage.io/sdk/apiclient/invoices.md): Create, publish, list, retrieve, archive, and delete CoinVoyage invoices and drafts with signed ApiClient methods.
- [ApiClient fee methods](https://docs.coinvoyage.io/sdk/apiclient/fees.md): Retrieve and claim CoinVoyage organization fee balances with signed ApiClient methods.
- [ApiClient webhooks and WebSocket subscriptions](https://docs.coinvoyage.io/sdk/apiclient/webhooks-and-websockets.md): Manage CoinVoyage webhook subscriptions and listen for real-time order events with ApiClient.
- [ApiClient core types](https://docs.coinvoyage.io/sdk/apiclient/types.md): Reference the core CoinVoyage order, status, payment, and funding types returned by ApiClient.
- [useOrderStatusWS - order status WebSocket hook](https://docs.coinvoyage.io/sdk/useorderstatusws.md): Subscribe to CoinVoyage order status events from React with automatic reconnects and connection-state callbacks.
- [PayKit Headless (Preview) - x402 payments for agents and servers](https://docs.coinvoyage.io/sdk/paykit-headless.md): Use the Preview @coin-voyage/paykit-headless package to satisfy CoinVoyage x402 PAYMENT-REQUIRED challenges without browser wallet UI.
- [CoinVoyage API overview](https://docs.coinvoyage.io/api/overview.md): Learn how to call the CoinVoyage v3 API directly, including authentication, orders, invoices, swaps, off-ramp flows, errors, pagination, and webhook-driven processing.
- [Set up webhooks for real-time payment notifications](https://docs.coinvoyage.io/webhooks/overview.md): Register a CoinVoyage webhook endpoint, verify HMAC-SHA256 delivery signatures, and handle order lifecycle events in your server.
- [CoinVoyage webhook event types and payload reference](https://docs.coinvoyage.io/webhooks/events.md): Every CoinVoyage order webhook event with its subscription identifier and v3 payload structure.
- [CoinVoyage Dashboard: manage payments and settings](https://docs.coinvoyage.io/dashboard/overview.md): Manage payments, configure settlement currencies, issue refunds, withdraw to fiat, and set up developer integrations from one place.
- [Transactions: search, inspect, and refund payments](https://docs.coinvoyage.io/dashboard/transactions.md): Use the Transactions tab to search and filter payments, view full on-chain details, and initiate full or partial refunds directly from the dashboard.
- [Settlement currencies: choose your payout asset and chain](https://docs.coinvoyage.io/dashboard/settlement.md): Define which asset and chain you receive payment settlement in, regardless of what your customers pay with at checkout.
- [Withdrawals: off-ramp crypto settlement balances to fiat](https://docs.coinvoyage.io/dashboard/withdrawals.md): Move supported settlement balances off-chain to a linked bank account after completing identity verification and configuring a payout destination.
- [Custom fees: charge an extra percentage on every payment](https://docs.coinvoyage.io/dashboard/custom-fees.md): Configure a custom fee percentage on top of the CoinVoyage platform fee, then claim accrued fees in USDC on EVM, Sui, or Solana.
- [Invoices: send crypto payment requests to customers](https://docs.coinvoyage.io/dashboard/invoices.md): Create and send crypto invoices directly from the CoinVoyage Dashboard. Customers pay via a link; you receive settlement in your preferred currency.
- [Manage API keys and webhooks in the Developers tab](https://docs.coinvoyage.io/dashboard/developers.md): Generate and rotate your CoinVoyage API key pair, configure webhook endpoints, and follow security best practices for your integration.
- [Production checklist](https://docs.coinvoyage.io/guides/production-checklist.md): Validate credentials, settlement settings, webhooks, payment states, refunds, monitoring, and reconciliation before launching CoinVoyage payments in production.
- [CoinVoyage pricing: transaction fees and volume plans](https://docs.coinvoyage.io/resources/pricing.md): CoinVoyage charges 1.5% per successful transaction with no off-ramp fees. Volume discounts are available on request.
- [CoinVoyage API rate limits, 429 responses, and retry behavior](https://docs.coinvoyage.io/resources/rate-limits.md): Understand CoinVoyage API rate limits, how to handle 429 Too Many Requests responses, and recommended retry and backoff behavior for production integrations.
- [CoinVoyage SDK and API changelog — release notes](https://docs.coinvoyage.io/resources/changelog.md): Integration-facing CoinVoyage SDK and API changes, ordered newest-first. Includes breaking changes, new features, and user-visible fixes.
- [CoinVoyage integration FAQ: auth, testing, and flows](https://docs.coinvoyage.io/resources/faqs.md): Common questions about testing, authentication, Deposit vs Sale flows, authorization signatures, and viewing transaction history in CoinVoyage.
- [CoinVoyage support: contact, examples, and resources](https://docs.coinvoyage.io/resources/support.md): Contact CoinVoyage support by email, test with the example site, browse GitHub examples, or inquire about enterprise and volume pricing.
- [Get Fee Balance](https://docs.coinvoyage.io/api-reference/fees/get-fee-balance.md)
- [Claim Fees](https://docs.coinvoyage.io/api-reference/fees/claim-fees.md)
- [List Invoices](https://docs.coinvoyage.io/api-reference/invoices/list-invoices.md)
- [Create Invoice](https://docs.coinvoyage.io/api-reference/invoices/create-invoice.md): Creates and publishes an invoice backed by a SALE pay order. The recipient is emailed a PDF invoice with a hosted payment link. Pass id to publish an existing draft.
- [Save Invoice Draft](https://docs.coinvoyage.io/api-reference/invoices/save-invoice-draft.md): Creates a draft invoice, or updates an existing unpublished one when id is set. Draft blocks are stored verbatim and only validated at publish.
- [Get Invoice](https://docs.coinvoyage.io/api-reference/invoices/get-invoice.md)
- [Delete Invoice Draft](https://docs.coinvoyage.io/api-reference/invoices/delete-invoice-draft.md): Deletes an unpublished draft. Published invoices cannot be deleted.
- [Archive Invoice](https://docs.coinvoyage.io/api-reference/invoices/archive-invoice.md)
- [List Bank Accounts](https://docs.coinvoyage.io/api-reference/off-ramp/list-bank-accounts.md)
- [Add Bank Account](https://docs.coinvoyage.io/api-reference/off-ramp/add-bank-account.md)
- [Get Bank Account](https://docs.coinvoyage.io/api-reference/off-ramp/get-bank-account.md)
- [List Off-ramp Intents](https://docs.coinvoyage.io/api-reference/off-ramp/list-off-ramp-intents.md)
- [Create Off-ramp Intent](https://docs.coinvoyage.io/api-reference/off-ramp/create-off-ramp-intent.md)
- [Create Off-ramp Verification](https://docs.coinvoyage.io/api-reference/off-ramp/create-off-ramp-verification.md)
- [Off-ramp Verification Status](https://docs.coinvoyage.io/api-reference/off-ramp/off-ramp-verification-status.md)
- [Create Onramp Auth Intent](https://docs.coinvoyage.io/api-reference/onramp/create-onramp-auth-intent.md): Create a Stripe Link OAuth auth intent for the embedded onramp flow.
- [Create Onramp Auth Token](https://docs.coinvoyage.io/api-reference/onramp/create-onramp-auth-token.md): Create a short-lived Stripe Link auth token client secret for React Native seamless sign-in. The server uses the previously stored Link OAuth token for the provided auth intent.
- [Create Onramp Intent](https://docs.coinvoyage.io/api-reference/onramp/create-onramp-intent.md): Create a reusable onramp intent. For Orders, amount, destination currency, and wallet fields are derived server-side from the Order and cannot be overridden by the client.
- [Create Onramp Session](https://docs.coinvoyage.io/api-reference/onramp/create-onramp-session.md): Create a headless Stripe embedded onramp session from a server-held onramp intent using the server-held Link OAuth access token. If Stripe identity or KYC action is required, this endpoint returns 422 with action fields in error.details, including status, reason, kyc_next_step, kyc_status, kyc_requi…
- [Checkout Onramp Session](https://docs.coinvoyage.io/api-reference/onramp/checkout-onramp-session.md): Checkout a headless Stripe embedded onramp session and return the checkout client secret required by the Stripe embedded component. The session is resolved to the stored Link OAuth token server-side.
- [Refresh Onramp Quote](https://docs.coinvoyage.io/api-reference/onramp/refresh-onramp-quote.md): Refresh the executable quote for a headless Stripe embedded onramp session. The session is resolved to the stored Link OAuth token server-side.
- [Get Onramp Verification Status](https://docs.coinvoyage.io/api-reference/onramp/get-onramp-verification-status.md): Retrieve normalized Stripe CryptoCustomer KYC and identity verification status after Link authentication or after KYC steps. The server exchanges or reuses the Link OAuth token and never returns it to the client.
- [List Orders](https://docs.coinvoyage.io/api-reference/orders/list-orders.md): Paginated list of orders for the authenticated organization.
- [Create Order](https://docs.coinvoyage.io/api-reference/orders/create-order.md): Create an order (SALE / DEPOSIT). SALE requires an Authorization signature; DEPOSIT accepts X-API-KEY or a signature.
- [Get Order](https://docs.coinvoyage.io/api-reference/orders/get-order.md)
- [Create Payment Details](https://docs.coinvoyage.io/api-reference/orders/create-payment-details.md): Create the payment details for an order — returns the resolved payment block (receiving address, amount, expiry, and steps to fund). The server always requotes (no quote_id).
- [Get Payment Methods](https://docs.coinvoyage.io/api-reference/orders/get-payment-methods.md)
- [Order Quotes](https://docs.coinvoyage.io/api-reference/orders/order-quotes.md): Ranked options for paying an order: source tokens (wallet scan and/or explicit list) ranked against the order fulfillment destination, falling back to a settlement currency. EXACT_OUTPUT only.
- [Refund Order](https://docs.coinvoyage.io/api-reference/orders/refund-order.md)
- [x402 Complete](https://docs.coinvoyage.io/api-reference/x402/x402-complete.md): x402 payment completion. Public: the PAYMENT-SIGNATURE header is the auth boundary. Without it, returns 402 with a PAYMENT-REQUIRED header.
- [Currency Search (Typeahead)](https://docs.coinvoyage.io/api-reference/search/currency-search-typeahead.md): Token search for source/destination pickers. Queries shorter than 2 characters return an empty list.
- [Execute Swap](https://docs.coinvoyage.io/api-reference/swap/execute-swap.md): Create the payment details for a SWAP-mode order — returns the deposit instruction (payment block with steps to fund).
- [Swap Quote](https://docs.coinvoyage.io/api-reference/swap/swap-quote.md): Spammable single-pair swap quote for live price discovery. Flat request/response. result_type carries soft errors on a 200. Optional recipient; fees match the swap execute path.
- [Wallet Portfolio](https://docs.coinvoyage.io/api-reference/wallet/wallet-portfolio.md): Scan wallets with per-wallet success or error results.
- [List Webhooks](https://docs.coinvoyage.io/api-reference/webhooks/list-webhooks.md)
- [Create Webhook](https://docs.coinvoyage.io/api-reference/webhooks/create-webhook.md)
- [Delete Webhook](https://docs.coinvoyage.io/api-reference/webhooks/delete-webhook.md)
- [Update Webhook (partial)](https://docs.coinvoyage.io/api-reference/webhooks/update-webhook-partial.md)
- [Order Status WebSocket](https://docs.coinvoyage.io/api-reference/websocket/order-status-websocket.md): Upgrade to a WebSocket for real-time order events. Authenticate with a `connect` message, then `subscribe` by `order_id`. Event pushes use `{"type":"event","data":{"event":"ORDER_*","delivered_at":...,"order":{...}}}`.

## OpenAPI Specs

- [openapi](https://api.coinvoyage.io/v3/openapi.json)