List Bank Slips

The bank slip listing will return all bank slips from the wallet that fit the query parameters sent in the request.

Request

ENDPOINT

/account/ACCOUNT_KEY/requester_profile/REQUESTER_PROFILE_KEY/bank_slips

METHOD

GET

Path parameters

Field	Type	Description	Characters
account_key	uuidv4	Unique account identification key, in uuid v4 format	36
requester_profile_key	uuidv4	Unique wallet identification key, in uuid v4 format	36

Query parameters

Field	Type	Description	Characters
request_control_key	uuidv4	Unique request identification key, in uuid v4 format	36
bank_slip_key	uuidv4	Unique bank slip identification key, in uuid v4 format	36
bank_slip_status	string	Bank slip status	bank_slip_status Enumerators
page	integer	Page number	-
page_size	integer	Page size	-
from_date	string	Initial registration date (format "YYYY-MM-DD")	10
to_date	string	Final registration date (format "YYYY-MM-DD")	10

Enumeradores bank_slip_status

Enumerator	Description
accepted	Accepted and sent to Nuclea/CIP for analysis
rejected	Registration rejected by Nuclea/CIP
payment_notice	Payment notice (bank slip paid but payment not yet settled)
notary_office_payment_notice	Notary office payment notice (bank slip paid but payment not yet settled)
registered	Registration confirmed by Nuclea/CIP
payment_blocked	Blocked for payment (in protest flow)
paid	Paid
written_off	Written off

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

Field	Type	Description	Characters
data *	object array	Bank slips	bank_slip Object
pagination *	object	Pagination information	pagination Object

Objeto bank_slip

Field	Type	Description	Characters
bank_slip_key *	uuidv4	Unique bank slip identification key in uuid v4 format	36
request_control_key *	uuidv4	Unique request identification key used by the client in uuid v4 format	36
our_number *	integer	Unique identification number of the bank slip within the wallet	11
bank_slip_status *	string	Bank slip status	bank_slip_status Enumerators
protest_status *	string	Bank slip protest status at notary office	protest_status Enumerators
document_number *	string	Bank slip identification number	10
amount *	float	Bank slip base amount	-
expiration *	string	Due date	10
barcode *	string	Bank slip barcode	44
digitable_line *	string	Bank slip digitable line	47
bank_teller_instructions	string	Additional registration instructions, which will appear on the bank slip PDF	320
rebate_amount	float	Bank slip rebate amount, which will be applied on top of the base amount	-
max_payment_days *	integer	Maximum calendar days the bank slip will remain available for payment after due date (can be at most 365)	-
write_off_data	object	Write-off configuration	write_off_data Object
protest_data	object	Protest configuration	protest_data Object
bankruptcy_protest_data	object	Bankruptcy protest configuration	bankruptcy_protest_data Object
fine_data	object	Fine configuration	fine_data Object
interest_data	object	Interest configuration	interest_data Object
discounts_data	object array	Discounts	discount Object
payer_data *	object	Payer data	payer_data Object
guarantor_data *	object	Guarantor data	guarantor_data Object

Objeto pagination

Field	Type	Description	Characters
current_page *	integer	Current page	-
rows_per_page *	integer	Items per page	-

Enumeradores protest_status

Enumerator	Description
not_protested	Bank slip without protest flow initiated
protest_requested	Notary office protest requested
notary_office_entry	Bank slip at notary office, in three-day period
protest_cancel_requested	Protest withdrawal requested
notary_office_exit	Bank slip left notary office
protested	Bank slip protested
paid_at_notary_office	Paid at notary office
judicially_suspended	Protest judicially suspended
protest_remove_requested	Protest removal requested

Objeto write_off_data

Field	Type	Description	Characters
days_to_write_off *	integer	Days after due date for the bank slip to be automatically written off	-

Objeto protest_data

Field	Type	Description	Characters
days_to_protest *	integer	Days after due date for the bank slip to be automatically protested	-

Objeto bankruptcy_protest_data

Field	Type	Description	Characters
days_to_bankruptcy_protest *	integer	Days after due date for the bank slip to be automatically protested	-

Objeto fine_data

Option 1: fine in absolute value (fine_type=absolute)

Field	Type	Description	Characters
fine_type *	string	Fine type	fine_type Enumerators
fine_amount *	float	Fine absolute value	-
days_to_fine *	integer	Days after due date for the fine to be charged	-

Option 2: fine in percentage value (fine_type=percentage)

Field	Type	Description	Characters
fine_type *	string	Fine type	fine_type Enumerators
fine_percentage *	integer	Fine percentage value, from 1 to 100	-
days_to_fine *	integer	Days after due date for the fine to be charged	-

Enumeradores fine_type

Enumerator	Description
absolute	absolute value
percentage	percentage value

Objeto interest_data

Option 1: interest using absolute values (interest_type=calendar_days_daily_amount or interest_type=workdays_daily_amount)

Field	Type	Description	Characters
interest_type *	string	Interest type	interest_type Enumerators
interest_amount *	float	Amount to be charged per determined time unit (workdays or calendar days)	-
days_to_interest *	integer	Days after due date to start charging interest	-

Option 2: interest using percentage values (interest_type=calendar_days_monthly_percentage)

Field	Type	Description	Characters
interest_type *	string	Interest type	interest_type Enumerators
interest_percentage *	integer	Percentage to be charged per determined time unit (workdays or calendar days)	-
days_to_interest *	integer	Days after due date to start charging interest	-

Enumeradores interest_type

Enumerator	Description
calendar_days_daily_amount	Daily amount on calendar days
workdays_daily_amount	Daily amount on workdays
calendar_days_monthly_percentage	Monthly interest percentage charged, based on calendar days

Objeto discount

Option 1: discounts using absolute values (discount_type in ["absolute", "anticipation_calendar_days_daily_amount", "anticipation_workdays_daily_amount"])

Field	Type	Description	Characters
discount_amount *	float	Absolute discount value per time unit	-
discount_number *	integer	Discount number	-
discount_type *	string	Discount configuration in absolute values	discount_type Enumerator
discount_limit_date *	string	Limit date for discount application	10

Option 2: discounts using percentage values (discount_type in ["percentage", "anticipation_calendar_days_daily_percentage", "anticipation_workdays_daily_percentage"])

Field	Type	Description	Characters
discount_percentage *	float	Percentage discount value per time unit	-
discount_number *	integer	Discount number	-
discount_type *	string	Discount configuration in percentage values	discount_type Enumerator
discount_limit_date *	string	Limit date for discount application	10

Attention!

The bank slip can have up to three discounts, and all discounts must be of the same type, that is, they must have the same discount_type. Discounts must be numbered from 1 to 3, incrementally and starting necessarily at 1. That is, if two discounts are sent in the request, they must necessarily be numbered 1 and 2.

Enumeradores discount_type

Enumerator	Description
absolute	Fixed value
anticipation_calendar_days_daily_amount	Daily anticipation discount value, on calendar days
anticipation_workdays_daily_amount	Daily anticipation discount value, on workdays
percentage	Fixed percentage
anticipation_calendar_days_daily_percentage	Monthly anticipation discount percentage, based on calendar days
anticipation_workdays_daily_percentage	Annual anticipation discount percentage, based on workdays

Objetos payer_data e guarantor_data

Field	Type	Description	Characters
name *	string	Full name	100
document_number *	string	Document number (CPF/CNPJ)	11 or 14
person_type *	string	Person type (natural or legal)	person_type Enumerators
contact	object	Contact information	contact Object
address	object	Address	address Object

Enumeradores person_type

Enumerator	Description
natural	natural person
legal	legal person

Objeto contact

Field	Type	Description	Characters
email	string	Contact email	320
phone	object	Contact phone	phone Object

Objeto phone

Field	Type	Description	Characters
international_dial_code *	string	International dialing code	3
area_code *	string	Area code	2
number *	string	Number	9

Objeto address

Field	Type	Description	Characters
street *	string	Street	500
number *	string	Number	6
complement	string	Complement	500
neighborhood *	string	Neighborhood	100
postal_code *	string	Postal code	8
city *	string	City	100
state *	string	State	state Enumerator

Enumeradores state

Enumerator	Description
AC	Acre
AL	Alagoas
AM	Amazonas
AP	Amapá
BA	Bahia
CE	Ceará
DF	Distrito federal
ES	Espírito Santo
GO	Goiás
MA	Maranhão
MG	Minas Gerais
MS	Mato Grosso do Sul
MT	Mato Grosso
PA	Pará
PB	Paraíba
PE	Pernambuco
PI	Piauí
PR	Paraná
RJ	Rio de Janeiro
RN	Rio Grande do Norte
RO	Rondônia
RR	Roraima
RS	Rio Grande do Sul
SC	Santa Catarina
SE	Sergipe
SP	São Paulo
TO	Tocantins
EX	Exception

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 (pt-br) translation
403	BKS000005	Forbidden	User is not allowed to do this action	Usuário não tem autorização para fazer essa ação
404	BKS000006	Not Found	The source account key was not found.	A chave da conta de origem não foi encontrada.
400	BKS000007	Bad Request	It 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.
400	BKS000008	Bad Request	The source account is closed.	A conta de origem está fechada.
400	BKS000009	Bad Request	The source account is blocked.	A conta de origem está bloqueada.
400	BKS000012	Bad Request	Invalid integer value for page or size query string parameters.	Valor inválido para parâmetros de página ou tamanho de página.
404	BKS000013	Not Found	Requester profile not found	Carteira não encontrada