Consultar Cobrança

Página dedicada a API Consultar Cobrança PagBlu com HTTP Status

Consultar Cobrança

GEThttps://api-hlg.blu.com.br/b2b/payment-collections/v2/{uuid}

Consulta a situação de uma cobrança.

Relação de status_code de Pedido/Cobrança

Abaixo estão listados os códigos que representam a situação que um pedido/cobrança pode se encontrar dentro da Blu.

Status Code	Descrição
1	Aguardando aprovação
2	Aprovado, aguardando o valor total para pagamento automático
3	Pagamento realizado
4	Pagamento cancelado
5	Pagamento rejeitado
6	Agendamento aprovado para o dia AAAA-MM-DD
7	Em processamento
8	Pagamento aguardando faturamento ou cancelamento de nota
9	Pagamento devolvido
10	Aguardando Antecipação

Path Parameters

Name	Type	Description
uuid	string	Identificador único do pedido/cobrança.

Headers

Name	Type	Description
Authorization	string	Bearer token.

200 OK

OK

{
    "uuid": "<identificador-único>",
    "billing_later": true,
    "document_number": "",
    "charger": "000.000.000-00",
    "charged": "00.000.000/0000-00",
    "status": "Aguardando aprovação",
    "statusCode": 1,
    "kind": "payment_collection",
    "charger_kind": "default",
    "charger_increase_or_discount_rate": "0.0",
    "charger_increase_or_discount": "0.0",
    "charger_value": "0.0",
    "tax_percentage_flex":null,
    "installments_flex":null,
    "scheduled_at": "",
    "created_at": "aaaa-mm-ddThh:mm:ss.sss+00:00",
    "approved_at": "aaaa-mm-ddThh:mm:ss.sss+00:00",
    "paid_at": "aaaa-mm-ddThh:mm:ss.sss+00:00",
    "increase_or_discount_rate": "0.0",
    "increase_or_discount": "0.0",
    "value": "0.0",
    "installments_of_charger": [
       {
            "id": "xxxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxxx",
            "uuid": "xxxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxxx",
            "released_at": "aaaa-mm-dd",
            "gross_value": "0.0",
            "net_value": "0.0",
            "rate_value": "0.0",
            "tax_rate": "0.00",
            "status": null,
            "transaction_category_id": null,
            "advances_rate_value": null,
            "charged": "00000000000",
            "payment_collection_reference": "document_number",
            "receivable_id": "xxxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxxx",
            "payment_plan_uuid": "xxxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx",
            "payment_plan_invoice_number": "Nota Fiscal"
        },(...)
     }
  ]
}

401: Unauthorized Token não informado

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

404: Not Found Uuid não informado ou inválido

{
    "message": "Nenhuma cobrança encontrada para o identificador informado."
}

A unicidade de uma parcela é garantida pelos campos id, uuid e payment_plan_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/{uuid}' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXX'

NodeJs

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

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