Enviar Devolução

Página dedicada a API Enviar Devolução PagBlu com HTTP Status

Enviar Devolução

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

Permite realizar a devolução do valor empenhado para o pagamento do pedido/cobrança ao lojista/cobrado. A devolução parcial ou total de um pedido/cobrança, somente poderá ser realizada se este encontra-se aprovado e ainda não esteja pago ("status_code": 8).

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>",
    "document_number": "",
    "charger": "00000000000",
    "value": "0.00",
    "message": "Faturamento será finalizado, o valor remanescente será devolvido ao cobrado"
}

NOK

{
    "uuid": "<identificador-único>",
    "document_number": "",
    "charger": "00000000000",
    "value": "0.00    ",
    "message": "Cobrança encontra-se em status 'Pagamento confirmado' e saldo à faturar não pode ser devolvido"
}

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: Unprocessable Entity Status impossibilitando devolução

{
    "uuid": "<uuid>",
    "document_number": "xxxxxxxxx-xx",
    "charger": "xxxxxxxxxxx",
    "value": "0.00",
    "message": "Cobrança encontra-se em status <status> e saldo à faturar não pode ser devolvido"
}

cURL

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

NodeJs

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