Skip to main content

List Account Wallets

The wallet listing will return all bank slip wallets for the account that match the query parameters sent in the request.

Request​

ENDPOINT
/account/ACCOUNT_KEY/requester_profiles
METHOD
GET

Path parameters​

FieldTypeDescriptionCharacters
account_keyuuidv4Unique account identification key, in uuid v4 format36

Query parameters​

FieldTypeDescriptionCharacters
request_control_keyuuidv4Unique request identification key, in uuid v4 format36
requester_profile_keyuuidv4Unique bank slip wallet identification key, in uuid v4 format36
requester_profile_codestringUnique wallet identification code19
pageintegerPage number-
page_sizeintegerPage size-

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
        },
        "cnab_settings": {
          "default_bank": "qi_scd",
          "preferred_layout": "400"
        }
      }
    }
  ],
  "pagination": {
    "current_page": 1,
    "rows_per_page": 100
  }
}

Response Body Parameters​

FieldTypeDescriptionCharacters
data *object arrayBank slip walletsrequester_profile Object
pagination *objectPagination informationpagination Object

requester_profile Object​

FieldTypeDescriptionCharacters
requester_profile_key *uuidv4Unique wallet identification key in uuid v4 format36
requester_profile_code *stringUnique wallet identification code19
request_control_key *uuidv4Unique request identification key used by the client in uuid v4 format36
account_key *uuidv4Unique account identification key in uuid v4 format36
requester_profile_status *stringWallet statusrequester_profile_status Enumerators
configuration_data *objectWallet default settingsconfiguration_data Object

requester_profile_status Enumerators​

EnumeratorDescription
pendingAccepted wallet pending confirmation
openedOpen wallet

pagination Object​

FieldTypeDescriptionCharacters
current_page *integerCurrent page-
rows_per_page *integerItems per page-

configuration_data Object​

FieldTypeDescriptionCharacters
max_payment_days *integerMaximum calendar days the bank slip will be available for payment after due date (maximum 365)-
write_off_settingsobjectDefault write-off configurationwrite_off_settings Object
protest_settingsobjectDefault protest configurationprotest_settings Object
bankruptcy_protest_settingsobjectDefault bankruptcy protest configurationbankruptcy_protest_settings Object
fine_settingsobjectDefault fine configurationfine_setings Object
interest_settingsobjectDefault interest configurationinterest_settings Object
qr_code_settingsobjectDefault PIX QR Code configuration (for bolePix)qr_code_settings Object
cnab_settingsobjectDefault CNAB file configurationcnab_settings Object

write_off_settings Object​

FieldTypeDescriptionCharacters
days_to_write_off *integerDays after due date for the bank slip to be automatically written off-

protest_settings Object​

FieldTypeDescriptionCharacters
days_to_protest *integerDays after due date for the bank slip to be automatically protested-

bankruptcy_protest_settings Object​

FieldTypeDescriptionCharacters
days_to_bankruptcy_protest *integerDays after due date to automatically start a bankruptcy protest process-

fine_settings Object​

Option 1: absolute value fine (fine_type=absolute)
FieldTypeDescriptionCharacters
fine_type *stringFine typefine_type Enumerators
fine_amount *floatAbsolute value of the fine-
days_to_fine *integerDays after due date for the fine to be charged-
Option 2: percentage value fine (fine_type=percentage)
FieldTypeDescriptionCharacters
fine_type *stringFine typefine_type Enumerators
fine_percentage *integerPercentage value of the fine, from 1 to 100-
days_to_fine *integerDays after due date for the fine to be charged-

fine_type Enumerators​

EnumeratorDescription
absoluteabsolute value
percentagepercentage value

interest_settings Object​

Option 1: interest using absolute values (interest_type=calendar_days_daily_amount or interest_type=workdays_daily_amount)
FieldTypeDescriptionCharacters
interest_type *stringInterest typeinterest_type Enumerators
interest_amount *floatAmount to be charged per time unit (business or calendar days)-
days_to_interest *integerDays after due date to start charging interest-
Option 2: interest using percentage values (interest_type=calendar_days_monthly_percentage)
FieldTypeDescriptionCharacters
interest_type *stringInterest typeinterest_type Enumerators
interest_percentage *integerPercentage to be charged per time unit (business or calendar days)-
days_to_interest *integerDays after due date to start charging interest-

interest_type Enumerators​

EnumeratorDescription
calendar_days_daily_amountDaily amount over calendar days
workdays_daily_amountDaily amount over business days
calendar_days_monthly_percentageMonthly interest percentage charged based on calendar days

qr_code_settings Object​

FieldTypeDescriptionCharacters
pix_key *uuidv4Random type PIX key36
qr_code_on_discharge_enabled *booleanDetermines if QR Code information will appear in the return file (CNAB)-

cnab_settings Object​

FieldTypeDescriptionCharacters
default_bankstringDefault bank layout for CNAB file processingdefault_bank Enumerators
preferred_layoutstringPreferred layout for CNAB filespreferred_layout Enumerators

default_bank Enumerators​

EnumeratorDescription
santanderSantander Bank
itauItaú Bank
bradescoBradesco Bank
qi_scdQI SCD

preferred_layout Enumerators​

EnumeratorDescription
400CNAB 400 Layout
240CNAB 240 Layout

Error Response​

STATUS
4xx
Response Body: Error
{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}
HTTP Code
status		QI Code
code		Title
title		Description (eng)
description		Description (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.
400BKS000012Bad RequestInvalid integer value for page or size query string parameters.Valor inválido para parâmetros de página ou tamanho de página.
404BKS000013Not FoundRequester profile not foundCarteira não encontrada
400BKS000025Bad RequestInvalid bank slip status.Status de boleto inválido.