# Ivorypay On-Off Ramp Documentation

## Ivorypay On-Off Ramp Documentation

- [Introduction](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/overview/readme.md): The complete API reference for IvoryPay's On/Off-Ramp platform. Accept crypto payments, process fiat payouts, and bridge traditional finance with blockchain — all through a single API.
- [Authentication](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/getting-started/authentication.md): How to authenticate your API requests to IvoryPay.
- [Environments](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/getting-started/environments.md): Understand test and live environments in IvoryPay.
- [Request & Response Format](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/getting-started/request-and-response-format.md): Standard request and response formats used across the IvoryPay API.
- [Error Handling](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/getting-started/errors.md): How to handle errors from the IvoryPay API.
- [Pagination & Filtering](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/getting-started/pagination.md): How to paginate and filter list endpoints.
- [On-Ramp: Fiat → Crypto](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/guides/on-ramp.md): Step-by-step guide to integrating fiat-to-crypto on-ramp transactions.
- [Off-Ramp: Crypto → Fiat](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/guides/off-ramp.md): Step-by-step guide to integrating crypto-to-fiat off-ramp transactions.
- [Hosted Checkout (On-Ramp & Off-Ramp)](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/guides/hosted-checkout.md)
- [Business Checkout Integration](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/guides/business-checkout-integration.md)
- [Deposits & Settlements](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/guides/deposits-and-settlements.md): Understanding fiat deposits via virtual accounts and their crypto settlement lifecycle.
- [Initiate On-Ramp (with Customer)](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-on-ramp/initiate-with-customer.md): Create a new customer and initiate an on-ramp transaction in a single call.
- [Initiate On-Ramp](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-on-ramp/initiate.md): Initiate an on-ramp transaction for an existing customer.
- [Initiate On-Ramp Checkout](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-on-ramp/checkout-initiate.md): Create a hosted on-ramp checkout session and get a redirect URL.
- [Confirm On-Ramp Checkout](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-on-ramp/checkout-confirm.md): Confirm a pending on-ramp from the hosted checkout (called by the checkout UI).
- [Get On-Ramp Status](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-on-ramp/get-status.md): Check the current status of an on-ramp transaction.
- [Get Minimum On-Ramp Amount](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-on-ramp/get-minimum-amount.md): Get the minimum on-ramp amount for a fiat currency.
- [Initiate Off-Ramp (with Customer)](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-off-ramp/initiate-with-customer.md): Create a new customer and initiate a crypto-to-fiat off-ramp transaction.
- [Initiate Off-Ramp](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-off-ramp/initiate.md): Initiate an off-ramp transaction for an existing customer.
- [Initiate Off-Ramp Checkout](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-off-ramp/checkout-initiate.md): Create a hosted off-ramp checkout session and get a redirect URL.
- [Confirm Off-Ramp Checkout](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-off-ramp/checkout-confirm.md): Confirm a pending off-ramp by selecting a payout account (called by the checkout UI).
- [Get Off-Ramp Status](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-off-ramp/get-status.md): Check the current status of an off-ramp transaction.
- [Refresh Off-Ramp Session](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-off-ramp/refresh-session.md): Extend an expired or expiring off-ramp session.
- [Confirm Crypto Sent](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-off-ramp/confirm-crypto-sent.md): Manually confirm that crypto has been sent for an off-ramp transaction.
- [Get Minimum Off-Ramp Amount](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-off-ramp/get-minimum-amount.md): Get the minimum off-ramp amount for a crypto token.
- [Get On-Ramp Exchange Rate](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-exchange-rates/onramp-rate.md): Get a fee breakdown and crypto conversion for a proposed on-ramp transaction.
- [Get Off-Ramp Exchange Rate](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-exchange-rates/offramp-rate.md): Get a fee breakdown and fiat conversion for a proposed off-ramp transaction.
- [List All Banks](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-banks/list-banks.md): Retrieve all supported banks.
- [Get Banks by Currency](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-banks/get-banks-by-currency.md): Get banks available for a specific fiat currency.
- [Resolve Bank Account](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-banks/resolve-account.md): Verify a bank account number and retrieve the account holder's name.
- [Create Customer](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-customers/create.md): Create a new customer for your business.
- [Get Customer](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-customers/get.md): Retrieve a customer by ID, email, or reference code.
- [Update Customer](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-customers/update.md): Update a customer's details.
- [Delete Customer](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-customers/delete.md): Delete a customer record.
- [Customer Bank Accounts](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-customers/bank-accounts.md): Manage a customer's saved payout accounts (bank transfer & mobile money).
- [Create Virtual Account](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-virtual-accounts/create.md): Create a dedicated virtual bank account for receiving fiat deposits.
- [List Virtual Accounts](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-virtual-accounts/list.md): List all virtual accounts for your business.
- [Query Virtual Account](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-virtual-accounts/query.md): Query a specific virtual account by account number.
- [Update Virtual Account Status](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-virtual-accounts/update-status.md): Enable or disable a virtual account.
- [Delete Virtual Account](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-virtual-accounts/delete.md): Close and delete a virtual account.
- [List Deposits](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-deposits/list.md): List all fiat deposits received by your business.
- [Get Deposit by ID](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-deposits/get-by-id.md): Get a specific deposit by its ID.
- [Get Deposits by Account](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-deposits/get-by-account.md): Get all deposits for a specific virtual account.
- [List Settlements](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-settlements/list.md): List all settlements for your business.
- [Get Settlement by ID](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-settlements/get-by-id.md): Get a specific settlement by its ID.
- [Get Settlement by Deposit](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-settlements/get-by-deposit.md): Get the settlement associated with a specific deposit.
- [List Transactions](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-transactions/list.md): List all transactions for your business.
- [Get Transaction by ID](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-transactions/get-by-id.md): Get a specific transaction by its ID.
- [Verify Transaction](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-transactions/verify.md): Verify the status of a transaction by reference.
- [Get Wallet Balance](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-wallets/get-balance.md): Get your business wallet balance.
- [Setup Webhook](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-webhooks/setup.md): Configure a webhook URL to receive event notifications.
- [List Webhooks](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-webhooks/list.md): List all configured webhooks.
- [Update Webhook](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-webhooks/update.md): Update a webhook's URL or subscribed events.
- [Delete Webhook](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-webhooks/delete.md): Delete a webhook configuration.
- [List Webhook Events](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/api-reference-webhooks/list-events.md): List all available webhook events.
- [Webhooks Overview](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/webhooks/overview.md): Real-time event notifications for your IvoryPay transactions.
- [Webhook Events Reference](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/webhooks/events-reference.md): Complete reference of all webhook events and their payload schemas.
- [Webhook Security](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/webhooks/security.md): How to verify webhook signatures to ensure authenticity.
- [Supported Fiat Currencies](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/resources/supported-currencies.md): All fiat currencies supported by the IvoryPay API.
- [Supported Networks & Tokens](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/resources/supported-blockchains.md): All blockchain networks and supported tokens for the IvoryPay API.
- [Supported Cryptocurrencies](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/resources/supported-cryptocurrencies.md): Supported tokens and blockchains for the IvoryPay API.
- [Error Codes](https://ivorypay.gitbook.io/ivorypay-on-off-ramp-documentation/resources/error-codes.md): Complete list of IvoryPay API error codes.