# Chainrails Documentation

## Docs

- [Introduction](https://docs.chainrails.io/index.md): The easiest way to let users fund your app with crypto or fiat — instantly.
- [Quickstart](https://docs.chainrails.io/quickstart.md): Get up and running with Chainrails in minutes.
- [SDK vs API](https://docs.chainrails.io/sdk-vs-api.md): When to use the SDK vs the API
- [Chainrails vs (Bridges/Aggregators)](https://docs.chainrails.io/concepts/chainrails-vs-others.md): How Chainrails compares to other solutions like bridges and aggregators
- [Refunds](https://docs.chainrails.io/concepts/refunds.md): How Chainrails automates refunds for failed/excess payments
- [Paymaster](https://docs.chainrails.io/concepts/paymaster.md): Sponsor protocol fees for your users with Chainrails Paymaster
- [Know Your Customer (KYC)](https://docs.chainrails.io/concepts/kyc.md): Understand Chainrails-owned KYC, progressive requirements, verification methods, and API states
- [A Full Intent Lifecycle](https://docs.chainrails.io/guides/payments.md): Implement Chainrails cross-chain payment flow from start to finish
- [Cross-chain Quotes & Routing](https://docs.chainrails.io/guides/quotes.md): Retrieve quotes and find optimal routes for cross-chain transfers
- [Complete Ramping Guide](https://docs.chainrails.io/guides/ramping.md): Build fiat on-ramp and off-ramp flows with Chainrails, including headless KYC and hosted provider widgets
- [Mobile Development](https://docs.chainrails.io/guides/mobile-development.md): Build mobile payment flows with Chainrails in React Native
- [Seeker Mobile Guide](https://docs.chainrails.io/guides/seeker-mobile-guide.md): Integrate Chainrails into a React Native app for Solana Seeker devices
- [Mini-Apps](https://docs.chainrails.io/guides/mini-apps.md): Integrate Chainrails into Farcaster/Base MiniApps
- [Webhooks](https://docs.chainrails.io/guides/webhooks.md): Instant notifications about events in your application
- [Settlement Modes](https://docs.chainrails.io/essentials/settlements.md): Understanding Instant and Standard settlement options
- [Supported Networks, Tokens & Currencies](https://docs.chainrails.io/essentials/integrations.md): Check out the networks, tokens and currencies supported by Chainrails
- [Introduction](https://docs.chainrails.io/api-reference/introduction.md): API Reference for Chainrails
- [Get all client intents](https://docs.chainrails.io/api-reference/intents/get-all-client-intents.md): Retrieves all intents for the authenticated client with pagination and optional status filtering
- [Create new intent](https://docs.chainrails.io/api-reference/intents/create-new-intent.md): Creates a new payment intent with cross-chain transfer parameters
- [Get intent by ID](https://docs.chainrails.io/api-reference/intents/get-intent-by-id.md): Retrieves information about a specific intent using its unique id
- [Update intent status](https://docs.chainrails.io/api-reference/intents/update-intent-status.md): Updates the status of an existing intent
- [Refund an expired intent](https://docs.chainrails.io/api-reference/intents/refund-an-expired-intent.md): Manually refunds an expired intent for the authenticated client. This is an escape hatch for recovering stuck funds when automation fails.
- [Manually trigger intent processing](https://docs.chainrails.io/api-reference/intents/manually-trigger-intent-processing.md): Triggers manual processing of an intent. Checks funding status, starts the intent if needed, and initiates completion flow. Use this as a fallback when the indexer misses the funding event.
- [Get intent by address](https://docs.chainrails.io/api-reference/intents/get-intent-by-address.md): Retrieves an intent using its contract address
- [Calculate destination intent address](https://docs.chainrails.io/api-reference/intents/calculate-destination-intent-address.md): Calculates what the intent address would be on the destination chain for a given source intent
- [Get user intents](https://docs.chainrails.io/api-reference/intents/get-user-intents.md): Retrieves all intents created by a specific user
- [Get supported chains](https://docs.chainrails.io/api-reference/chains/get-supported-chains.md): Retrieves all supported blockchain networks, optionally filtered by network type (mainnet/testnet)
- [Get supported tokens for chain](https://docs.chainrails.io/api-reference/chains/get-supported-tokens-for-chain.md): Retrieves all supported tokens available on the specified blockchain network
- [Get wallet balances across all chains](https://docs.chainrails.io/api-reference/chains/get-wallet-balances-across-all-chains.md): Retrieves all token balances for the specified wallet address across all supported blockchain networks. Returns only non-zero balances by default.
- [Get all supported tokens](https://docs.chainrails.io/api-reference/chains/get-all-supported-tokens.md): Retrieves all unique token symbols supported on Chainrails across all blockchain networks
- [Inspect configured provider requirements](https://docs.chainrails.io/api-reference/kyc/inspect-configured-provider-requirements.md)
- [Inspect the current KYC state for a transaction](https://docs.chainrails.io/api-reference/kyc/inspect-the-current-kyc-state-for-a-transaction.md)
- [Submit KYC fields and start any required verification](https://docs.chainrails.io/api-reference/kyc/submit-kyc-fields-and-start-any-required-verification.md)
- [Create a modal session](https://docs.chainrails.io/api-reference/modal-sessions/create-a-modal-session.md): Creates a modal session with constraints (recipient, token, chain, amount). Returns a session token valid for 60 minutes.
- [Get best quote across all bridges](https://docs.chainrails.io/api-reference/quotes/get-best-quote-across-all-bridges.md): Retrieves the best quote (lowest total fee) from all supported bridge protocols
- [Get quotes from all source chains to destination](https://docs.chainrails.io/api-reference/quotes/get-quotes-from-all-source-chains-to-destination.md): Shows Alice all her options to send money to a specific destination chain, including same-chain transfers
- [Get quotes from all bridges](https://docs.chainrails.io/api-reference/quotes/get-quotes-from-all-bridges.md): Retrieves quotes from all supported bridge protocols for comparison
- [Get quote from specific bridge](https://docs.chainrails.io/api-reference/quotes/get-quote-from-specific-bridge.md): Retrieves a cross-chain transfer quote from a specific bridge protocol
- [List supported countries](https://docs.chainrails.io/api-reference/ramp/list-supported-countries.md): Returns all enabled countries with currency details. Optionally filter by fiat currency code, minimum crypto (USDC) amount, and ramp type. When type=off-ramp, only countries with direct S2S off-ramp support are returned.
- [List supported fiat currencies](https://docs.chainrails.io/api-reference/ramp/list-supported-fiat-currencies.md): Returns all enabled fiat currencies. Optionally filter by a specific ramp provider and/or ramp type. When type=off-ramp, only currencies with direct S2S off-ramp support are returned.
- [Get user KYC state](https://docs.chainrails.io/api-reference/ramp/get-user-kyc-state.md): Returns the Chainrails KYC state and transaction requirements for a user.
- [Submit KYC information](https://docs.chainrails.io/api-reference/ramp/submit-kyc-information.md): Submits available KYC fields. The Chainrails KYC engine determines whether text validation, external verification, or both are required.
- [Get provider KYC requirements](https://docs.chainrails.io/api-reference/ramp/get-provider-kyc-requirements.md)
- [List ramp orders](https://docs.chainrails.io/api-reference/ramp/list-ramp-orders.md): Returns ramp orders for the authenticated client, optionally filtered by type. Newest first.
- [Create a ramp order](https://docs.chainrails.io/api-reference/ramp/create-a-ramp-order.md): Creates an on-ramp or off-ramp order with the selected provider.
- [Get a ramp order by ID](https://docs.chainrails.io/api-reference/ramp/get-a-ramp-order-by-id.md): Returns the full details of a ramp order, scoped to the authenticated client.
- [Cancel a ramp order](https://docs.chainrails.io/api-reference/ramp/cancel-a-ramp-order.md): Cancels a ramp order if it is still in a cancellable state.
- [Confirm a ramp order](https://docs.chainrails.io/api-reference/ramp/confirm-a-ramp-order.md): Confirms a ramp order after the user has completed their deposit action.
- [Get a ramp order by intent address](https://docs.chainrails.io/api-reference/ramp/get-a-ramp-order-by-intent-address.md): Returns the full details of a ramp order looked up by its on-chain intent address.
- [Get aggregated ramp quotes](https://docs.chainrails.io/api-reference/ramp/get-aggregated-ramp-quotes.md): Returns on-ramp or off-ramp quotes from all eligible providers, sorted by cheapest total cost.
- [Find optimal cross-chain transfer route](https://docs.chainrails.io/api-reference/router/find-optimal-cross-chain-transfer-route.md): Analyzes available bridges and returns the optimal route with best pricing
- [Get all supported bridges](https://docs.chainrails.io/api-reference/router/get-all-supported-bridges.md): Returns all bridges and their supported routes
- [Get supported bridges for specific route](https://docs.chainrails.io/api-reference/router/get-supported-bridges-for-specific-route.md): Returns all bridges that support transfers between specific source and destination chains
- [Get supported routes for specific bridge](https://docs.chainrails.io/api-reference/router/get-supported-routes-for-specific-bridge.md): Returns all source/destination chain pairs supported by a specific bridge
- [Introduction](https://docs.chainrails.io/sdk-reference/introduction.md): SDK Reference for Chainrails client SDKs for web and mobile cross-chain payments
- [PaymentModal](https://docs.chainrails.io/sdk-reference/components/payment-modal.md): Drop-in payment modal and hooks for Chainrails web and mobile integrations.
- [Create Intent](https://docs.chainrails.io/sdk-reference/intents/create.md): Create a new payment intent with cross-chain transfer parameters
- [Get Intent by ID](https://docs.chainrails.io/sdk-reference/intents/get-by-id.md): Retrieve information about a specific intent
- [Get All Client Intents](https://docs.chainrails.io/sdk-reference/intents/get-all.md): Retrieve all intents for the authenticated client with pagination and filtering
- [Get Intents for Sender](https://docs.chainrails.io/sdk-reference/intents/get-for-sender.md): Retrieve all intents created by a specific user address
- [Get Intent by Address](https://docs.chainrails.io/sdk-reference/intents/get-for-address.md): Retrieve an intent using its contract address
- [Update Intent Status](https://docs.chainrails.io/sdk-reference/intents/update.md): Update the status of an existing intent
- [Get Optimal Routes](https://docs.chainrails.io/sdk-reference/router/get-optimal-routes.md): Analyze available bridges and return the optimal route with best pricing
- [Get All Supported Bridges](https://docs.chainrails.io/sdk-reference/router/get-all-supported-bridges.md): Return all bridges and their supported routes
- [Get Supported Bridges for Route](https://docs.chainrails.io/sdk-reference/router/get-supported-bridges.md): Return all bridges that support transfers between specific source and destination chains
- [Get Supported Routes for Bridge](https://docs.chainrails.io/sdk-reference/router/get-supported-routes.md): Return all source/destination chain pairs supported by a specific bridge
- [Get Quote from Specific Bridge](https://docs.chainrails.io/sdk-reference/quotes/get-from-specific-bridge.md): Retrieve a cross-chain transfer quote from a specific bridge protocol
- [Get Quotes from All Bridges](https://docs.chainrails.io/sdk-reference/quotes/get-from-all-bridges.md): Retrieve quotes from all supported bridge protocols for comparison
- [Get Best Quote Across All Bridges](https://docs.chainrails.io/sdk-reference/quotes/get-best-across-bridges.md): Retrieve the best quote (lowest total fee) from all supported bridge protocols
- [Get Quotes from All Source Chains](https://docs.chainrails.io/sdk-reference/quotes/get-all.md): Show all options to send money to a specific destination chain
- [Get Supported Chains](https://docs.chainrails.io/sdk-reference/chains/get-supported.md): Retrieve all supported blockchain networks, optionally filtered by network type
- [Get Supported Tokens for Chain](https://docs.chainrails.io/sdk-reference/chains/get-supported-tokens.md): Retrieve all supported tokens available on a specified blockchain network
- [Get Client Info](https://docs.chainrails.io/sdk-reference/client/get-client-info.md): Retrieve information about the authenticated client
- [Introduction](https://docs.chainrails.io/sdk-reference/ramp/introduction.md): Allow users make payment using local fiat currencies
- [Get Countries](https://docs.chainrails.io/sdk-reference/ramp/get-countries.md): List all supported countries with currency details
- [Get Currencies](https://docs.chainrails.io/sdk-reference/ramp/get-currencies.md): List all supported on-ramp currencies
- [Get Quotes](https://docs.chainrails.io/sdk-reference/ramp/get-quotes.md): Get aggregated fiat-to-crypto quotes from all eligible providers
- [Create Order](https://docs.chainrails.io/sdk-reference/ramp/create-order.md): Create a fiat-to-crypto order and get a provider widget URL
- [List Orders](https://docs.chainrails.io/sdk-reference/ramp/list-orders.md): List all orders
- [Get Order](https://docs.chainrails.io/sdk-reference/ramp/get-order.md): Retrieve a specific order details by it's id
- [Confirm Order](https://docs.chainrails.io/sdk-reference/ramp/confirm-order.md): Confirm order after user completes deposit
- [Cancel Order](https://docs.chainrails.io/sdk-reference/ramp/cancel-order.md): Cancel an order before completion
- [Introduction](https://docs.chainrails.io/contract-reference/introduction.md): Contract-level Integrations With Chainrails
- [EVM Interface](https://docs.chainrails.io/contract-reference/evm-interface.md): Chainrails Intent Broadcaster Interface for EVM-compatible chains
- [EVM Implementation](https://docs.chainrails.io/contract-reference/evm-implementation.md): Chainrails Intent Broadcaster Implementation for EVM-compatible chains
- [Starknet Interface](https://docs.chainrails.io/contract-reference/starknet-interface.md): Chainrails Intent Broadcaster Interface for Starknet
- [Starknet Implementation](https://docs.chainrails.io/contract-reference/starknet-implementation.md): Chainrails Intent Broadcaster Implementation for Starknet

## OpenAPI Specs

- [openapi](https://docs.chainrails.io/api-reference/openapi.json)

## Optional

- [Dashboard](https://dashboard.chainrails.io)
- [Demo](https://demo.chainrails.io)
- [GitHub Examples](https://github.com/horuslabsio/chainrails-demo)


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