Cancelar Faturamento

Página dedicada a API Cancelar Faturamento PagBlu com HTTP Status

Cancelar Faturamento

DELETE https://api-hlg.blu.com.br/b2b/payment-collections/v2/{uuid}/payment-plans/{payment_plan_uuid}

Permite realizar o cancelamento do faturamento de um pedido/cobrança. O cancelamento de um faturamento somente poderá ser realizado em pedidos/cobranças que já estejam aprovados e ainda não estejam pagos ("status_code": 8).

Path Parameters

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

Headers

Name	Type	Description
Authorization	string	Bearer token.

202: Accepted Solicitação de cancelamento de fatura em processamento.

OK

{
    "uuid": "<uuid-do-pedido/cobrança>",
    "document_number": "",
    "charger": "00000000000",
    "value": "0.00",
    "message": "Nota xxxxxxxxxx-xxxxxxx-xxxxxx-xxxxx-xxxxxxxxxx será cancelada. Invoice_number: Número-Faturamento. O valor recebido será devolvido e voltará para o saldo a faturar."
}

NOK

{
    "uuid": "<uuid-do-pedido/cobrança>",
    "document_number": "",
    "charger": "000000000000",
    "value": "0.00",
    "message": "A Cobrança encontra-se em status 3 - Pagamento confirmado - Não é possível cancelar o faturamento de uma cobrança no status 3 - Pagamento confirmado"
}

401: Unauthorized Token não informado ou inválido

{
    "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."
}

422: Unprocessable Entity Payment-plan-uuid não informado ou inválido

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

422: Unprocessable Entity Status impossibilitando cancelamento

{
    "uuid": "<uuid>",
    "document_number": "xxxxxx-xx",
    "charger": "xxxxxxxxxxx",
    "value": "0.00",
    "message": "A Cobrança encontra-se em status <status> - Não é possível cancelar o faturamento de uma cobrança no status <status>"
}

Exemplo de chamada:

cURL

curl --location -g --request DELETE 'https://api-hlg.blu.com.br/b2b/payment-collections/v2/{uuid}/payment-plans/{payment-plan-uuid}' \
--header 'Authorization: Bearer XXXXXXXXXXXXXXXXXXXXXXX' 

NodeJS

var request = require('request');
var options = {
  'method': 'DELETE',
  'url': 'https://api-hlg.blu.com.br/b2b/payment-collections/v2/{uuid}/payment-plans/{payment-plan-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