Skip to main content

Listar boletos

A listagem de boletos retornará todos os boletos da carteira que se enquadrarem nos query parameters enviados na request.

Request​

ENDPOINT
/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/bank_slips
MÉTODO
GET

Path parameters​

CampoTipoDescriçãoCaracteres
account_keyuuidv4Chave única de identificação da conta, no formato uuid v436
requester_profile_keyuuidv4Chave única de identificação da carteira, no formato uuid v436

Query parameters​

CampoTipoDescriçãoCaracteres
request_control_keyuuidv4Chave única de identificação da request, no formato uuid v436
bank_slip_keyuuidv4Chave única de identificação do boleto, no formato uuid v436
bank_slip_statusstringStatus do boletoEnumeradores bank_slip_status
pageintegerNúmero da página-
page_sizeintegerTamanho da página-
from_datestringData inicial (formato "AAAA-MM-DD")10
to_datestringData final (formato "AAAA-MM-DD")10

Enumeradores bank_slip_status​

EnumeradorDescrição
acceptedAceito e enviado para a Nuclea/CIP para análise
rejectedRegistro rejeitado pela Nuclea/CIP
payment_noticeAviso de pagamento (boleto pago mas pagamento ainda não liquidado)
notary_office_payment_noticeAviso de pagamento em cartório (boleto pago mas pagamento ainda não liquidado)
registeredRegistro confirmado pela Nuclea/CIP
payment_blockedBloqueado para pagamento (em fluxo de protesto)
paidPago
written_offBaixado

Response​

STATUS
200
Response Body
{
  "data": [
    {
      "bank_slip_key": "b58ce415-5428-45c4-8e33-b2df0d3ab6e8",
      "request_control_key": "53529224-330d-44b5-9f4d-59d55bc3cb8c",
      "our_number": 24384760943,
      "document_number": "DOC4561237",
      "amount": "8000.00",
      "rebate_amount": "200.00",
      "expiration": "2024-07-13",
      "barcode": "32994978900005000000001594438621284040114400",
      "digitable_line": "32990001529443862128940401144007497890000500000",
      "bank_teller_instructions": "Confirm payment",
      "protest_data": {
        "days_to_protest": 7
      },
      "bankruptcy_protest_data": {
        "days_to_bankruptcy_protest": 14
      },
      "max_payment_days": 45,
      "fine_data": {
        "fine_type": "absolute",
        "fine_amount": 100.0,
        "days_to_fine": 10
      },
      "interest_data": {
        "interest_type": "workdays_daily_amount",
        "interest_amount": 5.0,
        "days_to_interest": 10
      },
      "discounts_data": [
        {
          "discount_type": "anticipation_workdays_daily_percentage",
          "discount_number": 1,
          "discount_limit_date": "2024-07-13",
          "discount_percentage": 10
        }
      ],
      "payer_data": {
        "name": "Country Tech",
        "address": {
          "city": "Innovation City",
          "state": "RS",
          "number": "202",
          "street": "101 High St.",
          "complement": "Building A",
          "postal_code": "57099999",
          "neighborhood": "Tech Park"
        },
        "person_type": "legal",
        "document_number": "12345678000195"
      },
      "guarantor_data": {
        "name": "Jamie Doe",
        "address": {
          "city": "Peaceful Town",
          "state": "MG",
          "number": "303",
          "street": "202 Elm St.",
          "complement": "House 1",
          "postal_code": "57099999",
          "neighborhood": "Quiet Neighborhood"
        },
        "person_type": "natural",
        "document_number": "98765432100"
      },
      "bank_slip_status": "accepted"
    }
  ],
  "pagination": {
    "current_page": 1,
    "rows_per_page": 100
  }
}

Response Body Params​

CampoTipoDescriçãoCaracteres
data *object arrayBoletosObjeto bank_slip
pagination *objectInformações de paginaçãoObjeto pagination

Objeto bank_slip​

CampoTipoDescriçãoCaracteres
bank_slip_key *uuidv4Chave única de identificação do boleto no formato uuid v436
request_control_key *uuidv4Chave única de identificação da request utilizada pelo cliente no formato uuid v436
our_number *integerNúmero único de identificação do boleto junto à carteira11
bank_slip_status *stringStatus do boletoEnumeradores bank_slip_status
protest_status *stringStatus de protesto, em cartório, do boletoEnumeradores protest_status
document_number *stringNúmero de identificação do boleto10
amount *floatValor base do boleto-
expiration *stringData de vencimento10
barcode *stringCódigo de barras do boleto44
digitable_line *stringLinha digitável do boleto47
bank_teller_instructionsstringInstruções adicionais de registro, que constarão no PDF do boleto320
rebate_amountfloatValor de abatimento do boleto, que será aplicado em cima do valor base-
max_payment_days *integerMáximo de dias corridos que o boleto ficará disponível para pagamento, após o vencimento (pode ser no máximo 365)-
write_off_dataobjectConfiguração de baixaObjeto write_off_data
protest_dataobjectConfiguração de protestoObjeto protest_data
bankruptcy_protest_dataobjectConfiguração de protesto falimentarObjeto bankruptcy_protest_data
fine_dataobjectConfiguração de multaObjeto fine_data
interest_dataobjectConfiguração de jurosObjeto interest_data
discounts_dataobject arrayDescontosObjeto discount
payer_data *objectDados do pagadorObjeto payer_data
guarantor_data *objectDados do sacador avalistaObjeto guarantor_data

Objeto pagination​

CampoTipoDescriçãoCaracteres
current_page *integerPágina atual-
rows_per_page *integerItens por página-

Enumeradores protest_status​

EnumeradorDescrição
not_protestedBoleto sem fluxo de protesto iniciado
protest_requestedProtesto em cartório solicitado
notary_office_entryBoleto no cartório, em período de tríduo
protest_cancel_requestedDesistência do protesto solicitada
notary_office_exitBoleto saiu do cartório
protestedBoleto protestado
paid_at_notary_officePago no cartório
judicially_suspendedProtesto suspenso judicialmente
protest_remove_requestedRemoção do protesto solicitada

Objeto write_off_data​

CampoTipoDescriçãoCaracteres
days_to_write_off *integerDias, após o vencimento, para que o boleto seja baixado automaticamente-

Objeto protest_data​

CampoTipoDescriçãoCaracteres
days_to_protest *integerDias, após o vencimento, para que o boleto seja protestado automaticamente-

Objeto bankruptcy_protest_data​

CampoTipoDescriçãoCaracteres
days_to_bankruptcy_protest *integerDias, após o vencimento, para que o boleto seja protestado automaticamente-

Objeto fine_data​

Opção 1: multa em valor absoluto (fine_type=absolute)
CampoTipoDescriçãoCaracteres
fine_type *stringTipo da multaEnumeradores fine_type
fine_amount *floatValor absoluto da multa-
days_to_fine *integerDias, após o vencimento, para que a multa seja cobrada-
Opção 2: multa em valor percentual (fine_type=percentage)
CampoTipoDescriçãoCaracteres
fine_type *stringTipo da multaEnumeradores fine_type
fine_percentage *integerValor percentual da multa, de 1 a 100-
days_to_fine *integerDias, após o vencimento, para que a multa seja cobrada-

Enumeradores fine_type​

EnumeradorDescrição
absolutevalor absoluto
percentagevalor percentual

Objeto interest_data​

Opção 1: juros utilizando valores absolutos (interest_type=calendar_days_daily_amount ou interest_type=workdays_daily_amount)
CampoTipoDescriçãoCaracteres
interest_type *stringTipo de jurosEnumeradores interest_type
interest_amount *floatValor a ser cobrado por unidade de tempo determinada (dias úteis ou corridos)-
days_to_interest *integerDias, após o vencimento, para que comece a cobrar os juros-
Opção 2: juros utilizando valores percentuais (interest_type=calendar_days_monthly_percentage)
CampoTipoDescriçãoCaracteres
interest_type *stringTipo de jurosEnumeradores interest_type
interest_percentage *integerPorcentagem a ser cobrada por unidade de tempo determinada (dias úteis ou corridos)-
days_to_interest *integerDias, após o vencimento, para que comece a cobrar os juros-

Enumeradores interest_type​

EnumeradorDescrição
calendar_days_daily_amountValor diário sobre dias corridos
workdays_daily_amountValor diário sobre dias úteis
calendar_days_monthly_percentagePorcentagem de juros cobrados mensalmente, com base em dias corridos

Objeto discount​

Opção 1: descontos utilizando valores absolutos (discount_type in ["absolute", "anticipation_calendar_days_daily_amount", "anticipation_workdays_daily_amount"])
CampoTipoDescriçãoCaracteres
discount_amount *floatValor absoluto de desconto por unidade de tempo-
discount_number *integerNúmero do desconto-
discount_type *stringConfiguração do desconto em valores absolutosEnumerador discount_type
discount_limit_date *stringData limite para aplicação do desconto10
Opção 2: descontos utilizando valores percentuais (discount_type in ["percentage", "anticipation_calendar_days_daily_percentage", "anticipation_workdays_daily_percentage"])
CampoTipoDescriçãoCaracteres
discount_percentage *floatValor percentual de desconto por unidade de tempo-
discount_number *integerNúmero do desconto-
discount_type *stringConfiguração do desconto em valores percentuaisEnumerador discount_type
discount_limit_date *stringData limite para aplicação do desconto10
Atenção!

O boleto pode ter até três descontos, sendo que os descontos devem ser todos do mesmo tipo, isto é, devem ter o mesmo discount_type. Os descontos devem ser numerados de 1 a 3, de maneira crescente e começando necessariamente em 1. Ou seja, caso sejam enviados dois descontos na requisição, devem necessariamente ser numerados com 1 e 2.

Enumeradores discount_type​

EnumeradorDescrição
absoluteValor fixo
anticipation_calendar_days_daily_amountValor diário de desconto de antecipação, sobre dias corridos
anticipation_workdays_daily_amountValor diário de desconto de antecipação, sobre dias úteis
percentagePorcentagem fixa
anticipation_calendar_days_daily_percentagePorcentagem mensal de desconto de antecipação, com base em dias corridos
anticipation_workdays_daily_percentagePorcentagem anual de desconto de antecipação, com base em dias úteis

Objetos payer_data e guarantor_data​

CampoTipoDescriçãoCaracteres
name *stringNome completo100
document_number *stringNúmero do documento (CPF/CNPJ)11 ou 14
person_type *stringTipo da pessoa (física ou jurídica)Enumeradores person_type
contactobjectInformações de contatoObjeto contact
addressobjectEndereçoObjeto address

Enumeradores person_type​

EnumeradorDescrição
naturalpessoa física
legalpessoa jurídica

Objeto contact​

CampoTipoDescriçãoCaracteres
emailstringE-mail de contato320
phoneobjectTelefone de contatoObjeto phone

Objeto phone​

CampoTipoDescriçãoCaracteres
international_dial_code *stringCódigo DDI (Discagem Direta Internacional)3
area_code *stringCódigo DDD (Discagem Direta à Distância)2
number *stringComplemento9

Objeto address​

CampoTipoDescriçãoCaracteres
street *stringLogradouro500
number *stringNúmero6
complementstringComplemento500
neighborhood *stringBairro100
postal_code *stringCEP8
city *stringCidade100
state *stringEstado (UF)Enumerador state

Enumeradores state​

EnumeradorDescrição
ACAcre
ALAlagoas
AMAmazonas
APAmapá
BABahia
CECeará
DFDistrito federal
ESEspírito Santo
GOGoiás
MAMaranhão
MGMinas Gerais
MSMato Grosso do Sul
MTMato Grosso
PAPará
PBParaíba
PEPernambuco
PIPiauí
PRParaná
RJRio de Janeiro
RNRio Grande do Norte
RORondônia
RRRoraima
RSRio Grande do Sul
SCSanta Catarina
SESergipe
SPSão Paulo
TOTocantins
EXExceção

Error Response​

STATUS
4xx
Response Body: Error
{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}
Código HTTP
status		Código QI
code		Título
title		Descrição (eng)
description		Descrição (pt-br)
translation
403BKS000005ForbiddenUser is not allowed to do this actionUsuário não tem autorização para fazer essa ação
404BKS000006Not FoundThe source account key was not found.A chave da conta de origem não foi encontrada.
400BKS000007Bad RequestIt was not possible to consult the source account at this time. Please try again in a few minutes.Não foi possível consultar a conta de origem neste momento. Por favor, tente novamente em alguns minutos.
400BKS000008Bad RequestThe source account is closed.A conta de origem está fechada.
400BKS000009Bad RequestThe source account is blocked.A conta de origem está bloqueada.
404BKS000013Not FoundRequester profile not foundCarteira não encontrada