Material de Apoio para utilização das APIs
Está página tem como objetivo explicar melhor a utilização das APIs da Integração bem como responder a perguntas frequentes
Enviar Cobrança
Esta API tem como objetivo enviar uma cobrança para ser registrada no Portal Blu. Neste ponto, é determinado através do campo billing_later. se a cobrança será com ou sem faturamento:
Com faturamento → billing_later: true
Sem faturamento → billing_later: false
A operação ocorrendo com sucesso deve ser retornado o status 1 - Aguardando aprovação e aguardar o cobrado aprovar a cobrança.
Consultar Cobrança
A API tem como principais funções:
1. Consultar se houve mudança de status na cobrança:
Devem ser verificados os campo status e status_code para saber se houve alteração. Os status possíveis estão aqui.
2. Consultar se o calendário de pagamento da cobrança foi gerado (PagBlu) ou se o pagamento "À Vista" foi realizado:
O campo installments_of_charger é populado a partir do momento que o calendário de pagamento é emitido pela Blu:
Cobrança com faturamento → Após o envio do faturamento o calendário de pagamento é gerado.
Cobrança sem faturamento → No momento em que o cobrado aprova a cobrança o calendário de pagamento é gerado.
Cobrança À Vista → No momento em que o cobrado aprova a cobrança uma parcela com o valor total da cobrança aparece no campo.
3. Verificar o charger_kind que pode ser default ou on_time.
Default se refere ao pagamento do tipo PagBlu (parcelado) e on_time que tratará de pagamentos À Vista.
4. Validação de valores de desconto pelo visão de cobrador (fornecedor) e cobrado (lojista):
Cobrador → Os campos charger_increase_or_discount_rate, charger_increase_or_discount, charger_value se referem ao percentual de desconto, valor do desconto e valor total a ser recebido pelo cobrador.
Cobrado → Os campos increase_or_discount_rate, increase_or_discount, value se referem ao percentual de desconto, valor do desconto e valor total que foi pago pelo cobrado. Existem casos em que o desconto dado ao cobrado é diferente do desconto aplicado ao cobrador por conta do modelo de recebimento escolhido pelo cobrador. Neste caso, para ter o valor exato do valor cobrado pela escolha do modelo de recebimento deve ser feita a diferença entre os campos do cobrado e cobrador. Em caso de dúvidas consulte o Time de Integração para maiores esclarecimentos.
Cancelar Cobrança
Esta API permite que o cobrador cancele a cobrança antes que o cobrado a aceite. Ou seja, a cobrança deve estar em status 1 - Aguardando Aprovação ou status 2 - Aprovado, aguardando o valor total para pagamento automático para que seja possível cancelar a cobrança.
Após o cancelamento da cobrança ela passará a ter status 4 - Pagamento cancelado.
Vale frisar que quando uma cobrança é cancelada pelo cobrador ou rejeitada pelo cobrado é possível utilizar o mesmo document_number em uma nova cobrança.
Enviar Faturamento
Esta API é utilizada em cobranças com o parâmetro billing_later: true para que o faturamento seja enviado para a Blu e o calendário de pagamento gerado. O envio do faturamento só pode ser feito quando a cobrança já foi aprovada pelo cobrado e encontra-se em status 8 - Pagamento aguardando faturamento ou cancelamento de nota e deve:
Possuir data do dia atual ou futura.
Ter valor menor ou igual ao valor da cobrança.
Cada faturamento de cobrança enviado deve ter um nome de Nota Fiscal único.
Para verificar se o faturamento foi registrado corretamente deve ser utilizada a API de Consultar Cobrança no campo installments_of_charger. Após o envio de um faturamento total a cobrança permanece em status 8 por mais 72h e então o status é alterado para status 3 - Pagamento realizado.
Cancelar Faturamento
A API de Cancelar Faturamento é utilizada em cobranças com com o parâmetro billing_later: true e permite cancelar um faturamento de uma cobrança que ainda encontre-se em status 8 - Pagamento aguardando faturamento ou cancelamento de nota.
Após o cancelamento do faturamento o saldo volta a estar Aguardando faturamento e o calendário de pagamento gerado é extinto.
Enviar Devolução
Esta API é utilizada em cobranças com o parâmetro billing_later: true e em três situações:
Quando deseja-se devolver o valor total ao cobrado e não faturar nenhuma nota. Neste caso após a devolução a cobrança irá para status 9 - Pagamento devolvido.
Quando a cobrança foi parcialmente faturada e deseja-se devolver o valor restante para o cobrado. Neste caso após a devolução irá para status 3 - Pagamento realizado.
Quando há um valor residual de centavos e a cobrança não passa para status 3 após 72h. Após a devolução a cobrança irá para status 3 - Pagamento realizado.
Quando a cobrança está totalmente faturada e deseja-se que ela mude para o status 3 - Pagamento realizado de maneira imediata sem aguardar as 72h que possibilitam o cancelamento do faturamento.
Em todos os casos o valor é devolvido para a Conta Blu do cobrado no momento em que a devolução é enviada.
Vale frisar que não é possível determinar o valor da devolução. Todo o valor Aguardando faturamento, ou seja, sem Nota Fiscal e calendário de pagamento associados será devolvido para o cobrado.
Após o envio da devolução a cobrança é finalizada, entrando nos status finais 3 ou 9.
Consultar Conciliação Financeira
A API de Consultar Conciliação Financeira possibilita consultar todos os pagamentos feitos pela Blu em D-1 ou anterior, ou seja, deve-se sempre consultar no mínimo o dia anterior ao atual. A consulta deve ocorrer sempre após às 9h, caso contrários os dados de D-1 podem ainda não estar disponíveis e retorno ser erroneamente “Nenhuma informação encontrada para os dados informados.". As movimentações mostradas pela API são:
Recebimento de Parcelas PagBlu.
Recebimento de cobranças À Vista.
Antecipações financeiras provenientes de cobranças.
Vale frisar que em movimentações de baixa parcial de parcelas advindas de antecipações financeiras o valor proporcional da taxa de inadimplência e a taxa de antecipação são exibidas em cada uma das parcelas.
Auxiliar: Verifica Lojista/Criado Blu
A API de Verifica Lojista/Criado Blu pode ser acessada no link e tem como objetivo verificar se um cobrado possui conta Blu. Vale frisar que essa API não deve ser utilizada em massa e sim pontualmente no cadastro do cliente.
Perguntas Frequentes
Last updated