Periodic Limits

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.

get/api/v1/end-users/{end_user_id}/limits/

Request

  • Base URL: https://sandbox-b2b.ripio.com
  • URL: https://sandbox-b2b.ripio.com/api/v1/end-users/{end_user_id}/limits/
  • Auth: OAuth 2 (client credentials, token URL https://sandbox-b2b.ripio.com/oauth2/token/)

Response

OK

type'BUY' | 'SELL' required

Indicates limit type.

currency'ARS' | 'USD' required

Indicates the currency in which the limit has been expressed.

period'DAILY' | 'MONTHLY' | 'YEARLY' required

Indicates the period in which the limit applies.

allowed_frequencystring required

Indicates the maximum frequency allowed per period for a given operation type and currency.

allowed_amountstring required

Indicates the maximum tradable amount allowed per period for a given operation type and currency.

consumed_frequencystring required

Indicates the spent frequency related to the allowed_frequency declared. It must comply with the following invariant: allowed_frequency >= consumed_frequency.

consumed_amountstring required

Indicates the spent tradable amount related to the allowed_frequency declared. It must comply with the following invariant: allowed_amount >= consumed_amount.

Changes

No recorded changes to this operation across all 1 revision of this API.