API Conciliação de Débito
O objetivo principal da API de Conciliação de vendas em débito é permitir que o varejista automatize o processo de conciliação de suas vendas realizadas em débito 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.
As APIs Liquidações (Antecipações, Débito e Crédito) devem ser utilizadas em conjunto para ser a visibilidade total da conciliação de vendas Blu.
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 débito.
É necessário um
token
para ter acesso aos dados.
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.
API
Fique atento! para visualizar os exemplos de retornos da API, clique no botão > para abrir o campo de leitura
Conciliação Débito
GET
https://api.blu.com.br/conciliations/debits/installments?beginDate=?&endDate=?
Esta API é responsável por retornar as liquidações referentes a vendas débito realizadas na maquininha Blu de acordo com as datas solicitadas a partir de D-1.
Objetivo
Possibilitar aos varejistas validar que as vendas débito realizadas caíram corretamente em sua conta Blu.
Query Parameters
Name | Type | Description |
---|---|---|
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
Name | Type | Description |
---|---|---|
Authorization* | String | Token de operação |
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:
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.
Campos da transação | Data type | Descrição |
---|---|---|
String | Registro que representa a empresa. | |
String | Nome da empresa. | |
String | Número identificador da transação. | |
String | Número identificador da categoria da transação. | |
String | Data da liquidação. | |
String | Valor bruto da transação. | |
String | Valor liquido da transação. | |
String | Valor da taxa. | |
Array | Lista de parcelas liquidadas. |
Campos da parcela | Data type | Descrição |
---|---|---|
String | Número identificador da parcela. | |
String | Código da transação realizada via cartão. | |
String | Código da transação via cartão, gerado quando aprovada. | |
String | Valor bruto da parcela. | |
String | Valor líquido da parcela. | |
String | Valor bruto liquidado. | |
String | Valor líquido liquidado. |
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 débito:
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.
Last updated