# Hyperrail - Documentation ## Docs - [Authentication](https://docs.hyperrails.io/api-reference/authentication.md): Secure authentication is crucial for protecting your account and ensuring authorized access. All API requests require authentication with your secret key, kindly include it in the `Authorization` header for secure access. - [Create Dynamic Account](https://docs.hyperrails.io/api-reference/dynamic-accounts/create-dynamic-account.md): Dynamic accounts don't act as independent money storage - they simply channel incoming payments straight to your account. These accounts cannot process outgoing payments or be linked to payment terminals. Since virtual accounts do not serve as containers for funds, there's no need for BVN verificati… - [Get Dynamic Account by ID](https://docs.hyperrails.io/api-reference/dynamic-accounts/dynamic-account-id.md): Get details of your created dynamic account by its ID. - [Get All Dynamic Accounts](https://docs.hyperrails.io/api-reference/dynamic-accounts/list-dynamic-account.md): This retrieves and lists all the active dynamic accounts you created. - [Error Codes](https://docs.hyperrails.io/api-reference/error-codes.md): Encountered an error? This page explains Hyperrial API error codes, what they mean, and how to resolve them. - [Accept Quote](https://docs.hyperrails.io/api-reference/hyperrail-quote/accept-quote.md): Finalize and accept a specific quote by providing the settlement destination details (Bank or Blockchain). - [Cancel Quote](https://docs.hyperrails.io/api-reference/hyperrail-quote/cancel-quote.md): Cancels an active or pending quote session. Once cancelled, the quote can no longer be accepted or completed. - [Create Instant Trade](https://docs.hyperrails.io/api-reference/hyperrail-quote/create-express-quote.md): Create an express quote with automatic best-rate provider selection and immediate execution. - [Create Payment Intent](https://docs.hyperrails.io/api-reference/hyperrail-quote/create-payment-intent.md): Initiates a quote request for a currency exchange, specifying the amount and direction (source or destination). - [Remove Quote Item](https://docs.hyperrails.io/api-reference/hyperrail-quote/delete-quote-item.md): Removes a specific allocation or item from an existing quote session using the quote ID and item ID. - [Edit Quote](https://docs.hyperrails.io/api-reference/hyperrail-quote/edit-quote.md): Updates an existing quote session by adding or modifying the pool allocation details, including amount and direction. - [Complete a Quote By its ID](https://docs.hyperrails.io/api-reference/hyperrail-quote/get-complete-quote-id.md): Fetches the final status and payment instructions for a completed marketplace quote session. - [Get Quote By ID](https://docs.hyperrails.io/api-reference/hyperrail-quote/get-quote-id.md): Returns the full details of a specific marketplace quote, including allocation results, payment metadata (Bank or Crypto), and chat history timestamps. - [Get All Wallets](https://docs.hyperrails.io/api-reference/hyperrail-wallet/get.md): Returns all balances - [Get Wallet By Currency](https://docs.hyperrails.io/api-reference/hyperrail-wallet/get-balance-currency.md): Returns all balance by currency - [Get Wallet By ID](https://docs.hyperrails.io/api-reference/hyperrail-wallet/get-balance-id.md): Returns all balance by account ID - [API Reference](https://docs.hyperrails.io/api-reference/introduction.md): HyperRail APIs allow approved partners to programmatically access on-ramp, off-ramp, and fiat currency exchange functionality through secure, RESTful endpoints. - [Endpoint Mapping](https://docs.hyperrails.io/api-reference/iso20022/endpoint-mapping.md) - [Get All Banks](https://docs.hyperrails.io/api-reference/payout/list-banks.md): Get details of all banks, their names and codes - [Resolve Bank Account](https://docs.hyperrails.io/api-reference/payout/resolve-account.md): Get/Validate A Specific Account Number and Bank Code with its details i.e the account name - [Create Wallet Payout](https://docs.hyperrails.io/api-reference/payout/wallet-payout.md): Processes a withdrawal request from a partner wallet to an on-chain blockchain address. Supports USDC, USDT withdrawals on Ethereum, Polygon, and Base networks. - [Create Fiat Payout](https://docs.hyperrails.io/api-reference/payout/withdrawal.md): Processes a withdrawal request from a specified account to a destination bank account. - [Get Rate](https://docs.hyperrails.io/api-reference/rate/get-rate.md): Retrieve the current exchange rate between two currencies. Optionally specify a blockchain network. - [Get Rate Stream](https://docs.hyperrails.io/api-reference/rate/rate-stream.md): Subscribe to real-time exchange rate updates via Server-Sent Events (SSE). The connection remains open and pushes rate updates as they occur. - [Account Management](https://docs.hyperrails.io/documentation/features/account-management.md): Manage your HyperRail account details, profile information, and brand settings from a single place. - [Currency Exchange (Fiat)](https://docs.hyperrails.io/documentation/features/currency-exchange-fiat.md): Exchange one fiat currency for another using HyperRail’s exchange feature. - [Fiat Payout Process](https://docs.hyperrails.io/documentation/features/fiat-payout-process.md): A comprehensive guide to managing and executing fiat payouts on Hyperrails - [Off-Ramp Transactions](https://docs.hyperrails.io/documentation/features/offramp-transaction.md): Convert stablecoins into fiat currency using HyperRail’s off-ramp feature. - [On-Ramp Transactions](https://docs.hyperrails.io/documentation/features/onramp-transaction.md): Convert fiat currency into stablecoins using HyperRail’s on-ramp feature. - [Payout Structure](https://docs.hyperrails.io/documentation/features/payout-structure.md): The Payout process is how your earned revenue moves from your Hyperrails Balance to your preferred Bank Account via Bank Transfer. We offer flexible cycles to match your cash flow needs. - [Your Team Members](https://docs.hyperrails.io/documentation/features/team-members.md): Invite team members to your HyperRail dashboard and manage their access using predefined or custom roles. - [Verification Process](https://docs.hyperrails.io/documentation/kyb-verification.md): Learn how to complete HyperRail’s mandatory onboarding verification process to access trading, liquidity, and treasury features securely and compliantly. - [Onboarding Process](https://docs.hyperrails.io/documentation/onboarding.md): Learn how to get started on HyperRail as a Merchant or Liquidity Provider. - [FAQs](https://docs.hyperrails.io/documentation/support-channel/faq.md): Answers to common questions about HyperRail, including on-ramp, off-ramp, fiat exchange, liquidity, wallets, team management, and security. - [Funding in Test Mode](https://docs.hyperrails.io/documentation/testing/funding-in-test-mode.md): Learn how to add fake funds in HyperRail's test environment using the Funding Simulator App. - [Test Mode Overview](https://docs.hyperrails.io/documentation/testing/test-mode-overview.md): Understand how HyperRail's test environment works before you start building. - [Overview](https://docs.hyperrails.io/documentation/webhooks/overview.md): Webhooks are your essential tool for real-time notifications. They provide instant, server-to-server notifications when critical events occur within the HyperRails platform, ensuring your application is always up-to-date, enabling seamless integration. - [Webhooks Payload](https://docs.hyperrails.io/documentation/webhooks/payloads.md): This is the structure of the data payload sent to your webhook URL whenever an order is successful within HyperRails. ## OpenAPI Specs - [openapi](https://docs.hyperrails.io/api-reference/openapi.json)