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.
Authorizations
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
Path Parameters
Response
Indicates limit type.
BUY, SELL Indicates the currency in which the limit has been expressed.
ARS, USD Indicates the period in which the limit applies.
DAILY, MONTHLY, YEARLY Indicates the maximum frequency allowed per period for a given operation type and currency.
Indicates the maximum tradable amount allowed per period for a given operation type and currency.
Indicates the spent frequency related to the allowed_frequency declared. It must comply with the following invariant: allowed_frequency >= consumed_frequency.
Indicates the spent tradable amount related to the allowed_frequency declared. It must comply with the following invariant: allowed_amount >= consumed_amount.
Was this page helpful?