> ## 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. > 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 optional `asset` field to opt into a single product instead, one request per product, leaving the other opts of the user untouched. Opt-in applies to the full balance of each opted-in asset. # Yield Opt In The response is always a list, with one element per product opted into. Sending `asset` therefore returns a list of a single element. The request and response example selectors above are independent of each other. Pick the same name in both — `Opt in to every enabled product` or `Opt in to a single product` — to see a request paired with the response it actually produces. ## Opt in to every enabled product Omit `asset`. Every product enabled for your account is opted into, and one opt-in comes back per product. This form requires the user to have **no active opt-in at all**. Omitting `asset` is not a top-up. It does not add the products a user is missing: if the user already has an active opt-in — even for a single product — the request fails with `400` and nothing changes. A user opted into `USDT` only, on an account where `BTC`, `ETH` and `USDT` are enabled: ```json Request theme={null} { "end_user_id": "75c741a2-c3c8-46b1-a807-4fa1f40bf048" } ``` ```json Response theme={null} { "code": 20000, "type": "ValidationError", "detail": { "non_field_errors": [ { "message": "An active OptIn already exists for user 75c741a2-c3c8-46b1-a807-4fa1f40bf048", "code": "invalid" } ] }, "status": 400 } ``` The user stays opted into `USDT` alone. To add `BTC` and `ETH`, send one request per product with `asset`, as shown below. ```json Request theme={null} { "end_user_id": "75c741a2-c3c8-46b1-a807-4fa1f40bf048" } ``` ```json Response theme={null} [ { "id": "c468be09-3a1f-41aa-ad08-c7d715957105", "transaction_id": "e826023d-fddc-4ce1-bdac-7506ed17eb0e", "end_user_id": "75c741a2-c3c8-46b1-a807-4fa1f40bf048", "asset": "BTC", "created_at": "2025-04-10T15:53:11.847992Z", "opt_out_at": null, "is_active": true }, { "id": "c468be09-3a1f-41aa-ad08-c7d715957106", "transaction_id": "e826023d-fddc-4ce1-bdac-7506ed17eb01", "end_user_id": "75c741a2-c3c8-46b1-a807-4fa1f40bf048", "asset": "ETH", "created_at": "2025-04-10T15:53:11.847993Z", "opt_out_at": null, "is_active": true } ] ``` ## Opt in to a single product Send `asset`. Only that product is opted into, and the other opts of the user are left as they are. Send one request per product you want to enable. This is also the only way to enable a further product for a user who is already opted into something: one request per product to add, each naming its `asset`. ```json Request theme={null} { "end_user_id": "75c741a2-c3c8-46b1-a807-4fa1f40bf048", "asset": "USDT" } ``` ```json Response theme={null} [ { "id": "c468be09-3a1f-41aa-ad08-c7d715957107", "transaction_id": "e826023d-fddc-4ce1-bdac-7506ed17eb02", "end_user_id": "75c741a2-c3c8-46b1-a807-4fa1f40bf048", "asset": "USDT", "created_at": "2025-04-10T15:53:11.847994Z", "opt_out_at": null, "is_active": true } ] ``` ## OpenAPI ````yaml crypto-as-a-service/openapi.json POST /api/v1/opt-in/ openapi: 3.0.2 info: title: B2B API version: '1.0' description: >- B2B API allows a third party to access different use cases and services inside of Ripio ecosystem. It is organized around RESTful constraints, with requests and responses in JSON format, using HTTP in the standard format and the answer codes. The API is designed to be compliant with OpenAPI Specification v3.0, which is a trusted open source standard for HTTP-Based APIs. The API offers the ability to test it with a simple, yet powerful sandbox that will enhance developer experience and replicate production capabilities in a well isolated and safe environment, giving developers full freedom to try the integration without compromises. # Error Handling If a request to B2B REST API fails, the response will contain an five-digit error code with a corresponding error message to indicate the details of the error. The following code snippet is a sample error response that contains an error code and message pair: ```` { "code": 40001, "type": "NotAuthenticated", "detail": { "message": "Authentication credentials were not provided.", "code": "not_authenticated" }, "status": 403 } ```` ## Error Codes | Code | Error Category | Description | Resolution | | :------- | :------ | :------ | :----- | | 20000 | Validation Error | Raised when there is a semantic error in the payload of the request. | Check the docs for precise information on how to provide correct values for each resource atribute. | | 20001 | Parse Error | Raised when the API receives a malformed JSON document. | Check for syntax errors in the payload of your request. Also look for sample requests in the docs related to the desired operation. | | 20010 | Expired Quote | Raised when the received quote to execute has expired. | Generate a new quote and execute it within the 30 seconds time window. | | 20011 | Already Executed Quote | Raised when the received quote to execute has been executed before. | Try Generating a new quote with the former pair/amounts to replicate a similar trade. | | 20012 | Not Enough Balance | Raised when the amount to operate (sale/purchase) is larger than the balance amount of the debited currency. | Check end user's balances in order to inform the discrepancy before quote execution. Please contact our support team for further assistance. | | 20013 | Buy Limit Frequency Exceeded | Raised when the "BUY" frequency limit for a given end user has been reached.| Check end user's limits using Limits API in order to inform the discrepancy before performing a quote execution. | | 20014 | Sell Limit Frequency Exceeded | Raised when the "SELL" frequency limit for a given end user has been reached.| Check end user's limits using Limits API in order to inform the discrepancy before performing a quote execution. | | 20015 | Buy Limit Amount Exceeded | Raised when the "BUY" amount limit for a given end user has been reached.| Check end user's limits using Limits API in order to inform the discrepancy before performing a quote execution. | | 20016 | Sell Limit Amount Exceeded | Raised when the "SELL" amount limit for a given end user has been reached.| Check end user's limits using Limits API in order to inform the discrepancy before performing a quote execution. | | 20017 | Buy Transaction Min Limit Exceeded | Raised when the "BUY" amount min limit on a single transaction is exceeded.| Check Ripio's min and max transaction limits. | | 20018 | Buy Transaction Max Limit Exceeded | Raised when the "BUY" amount max limit on a single transaction is exceeded.| Check Ripio's min and max transaction limits. | | 20019 | Sell Transaction Min Limit Exceeded | Raised when the "SELL" amount min limit on a single transaction is exceeded.| Check Ripio's min and max transaction limits. | | 20020 | Sell Transaction Max Limit Exceeded | Raised when the "SELL" amount max limit on a single transaction is exceeded.| Check Ripio's min and max transaction limits. | | 20021 | Banned EndUser | Raised when a quote execution request comes from a banned user.| Please reach out our support team in order to get full detail on why the end user has been banned. | | 20022 | Swap Transaction Min Limit Exceeded | Raised when the "SWAP" amount min limit on a single transaction is exceeded.| Check Ripio's min and max transaction limits. | | 20023 | Swap Transaction Max Limit Exceeded | Raised when the "SWAP" amount max limit on a single transaction is exceeded.| Check Ripio's min and max transaction limits. | | 20024 | Swap Limit Frequency Exceeded | Raised when the "SWAP" frequency limit for a given end user has been reached.| Check end user's limits using Limits API in order to inform the discrepancy before performing a quote execution. | | 20025 | Swap Limit Amount Exceeded | Raised when the "SWAP" amount limit for a given end user has been reached.| Check end user's limits using Limits API in order to inform the discrepancy before performing a quote execution. | | 20026 | Quote With No Price | Raised when the received reusable quote to execute has no price. | Try Generating a new reusable quote with the former pair to replicate a similar trade. | | 20027 | Expired Withdrawal Fee | Raised when trying to execute a withdrawal fee that has already expired. | Request another withdrawal Fee. | | 20029 | Invalid address | Raised when the address provided is not valid on given network. | Try with a valid addres for that network. | | 20030 | Kyc not approved for end user | Raised when the end user doesn't have a kyc process approved. | Check the status of end user's verification submission | | 20031 | Kyc already approved for end user | Raised when the end user already has an approved kyc process. | - | | 20032 | Invalid or disabled payment method type | Raised when the payment_method_type does not exist or is disabled for the acccount. | Please reach out our support team. | | 20033 | Frequency limit exceeded for fiat withdrawals | Raised when the QTY limit for a given currency in a FIAT_WITHDRAWAL operation is exceeded. | - | | 20034 | Amount limit exceeded for fiat withdrawals | Raised when the amount limit for a given currency in a FIAT_WITHDRAWAL operation is exceeded. | - | | 20035 | Fiat account is required | Raised when a fiat account is required. | Create a Fiat account first. | | 20036 | Withdrawal amount less than network dust limit. | Raised when the amount of withdrawal request is less to the network dust limit. | Increase Withrawal amount. | | 20037 | There is no address created for end user and given network. | Raised when there is no address for a given concrete network name. | Create an AutoSwap address first. | || | 40000 | Authentication Failed | Raised when an incoming request includes incorrect authentication. | Check for invalid credentials in your request when trying to authenticate. | | 40001 | Not Authenticated | Raised when an unauthenticated request fails the permission checks. | Check if your request contains a valid and non-expired `access_token`. | | 40003 | Permission Denied | Raised when an authenticated request fails the permission checks. | Check if you have OAuth scopes to access requested resource. Please contact our support team if you think this is an error. | | 40004 | Not Found | Raised when a resource does not exists at the given URL. | Check if the resource you're looking for does exist. | | 40005 | Method Not Allowed | Raised when an incoming request has been performed with certain HTTP verb that is not valid for the requested resource. | Check the resource's docs section to learn the accepted HTTP methods. | | 40006 | Bad Request | Raised when historical market price API endpoint has not been used properly. | Check for syntax errors in the payload of your request. Also look for sample requests in the docs related to the desired operation. | | 40007 | Bad Request | Raised when a currency network is not allowed to operate the selected currency. | Check if your request contains a valid network for the selected currency. | | 40008 | Not Found | Raised when a currency doesn't have its limits configured. | Please reach out our support team with the error details and detailed execution flow. | | 40009 | Bad Request | Raised when an existing Quote with defined external_ref has not been executed, thus it can not be excuted idempotently. | Use another external_ref for the Quote. | | 40010 | Service Unavailable | Raised when there are no addresses available for networks compatible with a specific network name. | Please reach out our support team with the error details and detailed execution flow. | | 40015 | Unsupported Media Type | Raised when the content type of the request data is not JSON compliant. | Check if your request data is compliant with JSON format. | | 40029 | Throttled | Raised when an incoming request fails the throttling checks. | Check if you are exceding the daily/hourly request quota for your account. Please contact our support team if you think you'll need an extended quota for your use-case. | || | 50003 | Service Unavailable | Raised when the service (or requested resource) is not available. | Please reach out our support team with the error details and detailed execution flow. | contact: name: Ripio email: b2b@ripio.com url: https://ripio.com termsOfService: https://www.ripio.com/ar/terms/ servers: - url: https://sandbox-b2b.ripio.com description: Sandbox environment - url: https://b2b-api.ripio.com/ description: Production environment security: - OAuth2: [] tags: - name: Access Token - name: Addresses - name: Auto Swap Addresses - name: Balance - name: Beneficiary Fiat Accounts - name: Deposit IPN - name: Deposits - name: End User - name: Fiat Accounts - name: IPN Webhooks - name: Pairs - name: Periodic Limits - name: Quote Execution - name: Quotes - name: Rates - name: Reusable Quote Execution - name: Reusable Quotes - name: Service Status - name: Swap Reusable Quote Execution - name: Swap Reusable Quotes - name: Transactions - name: TXN Limits - name: Withdrawals - name: Fiat Withdrawals - name: Fiat Deposits - name: KYC Requirements - name: KYC Submissions - name: Simulate Fiat Deposit - name: Yields - name: IPN Messages paths: /api/v1/opt-in/: post: tags: - Yields summary: Yield Opt In operationId: post-api-v1-opt-in requestBody: content: application/json: schema: type: object properties: end_user_id: type: string description: End user's external ref. asset: type: string description: >- Optional. Symbol of the single product to opt the end user into, for example `USDT`. Only the products enabled for your account are accepted; the Yield APYs endpoint lists them. Send one request per product: each one either succeeds for that product or fails without touching the other opts of the end user. When omitted, the end user is opted into every product enabled for your account, and the request requires the end user to have no active opt-in at all: omitting `asset` is not a top-up, so if the end user already has one — even for a single product — the request fails and nothing changes. To add products to an end user who already has some, send one request per product with `asset`. required: - end_user_id examples: Opt in to every enabled product: value: end_user_id: 75c741a2-c3c8-46b1-a807-4fa1f40bf048 Opt in to a single product: value: end_user_id: 75c741a2-c3c8-46b1-a807-4fa1f40bf048 asset: USDT responses: '201': description: Successful Creation content: application/json: schema: type: array description: >- List of opt ins created for the end user. One element per product opted into: every product enabled for your account, or just the one named by `asset`. items: type: object title: Opt In Response properties: id: type: string format: uuid description: UUID used as opt in identifier. transaction_id: type: string format: uuid description: UUID used as opt in's transaction identifier. end_user_id: type: string format: uuid description: Unique identifier used as end user's external ref. asset: type: string description: Asset symbol. created_at: type: string format: date-time description: ISO format creation datetime opt_out_at: type: string format: date-time description: ISO format opt out datetime nullable: true is_active: type: boolean description: Indicates if the opt in is active. examples: Opt in to every enabled product: value: - id: c468be09-3a1f-41aa-ad08-c7d715957105 transaction_id: e826023d-fddc-4ce1-bdac-7506ed17eb0e end_user_id: 75c741a2-c3c8-46b1-a807-4fa1f40bf048 asset: BTC created_at: '2025-04-10T15:53:11.847992Z' opt_out_at: null is_active: true - id: c468be09-3a1f-41aa-ad08-c7d715957106 transaction_id: e826023d-fddc-4ce1-bdac-7506ed17eb01 end_user_id: 75c741a2-c3c8-46b1-a807-4fa1f40bf048 asset: ETH created_at: '2025-04-10T15:53:11.847993Z' opt_out_at: null is_active: true Opt in to a single product: value: - id: c468be09-3a1f-41aa-ad08-c7d715957107 transaction_id: e826023d-fddc-4ce1-bdac-7506ed17eb02 end_user_id: 75c741a2-c3c8-46b1-a807-4fa1f40bf048 asset: USDT created_at: '2025-04-10T15:53:11.847994Z' opt_out_at: null is_active: true '400': description: >- EndUser Not Found, the requested `asset` is not enabled for your account, or the opt-in already exists: for that `asset` when one is sent, or any active opt-in at all when `asset` is omitted. content: application/json: schema: type: object examples: End user not found: value: code: 20000 type: ValidationError detail: non_field_errors: - message: >- Specified end_user_id 75c741a2-c3c8-46b1-a807-4fa1f40bf001 does not exist code: invalid status: 400 Asset not enabled for the account: value: code: 20000 type: ValidationError detail: non_field_errors: - message: >- Specified asset SOL is not enabled for yields. Enabled assets: BTC, ETH, USDT code: invalid status: 400 Active opt-in already exists for the asset: value: code: 20000 type: ValidationError detail: non_field_errors: - message: >- An active OptIn already exists for user 75c741a2-c3c8-46b1-a807-4fa1f40bf048 and asset USDT code: invalid status: 400 Asset omitted and the end user already has an opt-in: value: code: 20000 type: ValidationError detail: non_field_errors: - message: >- An active OptIn already exists for user 75c741a2-c3c8-46b1-a807-4fa1f40bf048 code: invalid status: 400 components: securitySchemes: OAuth2: type: oauth2 flows: clientCredentials: scopes: read: Default scope to read all resources. write: Default scope to performe write operations on certain resources. tokenUrl: https://sandbox-b2b.ripio.com/oauth2/token/ description: > B2B’s White Label API uses OAuth2. Currently there is only one supported authentication flow: * **clientCredentials** allows you to access your own B2B account (First-Party Integration) and performs transactions against the public API. This oauth2 flow is well suited for this API, as it allows machine-to-machine communication. 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 be needed to generate a credential in order to negotiate an ephemeral access token. Every request must be accompianed by an `Authorization` header with a value that follows the following schema: `Bearer ACCESS_TOKEN` ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.