> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ripio.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Ripio Ramps API: On-Ramp & Off-Ramp Integration for Partners

> 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.

Ripio Ramps API is a RESTful interface that enables partners to integrate On-Ramp (fiat to crypto) and Off-Ramp (crypto to fiat) services into their platforms. It supports customer management, KYC flows, real-time quotes, and transaction tracking via OAuth2-authenticated API calls or an embeddable Widget.

## Ramp API Integration

A comprehensive RESTful API that allows for deep integration of Ripio's financial services directly into a partner's existing infrastructure.

**Key Features & Purpose:**

* **Direct Control:** Partners can build custom user experiences by directly calling API endpoints for various functionalities.
* **Services Offered:**
  * **On-Ramp & Off-Ramp:** Facilitate the conversion between fiat and cryptocurrencies.
  * **Customer Management:** Create and manage end-user accounts.
  * **KYC Processes:** Integrate Know Your Customer verification flows.
  * **Quotes:** Obtain real-time and held price quotes for conversions.
  * **Fiat Accounts:** Manage fiat accounts for withdrawals.
  * **Transaction Management:** Track and list on-ramp and off-ramp orders.
  * **Network Information:** Retrieve details about supported deposit and withdrawal networks.
  * **Rates:** Get current market rates.
* **Authentication:** Utilizes OAuth2 Client Credentials flow for M2M authentication. Partners obtain a Client ID and Client Secret from Ripio to generate access tokens.

This method is ideal for partners who require a high degree of customization and want to maintain their brand's look and feel throughout the user journey.

## Widget Integration

The Ripio On/Off Ramp Widget is a pre-built, embeddable user interface that simplifies the integration of on-ramp and off-ramp services. It's designed to be easily dropped into any partner platform that can host a web view.

**Key Features & Purpose:**

* **Simplified Integration:** Reduces development effort by providing a ready-to-use UI for on-ramp and off-ramp flows.
* **On-Ramp Flow:**
  * Allows users to acquire cryptocurrencies using FIAT money.
  * Requires users to have a crypto wallet and undergo a KYC (Know Your Client) process.
  * Supported payment methods: Mercado Pago and bank transfer (Argentina); bank transfer (Mexico); PSE, BREB, and Request-to-Pay via Bancolombia and Nequi (Colombia).
* **Off-Ramp Flow:**
  * Allows users to convert cryptocurrencies into FIAT money.
  * Requires users to have a bank account and undergo a KYC process.
  * Supported deposit methods: bank transfer with CBU/CVU/ALIAS (Argentina), bank transfer (Mexico), and PSE or BREB (Colombia).
* **Environment:** Developed to function in any modern web browser.
* **Integration Steps:**
  1. **Generate Authentication Token:** Partners request an access JWT token by providing their `client_id`, `client_secret`, and a unique `external_ref` (UUID v4 representing the partner's user).
  2. **Widget Access:** Redirect the user to the widget URL, passing the generated authentication token as a query parameter.
* **Customization:**
  * **Theme:** The widget's UI can be customized via a CSS file provided by the partner to match their brand style.
  * **Parameters:** Query parameters can be used to prefill certain fields like wallet address (`_addr`), network (`_net`), amount (`_amount`), cryptocurrency (`_crypto`), and a custom tracking session ID (`_tracking_session`).

This method is suitable for partners looking for a quick and easy way to offer on-ramp/off-ramp services without extensive development.

## Distinctions

| Feature                | Ramp API Integration                                          | Widget Integration                                                   |
| ---------------------- | ------------------------------------------------------------- | -------------------------------------------------------------------- |
| **Integration Type**   | Direct API calls, backend-to-backend primarily                | Embeddable UI, frontend integration                                  |
| **User Experience**    | Fully customizable by the partner                             | Pre-built UI, themeable via CSS                                      |
| **Development Effort** | Higher, requires building UI and handling API logic           | Lower, primarily involves token generation and URL redirection       |
| **Control**            | Granular control over each step of the process                | Streamlined flow managed by the widget                               |
| **Use Case**           | Platforms needing deep, custom financial service integrations | Platforms wanting a quick, easy way to add on/off-ramp functionality |
| **Authentication**     | OAuth2 Client Credentials for API access                      | JWT token generated via API for widget session authentication        |

Both solutions are designed to empower partners to offer robust cryptocurrency transaction services, catering to different integration needs and technical capabilities.

## What you can build

* Convert fiat to crypto for your users — [On-Ramp](/ramps-api/on-ramp/create-on-ramp-order)
* Convert crypto to fiat with bank transfers — [Off-Ramp](/ramps-api/off-ramp/create-off-ramp-session)
* Manage [customer KYC and compliance flows](/ramps-api/kyc/kyc-via-api-overview)
* Retrieve [real-time quotes and exchange rates](/ramps-api/quotes/create-quote)
* [Track and list on-ramp/off-ramp transactions](/ramps-api/transactions/list-all-orders-on-ramp-&-off-ramp)

## Where to start

* [Authentication (OAuth2 setup)](/ramps-api/authentication/acquire-access-token)
* [Widget Integration](/ramps-api/widget/introduction)
* [API Reference — Customers](/ramps-api/customers/create-customer)

## FAQ

### What is Ripio Ramps API?

Ripio Ramps API is a REST API that lets partners integrate On-Ramp (fiat to crypto) and Off-Ramp (crypto to fiat) services into their platforms. It handles customer management, KYC flows, real-time quotes, and transaction tracking via OAuth2.

### What payment methods are supported?

Payment methods depend on country and flow:

| Country         | On-Ramp                                                        | Off-Ramp                      |
| --------------- | -------------------------------------------------------------- | ----------------------------- |
| Argentina (ARS) | Mercado Pago, bank transfer                                    | Bank transfer (CBU/CVU/ALIAS) |
| Mexico (MXN)    | Mercado Pago, bank transfer                                    | Bank transfer                 |
| Colombia (COP)  | Bank transfer (PSE), BREB, Request-to-Pay (Bancolombia, Nequi) | Bank transfer (PSE), BREB     |

### What's the difference between the API and the Widget?

The API gives you full control over the UX — you build the interface, we handle the backend. The Widget is an embeddable solution that requires minimal integration: you drop it into your platform and Ripio handles both the UI and the flow. The API suits teams that want custom experiences; the Widget is faster to ship.