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

# Get Limits for End User.

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




## OpenAPI

````yaml crypto-as-a-service/openapi.json GET /api/v1/end-users/{end_user_id}/limits/
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
paths:
  /api/v1/end-users/{end_user_id}/limits/:
    parameters:
      - schema:
          type: string
        name: end_user_id
        in: path
        required: true
    get:
      tags:
        - Periodic Limits
      summary: Get Limits for End User.
      description: >
        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**: 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.
      operationId: get-api-v1-end-users-end_user_id-limits
      parameters: []
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
                  description: ''
                  x-examples:
                    BUY ARS Yearly Example:
                      type: BUY
                      currency: ARS
                      period: YEARLY
                      allowed_frequency: '5'
                      allowed_amount: '5.00'
                      consumed_frequency: '0'
                      consumed_amount: '0.00'
                    SELL ARS Yearly Example:
                      type: SELL
                      currency: ARS
                      period: YEARLY
                      allowed_frequency: '5'
                      allowed_amount: '5.00'
                      consumed_frequency: '0'
                      consumed_amount: '0.00'
                  properties:
                    type:
                      type: string
                      description: Indicates limit type.
                      enum:
                        - BUY
                        - SELL
                    currency:
                      type: string
                      description: >-
                        Indicates the currency in which the limit has been
                        expressed.
                      enum:
                        - ARS
                        - USD
                    period:
                      type: string
                      description: Indicates the period in which the limit applies.
                      enum:
                        - DAILY
                        - MONTHLY
                        - YEARLY
                    allowed_frequency:
                      type: string
                      description: >-
                        Indicates the maximum frequency allowed per period for a
                        given operation type and currency.
                    allowed_amount:
                      type: string
                      description: >-
                        Indicates the maximum tradable amount allowed per period
                        for a given operation type and currency.
                    consumed_frequency:
                      type: string
                      description: >-
                        Indicates the spent frequency related to the
                        allowed_frequency declared. It must comply with the
                        following invariant: `allowed_frequency >=
                        consumed_frequency`.
                    consumed_amount:
                      type: string
                      description: >-
                        Indicates the spent tradable amount related to the
                        allowed_frequency declared. It must comply with the
                        following invariant: `allowed_amount >=
                        consumed_amount`.
                  required:
                    - type
                    - currency
                    - period
                    - allowed_frequency
                    - allowed_amount
                    - consumed_frequency
                    - consumed_amount
                  readOnly: true
                  x-stoplight:
                    id: w06tn5ptzp6vf
              examples:
                End User Limits:
                  value:
                    - type: BUY
                      currency: ARS
                      period: YEARLY
                      allowed_frequency: '1000'
                      allowed_amount: '5000000.00'
                      consumed_frequency: '5'
                      consumed_amount: '10.00'
                    - type: SELL
                      currency: ARS
                      period: YEARLY
                      allowed_frequency: '5000000.00'
                      allowed_amount: '5.00'
                      consumed_frequency: '10'
                      consumed_amount: '200.00'
                    - type: BUY
                      currency: ARS
                      period: MONTHLY
                      allowed_frequency: '4'
                      allowed_amount: '4.00'
                      consumed_frequency: '0'
                      consumed_amount: '0.00'
                    - type: SELL
                      currency: ARS
                      period: MONTHLY
                      allowed_frequency: '4'
                      allowed_amount: '4.00'
                      consumed_frequency: '0'
                      consumed_amount: '0.00'
                    - type: BUY
                      currency: ARS
                      period: DAILY
                      allowed_frequency: '3'
                      allowed_amount: '3.00'
                      consumed_frequency: '0'
                      consumed_amount: '0.00'
                    - type: SELL
                      currency: ARS
                      period: DAILY
                      allowed_frequency: '3'
                      allowed_amount: '3.00'
                      consumed_frequency: '0'
                      consumed_amount: '0.00'
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`

````