Cancelar Cobrança

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

Cancelar Cobrança

DELETE https://api-hlg.blu.com.br/b2b/payment-collections/v/2{uuid}

Realiza o cancelamento de um pedido/cobrança, caso este ainda não tenha sido aprovado ("status_code": 1), esteja aguardando saldo para efetuar o pagamento ("status_code": 2) ou ainda esteja aprovado, aguardando pagamento agendado ("status_code": 6).

Path Parameters

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

Headers

Name	Type	Description
Authorization	string	Bearer token.

200 Solicitação de cancelamento em processamento.

OK

{
    "uuid": "<identificador-único>",
    "document_number": "",
    "charger": "000.000.000-00",
    "charged": "00.000.000/0000-00",
    "message": "Pagamento cancelado com sucesso!"
}

NOK

{
    "uuid": "<identificador-único>",
    "document_number": "",
    "charger": "000.000.000-00",
    "charged": "00.000.000/0000-00",
    "message": "Cobrança encontra-se em status 'Pagamento confirmado' e não pode ser cancelada."
}

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

422: Status impossibilitando cancelamento

{
    "uuid": "<uuid>",
    "document_number": "xxxxxxxx-xx",
    "charger": "xxxxxxxxxxx",
    "charged": "xxxxxxxxxxx",
    "message": "Cobrança encontra-se em status <status> e não pode ser cancelada."
}

422

{
"statusCode": 422,
"body": 
    "{"uuid":"xxxxxxxxx-xxxxxx-xxxxxxx-xxxxxx-xxxxxxxxxxxxxxx",
    "document_number":"document_number",
    "charger":"000000000000",
    "value":"0.00",
    "message":"Nota <uuid> não pode ser cancelada. Invoice_number: <invoice-number>. O prazo de cancelamento expirou"}"
}

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