Skip to main content

Listar carteiras da conta

A listagem de carteiras retornará todas as carteiras de boletos da conta que se enquadrarem nos query parameters enviados na request.

Request​

ENDPOINT
/account/ACCOUNT_KEY/requester_profiles
MÉTODO
GET

Path parameters​

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

Query parameters​

CampoTipoDescriçãoCaracteres
request_control_keyuuidv4Chave única de identificação da request, no formato uuid v436
requester_profile_keyuuidv4Chave única de identificação da carteira de boletos, no formato uuid v436
requester_profile_codestringCódigo único de identificação da carteira19
pageintegerNúmero da página-
page_sizeintegerTamanho da página-

Response​

STATUS
200
Response Body
{
  "data": [
    {
      "requester_profile_key": "fd86d9b1-2a5e-4e03-9a59-a043c7632c97",
      "requester_profile_code": "329-04-2338-2625918",
      "request_control_key": "0868a24b-4a69-4138-ac4d-ecaeddf0005f",
      "account_key": "0494902f-b21c-4ae6-b37e-854cfe883402",
      "requester_profile_status": "pending",
      "configuration_data": {
        "max_payment_days": 1,
        "protest_settings": {
          "days_to_protest": 0
        },
        "bankruptcy_protest_settings": {
          "days_to_bankruptcy_protest": 0
        },
        "write_off_settings": {
          "days_to_write_off": 0
        },
        "fine_settings": {
          "fine_type": "absolute",
          "fine_amount": 10,
          "days_to_fine": 0
        },
        "interest_settings": {
          "interest_type": "workdays_daily_amount",
          "interest_amount": 10,
          "days_to_interest": 0
        },
        "qr_code_settings": {
          "pix_key": "5df7a433-bd61-4f98-9515-df9aedc2980c",
          "qr_code_on_discharge_enabled": false
        }
      }
    }
  ],
  "pagination": {
    "current_page": 1,
    "rows_per_page": 100
  }
}

Response Body Parameters​

CampoTipoDescriçãoCaracteres
data *object arrayCarteiras de boletosObjeto requester_profile
pagination *objectInformações de paginaçãoObjeto pagination

Objeto requester_profile​

CampoTipoDescriçãoCaracteres
requester_profile_key *uuidv4Chave única de identificação da carteira no formato uuid v436
requester_profile_code *stringCódigo único de identificação da carteira19
request_control_key *uuidv4Chave única de identificação da request utilizada pelo cliente no formato uuid v436
account_key *uuidv4Chave única de identificação da conta no formato uuid v436
requester_profile_status *stringStatus da carteiraEnumeradores requester_profile_status
configuration_data *objectConfigurações padrão da carteiraObjeto configuration_data

Enumeradores requester_profile_status​

EnumeradorDescrição
pendingCarteira aceita e pendente de confirmação
openedCarteira aberta

Objeto pagination​

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

Objeto configuration_data​

CampoTipoDescriçãoCaracteres
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_settingsobjectConfiguração padrão de baixaObjeto write_off_settings
protest_settingsobjectConfiguração padrão de protestoObjeto protest_settings
bankruptcy_protest_settingsobjectConfiguração padrão de protesto falimentarObjeto bankruptcy_protest_settings
fine_settingsobjectConfiguração padrão de multaObjeto fine_setings
interest_settingsobjectConfiguração padrão de jurosObjeto interest_settings
qr_code_settingsobjectConfiguração padrão de QR Code PIX (para bolePix)Objeto qr_code_settings

Objeto write_off_settings​

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

Objeto protest_settings​

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

Objeto bankruptcy_protest_settings​

CampoTipoDescriçãoCaracteres
days_to_bankruptcy_protest *integerDias, após o vencimento, para que seja iniciado um processo de protesto falimentar automaticamente-

Objeto fine_settings​

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_settings​

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 qr_code_settings​

CampoTipoDescriçãoCaracteres
pix_key *uuidv4Chave Pix do tipo aleatória36
qr_code_on_discharge_enabled *booleanDetermina se as informações do QR Code constarão no arquivo retorno (CNAB)-

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 (ptbr)
translation
400QIT000001Bad RequestSchema ErrorSchema Inválido
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
400BKS000025Bad RequestInvalid bank slip status.Status de boleto inválido.