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. 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.
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.
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
GET
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
beginDate
String
Data inicial do período de busca, não podendo ser superior a D-1. Formato AAAA-MM-DD.
endDate
String
Data final do período de busca, não podendo ser superior a D-1. Formato AAAA-MM-DD.
Headers
Authorization*
String
Token de operação
[
{
"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"
}
]
}
]
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.
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:
cpf_cnpj
String
Registro que representa a empresa.
client_name
String
Nome da empresa.
id
String
Número identificador da transação.
transaction_category_id
String
Número identificador da categoria da transação.
released_at
String
Data da liquidação.
gross_value
String
Valor bruto da transação.
net_value
String
Valor liquido da transação.
rate_value
String
Valor da taxa.
liquidated_installments
Array
Lista de parcelas liquidadas.
id
String
Número identificador da parcela.
nsu_code
String
Código da transação realizada via cartão.
authorization_code
String
Código da transação via cartão, gerado quando aprovada.
gross_value
String
Valor bruto da parcela.
net_value
String
Valor líquido da parcela.
liquidated_gross_value
String
Valor bruto liquidado.
liquidated_net_value
String
Valor líquido liquidado.
proportional_mdr
String
Valor proporcional da taxa mdr na parcela
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:
{
"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'
Last updated
Was this helpful?