[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
Campo | Descrição |
---|---|
current_identity | É o CPF/CNPJ do usuário que gerou a cobrança. |
billing_method | Indica o tipo da cobrança. |
Account.branch | Agência da conta que criou a cobrança. |
Account.number | Número da conta de quem criou a cobrança. |
amount | Valor da cobrança em Reais (BRL). |
status | Pode 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_date | Data 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. |
description | Descrição da cobrança. Este valor será apresentado no PDF do Boleto. |
payer | São os dados de quem está sendo cobrado, ou seja, do responsável pelo pagamento. |
payer.trade_name | Campo opcional. Utilizado quando o pagador possui nome fantasia. |
payer.email | Campo opcional. E-mail do pagador. Quando informado, enviaremos lembretes de vencimento e/ou confirmação do pagamento da cobrança. |
payer.phone | Campo 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_payment | Indica 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_rate | Percentual de desconto que será aplicado ao valor da cobrança quando ocorrer compensação até 1 (um) dia antes da data de vencimento. |
fine_rate | Percentual referente a multa. Aplicado quando pago após o vencimento. |
interest_rate | Percentual referente aos juros mensais. Aplicado quando pago após o vencimento. |
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-Current-Identity | number | CPF/CNPJ do usuário que está consultando a cobrança. Ele deve ter permissão na conta que a gerou. |