> For the complete documentation index, see [llms.txt](https://apidocs.onekeypayments.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://apidocs.onekeypayments.com/guides/deposits/countries-specialization/brazilian-transactional-accounts.md).

# Brazilian Transactional Accounts

{% hint style="info" %}

#### This solution is designed for Brazilian regulated gambling merchants.

To comply with local regulations regarding the segregation of funds, OneKey Payments provides a solution that automatically separates user funds (liabilities) from proprietary capital (assets).

This document explains how money flows between these accounts and when you need to use the API to manage them.
{% endhint %}

### Before you start

To use the endpoints described in this guide, you must contact your account manager with your company name and CNPJ. We need to configure your specific wallet environment for regulatory compliance before you can move funds.

### Understanding your account structure

When you integrate with us, we assign two distinct accounts (or "wallets") to your merchant ID. Keeping these separate is essential for your accounting and regulatory reporting.

<table data-full-width="false"><thead><tr><th width="146.7890625"></th><th width="293.09375">Transactional Account</th><th>Propietary Account</th></tr></thead><tbody><tr><td><em><strong>What goes in</strong></em></td><td>All user deposits land here automatically.</td><td>Funds the merchant  transfer from the transactional account and top ups from external bank accounts. </td></tr><tr><td><em><strong>What comes out</strong></em></td><td>User cashouts (payouts) are paid from here first.</td><td>Fees, settlements to your external bank account, and backup funding for cashouts.</td></tr><tr><td><em><strong>Details</strong></em></td><td>These funds belong to the players (liabilities). Merchants cannot settle these funds to your external bank until they are formally recognized as revenue.</td><td>These are the merchant's finalized assets.</td></tr></tbody></table>

### When to use the API

Since deposits and payouts happen automatically, you only need to use the API for internal liquidity management.

The <mark style="color:orange;background-color:orange;">POST</mark> **`/wallet/transaction`** endpoint allows you to **move funds** between your two internal accounts.

#### &#x20;  Moving surplus profits

The transactional account is the primary source for funding player cashouts. However, as deposits accumulate, this balance will grow beyond what is needed for daily liquidity. Use this flow to transfer your excess profits to the proprietary account when you are ready to settle them to your bank, while leaving enough balance behind to cover ongoing withdrawals.

* Source: `TRANSACTIONAL`
* Destination: `PROPRIETARY`

{% tabs %}
{% tab title="Example request" %}

```json
{
  "source": "TRANSACTIONAL",
  "destination": "PROPRIETARY",
  "currency": "BRL",
  "amount": 100.00
}
```

{% endtab %}

{% tab title="Example response" %}

```json
{
  "currency": "BRL",
  "proprietary_balance": 100.00,
  "transactional_balance": 100.00
}
```

{% endtab %}
{% endtabs %}

#### &#x20;  Top-ups

If your transactional account is running low and you expect a high volume of cashouts, you can move operating capital into the transactional bucket to maintain liquidity for your users.

* Source: `PROPRIETARY`
* Destination: `TRANSACTIONAL`

{% tabs %}
{% tab title="Example request" %}

```json
{
  "source": "PROPRIETARY",
  "destination": "TRANSACTIONAL",
  "currency": "BRL",
  "amount": 100.00
}
```

{% endtab %}

{% tab title="Example response" %}

```json
{
  "currency": "BRL",
  "proprietary_balance": 100.00,
  "transactional_balance": 100.00
}
```

{% endtab %}
{% endtabs %}

> For more information please visit the API Reference <a href="/spaces/0lbPmhFPUb55BAkK3G6F/pages/MSeMxFNqXoXakq3u6psA" class="button primary" data-icon="pencil">Move funds</a>

***

### Retrieving balances

Merchants should use the <mark style="color:green;background-color:green;">GET</mark>  **`/wallet/balance`** endpoint to monitor changes in the balances. This single call returns the current standing of both your accounts. We recommend checking this periodically to decide if you need to perform movements within the accounts.

{% code title="Example response" %}

```json
{
    "balances": [
        {
            "amount": 200.00,
            "currency": "BRL",
            "type": "PROPRIETARY"
        },
        {
            "amount": 222.00,
            "currency": "BRL",
            "type": "TRANSACTIONAL"
        }
    ]
}
```

{% endcode %}

> For more information please visit the API Reference <a href="/spaces/0lbPmhFPUb55BAkK3G6F/pages/ZdA6nwMCxyJRvZhDdN5s" class="button primary" data-icon="magnifying-glass">Get balances</a>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://apidocs.onekeypayments.com/guides/deposits/countries-specialization/brazilian-transactional-accounts.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.