Manteca

Getting started

Introduction

Authentication

Dashboard

Key Concepts

Exchanges (Multi-Country)

Different types of IDs

People, not Users

Error handling

Networks

Pagination

Company Setup

Your Company

Fees and Profit

Accounting

Webhooks

Onboarding Users

The Onboarding Process

Country requirements

Start Operating

Manual Operation

Synthetics (Automatic Operation)

Widgets (Front-end as a service)

Compliance

Compliance concepts

Limits management

Common Entities

Users

User balances

Deposits

Withdraws

Orders

Synthetics

Common Entities Queries

Stats

Accounting Stats

Onboarding Stats

User Stats

Annex

Price Quoting

Previewing QR Payments

Locking withdraw cost

Locking User Balance

Accounting Endpoints

Enum Definitions

Test Resources

Blank

API Cripto

Crypto-as-a-service. Enable buy, sell, and transfer of crypto with one simple API integration

Docs - API Cripto

Production

Sandbox

<p class="slate-p " >Our API is designed to streamline cryptocurrency trading, providing businesses with the infrastructure needed to simplify a wide range of operations. It supports the seamless receipt of user funds from an expanding selection of blockchains and financial institutions, facilitates trading of cryptocurrencies (both cross-pair and against fiat currencies), and enables secure fund transfers to external wallets or bank accounts.</p><p class="slate-p " ></p><h2 class="slate-h2 " >What is the API version 2?</h2><p class="slate-p " >Alongside our cryptocurrency trading API, we provide additional APIs for stock trading and fiat exchange, with other finance-related projects currently in development. To simplify and unify these different systems, we underwent a standardization process, which required changing the structure of certain interfaces as well as many endpoints. We&apos;ve implemented these changes to minimize the adaptation burden on our clients.</p><p class="slate-p " ></p>

Our API is designed to streamline cryptocurrency trading, providing businesses with the infrastructure needed to simplify a wide range of operations. It supports the seamless receipt of user funds from an expanding selection of blockchains and financial institutions, facilitates trading of cryptocurrencies (both cross-pair and against fiat currencies), and enables secure fund transfers to external wallets or bank accounts.

Alongside our cryptocurrency trading API, we provide additional APIs for stock trading and fiat exchange, with other finance-related projects currently in development. To simplify and unify these different systems, we underwent a standardization process, which required changing the structure of certain interfaces as well as many endpoints. We've implemented these changes to minimize the adaptation burden on our clients.

<p class="slate-p " >Manteca uses API keys to authenticate requests. These keys must be included in the <code class="slate-code">md-api-key</code> header.</p><p class="slate-p " >The credentials grant full access, so they must be stored securely. Credential rotation is required every 12 months. Failure to rotate keys will result in failed API calls.</p><p class="slate-p " >For environments with special security requirements, we can enable additional network control measures:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">IP whitelisting </div></li><li class="slate-li " ><div style="position:relative">VPN access</div></li></ul><p class="slate-p " ></p>

Manteca uses API keys to authenticate requests. These keys must be included in the 

The credentials grant full access, so they must be stored securely. Credential rotation is required every 12 months. Failure to rotate keys will result in failed API calls.

For environments with special security requirements, we can enable additional network control measures:

<p class="slate-p " ><p class="slate-p " >All orders will be executed on a particular exchange, an exchange represents a logical separation between certain countries jurisdictions. For the most part you can onboard users on multiple exchanges, so you could for example have half your users on the Argentina exchange, a quarter on the Chile exchange and the rest on the Brazil exchange. A single User will always belong to one and only one exchange, that is because during the onboarding process the users provide their legal id, which corresponds to only one country and therefore one exchange. The real person however can have multiple users on multiple exchanges and even multiple companies. The Argentina exchange has extra onboarding requirements to operate and is treated as a separate entity for accounting, meaning debt generated in that exchange will be displayed separately than debt generated in other exchanges. For more information read <a href="6781fc80d45e47dc0847525c/6781ffe812bd360b8b5edbd5" target="">Accounting</a>.</p><p class="slate-p " ></p></p><h2 class="slate-h2 " >Available Exchanges</h2><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div><div style="width:100px;">Description</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Exchange Country</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Supported Assets</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >ARGENTINA</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >ARS, USD, BRL (QR pix payments)</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >CHILE</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >CLP</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >BRAZIL</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >BRL</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >COLOMBIA</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >COP</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >PANAMA</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >PUSD</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >COSTA_RICA</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >CRC</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >GUATEMALA</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >GTQ</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >MEXICO</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >MXN</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >PHILIPPINES</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >PHP</p></td></div></tr></tbody></table></div><p class="slate-p " ></p><h3 class="slate-h3 " >Differences in accounting between exchanges</h3><p class="slate-p " >For companies that generate credit through the profit system or operate against debt, as described in the <a href="6781fc80d45e47dc0847525c/6781ffe812bd360b8b5edbd5" target="">Accounting</a> section, it is important to explain that all debt/credit generated on any exchange except the Argentina exchange will be converted to it&apos;s USDT value and expected to be settled in that asset or any alternative USD-pegged stable coin that we support like USDC. The only exchange that allows for debt in local currency as of right now is Argentina in which case debt/credit can be in either ARS, USD or USDT, depending on the particular operation.</p><p class="slate-p " ></p><h3 class="slate-h3 " >How we determine the exchange for an operation</h3><p class="slate-p " >The exchange for an operation is determined at the moment of creation of the corresponding entity and it depends on the exchange the User belongs to. For example, if you have users that belong on different exchanges, and then you request to create an Order for one User, then the exchange for that particular Order will match with the exchange for the corresponding User. The same goes for any other entity, although not shown, withdraws and deposits also happen on a particular exchange for the purposes of accounting, meaning that if for example a User from Argentina withdraws funds to the deposit address of a User from Brazil, then the Withdraw will affect the accounting for Argentina whilst the Deposit will affect the accounting for Brazil.</p><p class="slate-p " ></p>

Title

Description

Differences in accounting between exchanges

For companies that generate credit through the profit system or operate against debt, as described in the 

 section, it is important to explain that all debt/credit generated on any exchange except the Argentina exchange will be converted to it's USDT value and expected to be settled in that asset or any alternative USD-pegged stable coin that we support like USDC. The only exchange that allows for debt in local currency as of right now is Argentina in which case debt/credit can be in either ARS, USD or USDT, depending on the particular operation.

How we determine the exchange for an operation

The exchange for an operation is determined at the moment of creation of the corresponding entity and it depends on the exchange the User belongs to. For example, if you have users that belong on different exchanges, and then you request to create an Order for one User, then the exchange for that particular Order will match with the exchange for the corresponding User. The same goes for any other entity, although not shown, withdraws and deposits also happen on a particular exchange for the purposes of accounting, meaning that if for example a User from Argentina withdraws funds to the deposit address of a User from Brazil, then the Withdraw will affect the accounting for Argentina whilst the Deposit will affect the accounting for Brazil.

<p class="slate-p " ><p class="slate-p " ></p><p class="slate-p " >Entities can have multiple types of IDs, these are:</p><p class="slate-p " ></p></p><h3 class="slate-h3 " >ID and numberId</h3><p class="slate-p " >These are always present and are generated by us at the time of entity creation. The ID is a 24-character hexadecimal string that is globally unique across all entity types. The numberId is a positive integer that is only unique within its specific entity type.</p><p class="slate-p " ></p><h3 class="slate-h3 " >External ID</h3><p class="slate-p " >The externalId is optional and managed by your company. If provided, it must be unique within the same entity type. This ID must not follow the format of a 24-character hexadecimal string or a positive integer, to ensure it can be clearly distinguished from the other ID types.</p><p class="slate-p " ></p><h3 class="slate-h3 " >Session ID</h3><p class="slate-p " >You may provide a sessionId when creating entities. This ID can be used to group entities based on any logic your company defines. We impose no constraints on this value. It is simply stored with the entities, allowing you to later query them using that ID. We also offer endpoints that simplify querying multiple entities by sessionId.</p><p class="slate-p " ></p><h3 class="slate-h3 " >Example</h3><p class="slate-p " >For this example let&apos;s assume we have 2 Orders, 1 Withdraw and 1 Deposit. Then the possible IDs would look like this:</p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:initial;"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:127px;">Title</div><div style="width:128px;">Description</div></div><colgroup ><col style="width:127px"><col style="width:128px"><col style="width:242px"><col style="width:184px"><col style="width:210px"><col style="width:103px"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Entity</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Entity Type</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >ID</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Number ID</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >External ID (Optional)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Session ID (Optional)</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >First Order</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Order</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >67628c55a62ffdc40a97e023</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >1</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >example-external-id-1</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >example-session-id-1</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Second Order</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Order</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >67628c5bfd69ee89f9f6fccc</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >2</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >example-external-id-2</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >example-session-id-1</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >First Withdraw</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Withdraw</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >67628c61f2ba1bdc029919d4</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >1</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >example-external-id-1</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >example-session-id-1</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >First Deposit</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Deposit</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >67628c669c53fa98f505a714</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >1</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >example-external-id-1</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >example-session-id-1</p></td></div></tr></tbody></table></div><p class="slate-p " ></p>

These are always present and are generated by us at the time of entity creation. The ID is a 24-character hexadecimal string that is globally unique across all entity types. The numberId is a positive integer that is only unique within its specific entity type.

The externalId is optional and managed by your company. If provided, it must be unique within the same entity type. This ID must not follow the format of a 24-character hexadecimal string or a positive integer, to ensure it can be clearly distinguished from the other ID types.

You may provide a sessionId when creating entities. This ID can be used to group entities based on any logic your company defines. We impose no constraints on this value. It is simply stored with the entities, allowing you to later query them using that ID. We also offer endpoints that simplify querying multiple entities by sessionId.

For this example let's assume we have 2 Orders, 1 Withdraw and 1 Deposit. Then the possible IDs would look like this:

<p class="slate-p " ><p class="slate-p " >Our compliance system monitors activity at the person level, not just at the individual user level. This means that if the same person creates multiple users across different companies using our system, those users will share the same operational limits.</p><p class="slate-p " >For example, if a person reaches their transaction limit while operating through an account under Company A, they will not be able to continue transacting through another account under Company B. The same logic applies to fraud-related restrictions: if fraudulent behavior is detected, the block is applied to the person, regardless of which user or company the behavior originated from.</p><p class="slate-p " >In summary, limits and restrictions are enforced at the person level, regardless of how many users or accounts they may have across different entities.</p></p>

<p class="slate-p " ><p class="slate-p " >API Cripto uses standard HTTP response codes to indicate the success or failure of requests.</p><p class="slate-p " >In general:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">2xx</strong> codes indicate a successful operation. </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">4xx</strong> codes indicate a client error, typically related to the provided input (e.g., missing or invalid parameters). </div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">5xx</strong> codes indicate an unexpected server error on Manteca&apos;s side. </div></li></ul><p class="slate-p " >In the case of an error, additional details can be found in the response body. All error responses follow a consistent format, which includes:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">internalStatus</code>: a string-based internal error code. </div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">message</code>: a more detailed description of the issue. </div></li></ul><p class="slate-p " ></p><p class="slate-p " >All endpoints may return error responses with HTTP status codes in the 400–499 range.
 These responses follow a consistent structure, as shown below:</p></p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">{
  &quot;internalStatus&quot;: &quot;INTERNAL_STATUS&quot;,
  &quot;message&quot;: &quot;Message explaining the error.&quot;,
  &quot;errors&quot;: [
    &quot;Optional array of messages with details about the error.&quot;
  ]
}</div></div></code></pre></div><p class="slate-p " ></p><h2 class="slate-h2 " >Common Errors</h2><div class="accordions-widget multi" style="width:100%"><details class="accordion-item"><summary class=accordion-header><div class=accordion-title><h3>400 - BAD_REQUEST</h3></div><div class=accordion-toggle><svg fill=none height=8 viewBox="0 0 12 8"width=12><path d="M11.3278 0.792629C11.1872 0.795955 11.0535 0.854737 10.956 0.956171L5.99972 5.91242L1.04347 0.956171C0.993767 0.90508 0.93433 0.86447 0.868669 0.836738C0.803007 0.809006 0.732454 0.794716 0.661176 0.794712C0.555079 0.79474 0.4514 0.826409 0.363395 0.885669C0.27539 0.94493 0.207057 1.02909 0.167133 1.12739C0.12721 1.22569 0.117509 1.33366 0.139271 1.4375C0.161033 1.54135 0.213269 1.63634 0.289301 1.71034L5.62264 7.04367C5.72266 7.14365 5.85829 7.19982 5.99972 7.19982C6.14114 7.19982 6.27678 7.14365 6.3768 7.04367L11.7101 1.71034C11.7876 1.63586 11.8407 1.53972 11.8626 1.43451C11.8845 1.32931 11.8741 1.21995 11.8328 1.12076C11.7915 1.02157 11.7212 0.937165 11.6311 0.878615C11.541 0.820064 11.4353 0.790094 11.3278 0.792629Z"fill=#141719 fill-opacity=0.84 /></svg></div></summary><div class="accordion-content"><div class="slate-div"></div><p class="slate-p " >These are errors in how the request was formatted, it will include an array of messages with details about what field had a wrong value and why it was wrong. For example:</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">{
    &quot;internalStatus&quot;: &quot;BAD_REQUEST&quot;,
    &quot;message&quot;: &quot;Bad request.&quot;,
    &quot;errors&quot;: [
        &quot;asset has wrong value INVALID_ASSET. Possible values are DAI,USDT,BUSD,USDC,USDCB,UST,ETH,BNB,AUST,BTC,LUNA,LUNA2,SOL,MATIC,NUARS,WLD,USDL,SDAI,AXS,MANA,ENJ,SAND,PSG,ATM,BAR,CITY,POL.&quot;,
        &quot;against has wrong value INVALID_AGAINST. Possible values are ARS,USD,CLP,COP,BRL,GTQ,CRC,PUSD.&quot;,
        &quot;assetAmount has wrong value non-number-amount. Value should be valid number string using dot (.) as decimal separator and without trailing dot. So 100 or 100.0 but not 100. Adding - at the beginning like -100.10 is not allowed..&quot;,
        &quot;One of these fields needs to be provided [assetAmount, againstAmount].&quot;,
        &quot;withdrawAddress has wrong value non-valid-address. Value should be a valid ethers address or ICAP address.&quot;,
        &quot;withdrawAddress has wrong value non-valid-address. Value should be a valid terra address.&quot;,
        &quot;withdrawAddress has wrong value non-valid-address. Value should be keyword any-available.&quot;,
        &quot;withdrawNetwork has wrong value INVALID_NETWORK. Possible values are ETHEREUM,BINANCE,TERRA,TERRA2,POLYGON,OPTIMISM,WORLDCHAIN,BASE,ARBITRUM,INTERNAL,BIND,COINAG,VITA,KOYWE,LOCALPAYMENT,MANTECA,TRANSFERO,SUPEFINA.&quot;
    ]
}</div></div></code></pre></div></div></details><details class="accordion-item"><summary class=accordion-header><div class=accordion-title><h3>404 - NOT_FOUND</h3></div><div class=accordion-toggle><svg fill=none height=8 viewBox="0 0 12 8"width=12><path d="M11.3278 0.792629C11.1872 0.795955 11.0535 0.854737 10.956 0.956171L5.99972 5.91242L1.04347 0.956171C0.993767 0.90508 0.93433 0.86447 0.868669 0.836738C0.803007 0.809006 0.732454 0.794716 0.661176 0.794712C0.555079 0.79474 0.4514 0.826409 0.363395 0.885669C0.27539 0.94493 0.207057 1.02909 0.167133 1.12739C0.12721 1.22569 0.117509 1.33366 0.139271 1.4375C0.161033 1.54135 0.213269 1.63634 0.289301 1.71034L5.62264 7.04367C5.72266 7.14365 5.85829 7.19982 5.99972 7.19982C6.14114 7.19982 6.27678 7.14365 6.3768 7.04367L11.7101 1.71034C11.7876 1.63586 11.8407 1.53972 11.8626 1.43451C11.8845 1.32931 11.8741 1.21995 11.8328 1.12076C11.7915 1.02157 11.7212 0.937165 11.6311 0.878615C11.541 0.820064 11.4353 0.790094 11.3278 0.792629Z"fill=#141719 fill-opacity=0.84 /></svg></div></summary><div class="accordion-content"><div class="slate-div"></div><p class="slate-p " >A not found error means the requested entity could not be found. This error can appear on POST requests as well if for example during the creation of an Order you provide an userAnyId with valid syntax but but no user with that ID can be found.</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">{
    &quot;internalStatus&quot;: &quot;USER_NF&quot;,
    &quot;message&quot;: &quot;User not found.&quot;
}</div></div></code></pre></div></div></details><details class="accordion-item"><summary class=accordion-header><div class=accordion-title><h3>403 - FORBIDDEN</h3></div><div class=accordion-toggle><svg fill=none height=8 viewBox="0 0 12 8"width=12><path d="M11.3278 0.792629C11.1872 0.795955 11.0535 0.854737 10.956 0.956171L5.99972 5.91242L1.04347 0.956171C0.993767 0.90508 0.93433 0.86447 0.868669 0.836738C0.803007 0.809006 0.732454 0.794716 0.661176 0.794712C0.555079 0.79474 0.4514 0.826409 0.363395 0.885669C0.27539 0.94493 0.207057 1.02909 0.167133 1.12739C0.12721 1.22569 0.117509 1.33366 0.139271 1.4375C0.161033 1.54135 0.213269 1.63634 0.289301 1.71034L5.62264 7.04367C5.72266 7.14365 5.85829 7.19982 5.99972 7.19982C6.14114 7.19982 6.27678 7.14365 6.3768 7.04367L11.7101 1.71034C11.7876 1.63586 11.8407 1.53972 11.8626 1.43451C11.8845 1.32931 11.8741 1.21995 11.8328 1.12076C11.7915 1.02157 11.7212 0.937165 11.6311 0.878615C11.541 0.820064 11.4353 0.790094 11.3278 0.792629Z"fill=#141719 fill-opacity=0.84 /></svg></div></summary><div class="accordion-content"><div class="slate-div"></div><p class="slate-p " >A forbidden error can mean multiple things, like for example either your Company does not have enough permissions to perform a certain operation, or the User is missing some compliance requierements or your Company has reached their debt limit, and so on.</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">{
    &quot;internalStatus&quot;: &quot;PERMISSIONS&quot;,
    &quot;message&quot;: &quot;Company has no such permission.&quot;
}</div></div></code></pre></div></div></details><details class="accordion-item"><summary class=accordion-header><div class=accordion-title><h3>409 - CONFLICT</h3></div><div class=accordion-toggle><svg fill=none height=8 viewBox="0 0 12 8"width=12><path d="M11.3278 0.792629C11.1872 0.795955 11.0535 0.854737 10.956 0.956171L5.99972 5.91242L1.04347 0.956171C0.993767 0.90508 0.93433 0.86447 0.868669 0.836738C0.803007 0.809006 0.732454 0.794716 0.661176 0.794712C0.555079 0.79474 0.4514 0.826409 0.363395 0.885669C0.27539 0.94493 0.207057 1.02909 0.167133 1.12739C0.12721 1.22569 0.117509 1.33366 0.139271 1.4375C0.161033 1.54135 0.213269 1.63634 0.289301 1.71034L5.62264 7.04367C5.72266 7.14365 5.85829 7.19982 5.99972 7.19982C6.14114 7.19982 6.27678 7.14365 6.3768 7.04367L11.7101 1.71034C11.7876 1.63586 11.8407 1.53972 11.8626 1.43451C11.8845 1.32931 11.8741 1.21995 11.8328 1.12076C11.7915 1.02157 11.7212 0.937165 11.6311 0.878615C11.541 0.820064 11.4353 0.790094 11.3278 0.792629Z"fill=#141719 fill-opacity=0.84 /></svg></div></summary><div class="accordion-content"><div class="slate-div"></div><p class="slate-p " >A conflict error means the request was valid, but some aspect of the current state of the entities involved does not allow for such an operation to be performed. For example, asking to pause a Synthetic that is already in a COMPLETED status, or creating an entity with an external ID that already exists.</p><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">{
    &quot;internalStatus&quot;: &quot;SYNTHETIC_STATUS&quot;,
    &quot;message&quot;: &quot;Synthetic status does not allow this operation.&quot;
}</div></div></code></pre></div></div></details><details class="accordion-item"><summary class=accordion-header><div class=accordion-title><h3>500 - SERVER ERROR</h3></div><div class=accordion-toggle><svg fill=none height=8 viewBox="0 0 12 8"width=12><path d="M11.3278 0.792629C11.1872 0.795955 11.0535 0.854737 10.956 0.956171L5.99972 5.91242L1.04347 0.956171C0.993767 0.90508 0.93433 0.86447 0.868669 0.836738C0.803007 0.809006 0.732454 0.794716 0.661176 0.794712C0.555079 0.79474 0.4514 0.826409 0.363395 0.885669C0.27539 0.94493 0.207057 1.02909 0.167133 1.12739C0.12721 1.22569 0.117509 1.33366 0.139271 1.4375C0.161033 1.54135 0.213269 1.63634 0.289301 1.71034L5.62264 7.04367C5.72266 7.14365 5.85829 7.19982 5.99972 7.19982C6.14114 7.19982 6.27678 7.14365 6.3768 7.04367L11.7101 1.71034C11.7876 1.63586 11.8407 1.53972 11.8626 1.43451C11.8845 1.32931 11.8741 1.21995 11.8328 1.12076C11.7915 1.02157 11.7212 0.937165 11.6311 0.878615C11.541 0.820064 11.4353 0.790094 11.3278 0.792629Z"fill=#141719 fill-opacity=0.84 /></svg></div></summary><div class="accordion-content"><div class="slate-div"></div><p class="slate-p " >A server error is rare, but if encountered then it means we are experiencing a temporary issue.</p></div></details></div><p class="slate-p " ></p>

<p class="slate-p " ><p class="slate-p " >Both deposits and withdrawals can be made through different networks, depending on the asset being transferred.
 In this context, a <em class="slate-italic">network</em> refers to either a blockchain or a banking system.</p><p class="slate-p " >
Below is a list of all supported networks, along with the assets available on each:</p></p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:216px;">Title</div><div style="width:0px;">Description</div></div><colgroup ><col style="width:216px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Network</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Supported Assets</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >ETHEREUM</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >ETH, DAI, USDT, USDC, BTC, POL, USDL</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >BINANCE</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >BNB, ETH, DAI, USDT, BUSD, USDC, BTC, POL, SOL, NUARS</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >POLYGON</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >POL, DAI, USDT, USDC, USDCB (USDC.e)</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >OPTIMISM</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >ETH, WLD, USDT, USDC, USDCB (USDC.e)</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >WORLDCHAIN</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >ETH, WLD, USDCB (USDC.e)</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >BASE</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >ETH, USDC</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >ARBITRUM</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >ETH, ARB, USDC</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >BANK TRANSFER</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >ARS, USD, CLP, COP, PUSD, CRC, GTQ, MXN, PHP</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >PIX</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >BRL</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >TRANSFIYA</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >COP</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >NEQUI</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >COP</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >INSTAPAY</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >PHP</p></td></div></tr></tbody></table></div><p class="slate-p " ></p>

<p class="slate-p " >Some endpoints return arrays in the response. In cases where the data set can grow dynamically, the response will include pagination metadata, and the following query parameters are supported for paginated requests:</p><p class="slate-p " ><strong class="slate-bold">Parameters</strong></p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative"><code class="slate-code">page</code>: The current page number (default: <code class="slate-code">1</code>) </div></li><li class="slate-li " ><div style="position:relative"><code class="slate-code">limit</code>: The number of items per page (default: <code class="slate-code">10</code>)</div></li></ul><p class="slate-p " ></p>

Some endpoints return arrays in the response. In cases where the data set can grow dynamically, the response will include pagination metadata, and the following query parameters are supported for paginated requests:

<p class="slate-p " >The first step to start using our API is to create your company account. To do this, please reach out to us at info@manteca.dev. We&apos;ll review your company’s requirements and guide you through the integration process.</p><p class="slate-p " >During onboarding, we’ll create your company entity and provide you with the API keys required to access our sandbox environment, where you can begin testing your integration.</p><p class="slate-p " >This entity will include all relevant configurations, such as:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Accounting setup: defines which addresses are authorized to settle debts and/or receive profits </div></li><li class="slate-li " ><div style="position:relative">Webhook configuration: allows you to define how your company will receive event notifications from our system </div></li><li class="slate-li " ><div style="position:relative">Fee configuration: allows you to specify markup fees charged on top of the base price</div></li></ul><p class="slate-p " ></p><h3 class="slate-h3 " >Company entity interface</h3><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">TypeScript</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-typescript keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">interface ICompany {
    // Id of your company, a 24 hex string.
    id: string

    // The name of your company.
    name: string

    // Optional contact email for your company.
    email?: string

    // Your accounting information where you can whitelist settlement and collector addresses.
    accounting: {
        // Here we hold the settlement addresses.
        // These are CVU/CBU, crypto addresses, etc that if we detect a deposit to accounting address from one of these addresses we consider that deposit a settlement for this company&apos;s debt.
        settlementAddresses: string[]

        // Here we hold the collector addresses.
        // These are CVU/CBU, crypto addresses, etc that are authorized to be selected to collect profits or outstanding credit.
        collectorAddresses: string[]
    }

    // Your notification information where you can configure how you want your company to be notified of system events.
    notificationInfo: {
        // The notification type determines how we notify your company of system events like an order being completed.
        type: COMPANY_NOTIFICATION_TYPE

        // The url where we are going to send webhooks if no other more specific webhook was set up.
        // Required for WEBHOOK notification type and ignored for NONE.
        generalWebhook?: string

        // Here the company can configure more specific webhooks, in case they want for example order status update to be sent to a different url than the rest.
        // Required for WEBHOOK notification type and ignored for NONE.
        webhooks?: {
            // Mapping of event names to webhook url.
            [event: string]: string
        }

        // Possible values are “STABLE” meaning all debt is converted to USD-Pegged stable, even supported fiat debt, and must be cancelled sending some USD-Pegged stable.
        // Or “MATCHING” meaning debt in supported fiat (like “ARS”, or “BRL”) will not be converted and must be cancelled sending the corresponding fiat.
        settlementPreference: string
    }

    // Time of the creation of your company entity as an ISO 8601 Date string.
    creationTime: string

    // Time your company entity was last updated at as an ISO 8601 Date string.
    updatedAt: string
}</div></div></code></pre></div><p class="slate-p " ></p><h3 class="slate-h3 " >Example company</h3><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">{
    &quot;id&quot;: &quot;675e629f4582a7f05c68f841&quot;,
    &quot;name&quot;: &quot;Manteca company&quot;,
    &quot;email&quot;: &quot;dev@example.com&quot;,
    &quot;accounting&quot;: {
        &quot;settlementAddresses&quot;: [
            &quot;some crypto address&quot;,
            &quot;some bank address&quot;
        ],
        &quot;collectorAddresses&quot;: [
            &quot;some crypto address&quot;,
            &quot;some bank address&quot;
        ]
    },
    &quot;notificationInfo&quot;: {
        &quot;type&quot;: &quot;WEBHOOK&quot;,
        &quot;generalWebhook&quot;: &quot;https://www.example.com/general/webhook/listener&quot;,
        &quot;webhooks&quot;: {
            &quot;ORDER_STATUS_UPDATE&quot;: &quot;https://www.example.com/order/webhook/listener/override&quot;,
            &quot;DEPOSIT_STATUS_UPDATE&quot;: &quot;https://www.example.com/deposit/webhook/listener/override&quot;
        }
    },
    &quot;creationTime&quot;: &quot;2024-12-13T12:22:54.290-03:00&quot;,
    &quot;updatedAt&quot;: &quot;2024-12-13T12:22:54.290-03:00&quot;,
}</div></div></code></pre></div><p class="slate-p " ></p>

The first step to start using our API is to create your company account. To do this, please reach out to us at info@manteca.dev. We'll review your company’s requirements and guide you through the integration process.

During onboarding, we’ll create your company entity and provide you with the API keys required to access our sandbox environment, where you can begin testing your integration.

This entity will include all relevant configurations, such as:

<p class="slate-p " ><p class="slate-p " >In API Crypto, we don&apos;t charge platform fees. In our pricing model, all prices provided already include a spread that covers Manteca’s revenue. As such, they can be used directly for operations without requiring any additional adjustments.</p><p class="slate-p " >If your company wishes to charge an additional fee to end users, this must be configured on top of our base prices. Any extra amount collected will be treated as your company’s revenue and can be managed and monitored through our accounting system.</p></p><h3 class="slate-h3 " >Types of fees</h3><p class="slate-p " >In API Crypto, we currently offer one type of fee: the Base Fee (or Platform Fee). Our other API solutions may include additional fee types.</p><p class="slate-p " >The Base Fee is the percentage of each Order taken to cover service costs and generate profit for your company to be collected later. This value is determined during onboarding based on your company&apos;s specific needs. It works in conjunction with the Base Split, which determines what percentage goes to Manteca versus your company.
Example<strong class="slate-bold">:</strong> If the Base Fee is 0.05 (5%) and the Base Split is 0.7 (70% to your company) on an Order of $10,000 ARS:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">$500 ARS is taken as fees (5% of $10,000)</div></li><li class="slate-li " ><div style="position:relative">$350 ARS goes to your company (70% of the $500 fee)</div></li><li class="slate-li " ><div style="position:relative">$150 ARS goes to Manteca (30% of the $500 fee)</div></li><li class="slate-li " ><div style="position:relative">$9,500 ARS is converted to the crypto asset specified in the Order
</div></li></ul><h3 class="slate-h3 " >Fee interface</h3><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">TypeScript</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-typescript keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">interface IFeeInfo {
    // The id of the fee info, used for queries and to assign Users later.
    id: string

    // Flag that determines if this is the main fee info that will act as the default.
    main: boolean

    // The values of the fees and split for this Fee Info. All values are numbers between 0 and 1 and represent a percentage, so “0.5” means 50%
    structure: {
        // The base fee is the fee to use our platforms, this is the fee that can be split between Manteca and your Company. In CRIPTO all of this fee is for your Company.
        baseFee: string

        // This is the percentage of the base fee that goes to your company. In CRIPTO baseSplit is usually 1, because we don&apos;t have platform fees.
        baseSplit: string
    }

    // Time of the creation of your company entity as an ISO 8601 Date string.
    creationTime: string

    // Time your company entity was last updated at as an ISO 8601 Date string.
    updatedAt: string
}</div></div></code></pre></div><p class="slate-p " ></p><h3 class="slate-h3 " >Example fee configuration</h3><div class="slate-code_line"></div><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">{
    &quot;id&quot;: &quot;6789b7effcd21f313bb24477&quot;,
    &quot;main&quot;: true,
    &quot;structure&quot;: {
        &quot;baseFee&quot;: &quot;0.05&quot;,
        &quot;baseSplit&quot;: &quot;0.5&quot;
    },
    &quot;creationTime&quot;: &quot;2024-12-13T12:22:54.290-03:00&quot;,
    &quot;updatedAt&quot;: &quot;2024-12-13T12:22:54.290-03:00&quot;
}</div></div></code></pre></div><p class="slate-p " ></p>

In API Crypto, we currently offer one type of fee: the Base Fee (or Platform Fee). Our other API solutions may include additional fee types.

The Base Fee is the percentage of each Order taken to cover service costs and generate profit for your company to be collected later. This value is determined during onboarding based on your company's specific needs. It works in conjunction with the Base Split, which determines what percentage goes to Manteca versus your company.
Example

 If the Base Fee is 0.05 (5%) and the Base Split is 0.7 (70% to your company) on an Order of $10,000 ARS:

<p class="slate-p " >For companies that need to operate with credit or manage debt settlements, we provide a comprehensive accounting system that tracks all financial obligations and presents them through simple endpoints for easy management. Our flexible accounting system supports different operational models:</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">User balance Operations</strong>: Standard operations where users maintain a balance within your platform.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Credit-based Operations</strong>: Allow users to operate on credit and settle accumulated debt at scheduled intervals.</div></li><li class="slate-li " ><div style="position:relative"><strong class="slate-bold">Pre-funded Overdraft</strong>: For scenarios requiring credit operations with pre-funding to cover potential exposure.</div></li></ol><p class="slate-p " ></p><p class="slate-p " >Our accounting system gives you the flexibility to choose the operational model that best fits your business requirements, whether you need real-time settlements or periodic debt reconciliation.</p><p class="slate-p " ></p><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h2 class="slate-h2 " >
Settlements</h2><p class="slate-p " >Settlements are records of all instances where your company and Manteca have settled outstanding debts. These settlements are triggered either manually or automatically when funds are sent from your settlement addresses to one of our bank accounts or when your company withdraws company credit or profit to one of your collector addresses.</p><p class="slate-p " ></p><h3 class="slate-h3 " >Settlement interface</h3><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">TypeScript</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-typescript keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">interface ISettlement {
    // Id of the settlement, a 24 hex string.
    id: string

    // The platform that relates to the settlement. This can be: CRIPTO, BROKER or CAMBIO.
    platform: PLATFORM

    // The type of settlement, read enum below for more details.
    type: ACCOUNTING_SETTLEMENT_TYPE

    // The money being sent, always in positive values and the type determines if it is treated as credit or debt.
    payment: IBalance

    // How many debt slips were eliminated during this settlement.
    // Remember debt slips and net balance (credit - debt) are different things.
    debtSettled: IBalance

    // How many credit slips (not profit slips) were eliminated during this settlement.
    creditSettled: IBalance

    // How many profit slips (not credit slips) were eliminated during this settlement.
    profitSettled: IBalance

    // Time of the creation of the settlement entity as ISO 8601 Date String.
    creationTime: string

    // Time the settlement entity was last updated at as ISO 8601 Date String.
    updatedAt: string
}

enum ACCOUNTING_SETTLEMENT_TYPE {
    // Your company sent money to manteca and that resulted on this settlement.
    COMPANY_TO_MANTECA = &apos;COMPANY_TO_MANTECA&apos;,
    // Your company withdrew credit or manteca sent money to your company some other way and that resulted on this settlement.
    MANTECA_TO_COMPANY = &apos;MANTECA_TO_COMPANY&apos;,
    // Your company withdrew accumulated profit and that resulted on this settlement.
    PROFIT_SETTLEMENT = &apos;PROFIT_SETTLEMENT&apos;,
}

interface IBalance {
    // Keys are assets, like &quot;ARS&quot; or &quot;USDT&quot; and value is decimal amounts, like &quot;10.0&quot; or &quot;0.000005&quot;.
    [asset: string]: string
}</div></div></code></pre></div><p class="slate-p " ></p><h3 class="slate-h3 " >Example settlement</h3><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">{
    &quot;id&quot;: &quot;675fc843f5763f6f70e832b0&quot;,
    &quot;platform&quot;: &quot;CRIPTO&quot;,
    &quot;type&quot;: &quot;COMPANY_TO_MANTECA&quot;,
    &quot;payment&quot;: {
        &quot;USDT&quot;: &quot;1480.35894572&quot;
    },
    &quot;debtSettled&quot;: {
        &quot;USDT&quot;: &quot;6480.35894572&quot;
    },
    &quot;creditSettled&quot;: {
        &quot;USDT&quot;: &quot;5000.00&quot;
    },
    &quot;profitSettled&quot;: {},
    &quot;creationTime&quot;: &quot;2024-12-13T12:22:54.290-03:00&quot;,
    &quot;updatedAt&quot;: &quot;2024-12-13T12:22:54.290-03:00&quot;
}
</div></div></code></pre></div><p class="slate-p " ></p><h3 class="slate-h3 " ></h3><p class="slate-p " ></p>

For companies that need to operate with credit or manage debt settlements, we provide a comprehensive accounting system that tracks all financial obligations and presents them through simple endpoints for easy management. Our flexible accounting system supports different operational models:

Our accounting system gives you the flexibility to choose the operational model that best fits your business requirements, whether you need real-time settlements or periodic debt reconciliation.

Settlements are records of all instances where your company and Manteca have settled outstanding debts. These settlements are triggered either manually or automatically when funds are sent from your settlement addresses to one of our bank accounts or when your company withdraws company credit or profit to one of your collector addresses.

Webhooks are one of the ways in which a system event can be notified to a company. Read 

 section to view the endpoint used to configure your notification settings. Webhooks—both in the sandbox and production environments—will be sent from the fixed IP address: 

. This static IP allows your team to adjust firewall or security policies accordingly to ensure secure and controlled reception of webhook events.

To ensure the integrity of data sent via webhooks, we use an HMAC-based validation system. Each webhook includes a signature in the 

 HTTP header. This signature, combined with the shared secret between your company and Manteca, allows you to verify the authenticity of incoming messages.

The verification process involves generating an HMAC signature on your side using:

The generated signature must exactly match the one received in the header. To guarantee consistency and make sure the HMAC calculation is deterministic, the JSON body must be serialized in a stable way—with keys sorted alphabetically.

 library to handle this serialization. We recommend applying a similar approach on your side to ensure consistent results during verification.


The payload for an event and the payload sent in a webhook are not the same, since webhook payloads will contain extra information. At continuation we will show the basic structure of a webhook payload:

When delivering webhooks, we implement an exponential backoff strategy to handle failures gracefully. If the receiving server does not respond with a successful HTTP status code (2xx), we will not drop the request immediately. Instead, we will automatically retry the delivery multiple times over the course of several hours, gradually increasing the delay between each attempt.

This approach ensures resilience against temporary outages or network issues on the receiving end.

<div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >A more streamlined alternative exists through the use of Widgets, read <a href="6781feaa12bd360b8b5ed9ed/6789fe2333b3c89b3bb8bd28" target="">Onboarding Widget</a> section for more information.</p></div></div><p class="slate-p " ><p class="slate-p " >The process of onboarding a new user is a vital part of our platform, and is the first step any user needs to perform in order to operate in our systems. The general flow for the onboarding process is:</p></p><div class="steps-widget" style="width:100%;
  	min-width:100%;"><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >1</h6><h3 class="slate-h3 " >Creation of the initial user</h3><p class="slate-p " >A user is created with minimal information and initially assigned the <code class="slate-code">ONBOARDING</code> status. While in this status, the user cannot perform any operations. While sending a complete dataset is not mandatory—since the onboarding process allows for incremental updates through other tasks—we strongly recommend including as much data as possible from the start. Providing a full set of user information increases the chances of an instant approval, reducing the need for manual review or follow-ups.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >2</h6><h3 class="slate-h3 " >Perform all the required onboarding tasks</h3><p class="slate-p " >They must complete all onboarding tasks marked as required. For details on how to perform each task and when they are typically needed, refer to the <a href="6781fca833b3c89b3beb049f/67926378cb63a70cd625879c" target="">Onboarding tasks</a> section. <strong class="slate-bold">In most countries, onboarding tasks are completed automatically.</strong></p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >3</h6><h3 class="slate-h3 " >User status changes to <code class="slate-code">ACTIVE</code></h3><p class="slate-p " >Once all required onboarding tasks have been completed, the user’s status will transition to <code class="slate-code">ACTIVE</code>, allowing them to start operating.</p></div></div></div><p class="slate-p " ></p>

<p class="slate-p " >Onboarding requirements are quite similar across countries; however, certain data fields may be optional in some jurisdictions and mandatory in others. As a general rule, we recommend always providing as much information as possible, even though we have access to systems that allow us to retrieve additional details based on the legal IDs you provide.</p><p class="slate-p " ></p>

Onboarding requirements are quite similar across countries; however, certain data fields may be optional in some jurisdictions and mandatory in others. As a general rule, we recommend always providing as much information as possible, even though we have access to systems that allow us to retrieve additional details based on the legal IDs you provide.

<p class="slate-p " >We call manual operation to the process of manually creating the price locks, orders and withdraws with individual HTTP requests to separate endpoints, as opposed to, for example, doing it through a <a href="6781feaa12bd360b8b5ed9ed/67564795c495c161c94b0665" target="">Synthetic</a> or through a <a href="6781feaa12bd360b8b5ed9ed/6756479ac495c161c94b0679" target="">Widget</a>.</p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >Read the <a href="6781fe85d45e47dc08475523/6788f4dc33b3c89b3b9508ef" target="">Common Entities</a> section to gain a better understading of what the entities look like.</p></div></div><p class="slate-p " ></p>

We call manual operation to the process of manually creating the price locks, orders and withdraws with individual HTTP requests to separate endpoints, as opposed to, for example, doing it through a 

<p class="slate-p " >We understand some flows are very common and companies would like a simplified version of said flows. In order to respond to this demand we developed some automatization tools, in particular what we call Synthetics, which will simplify and automate some common operations, like for example detect a deposit, create an order for the amount that was deposited and then withdraw the result of the order to a certain address, flow that we call a ramp operation.
A <a href="6781fe85d45e47dc08475523/6789da4f39e1c2df200a0f23" target="">Synthetic</a> is an entity which consists of a series of stages that will be executed in order according to certain logic. One example of this would be a ramp operation, where it waits for a deposit to arrive, once it detects one it creates an order based on the received amount, and finally once the order is complete it withdraws the resulting amount to a given address.</p><p class="slate-p " ></p><div class="accordions-widget " style="width:100%"><details class="accordion-item"><summary class=accordion-header><div class=accordion-title><div class=icon><svg width="32" height="32" viewBox="0 0 24 24" fill="none" class="icon-style" xmlns="http://www.w3.org/2000/svg"> <g clipPath="url(#clip0_2631_4475)"> <path d="M22 7C22.5304 7 23.0391 6.78929 23.4142 6.41421C23.7893 6.03914 24 5.53043 24 5V1C24 0.734784 23.8946 0.48043 23.7071 0.292893C23.5196 0.105357 23.2652 0 23 0C22.7348 0 22.4804 0.105357 22.2929 0.292893C22.1054 0.48043 22 0.734784 22 1V5H18C17.982 5 17.968 5.009 17.95 5.01C17.4717 3.825 16.6502 2.80998 15.5909 2.09522C14.5316 1.38045 13.2829 0.998562 12.005 0.998562C10.7271 0.998562 9.47839 1.38045 8.4191 2.09522C7.35981 2.80998 6.5383 3.825 6.06 5.01C6.039 5.011 6.021 5 6 5H2V1C2 0.734784 1.89464 0.48043 1.70711 0.292893C1.51957 0.105357 1.26522 0 1 0C0.734784 0 0.48043 0.105357 0.292893 0.292893C0.105357 0.48043 0 0.734784 0 1L0 5C0 5.53043 0.210714 6.03914 0.585786 6.41421C0.960859 6.78929 1.46957 7 2 7H5.485L4.472 11H1C0.734784 11 0.48043 11.1054 0.292893 11.2929C0.105357 11.4804 0 11.7348 0 12C0 12.2652 0.105357 12.5196 0.292893 12.7071C0.48043 12.8946 0.734784 13 1 13H3.965L3.82 13.573L3.8 13.7C3.75541 14.0422 3.73203 14.3869 3.73 14.732C3.73101 15.4994 3.83974 16.2628 4.053 17H2C1.46957 17 0.960859 17.2107 0.585786 17.5858C0.210714 17.9609 0 18.4696 0 19L0 23C0 23.2652 0.105357 23.5196 0.292893 23.7071C0.48043 23.8946 0.734784 24 1 24C1.26522 24 1.51957 23.8946 1.70711 23.7071C1.89464 23.5196 2 23.2652 2 23V19H4.93C5.66311 20.2202 6.69952 21.2298 7.93842 21.9308C9.17732 22.6317 10.5765 23.0001 12 23.0001C13.4235 23.0001 14.8227 22.6317 16.0616 21.9308C17.3005 21.2298 18.3369 20.2202 19.07 19H22V23C22 23.2652 22.1054 23.5196 22.2929 23.7071C22.4804 23.8946 22.7348 24 23 24C23.2652 24 23.5196 23.8946 23.7071 23.7071C23.8946 23.5196 24 23.2652 24 23V19C24 18.4696 23.7893 17.9609 23.4142 17.5858C23.0391 17.2107 22.5304 17 22 17H19.947C20.1614 16.2613 20.2708 15.4962 20.272 14.727C20.2691 14.3835 20.2451 14.0405 20.2 13.7L20.025 13H23C23.2652 13 23.5196 12.8946 23.7071 12.7071C23.8946 12.5196 24 12.2652 24 12C24 11.7348 23.8946 11.4804 23.7071 11.2929C23.5196 11.1054 23.2652 11 23 11H19.522L18.513 7H22ZM12 21C10.337 20.9981 8.74257 20.3366 7.56672 19.1606C6.39086 17.9845 5.72959 16.39 5.728 14.727C5.72938 14.484 5.74507 14.2412 5.775 14L7.805 5.97C8.10966 5.1051 8.67418 4.3555 9.42129 3.82381C10.1684 3.29212 11.0616 3.00434 11.9786 2.99985C12.8955 2.99536 13.7915 3.27439 14.5438 3.79874C15.2961 4.32309 15.8679 5.06712 16.181 5.929L18.225 14C18.2549 14.2405 18.2705 14.4826 18.272 14.725C18.2709 16.3884 17.6099 17.9834 16.434 19.1599C15.2581 20.3363 13.6634 20.9981 12 21Z" fill="#374957" /> </g> <defs> <clipPath id="clip0_2631_4475"> <rect width="32" height="32" fill="white" /> </clipPath> </defs> </svg></div><h3>Common Errors</h3></div><div class=accordion-toggle><svg fill=none height=8 viewBox="0 0 12 8"width=12><path d="M11.3278 0.792629C11.1872 0.795955 11.0535 0.854737 10.956 0.956171L5.99972 5.91242L1.04347 0.956171C0.993767 0.90508 0.93433 0.86447 0.868669 0.836738C0.803007 0.809006 0.732454 0.794716 0.661176 0.794712C0.555079 0.79474 0.4514 0.826409 0.363395 0.885669C0.27539 0.94493 0.207057 1.02909 0.167133 1.12739C0.12721 1.22569 0.117509 1.33366 0.139271 1.4375C0.161033 1.54135 0.213269 1.63634 0.289301 1.71034L5.62264 7.04367C5.72266 7.14365 5.85829 7.19982 5.99972 7.19982C6.14114 7.19982 6.27678 7.14365 6.3768 7.04367L11.7101 1.71034C11.7876 1.63586 11.8407 1.53972 11.8626 1.43451C11.8845 1.32931 11.8741 1.21995 11.8328 1.12076C11.7915 1.02157 11.7212 0.937165 11.6311 0.878615C11.541 0.820064 11.4353 0.790094 11.3278 0.792629Z"fill=#141719 fill-opacity=0.84 /></svg></div></summary><div class="accordion-content"><div class="slate-div"></div><p class="slate-p " >BAD_REQUEST.PARAMS: Invalid parameters
BAD_REQUEST.FUNDS: Insufficient funds
BAD_REQUEST.EXPIRED_PRICE: Expired prices
BAD_REQUEST.EXTERNAL_ID: The externalId cannot be a purely numeric value
BAD_REQUEST.INVALID_COIN: Invalid coin
BAD_REQUEST.INVALID_COIN_COUNTRY: Invalid coin for user country
FORBIDDEN.PERMISSIONS: Company has no such permission
NOT_FOUND.USER: User not found
NOT_FOUND.PRICE: Price not found
CONFLICT.USER_BLOCKED: User blocked
CONFLICT.USER_NOT_VALIDATED: User not able to operate
CONFLICT.SYNTHETIC_EXISTS: Synthetic with given ids already exists
CONFLICT.SYNTHETIC_STATUS: Synthetic status does not allow this operation
CONFLICT.SYNTHETIC_TYPE: Synthetic type does not allow this operation
CONFLICT.OPERATION_BLOCKED: Operation blocked
CONFLICT.QR_PAYMENT: QR-PAYMENT generic error
CONFLICT.QR_STATUS: Given QR payment is already paid or expired
CONFLICT.QR_AMOUNT: Given QR payment requires amount to be provided in order to acquire the lock
BAD_REQUEST.QR_CODE: QR code seems to be invalid
BAD_REQUEST.BLOCKED_UIF: User blocked due to missing fund origin or required ID documentation
BAD_REQUEST.IS_PEP: User is a Politically Exposed Person (PEP); PEP documentation required
BAD_REQUEST.IS_FACTA: User is a US national and cannot operate
BAD_REQUEST.IS_UAF: User is classified as UAF and cannot operate
BAD_REQUEST.IS_IN_LISTS: User is considered high risk and cannot operate
BAD_REQUEST.IS_DEAD: User is considered high risk (deceased) and cannot operate
BAD_REQUEST.IS_UNDER_AGE: User is underage and cannot operate
BAD_REQUEST.HIGH_RISK: User is high risk and cannot operate
CONFLICT.USER_NEEDS_EXTRA_DOC: User needs to provide additional documentation
CONFLICT.USER_BLOCKED_FUNDS: User has blocked funds</p></div></details></div><p class="slate-p " ></p>

We understand some flows are very common and companies would like a simplified version of said flows. In order to respond to this demand we developed some automatization tools, in particular what we call Synthetics, which will simplify and automate some common operations, like for example detect a deposit, create an order for the amount that was deposited and then withdraw the result of the order to a certain address, flow that we call a ramp operation.
A 

 is an entity which consists of a series of stages that will be executed in order according to certain logic. One example of this would be a ramp operation, where it waits for a deposit to arrive, once it detects one it creates an order based on the received amount, and finally once the order is complete it withdraws the resulting amount to a given address.

<p class="slate-p " ><p class="slate-p " >Widgets are our solution for those companies that do not desire to build a new user-facing interface to get integrated into our systems, and simply wish to redirect their users to one of our widgets to perform the necessary operations and then await for the response of said operation to continue. We have a few of these widgets available to perform complex operations like the onboarding of a new user, including the respective KYC requirements, or the creation of a ramp operation, as well as the possibility to chain widgets one after the other.</p></p><p class="slate-p " >The flow of a widget consists of 3 simple steps:</p><p class="slate-p " ></p><div class="steps-widget" style="width:100%;
  	min-width:100%;"><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >1</h6><h3 class="slate-h3 " >Generate a new widget URL</h3><p class="slate-p " >With your company API Key you can requests a new widget url for a given flow, like for example onboarding or ramp operation or onboarding followed by a ramp operation, etc. In this first request you can provide the necessary configuration to determine the behaviour of the widget, like for example determining the return url (the url the user is redirected to after widget ends) or the externalId to assign the created user (in the onboarding widget) or the details of the ramp operation like the asset, amount, withdraw network, etc.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >2</h6><h3 class="slate-h3 " >Redirect user to the URL</h3><p class="slate-p " >Once you have generated the URL you simply need to redirect your user to that URL and they will be presented with the visual interface to perform the corresponding operation. The authentication is embedded into the URL so no other extra action is required.</p></div></div><div class="steps-wrapper"><div class="steps-content"><h6 class="slate-h6 " >3</h6><h3 class="slate-h3 " >Await for the response</h3><p class="slate-p " >During the generation of the URL you defined a returnUrl, and optionally a failureUrl. A GET HTTP Request will be sent to that URL once the user finalized utilizing the widget, and in the query parameters of said url we will send you all the relevant information that was generated during the use of the widget. You can also listen to corresponding system events through our notification system (read <a href="6781fc80d45e47dc0847525c/67835c8cd45e47dc084c21a8" target="">Notifications</a> for more information).</p></div></div></div><p class="slate-p " ></p><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=success ><div class="callout-icon"><svg width="18" height="18" viewBox="0 0 18 18" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M7.77116 10.8968L5.72949 8.8551C5.60449 8.7301 5.45171 8.6676 5.27116 8.6676C5.0906 8.6676 4.93088 8.73705 4.79199 8.87594C4.6531 9.01482 4.58366 9.17455 4.58366 9.3551C4.58366 9.53566 4.6531 9.68844 4.79199 9.81344L7.33366 12.3551C7.45866 12.4801 7.60449 12.5426 7.77116 12.5426C7.93783 12.5426 8.08366 12.4801 8.20866 12.3551L13.2087 7.3551C13.3337 7.2301 13.3927 7.07732 13.3857 6.89677C13.3788 6.71621 13.3128 6.56344 13.1878 6.43844C13.0628 6.29955 12.9066 6.2301 12.7191 6.2301C12.5316 6.2301 12.3684 6.29955 12.2295 6.43844L7.77116 10.8968ZM9.00033 17.3343C7.81977 17.3343 6.72255 17.1225 5.70866 16.6989C4.69477 16.2752 3.81283 15.6884 3.06283 14.9384C2.31283 14.1884 1.72602 13.3065 1.30241 12.2926C0.878798 11.2787 0.666992 10.1815 0.666992 9.00094C0.666992 7.83427 0.878798 6.74399 1.30241 5.7301C1.72602 4.71621 2.31283 3.83427 3.06283 3.08427C3.81283 2.33427 4.69477 1.74399 5.70866 1.31344C6.72255 0.88288 7.81977 0.667603 9.00033 0.667603C10.167 0.667603 11.2573 0.88288 12.2712 1.31344C13.285 1.74399 14.167 2.33427 14.917 3.08427C15.667 3.83427 16.2573 4.71621 16.6878 5.7301C17.1184 6.74399 17.3337 7.83427 17.3337 9.00094C17.3337 10.1815 17.1184 11.2787 16.6878 12.2926C16.2573 13.3065 15.667 14.1884 14.917 14.9384C14.167 15.6884 13.285 16.2752 12.2712 16.6989C11.2573 17.1225 10.167 17.3343 9.00033 17.3343ZM9.00033 16.0843C11.0142 16.0843 12.6982 15.4072 14.0524 14.053C15.4066 12.6989 16.0837 11.0148 16.0837 9.00094C16.0837 6.98705 15.4066 5.30302 14.0524 3.94885C12.6982 2.59469 11.0142 1.9176 9.00033 1.9176C6.98644 1.9176 5.30241 2.59469 3.94824 3.94885C2.59408 5.30302 1.91699 6.98705 1.91699 9.00094C1.91699 11.0148 2.59408 12.6989 3.94824 14.053C5.30241 15.4072 6.98644 16.0843 9.00033 16.0843Z" fill="#06837A"></path></svg></div><div ><p class="slate-p " >Widgets can be chained together, meaning that you can create an Onboarding widget that once it ends redirects the newly created user to an Operation widget, and since the Onboarding widget instantly ends if User already exists you can use the same chain of widgets even for existing Users and they will all be redirected to an Operation widget.</p></div></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h2 class="slate-h2 " >Onboarding Widget</h2><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >For details about the onboarding process read <a href="6781fca833b3c89b3beb049f/67849f5933b3c89b3bf42608" target="">The Onboarding Process</a> first.</p></div></div><p class="slate-p " >The onboarding widget guides the users through the whole onboarding process, from the creation of the initial user, the uploading of the required documentation and data to comply with the KYC requirements, and the validation of the user&apos;s identity.</p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/3650c499-6827-4cb2-840f-167c3b9d4a5b.jpg" style="
              width:612px;
	            height:237px;
	            aspect-ratio:612 / 237"
         /></div><div class="slate-hr"><hr contenteditable="false" class="slate-HrElement-hr"/></div><h2 class="slate-h2 " >Operation Widget</h2><p class="slate-p " >The operation widget runs as soon as the user is redirected to it, based on the initial configuration it will perform the required steps of obtaining and locking a price, validating all compliance requirements, setting up all automatic rules and then, based on the configuration, either immediately perform the operation against debt or present the user with a screen indicating where and how much to send funds in order to continue the operation. In the latter scenario once a deposit is detected it will perform the operation using the funds it received.</p><div style="text-align:left"><img src="https://theneo-prod-public.s3.us-east-1.amazonaws.com/8db922a3-b204-4c05-872c-442b0a00c247.png" style="
              width:612px;
	            height:366px;
	            aspect-ratio:612 / 366"
         /></div><p class="slate-p " ></p>

The flow of a widget consists of 3 simple steps:

The onboarding widget guides the users through the whole onboarding process, from the creation of the initial user, the uploading of the required documentation and data to comply with the KYC requirements, and the validation of the user's identity.

The operation widget runs as soon as the user is redirected to it, based on the initial configuration it will perform the required steps of obtaining and locking a price, validating all compliance requirements, setting up all automatic rules and then, based on the configuration, either immediately perform the operation against debt or present the user with a screen indicating where and how much to send funds in order to continue the operation. In the latter scenario once a deposit is detected it will perform the operation using the funds it received.

<p class="slate-p " >Our compliance system ensures that all individuals using our platform adhere to the applicable legal requirements of the country in which they operate. This gives your company the confidence that all regulations are being followed and that no fraudulent or illegal activity is taking place through your environment.</p><p class="slate-p " >To reinforce this, we integrate with robust third-party compliance services to review every operation, including deposits and withdrawals across all supported networks—whether blockchain-based or traditional financial rails.</p><h2 class="slate-h2 " ></h2><p class="slate-p " ></p>

Our compliance system ensures that all individuals using our platform adhere to the applicable legal requirements of the country in which they operate. This gives your company the confidence that all regulations are being followed and that no fraudulent or illegal activity is taking place through your environment.

To reinforce this, we integrate with robust third-party compliance services to review every operation, including deposits and withdrawals across all supported networks—whether blockchain-based or traditional financial rails.

<p class="slate-p " >This section centralizes all information related to a person&apos;s regulatory compliance. It includes:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">Operating limits: outlines the monthly and annual limits defined by the system for each user, including current usage and last update date.</div></li><li class="slate-li " ><div style="position:relative">Source of funds documentation: lists the documents submitted by the person, along with their status (pending, approved, rejected).</div></li></ul><p class="slate-p " ></p>

This section centralizes all information related to a person's regulatory compliance. It includes:

<p class="slate-p " ><div style="width:100%;
	min-width:100%;" class="callout-widget" data-type=info ><div class="callout-icon"><svg width="20" height="20" viewBox="0 0 20 20" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M10.0628 14.1676C10.2434 14.1676 10.3927 14.1086 10.5107 13.9905C10.6288 13.8725 10.6878 13.7232 10.6878 13.5426V9.77177C10.6878 9.6051 10.6253 9.46274 10.5003 9.34469C10.3753 9.22663 10.2295 9.1676 10.0628 9.1676C9.88227 9.1676 9.73296 9.22663 9.61491 9.34469C9.49685 9.46274 9.43783 9.61205 9.43783 9.7926V13.5634C9.43783 13.7301 9.50033 13.8725 9.62533 13.9905C9.75033 14.1086 9.89616 14.1676 10.0628 14.1676ZM10.0003 7.62594C10.1948 7.62594 10.358 7.56344 10.4899 7.43844C10.6219 7.31344 10.6878 7.15371 10.6878 6.95927C10.6878 6.76482 10.6219 6.59816 10.4899 6.45927C10.358 6.32038 10.1948 6.25094 10.0003 6.25094C9.80588 6.25094 9.64269 6.32038 9.51074 6.45927C9.3788 6.59816 9.31283 6.76482 9.31283 6.95927C9.31283 7.15371 9.3788 7.31344 9.51074 7.43844C9.64269 7.56344 9.80588 7.62594 10.0003 7.62594ZM10.0003 18.3343C8.81977 18.3343 7.72255 18.1225 6.70866 17.6989C5.69477 17.2752 4.81283 16.6884 4.06283 15.9384C3.31283 15.1884 2.72602 14.3065 2.30241 13.2926C1.8788 12.2787 1.66699 11.1815 1.66699 10.0009C1.66699 8.83427 1.8788 7.74399 2.30241 6.7301C2.72602 5.71621 3.31283 4.83427 4.06283 4.08427C4.81283 3.33427 5.69477 2.74399 6.70866 2.31344C7.72255 1.88288 8.81977 1.6676 10.0003 1.6676C11.167 1.6676 12.2573 1.88288 13.2712 2.31344C14.285 2.74399 15.167 3.33427 15.917 4.08427C16.667 4.83427 17.2573 5.71621 17.6878 6.7301C18.1184 7.74399 18.3337 8.83427 18.3337 10.0009C18.3337 11.1815 18.1184 12.2787 17.6878 13.2926C17.2573 14.3065 16.667 15.1884 15.917 15.9384C15.167 16.6884 14.285 17.2752 13.2712 17.6989C12.2573 18.1225 11.167 18.3343 10.0003 18.3343ZM10.0003 17.0843C11.9448 17.0843 13.6114 16.3898 15.0003 15.0009C16.3892 13.612 17.0837 11.9454 17.0837 10.0009C17.0837 8.05649 16.3892 6.38982 15.0003 5.00094C13.6114 3.61205 11.9448 2.9176 10.0003 2.9176C8.05588 2.9176 6.38921 3.61205 5.00033 5.00094C3.61144 6.38982 2.91699 8.05649 2.91699 10.0009C2.91699 11.9454 3.61144 13.612 5.00033 15.0009C6.38921 16.3898 8.05588 17.0843 10.0003 17.0843Z" fill="#3960B4"></path></svg></div><div ><p class="slate-p " >Read <a href="6781fca833b3c89b3beb049f/67849f5933b3c89b3bf42608" target="">Onboarding Users</a> section for more information about how the User entity is created and the onboarding tasks required to make the User active.</p></div></div></p><p class="slate-p " >After the onboarding process has been started, the user entity represents the account of that individual for your company. The same individual cannot have more than one user per company, although it is possible for the same individual to have more than one user under different companies, in which case it will share the same operation limits across all companies (Read <a href="6782033812bd360b8b5ee27f/67849ec1d45e47dc08506607" target="">People, not Users</a> for more information).</p><p class="slate-p " ></p><h3 class="slate-h3 " >Interface</h3><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">TypeScript</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-typescript keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">interface IUser {
    // The id of the user, a 24 hex string.
    id: string

    // The number id of the user, a positive integer.
    numberId: string

    // Company defined id for the user.
    externalId?: string

    // Session id associated with the user.
    sessionId?: string

    // Email address of the user
    email: string

    // The current status of the user.
    status: USER_STATUS

    // The type of user, only INDIVIDUAL for now but support for companies as users is in development.
    type: USER_TYPE

    // This is the exchange the user will operate in.
    exchange: EXCHANGE

    // Banking information of the user
    banking: {
        // Accounts associated with the user.
        accounts: IBankAccount[]
    }

    // Information about the associated crypto deposit addresses for this user.
    addresses: {
        // A transfer to a deposit address indicates the value of the transfer belongs to this user
        depositAddresses: {
            [network: string]: string
        }

        // A transfer from a known address to our shared deposit addresses indicates the transfer belongs to this user.
        knownAddresses: string[]
    }

    // The id to the corresponding Fee Info this user is bound by, if undefined then it would be the default main Fee Info.
    feeInfoId?: string

    // This property holds a summary of all the onboarding tasks the user has taken as well as their status.
    onboarding: IUserOnboarding

    // Time the user was created as an ISO 8601 Date String.
    creationTime: string

    // Time the user was last updated at as an ISO 8601 Date String.
    updatedAt: string
}</div></div></code></pre></div><p class="slate-p " ></p><h4 class="slate-h4 " >Bank Account Interface</h4><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">TypeScript</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-typescript keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">interface IBankAccount {
    cbu: string
    currency: FIAT_ASSETS
    description: string
}</div></div></code></pre></div><p class="slate-p " ></p><h4 class="slate-h4 " >User Onboarding Interface</h4><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">TypeScript</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-typescript keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">interface IUserOnboarding {
    // Email validation entails sending a confirmation link to the user email and having the user click on that link. Usually not required.
    emailValidation: IOnboardingTaskInfo

    // This task entails providing us with a valid legal ID number for the corresponding exchange the user is in (for example CUIT/CUIL in Argentina). Always required.
    identityDeclaration: IOnboardingTaskInfo

    // This task entails defining all the basic personal data we are mandated to collect from the user, in some cases this task is automatically completed during identityDeclaration task. Usually required.
    basicPersonalDataDefinition: IOnboardingTaskInfo

    // This task entails defining the user work condition and the type of work they do. Usually not required.
    workDefinition: IOnboardingTaskInfo

    // This task entails uploading images of the previously declared legal ID which will then be verified by our compliance systems. Usually required.
    identityValidation: IOnboardingTaskInfo

    // This task entails having the user read and accept the Terms and Conditions. Usually required.
    tycAcceptance: IOnboardingTaskInfo

    // This task entails having the user declare their political constraints (things like UIF/PEP/FATCA etc), which will then be verified by our compliance systems. Usually required.
    politicalConstraintsValidation: IOnboardingTaskInfo

    // This task entails checking against databases of known terrorists as well as other security databases to ensure this individual is not blacklisted. Usually required.
    securityValidation: IOnboardingTaskInfo

    // This task entails uploading images of the face of the user. Usually not required.
    selfieValidation: IOnboardingTaskInfo

    // This task can be set to required after the politicalConstraintsValidation task. It entails uploading the corresponding UIF documentation. Usually not required.
    uifDocumentationValidation: IOnboardingTaskInfo

    // This task can be set to required after the politicalConstraintsValidation task. It entails uploading the corresponding PEP documentation. Usually not required.
    pepDocumentationValidation: IOnboardingTaskInfo

    // This task entails providing and validating a phone number. Usually not required.
    phoneNumberValidation: IOnboardingTaskInfo
}

interface IOnboardingTaskInfo {
    // If true then this user requires this task to be completed in order to continue operating, if false then it is not required for this user.
    required: boolean

    // The status of this task.
    status: ONBOARDING_TASK_STATUS

    // If task was rejected, here a message will appear explaining the reason for the rejection.
    rejectionReason?: string
}</div></div></code></pre></div><p class="slate-p " ></p><h3 class="slate-h3 " >Possible Statuses</h3><p class="slate-p " >A user can have multiple statuses, these are:</p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:211px;">Title</div><div style="width:0px;">Description</div></div><colgroup ><col style="width:211px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Status</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Meaning</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >ONBOARDING</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Means the user has not completed the minimal onboarding requirements.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >ACTIVE</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Means the user has completed enough of the onboarding to be able to perform at least one operation. They might still need to perform other tasks in order to unlock other features.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >INACTIVE</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Means the user was deleted or made inactive.</p></td></div></tr></tbody></table></div><h3 class="slate-h3 " >Example</h3><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">{
    &quot;id&quot;: &quot;6762a062183af03b822f7a71&quot;,
    &quot;numberId&quot;: &quot;10001&quot;,
    &quot;externalId&quot;: &quot;example-external-id-1&quot;,
    &quot;sessionId&quot;: &quot;example-session-id-1&quot;,
    &quot;email&quot;: &quot;example@email.com&quot;,
    &quot;status&quot;: &quot;ACTIVE&quot;,
    &quot;type&quot;: &quot;INDIVIDUAL&quot;,
    &quot;exchange&quot;: &quot;ARGENTINA&quot;,
    &quot;banking&quot;: {
        &quot;accounts&quot;: [
            {
                &quot;cbu&quot;: &quot;999999999999999&quot;,
                &quot;currency&quot;: &quot;ARS&quot;,
                &quot;description&quot;: &quot;Supervielle&quot;
            }
        ]
    },
    &quot;addresses&quot;: {
        &quot;depositAddresses&quot;: {
            &quot;BINANCE&quot;: &quot;0xaA7B65Cc73500b722FACb0722b4D3AEafE60eB68&quot;,
            &quot;ETHEREUM&quot;: &quot;0xaA7B65Cc73500b722FACb0722b4D3AEafE60eB68&quot;,
            &quot;ARBITRUM&quot;: &quot;0xaA7B65Cc73500b722FACb0722b4D3AEafE60eB68&quot;,
            &quot;TERRA&quot;: &quot;terra1jun4lrhyyx0jp3f0z2d34p7vrnh2zvvm09p8xq&quot;,
            &quot;TERRA2&quot;: &quot;terra1jun4lrhyyx0jp3f0z2d34p7vrnh2zvvm09p8xq&quot;,
            &quot;POLYGON&quot;: &quot;0xaA7B65Cc73500b722FACb0722b4D3AEafE60eB68&quot;,
            &quot;BASE&quot;: &quot;0xaA7B65Cc73500b722FACb0722b4D3AEafE60eB68&quot;,
            &quot;ROOTSTOCK&quot;: &quot;0xaA7B65Cc73500b722FACb0722b4D3AEafE60eB68&quot;,
            &quot;OPTIMISM&quot;: &quot;0xaA7B65Cc73500b722FACb0722b4D3AEafE60eB68&quot;,
            &quot;WORLDCHAIN&quot;: &quot;0xaA7B65Cc73500b722FACb0722b4D3AEafE60eB68&quot;
        },
        &quot;knownAddresses&quot;: []
    },
    &quot;feeInfoId&quot;: &quot;678c5562b709beffdb4e37ba&quot;,
    &quot;onboarding&quot;: {
        &quot;emailValidation&quot;: {
            &quot;required&quot;: false,
            &quot;status&quot;: &quot;NOT_DONE&quot;
        },
        &quot;identityDeclaration&quot;: {
            &quot;required&quot;: true,
            &quot;status&quot;: &quot;COMPLETED&quot;
        },
        &quot;basicPersonalDataDefinition&quot;: {
            &quot;required&quot;: true,
            &quot;status&quot;: &quot;COMPLETED&quot;
        },
        &quot;workDefinition&quot;: {
            &quot;required&quot;: true,
            &quot;status&quot;: &quot;COMPLETED&quot;
        },
        &quot;identityValidation&quot;: {
            &quot;required&quot;: true,
            &quot;status&quot;: &quot;COMPLETED&quot;
        },
        &quot;tycAcceptance&quot;: {
            &quot;required&quot;: true,
            &quot;status&quot;: &quot;COMPLETED&quot;
        },
        &quot;politicalConstraintsValidation&quot;: {
            &quot;required&quot;: true,
            &quot;status&quot;: &quot;COMPLETED&quot;
        },
        &quot;securityValidation&quot;: {
            &quot;required&quot;: true,
            &quot;status&quot;: &quot;COMPLETED&quot;
        },
        &quot;selfieValidation&quot;: {
            &quot;required&quot;: false,
            &quot;status&quot;: &quot;NOT_DONE&quot;
        },
        &quot;uifDocumentationValidation&quot;: {
            &quot;required&quot;: false,
            &quot;status&quot;: &quot;NOT_DONE&quot;
        },
        &quot;pepDocumentationValidation&quot;: {
            &quot;required&quot;: false,
            &quot;status&quot;: &quot;NOT_DONE&quot;
        },
        &quot;phoneNumberValidation&quot;: {
            &quot;required&quot;: false,
            &quot;status&quot;: &quot;NOT_DONE&quot;
        }
    },
    &quot;creationTime&quot;: &quot;2024-12-13T12:26:03.792-03:00&quot;,
    &quot;updatedAt&quot;: &quot;2024-12-13T12:26:34.911-03:00&quot;
}</div></div></code></pre></div><p class="slate-p " ></p>

After the onboarding process has been started, the user entity represents the account of that individual for your company. The same individual cannot have more than one user per company, although it is possible for the same individual to have more than one user under different companies, in which case it will share the same operation limits across all companies (Read 

A user can have multiple statuses, these are:

<p class="slate-p " ><p class="slate-p " >Each user has an associated balance entity, where we hold its current balance. Unlike other entities it does not have IDs of its own but rather it utilizing the same IDs as the user. User balance can be locked so it cannot be used as well as unlocked, this is done through a pair of endpoints. Read <a href="678c5bb6384f82a018fc78dd" target="">Locking User Balance</a> for more information.</p></p><p class="slate-p " ></p><h3 class="slate-h3 " >Interface</h3><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">TypeScript</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-typescript keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">interface IUserBalance {
    // The id of the user, a 24 hex string.
    userId: string

    // The number id of the user, a positive integer.
    userNumberId: string

    // The company defined external id of the user.
    userExternalId?: string

    // The balance of the user is a map of asset name to decimal form amount.
    balance: {
        // For example &quot;ARS&quot;: &quot;1534.32&quot;
        [asset: string]: string
    }

    // Locked balance is balance that cannot be used for any reason, balance can be locked or unlocked as required.
    lockedBalance: {
        // For example &quot;ARS&quot;: &quot;1534.32&quot;
        [asset: string]: string
    }

    // The time of the creation of the entity as an ISO 8601 Date String.
    creationTime: string

    // The time the entity was last updated at as an ISO 8601 Date String.
    updatedAt: string
}</div></div></code></pre></div><h3 class="slate-h3 " >Example</h3><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">{
    &quot;userId&quot;: &quot;6762a062183af03b822f7a71&quot;,
    &quot;userNumberId&quot;: &quot;10001&quot;,
    &quot;userExternalId&quot;: &quot;example-external-id-1&quot;,
    &quot;balance&quot;: {
        &quot;ARS&quot;: &quot;10000.00&quot;,
        &quot;USD&quot;: &quot;200.00&quot;,
        &quot;USDT&quot;: &quot;25.123456789012345678&quot;
    },
    &quot;lockedBalance&quot;: {
        &quot;USD&quot;: &quot;15.25&quot;
    },
    &quot;creationTime&quot;: &quot;2024-12-13T12:22:54.290-03:00&quot;,
    &quot;updatedAt&quot;: &quot;2024-12-13T12:22:54.290-03:00&quot;
}</div></div></code></pre></div><p class="slate-p " ></p>

<p class="slate-p " ><p class="slate-p " >A deposit entity is created automatically whenever funds arrive to one of our system addresses, through any of our supported networks. Read <a href="6782033812bd360b8b5ee27f/678c5e83384f82a018fc7c79" target="">Networks</a> section for more information.</p></p><h3 class="slate-h3 " >Interface</h3><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">TypeScript</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-typescript keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">interface IDeposit {
    // The id of the deposit, a 24 hex string.
    id: string

    // The number id of the deposit, a positive integer.
    numberId: string

    // An optional id defined by your company either through our automatization systems or manually after deposit was created.
    externalId?: string

    // Session id associated with the deposit.
    sessionId?: string

    // The id of the user the deposit corresponds to, a 24 hex string.
    userId: string

    // The number id of the user the deposit corresponds to, a positive integer.
    userNumberId: string

    // The external id of the user, as defined by the company.
    userExternalId?: string

    // The legalId of the user
    userLegalId?: string

    // The asset being depositted.
    asset: string

    // The decimal amount being depositted.
    amount: string

    // The address from which the funds were sent.
    source: string

    // The network through which it is being sent.
    network: NETWORKS

    // The id inside the network to identify the transaction.
    networkId: string

    // The time the entity was created.
    creationTime: string

    // The time the entity was last updated.
    updatedAt: string
}</div></div></code></pre></div><h3 class="slate-h3 " >Example</h3><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">{
    &quot;id&quot;: &quot;67613eb255ae7a04e6f9679e&quot;,
    &quot;numberId&quot;: &quot;100001&quot;,
    &quot;externalId&quot;: &quot;example-external-id-1&quot;,
    &quot;sessionId&quot;: &quot;example-session-id-1&quot;,
    &quot;userId&quot;: &quot;6762a062183af03b822f7a71&quot;,
    &quot;userNumberId&quot;: &quot;10001&quot;,
    &quot;userExternalId&quot;: &quot;example-external-id-1&quot;,
    &quot;asset&quot;: &quot;USDT&quot;,
    &quot;amount&quot;: &quot;15385.3&quot;,
    &quot;source&quot;: &quot;0x93e854d2507de1c9d9c278c0d706abe25e86ff2c&quot;,
    &quot;network&quot;: &quot;BINANCE&quot;,
    &quot;networkId&quot;: &quot;0x57851953a0592dce779d286e7a6053d82a3a8193a6e7b312246eb016b60c59db&quot;,
    &quot;creationTime&quot;: &quot;2024-12-13T12:22:54.290-03:00&quot;,
    &quot;updatedAt&quot;: &quot;2024-12-13T12:22:54.290-03:00&quot;
}</div></div></code></pre></div><p class="slate-p " ></p>

<p class="slate-p " ><p class="slate-p " >A withdraw consists of taking funds out of our system and sending them to an external address through a certain external network. These networks can be either blockchains or banking systems.</p></p><h3 class="slate-h3 " >Interface</h3><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">TypeScript</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-typescript keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">interface IWithdraw {
    // The id of the withdraw, a 24 hex string.
    id: string

    // The number id of the withdraw, a positive integer.
    numberId: string

    // An optional id defined by your company at the time of the creation of the withdraw.
    externalId?: string

    // Session id associated with the withdraw.
    sessionId?: string

    // The id of the user making the withdraw, a 24 hex string.
    userId: string

    // The number id of the user making the withdraw, a positive integer.
    userNumberId: string

    // The external id of the user, as defined by the company.
    userExternalId?: string

    // The legal id of the user
    userLegalId?: string

    // The asset being withdrawn.
    asset: string

    // The decimal amount being withdrawn.
    amount: string

    // The address where te funds are being sent to.
    destination: string

    // The network through which it is being sent.
    network: NETWORKS

    // The id inside the network to identify the transaction, undefined at first but added as soon as it is defined by the network.
    networkId?: string

    // The status of the transaction.
    status: WITHDRAW_STATUS

    // Present if status is CANCELLED, explains the reason for the cancellation
    statusMessage?: string

    // The time the entity was created.
    creationTime: string

    // The time the entity was last updated.
    updatedAt: string
}</div></div></code></pre></div><p class="slate-p " ></p><h3 class="slate-h3 " >Possible Statuses</h3><p class="slate-p " >A withdraw can have multiple statuses, these are:</p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:258px;">Title</div><div style="width:0px;">Description</div></div><colgroup ><col style="width:258px"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Status</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Meaning</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >PENDING</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The user passed all compliance checks and had enough funds to make the withdraw, the withdraw entity was created and a request was made to the corresponding network to send the funds.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >EXECUTED</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The withdraw was confirmed succesful by the network and it is safe to assume the destination has received the funds correctly.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >CANCELLED</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The withdraw was cancelled and the used funds were refunded, this is a final status and a new withdraw should be attempted after resolving the reason for the cancellation.</p></td></div></tr></tbody></table></div><h3 class="slate-h3 " >Example with success</h3><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">{
    &quot;id&quot;: &quot;67613eb255ae7a04e6f9679e&quot;,
    &quot;numberId&quot;: &quot;100001&quot;,
    &quot;externalId&quot;: &quot;example-external-id-1&quot;,
    &quot;sessionId&quot;: &quot;example-session-id-1&quot;,
    &quot;userId&quot;: &quot;6762a062183af03b822f7a71&quot;,
    &quot;userNumberId&quot;: &quot;10001&quot;,
    &quot;userExternalId&quot;: &quot;example-external-id-1&quot;,
    &quot;asset&quot;: &quot;USDT&quot;,
    &quot;amount&quot;: &quot;15385.3&quot;,
    &quot;destination&quot;: &quot;0x93e854d2507de1c9d9c278c0d706abe25e86ff2c&quot;,
    &quot;network&quot;: &quot;BINANCE&quot;,
    &quot;networkId&quot;: &quot;0x57851953a0592dce779d286e7a6053d82a3a8193a6e7b312246eb016b60c59db&quot;,
    &quot;status&quot;: &quot;EXECUTED&quot;,
    &quot;creationTime&quot;: &quot;2024-12-13T12:22:54.290-03:00&quot;,
    &quot;updatedAt&quot;: &quot;2024-12-13T12:22:54.290-03:00&quot;
}
</div></div></code></pre></div><p class="slate-p " ></p><p class="slate-p " ></p><h3 class="slate-h3 " >Example with error</h3><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">{
     &quot;id&quot;: &quot;67f5dd745666ae4bc50acbc7&quot;,
     &quot;numberId&quot;: &quot;100003823&quot;,
     &quot;network&quot;: &quot;BANKTRANSFER&quot;,
     &quot;userId&quot;: &quot;67efb891d88082731ebccbcf&quot;,
     &quot;userNumberId&quot;: &quot;100007516&quot;,
     &quot;userLegalId&quot;: &quot;20297585240&quot;,
     &quot;status&quot;: &quot;CANCELLED&quot;,
     &quot;statusMessage&quot;: &quot;D1: Document number does not match account&quot;,
     &quot;asset&quot;: &quot;ARS&quot;,
     &quot;amount&quot;: &quot;2.00&quot;,
     &quot;destination&quot;: &quot;999999999999995&quot;,
     &quot;creationTime&quot;: &quot;2025-04-08T23:37:40.694-03:00&quot;,
     &quot;updatedAt&quot;: &quot;2025-04-08T23:37:40.887-03:00&quot;
 }</div></div></code></pre></div><p class="slate-p " ></p><h3 class="slate-h3 " >Possible Errors</h3><p class="slate-p " >A withdrawal request may encounter various types of errors. These errors are categorized as follows:</p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div><div style="width:100px;">Description</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Error code (statusMessage prefix)</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Error description</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">G</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Generic errors</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">C</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Account-related errors (e.g., a blocked or non-existent account)</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">D</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Identity mismatch errors (e.g., account not owned by the user)</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">U</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >User-related errors</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><strong class="slate-bold">B</strong></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Bank-specific errors</p></td></div></tr></tbody></table></div><p class="slate-p " >The complete list of errors can be found below:</p><ol class="slate-ol " ><li class="slate-li " ><div style="position:relative">G1: Generic error</div></li><li class="slate-li " ><div style="position:relative">C1: Generic account error</div></li><li class="slate-li " ><div style="position:relative">C2: Provided bank does not match the account</div></li><li class="slate-li " ><div style="position:relative">C3: Non-existent account number</div></li><li class="slate-li " ><div style="position:relative">C4: Inactive or disabled account number</div></li><li class="slate-li " ><div style="position:relative">C5: Invalid account number</div></li><li class="slate-li " ><div style="position:relative">C6: Invalid account currency</div></li><li class="slate-li " ><div style="position:relative">C7: Unsupported bank</div></li><li class="slate-li " ><div style="position:relative">C8: Invalid account type for the destination bank</div></li><li class="slate-li " ><div style="position:relative">C9: Invalid account type</div></li><li class="slate-li " ><div style="position:relative">D1: Document number does not match account number</div></li><li class="slate-li " ><div style="position:relative">D2: Invalid document number</div></li><li class="slate-li " ><div style="position:relative">D3: Disabled document number</div></li><li class="slate-li " ><div style="position:relative">U1: Invalid email</div></li><li class="slate-li " ><div style="position:relative">U2: User name does not match document</div></li><li class="slate-li " ><div style="position:relative">B1: Amount does not meet the minimum requirement</div></li><li class="slate-li " ><div style="position:relative">B2: Invalid bank</div></li></ol><p class="slate-p " ></p>

A withdraw can have multiple statuses, these are:

A withdrawal request may encounter various types of errors. These errors are categorized as follows:

The complete list of errors can be found below:

<p class="slate-p " ><p class="slate-p " >An order represents an exchange of a certain amount of a given asset for an equivalent amount of a different asset. All possible trades are defined as either a buy operation or a sell operation of one asset against another asset, the second one usually being a fiat or a stable coin. For example, to obtain USDT in exchange for ARS you would perform a buy operation of USDT against ARS, and in turn, to obtain ARS in exchange for USDT you would perform a sell operation of USDT against ARS.
</p><p class="slate-p " >The minimum operation amount is <strong class="slate-bold">0.1 USD</strong>.</p><p class="slate-p " ></p></p><h3 class="slate-h3 " >Interface</h3><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">TypeScript</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-typescript keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">interface IOrder {
    // The id of the order, a 24 hex string.
    id: string

    // The number id of the order, a positive integer.
    numberId: string

    // Company defined id for the order.
    externalId?: string

    // Session id attached to the order.
    sessionId?: string

    // Id of the user performing the operation, a 24 hex string.
    userId: string

    // Number id of the user, a positive integer.
    userNumberId: string

    // Company defined external id for the user.
    userExternalId?: string

    // The exchange the order was performed in.
    exchange: EXCHANGE

    // Current status of the order.
    status: ORDER_STATUS

    // Present if status is CANCELLED, explains the reason for the cancellation.
    cancellationReason?: string

    // Type of order, usually DIRECT.
    type: ORDER_TYPE

    // Side of the order, either BUY or SELL.
    side: ORDER_SIDE

    // Asset being operated.
    asset: CRYPTO_ASSETS

    // Asset against which the operation is being made.
    against: FIAT_ASSETS | CRYPTO_ASSETS

    // Amount of the asset to be operated.
    assetAmount: string

    // Amount that has been already succesfully operated.
    filledAmount: string

    // Price at which the operation is being made.
    price: string

    // Effective price of the operation taking fees into consideration.
    effectivePrice: string

    // Reference prices to simplify conversion of assetAmount to other prices at the time of the creation of the order.
    referencePrices: IReferencePrices

    // Information regarding the fees being applied to this order.
    feeInfo: IOrderFeeInfo

    // Detailed itemized summary of the amount claimed from user balance or company debt in order to perform the operation.
    finalClaimInfo: IOrderFulfillmentInfo

    // Detailed itemized summary of the amount credited to user balance or as company credit as a result of performing the operation.
    finalCreditInfo: IOrderFulfillmentInfo

    // Time at which the order was created as an ISO 8601 Date String.
    creationTime: string

    // Time the order was last updated at as an ISO 8601 Date String.
    updatedAt: string
}</div></div></code></pre></div><p class="slate-p " ></p><h4 class="slate-h4 " >Reference Prices Interface</h4><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">TypeScript</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-typescript keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">interface IReferencePrices {
    // Price of the asset in local currency (so ARS for Argentina, CLP for Chile and so on) for the given side.
    assetLocalCurrencyPrice: string

    // Price of USDT in local currency (so ARS for Argentina, CLP for Chile and so on) for the given side.
    usdtLocalCurrencyPrice: string

    // Price of the asset in ARS for the given side. If exchange is Argentina it should be the same as assetLocalCurrencyPrice.
    assetArsPrice: string

    // Price of the asset in USD for the given side.
    assetUsdPrice: string
}</div></div></code></pre></div><p class="slate-p " ></p><h4 class="slate-h4 " >Fee info interface</h4><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">TypeScript</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-typescript keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">interface IOrderFeeInfo {
    // Multiplier for the platform fees, meaning what we charge for the use of our systems.
    platformFee: string

    // Multiplier for the company profit, meaning what the company witholds as profit from the operation.
    companyProfit: string

    // Addition of all the multipliers
    totalFee: string
}</div></div></code></pre></div><p class="slate-p " ></p><h4 class="slate-h4 " >Order Fulfillment info interface</h4><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">TypeScript</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-typescript keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">interface IOrderFulfillmentInfo {
    // The asset in which the following values are in.
    asset: string

    // Total amount after fee addition or subtraction (depending on if it&apos;s a claim or a credit).
    total: string

    // Base amount without taking fees into consideration.
    base: string

    // Total amount to be charged in fees.
    totalFees: string

    // Amount to be charged in platform fee.
    platformFee: string

    // Amount to be charged in company profit.
    companyProfit: string
}</div></div></code></pre></div><p class="slate-p " ></p><h3 class="slate-h3 " >Possible Statuses</h3><p class="slate-p " >An order can have multiple statuses, these are:</p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;min-height:initial;visibility: hidden;border:initial"><div style="width:100px;">Title</div><div style="width:100px;">Description</div></div><colgroup ><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Status</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Meaning</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >PENDING</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The order entity was created, the funds were claimed and all compliance checks were done, but the operation has yet to be done.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >COMPLETED</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The operation has been done and the resulting amount has been credited.</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >CANCELLED</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >The order was cancelled and the claimed funds were refunded. This is a final status, a new order must be made.</p></td></div></tr></tbody></table></div><h3 class="slate-h3 " >Example</h3><div class="code-block-wrapper"  style="width:100%;min-width:100%" ><div class="code-block-header">JSON</div><pre class="slate-CodeBlockElement slate-code_block"><textarea id="publishedPageCodeblock" style="display:none !important; visibility: hidden; opacity: 0; width: 1px; height: 1px;" type="hidden"> </textarea><code class="language-json keep-markup drop-tokens"><div class="slate-code_line"><div class="slate-code_line">{
    &quot;id&quot;: &quot;6762f88e065d780e5d758045&quot;,
    &quot;numberId&quot;: &quot;10001&quot;,
    &quot;externalId&quot;: &quot;example-external-id-1&quot;,
    &quot;sessionId&quot;: &quot;example-session-id-1&quot;,
    &quot;userId&quot;: &quot;6762f8c7767750522c90b55f&quot;,
    &quot;userNumberId&quot;: &quot;10001&quot;,
    &quot;userExternalId&quot;: &quot;example-external-id-1&quot;,
    &quot;exchange&quot;: &quot;ARGENTINA&quot;,
    &quot;status&quot;: &quot;COMPLETED&quot;,
    &quot;type&quot;: &quot;DIRECT&quot;,
    &quot;side&quot;: &quot;SELL&quot;,
    &quot;asset&quot;: &quot;USDT&quot;,
    &quot;against&quot;: &quot;ARS&quot;,
    &quot;assetAmount&quot;: &quot;10.00000000&quot;,
    &quot;filledAmount&quot;: &quot;10.00000000&quot;,
    &quot;price&quot;: &quot;1000.00&quot;,
    &quot;effectivePrice&quot;: &quot;998.00&quot;,
    &quot;feeInfo&quot;: {
        &quot;platformFee&quot;: &quot;0.001&quot;,
        &quot;companyProfit&quot;: &quot;0.001&quot;,
        &quot;totalFee&quot;: &quot;0.002&quot;
    },
    &quot;finalClaimInfo&quot;: {
        &quot;asset&quot;: &quot;USDT&quot;,
        &quot;total&quot;: &quot;10.00000000&quot;,
        &quot;base&quot;: &quot;10.00000000&quot;,
        &quot;totalFees&quot;: &quot;0.00&quot;,
        &quot;platformFee&quot;: &quot;0.00&quot;,
        &quot;companyProfit&quot;: &quot;0.00&quot;
    },
    &quot;finalCreditInfo&quot;: {
        &quot;asset&quot;: &quot;ARS&quot;,
        &quot;total&quot;: &quot;9980.00&quot;,
        &quot;base&quot;: &quot;10000.00&quot;,
        &quot;totalFees&quot;: &quot;20.00&quot;,
        &quot;platformFee&quot;: &quot;10.00&quot;,
        &quot;companyProfit&quot;: &quot;10.00&quot;
    },
    &quot;creationTime&quot;: &quot;2024-12-13T12:22:54.290-03:00&quot;,
    &quot;updatedAt&quot;: &quot;2024-12-13T12:22:54.290-03:00&quot;
}
</div></div></code></pre></div><p class="slate-p " ></p>

An order can have multiple statuses, these are:

Types of Synthetic (and their ISyntheticDetails interface)

The synthetic type determines the stages, the order of those stages and some internal logic for the synthetic to achieve a certain flow. It also determines the look of the ISyntheticDetails interface. The available synthetic types are:

Stages (and their ISyntheticStage interface)

Stages represent a given action that the synthetic will take once it is reached, and the details of said action are determined through the synthetic stage info interface, which will depend on the type of stage since each action requires their unique configuration. They all share a common part which is as follows but each stage will extend the interface to add more information.

A synthetic can have multiple statuses, these are:

<p class="slate-p " ><p class="slate-p " >At continuation we list all the endpoints we provide to query common entities:</p></p>

<p class="slate-p " ><p class="slate-p " >At continuation a list of all the available stats endpoints relating to accounting:</p></p>

<p class="slate-p " ><p class="slate-p " >At continuation a list of all the available stats endpoints relating to onboarding:</p></p>

<p class="slate-p " ><p class="slate-p " >At continuation a list of all the available stats endpoints relating to users and their balances:</p></p><p class="slate-p " ></p>

<p class="slate-p " >All exchange rates provided by the API are real-time and reflect the current market conditions. You can fetch the latest prices at any moment using the corresponding endpoint. Before executing a transaction, you must <a href="6781feaa12bd360b8b5ed9ed/6781fee912bd360b8b5eda2e/67820667d45e47dc08476201" target="">lock the price</a> to guarantee the rate. Prices may fluctuate rapidly due to market volatility, so operations must be based on a previously locked price to ensure consistency and avoid mismatches.</p><div class="slate-div"></div><p class="slate-p " ></p>

All exchange rates provided by the API are real-time and reflect the current market conditions. You can fetch the latest prices at any moment using the corresponding endpoint. Before executing a transaction, you must 

 to guarantee the rate. Prices may fluctuate rapidly due to market volatility, so operations must be based on a previously locked price to ensure consistency and avoid mismatches.

<p class="slate-p " >QR payments start by scanning a QR code. You should then utilize our endpoints to decode the information contained in that QR code and lock in a temporary exchange rate for the operation.</p><p class="slate-p " >After that, you must create a <a href="6781feaa12bd360b8b5ed9ed/6789d9c433b3c89b3bb75a40/679b3a3e5b93c87c37486a9c" target="">synthetic payment</a> based on that locked-in quote.</p><p class="slate-p " ></p>

QR payments start by scanning a QR code. You should then utilize our endpoints to decode the information contained in that QR code and lock in a temporary exchange rate for the operation.

<p class="slate-p " >This endpoint allows you to pre-lock the withdrawal cost for one or more blockchain networks before executing the actual transfer.
 It returns a unique <code class="slate-code">withdrawLockCode</code> for each network, along with the estimated fee and expiration time.  To proceed with the withdrawal using the locked fee, you must include the <code class="slate-code">withdrawLockCode</code> field in your request to the <code class="slate-code">withdraw</code> endpoint.</p><p class="slate-p " ></p>

This endpoint allows you to pre-lock the withdrawal cost for one or more blockchain networks before executing the actual transfer.
 It returns a unique 

 for each network, along with the estimated fee and expiration time.  To proceed with the withdrawal using the locked fee, you must include the 

<p class="slate-p " ><p class="slate-p " >Locking the balance of an user is a special action that ensures the balance will not be used for any reason until manually unlocked.</p></p><p class="slate-p " ></p>

<p class="slate-p " ><p class="slate-p " >At continuation we will details the endpoints relating to your company accounting, for more information read the <a href="6781fc80d45e47dc0847525c/6781ffe812bd360b8b5edbd5" target="">Accounting</a> section.</p></p><p class="slate-p " ></p>

<p class="slate-p " >This section lists all possible enum values used across our API endpoints. It serves as a central reference to improve visibility and ensure consistent integration.</p>

This section lists all possible enum values used across our API endpoints. It serves as a central reference to improve visibility and ensure consistent integration.

<p class="slate-p " >In our sandbox environment, you can test all the flows end-to-end. If there’s any type of test you’d like to conduct that isn’t currently supported by the resources we provide, feel free to reach out — we’re happy to help and can enable any additional flows you need.</p><p class="slate-p " ></p><h4 class="slate-h4 " >Crypto withdrawals</h4><p class="slate-p " >We provide a <a href="https://faucet.manteca.dev" target="">faucet</a> where you can obtain test cryptocurrencies. Below is a table with all the supported token contracts.
</p><div class="table-container" style="width:100%;
  min-width:100%;"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:100px;">Chain</div><div style="width:100px;">Ass</div><div style="width:100px;">Contract addre</div></div><colgroup ><col style="width:initial"><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >BNB Testnet</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >USDT</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >0x3eC7DA586A34589157e0B3AFA5F9eFADa51f36ec</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Polygon Amoy</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >USDT</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >0x8431eBc62F7B08af1bBf80eE7c85364ffc24ae24</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >ETH Sepolia</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >USDT</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >0x33623435D98fD040DBd382B2076C638C45BfEa6b</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Optimism Sepolia</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >USDC</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >0x177AAE8822048B9dD840C9816CD0e9654924c261</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Worldchain Sepolia</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >USDC</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >0x7b66f92D421C8c9Ea12F328d6335e08590AaF4D4</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Arbitrum Sepolia</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >USDC</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >0x8431ebc62f7b08af1bbf80ee7c85364ffc24ae24</p></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Base Sepolia</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >USDC</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >0x8431eBc62F7B08af1bBf80eE7c85364ffc24ae2</p></td></div></tr></tbody></table></div><h4 class="slate-h4 " >Fiat withdrawals</h4><p class="slate-p " >Any fiat withdrawal may either succeed or fail randomly, simulating real-world scenarios.
</p><h4 class="slate-h4 " >QR payments</h4><p class="slate-p " >You can use the following sample QR codes to test different QR payment scenarios. Keep in mind the following rules:</p><ul class="slate-ul " ><li class="slate-li " ><div style="position:relative">If the QR code contains the word qr3, it will be considered a valid QR for Argentina.</div></li><li class="slate-li " ><div style="position:relative">If it contains pix, it will be considered a valid QR for Brazil.</div></li><li class="slate-li " ><div style="position:relative">If it also contains manualamount, the amount sent in the amount field will be used — meaning it will behave as a static QR.</div></li><li class="slate-li " ><div style="position:relative">If not, it will be treated as a dynamic QR.</div></li><li class="slate-li " ><div style="position:relative">If destination includes “fail” word, the payment will fail.</div></li><li class="slate-li " ><div style="position:relative">If the QR code is valid and real, Sandbox will return the actual information associated with it.</div></li></ul><p class="slate-p " >You can use the following sample QR codes to test different QR payment scenarios:</p><div class="table-container" style="width:100%;min-width:100%"><table class="slate-table" style="min-width:100%"><div class="published-table-header" style="width:100%;min-width:100%;"><div style="width:0px;">Country</div><div style="width:259px;">Type</div><div style="width:0px;">String</div><div style="width:0px;">Image</div></div><colgroup ><col style="width:initial"><col style="width:259px"><col style="width:initial"><col style="width:initial"></colgroup><tbody class="slate-TableElement-tbody"><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Brazil</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Static</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >pixmanualamount</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><div style="text-align:left"><img src="https://d24lr4zqs1tgqh.cloudfront.net/4fab1820-4cd4-4ea6-8e1b-00eebe0fed11.png" style="
              width:108px;
	            height:108px;
	            aspect-ratio:108 / 108"
         /></div></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Brazil</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Dynamic</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >pix</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p><div style="text-align:left"><img src="https://d24lr4zqs1tgqh.cloudfront.net/003c47bf-ab93-4f4f-a819-31c543cdf599.png" style="
              width:111px;
	            height:111px;
	            aspect-ratio:111 / 111"
         /></div></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Argentina</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Dynamic</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >qr3</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p><div style="text-align:left"><img src="https://d24lr4zqs1tgqh.cloudfront.net/8b6f0208-2b4a-471f-9abb-20dbcb92a875.png" style="
              width:117px;
	            height:117px;
	            aspect-ratio:117 / 117"
         /></div></td></div></tr><tr class="slate-tr " ><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " >Peru</p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:rgb(0, 0, 0)">Dynamic</span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ><span style="color:rgb(0, 0, 0)">00020101021226370002800103903022025072409211954330527520448295303604540415005802PE5917CESAR TACURI INGA6004Lima80550003ID10144suGASdIEsZFzlFh4eZ/UMQRNdpSojGNBwPiV0Punz2o=90490005GLOSA0136Happy Path Generación de QR Dinamico91230007FECVCTO01082025123192210005QUOTA01089999999963041AAA</span></p></td></div><div class="slate-TableCellElement-content"><td class="slate-td"><p class="slate-p " ></p><div style="text-align:left"><img src="https://d24lr4zqs1tgqh.cloudfront.net/c2919171-0aeb-45cb-9bda-a5f0e1289933.jpg" style="
              width:147px;
	            height:147px;
	            aspect-ratio:147 / 147"
         /></div></td></div></tr></tbody></table></div><h4 class="slate-h4 " >User onboardings</h4><p class="slate-p " >If the user&apos;s name contains the word <code class="slate-code">&quot;fail&quot;</code> (case-insensitive), the onboarding request will be rejected. This behavior is intended for testing purposes and allows you to simulate failed user onboarding scenarios.</p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p><p class="slate-p " ></p>

In our sandbox environment, you can test all the flows end-to-end. If there’s any type of test you’d like to conduct that isn’t currently supported by the resources we provide, feel free to reach out — we’re happy to help and can enable any additional flows you need.

 where you can obtain test cryptocurrencies. Below is a table with all the supported token contracts.


Chain

Contract addre

Contract address

Any fiat withdrawal may either succeed or fail randomly, simulating real-world scenarios.


You can use the following sample QR codes to test different QR payment scenarios. Keep in mind the following rules:

You can use the following sample QR codes to test different QR payment scenarios:

Country

Type

String

Image

 (case-insensitive), the onboarding request will be rejected. This behavior is intended for testing purposes and allows you to simulate failed user onboarding scenarios.

Sections