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.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.
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.
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:
- Generate Authentication Token: Partners request an access JWT token by providing their
client_id,client_secret, and a uniqueexternal_ref(UUID v4 representing the partner’s user). - Widget Access: Redirect the user to the widget URL, passing the generated authentication token as a query parameter.
- Generate Authentication Token: Partners request an access JWT token by providing their
- 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).
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 |
What you can build
- Convert fiat to crypto for your users — On-Ramp
- Convert crypto to fiat with bank transfers — Off-Ramp
- Manage customer KYC and compliance flows
- Retrieve real-time quotes and exchange rates
- Track and list on-ramp/off-ramp transactions
Where to start
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 |