🚧 **Work In Progress**

Retrieve a list of opt-out events for users who have exited the yield-earning program. Each entry links to the original opt-in.

Supports filtering by user ID, asset, and creation date range.

List Opt Outs

OAuth2

Ripio B2B API

Ripio B2B

Documentation of Widget On Ramp and Off Ramp

On/Off Ramp

Fintech

Documentation of Banking as a Service Webhooks

BaaS Webhooks

API Reference

Register

Support

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.

To generate the access token, you should call this endpoint providing the header `Authorization` with the following schema: `Basic CREDENTIAL` where `CREDENTIAL` should be specified as a string with the format`client_id:client_secret` encoded in Base64.

Get Access Token

Retrieve a paginated list of generated reusable quotes.

List Account Reusable Quotes

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.

The typical Quotes workflow is as follows:

* Call [List Market Rates](#operation/listRatesViewSets) to get the latest available quoted prices for the assets you want to buy or sell. Please note that these rates are subject to change depending on the amount of base/quote currency the end user is willing to trade.
* Partner performs a POST request to [ReusableQuote Endpoint](#operation/createReusableQuoteResponse), B2B will respond a price for a price valid for 30 second.
* Present the offered price to the end-user, with a timer indicating the time to expiration (30 seconds).
* If a user accepts the price, call [Create Reusable Quote Execution](#operation/executeReusableQuoteResponse) passing the reusable quote id, end user external ref, operation type and base or quote amount.
* Call [Get Transaction](#operation/retrieveTransaction) or [Get Transaction List](#operation/listTransactions) to query trade status information.

Create Reusable Quote

Retrieve previously generated reusable quote given an id.

Retrieve Account Reusable Quote

Retrieve a paginated list of generated swap quotes.

List Account Swap Quotes

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:

* Partner performs a POST request to [Swap Reusable Quote Endpoint](#operation/createSwapQuote), B2B will respond a price for a price valid for 30 second.
* Present the offered price to the end-user, with a timer indicating the time to expiration (30 seconds).
* If a user accepts the price, call [Create Swap Reusable Quote Execution](#operation/executeSwapQuote) passing the reusable quote id, end user external ref, operation type and base or quote amount.
* Call [Get Transaction](#operation/retrieveTransaction) or [Get Transaction List](#operation/listTransactions) to query trade status information.

Create Swap Reusable Quotes

Reusable Quote Executions buy or sell assets using a Reusable Quote obtained from the [Reusable Quote Creation](#operations/createReusableQuoteResponse) flow.

The asset, and guaranteed price/rate of the execution are specified by the quote with ID `quote_id`.

The amount to buy or sell must be specified in either fiat or crypto by setting exactly one of:

* `base_amount` to specify the amount of crypto to buy or sell.
* `quote_amount` to specify the amount of fiat to spend or acquire.

An otherwise-valid request to create a quote execution may fail with the following types of errors:

* **Expired** if the reusable quote with ID `reusable_quote_id` has expired.
* **Insufficient Funds** if the end user with ID `end_user_id` has insufficient available balance to fund the execution.
* **Quote with no price** if a Reusable Quote has its prices set to null and status UNA_PRICE (Unavailable Price).
* **Buy Limit Frequency Exceeded** if the end_user reached a Daily/Monthly/Yearly frequency limit for BUY Trades.
* **Sell Limit Frequency Exceeded** if the end_user reached a Daily/Monthly/Yearly frequency limit for SELL Trades.
* **Buy Limit Amount Exceeded** if the end_user reached a Daily/Monthly/Yearly amount limit for BUY Trades.
* **Sell Limit Amount Exceeded** if the end_user reached a Daily/Monthly/Yearly amount limit for SELL Trades.

Execute Reusable Quote

Swap Quote Executions performs assets using a Reusable Quote obtained from the [Swap Reusable Quote Creation](#operations/createSwapQuote) flow.

The asset, and guaranteed price/rate of the execution are specified by the quote with ID `quote_id`.

The amount to swap must be specified by setting the following attribute:

* `base_amount` to specify the amount of crypto that will be debited from base asset in order to accredit the equivalent quote asset.

An otherwise-valid request to create a quote execution may fail with the following types of errors:

* **Expired** if the reusable quote with ID `swap_quote_id` has expired.
* **Insufficient Funds** if the end user with ID `end_user_id` has insufficient available balance to fund the execution.
* **Swap Limit Frequency Exceeded** if the end_user reached a Daily/Monthly/Yearly frequency limit for SWAP Trades.
* **Swap Limit Amount Exceeded** if the end_user reached a Daily/Monthly/Yearly amount limit for SWAP Trades.

Execute Swap Reusable Quote

An exchange rate is the rate at which one currency will be exchanged for another currency.

Returns last market rates (BUY and SELL) for each account pair enabled.

Get Last Market Rates

Returns historical market rates, for a given enabled pair.

Either both or none of `begin` and `end` query params are mandatory.
If no `begin` and `end` QueryParams are indicated, the default response will return market prices of the last 24 hours.


Get Historical Market Rates

Returns all enabled pairs for the Account.

A currency pair is a quotation for two different currencies. It is the amount you would pay in one currency for a unit of another currency. For instance, when a trader is quoted USDT/ARS 110.50 it means that the trader can exchange 1 USDT and receive 110.50 ARS.

Get Account Pairs

List Transactions

Retrieve transaction details given an id.

Retrieve Transaction

A transaction limit is the current maximum or minimum amount allowed for a single operation (BUY, SELL, SWAP) and a given fiat currency.

Get Transaction Limits

This endpoint allows to fetch a list of all active End Users already created.

List End Users

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.

In order to create an End User, the partner must provide an unique and arbitrary ID. All following trades will requiere this ID or REF in order to attach the trade data to that user.

Create End User

Retrieve end_user details given an end_user_id (external_ref).

Retrieve End User

Ban an End User

Unban an End User

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.

**Key aspects:**

* **Negotiated Format**: The info field format must be negotiated with the client before usage to ensure it meets the requirements of the specific use case.
* **Validation**: Validation rules for the info payload may vary depending on the format and purpose of the data being submitted.
* **Versatility**: This endpoint is not limited to billing information but can be repurposed for other ad-hoc workflows requiring custom data exchange.
* **Support for Data Corrections**: This endpoint can also be invoked to rectify previously submitted data. If multiple rectifications are sent, the system will always use the most recent rectification received.

**Use Case Example: Regulatory Reporting in Argentina**

A common use case for this endpoint is to collect information for regulatory reporting, such as meeting compliance requirements for Argentina's Financial Information Unit (UIF). In this scenario, the required format for the `info` field is as follows:

Field Descriptions:
- `condición_extranjero (boolean)`: Indicates if the person is a foreign resident (`true`) or not (`false`).
- `cuit (string)`: Unique Tax Identification Code (Clave Única de Identificación Tributaria) of the person.
- `apellidos (string)`: Last name(s) of the person.
- `nombres (string)`: First name(s) of the person.
- `tipo_documento (string)`: Type of document (DNI, PASAPORTE).
- `num_documento (string)`: Document number.
- `nacionalidad (string)`: Nationality of the person.
- `fecha_nac (string)`: Date of birth in the format DD/MM/YYYY.
- `fecha_alta (string)`: Registration date in the format `DD/MM/YYYY`.
- `fecha_baja (string | null)`: Deregistration date in the format `DD/MM/YYYY` or `null` if not applicable.
- `es_pep (boolean)`: Indicates if the person is a Politically Exposed Person (`true` or `false`).

Assign Billing Information for an End User

Retrieve end_user balances details given an end_user_id (external_ref).

Get Balances for End User

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**: Indicates which is the daily / monthly / annual limit of trades that an end user can carry out. A reset of these limits occurs at the end of each period.
- **Tradable Amount**: Indicates which is the maximum operable amount for a purchase or sale trade within a time period, stratified by day / month / year. A reset of these limits occurs at the end of each period.

Currently, the limits model applies to two separate types of operations: **Buy Trades** and **Sell Trades**.
Each type of trade maintains its limits separately, indicating the **Maximum Frequency** and **Tradable Amount** limits for each one, stratified by day / month / year.

It is important to note that each limit is reset at the end of each period. For instance take in consideration the following scenario:

Given that an end user can perform at most 6 BUY trades a day, and the End User _CUST-1567_ has already performed 6 BUY trades this day,
When the end user _CUST-1567_ tries to perform another trade,
the system will respond indicating it has excedeed the daily limit set to 6 trades a day.

Of course, the following day, end user _CUST-1567_ will have 0 trades performed, due to the daily reset, thus it will be able to perform another 6 trades.

It's important to note that Limits are set on commercial and compliance aggreements basis, please reach out your commercial partner if you want to know specific details about limits for your use case.


Get Limits for End User. Limits are set per operation basis, so one should expect for "BUY", "SELL" or "SWAP".

Endpoint that lists every withdrawal operation.

List Withdrawals

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. The subtracted amount will also include a fee amount, returned as charged_fee on the response.
If withdrawal_fee_id is provided, the operation will be executed with such fee, otherwise it will proceed with the fee needed to perform the transaction according to current blockchain activity.

Create Withdrawal

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.

Create Withdrawal Fee

Endpoint that retrieves a specific withdrawal given a withdrawal ID.

Retrieve Withdrawal

This endpoint allows to fetch a list of the given user's wallet's addresses

List End User's Addresses

Endpoint that allows the creation of a deposit address for a given end user.

Create Address for End User

This endpoint allows to fetch a list of the given user's auto-swap addresses

List End User's Auto Swap Addresses

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.

Auto Swap is a feature that allows you to create a deposit address, and any deposit you make will be automatically swapped for a pre-defined asset (contact the admin to set this value) and then withdrawn to the desired target address.

Important Notes:

- The swap will be executed at the best market price obtained after your deposit is confirmed. In other words, this is an open-price model, so there are no guarantees or held-quotes on the final price obtained before the deposit happens.
- Trading and withdrawal fees will be deducted before the converted funds are sent to your target address.


Create Auto Swap Address for End User

This endpoint allows to update the target_address of the given EndUser's auto-swap addresses

Update target_address of EndUser's AutoSwap address.

Endpoint that list all the deposits received.

**Note**:

This endpoints allows to poll or reconcile deposited transactions. We offer the capability to set a Webhook URL in order to be notified in real time. Please note that you should expect a payload format similar to the one below (see results attribute in response's payload)


List Deposits

Endpoint that retrieves details of a received deposit by id.

**Note**:

We offer the capability to set a Webhook URL in order to be notified in real time. Please note that you should expect a payload format similar to the one below.

Retrieve Deposit

Endpoint that performs the creation of an IPN Webhook for the current account.
**Important**: This endpoint is only available in Sandbox.

Create IPN Webhook

Endpoint that list all the available IPN Webhooks for the current account.
**Important**: This endpoint is only available in Sandbox.

List Available IPN Webhooks

Endpoint that allows the retrieval of a given IPN Webhooks.
**Important**: This endpoint is only available in Sandbox.

Retrieve IPN Webhooks

Endpoint that performs an update of an IPN Webhook for the current account.
**Important**: This endpoint is only available in Sandbox.

Update IPN Webhook

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.

Create Deposit IPN Notification for Testing

Endpoint that simulates a fiat deposit in the fiat account with the cvu passed in the body of the request.

Simulate Fiat Deposit

This endpoint allows to fetch a list of the given user's beneficiary fiat accounts.

List Beneficiary Fiat Account

This endpoint allows you to create an Beneficiary Fiat Account.

An Beneficiary Fiat Account represents a Fiat Account owned by the given end user, and will be used to [withdrawal fiat money](/fiat-withdrawals/create-fiat-withdrawal) from user's balance.

Create Beneficiary Fiat Account

This endpoint allows to retrieve an end user's beneficiary fiat accounts details.

Retrieve Beneficiary Fiat Account

This endpoint allows to fetch a list of the given user's fiat accounts.

List Fiat Account

This endpoint allows you to create a Fiat Account. 

A Fiat Account allows an end user to transfer FIAT money to ripio B2B environment. Such money will be used, later, to fulfill orders.  While a process or flow may be technically feasible, it does not necessarily mean it is legally, financially, or operationally viable. These aspects must be reviewed and validated by the respective areas before implementation.

The personal information that will be used to create the Fiat Account is the information that was uploaded in the KYC process. See: [Create KYC Submission](/kyc-submissions/create-kyc-submission).

This endpoint behaves asynchronously, don't expect the Fiat Account to be created after the request execution. To check for its completion, use the [Retrieve Fiat Account endpoint](/fiat-accounts/retrieve-fiat-account). 

When the fiat account is created, a webhook will be sent. See [BaaS Webhook](/webhooks/baas-webhooks#fiat-account-creation-webhook) in the documentation.

Create Fiat Account

This endpoint allows to retrieve an end user's fiat accounts details.

Retrieve Fiat Account

Endpoint that lists every fiat withdrawal operation.

List Fiat Withdrawals

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](/beneficiary-fiat-accounts/create-beneficiary-fiat-account).

This endpoint behaves asynchronously, don't expect the withdrawal to be completed after the request execution. To check for its completion, use the [Retrieve Fiat Withdrawal endpoint](/fiat-withdrawals/retrieve-fiat-withdrawal). Updates for Fiat Withdrawals will be communicated via IPN webhooks. See [IPN Webhooks](/webhooks/bass-webhooks#ipn-fiat-withdrawal-webhook) in the documentation.

Create Fiat Withdrawal

Endpoint that retrieves an specific Fiat Withdrawal given a fiat_withdrawal_id.

We offer the capability to set a Webhook URL in order to be notified in real time. Please note that you should expect a payload format similar to the one below. See [IPN Webhooks](/webhooks/baas-webhooks#ipn-fiat-withdrawal-webhook) in the documentation.

Retrieve Fiat Withdrawal

Endpoint that list all the fiat deposits received.

This endpoints allows to poll or reconcile fiat deposited transactions. We offer the capability to set a Webhook URL in order to be notified in real time. See [IPN Webhooks](/webhooks/baas-webhooks#ipn-fiat-deposit-webhook) in the documentation.

List Fiat Deposits

Endpoint that retrieves details of a received fiat deposit by its id.

We offer the capability to set a Webhook URL in order to be notified in real time. See [IPN Webhooks](/webhooks/baas-webhooks#ipn-fiat-deposit-webhook) in the documentation.

Retrieve Fiat Deposit

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.

KYC Requirements

Endpoint that list an end user's KYC Submissions

List KYC Submissions

This endpoint allows you to submit user's kyc information.

This endpoint behaves asynchronously, don't expect the KYC Submission to be approved after the request execution. To check for its completion, use the [Retrieve KYC Submission endpoint](/kyc-submissions/retrieve-kyc-submission). When the verification submission is completed, a webhook will be sent. See [BaaS Webhooks](/webhooks/baas-webhooks#completed-verification-submission-webhook) in the documentation.

Create KYC Submission

Endpoint that retrieves an specific KYC submission given a submission ID.

We offer the capability to set a Webhook URL in order to be notified in real time. Please note that you should expect a payload format similar to the one below. See [BaaS Webhooks](/webhooks/baas-webhooks#completed-verification-submission-webhook) in the documentation.

Retrieve KYC Submission

🚧 **Work In Progress**

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.

Supports filtering by user ID, asset type, opt-in status, and creation date range.

List Opt Ins

🚧 **Work In Progress**

Register a user to participate in the yield-earning program. This enables daily interest accrual on supported assets held by the user. Opt-in applies to the full balance of eligible assets.

Yield Opt In

🚧 **Work In Progress**

Fetch detailed information about a specific opt-in entry using its unique identifier.

Retrieve Opt In

🚧 **Work In Progress**

De-register a user from the yield-earning program. The user will stop receiving interest on their eligible balances. Requires that the user has an active opt-in.

Yield Opt Out

🚧 **Work In Progress**

Retrieve details of a specific opt-out record, including the associated opt-in and transaction information, by providing its unique ID.

Retrieve Opt Out

🚧 **Work In Progress**

List all yield credit transactions that reflect accrued and credited interest to a user's account.

Supports filtering by user ID, asset, opt-in, and date range of the accrual.

List Yield Credits

🚧 **Work In Progress**

Retrieve detailed information for a specific yield credit transaction, including the amount credited, asset type, and associated opt-in context.

Retrieve Yield Credit

🚧 **Work In Progress**

Retrieve the current Annual Percentage Yields (APYs) for all supported assets enrolled in the yield-earning program.

This endpoint provides information on the rates being applied to user balances for each eligible token. This data can be used to inform the end users about the potential returns for opting in.

Overview

OAuth2

Widget

Trading

Transactions

End Users

Onchain Deposits & Withdrawals

Sandbox

Banking as a Service

Webhooks

🚧 WIP: Yields

List Opt Outs

Authorizations

Query Parameters

Response