Enviar Faturamento

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

Enviar Faturamento

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

Permite o envio de informações relacionadas ao faturamento de um pedido/cobrança específica. Após o envio dessas informações, na API GET Consultar Cobrança, nos dados da "installments_of_charger", será possível consultar todos os dados dos pagamentos. O faturamento de um pedido/cobrança somente poderá ser realizando se este foi criado com a opção de faturamento ("billing_later": true), já encontra-se aprovado e não esteja pago ("status_code": 8).

Atenção! O tempo para o cancelamento de um faturamento é de até 24 horas.

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

Name	Type	Description
Authorization	string	Bearer token.

Name	Type	Description
type	string	Tipo do documento (nota fiscal, boleto, título).
key	string	Chave de autorização da nota fiscal.
invoice_number	string	Número do documento (nota fiscal, boleto, título).
value	string	Valor do documento.
date	string	Data de envio dos dados do faturamento ou vencimento do documento.

201: Faturamento regisrado

OK

{
    "uuid": "<identificador-único>",
    "invoice_number": "XXXXXX-XXXXXX-XXXXX",
    "value": "0.00",
    "date": "aaaa-mm-dd",    
    "message": "Faturamento registrado com sucesso."
}

OK: pending

{
	"uuid": "<identificador-único>",
	"invoice_number": "XXXXXX-XXXXXX-XXXXX",
	"value": 0.00,
	"date": "aaaa-mm-dd",
	"status": "pending",
	"message": "Faturamento aguardando saldo para ser processado."
}

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 os dados informados."
}

422: Unprocessable Entity Dados do faturamento não informados

{
{
    "status": "rejected!",
    "message": "Valor não pode ficar em branco, Valor não é um número, Data não pode ficar em branco, Número do faturamento não pode ficar em branco"
}

422: Unprocessable Entity Status impossibilitando cancelamento

{
    "status": "rejected!",
    "message": "Cobrança precisa estar aprovada, agendada ou aguardando faturamento"
}

422: Unprocessable Entity Somatório de notas ultrapassando valor da cobrança

{
    "status": "rejected!",
    "message": "Somatório das notas não pode ultrapassar o valor da cobrança"
}

O retorno "Faturamento aguardando saldo para ser processado." é um status transitório e ao consultar a cobrança o faturamento já estará processado.

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