[DEPRECATED] Get Billing by ID

GET {{url_contbank}}/billings/:billing_id

[Esta rota não é mais válida (DEPRECATED)]

Endpoint para obter os dados de uma cobrança específica.

O ID da cobrança deve ser enviado na URL.
O X-Current-Identity deve ser preenchido no Header da requisição.

Response Schema

CampoDescrição
current_identityÉ o CPF/CNPJ do usuário que gerou a cobrança.
billing_methodIndica o tipo da cobrança.
Account.branchAgência da conta que criou a cobrança.
Account.numberNúmero da conta de quem criou a cobrança.
amountValor da cobrança em Reais (BRL).
statusPode ser PENDING (cobrança ainda sendo registrada), REGISTERED (cobrança já registrada e aguardando o pagamento), CANCELED (cobrança cancelada) ou SETTLED (cobrança paga/quitada).
due_dateData de vencimento da cobrança. A data limite de pagamento de uma cobrança, por padrão, é de 60 dias após esta data de vencimento indicada.
descriptionDescrição da cobrança. Este valor será apresentado no PDF do Boleto.
payerSão os dados de quem está sendo cobrado, ou seja, do responsável pelo pagamento.
payer.trade_nameCampo opcional. Utilizado quando o pagador possui nome fantasia.
payer.emailCampo opcional. E-mail do pagador. Quando informado, enviaremos lembretes de vencimento e/ou confirmação do pagamento da cobrança.
payer.phoneCampo opcional. Telefone celular do pagador. Quando informado, enviaremos SMS ao número indicado, lembrando do vencimento e/ou confirmando o recebimento do pagamento da cobrança.
close_paymentIndica a data limite que o pagamento é aceito. Após esta data, não é mais possível receber o pagamento da cobrança, sendo a mesma automaticamente cancelada.
discount_ratePercentual de desconto que será aplicado ao valor da cobrança quando ocorrer compensação até 1 (um) dia antes da data de vencimento.
fine_ratePercentual referente a multa. Aplicado quando pago após o vencimento.
interest_ratePercentual referente aos juros mensais. Aplicado quando pago após o vencimento.

HEADERS

KeyDatatypeRequiredDescription
X-Current-IdentitynumberCPF/CNPJ do usuário que está consultando a cobrança. Ele deve ter permissão na conta que a gerou.