# CoinVoyage

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

## Docs

- [Claim Fees](https://docs.coinvoyage.io/api-reference/fees/claim-fees.md): Claim accrued fees for the authenticated organization
- [Get Fee Balances](https://docs.coinvoyage.io/api-reference/fees/get-fee-balances.md): Retrieve the claimable fee balances for the authenticated organization
- [Create KYC Link](https://docs.coinvoyage.io/api-reference/kyc/create-kyc-link.md): Generate a KYC/TOS verification link via Bridge.xyz for a customer to complete identity verification
- [KYC Status](https://docs.coinvoyage.io/api-reference/kyc/kyc-status.md): Retrieve the current status of a KYC verification
- [Create a PayOrder](https://docs.coinvoyage.io/api-reference/pay-orders/create-a-payorder.md): Create a new PayOrder for cryptocurrency payment processing. `SALE` mode requires an `Authorization` signature; other modes accept either `X-API-KEY` or `Authorization`.
- [Create Refund](https://docs.coinvoyage.io/api-reference/pay-orders/create-refund.md): Create a refund for a PayOrder
- [Get Payment Details](https://docs.coinvoyage.io/api-reference/pay-orders/get-payment-details.md): Get payment details for a PayOrder
- [Get Payment Methods](https://docs.coinvoyage.io/api-reference/pay-orders/get-payment-methods.md): Get the available payment methods for a PayOrder at the current request origin
- [Get PayOrder](https://docs.coinvoyage.io/api-reference/pay-orders/get-payorder.md): Retrieve details of a specific PayOrder
- [List PayOrders](https://docs.coinvoyage.io/api-reference/pay-orders/list-payorders.md): Retrieve a paginated list of pay orders for the authenticated organization
- [Quote PayOrder](https://docs.coinvoyage.io/api-reference/pay-orders/quote-payorder.md): Get payment quotes for a PayOrder
- [Get Swap Data](https://docs.coinvoyage.io/api-reference/swap/get-swap-data.md): Get transaction data for executing a swap
- [Get Swap Quote](https://docs.coinvoyage.io/api-reference/swap/get-swap-quote.md): Get a quote for swapping between two currencies
- [Create Webhook](https://docs.coinvoyage.io/api-reference/webhooks/create-webhook.md): Create a new webhook for the authenticated organization to receive event notifications
- [Delete Webhook](https://docs.coinvoyage.io/api-reference/webhooks/delete-webhook.md): Delete an existing webhook for the authenticated organization
- [List Webhooks](https://docs.coinvoyage.io/api-reference/webhooks/list-webhooks.md): Retrieve all webhooks for the authenticated organization
- [Update Webhook](https://docs.coinvoyage.io/api-reference/webhooks/update-webhook.md): Update an existing webhook for the authenticated organization
- [Order Status WebSocket](https://docs.coinvoyage.io/api-reference/websocket/order-status-websocket.md): Upgrade to a WebSocket connection to receive real-time order status events.
- [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 PayOrder creation through provider chaining to final settlement.
- [PayOrders: DEPOSIT, SALE, REFUND modes and statuses](https://docs.coinvoyage.io/concepts/pay-orders.md): Understand the PayOrder object at the center of every CoinVoyage payment — its three modes, full status lifecycle, and how to attach 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.
- [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.
- [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.
- [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.
- [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.
- [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.
- [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.
- [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.
- [CoinVoyage: non-custodial cross-chain crypto payments](https://docs.coinvoyage.io/introduction.md): CoinVoyage is a non-custodial crypto payments platform that lets 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.
- [CoinVoyage SDK and API changelog — release notes](https://docs.coinvoyage.io/resources/changelog.md): All notable changes to the CoinVoyage SDK, API, and platform, ordered newest-first. Includes breaking changes, new features, and bug 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 pricing: transaction fees and volume plans](https://docs.coinvoyage.io/resources/pricing.md): CoinVoyage charges 1.5% per successful transaction with no offramp fees. Volume discounts are available on request.
- [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.
- [ApiClient — server-side CoinVoyage REST API client](https://docs.coinvoyage.io/sdk/apiclient.md): Use ApiClient from @coin-voyage/paykit/server to create pay orders, fetch quotes, manage webhooks, stream real-time order status, and claim fees.
- [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 usePayStatus fit into your integration.
- [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.
- [PayKitProvider — set up your global payment context](https://docs.coinvoyage.io/sdk/paykitprovider.md): Configure PayKitProvider with your API key, theme, environment, wallet callbacks, and global PayKitOptions to control every aspect of 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.
- [CoinVoyage webhook event types and payload reference](https://docs.coinvoyage.io/webhooks/events.md): Every PayOrder webhook event with its subscription identifier, payload type value, and full JSON example delivered to your endpoint.
- [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 PayOrder lifecycle events in your server.

## OpenAPI Specs

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