Get Billing By ID

GET {{url_contbank}}/s2s/billings/:billing_id

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

O ID da cobrança deve ser enviado como path param na URL.

O X-Current-Identity deve ser enviado no Header da requisição.

Response Schema

Campo
Tipo do Campo
Descrição do Campo
id
string
ID da cobrança.
billing_method
string
Método de cobrança.
current_identity
string
Identificador do emissor da cobrança.
account
object
Objeto contendo os detalhes da conta do emitente.
account.account_id
string
ID da conta.
account.branch
string
Agência da conta.
account.number
string
Número da conta.
account.identifier
string
Identificador da conta.
payer
object
Objeto contendo informações do pagador.
payer.name
string
Nome do pagador.
payer.identifier
string
Identificador do pagador.
payer.address.street
string
Rua do endereço do pagador.
payer.address.zip
string
CEP do endereço do pagador.
payer.address.city
string
Cidade do endereço do pagador.
payer.address.state
string
Estado do endereço do pagador.
payer.email
string
E-mail do pagador.
payerstatus.phone.country_code
string
Código do país do telefone do pagador.
payer.phone.phone_number
string
Número do telefone do pagador.
payer.notifications.send_email
boolean
Enviar e-mail de notificação para o pagador (true/false).
payer.notifications.send_sms
boolean
Enviar SMS de notificação para o pagador (true/false).
payer.save_as_contact
boolean
Salvar como contato do pagador (true/false).
due_date
string
Data de vencimento da cobrança.
close_payment
string
Data de fechamento do pagamento.
close_payment_days
integer
Dias para fechamento do pagamento.
description
string
Descrição da cobrança.
amount
number
Valor da cobrança.
discounts
object
Objeto contendo os detalhes do desconto.
discounts.limit_date
string
Data limite para desconto.
discounts.value
number
Valor do desconto.
discounts.type
string
Tipo de desconto (ex: PERCENT/CURRENCY).
discounts.interval_days
integer
Dias de intervalo para desconto.
fine
object
Objeto contendo os detalhes da multa.
fine.start_date
string
Data de início da multa.
fine.value
number
Valor da multa.
fine.type
string
Tipo de multa (ex: PERCENT/CURRENCY).
fine.interval_days
integer
Dias de intervalo para multa.
interest
object
Objeto contendo os detalhes dos juros.
interest.start_date
string
Data de início dos juros.
interest.value
number
Valor dos juros.
interest.type
string
Tipo de juros (ex: PERCENT/CURRENCY).
interest.interval_days
integer
Dias de intervalo para juros.
status
string
Status atual da cobrança.
status_reason
string
Campo opcional. Por vezes indica alguma outra informação em relação ao status atual.

Exemplo :
- BANKSLIP_LIMIT_REACHED : Limite operacional atingido. Neste caso, contate o setor comercial para maiores detalhes ou solicitação de aumento de cota de geração.
status_history
object
Array contendo o historico dos status da cobrança.
status_history.status
string
Status histórico da cobrança.
status_history.updated_at
string
Data de atualização do status histórico da cobrança.
status_history.updated_by
string
ID do usuário que atualizou o status histórico da cobrança.
updated_at
string
Data de atualização da cobrança.
updated_by
string
ID do usuário que atualizou a cobrança.
created_at
string
Data de criação da cobrança.
created_by
string
ID do usuário que criou a cobrança.
request_id
string
ID da requisição.
billing_method_related
object
Objeto contendo informações relacionadas ao método de cobrança.
billing_method_related.updated_at
timestamp
Data e hora da última atualização do método de cobrança.
billing_method_related.boleto_id
string
ID do boleto.
billing_method_related.authentication_code
string
Código de autenticação.
billing_method_related.barcode
string
Código de barras do boleto.
billing_method_related.digitable_line
string
Linha digitável do boleto.
billing_method_related.our_number
string
Nosso número do boleto.
billing_method_related.document
string
Documento relacionado ao boleto.
billing_method_related.pix_id
string
ID do pix.
billing_method_related.pix_encoded_value
string
Valor em decodificado base64 do PIX Copia e Cola. No campo billing_method_related.pix_copy_paste há o valor decodificado, se preferir.
billing_method_related.pix_encoded_file
string (data:image/png;base64)
Valor em base64 da imagem de extensão PNG. Refere-se ao PIX QRCode.
billing_method_related.pix_copy_paste
string
Valor em string do PIX Copia e Cola. Trata-se do campo billing_method_related.pix_encoded_value decodificado.
installment
integer
Número da parcela.
total_of_installments
integer
Total de parcelas.
recurring_id
string
ID do pagamento recorrente.
payments
array
Array contendo os dados relacionados ao pagamento da cobrança. Este objeto é retornado apenas quando o boleto possui o status PAID_OUT.
payments.id
string
ID da transação de pagamento.
payments.amount
number
Valor pago.
payments.channel
string
Nome do canal de pagamento.
payments.paid_out_date
timestamp
Data de pagamento da cobrança.

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.