# Ripio B2B API

- [Crypto as a Service](https://docs.ripio.com/crypto-as-a-service/overview/introduction.md): A brief introduction to B2B API.
- [Choose your integration](https://docs.ripio.com/crypto-as-a-service/overview/choose-your-integration.md): Decide between the CaaS API and the embeddable Widget to add crypto trading to your platform.
- [Widget integration](https://docs.ripio.com/crypto-as-a-service/widget/overview.md): Ripio's embeddable crypto widget: what your users can do inside it, what you configure, and what your backend still owns.
- [Authentication](https://docs.ripio.com/crypto-as-a-service/widget/get-started/authentication.md): How to generate a one-time session code for the crypto widget.
- [Embedding the widget](https://docs.ripio.com/crypto-as-a-service/widget/get-started/embedding.md): The script tag and the web component's attributes.
- [Mobile / WebView integration](https://docs.ripio.com/crypto-as-a-service/widget/get-started/webview.md): Point a WebView at the widget's hosted page for React Native, Ionic or native Android and iOS.
- [Session lifecycle](https://docs.ripio.com/crypto-as-a-service/widget/get-started/session-lifecycle.md): How long a widget session lasts, the events the widget emits, and how to renew a session without reloading your page.
- [Home](https://docs.ripio.com/crypto-as-a-service/widget/flows/home.md): The widget's landing screen: balance, holdings, activity and the market.
- [Buy and sell](https://docs.ripio.com/crypto-as-a-service/widget/flows/buy-and-sell.md): The quote-then-confirm flow a user goes through to buy or sell crypto.
- [Theming](https://docs.ripio.com/crypto-as-a-service/widget/configuration/theming.md): Match the widget to your brand: the tokens Ripio can set on your account, the values they accept, and the fonts the widget ships.
- [Webhooks](https://docs.ripio.com/crypto-as-a-service/widget/webhooks.md): The two requests your endpoint receives for the widget's buy and sell flow, and how to verify their signature.
- [Troubleshooting](https://docs.ripio.com/crypto-as-a-service/widget/troubleshooting.md): The widget's error contract, and what to do when a session ends.
- [Get Access Token](https://docs.ripio.com/crypto-as-a-service/access-token/get-access-token.md): Every call to the API has to be authenticated with an OAuth2 Token. In order to request this token, you will need to have sandbox or production API Keys (`client_id` and `client_secret`) that will allow to negotiate an ephemeral access token.
- [Error Handling](https://docs.ripio.com/crypto-as-a-service/errors/error-handling.md): Error response format and the full list of B2B API error codes.
- [List Account Reusable Quotes](https://docs.ripio.com/crypto-as-a-service/reusable-quotes/list-account-reusable-quotes.md): Retrieve a paginated list of generated reusable quotes.
- [Create Reusable Quote](https://docs.ripio.com/crypto-as-a-service/reusable-quotes/create-reusable-quote.md): ReusableQuotes are "held rates" offered by Ripio to buy or sell assets at a specific price within a period of time - for example, the option to buy ETH within the next 30 seconds for $10,000.
- [Retrieve Account Reusable Quote](https://docs.ripio.com/crypto-as-a-service/reusable-quotes/retrieve-account-reusable-quote.md): Retrieve previously generated reusable quote given an id.
- [List Account Swap Quotes](https://docs.ripio.com/crypto-as-a-service/swap-reusable-quotes/list-account-swap-quotes.md): Retrieve a paginated list of generated swap quotes.
- [Create Swap Reusable Quotes](https://docs.ripio.com/crypto-as-a-service/swap-reusable-quotes/create-swap-reusable-quotes.md): SwapReusableQuotes are "held rates" offered by Ripio to swap assets at a specific price within a period of time. The typical Quotes workflow is as follows:
- [Execute Reusable Quote](https://docs.ripio.com/crypto-as-a-service/reusable-quote-execution/execute-reusable-quote.md): Reusable Quote Executions buy or sell assets using a Reusable Quote obtained from the [Reusable Quote Creation](#operations/createReusableQuoteResponse) flow.
- [Execute Swap Reusable Quote](https://docs.ripio.com/crypto-as-a-service/swap-reusable-quote-execution/execute-swap-reusable-quote.md): Swap Quote Executions performs assets using a Reusable Quote obtained from the [Swap Reusable Quote Creation](#operations/createSwapQuote) flow.
- [Get Last Market Rates](https://docs.ripio.com/crypto-as-a-service/rates/get-last-market-rates.md): An exchange rate is the rate at which one currency will be exchanged for another currency.
- [Get Account Pairs](https://docs.ripio.com/crypto-as-a-service/pairs/get-account-pairs.md): Returns all enabled pairs for the Account.
- [List Transactions](https://docs.ripio.com/crypto-as-a-service/transactions/list-transactions.md): List all executed transactions.
- [Retrieve Transaction](https://docs.ripio.com/crypto-as-a-service/transactions/retrieve-transaction.md): Retrieve transaction details given an id.
- [Get Transaction Limits](https://docs.ripio.com/crypto-as-a-service/txn-limits/get-transaction-limits.md): A transaction limit is the current maximum or minimum amount allowed for a single operation (BUY, SELL, SWAP) and a given fiat currency.
- [List End Users](https://docs.ripio.com/crypto-as-a-service/end-user/list-end-users.md): This endpoint allows to fetch a list of all active End Users already created.
- [Create End User](https://docs.ripio.com/crypto-as-a-service/end-user/create-end-user.md): An End User represents the ultimate stakeholder that will be attached to all efective buy/sell trades. The partner will operate on-behalf-of the end user, serving as a middle-man for the quotation and trade execution process.
- [Retrieve End User](https://docs.ripio.com/crypto-as-a-service/end-user/retrieve-end-user.md): Retrieve end_user details given an end_user_id (external_ref).
- [Ban an End User](https://docs.ripio.com/crypto-as-a-service/end-user/ban-an-end-user.md): Endpoint that bans an End User
- [Unban an End User](https://docs.ripio.com/crypto-as-a-service/end-user/unban-an-end-user.md): Endpoint that unbans an End User
- [Assign Billing Information for an End User](https://docs.ripio.com/crypto-as-a-service/end-user/assign-billing-information-for-an-end-user.md): This endpoint is a flexible tool designed to collect additional information required for ad-hoc workflows, such as billing or regulatory reporting. The flexibility of the endpoint allows the payload format to be customized according to the specific use case, as agreed upon with the partner.
- [Get Balances for End User](https://docs.ripio.com/crypto-as-a-service/balance/get-balances-for-end-user.md): Retrieve end_user balances details given an end_user_id (external_ref).
- [Get Limits for End User.](https://docs.ripio.com/crypto-as-a-service/periodic-limits/get-limits-for-end-user.md): Limits are set per operation basis, so one should expect for "BUY", "SELL" or "SWAP". All End Users have certain restrictions when executing trades. Limits model seeks to control the maximun allowed frequency and magnitude of the volume operated by an end user in certain period: - **Frequency Limits…
- [List Withdrawals](https://docs.ripio.com/crypto-as-a-service/withdrawals/list-withdrawals.md): Endpoint that lists every withdrawal operation.
- [Create Withdrawal](https://docs.ripio.com/crypto-as-a-service/withdrawals/create-withdrawal.md): This endpoint allows the creation of a withdrawal. It will debit from the end user's currency's balance and credit the amount in the destination address.
- [Create Withdrawal Fee](https://docs.ripio.com/crypto-as-a-service/withdrawals/create-withdrawal-fee.md): This endpoint allows the creation of a withdrawal fee. Withdrawal fees are "held fees" offered by Ripio to withdraw assets at a specific fee within a period of time - for example, the option to transfer out 0.25 ETH within the next 15 seconds for 0.001 ETH. The fee does not depend on the withdrawal…
- [Retrieve Withdrawal](https://docs.ripio.com/crypto-as-a-service/withdrawals/retrieve-withdrawal.md): Endpoint that retrieves a specific withdrawal given a withdrawal ID.
- [List End User's Addresses](https://docs.ripio.com/crypto-as-a-service/addresses/list-end-users-addresses.md): This endpoint allows to fetch a list of the given user's wallet's addresses
- [Create Address for End User](https://docs.ripio.com/crypto-as-a-service/addresses/create-address-for-end-user.md): Endpoint that allows the creation of a deposit address for a given end user.
- [List End User's Auto Swap Addresses](https://docs.ripio.com/crypto-as-a-service/auto-swap-addresses/list-end-users-auto-swap-addresses.md): This endpoint allows to fetch a list of the given user's auto-swap addresses
- [Create Auto Swap Address for End User](https://docs.ripio.com/crypto-as-a-service/auto-swap-addresses/create-auto-swap-address-for-end-user.md): Endpoint that allows the creation of a auto swap deposit address for a given end user. This endpoint behaves idempontently for a given user and any of the networks from a network family.
- [Update target_address of EndUser's AutoSwap address.](https://docs.ripio.com/crypto-as-a-service/auto-swap-addresses/update-target_address-of-endusers-autoswap-address.md): This endpoint allows to update the target_address of the given EndUser's auto-swap addresses
- [List Deposits](https://docs.ripio.com/crypto-as-a-service/deposits/list-deposits.md): Endpoint that list all the deposits received.
- [Retrieve Deposit](https://docs.ripio.com/crypto-as-a-service/deposits/retrieve-deposit.md): Endpoint that retrieves details of a received deposit by id.
- [Create IPN Webhook](https://docs.ripio.com/crypto-as-a-service/ipn-webhooks/create-ipn-webhook.md): Endpoint that performs the creation of an IPN Webhook for the current account. **Important**: This endpoint is only available in Sandbox.
- [List Available IPN Webhooks](https://docs.ripio.com/crypto-as-a-service/ipn-webhooks/list-available-ipn-webhooks.md): Endpoint that list all the available IPN Webhooks for the current account. **Important**: This endpoint is only available in Sandbox.
- [Retrieve IPN Webhooks](https://docs.ripio.com/crypto-as-a-service/ipn-webhooks/retrieve-ipn-webhooks.md): Endpoint that allows the retrieval of a given IPN Webhooks. **Important**: This endpoint is only available in Sandbox.
- [Update IPN Webhook](https://docs.ripio.com/crypto-as-a-service/ipn-webhooks/update-ipn-webhook.md): Endpoint that performs an update of an IPN Webhook for the current account. **Important**: This endpoint is only available in Sandbox.
- [Create Deposit IPN Notification for Testing](https://docs.ripio.com/crypto-as-a-service/deposit-ipn/create-deposit-ipn-notification-for-testing.md): Endpoint that allows the creation of a dummy (but with proper format) deposit IPN Notification that will be sent to the registered IPN Webhooks created before.
- [Simulate Fiat Deposit](https://docs.ripio.com/crypto-as-a-service/simulate-fiat-deposit/simulate-fiat-deposit.md): Endpoint that simulates a fiat deposit in the fiat account with the cvu passed in the body of the request.
- [KYC Requirements](https://docs.ripio.com/crypto-as-a-service/kyc-requirements/kyc-requirements.md): This endpoint returns a list of fields that needs to be provided on a KYC submission.  The response is structured in a list of fields so that an UI can be constructed from it.
- [List KYC Submissions](https://docs.ripio.com/crypto-as-a-service/kyc-submissions/list-kyc-submissions.md): Endpoint that list an end user's KYC Submissions
- [Create KYC Submission](https://docs.ripio.com/crypto-as-a-service/kyc-submissions/create-kyc-submission.md): This endpoint allows you to submit user's kyc information.
- [Retrieve KYC Submission](https://docs.ripio.com/crypto-as-a-service/kyc-submissions/retrieve-kyc-submission.md): Endpoint that retrieves an specific KYC submission given a submission ID.
- [List Beneficiary Fiat Account](https://docs.ripio.com/crypto-as-a-service/beneficiary-fiat-accounts/list-beneficiary-fiat-account.md): This endpoint allows to fetch a list of the given user's beneficiary fiat accounts.
- [Create Beneficiary Fiat Account](https://docs.ripio.com/crypto-as-a-service/beneficiary-fiat-accounts/create-beneficiary-fiat-account.md): This endpoint allows you to create an Beneficiary Fiat Account.
- [Retrieve Beneficiary Fiat Account](https://docs.ripio.com/crypto-as-a-service/beneficiary-fiat-accounts/retrieve-beneficiary-fiat-account.md): This endpoint allows to retrieve an end user's beneficiary fiat accounts details.
- [List Fiat Account](https://docs.ripio.com/crypto-as-a-service/fiat-accounts/list-fiat-account.md): This endpoint allows to fetch a list of the given user's fiat accounts.
- [Create Fiat Account](https://docs.ripio.com/crypto-as-a-service/fiat-accounts/create-fiat-account.md): This endpoint allows you to create a Fiat Account.
- [Retrieve Fiat Account](https://docs.ripio.com/crypto-as-a-service/fiat-accounts/retrieve-fiat-account.md): This endpoint allows to retrieve an end user's fiat accounts details.
- [List Fiat Withdrawals](https://docs.ripio.com/crypto-as-a-service/fiat-withdrawals/list-fiat-withdrawals.md): Endpoint that lists every fiat withdrawal operation.
- [Create Fiat Withdrawal](https://docs.ripio.com/crypto-as-a-service/fiat-withdrawals/create-fiat-withdrawal.md): This endpoint allows the creation of a Fiat withdrawal. It will debit from the end user's currency's balance and withdraw such amount to the specified [Beneficiary Fiat Account](/crypto-as-a-service/beneficiary-fiat-accounts/create-beneficiary-fiat-account).
- [Retrieve Fiat Withdrawal](https://docs.ripio.com/crypto-as-a-service/fiat-withdrawals/retrieve-fiat-withdrawal.md): Endpoint that retrieves an specific Fiat Withdrawal given a fiat_withdrawal_id.
- [List Fiat Deposits](https://docs.ripio.com/crypto-as-a-service/fiat-deposits/list-fiat-deposits.md): Endpoint that list all the fiat deposits received.
- [Retrieve Fiat Deposit](https://docs.ripio.com/crypto-as-a-service/fiat-deposits/retrieve-fiat-deposit.md): Endpoint that retrieves details of a received fiat deposit by its id.
- [Webhooks Introduction](https://docs.ripio.com/crypto-as-a-service/webhooks/introduction.md): Understanding and using webhooks with the Ripio Crypto-as-a-Service API.
- [Crypto as a Service Webhooks](https://docs.ripio.com/crypto-as-a-service/webhooks/crypto-as-a-service-webhooks.md): Documentation of Crypto as a Service Webhooks
- [BaaS Webhooks](https://docs.ripio.com/crypto-as-a-service/webhooks/baas-webhooks.md): Documentation of Banking as a Service Webhooks
- [List IPN Messages](https://docs.ripio.com/crypto-as-a-service/ipn-messages/list-ipn-messages.md): List the webhook messages issued for your account.
- [Retrieve IPN Message](https://docs.ripio.com/crypto-as-a-service/ipn-messages/retrieve-ipn-message.md): Retrieve a single message by the `message_id` it carries in its body.
- [List Opt Ins](https://docs.ripio.com/crypto-as-a-service/opt-ins/list-opt-ins.md): Retrieve a list of all active and historical opt-in records for a given user, indicating whether the user's balances are enrolled to earn yield.
- [Yield Opt In](https://docs.ripio.com/crypto-as-a-service/opt-ins/yield-opt-in.md): Register a user to participate in the yield-earning program. This enables daily interest accrual on supported assets held by the user. By default the user is opted into every product enabled for your account, and that form of the request requires the user to have no active opt-in at all. Send the op…
- [Retrieve Opt In](https://docs.ripio.com/crypto-as-a-service/opt-ins/retrieve-opt-in.md): Fetch detailed information about a specific opt-in entry using its unique identifier.
- [List Opt Outs](https://docs.ripio.com/crypto-as-a-service/opt-outs/list-opt-outs.md): Retrieve a list of opt-out events for users who have exited the yield-earning program. Each entry links to the original opt-in.
- [Yield Opt Out](https://docs.ripio.com/crypto-as-a-service/opt-outs/yield-opt-out.md): De-register a user from the yield-earning program. The user will stop receiving interest on their eligible balances. By default every active opt-in of the user is closed. Send the optional `asset` field to opt out of a single product instead, leaving the other opts of the user active. Requires that…
- [Retrieve Opt Out](https://docs.ripio.com/crypto-as-a-service/opt-outs/retrieve-opt-out.md): Retrieve details of a specific opt-out record, including the associated opt-in and transaction information, by providing its unique ID.
- [List Yield Credits](https://docs.ripio.com/crypto-as-a-service/yield-credits/list-yield-credits.md): List all yield credit transactions that reflect accrued and credited interest to a user's account.
- [Retrieve Yield Credit](https://docs.ripio.com/crypto-as-a-service/yield-credits/retrieve-yield-credit.md): Retrieve detailed information for a specific yield credit transaction, including the amount credited, asset type, and associated opt-in context.
- [List Daily Yield Accumulations](https://docs.ripio.com/crypto-as-a-service/daily-yield-accumulations/list-daily-yield-accumulations.md): List the daily yield accumulations for your account: a per-asset, per-day aggregate of all yield credited to your end users.
- [Retrieve Daily Yield Accumulation](https://docs.ripio.com/crypto-as-a-service/daily-yield-accumulations/retrieve-daily-yield-accumulation.md): Retrieve a specific daily yield accumulation, including the total accrued amount, the Ripio and partner fees charged, and the number of contributing end users, and the fiat valuation (`fiat_details`) for the asset on the accrued date.
- [List APYs](https://docs.ripio.com/crypto-as-a-service/yield-apy/list-yield-apys.md): Retrieve the current Annual Percentage Yields (APYs) for all supported assets enrolled in the yield-earning program.
- [Ripio Ramps API: On-Ramp & Off-Ramp Integration for Partners](https://docs.ripio.com/ramps-api/overview/introduction.md): Integrate Ripio's On-Ramp & Off-Ramp API to let your users buy and sell crypto with fiat. REST API and embeddable Widget solutions for partners.
- [Choose your integration](https://docs.ripio.com/ramps-api/overview/choose-your-integration.md): Decide between the Ramps API and the embeddable Widget to add On-Ramp and Off-Ramp to your platform.
- [Countries & payment methods](https://docs.ripio.com/ramps-api/overview/countries/overview.md): Supported countries, currencies and payment methods for On-Ramp and Off-Ramp across Argentina, Mexico, Colombia and Brazil.
- [Argentina](https://docs.ripio.com/ramps-api/overview/countries/argentina.md): On-Ramp and Off-Ramp payment methods, currency and requirements for Argentina (ARS).
- [Mexico](https://docs.ripio.com/ramps-api/overview/countries/mexico.md): On-Ramp and Off-Ramp payment methods, currency and requirements for Mexico (MXN).
- [Colombia](https://docs.ripio.com/ramps-api/overview/countries/colombia.md): On-Ramp and Off-Ramp payment methods, currency and requirements for Colombia (COP).
- [Brazil](https://docs.ripio.com/ramps-api/overview/countries/brazil.md): On-Ramp and Off-Ramp payment methods, currency and requirements for Brazil (BRL).
- [Widget integration](https://docs.ripio.com/ramps-api/widget/overview.md): Ripio's embeddable On/Off Ramp widget: what your users can do inside it, what you configure, and what your backend still owns.
- [Authentication](https://docs.ripio.com/ramps-api/widget/get-started/authentication.md): How to generate an authentication token for the On/Off Ramp Widget.
- [Launch the widget](https://docs.ripio.com/ramps-api/widget/get-started/launch.md): Widget URLs for on-ramp and off-ramp, sandbox hosts, and every query parameter you can prefill.
- [Returning to your app](https://docs.ripio.com/ramps-api/widget/get-started/returning-to-your-app.md): How the widget hands the user back to your platform, and exactly which query parameters it appends.
- [Sign-in and terms](https://docs.ripio.com/ramps-api/widget/flows/identity-and-terms.md): The email and one-time-code step every widget user goes through, and where Terms & Conditions acceptance is recorded.
- [Identity verification in the widget](https://docs.ripio.com/ramps-api/widget/flows/kyc.md): How the widget runs KYC when your account has it enabled, and how your backend learns the outcome.
- [Buying crypto (on-ramp)](https://docs.ripio.com/ramps-api/widget/flows/on-ramp.md): The in-widget on-ramp flow by country and payment method: quote, payment instructions, PIX, request-to-pay, and where the user ends up.
- [Selling crypto (off-ramp)](https://docs.ripio.com/ramps-api/widget/flows/off-ramp.md): The in-widget off-ramp flow: destination account book, network and deposit, payout, and the QR versus auto-redirect behaviour.
- [History and refunds](https://docs.ripio.com/ramps-api/widget/flows/history-and-refunds.md): The in-widget transaction history, the refunds a user can claim from it, and how your backend follows a refund it did not request.
- [Recovering a rejected payout](https://docs.ripio.com/ramps-api/widget/flows/order-recovery.md): Two ways a user fixes the destination account of an off-ramp order that could not be paid: inside the session, or from an emailed link.
- [Emails Ripio sends your users](https://docs.ripio.com/ramps-api/widget/flows/emails.md): The transactional emails the widget triggers, in which language, and which one carries an action link.
- [Partner settings](https://docs.ripio.com/ramps-api/widget/configuration/partner-settings.md): What Ripio configures on your account for the widget, and how the interface language is chosen.
- [Theming](https://docs.ripio.com/ramps-api/widget/configuration/theming.md): Match the widget to your brand with CSS custom properties: the supported tokens, the design-system scales, and how to send Ripio your theme.
- [Troubleshooting and support](https://docs.ripio.com/ramps-api/widget/troubleshooting.md): Where a user can get stuck inside the widget, what unblocks them, and how they reach support.
- [Overview & which model to use](https://docs.ripio.com/ramps-api/kyc/overview.md): How identity verification (KYC) works in the Ramps API and how to choose between the Ripio-hosted redirect and the partner-submitted API model.
- [Ripio-hosted KYC (redirect)](https://docs.ripio.com/ramps-api/kyc/kyc-with-ripio.md): Delegated KYC flow where the partner initiates the process and the user completes identity verification directly on Ripio's platform via a redirect.
- [Partner-submitted KYC (API)](https://docs.ripio.com/ramps-api/kyc/kyc-via-api-overview.md): KYC flow where the partner collects the customer's data in their own UI and submits it through the Ramps API, with an OTP shortcut to reuse an existing Ripio KYC.
- [KYC fields by country](https://docs.ripio.com/ramps-api/kyc/kyc-fields-by-country.md): The KYC payload accepted by the Ramps API for Argentina, Brazil, Mexico and Colombia: which fields are required, what format each one takes, and the cross-field rules validated before the verification is opened.
- [Reusable KYC (Sumsub share token)](https://docs.ripio.com/ramps-api/kyc/reusable-kyc.md): Reuse a verification your customer already completed in your own Sumsub account, so they skip the document upload and liveness check.
- [On-Ramp integration](https://docs.ripio.com/ramps-api/guides/on-ramp-integration.md): Step-by-step walkthrough to convert fiat into crypto with the Ramps API, using either a single on-ramp order or a reusable on-ramp session.
- [Off-Ramp integration](https://docs.ripio.com/ramps-api/guides/off-ramp-integration.md): Step-by-step walkthrough to convert crypto into fiat with the Ramps API using a reusable off-ramp session.
- [Acquire Access Token](https://docs.ripio.com/ramps-api/authentication/acquire-access-token.md): Every call to the API has to be authenticated with an OAuth2 Token. In order to request this token, you will need to have sandbox or production API Keys (`client_id` and `client_secret`) that will allow to negotiate an ephemeral access token.
- [Create Customer](https://docs.ripio.com/ramps-api/customers/create-customer.md): Creates a new customer account (individual or business). This is the foundational step for other API use cases.
- [Update Customer](https://docs.ripio.com/ramps-api/customers/update-customer.md): Updates an existing customer's information. Currently, only the email address can be updated. Once the customer's KYC has been approved, this endpoint can no longer change the email — see the `email` field description and the `400` response below.
- [Create Deposit Account](https://docs.ripio.com/ramps-api/customers/create-deposit-account.md): Creates the customer's fiat **deposit account** - the CVU, CLABE or BRE-B key the end user will transfer to.
- [Accept Terms and Conditions](https://docs.ripio.com/ramps-api/customers/accept-terms.md): Records the customer's acceptance of the active Terms and Conditions for the account's country. This endpoint is required when the Partner integrates Ramps via API. The customer must accept the T&C before performing on-ramp or off-ramp operations.
- [Deactivate Customer](https://docs.ripio.com/ramps-api/customers/deactivate-customer.md): Deactivates a customer account and all associated fiat accounts. This action sets the customer and their deposit accounts to inactive. External fiat accounts are transitioned to deactivated as well.
- [Terms and Conditions](https://docs.ripio.com/ramps-api/terms-and-conditions/introduction.md): How to manage Terms and Conditions acceptance for customers when integrating via the Ramps API.
- [Get Terms and Conditions](https://docs.ripio.com/ramps-api/terms-and-conditions/get-terms-and-conditions.md): Returns the currently active Terms and Conditions for the account's country. Use the `termsId` from the response when calling `POST /api/v1/customers/{customerId}/acceptTerms/`.
- [Get Terms Acceptance Status](https://docs.ripio.com/ramps-api/terms-and-conditions/get-terms-acceptance-status.md): Returns whether the customer has accepted the currently active Terms and Conditions for their account's country, along with the active T&C details.
- [Retrieve KYC Requirements](https://docs.ripio.com/ramps-api/kyc/retrieve-kyc-requirements.md): Retrieves the specific Know Your Customer (KYC) requirements, detailing the fields and document types needed for customer verification.
- [Start KYC](https://docs.ripio.com/ramps-api/kyc/start-kyc.md): Starts a KYC verification for the customer. Takes no identity data — only a required `redirectUrl` and an optional `kycProviderShareToken`.
- [Submit KYC Information](https://docs.ripio.com/ramps-api/kyc/submit-kyc-information.md): Submits KYC data for a specific customer. The response will include a URL to a third-party KYC provider's widget for document uploads and liveness checks. Webhook events will notify about the validation process.
- [Resend KYC OTP](https://docs.ripio.com/ramps-api/kyc/resend-kyc-otp.md): Resends the email OTP for a KYC verification that is waiting on it. Only works while the verification is pending OTP confirmation — call [Start KYC](/ramps-api/kyc/start-kyc) first.
- [Validate KYC OTP](https://docs.ripio.com/ramps-api/kyc/validate-kyc-otp.md): Validates the email OTP code for a KYC verification that is waiting on it. If the customer's identity was already resolved — for example, by reusing an approved KYC with Ripio, or a compatible `kycProviderShareToken` — the KYC is approved immediately. Otherwise, submit the customer's data next with…
- [Retrieve Latest KYC Submission](https://docs.ripio.com/ramps-api/kyc/retrieve-kyc-submission.md): Retrieves the latest KYC submission for a specific customer, including its status and creation timestamp.
- [Fiat account lifecycle](https://docs.ripio.com/ramps-api/fiat-accounts/lifecycle.md): How a customer's fiat (beneficiary) account moves through its states, why only one account can be active per payment method, and how a suspended account is reactivated.
- [List Fiat Accounts](https://docs.ripio.com/ramps-api/fiat-accounts/list-fiat-accounts.md): Retrieves a list of fiat accounts, optionally filtered by customerId or paymentMethodType. Results are limited to active customers — fiat accounts belonging to deactivated customers are excluded.
- [Create Fiat Account](https://docs.ripio.com/ramps-api/fiat-accounts/create-fiat-account.md): Creates a new fiat account for a customer, linked to specific bank or virtual wallet details for withdrawals.
- [Confirm Fiat Account](https://docs.ripio.com/ramps-api/fiat-accounts/confirm-fiat-account.md): Confirms an unconfirmed fiat account and starts the enabling process.
- [Retrieve Fiat Account Requirements](https://docs.ripio.com/ramps-api/fiat-accounts/retrieve-fiat-account-requirements.md): Retrieves the specific payment details required for creating Fiat Accounts based on a payment method.
- [List Bank Codes](https://docs.ripio.com/ramps-api/fiat-accounts/list-banks.md): Retrieves a list of available bank codes for creating fiat accounts via bank transfer in Colombia. Each bank includes its code (used as `beneficiary_institution` when creating a fiat account) and the allowed `counterparty_type` values.
- [Create Quote](https://docs.ripio.com/ramps-api/quotes/create-quote.md): Obtains a held price quote for a cryptocurrency conversion, valid for a limited time (e.g., 30 seconds). This quote includes the exchange rate and applicable fees, serving as the basis for on-ramp and off-ramp operations.
- [List On-Ramp Orders](https://docs.ripio.com/ramps-api/on-ramp/list-on-ramp-orders.md): Retrieves a list of on-ramp orders, with optional filtering by date range and pagination. Results are limited to active customers — orders belonging to deactivated customers are excluded.
- [Create On-Ramp Order](https://docs.ripio.com/ramps-api/on-ramp/create-on-ramp-order.md): Initiates a fiat-to-crypto on-ramp transaction process based on a previously obtained quote. Returns transaction details and fiat payment instructions for the customer.
- [Retrieve an On-Ramp Order](https://docs.ripio.com/ramps-api/on-ramp/retrieve-an-on-ramp-order.md): Returns a single on-ramp order by its `orderId`.
- [List On-Ramp Sessions](https://docs.ripio.com/ramps-api/on-ramp/list-on-ramp-sessions.md): Retrieves a list of all on-ramp sessions. Results are limited to active customers — sessions belonging to deactivated customers are excluded. Pass the `customerId` query parameter to return only the session for a single customer instead of listing and filtering client-side.
- [Create On-Ramp Session](https://docs.ripio.com/ramps-api/on-ramp/create-on-ramp-session.md): Initiates an on-ramp session for a customer, specifying payment method, chain, cryptocurrency, and deposit address. Returns session details and payment instructions.
- [Retrieve an On-Ramp Session](https://docs.ripio.com/ramps-api/on-ramp/retrieve-an-on-ramp-session.md): Retrieves the details of a specific on-ramp session by its ID.
- [Retrieve a Customer's On-Ramp Session](https://docs.ripio.com/ramps-api/on-ramp/retrieve-a-customer-on-ramp-session.md): Retrieves the on-ramp session for a specific customer, keyed by your partner-facing customer ID. A customer has at most one on-ramp session, so this returns that single session — useful for per-customer integrations that would otherwise have to list every session and filter client-side. Returns 404…
- [List Off-Ramp Orders](https://docs.ripio.com/ramps-api/off-ramp/list-off-ramp-orders.md): Retrieves a list of off-ramp orders, regardless of the session, with optional filtering by date range and pagination. Results are limited to active customers — orders belonging to deactivated customers are excluded.
- [Create Off-Ramp Order](https://docs.ripio.com/ramps-api/off-ramp/create-off-ramp-order.md): Initiates a single crypto-to-fiat off-ramp transaction based on a previously obtained quote and the customer's destination fiat account. Returns the transaction id and the crypto deposit address the customer must send funds to. The order executes automatically once the crypto deposit is confirmed. U…
- [Retrieve an Off-Ramp Order](https://docs.ripio.com/ramps-api/off-ramp/retrieve-an-off-ramp-order.md): Returns a single off-ramp order by its `orderId`.
- [List Off-Ramp Sessions](https://docs.ripio.com/ramps-api/off-ramp/list-off-ramp-sessions.md): Retrieves a list of all off-ramp sessions. Results are limited to active customers — sessions belonging to deactivated customers are excluded.
- [Create Off-Ramp Session](https://docs.ripio.com/ramps-api/off-ramp/create-off-ramp-session.md): Initiates an off-ramp session for a customer, specifying their fiat account. Returns session details and cryptocurrency deposit addresses.
- [Retrieve an Off-Ramp Session](https://docs.ripio.com/ramps-api/off-ramp/retrieve-an-off-ramp-session.md): Retrieves the details of a specific off-ramp session by its ID.
- [Change Fiat Account and Reprocess](https://docs.ripio.com/ramps-api/off-ramp/change-fiat-account.md): Points a cancelled off-ramp order at a different destination account and reprocesses the payout. Use it when the order was cancelled because the fiat could not be delivered — `failureReason: INVALID_DESTINATION` on the order — for example a closed, mistyped or unreachable account.
- [Refunds](https://docs.ripio.com/ramps-api/refunds/overview.md): How to return the money of an on-ramp or off-ramp operation that could not be completed: when a refund can be requested, where the money goes, and how to follow its outcome.
- [Request a Fiat Refund](https://docs.ripio.com/ramps-api/refunds/request-fiat-refund.md): Requests the return of the fiat deposited for an on-ramp order that was cancelled and could not be completed.
- [List Refundable Deposits](https://docs.ripio.com/ramps-api/refunds/list-refundable-deposits.md): Returns the customer's fiat deposits that were received but never matched to an on-ramp order.
- [Refund a Deposit](https://docs.ripio.com/ramps-api/refunds/refund-deposit.md): Requests the return of a fiat deposit that was received but never matched to an on-ramp order — the ones listed by `GET /customers/{customerId}/refundableDeposits/`.
- [Request a Crypto Refund](https://docs.ripio.com/ramps-api/refunds/request-crypto-refund.md): Requests the return of the crypto deposited for an off-ramp order that could not be completed (for example, because the trade could not be executed).
- [Request a Customer's Crypto Refund](https://docs.ripio.com/ramps-api/refunds/request-customer-crypto-refund.md): Requests the return of the crypto deposited for an off-ramp order that could not be completed (for example, because the trade could not be executed).
- [List Refundable Crypto Deposits](https://docs.ripio.com/ramps-api/refunds/list-refundable-crypto-deposits.md): Returns the customer's crypto deposits that arrived at one of their off-ramp deposit addresses and matched no order. Crypto twin of `GET /customers/{customerId}/refundableDeposits/`: the object is a payment with no operation behind it, so it appears on no transaction listing — this is the only place…
- [Refund a Crypto Deposit](https://docs.ripio.com/ramps-api/refunds/refund-crypto-deposit.md): Requests the return of a crypto deposit that arrived at one of your customers' deposit addresses and matched no off-ramp order — the ones listed by `GET /customers/{customerId}/refundableCryptoDeposits/`.
- [Create fiat account for sell and pay](https://docs.ripio.com/ramps-api/sell-and-pay/create-fiat-account.md): **Important:** This step is crucial for optimal performance. Creating the fiat account in advance prevents delays during the first Sell and Pay transaction.
- [Create Sell and Pay transaction](https://docs.ripio.com/ramps-api/sell-and-pay/create-sell-and-pay.md): Creates a new Sell and Pay transaction for converting cryptocurrency to fiat currency and paying a merchant via QR code. This endpoint automatically cancels any existing Sell and Pay transactions for the same customer. If all required fields are provided (customerId, externalRef, qrCode, paymentCurr…
- [Update Sell and Pay transaction](https://docs.ripio.com/ramps-api/sell-and-pay/update-sell-and-pay.md): Updates an existing Sell and Pay transaction to complete or modify its details. Use this endpoint to add missing required fields (depositCurrency, depositNetwork, refundAddress) or update the payment amount. When all required fields are provided, the transaction status will automatically change from…
- [Execute Sell and Pay transaction](https://docs.ripio.com/ramps-api/sell-and-pay/execute-sell-and-pay.md): Executes a Sell and Pay transaction that is in PENDING status. Upon successful execution, the transaction status changes to WAITING_DEPOSIT, indicating that the system is ready to receive the cryptocurrency deposit. The transaction must have all required fields completed before it can be executed. O…
- [List Sell and Pay transactions](https://docs.ripio.com/ramps-api/sell-and-pay/list-sell-and-pay.md): Retrieves a paginated list of Sell and Pay transactions.
- [Retrieve Sell and Pay transaction](https://docs.ripio.com/ramps-api/sell-and-pay/retrieve-sell-and-pay.md): Retrieves detailed information about a specific Sell and Pay transaction by its ID.
- [Delete Sell and Pay transaction](https://docs.ripio.com/ramps-api/sell-and-pay/delete-sell-and-pay.md): Cancels and deletes a Sell and Pay transaction. This operation can be performed on transactions in INCOMPLETE, PENDING, or WAITING_DEPOSIT status. Transactions in RECEIVED_DEPOSIT, CONFIRMED_DEPOSIT, TRADE_COMPLETED, QR_EXECUTION_PENDING, COMPLETED, CANCELED, REFUND_PENDING, or REFUNDED status canno…
- [Validate QR Code](https://docs.ripio.com/ramps-api/sell-and-pay/validate-qr-code.md): Validates a QR code and extracts merchant information from it. This endpoint can be used to verify QR codes before creating a Sell and Pay transaction.
- [List All Orders (On-Ramp & Off-Ramp)](https://docs.ripio.com/ramps-api/transactions/list-all-orders-on-ramp-&-off-ramp.md): Retrieves a unified list of all transaction orders, including both OnRamp and OffRamp types. Allows filtering by type, status, and pagination.
- [Retrieve an Order (On-Ramp or Off-Ramp)](https://docs.ripio.com/ramps-api/transactions/retrieve-an-order.md): Returns a single order by its `orderId`, whichever ramp it belongs to — the detail counterpart of [List All Orders](/ramps-api/transactions/list-all-orders-on-ramp-&-off-ramp). The response is the on-ramp or the off-ramp order object, so read `type` to tell them apart.
- [List Customer's On-Ramp Transaction History](https://docs.ripio.com/ramps-api/transactions/list-customer-onramp-transactions.md): Returns a paginated list of on-ramp transactions for a specific customer, ordered by most recently updated. Use this endpoint to display transaction history to end customers in your widget or integration. Returns 404 if the customer does not exist or does not belong to your account.
- [List Customer's Off-Ramp Transaction History](https://docs.ripio.com/ramps-api/transactions/list-customer-offramp-transactions.md): Returns a paginated list of off-ramp transactions for a specific customer, ordered by most recently updated. Use this endpoint to display transaction history to end customers in your widget or integration. Returns 404 if the customer does not exist or does not belong to your account.
- [Get Deposit Networks](https://docs.ripio.com/ramps-api/networks/get-deposit-networks.md): Gets the available deposit networks with their assets (currencies). Allows filtering by currency and optionally including currency details.
- [Get Withdrawal Networks](https://docs.ripio.com/ramps-api/networks/get-withdrawal-networks.md): Gets the available withdrawal networks with their assets (currencies). Allows filtering by currency and optionally including currency details. Networks are grouped by network name: if multiple currencies are available for the same network, they are merged into a single entry whose `assets` array lis…
- [Get Market Rates](https://docs.ripio.com/ramps-api/rates/get-market-rates.md): Returns the last market rates (BUY and SELL) for each account pair enabled, grouped by payment method type. These rates are for reference only and do not represent a held rate.
- [Get Transaction Limits](https://docs.ripio.com/ramps-api/transaction-limits/get-transaction-limits.md): Returns the current per-transaction limits (minimum and maximum amounts allowed for a single operation) for each enabled fiat currency and ramp operation. Amounts are expressed in the fiat currency named in each key.
- [KYC in sandbox](https://docs.ripio.com/ramps-api/sandbox/kyc-in-sandbox.md): How identity verification works in sandbox, including skipping KYC or simulating approval and rejection.
- [Simulate Deposit for On-Ramp (Sandbox)](https://docs.ripio.com/ramps-api/sandbox/simulate-deposit-for-on-ramp-sandbox.md): Simulates a fiat deposit for an on-ramp transaction in the sandbox environment. Valid for ARS, MXN, and COP currencies with `bank_transfer` paymentMethodType, and for BRL with `pix` paymentMethodType.
- [Create Support Ticket](https://docs.ripio.com/ramps-api/support-tickets/create-support-ticket.md): Raises a support ticket on behalf of one of your customers and queues it for Ripio's support team.
- [Retrieve Support Ticket](https://docs.ripio.com/ramps-api/support-tickets/retrieve-support-ticket.md): Returns the current status of a support ticket previously created via [Create Support Ticket](/ramps-api/support-tickets/create-support-ticket). The ticket reference (`issueKey`) becomes available once the ticket reaches the `CREATED` status.
- [Webhooks Introduction](https://docs.ripio.com/ramps-api/webhooks/introduction.md): Understanding and using webhooks with the Ripio OnRamp API.
- [On-Ramp Webhook Events](https://docs.ripio.com/ramps-api/webhooks/on-ramp-events.md): Detailed information on webhook events for On-Ramp transactions.
- [Off-Ramp Webhook Events](https://docs.ripio.com/ramps-api/webhooks/off-ramp-events.md): Detailed information on webhook events for Off-Ramp transactions.
- [Sell and Pay Webhook Events](https://docs.ripio.com/ramps-api/webhooks/sell-and-pay-events.md): Detailed information on webhook events for Sell and Pay transactions.
- [KYC Webhook Events](https://docs.ripio.com/ramps-api/webhooks/kyc-events.md): Detailed information on webhook events for KYC verification status changes.
- [Account Webhook Events](https://docs.ripio.com/ramps-api/webhooks/account-events.md): Detailed information on webhook events for customer account lifecycle changes.
- [Support Ticket Webhook Events](https://docs.ripio.com/ramps-api/webhooks/support-ticket-events.md): Detailed information on webhook events for support tickets raised on behalf of your customers.

## OpenAPI Specs

- [openapi](/crypto-as-a-service/openapi.json)
- [package-lock](/package-lock.json)
- [package](/package.json)
- [openapi](/ramps-api/openapi.json)