# QI Tech — Investment-as-a-Service › Boletos (IaaS)
Documentação da QI Tech em texto corrido, para colar em um LLM.
Fonte: https://docs.qitech.com.br
8 página(s).
Índice:
- Introduction (/en/documentation/iaas/boletos/inicio)
- Bankslip Instructions (/en/documentation/iaas/boletos/instrucoes_boleto)
- CNAB Files Retrieval (/en/documentation/iaas/boletos/recuperar_arquivo_retorno)
- Bankslip Retrieval and Second Copy (/en/documentation/iaas/boletos/recuperar_boleto)
- Bankslip Retrieval (/en/documentation/iaas/boletos/recuperar_boletos)
- Bankslip Profiles Retrieval (/en/documentation/iaas/boletos/recuperar_carteiras_cobranca)
- Bankslip Configurations Retrieval (/en/documentation/iaas/boletos/recuperar_configuracoes_boleto)
- Webhooks (/en/documentation/iaas/boletos/webhook)
---
# Introduction
URL: /en/documentation/iaas/boletos/inicio
In this section we will explain how the **billing slip issuance** ecosystem works in the context of a **receivables assignment to Investment Funds**.
## Billing Slip Issuance Structure
The billing slip issuance process within receivables assignment follows the following structure:
1. **Collection account registration and assignment contract generation**
- [5.2.4. Assignment Contract](/documentation/iaas/homologacao_cedente/contrato_de_cessao/pedido_de_contrato)
2. **Billing Slip Registration**
- The billing slip is registered with the issuing bank as soon as the assignment is paid.
- Required information:
- Assignor identification
- Drawee (payer) identification
- Nominal value
- Due date
3. **Registration Confirmation**
- The billing slip registration confirmation is done on the next business day in the bank return processing
4. **Settlement**
- When the billing slip is paid by the drawee, the settlement is captured and updated automatically.
- The financial flow goes to the Fund's main account, composing the available cash.
5. **Write-off**
- If the bill payment is made through an assignor write-off or substitution, the billing slip is written off automatically
:::warning
For billing slip issuance to occur **automatically**, it is mandatory that the **Assignment Contract** contains all necessary collection information and that there is a **collection account properly registered** in the system.
:::
To have access to these services, contact the team at [integracao.dtvm@qitech.com.br](mailto:integracao.dtvm@qitech.com.br), so that the appropriate permissions can be made, both in the Homologation (Sandbox) environment and in the production environment.
---
# Bankslip Instructions
URL: /en/documentation/iaas/boletos/instrucoes_boleto
This endpoint allows you to send instructions to an already registered bankslip, such as a due date extension, an update of interest and fine, the inclusion of discounts, a rebate, a write-off and a protest request.
## Request
ENDPOINT /bankslip_collection/fund_class/ FUND_CLASS_KEY /bankslip_configuration/ BANKSLIP_CONFIGURATION_KEY /bankslip/ BANKSLIP_KEY
METHOD PUT
### Path Parameters
| Field | Type | Description | Characters |
|--------------------------------|--------|------------------------------------------------------------------------|------------|
| `fund_class_key` | uuidv4 | Unique identification key of the fund class, in the uuid v4 format | 36 |
| `bankslip_configuration_key` | uuidv4 | Unique identification key of the bankslip configuration, in the uuid v4 format | 36 |
| `bankslip_key` | uuidv4 | Unique identification key of the bankslip, in the uuid v4 format | 36 |
### Request Body Params
The `occurrence_type` field defines which instruction will be sent to the bankslip. The `occurrence_data` field contains the specific data of the instruction, when applicable.
| Field | Type | Description | Characters |
|-------------------|--------|---------------------------------------------------------------------------|-------------------------------------------------------------------------|
| `occurrence_type` | string | Type of the instruction to be sent to the bankslip. | **[`occurrence_type` enumerators](#occurrence_type-enumerators)** |
| `occurrence_data` | object | Data of the instruction. Required for the types that need extra parameters. | Varies according to the `occurrence_type` |
### `occurrence_type` enumerators
| Enumerator | Description |
|------------------------|-----------------------------------------------------|
| `due_date_extension` | Extension of the due date |
| `delay_interest_update`| Update of the late payment interest |
| `delay_fine_update` | Update of the late payment fine |
| `rebate` | Application of a rebate |
| `rebate_withdrawn` | Cancellation of the rebate |
| `discount_inclusion` | Inclusion of discounts |
| `write_off` | Write-off of the bankslip |
| `protest_request` | Protest request |
---
### Instruction: `due_date_extension` — Due Date Extension
Request Body
```json
{
"occurrence_type": "due_date_extension",
"occurrence_data": {
"due_date": "2026-12-31"
}
}
```
#### `occurrence_data` object — due_date_extension
| Field | Type | Description | Characters |
|------------|--------|---------------------------------------------------|------------|
| `due_date` | string | New due date of the bankslip (`YYYY-MM-DD` format) | 10 |
---
### Instruction: `delay_interest_update` — Late Payment Interest Update
Request Body
```json
{
"occurrence_type": "delay_interest_update",
"occurrence_data": {
"interest": {
"method": "pre_fixed",
"pre_fixed": {
"monthly_rate": 1.5,
"calendar_base": "calendar_360"
}
}
}
}
```
#### `occurrence_data` object — delay_interest_update
| Field | Type | Description |
|------------|--------|---------------------------------------|
| `interest` | object | Configuration of the late payment interest (see below). |
#### `interest` object
| Field | Type | Description |
|--------------|--------|---------------------------------------------------------------|
| `method` | string | Interest calculation method. Value: `pre_fixed` |
| `pre_fixed` | object | Parameters for the pre-fixed interest calculation (see below). |
#### `pre_fixed` object
| Field | Type | Description |
|-----------------|--------|----------------------------------------------------------------------------------------------|
| `monthly_rate` | number | Monthly interest rate (0.01 is equivalent to 1% per month). |
| `calendar_base` | string | Calendar base for the calculation. **[`calendar_base` enumerators](#calendar_base-enumerators)** |
#### `calendar_base` enumerators
| Enumerator | Description |
|-----------------|------------------------|
| `calendar_360` | 360-day base |
| `workdays` | Business days |
| `calendar_365` | 365-day base |
---
### Instruction: `delay_fine_update` — Late Payment Fine Update
Request Body
```json
{
"occurrence_type": "delay_fine_update",
"occurrence_data": {
"fine": {
"fine_type": "percentage",
"percentage_value": 2.0
}
}
}
```
#### `occurrence_data` object — delay_fine_update
| Field | Type | Description |
|--------|--------|----------------------------------------|
| `fine` | object | Configuration of the late payment fine (see below). |
#### `fine` object
| Field | Type | Description |
|--------------------|--------|------------------------------------------------------------------|
| `fine_type` | string | Fine type. Value: `percentage` |
| `percentage_value` | number | Percentage of the fine. It must be greater than or equal to `0`. |
---
### Instruction: `rebate` — Rebate
Request Body
```json
{
"occurrence_type": "rebate",
"occurrence_data": {
"rebate": 50.00
}
}
```
#### `occurrence_data` object — rebate
| Field | Type | Description |
|----------|--------|------------------------------------|
| `rebate` | number | Value of the rebate to be applied. |
---
### Instruction: `rebate_withdrawn` — Rebate Cancellation
This instruction does not require `occurrence_data`.
Request Body
```json
{
"occurrence_type": "rebate_withdrawn"
}
```
---
### Instruction: `discount_inclusion` — Inclusion of Discounts
Request Body
```json
{
"occurrence_type": "discount_inclusion",
"occurrence_data": {
"discounts": [
{
"discount_type": "percentage",
"discount_number": 1,
"discount_limit_date": "2026-11-30",
"discount_amount": 5.0
}
]
}
}
```
#### `occurrence_data` object — discount_inclusion
| Field | Type | Description |
|-------------|-------------|----------------------------------------------------|
| `discounts` | array | List of discounts to be applied (see below). |
#### `discount` object (item of the discounts array)
| Field | Type | Description | Characters |
|-----------------------|--------|----------------------------------------------------------------------------------------------|------------|
| `discount_type` | string | Discount type. **[`discount_type` enumerators](#discount_type-enumerators)** | - |
| `discount_number` | number | Sequential number of the discount. | - |
| `discount_limit_date` | string | Limit date for the application of the discount (`YYYY-MM-DD` format). | 10 |
| `discount_amount` | number | Value of the discount. | - |
#### `discount_type` enumerators
| Enumerator | Description |
|-----------------------------------------------|----------------------------------------------------------------------------|
| `absolute` | Fixed value |
| `percentage` | Fixed percentage |
| `anticipation_workdays_daily_amount` | Daily anticipation value over business days |
| `anticipation_workdays_daily_percentage` | Daily anticipation percentage over business days |
| `anticipation_calendar_days_daily_amount` | Daily anticipation value over calendar days |
| `anticipation_calendar_days_daily_percentage` | Daily anticipation percentage over calendar days |
---
### Instruction: `write_off` — Bankslip Write-Off
This instruction does not require `occurrence_data`.
Request Body
```json
{
"occurrence_type": "write_off"
}
```
---
### Instruction: `protest_request` — Protest Request
Request Body
```json
{
"occurrence_type": "protest_request",
"occurrence_data": {
"protest_type": "protest"
}
}
```
#### `occurrence_data` object — protest_request
| Field | Type | Description |
|----------------|--------|----------------------------------------------------------------------------------------|
| `protest_type` | string | Protest type. **[`protest_type` enumerators](#protest_type-enumerators)** |
#### `protest_type` enumerators
| Enumerator | Description |
|----------------------|------------------------------|
| `protest` | Standard protest |
| `bankruptcy_protest` | Bankruptcy protest |
---
## Response
STATUS 201
Response Body
```json title='Response Body'
{
"bankslip_key": "c9eb109c-800f-4cf5-b209-2119c9d77a72",
"external_participant_control_number": "801KFZFNB4UZ34MLGJG2X9WNG",
"bankslip_configuration": {
"bankslip_configuration_key": "1b382eb7-7006-4389-975b-afa76b0ad7b4",
"bankslip_profile": {
"bankslip_profile_key": "5910d4a3-f5df-432a-902f-849a1a77cd86",
"bankslip_profile_code": "329-09-0001-4993010",
"bankslip_profile_number": 1,
"bankslip_provider": "qi_scd",
"additional_information": {
"external_beneficiary_key": "2666e7a3-0bd7-46fc-8f6b-725f2ef9b13f"
},
"internal_account_key": "6b5335ed-1380-4348-9520-8998ca6e388b",
"fund_class": {
"fund_class_key": "7f03069e-1854-4cee-8e59-a6a548976015",
"document_number": "51.620.927/0001-65",
"name": "Sample Fund Class",
"manager": {
"name": "Sample Manager",
"manager_key": "5cb734e9-c33b-4e7e-bb40-f894aa82b153",
"document_number": "51.620.927/0001-65"
}
}
}
},
"due_date": "2026-12-31",
"face_value": 629.33,
"status": "registered",
"participant_control_number": "801KFZFNB4UZ34MLGJG2X9WNG",
"borrower": {
"document_number": "755.510.684-12",
"name": "Tomador Exemplo",
"person_type": "natural_person",
"address": {
"postal_code": "05425-020"
}
},
"assignor": {
"name": "Cedente LTDA",
"document_number": "37.341.966/0001-00",
"person_type": "legal_person"
},
"bankslip_type": "simple",
"delay": null,
"our_number": "00000012345",
"our_number_digit": "6",
"digitable_line": "32991.23456 78901.234567 89012.345678 9 00010000062933",
"barcode": "32999000010000062933123456789012345678901234",
"occurrences": [
{
"occurrence_key": "e9898e50-cd2b-492f-9201-7e5c5f231853",
"status": "pending_submission",
"type": "due_date_extension",
"occurrence_data": {
"due_date": "2026-12-31"
}
}
],
"settlement_instructions": [
{
"settlement_instruction_key": "fe419363-bf04-4b3a-90bd-185618baa720",
"status": "pending_bankslip_payment",
"asset_type": "duplicata_mercantil",
"asset_key": "22fc5c95-3622-48ad-b26a-99f8d0499e69",
"external_id": "758638e4-6fe6-4b69-8799-30728ca16a22",
"issue_date": "2025-01-17",
"maturity_date": "2026-12-31",
"face_value": 629.33,
"order_number": "49761-1"
}
]
}
```
### Bankslip
| Field | Type | Description |
|---------------------------------------|--------|------------------------------------------------------------------------|
| `bankslip_key` | string | Unique identifier of the bankslip. |
| `external_participant_control_number` | string | External control number of the participant. |
| `bankslip_configuration` | object | Configuration of the bankslip (see below). |
| `due_date` | date | Due date of the bankslip. |
| `face_value` | number | Nominal value of the bankslip. |
| `status` | string | Current status of the bankslip. |
| `participant_control_number` | string | Internal control number of the participant. |
| `borrower` | object | Object representing the drawee (borrower). |
| `assignor` | object | Object representing the assignor of the receivable. |
| `bankslip_type` | string | Bankslip type. |
| `delay` | object | Late payment data of the bankslip, when applicable. |
| `order_number` | string | Order number, when available. |
| `our_number` | string | "Nosso número", when available. |
| `our_number_digit` | string | Check digit of the "nosso número", when available. |
| `digitable_line` | string | Digitable line of the bankslip, when available. |
| `barcode` | string | Barcode of the bankslip, when available. |
| `occurrences` | array | List of occurrences related to the bankslip (each item is an object). |
| `settlement_instructions` | array | List of settlement instructions related to the bankslip. |
### Bankslip Configuration
| Field | Type | Description |
|------------------------------|--------|----------------------------------|
| `bankslip_configuration_key` | string | Configuration key of the bankslip. |
| `bankslip_profile` | object | Associated bankslip profile. |
### Bankslip Profile
| Field | Type | Description |
|----------------------------|--------|--------------------------------------------------------------|
| `bankslip_profile_key` | string | Identifier of the bankslip profile. |
| `bankslip_profile_code` | string | Code of the profile. |
| `bankslip_profile_number` | number | Number of the profile. |
| `bankslip_provider` | string | Provider of the bankslip. |
| `additional_information` | object | Additional information of the profile. |
| `internal_account_key` | string | Identifier of the associated internal account. |
| `fund_class` | object | Object representing the fund class (see below). |
### Fund Class
| Field | Type | Description | Characters |
|-------------------|--------|-------------------------------------------------|------------|
| `fund_class_key` | string | Unique identification key of the fund class | 36 |
| `document_number` | string | CNPJ of the fund class | - |
| `name` | string | Name of the fund class | up to 255 |
### Borrower
| Field | Type | Description |
|-------------------|--------|--------------------------------|
| `name` | string | Name of the drawee. |
| `document_number` | string | Document (CPF/CNPJ). |
| `person_type` | string | Person type. |
| `address` | object | Address of the drawee. |
### Assignor
| Field | Type | Description |
|-------------------|--------|-----------------------|
| `name` | string | Name of the assignor. |
| `document_number` | string | Document (CNPJ). |
| `person_type` | string | Person type. |
### Occurrences
Each item of the array is an object with the following fields:
| Field | Type | Description |
|-------------------|--------|---------------------------------|
| `occurrence_key` | string | Identifier of the occurrence. |
| `status` | string | Status of the occurrence. |
| `type` | string | Type of the occurrence. |
| `occurrence_data` | object | Additional data of the occurrence. |
### Settlement Instructions
Each item of the array is an object with the following fields:
| Field | Type | Description |
|------------------------------|--------|------------------------------------------------------|
| `settlement_instruction_key` | string | Identifier of the settlement instruction. |
| `status` | string | Status of the settlement instruction. |
| `asset_type` | string | Asset type. |
| `asset_key` | string | Unique key of the asset in the system. |
| `external_id` | string | External identifier of the client. |
| `issue_date` | date | Issue date. |
| `maturity_date` | date | Maturity date. |
| `face_value` | number | Face value of the asset. |
| `order_number` | string | Contract number. |
---
## Error Response
STATUS 4xx
Response Body: Error
```json
{
"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` |
|--------------------------|----------------------|-----------------------|--------------------------------------------------------------|------------------------------------------------------------------|
| 400 | QIT000001 | Bad Request | Schema Error | Schema Inválido |
| 404 | BSC000009 | Bankslip not Found | Bankslip with key `{bankslip_key}` was not found. | Boleto com chave `{bankslip_key}` não foi encontrado. |
---
# CNAB Files Retrieval
URL: /en/documentation/iaas/boletos/recuperar_arquivo_retorno
---
## List CNAB files
Returns a paginated list of CNAB files (remittance and return files exchanged with the bank) belonging to a bankslip profile of a fund class.
### Request
ENDPOINT /bankslip_collection/fund_class/FUND_CLASS_KEY/bankslip_profile/BANKSLIP_PROFILE_KEY/cnab_files
METHOD GET
### Path Params
| Parameter | Description |
|------------------------|---------------------------------------------------------------------------------------------------------------------------|
| `fund_class_key` | Key of the fund class. Returns `404` (`NotFoundFundClass`) if it doesn't exist. |
| `bankslip_profile_key` | Key of the bankslip profile, which must belong to the fund class. Returns `404` (`NotFoundBankslipConfiguration`) if not found. |
### Query Params
All parameters are optional.
| Parameter | Type | Description |
|----------------|--------|--------------------------------------------------------------------------------|
| `initial_date` | date | Filters files with `cnab_date` greater than or equal to the given date (YYYY-MM-DD). |
| `final_date` | date | Filters files with `cnab_date` less than or equal to the given date (YYYY-MM-DD). |
| `cnab_type` | string | Filters by file type (see **[CNAB Type](#cnab-type)**). |
| `limit` | int | Value between 0 and 20 with the number of items per page. Default: `10`. |
| `page` | int | Zero-based page number. Default: `0`. |
When `is_last_page` is `false`, request the next `page` to retrieve the remaining results.
### Response
Response Body
```json title='Response Body'
{
"data": [
{
"cnab_file_key": "79f21d3e-ed99-413c-8e05-39cf84fbab7c",
"bankslip_profile": {
"bankslip_profile_key": "a1d7f09b-cb77-48da-a23d-b83d97d4b46b",
"bankslip_profile_code": "329-09-0001-0000000",
"bankslip_profile_number": 9,
"bankslip_provider": "qi_scd",
"additional_information": {
"requester_profile_key": "30f72181-042c-4aae-9be7-b2794916416f"
},
"internal_account_key": "18809219-17d9-4845-a830-51e7f2beaf28",
"fund_class": {
"fund_class_key": "92c63a0f-25d6-45cb-90a2-6026c0ce2ef9",
"document_number": "00.000.000/0001-01",
"name": "FUNDO DE INVESTIMENTO EM DIREITOS CREDITÓRIOS",
"manager": {
"name": "GESTÃO DE RECURSOS",
"manager_key": "7a5ff2f5-f127-451c-98d8-001826c35c3c",
"document_number": "00.100.100/0001-00"
}
}
},
"cnab_date": "2025-07-30",
"type": "return",
"status": "completed",
"download_filename": "cnab-retorno-2025-07-30-79f21d3e.ret",
"url": "https://s3.amazonaws.com/...",
"external_cnab_file_key": "e8b5e962-eb5f-4b9d-8d2b-70cd6d3d5252",
"number_of_occurrences": 6
},
{
"cnab_file_key": "ff7aaa47-a901-4f66-98d7-46f76ca4fa16",
"bankslip_profile": {
"bankslip_profile_key": "e0771a02-4f3e-4162-a468-a872fc6975e4",
"bankslip_profile_code": "329-09-0001-0000000",
"bankslip_profile_number": 9,
"bankslip_provider": "qi_scd",
"additional_information": {
"requester_profile_key": "cdec985f-e629-44ce-8511-a323f38bd63e"
},
"internal_account_key": "5e621ba2-b4ac-4ddd-9893-82d220e1577e",
"fund_class": {
"fund_class_key": "92c63a0f-25d6-45cb-90a2-6026c0ce2ef9",
"document_number": "00.000.000/0001-01",
"name": "FUNDO DE INVESTIMENTO EM DIREITOS CREDITÓRIOS",
"manager": {
"name": "GESTÃO DE RECURSOS",
"manager_key": "7a5ff2f5-f127-451c-98d8-001826c35c3c",
"document_number": "00.100.100/0001-00"
}
}
},
"cnab_date": "2025-07-30",
"type": "external_return",
"status": "completed",
"download_filename": "cnab-retorno-2025-07-30-ff7aaa47.ret",
"url": "https://s3.amazonaws.com/...",
"external_cnab_file_key": "d3b1f7c4-9e2a-4f6b-8c1d-5a7e9b3f2c8e",
"number_of_occurrences": 3,
"bankslip_expenses": [
{
"bankslip_expense_key": "4d727b05-00df-454e-93e3-160ec9ee596c",
"type": "fee_or_costs.payment",
"number_of_expenses": 3,
"total_value": 2.25,
"status": "completed"
}
]
}
],
"limit": 10,
"page": 0,
"is_last_page": true
}
```
### Paginated Object
| Field | Type | Description |
|----------------|---------|------------------------------------------------------|
| `data` | array | List of **[CNAB File](#cnab-file)** objects |
| `limit` | int | Limit of objects retrieved per page |
| `page` | int | Number of the retrieved page |
| `is_last_page` | boolean | Indicates whether the retrieved page is the last one |
### CNAB File
| Field | Type | Description |
|--------------------------|--------|--------------------------------------------------------------------------------------------------------------------|
| `cnab_file_key` | string | Unique identifier of the CNAB file. |
| `bankslip_profile` | object | Associated bankslip profile (see **[Bankslip Profile](/documentation/iaas/boletos/recuperar_boletos#bankslip-profile)**). |
| `cnab_date` | date | Date of the CNAB file. |
| `type` | string | File type (see **[CNAB Type](#cnab-type)**). |
| `status` | string | File status (see **[CNAB Status](#cnab-status)**). |
| `download_filename` | string | Name the file is downloaded with. |
| `url` | string | Pre-signed URL to download the file, valid for **1 hour**. Omitted if it cannot be generated. |
| `external_cnab_file_key` | string | Identifier of the external CNAB file. Only present when the file has this value. |
| `header` | string | File header. Only present when the file has this value. |
| `trailer` | string | File trailer. Only present when the file has this value. |
| `number_of_occurrences` | int | Number of occurrences in the file. Only present when the file has this value. |
| `expectation` | object | Expectation data of the file. Only present when the file has this value. |
| `bankslip_expenses` | array | List of **[Bankslip Expense](#bankslip-expense)** objects. Only present when the file has associated expenses. |
### Bankslip Expense
| Field | Type | Description |
|------------------------|--------|----------------------------------|
| `bankslip_expense_key` | string | Unique identifier of the expense.|
| `type` | string | Expense type. |
| `number_of_expenses` | int | Number of grouped expenses. |
| `total_value` | number | Total value of the expenses. |
| `status` | string | Expense status. |
## CNAB Type
| Enumerator | Description |
|-----------------------|----------------------|
| `return` | Return File |
| `external_return` | External Return File |
| `remittance` | Remittance |
| `external_remittance` | External Remittance |
## CNAB Status
| Enumerator | Description |
|----------------------|--------------------|
| `created` | Created |
| `pending_processing` | Pending processing |
| `completed` | Completed |
| `canceled` | Canceled |
---
# Bankslip Retrieval and Second Copy
URL: /en/documentation/iaas/boletos/recuperar_boleto
---
## Bankslip List
### Request
ENDPOINT /bankslip_collection/fund_class/FUND_CLASS_KEY/bankslip_profile/BANKSLIP_PROFILE_KEY/bankslip/BANKSLIP_KEY
METHOD GET
### Response
Response Body
```json title='Response Body'
{
"bankslip_key": "c9eb109c-800f-4cf5-b209-2119c9d77a72",
"external_participant_control_number": "801KFZFNB4UZ34MLGJG2X9WNG",
"asset_type": "duplicata_mercantil",
"bankslip_configuration": {
"bankslip_configuration_key": "1b382eb7-7006-4389-975b-afa76b0ad7b4",
"bankslip_profile": {
"bankslip_profile_key": "5910d4a3-f5df-432a-902f-849a1a77cd86",
"bankslip_profile_code": "329-09-0001-4993010",
"bankslip_profile_number": 1,
"bankslip_provider": "qi_scd",
"additional_information": {
"external_beneficiary_key": "2666e7a3-0bd7-46fc-8f6b-725f2ef9b13f"
},
"internal_account_key": "6b5335ed-1380-4348-9520-8998ca6e388b",
"fund_class": {
"fund_class_key": "7f03069e-1854-4cee-8e59-a6a548976015",
"document_number": "51.620.927/0001-65",
"name": "Sample_Name",
"manager": {
"name": "Sample name",
"manager_key": "5cb734e9-c33b-4e7e-bb40-f894aa82b153",
"document_number": "51.620.927/0001-65"
}
}
}
},
"due_date": "2026-04-21",
"face_value": 629.33,
"status": "pending_registration",
"participant_control_number": "801KFZFNB4UZ34MLGJG2X9WNG",
"borrower": {
"document_number": "755.510.684-12",
"name": "Tomador",
"person_type": "legal_person",
"address": {
"postal_code": "05425-020"
}
},
"assignor": {
"name": "Assignor LTDA",
"document_number": "37.341.966/0001-00",
"person_type": "legal_person"
},
"occurrences": [
{
"occurrence_key": "e9898e50-cd2b-492f-9201-7e5c5f231853",
"status": "pending_submission",
"type": "registration",
"occurrence_data": null
}
],
"settlement_instructions": [
{
"settlement_instruction_key": "fe419363-bf04-4b3a-90bd-185618baa720",
"status": "pending_bankslip_payment",
"asset_type": "duplicata_mercantil",
"asset_key": "22fc5c95-3622-48ad-b26a-99f8d0499e69",
"external_id": "758638e4-6fe6-4b69-8799-30728ca16a22",
"issue_date": "2025-01-17",
"maturity_date": "2026-09-17",
"face_value": 629.33,
"order_number": "49761-1"
}
],
"bankslip_url": "https://bankslip-proxys-bucket-production.s3.amazonaws.com/"
}
```
### Bankslip
| Field | Type | Description |
|---------------------------------------|----------|----------------------------------------------------------------------|
| `bankslip_key` | string | Unique identifier of the bankslip. |
| `external_participant_control_number` | string | External control number of the participant. |
| `asset_type` | string | Type of the linked asset. |
| `due_date` | date | Due date of the bankslip. |
| `face_value` | number | Nominal value of the bankslip. |
| `status` | string | Current status of the bankslip. |
| `participant_control_number` | string | Internal control number of the participant. |
| `bankslip_configuration` | object | Object containing the bankslip configuration (see below). |
| `borrower` | object | Object representing the drawee (borrower). |
| `assignor` | object | Object representing the assignor of the receivable. |
| `occurrences` | array | List of occurrences related to the bankslip (each item is an object). |
| `settlement_instructions` | array | List of settlement instructions related to the bankslip. |
| `bankslip_url` | array | Link to retrieve the second copy. |
### Bankslip Configuration
| Field | Type | Description |
|--------------------------------------|----------|----------------------------------|
| `bankslip_configuration_key` | string | Configuration key of the bankslip. |
| `bankslip_profile` | object | Associated bankslip profile. |
---
### Bankslip Profile
| Field | Type | Description |
|--------------------------------------|----------|-------------------------------|
| `bankslip_profile_key` | string | Identifier of the bankslip profile. |
| `bankslip_profile_code` | string | Code of the profile. |
| `bankslip_profile_number` | number | Number of the profile. |
| `bankslip_provider` | string | Provider of the bankslip. |
| `additional_information` | object | Additional information (see below). |
| `internal_account_key` | string | Identifier of the associated internal account. |
| `fund_class` | object | Object representing the investment fund (see below). |
### Fund Class
| Field | Type | Description | Characters |
|-------------------------------|----------|---------------------------------------------------|------------|
| `name` | string | Name of the fund class | up to 255 |
| `fund_class_key` | string | Unique identification key of the fund class | 36 |
| `document_number` | string | CNPJ of the fund class | - |
### Borrower
| Field | Type | Description |
|--------------------------------------|----------|-------------------------------|
| `name` | string | Name of the drawee. |
| `document_number` | string | Document (CPF/CNPJ). |
| `person_type` | string | Person type. |
| `address` | object | Address of the drawee (see below). |
### Address
| Field | Type | Description |
|--------------------------------------|----------|-------------------------------|
| `street` | string | Street of the address. |
| `number` | string | Number of the address. |
| `neighborhood` | string | Neighborhood. |
| `city` | string | City. |
| `postal_code` | string | Postal code. |
| `uf` | string | Federative unit (state abbreviation). |
| `country` | string | Country in the ISO Alpha-3 format. |
---
## Assignor (Cedente)
| Field | Type | Description |
|--------------------------------------|----------|-------------------|
| `name` | string | Name of the assignor. |
| `document_number` | string | Document (CNPJ). |
| `person_type` | string | Person type. |
---
## Occurrences
Each item of the array is an object with the following fields:
| Field | Type | Description |
|--------------------------------------|----------|---------------------------------|
| `occurrence_key` | string | Identifier of the occurrence. |
| `status` | string | Status of the occurrence. |
| `type` | string | Type of the occurrence. |
| `occurrence_data` | object | Additional data of the occurrence. |
## Settlement Instructions
Each item of the array is an object with the following fields:
| Field | Type | Description |
|-------------------------------|----------|------------------------------------------------------|
| `settlement_instruction_key` | string | Identifier of the settlement instruction. |
| `status` | string | Status of the settlement instruction. |
| `asset_type` | string | Asset type. |
| `asset_key` | string | Unique key of the asset in the system. |
| `external_id` | string | External identifier of the client (used in the assignment). |
| `issue_date` | date | Issue date. |
| `maturity_date` | date | Maturity date. |
| `face_value` | number | Face value of the asset. |
| `order_number` | string | Contract number. |
| `installment_number` | number | Installment number of the asset. |
---
# Bankslip Retrieval
URL: /en/documentation/iaas/boletos/recuperar_boletos
---
## Bankslip List
### Request
ENDPOINT /bankslip_collection/fund_class/FUND_CLASS_KEY/bankslip_profile/BANKSLIP_PROFILE_KEY/bankslips
METHOD GET
### Query Params
| Parameter | Description |
|------------------------------|------------------------------------------------------------|
| `limit` | Value between 0 and 100 with the number of items per page. |
| `page` | Page number (starting from zero). |
| `borrower_document_number` | Borrower document number (numbers only). |
| `assignor_document_number` | Assignor document number (numbers only). |
| `participant_control_number` | Participant control number. |
| `order_number` | Contract number. |
| `our_number` | Our bankslip number at the bank. |
### Response
Response Body
```json title='Response Body'
{
"data": [
{
"bankslip_key": "c9eb109c-800f-4cf5-b209-2119c9d77a72",
"external_participant_control_number": "801KFZFNB4UZ34MLGJG2X9WNG",
"asset_type": "duplicata_mercantil",
"bankslip_configuration": {
"bankslip_configuration_key": "1b382eb7-7006-4389-975b-afa76b0ad7b4",
"bankslip_profile": {
"bankslip_profile_key": "5910d4a3-f5df-432a-902f-849a1a77cd86",
"bankslip_profile_code": "329-09-0001-4993010",
"bankslip_profile_number": 1,
"bankslip_provider": "qi_scd",
"additional_information": {
"external_beneficiary_key": "2666e7a3-0bd7-46fc-8f6b-725f2ef9b13f"
},
"internal_account_key": "6b5335ed-1380-4348-9520-8998ca6e388b",
"fund_class": {
"fund_class_key": "7f03069e-1854-4cee-8e59-a6a548976015",
"document_number": "51.620.927/0001-65",
"name": "Sample_Name",
"manager": {
"name": "Sample name",
"manager_key": "5cb734e9-c33b-4e7e-bb40-f894aa82b153",
"document_number": "51.620.927/0001-65"
}
}
}
},
"due_date": "2024-02-17",
"face_value": 629.33,
"status": "pending_registration",
"participant_control_number": "801KFZFNB4UZ34MLGJG2X9WNG",
"borrower": {
"document_number": "755.510.684-12",
"name": "Tomador",
"person_type": "legal_person",
"address": {
"postal_code": "05425-020"
}
},
"assignor": {
"name": "Assignor LTDA",
"document_number": "37.341.966/0001-00",
"person_type": "legal_person"
},
"occurrences": [
{
"occurrence_key": "e9898e50-cd2b-492f-9201-7e5c5f231853",
"status": "pending_submission",
"type": "registration",
"occurrence_data": null
}
]
},
{
"bankslip_key": "4584e60c-752f-479d-831a-50f09c2c7de2",
"external_participant_control_number": "TBFBDWKTEWJ7UTR6CPL4BAE4P",
"asset_type": "duplicata_mercantil",
"bankslip_configuration": {
"bankslip_configuration_key": "1b382eb7-7006-4389-975b-afa76b0ad7b4",
"bankslip_profile": {
"bankslip_profile_key": "5910d4a3-f5df-432a-902f-849a1a77cd86",
"bankslip_profile_code": "329-09-0001-4993010",
"bankslip_profile_number": 1,
"bankslip_provider": "qi_scd",
"additional_information": {
"external_beneficiary_key": "2666e7a3-0bd7-46fc-8f6b-725f2ef9b13f"
},
"internal_account_key": "6b5335ed-1380-4348-9520-8998ca6e388b",
"fund_class": {
"fund_class_key": "7f03069e-1854-4cee-8e59-a6a548976015",
"document_number": "51.620.927/0001-65",
"name": "Sample_Name",
"manager": {
"name": "Sample name",
"manager_key": "5cb734e9-c33b-4e7e-bb40-f894aa82b153",
"document_number": "51.620.927/0001-65"
}
}
}
},
"due_date": "2024-02-17",
"face_value": 629.33,
"status": "pending_registration",
"participant_control_number": "TBFBDWKTEWJ7UTR6CPL4BAE4P",
"borrower": {
"document_number": "784.508.035-78",
"name": "mgkstsdibe",
"person_type": "legal_person",
"address": {
"postal_code": "05425-020"
}
},
"assignor": {
"name": "Assignor LTDA",
"document_number": "37.341.966/0001-00",
"person_type": "legal_person"
},
"occurrences": [
{
"occurrence_key": "07ad7fce-fec6-40ac-be22-1ffd031f36bc",
"status": "pending_submission",
"type": "registration",
"occurrence_data": null
}
]
}
],
"limit": 15,
"page": 0,
"is_last_page": true
}
```
### Paginated Object
| Field | Type | Description |
|---------------|----------|----------------------------------------------------------------|
| `data` | array | List of **[Bankslip](#bankslip)** objects |
| `limit` | int | Limit of objects retrieved per page |
| `page` | int | Retrieved page number |
| `is_last_page`| boolean | Information indicating if the retrieved page is the last one |
### Bankslip
| Field | Type | Description |
|---------------------------------------|----------|-----------------------------------------------------------------|
| `bankslip_key` | string | Unique bankslip identifier. |
| `external_participant_control_number` | string | External participant control number. |
| `asset_type` | string | Linked asset type. |
| `due_date` | date | Bankslip due date. |
| `face_value` | number | Bankslip face value. |
| `status` | string | Current bankslip status. |
| `participant_control_number` | string | Internal participant control number. |
| `bankslip_configuration` | object | Object containing the bankslip configuration (see below). |
| `borrower` | object | Object representing the borrower (payer). |
| `assignor` | object | Object representing the receivables assignor. |
| `occurrences` | array | List of bankslip-related occurrences (each item is an object). |
| `settlement_instructions` | array | List of settlement instructions related to the bankslip. |
### Bankslip Configuration
| Field | Type | Description |
|--------------------------------------|----------|----------------------------------|
| `bankslip_configuration_key` | string | Bankslip configuration key. |
| `bankslip_profile` | object | Associated bankslip profile. |
---
### Bankslip Profile
| Field | Type | Description |
|--------------------------------------|----------|-------------------------------|
| `bankslip_profile_key` | string | Bankslip profile identifier. |
| `bankslip_profile_code` | string | Profile code. |
| `bankslip_profile_number` | number | Profile number. |
| `bankslip_provider` | string | Bankslip provider. |
| `additional_information` | object | Additional information (see below). |
| `internal_account_key` | string | Associated internal account identifier. |
| `fund_class` | object | Object representing the investment fund (see below). |
### Fund Class
| Field | Type | Description | Characters |
|-------------------------------|----------|---------------------------------------------------|------------|
| `name` | string | Fund class name | up to 255 |
| `fund_class_key` | string | Fund class unique identification key | 36 |
| `document_number` | string | Fund class CNPJ | - |
### Borrower
| Field | Type | Description |
|--------------------------------------|----------|-------------------------------|
| `name` | string | Borrower name. |
| `document_number` | string | Document (CPF/CNPJ). |
| `person_type` | string | Person type. |
| `address` | object | Borrower address (see below). |
### Address
| Field | Type | Description |
|--------------------------------------|----------|-------------------------------|
| `street` | string | Address street. |
| `number` | string | Address number. |
| `neighborhood` | string | Neighborhood. |
| `city` | string | City. |
| `postal_code` | string | Postal code. |
| `uf` | string | Federative unit (state abbreviation). |
| `country` | string | Country in ISO Alpha-3 format. |
---
## Assignor (Cedente)
| Field | Type | Description |
|--------------------------------------|----------|-------------------|
| `name` | string | Assignor name. |
| `document_number` | string | Document (CNPJ). |
| `person_type` | string | Person type. |
---
## Occurrences
Each array item is an object with the following fields:
| Field | Type | Description |
|--------------------------------------|----------|---------------------------------|
| `occurrence_key` | string | Occurrence identifier. |
| `status` | string | Occurrence status. |
| `type` | string | Occurrence type. |
| `occurrence_data` | object | Additional occurrence data. |
## Settlement Instructions
Each array item is an object with the following fields:
| Field | Type | Description |
|-------------------------------|----------|------------------------------------------------------|
| `settlement_instruction_key` | string | Settlement instruction identifier. |
| `status` | string | Settlement instruction status. |
| `asset_type` | string | Asset type. |
| `asset_key` | string | Unique key of the asset in the system. |
| `external_id` | string | Client's external identifier (used in the assignment). |
| `issue_date` | date | Issue date. |
| `maturity_date` | date | Maturity date. |
| `face_value` | number | Face value of the asset. |
| `order_number` | string | Contract number. |
| `installment_number` | number | Installment number of the asset. |
---
# Bankslip Profiles Retrieval
URL: /en/documentation/iaas/boletos/recuperar_carteiras_cobranca
---
## List bankslip profiles
Returns a paginated list of the bankslip profiles of a fund class. Access is granted only to the manager responsible for the fund class.
### Request
ENDPOINT /bankslip_collection/fund_class/FUND_CLASS_KEY/bankslip_profiles
METHOD GET
### Path Params
| Parameter | Description |
|------------------|-----------------------------------------------------------------------------------|
| `fund_class_key` | Key of the fund class. Returns `404` (`NotFoundFundClass`) if it doesn't exist. |
### Query Params
All parameters are optional.
| Parameter | Type | Description |
|-----------|------|-----------------------------------------------------------------------|
| `limit` | int | Value between 0 and 50 with the number of items per page. Default: `10`. |
| `page` | int | Zero-based page number. Default: `0`. |
When `is_last_page` is `false`, request the next `page` to retrieve the remaining results.
### Response
Response Body
```json title='Response Body'
{
"data": [
{
"bankslip_profile_key": "a1d7f09b-cb77-48da-a23d-b83d97d4b46b",
"bankslip_profile_code": "329-09-0001-0000000",
"bankslip_profile_number": 9,
"bankslip_provider": "qi_scd",
"additional_information": {
"requester_profile_key": "30f72181-042c-4aae-9be7-b2794916416f"
},
"internal_account_key": "18809219-17d9-4845-a830-51e7f2beaf28",
"fund_class": {
"fund_class_key": "92c63a0f-25d6-45cb-90a2-6026c0ce2ef9",
"document_number": "00.000.000/0001-01",
"name": "FUNDO DE INVESTIMENTO EM DIREITOS CREDITÓRIOS",
"manager": {
"name": "GESTÃO DE RECURSOS",
"manager_key": "7a5ff2f5-f127-451c-98d8-001826c35c3c",
"document_number": "00.100.100/0001-00"
}
},
"total_value": 12345.67,
"total_overdue_value": 890.12
},
{
"bankslip_profile_key": "e0771a02-4f3e-4162-a468-a872fc6975e4",
"bankslip_profile_code": "329-09-0001-0000001",
"bankslip_profile_number": 10,
"bankslip_provider": "qi_scd",
"additional_information": {
"requester_profile_key": "cdec985f-e629-44ce-8511-a323f38bd63e"
},
"internal_account_key": "5e621ba2-b4ac-4ddd-9893-82d220e1577e",
"fund_class": {
"fund_class_key": "92c63a0f-25d6-45cb-90a2-6026c0ce2ef9",
"document_number": "00.000.000/0001-01",
"name": "FUNDO DE INVESTIMENTO EM DIREITOS CREDITÓRIOS",
"manager": {
"name": "GESTÃO DE RECURSOS",
"manager_key": "7a5ff2f5-f127-451c-98d8-001826c35c3c",
"document_number": "00.100.100/0001-00"
}
}
}
],
"limit": 10,
"page": 0,
"is_last_page": true,
"elapsed_time_ms": 12.34
}
```
### Paginated Object
| Field | Type | Description |
|-------------------|---------|----------------------------------------------------------|
| `data` | array | List of **[Bankslip Profile](#bankslip-profile)** objects |
| `limit` | int | Limit of objects retrieved per page |
| `page` | int | Number of the retrieved page |
| `is_last_page` | boolean | Indicates whether the retrieved page is the last one |
| `elapsed_time_ms` | number | Server-side query execution time, in milliseconds |
### Bankslip Profile
| Field | Type | Description |
|---------------------------|--------|-------------------------------------------------------------------------------------------------------------------|
| `bankslip_profile_key` | string | Identifier of the bankslip profile. |
| `bankslip_profile_code` | string | Profile code. |
| `bankslip_profile_number` | number | Profile number. |
| `bankslip_provider` | string | Bankslip provider. |
| `additional_information` | object | Additional information of the profile. |
| `internal_account_key` | string | Identifier of the associated internal account. |
| `fund_class` | object | Object representing the fund class (see **[Fund Class](/documentation/iaas/boletos/recuperar_boletos#fund-class)**). |
| `total_value` | number | Total outstanding value of the profile. Only present after the profile's periodic balance calculation. |
| `total_overdue_value` | number | Total overdue value of the profile. Only present after the profile's periodic balance calculation. |
---
# Bankslip Configurations Retrieval
URL: /en/documentation/iaas/boletos/recuperar_configuracoes_boleto
---
## List bankslip configurations
Returns a paginated list of the bankslip configurations of a bankslip profile within a fund class. Access is granted only to the manager responsible for the fund class.
### Request
ENDPOINT /bankslip_collection/fund_class/FUND_CLASS_KEY/bankslip_profile/BANKSLIP_PROFILE_KEY/bankslip_configurations
METHOD GET
### Path Params
| Parameter | Description |
|------------------------|-------------------------------------------------------------------------------------------------------------------------|
| `fund_class_key` | Key of the fund class. Returns `404` (`NotFoundFundClass`) if it doesn't exist. |
| `bankslip_profile_key` | Key of the bankslip profile, which must belong to the fund class. Returns `404` (`NotFoundBankslipProfile`) if not found. |
### Query Params
All parameters are optional.
| Parameter | Type | Description |
|---------------|--------|-----------------------------------------------------------------------------------------------------------------|
| `issuer_type` | string | Filters by issuer type (see **[Issuer Type](#issuer-type)**). An unknown value returns an `InvalidValueForEntity` error. |
| `limit` | int | Value between 0 and 30 with the number of items per page. Default: `10`. |
| `page` | int | Zero-based page number. Default: `0`. |
When `is_last_page` is `false`, request the next `page` to retrieve the remaining results.
### Response
Response Body
```json title='Response Body'
{
"data": [
{
"bankslip_configuration_key": "1b382eb7-7006-4389-975b-afa76b0ad7b4",
"bankslip_profile": {
"bankslip_profile_key": "a1d7f09b-cb77-48da-a23d-b83d97d4b46b",
"bankslip_profile_code": "329-09-0001-0000000",
"bankslip_profile_number": 9,
"bankslip_provider": "qi_scd",
"additional_information": {
"requester_profile_key": "30f72181-042c-4aae-9be7-b2794916416f"
},
"internal_account_key": "18809219-17d9-4845-a830-51e7f2beaf28",
"fund_class": {
"fund_class_key": "92c63a0f-25d6-45cb-90a2-6026c0ce2ef9",
"document_number": "00.000.000/0001-01",
"name": "FUNDO DE INVESTIMENTO EM DIREITOS CREDITÓRIOS",
"manager": {
"name": "GESTÃO DE RECURSOS",
"manager_key": "7a5ff2f5-f127-451c-98d8-001826c35c3c",
"document_number": "00.100.100/0001-00"
}
}
},
"bankslip_issuer_type": "manager",
"delay": 0,
"our_number_range": {
"our_number_range_initial": 1,
"our_number_range_final": 99999
}
},
{
"bankslip_configuration_key": "9c47d1a8-3f2e-4b6d-8a1c-5e7f9b3d2c80",
"bankslip_profile": {
"bankslip_profile_key": "a1d7f09b-cb77-48da-a23d-b83d97d4b46b",
"bankslip_profile_code": "329-09-0001-0000000",
"bankslip_profile_number": 9,
"bankslip_provider": "qi_scd",
"additional_information": {
"requester_profile_key": "30f72181-042c-4aae-9be7-b2794916416f"
},
"internal_account_key": "18809219-17d9-4845-a830-51e7f2beaf28",
"fund_class": {
"fund_class_key": "92c63a0f-25d6-45cb-90a2-6026c0ce2ef9",
"document_number": "00.000.000/0001-01",
"name": "FUNDO DE INVESTIMENTO EM DIREITOS CREDITÓRIOS",
"manager": {
"name": "GESTÃO DE RECURSOS",
"manager_key": "7a5ff2f5-f127-451c-98d8-001826c35c3c",
"document_number": "00.100.100/0001-00"
}
}
},
"bankslip_issuer_type": "internal",
"delay": 1
}
],
"limit": 10,
"page": 0,
"is_last_page": true,
"elapsed_time_ms": 12.34
}
```
### Paginated Object
| Field | Type | Description |
|-------------------|---------|--------------------------------------------------------------------|
| `data` | array | List of **[Bankslip Configuration](#bankslip-configuration)** objects |
| `limit` | int | Limit of objects retrieved per page |
| `page` | int | Number of the retrieved page |
| `is_last_page` | boolean | Indicates whether the retrieved page is the last one |
| `elapsed_time_ms` | number | Server-side query execution time, in milliseconds |
### Bankslip Configuration
| Field | Type | Description |
|------------------------------|--------|------------------------------------------------------------------------------------------------------------------------------|
| `bankslip_configuration_key` | string | Unique identifier of the bankslip configuration. |
| `bankslip_profile` | object | Associated bankslip profile (see **[Bankslip Profile](/documentation/iaas/boletos/recuperar_boletos#bankslip-profile)**). |
| `bankslip_issuer_type` | string | Bankslip issuer type (see **[Issuer Type](#issuer-type)**). |
| `delay` | int | Delay configured for bankslip issuance. |
| `our_number_range` | object | "Nosso número" range assigned to the configuration (see **[Our Number Range](#our-number-range)**). Only present when the configuration has a range assigned. |
### Our Number Range
| Field | Type | Description |
|----------------------------|------|--------------------------------------|
| `our_number_range_initial` | int | Start of the "nosso número" range. |
| `our_number_range_final` | int | End of the "nosso número" range. |
## Issuer Type
| Enumerator | Description |
|--------------|-------------|
| `internal` | Internal |
| `manager` | Manager |
| `consultant` | Consultant |
---
# Webhooks
URL: /en/documentation/iaas/boletos/webhook
Throughout the bankslip life cycle, the system sends webhooks to notify the integrating partner about status changes. All the events use the `bankslip_collection.bankslip_status_change` type.
:::info Webhook configuration
To receive webhooks, you need to have a callback URL configured with QI Tech. Contact [integracao@qitech.com.br](mailto:integracao@qitech.com.br) to set it up.
:::
## Webhook structure
All the bankslip webhooks follow the same base structure:
| Field | Type | Description |
|---|---|---|
| `webhook_type` | string | Webhook type. Always `bankslip_collection.bankslip_status_change`. |
| `webhook_datetime` | string | Date and time of the event in the ISO 8601 format. |
| `data` | object | Data of the event. See the table below. |
#### `data` attributes
| Field | Type | Description |
|---|---|---|
| `bankslip_key` | string (UUID) | Unique identifier of the bankslip. |
| `bankslip_configuration_key` | string (UUID) | Identifier of the bankslip configuration. |
| `bankslip_profile_key` | string (UUID) | Identifier of the bankslip profile. |
| `status` | string | Current status of the bankslip. |
| `fund_class` | object | Data of the fund class associated with the bankslip. |
| `external_participant_control_number` | string | External control number of the participant. |
| `participant_control_number` | string | Internal control number of the participant. |
| `face_value` | float | Face value of the bankslip. |
| `due_date` | string | Due date in the `YYYY-MM-DD` format. |
| `borrower` | object | Data of the drawee (debtor). |
| `assignor` | object | Data of the assignor. |
| `settlement_instructions` | array | List of settlement instructions linked to the bankslip. |
| `our_number` | integer | **(Optional)** "Nosso número" assigned by the issuing bank. |
| `our_number_digit` | string | **(Optional)** Check digit of the "nosso número". |
| `order_number` | string | **(Optional)** Order number. |
| `digitable_line` | string | **(Optional)** Digitable line of the bankslip. Present when available after the registration. |
| `barcode` | string | **(Optional)** Barcode of the bankslip. Present when available after the registration. |
#### `fund_class` attributes
| Field | Type | Description |
|---|---|---|
| `document_number` | string | CNPJ of the fund class. |
| `fund_class_key` | string (UUID) | Identifier of the fund class. |
| `name` | string | Name of the fund class. |
#### `settlement_instructions` attributes
| Field | Type | Description |
|---|---|---|
| `asset_key` | string (UUID) | Identifier of the associated asset. |
| `asset_type` | string | Asset type (e.g. `duplicata_mercantil`, `duplicata_servicos`, `ccb`). |
| `issue_date` | string | Issue date of the asset in the `YYYY-MM-DD` format. |
| `maturity_date` | string | Maturity date of the asset in the `YYYY-MM-DD` format. |
| `face_value` | float | Face value of the asset. |
| `status` | string | Status of the settlement instruction. |
| `external_id` | string | **(Optional)** External identifier of the asset. |
| `installment_number` | integer | **(Optional)** Installment number, when applicable (e.g. installment CCBs). |
| `order_number` | string | **(Optional)** Order number of the instruction. |
---
## Events by status
### Bankslip Registration
STATUS pending_registration
Sent when a bankslip is created and submitted to the issuing bank for registration. The bankslip awaits confirmation from the banking institution. Depending on the bank, the `digitable_line`, `barcode` and `our_number` fields may be present when the bank returns them immediately upon registration. For other banks, those fields are filled in only after the confirmation via the return file.
```json title='Webhook Body'
{
"webhook_type": "bankslip_collection.bankslip_status_change",
"webhook_datetime": "2026-04-15T12:55:35Z",
"data": {
"bankslip_key": "7a26c259-1b1f-4d73-9a5b-48230022b8f2",
"bankslip_configuration_key": "b6b4ff70-917c-4003-bc4d-ebc4ccdd606c",
"bankslip_profile_key": "5666937c-944a-44c6-98e6-3591f99fe4ff",
"status": "pending_registration",
"fund_class": {
"document_number": "17.645.194/0001-85",
"fund_class_key": "d81118d0-527b-45b0-8c60-76e9d3ab3aa3",
"name": "Nome da Classe do Fundo"
},
"external_participant_control_number": "XO0QYVBF1JU9LFBBKGT7XYQV9",
"participant_control_number": "XO0QYVBF1JU9LFBBKGT7XYQV9",
"face_value": 629.33,
"due_date": "2026-09-17",
"borrower": {
"document_number": "631.430.668-06",
"name": "Nome do Sacado",
"person_type": "natural_person",
"address": {
"postal_code": "05425-020"
}
},
"assignor": {
"name": "Nome do Cedente",
"document_number": "37.341.966/0001-00",
"person_type": "legal_person"
},
"settlement_instructions": [
{
"asset_key": "22fc5c95-3622-48ad-b26a-99f8d0499e69",
"external_id": "758638e4-6fe6-4b69-8799-30728ca16a22",
"asset_type": "duplicata_mercantil",
"issue_date": "2025-01-17",
"maturity_date": "2026-09-17",
"face_value": 629.33,
"status": "pending_bankslip_payment"
}
],
"our_number": 10507,
"our_number_digit": "0"
}
}
```
---
### Bankslip Registered
STATUS registered
Sent when the issuing bank **confirms the registration** of the bankslip. From this moment on, the bankslip is ready for payment by the drawee. In this webhook, the `digitable_line`, `barcode`, `our_number` and `our_number_digit` fields will be present.
```json title='Webhook Body'
{
"webhook_type": "bankslip_collection.bankslip_status_change",
"webhook_datetime": "2026-04-15T13:10:22Z",
"data": {
"bankslip_key": "7a26c259-1b1f-4d73-9a5b-48230022b8f2",
"bankslip_configuration_key": "b6b4ff70-917c-4003-bc4d-ebc4ccdd606c",
"bankslip_profile_key": "5666937c-944a-44c6-98e6-3591f99fe4ff",
"status": "registered",
"fund_class": {
"document_number": "17.645.194/0001-85",
"fund_class_key": "d81118d0-527b-45b0-8c60-76e9d3ab3aa3",
"name": "Nome da Classe do Fundo"
},
"external_participant_control_number": "XO0QYVBF1JU9LFBBKGT7XYQV9",
"participant_control_number": "XO0QYVBF1JU9LFBBKGT7XYQV9",
"face_value": 629.33,
"due_date": "2026-09-17",
"borrower": {
"document_number": "631.430.668-06",
"name": "Nome do Sacado",
"person_type": "natural_person",
"address": {
"postal_code": "05425-020"
}
},
"assignor": {
"name": "Nome do Cedente",
"document_number": "37.341.966/0001-00",
"person_type": "legal_person"
},
"settlement_instructions": [
{
"asset_key": "22fc5c95-3622-48ad-b26a-99f8d0499e69",
"external_id": "758638e4-6fe6-4b69-8799-30728ca16a22",
"asset_type": "duplicata_mercantil",
"issue_date": "2025-01-17",
"maturity_date": "2026-09-17",
"face_value": 629.33,
"status": "pending_bankslip_payment"
}
],
"our_number": 10507,
"our_number_digit": "0",
"digitable_line": "03399.87654 32100.012345 67890.123456 1 00000000062933",
"barcode": "03391000000000629333987654321000123456789012345"
}
}
```
---
### Bankslip Rejected
STATUS rejected
Sent when the issuing bank **rejects the registration** of the bankslip. The bankslip will not be available for payment and will not advance in the flow. The linked settlement instructions are also marked as `rejected`.
```json title='Webhook Body'
{
"webhook_type": "bankslip_collection.bankslip_status_change",
"webhook_datetime": "2026-04-15T13:10:22Z",
"data": {
"bankslip_key": "7a26c259-1b1f-4d73-9a5b-48230022b8f2",
"bankslip_configuration_key": "b6b4ff70-917c-4003-bc4d-ebc4ccdd606c",
"bankslip_profile_key": "5666937c-944a-44c6-98e6-3591f99fe4ff",
"status": "rejected",
"fund_class": {
"document_number": "17.645.194/0001-85",
"fund_class_key": "d81118d0-527b-45b0-8c60-76e9d3ab3aa3",
"name": "Nome da Classe do Fundo"
},
"external_participant_control_number": "XO0QYVBF1JU9LFBBKGT7XYQV9",
"participant_control_number": "XO0QYVBF1JU9LFBBKGT7XYQV9",
"face_value": 629.33,
"due_date": "2026-09-17",
"borrower": {
"document_number": "631.430.668-06",
"name": "Nome do Sacado",
"person_type": "natural_person",
"address": {
"postal_code": "05425-020"
}
},
"assignor": {
"name": "Nome do Cedente",
"document_number": "37.341.966/0001-00",
"person_type": "legal_person"
},
"settlement_instructions": [
{
"asset_key": "22fc5c95-3622-48ad-b26a-99f8d0499e69",
"external_id": "758638e4-6fe6-4b69-8799-30728ca16a22",
"asset_type": "duplicata_mercantil",
"issue_date": "2025-01-17",
"maturity_date": "2026-09-17",
"face_value": 629.33,
"status": "rejected"
}
],
"our_number": 10507,
"our_number_digit": "0"
}
}
```
---
### Bankslip Written Off
STATUS written_off
Sent when the bankslip is **written off** at the issuing institution. This can happen upon a cancellation request.
```json title='Webhook Body'
{
"webhook_type": "bankslip_collection.bankslip_status_change",
"webhook_datetime": "2026-04-15T14:30:00Z",
"data": {
"bankslip_key": "7a26c259-1b1f-4d73-9a5b-48230022b8f2",
"bankslip_configuration_key": "b6b4ff70-917c-4003-bc4d-ebc4ccdd606c",
"bankslip_profile_key": "5666937c-944a-44c6-98e6-3591f99fe4ff",
"status": "written_off",
"fund_class": {
"document_number": "17.645.194/0001-85",
"fund_class_key": "d81118d0-527b-45b0-8c60-76e9d3ab3aa3",
"name": "Nome da Classe do Fundo"
},
"external_participant_control_number": "XO0QYVBF1JU9LFBBKGT7XYQV9",
"participant_control_number": "XO0QYVBF1JU9LFBBKGT7XYQV9",
"face_value": 629.33,
"due_date": "2026-09-17",
"borrower": {
"document_number": "631.430.668-06",
"name": "Nome do Sacado",
"person_type": "natural_person",
"address": {
"postal_code": "05425-020"
}
},
"assignor": {
"name": "Nome do Cedente",
"document_number": "37.341.966/0001-00",
"person_type": "legal_person"
},
"settlement_instructions": [
{
"asset_key": "22fc5c95-3622-48ad-b26a-99f8d0499e69",
"external_id": "758638e4-6fe6-4b69-8799-30728ca16a22",
"asset_type": "duplicata_mercantil",
"issue_date": "2025-01-17",
"maturity_date": "2026-09-17",
"face_value": 629.33,
"status": "written_off"
}
],
"our_number": 10507,
"our_number_digit": "0",
"digitable_line": "03399.87654 32100.012345 67890.123456 1 00000000062933",
"barcode": "03391000000000629333987654321000123456789012345"
}
}
```