Consultar Conciliação Financeira

Página dedicada a API Consultar Conciliação Financeira PagBlu com HTTP Status

Consultar Conciliação Financeira

GET https://api-hlg.blu.com.br/b2b/payment-collections/v2/reconciliation

Retorna a conciliação financeira, ou seja, todos os pagamentos efetuados na determinada data ("date": "aaaa-mm-dd"); e ou determinado pedido/cobrança ("document_number": "xxx-xx"); e ou determinado número de documento de faturamento ("invoice_number": "xxxx-xxxx-xxxx"), que foram enviados para a consulta. Caso não seja informado nenhum dos parâmetros, será retornado todos os pagamentos efetuados na data do dia da consulta menos um, ou seja D-1. É importante salientar que, a consulta sempre será ao passado, considerando o dia atual menos um (D-1) em diante.

Query Parameters

Name	Type	Description
document_number	string	Número do pedido/cobrança.
invoice_number	string	Número do documento de faturamento.
date	string	Data do pagamento. Formato AAAA-MM-DD.

Headers

Name	Type	Description
Authorization	string	Bearer token.

200 OK

OK

[
    {
        "payment_id": "<identificador-parcela>",
        "transaction_id": "<identificador-transacao>",
        "document_number": "XXXX-XX",
        "invoice_number": "XXXXXX-XXXXXX-XXXXX",
        "charged": "000.000.000-00",
        "date": "aaaa-mm-dd"
        "value": "0.00",
        "monetary_paidout": "0.00",
        "monetary_anticipation": "0.00",
        "standard_rate_value": "0.00"
    }
]

NOK

{
    "message": "Nenhuma informação encontrada para os dados informados."
}

401: Unauthorized Token inválido e parâmetros não informados

{
    "mensagem": "Usuário não encontrado para o token informado."
}

404: Not Found Parâmetros não informados

{
    "mensagem": "Nenhuma informação encontrada para os dados informados."
}

422: Unprocessable Entity Data fora do padrão YYYY-MM-DD

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

A unicidade de uma parcela é garantida pelos campos payment_id, transaction_id e invoice_number em conjunto. Se duas parcelas são pagas no mesmo dia somente utilizando os três campos será possível garantir a unicidade para conciliação.

Exemplo de chamada:

cURL

curl --location --request GET 'https://api-hlg.blu.com.br/b2b/payment-collections/v2/reconciliation?document_number=&date=AAAA-MM-DD&invoice_number=' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXX'

NodeJs

var request = require('request');
var options = {
  'method': 'GET',
  'url': 'https://api-hlg.blu.com.br/b2b/payment-collections/v2/reconciliation?document_number=&date=AAAA-MM-DD&invoice_number=',
  'headers': {
    'Authorization': 'Bearer XXXXXXXXXXXXXXXXXXXXXXX',
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Descrição dos campos de retorno da conciliação financeira

Campo	Data Type	Descrição
payment_id	string	Identificador único da parcela.
transaction_id	string	Identificador único da transação.
invoice_number	string	Número do documento de faturamento.
charged	string	CNPJ/CPF do lojista/cobrado.
date	string	Data do pagamento.
value	string	Valor bruto da parcela.
monetary_paidout	string	Valor líquido da parcela.
monetary_anticipation	string	Valor pago pela antecipação.
standart_rate_value	string	Valor pago pelo seguro inadimplência.

Download Collection Postman (pacote de APIs)

Segue abaixo o link para download da coleção de APIs no Postman.

1KB

Blu B2B - HTTP Status.postman_collection.zip

archive