> For the complete documentation index, see [llms.txt](https://integracao.useblu.com.br/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://integracao.useblu.com.br/varejo-apis/api-conciliacao-de-credito.md).

# API Conciliação de Crédito

O objetivo principal da API de Conciliação de vendas em crédito é permitir que o varejista automatize o processo de conciliação de suas vendas realizadas em crédito na POS da Blu, evitando a necessidade de fazer essa tarefa manualmente.

Esta conciliação envolve comparar as transações de vendas realizadas com as informações reconhecidas pela Blu, garantindo que todas as transações foram processadas corretamente e que os valores correspondem aos previstos.

Vale frisar que esta API trata somente das vendas que são pagas na data de liquidação prevista, vendas que foram antecipadas devem ser consultadas na [API de Antecipações](/varejo-apis/relatorios.md). Para o caso de vendas antecipadas parcialmente a parte antecipada constará na API de Antecipações e a parte paga na data de liquidação original constará na API Conciliação de Crédito.

{% hint style="info" %}
As **APIs Liquidações** ([Antecipações](/varejo-apis/relatorios.md), [Débito](/varejo-apis/api-conciliacao-de-debito.md) e Crédito) devem ser utilizadas em conjunto para ser a visibilidade total da conciliação de vendas Blu.
{% endhint %}

### Orientações

* Os dados devem ser buscados em D-1. 
* Os dados são carregados todos os dias às 9h, a consulta deve ser feita após esse horário.
* A API registra somente as vendas feitas no **crédito**.
* É necessário um `token` para ter acesso aos dados.
* É possível consultar dados de [produção](#conciliacao-credito) ou [homologação](#conciliacao-credito-homologacao).

{% hint style="info" %}
Esse token é disponibilizado pelo time de Integração da Blu, quando solicitado pelo executivo de contas. Além dele*,* outros campos podem ser preenchidos opcionalmente no header.
{% endhint %}

### API 

**Fique atento!** para visualizar os exemplos de retornos da API, clique no botão **>** para abrir o campo de leitura

## Conciliação Crédito

<mark style="color:blue;">`GET`</mark> `https://api.blu.com.br/conciliations/credit?beginDate=AAAA-MM-DD&endDate=AAAA-MM-DD`

Esta API é responsável por retornar as liquidações referentes a vendas crédito realizadas na maquininha Blu de acordo com as datas solicitadas a partir de D-1.

**Objetivo**

Possibilitar aos varejistas validar que as vendas crédito realizadas caíram corretamente em sua conta Blu.

#### Query Parameters

| Name      | Type   | Description                                                                                             |
| --------- | ------ | ------------------------------------------------------------------------------------------------------- |
| beginDate | String | <p>Data inicial do período de busca, não podendo ser superior a D-1.<br>Formato  AAAA-MM-DD.</p><p></p> |
| endDate   | String | <p>Data final do período de busca, não podendo ser superior a D-1.<br>Formato  AAAA-MM-DD.</p>          |
| page      | String | Página a consultar (ex: 1)                                                                              |
| per\_page | String | Quantidade de registro por página (**máx**: `4000`).                                                    |

#### Headers

```
authorization: <SEU_TOKEN_AQUI>
version: 2
```

{% tabs %}
{% tab title="200: OK Retorno de sucesso" %}

```javascript
{
    "page": 1,
    "per_page": 4000,
    "itemsPerPage": 3,
    "total_items": 3,
    "has_more": false,
    "items": [
    {
        "client_id": "12345",
        "cpf_cnpj": "16967380000178",
        "client_name": "Loja Calçados Ltda.",
        "id": "xxxxxxxx",
        "transaction_category_id": "xxx",
        "released_at": "2023-01-25T03:00:00.000Z",
        "gross_value": "255.98",
        "net_value": "255.98",
        "rate_value": "0.00",
        "liquidated_installments": [
            {
                "nsu_code": "123456789123",
                "authorization_code": "xxxxxx",
                "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                "gross_value": "159.97",
                "net_value": "158.14",
                "liquidated_gross_value": "158.14",
                "liquidated_net_value": "158.14",
                "proportional_mdr": "0.00" 
            },
            {
                "nsu_code": "213456787698",
                "authorization_code": "xxxxxx",
                "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                "gross_value": "98.97",
                "net_value": "97.84",
                "liquidated_gross_value": "97.84",
                "liquidated_net_value": "97.84",
                "proportional_mdr": "0.00" 
            }
        ]
    },
    {
        "client_id": "12345",
        "cpf_cnpj": "16967380000178",
        "client_name":  "Loja Calçados Ltda.",
        "id": "xxxxxxxx",
        "transaction_category_id": "xxx",
        "released_at": "2023-01-25T03:00:00.000Z",
        "gross_value": "87.61",
        "net_value": "87.61",
        "rate_value": "0.00",
        "liquidated_installments": [
            {
                "nsu_code": "100003344556",
                "authorization_code": "xxxxxx",
                "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                "gross_value": "89.99",
                "net_value": "87.61",
                "liquidated_gross_value": "87.61",
                "liquidated_net_value": "87.61",
                "proportional_mdr": "0.00" 
            }
         ]
     }
 ]  
```

{% endtab %}

{% tab title="401: Unauthorized Validação do token" %}

```javascript
{
    "message": "Usuário não encontrado para o token informado."
}
```

{% endtab %}

{% tab title="422: Unprocessable Entity Regra da requisição (beginDate e endDate)" %}

```javascript
{
    "message": "Não é possível realizar consultas com a data maior ou igual a data de hoje."
}
```

{% endtab %}

{% tab title="415: Unsupported Media Type Formato dos parâmetros" %}

```javascript
{
    "message": "A data deve ser no formato: YYYY-MM-DD."
}
```

{% endtab %}

{% tab title="204: No Content Parâmetros não encontrados" %}

```javascript
```

{% endtab %}
{% endtabs %}

{% tabs %}
{% tab title="200: OK Retorno de sucesso" %}

```javascript
{
    "page": 1,
    "per_page": 4000,
    "itemsPerPage": 3,
    "total_items": 3,
    "has_more": false,
    "items": [
    {
        "client_id": "12345",
        "cpf_cnpj": "16967380000178",
        "client_name": "Loja Calçados Ltda.",
        "id": "xxxxxxxx",
        "transaction_category_id": "xxx",
        "released_at": "2023-01-25T03:00:00.000Z",
        "gross_value": "255.98",
        "net_value": "255.98",
        "rate_value": "0.00",
        "liquidated_installments": [
            {
                "nsu_code": "123456789123",
                "authorization_code": "xxxxxx",
                "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                "gross_value": "159.97",
                "net_value": "158.14",
                "liquidated_gross_value": "158.14",
                "liquidated_net_value": "158.14",
                "proportional_mdr": "0.00" 
            },
            {
                "nsu_code": "213456787698",
                "authorization_code": "xxxxxx",
                "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                "gross_value": "98.97",
                "net_value": "97.84",
                "liquidated_gross_value": "97.84",
                "liquidated_net_value": "97.84",
                "proportional_mdr": "0.00" 
            }
        ]
    },
    {
        "client_id": "12345",
        "cpf_cnpj": "16967380000178",
        "client_name":  "Loja Calçados Ltda.",
        "id": "xxxxxxxx",
        "transaction_category_id": "xxx",
        "released_at": "2023-01-25T03:00:00.000Z",
        "gross_value": "87.61",
        "net_value": "87.61",
        "rate_value": "0.00",
        "liquidated_installments": [
            {
                "nsu_code": "100003344556",
                "authorization_code": "xxxxxx",
                "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                "gross_value": "89.99",
                "net_value": "87.61",
                "liquidated_gross_value": "87.61",
                "liquidated_net_value": "87.61",
                "proportional_mdr": "0.00" 
            }
         ]
     }
 ]  
```

{% endtab %}

{% tab title="401: Unauthorized Validação do token" %}

```javascript
{
    "message": "Usuário não encontrado para o token informado."
}
```

{% endtab %}

{% tab title="422: Unprocessable Entity Regra da requisição (beginDate e endDate)" %}

```javascript
{
    "message": "Não é possível realizar consultas com a data maior ou igual a data de hoje."
}
```

{% endtab %}

{% tab title="415: Unsupported Media Type Formato dos parâmetros" %}

```javascript
{
    "message": "A data deve ser no formato: YYYY-MM-DD."
}
```

{% endtab %}

{% tab title="204: No Content Parâmetros não encontrados" %}

```javascript
```

{% endtab %}
{% endtabs %}

{% hint style="danger" %}
• Os parâmetros *beginDate* e *endDate* se referem a data de ocorrência da transação e devem estar ambos preenchidos. Caso nenhum deles seja especificado, a resposta retornará todos os pagamentos realizados antes à data da consulta, ou seja, **D-1**.

• Se `page` **não** for informado, será considerado **`1`** (primeira página).\
• Se `per_page` **não** for informado, será considerado **`1000`** itens por página.
{% endhint %}

O retorno desta consulta é um arquivo JSON, contendo um conjunto (Array) das transações do período informado. Abaixo vemos todos os campos que serão retornados:

{% hint style="info" %}
Os **campos da transação** se referem ao header em comum das transações da mesma bandeira. Desta forma todas as vendas de uma bandeira são agrupadas pelo header refletindo o valor somado das mesmas, conforme aparece no extrato, e os **campos da parcela** descrevem os detalhes da venda que está sendo liquidada.
{% endhint %}

<table><thead><tr><th width="292" align="center">Campos da transação</th><th align="center">Data type</th><th align="center">Descrição</th></tr></thead><tbody><tr><td align="center"><pre><code>cpf_cnpj
</code></pre></td><td align="center">String</td><td align="center">Registro que representa a empresa.</td></tr><tr><td align="center"><pre><code>client_name
</code></pre></td><td align="center">String</td><td align="center">Nome da empresa.</td></tr><tr><td align="center"><pre><code>id
</code></pre></td><td align="center">String</td><td align="center">Número identificador da transação.</td></tr><tr><td align="center"><pre><code>transaction_category_id
</code></pre></td><td align="center">String</td><td align="center">Número identificador da categoria da transação.</td></tr><tr><td align="center"><pre><code>released_at
</code></pre></td><td align="center">String</td><td align="center">Data da liquidação.</td></tr><tr><td align="center"><pre><code>gross_value
</code></pre></td><td align="center">String</td><td align="center">Valor bruto da transação.</td></tr><tr><td align="center"><pre><code>net_value
</code></pre></td><td align="center">String</td><td align="center">Valor liquido da transação.</td></tr><tr><td align="center"><pre><code>rate_value
</code></pre></td><td align="center">String</td><td align="center">Valor da taxa.</td></tr><tr><td align="center"><pre><code>liquidated_installments
</code></pre></td><td align="center">Array</td><td align="center">Lista de parcelas liquidadas.</td></tr></tbody></table>

<table><thead><tr><th width="265" align="center">Campos da parcela</th><th align="center">Data type</th><th align="center">Descrição</th></tr></thead><tbody><tr><td align="center"><pre><code>id
</code></pre></td><td align="center">String</td><td align="center">Número identificador da parcela.</td></tr><tr><td align="center"><pre><code>nsu_code
</code></pre></td><td align="center">String</td><td align="center">Código da transação  realizada via cartão.</td></tr><tr><td align="center"><pre><code>authorization_code
</code></pre></td><td align="center">String</td><td align="center">Código da transação via cartão, gerado quando aprovada.</td></tr><tr><td align="center"><pre><code>gross_value
</code></pre></td><td align="center">String</td><td align="center">Valor bruto da parcela.</td></tr><tr><td align="center"><pre><code>net_value
</code></pre></td><td align="center">String</td><td align="center">Valor líquido da parcela.</td></tr><tr><td align="center"><pre><code>liquidated_gross_value
</code></pre></td><td align="center">String</td><td align="center">Valor bruto liquidado.</td></tr><tr><td align="center"><pre><code>liquidated_net_value
</code></pre></td><td align="center">String</td><td align="center">Valor líquido liquidado.</td></tr><tr><td align="center"><code>proportional_mdr</code></td><td align="center">String</td><td align="center">Valor proporcional da taxa mdr na parcela</td></tr></tbody></table>

O retorno desta consulta é um arquivo JSON, contendo um conjunto (Array) das transações do período informado. Abaixo vemos um exemplo de retorno da API para uma liquidação crédito:

```
{
    "page": 1,
    "per_page": 4000,
    "itemsPerPage": 1,
    "total_items": 1,
    "has_more": false,
    "items": [
{
        "client_id": "xxxxx",
        "cpf_cnpj": "xxxxxxxxxxxxxxxxxxx",
        "client_name": "Razão Social",
        "id": "xxxxxxxxxxx",
        "transaction_category_id": "00000",
        "released_at": "aaaa-mm-ddT00:00:00.000Z",
        "gross_value": "00.00",
        "net_value": "00.00",
        "rate_value": "0.00",
        "liquidated_installments": [
            {
                "nsu_code": "00000000000",
                "authorization_code": "0000000",
                "id": "xxxxxxxxxxx-xxxxx-xxxxxx-xxxxxxx-xxxxxxxxxx",
                "gross_value": "00.00",
                "net_value": "00.00",
                "liquidated_gross_value": "00.00",
                "liquidated_net_value": "00.00",
                "proportional_mdr": "0.00" 
            },
            (...)
         ]
 }           
```

A API retorna todas as liquidações de venda débito realizadas no período selecionado e o conjunto de dados *liquidated\_installments* contém todas as parcelas bem como o montante que foi liquidado de cada uma delas. O campo *id* neste conjunto deve ser relacionado com o *id\_transaction* presente na API Movimento de Vendas para dar match na parcela liquidada.

O cURL para executar a consulta é o exibido abaixo, bem como a collection com todas as APIs para ser importada no Postman está em anexo na página.

```
curl --location 'https://api.blu.com.br/conciliations/credit?beginDate=AAAA-MM-DD&endDate=AAAA-MM-DD' \
--header 'authorization: XXXXXXXXXXXXXX'
--header 'version: 2'
```

## Conciliação Crédito - Homologação

A API Movimento de Vendas pode ser consultada diretamente no [ambiente de produção](#conciliacao-credito) caso já existam liquidações de vendas crédito registradas para o CNPJ cadastrado no Portal Blu. Caso ainda não existam liquidações de vendas crédito é possível realizar a consulta em homologação.

{% hint style="warning" %}
**Atenção!** Os dados retornados na API Crédito - Homologação são mockados, anonimizados e sem uso de CNPJs reais. O retorno dessa API só é positivo na data de 01/12/2025, que constará no cURL.
{% endhint %}

<mark style="color:blue;">`GET`</mark> `https://api-hlg.blu.com.br/conciliations/credit`

#### Query Parameters

| Name      | Type   | Description                                                                                             |
| --------- | ------ | ------------------------------------------------------------------------------------------------------- |
| beginDate | String | <p>Data inicial do período de busca, não podendo ser superior a D-1.<br>Formato  AAAA-MM-DD.</p><p></p> |
| endDate   | String | <p>Data final do período de busca, não podendo ser superior a D-1.<br>Formato  AAAA-MM-DD.</p>          |

#### Headers

| Name                                            | Type   | Description          |
| ----------------------------------------------- | ------ | -------------------- |
| Authorization<mark style="color:red;">\*</mark> | String | Token de homologação |

{% tabs %}
{% tab title="200: OK Retorno de sucesso" %}

```javascript
[
    {
        "client_id": "12345",
        "cpf_cnpj": "16967380000178",
        "client_name": "Loja Calçados Ltda.",
        "id": "xxxxxxxx",
        "transaction_category_id": "xxx",
        "released_at": "2023-01-25T03:00:00.000Z",
        "gross_value": "255.98",
        "net_value": "255.98",
        "rate_value": "0.00",
        "liquidated_installments": [
            {
                "nsu_code": "123456789123",
                "authorization_code": "xxxxxx",
                "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                "gross_value": "159.97",
                "net_value": "158.14",
                "liquidated_gross_value": "158.14",
                "liquidated_net_value": "158.14",
                "proportional_mdr": "0.00" 
            },
            {
                "nsu_code": "213456787698",
                "authorization_code": "xxxxxx",
                "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                "gross_value": "98.97",
                "net_value": "97.84",
                "liquidated_gross_value": "97.84",
                "liquidated_net_value": "97.84",
                "proportional_mdr": "0.00" 
            }
        ]
    },
    {
        "client_id": "12345",
        "cpf_cnpj": "16967380000178",
        "client_name":  "Loja Calçados Ltda.",
        "id": "xxxxxxxx",
        "transaction_category_id": "xxx",
        "released_at": "2023-01-25T03:00:00.000Z",
        "gross_value": "87.61",
        "net_value": "87.61",
        "rate_value": "0.00",
        "liquidated_installments": [
            {
                "nsu_code": "100003344556",
                "authorization_code": "xxxxxx",
                "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                "gross_value": "89.99",
                "net_value": "87.61",
                "liquidated_gross_value": "87.61",
                "liquidated_net_value": "87.61",
                "proportional_mdr": "0.00" 
            }
         ]
     }
 ]  
```

{% endtab %}

{% tab title="401: Unauthorized Validação do token" %}

```javascript
{
    "message": "Usuário não encontrado para o token informado."
}
```

{% endtab %}

{% tab title="422: Unprocessable Entity Regra da requisição (beginDate e endDate)" %}

```javascript
{
    "message": "Não é possível realizar consultas com a data maior ou igual a data de hoje."
}
```

{% endtab %}

{% tab title="415: Unsupported Media Type Formato dos parâmetros" %}

```javascript
{
    "message": "A data deve ser no formato: YYYY-MM-DD."
}
```

{% endtab %}

{% tab title="204: No Content Parâmetros não encontrados" %}

```javascript
```

{% endtab %}
{% endtabs %}

{% hint style="danger" %}
Os parâmetros *beginDate* e *endDate* se referem a data de ocorrência da transação e devem estar ambos preenchidos. Caso nenhum deles seja especificado, a resposta retornará todos os pagamentos realizados antes à data da consulta, ou seja, **D-1**.
{% endhint %}

O retorno desta consulta é um arquivo JSON, contendo um conjunto (Array) das transações do período informado. Abaixo vemos todos os campos que serão retornados:

<table><thead><tr><th width="292" align="center">Campos da transação</th><th align="center">Data type</th><th align="center">Descrição</th></tr></thead><tbody><tr><td align="center"><pre><code>cpf_cnpj
</code></pre></td><td align="center">String</td><td align="center">Registro que representa a empresa.</td></tr><tr><td align="center"><pre><code>client_name
</code></pre></td><td align="center">String</td><td align="center">Nome da empresa.</td></tr><tr><td align="center"><pre><code>id
</code></pre></td><td align="center">String</td><td align="center">Número identificador da transação.</td></tr><tr><td align="center"><pre><code>transaction_category_id
</code></pre></td><td align="center">String</td><td align="center">Número identificador da categoria da transação.</td></tr><tr><td align="center"><pre><code>released_at
</code></pre></td><td align="center">String</td><td align="center">Data da liquidação.</td></tr><tr><td align="center"><pre><code>gross_value
</code></pre></td><td align="center">String</td><td align="center">Valor bruto da transação.</td></tr><tr><td align="center"><pre><code>net_value
</code></pre></td><td align="center">String</td><td align="center">Valor liquido da transação.</td></tr><tr><td align="center"><pre><code>rate_value
</code></pre></td><td align="center">String</td><td align="center">Valor da taxa.</td></tr><tr><td align="center"><pre><code>liquidated_installments
</code></pre></td><td align="center">Array</td><td align="center">Lista de parcelas liquidadas.</td></tr></tbody></table>

<table><thead><tr><th width="265" align="center">Campos da parcela</th><th align="center">Data type</th><th align="center">Descrição</th></tr></thead><tbody><tr><td align="center"><pre><code>id
</code></pre></td><td align="center">String</td><td align="center">Número identificador da parcela.</td></tr><tr><td align="center"><pre><code>nsu_code
</code></pre></td><td align="center">String</td><td align="center">Código da transação  realizada via cartão.</td></tr><tr><td align="center"><pre><code>authorization_code
</code></pre></td><td align="center">String</td><td align="center">Código da transação via cartão, gerado quando aprovada.</td></tr><tr><td align="center"><pre><code>gross_value
</code></pre></td><td align="center">String</td><td align="center">Valor bruto da parcela.</td></tr><tr><td align="center"><pre><code>net_value
</code></pre></td><td align="center">String</td><td align="center">Valor líquido da parcela.</td></tr><tr><td align="center"><pre><code>liquidated_gross_value
</code></pre></td><td align="center">String</td><td align="center">Valor bruto liquidado.</td></tr><tr><td align="center"><pre><code>liquidated_net_value
</code></pre></td><td align="center">String</td><td align="center">Valor líquido liquidado.</td></tr><tr><td align="center"><code>proportional_mdr</code></td><td align="center">String</td><td align="center">Valor proporcional da taxa mdr na parcela</td></tr></tbody></table>

O cURL para executar a consulta já com a data 01/12/2025 é o exibido abaixo, bem como a collection com todas as APIs para ser importada no Postman está em anexo na página com o nome Varejo HLG - Crédito ou APIs Varejo HLG.

```
curl --location 'https://api-hlg.blu.com.br/conciliations/credit?beginDate=2025-12-01&endDate=2025-12-01' \
--header 'authorization: XXXXXXXXXXXXXXXXXXXXX' \
```

{% file src="/files/gOjLzfDvKHtKQF71xESy" %}

{% file src="/files/LsbTtnw2LbCshc5tBfsX" %}

{% file src="/files/G8GqVpTgupzNOWGQTx9A" %}

{% file src="/files/Uo9JWZkd2jUSG8SlJu2A" %}


---

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

```
GET https://integracao.useblu.com.br/varejo-apis/api-conciliacao-de-credito.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
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.