API de Antecipações

A API de Antecipações permite consultar as antecipações realizadas e as parcelas utilizadas em cada operação.

Na Blu, para antecipar, informa-se apenas o valor. A Blu seleciona automaticamente os recebíveis que compõem a operação. A API exibe o resultado dessa seleção com as parcelas liquidadas, valores e datas, oferecendo transparência e facilitando a conciliação.

O que entrega

Lista de antecipações no período consultado;
Detalhe das parcelas liquidadas (bruto, líquido, taxas);
Dados prontos para conciliação.

Orientações

Os dados devem ser consultados em D-1 (dia anterior).
As informações ficam disponíveis diariamente às 9h.
A API retorna somente as vendas antecipadas.
É possível consultar dados de produção ou homologação.
Em caso de antecipação parcial:
- A parte antecipada aparece nesta API.
- A parte liquidada na data original aparece na API de Conciliação de Crédito.

Para uma visão completa da conciliação, recomenda-se o uso conjunto das APIs de Liquidações: Antecipações, Débito e Crédito.

Autenticação

O acesso exige um token de autenticação, fornecido pelo time de Integração da Blu mediante solicitação ao seu executivo de contas.

Authorization: Bearer <seu_token_aqui>

Endpoints da API

[V1] Consultar Antecipações

GET https://api.blu.com.br/conciliations/anticipations/installments

Retorna uma lista de antecipações realizadas e suas respectivas parcelas liquidadas.

Query parameters:

Parâmetro

Obrigatório

Descrição

beginDate

Sim

Data inicial no formato YYYY-MM-DD

endDate

Sim

Data final no formato YYYY-MM-DD

cpfCnpj

Não

Documento do cliente (CNPJ ou CPF)

Se os parâmetros begindate e endDate não forem informados, a API retornará todos os pagamentos realizados até D-1.

Headers:

Authorization: Bearer <seu_token_aqui>

Exemplo de requisição:

curl --location --request GET 'https://api.blu.com.br/conciliations/anticipations/installments?cpfCnpj=00000000000000&beginDate=AAAA-MM-DD&endDate=AAAA-MM-DD' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXX'

Exemplo de resposta de sucesso: ✔

[
    {
        "client_id": "xxxxxx",
        "cpf_cnpj": "xxxxxxxxxxxxxx",
        "client_name": "Razão Social",
        "id": "xxxxxxxx",
        "transaction_category_id": "0000",
        "transaction_category": "Tipo de Antecipação",
        "released_at": "aaaa-mm-dd",
        "gross_value": "00.00",
        "net_value": "00.00",
        "rate_value": "00.00",
        "liquidated_installments": [
            {
                "nsu_code": "000000000000",
                "authorization_code": "000000",
                "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
                "gross_value": "00.00",
                "net_value": "00.00",
                "liquidated_gross_value": "00.00",
                "liquidated_net_value": "00.00",
                "installment_rate": "00.00",
                "proportional_mdr": "00.00" 
            },
            {
                "nsu_code": "000000000000",
                "authorization_code": "000000",
                "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                "gross_value": "00.00",
                "net_value": "00.00",
                "liquidated_gross_value": "00.00",
                "liquidated_net_value": "00.00",
                "installment_rate": "00.00",
                "proportional_mdr": "00.00" 
            },
            {
                "nsu_code": "000000000000",
                "authorization_code": "000000",
                "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
                "gross_value": "00.00",
                "net_value": "00.00",
                "liquidated_gross_value": "00.00",
                "liquidated_net_value": "00.00",
                "installment_rate": "00.00",
                "proportional_mdr": "00.00" 
            }
         ]
     }
 ]

🔗 Acesse a descrição dos campos

Exemplo de respostas de erro: ❌

// erro no formato do parâmetro

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

// erro no formato do parâmetro

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

Observações Técnicas

O retorno é sempre em formato JSON.
O campo liquidated_installments contém todas as parcelas que compuseram a antecipação.
O campo id de cada parcela deve ser relacionado com o id_transaction da API Movimento de Vendas para dar match com a parcela original.

[V2] Consultar antecipações

GET https://api.blu.com.br/conciliations/anticipations/installments

A V2 da API de Antecipações mantém o funcionamento da versão anterior, mas agora oferece paginação para consultas com grandes volumes de recebíveis.

Com esse recurso, as informações podem ser recuperadas em lotes (ex.: milhares de recebíveis em uma única antecipação), de forma organizada e eficiente, sem sobrecarregar a integração.

Headers

authorization: <SEU_TOKEN_AQUI>
version: 2

Parâmetros de Query

Parâmetro

Obrigatório

Descrição

beginDate

Não

Data inicial YYYY-MM-DD (ou enviada no header).

endDate

Não

Data final YYYY-MM-DD (ou enviada no header).

cpfCnpj

Não

Documento do cliente (CNPJ/CPF).

page

Não

Página a consultar (ex: 1)

per_page

Não

Quantidade de registro por página (máx: 4000).

Observação • Se beginDate e endDate não forem informados, a API retorna os pagamentos realizados até 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.

Exemplo de requisição

curl --location --request GET 'https://api.blu.com.br/conciliations/anticipations/installments?beginDate=2025-08-01&endDate=2025-08-25&page=1&per_page=1000' \
--header 'authorization: <SEU_TOKEN_AQUI>' \
--header 'version: 2'

Resposta de sucesso: ✔

 {
  "page": 1,
  "per_page": 1000,
  "itemsPerPage": 3,
  "total_items": 3,
  "has_more": false,
  "items": [
    {
      "client_id": "xxxxxx",
        "cpf_cnpj": "xxxxxxxxxxxxxx",
        "client_name": "Razão Social",
        "id": "xxxxxxxx",
        "transaction_category_id": "0000",
        "transaction_category": "Tipo de Antecipação",
        "released_at": "aaaa-mm-dd",
        "gross_value": "00.00",
        "net_value": "00.00",
        "rate_value": "00.00",
        "liquidated_installments": [
            {
                "nsu_code": "000000000000",
                "authorization_code": "000000",
                "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
                "gross_value": "00.00",
                "net_value": "00.00",
                "liquidated_gross_value": "00.00",
                "liquidated_net_value": "00.00",
                "installment_rate": "00.00",
                "proportional_mdr": "00.00" 
            },
            {
                "nsu_code": "000000000000",
                "authorization_code": "000000",
                "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                "gross_value": "00.00",
                "net_value": "00.00",
                "liquidated_gross_value": "00.00",
                "liquidated_net_value": "00.00",
                "installment_rate": "00.00",
                "proportional_mdr": "00.00" 
            },
            {
                "nsu_code": "000000000000",
                "authorization_code": "000000",
                "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
                "gross_value": "00.00",
                "net_value": "00.00",
                "liquidated_gross_value": "00.00",
                "liquidated_net_value": "00.00",
                "installment_rate": "00.00",
                "proportional_mdr": "00.00" 
            }
      ]
    }
  ]
}

Descrição dos campos

Campo

O que é

Observações / Exemplos

page

Número da página retornada.

Vem do parâmetro de query page (padrão: 1).

per_page

Quantidade solicitada de itens por página.

Vem do parâmetro de query per_page (ex.: 1000).

itemsPerPage

Quantidade efetivamente retornada nesta página.

Pode ser menor que per_page

total_items

Total de registros que atendem ao filtro.

has_more

Indica se existe próxima página.

items

Lista de antecipações da página atual.

🔗 Acesse a descrição dos outros campos

Respostas de erro: ❌

// erro no formato do parâmetro

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

Antecipações - Homologação

A API Antecipações pode ser consultada diretamente no ambiente de produção caso já existam antecipações para o CNPJ cadastrado no Portal Blu. Caso ainda não existam antecipações é possível realizar a consulta em homologação.

Atenção! Os dados retornados na API Antecipações - 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.

GET https://api-hlg.blu.com.br/conciliations/anticipations/installments

Headers

Name

Type

Description

token*

string

Bearer token de identificação do fornecedor

Query Parameters

Parâmetro

Obrigatório

Descrição

beginDate

Sim

Data inicial no formato YYYY-MM-DD

endDate

Sim

Data final no formato YYYY-MM-DD

Se os parâmetros begindate e endDate não forem informados, a API retornará todos os pagamentos realizados até D-1.

[
    {
        "client_id": "xxxxxx",
        "cpf_cnpj": "xxxxxxxxxxxxxx",
        "client_name": "Razão Social",
        "id": "xxxxxxxx",
        "transaction_category_id": "0000",
        "transaction_category": "Tipo de Antecipação",
        "released_at": "aaaa-mm-dd",
        "gross_value": "00.00",
        "net_value": "00.00",
        "rate_value": "00.00",
        "liquidated_installments": [
            {
                "nsu_code": "000000000000",
                "authorization_code": "000000",
                "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
                "gross_value": "00.00",
                "net_value": "00.00",
                "liquidated_gross_value": "00.00",
                "liquidated_net_value": "00.00",
                "installment_rate": "00.00",
                "proportional_mdr": "00.00" 
            },
            {
                "nsu_code": "000000000000",
                "authorization_code": "000000",
                "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                "gross_value": "00.00",
                "net_value": "00.00",
                "liquidated_gross_value": "00.00",
                "liquidated_net_value": "00.00",
                "installment_rate": "00.00",
                "proportional_mdr": "00.00" 
            },
            {
                "nsu_code": "000000000000",
                "authorization_code": "000000",
                "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxx",
                "gross_value": "00.00",
                "net_value": "00.00",
                "liquidated_gross_value": "00.00",
                "liquidated_net_value": "00.00",
                "installment_rate": "00.00",
                "proportional_mdr": "00.00" 
            }
         ]
     }
 ]

O retorno desta consulta é um arquivo JSON, contendo um conjunto (Array) das transações do período informado. Detalhes dos campos retornados podem ser vistos na página com suas descrições.

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 - Antecipações ou APIs Varejo HLG.

curl --location 'https://api-hlg.blu.com.br/conciliations/anticipations/installments?beginDate=2025-12-01&endDate=2025-12-01' \
--header 'Authorization: XXXXXXXXXXXXXXXXXXXXXXXXX' \

928B

Varejo HLG - Antecipações.postman_collection.zip

archive

Open

2KB

APIs Varejo HLG.postman_collection.zip

archive

Open

637B

Varejo - Antecipações.postman_collection.zip

archive

Open

999B

APIs Varejo.postman_collection.zip

archive

Open

PreviousAPI Movimento de Vendas Split NextDescrição dos campos da API de antecipações

Last updated 1 month ago

hashtagOrientações

hashtagAutenticação

hashtagEndpoints da API

hashtag[V1] Consultar Antecipações

hashtagQuery parameters:

hashtagHeaders:

hashtagExemplo de requisição:

hashtagExemplo de resposta de sucesso: ✔

hashtagObservações Técnicas

hashtag[V2] Consultar antecipações

hashtagHeaders

hashtagExemplo de requisição

hashtagResposta de sucesso: ✔

hashtagRespostas de erro: ❌

hashtagAntecipações - Homologação

hashtagHeaders

hashtagQuery Parameters

Orientações

Autenticação

Endpoints da API

[V1] Consultar Antecipações

Query parameters:

Headers:

Exemplo de requisição:

Exemplo de resposta de sucesso: ✔

Observações Técnicas

[V2] Consultar antecipações

Headers

Exemplo de requisição

Resposta de sucesso: ✔

Respostas de erro: ❌

Antecipações - Homologação

Headers

Query Parameters