API Movimento de Vendas

A API de Movimento de Vendas tem como objetivo registrar as vendas que foram realizadas pela máquina de POS da Blu.

Podemos dizer, que ela é o primeiro passo para a realização da conciliação uma vez que registrará todas as vendas reconhecidas pela Blu que geraram saldo atual ou agenda na conta Blu. Vale frisar que esta API não registra o pagamento de parcelas, apenas a data em que a operação ocorreu e a previsão de pagamento.

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.

  • O range de data não deve ser superior a um mês.

  • A API registra as vendas feitas no crédito, débito e Link de Pagamento.

  • Para ter acesso aos dados, é necessário um token.

  • Para vendas split deve ser utilizada a API Movimento de Vendas Split

Esses parâmetros são disponibilizados pelo time de Integração da Blu quando solicitados pelo executivo de contas.

API

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

Movimento de Vendas

GET https://api.blu.com.br/conciliations/sales

Esta API é responsável por retornar as vendas realizadas na maquininha Blu de acordo com as datas solicitadas a partir de D-1.

Objetivo

Possibilitar aos varejistas validar que as vendas realizadas na máquina de POS da Blu foram registrada pelo portal Blu.

Fique atento! para visualizar os exemplos dos responses abaixo, clique no botão > para abrir o campo de leitura.

Headers

NameTypeDescription

token*

string

Bearer token de identificação do fornecedor

beginDate

string

Data inicial do período no formato AAAA-MM-DD. Não deve ser superior a D-1.

endDate

string

Data final do período no formato AAAA-MM-DD. Não deve ser superior a D-1.

nsuCode

string

Código NSU da Transação (Número Sequencial Único).

{
  "Message": "Quantidade de registros encontrados : 00",
  "Objects": [[{}]]
}

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 campo nsuCode pode ser utilizado na busca de forma independente a busca por data.

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:

Campos da transaçãoDescrição

id_transacao

Identificador da transação dentro da Blu.

valor_venda_total_bruto

Valor bruto da venda.

valor_venda_total_liquido

Valor líquido da venda.

valor_sem_taxas

Valor bruto da parcela.

valor_com_taxas

Valor líquido da parcela.

data_ocorrencia

Data de ocorrência da transação no formato AAAA-MM-DD.

data_liquidacao

Data de prevista para liquidação da transação no formato AAAA-MM-DD.

data_criacao

Data de criação da transação no portal Blu no formato AAAA-MM-DD.

cod_autorizacao

Código de autorização da transação.

tipo_venda

Tipo de venda da transação, sendo débito ou crédito.

numero_pos

Número do POS que foi efetuada a transação.

serial_pos

Serial do POS que foi efetuada a transação.

banco

Banco emissor do cartão que efetuou a transação.

bandeira

Bandeira do cartão que efetuou a transação.

numero_cartao

Número do cartão que efetuou a transação.

razao_social_cliente_blu

Razão social do cliente Blu registrado no POS.

cnpj_cliente_blu

CNPJ do cliente Blu registrado no POS.

cv_nsu

NSU da transação.

status_transacao_pos_ou_cobranca

Status da transação.

data_cancelamento_pos_ou_cobranca

Data do cancelamento da transação no formato AAAA-MM-DD.

parcela

Número da parcela da transação.

parcelas

Número total de parcelas da transação.

valor_taxa_administracao

Valor da taxa de administração da transação.

data_liquidacao_programada

Data de prevista para liquidação da transação no formato AAAA-MM-DD.

via_de_venda

Via que a transação foi realizada.

data_atualizacao

Data que a transação sofreu atualização no formato AAAA-MM-DD.

Abaixo vemos exemplos de retorno da API para uma transações do tipo crédito e débito:

{
                "id_transaction": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
                "valor_venda_total_bruto": "0.00",
                "valor_venda_total_liquido": "0.00",
                "valor_sem_taxas": "0.00",
                "valor_com_taxas": "0.00",
                "data_ocorrencia": "aaaa-mm-ddT00:00:00Z",
                "data_liquidacao": "aaaa-mm-ddT00:00:00Z",                
                "data_criacao": "aaaa-mm-ddT00:00:00Z",
                "cod_autorizacao": "xxxxxx",
                "tipo_venda": "credit",
                "numero_pos": xxxxxxxxxx,
                "serial_pos": xxxxxxxxxx,
                "banco": "Banco Emissor",
                "bandeira": "Nome da bandeira",
                "numero_cartao": "000000000XXXXXX0000",
                "razao_social_cliente_blu": "Razão Social",
                "cnpj_cliente_blu": "00000000000000",
                "cv_nsu": "000000000000",
                "status_transacao_pos_ou_cobranca": "confirmed",
                "data_cancelamento_pos_ou_cobranca": null,
                "parcela": 0,
                "parcelas": 0,
                "valor_taxa_administracao": "0.00000",
                "data_liquidacao_programada": "aaaa-mm-ddT00:00:00Z",
                "via_de_venda": "via de venda",
                "data_atualizacao": "aaaa-mm-ddT00:00:00Z"     
}

O campo id_transaction presente neste retorno será utilizado para relacionar as vendas registradas pela API Movimento de Vendas com a API Débito, Crédito e Antecipações.

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/sales' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXXXXX' \
--header 'begindate: AAAA-MM-DD' \
--header 'enddate: AAAA-MM-DD' \
--header 'nsucode: xxxxxxxxxxxxx' \
PreviousVarejo APIsNextAPI Movimento de Vendas Split

Last updated