# QI Tech — Banking-as-a-Service › Boletos

Documentação da QI Tech em texto corrido, para colar em um LLM.
Fonte: https://docs.qitech.com.br
57 página(s).

Índice:
- Create Wallet (/en/documentation/boletos/carteira/criar_carteira)
- Edit wallet (/en/documentation/boletos/carteira/editar_carteira)
- List Account Wallets (/en/documentation/boletos/carteira/listar_carteiras)
- Query temporary file (/en/documentation/boletos/cnab/consulta_por_chave)
- Remittance files (CNAB) - Introduction (/en/documentation/boletos/cnab/introducao)
- List temporary remittance files (/en/documentation/boletos/cnab/listar_arquivos_temporarios)
- List temporary occurrences (/en/documentation/boletos/cnab/listar_ocorrencias_temporarias)
- Upload CNAB file (/en/documentation/boletos/cnab/upload_de_arquivo_remessa)
- Query bank slip by key (/en/documentation/boletos/consulta/consulta_por_chave)
- List Bank Slips (/en/documentation/boletos/consulta/listar_boletos)
- Daily position report in Excel (/en/documentation/boletos/consultar_v1/posicao_diaria_excel)
- Daily position report in JSON (/en/documentation/boletos/consultar_v1/posicao_diaria_json)
- Solicitar 2ª via de boleto (/en/documentation/boletos/consultar_v1/segunda_via_de_boleto)
- Emissão de boleto único (instantânea) (/en/documentation/boletos/emissao/emissao_boleto_unico_instantanea)
- Emissão de boleto único (padrão) (/en/documentation/boletos/emissao/emissao_boleto_unico_padrao)
- Emissão de boletos em lote (/en/documentation/boletos/emissao/emissao_em_lote)
- Rebate cancellation (/en/documentation/boletos/instrucoes/abatimento/cancelar_abatimento)
- Create Rebate (/en/documentation/boletos/instrucoes/abatimento/criar_abatimento)
- Write-off (/en/documentation/boletos/instrucoes/baixa)
- Discount (/en/documentation/boletos/instrucoes/desconto)
- Edit (/en/documentation/boletos/instrucoes/edicao)
- Extension (/en/documentation/boletos/instrucoes/extensao)
- Interest (/en/documentation/boletos/instrucoes/juros)
- Query instruction batch (/en/documentation/boletos/instrucoes/lote/consultar_lote_de_instrucoes)
- Create instruction batch (/en/documentation/boletos/instrucoes/lote/criar_lote_de_instrucoes)
- List instruction batches (/en/documentation/boletos/instrucoes/lote/listar_lotes_de_instrucoes)
- Fine (/en/documentation/boletos/instrucoes/multa)
- Partial Payment (/en/documentation/boletos/instrucoes/pagamento_parcial)
- Protest instrument query (/en/documentation/boletos/instrucoes/protesto/consulta_instrumento_de_protesto)
- Query protest by key (/en/documentation/boletos/instrucoes/protesto/consulta_por_chave)
- Protest withdrawal (protest stoppage) (/en/documentation/boletos/instrucoes/protesto/desistencia_de_protesto)
- Protest withdrawal (stay) and bank slip write-off (/en/documentation/boletos/instrucoes/protesto/desistencia_de_protesto_e_baixa_do_boleto)
- Introduction (/en/documentation/boletos/instrucoes/protesto/introducao)
- List protests (/en/documentation/boletos/instrucoes/protesto/listar_protestos)
- Protest request (/en/documentation/boletos/instrucoes/protesto/pedido_de_protesto)
- Protest Removal (/en/documentation/boletos/instrucoes/protesto/sustacao_de_protesto)
- Credit Split Update (/en/documentation/boletos/instrucoes/rateio_de_credito)
- Amount (/en/documentation/boletos/instrucoes/valor)
- Introduction (/en/documentation/boletos/introducao)
- List settlement groups (/en/documentation/boletos/liquidacao/listar_grupos_de_liquidacao)
- List Settlements (/en/documentation/boletos/liquidacao/listar_liquidacoes)
- Scenario simulation (/en/documentation/boletos/liquidacao/simulacao_de_cenarios_de_liquidacao)
- List discharge files (/en/documentation/boletos/retorno/listar_arquivos_retorno)
- Bank Slip Webhooks (/en/documentation/boletos/webhooks/boleto)
- Bank slip wallet webhooks (/en/documentation/boletos/webhooks/carteira)
- Settlement webhooks (/en/documentation/boletos/webhooks/liquidacao)
- Return file Webhooks (/en/documentation/boletos/webhooks/retorno)
- Open bank slip ownership exchange batch (/en/documentation/troca_de_titularidade/abrir_lote)
- Approve Bank Slip Ownership Exchange Batch (/en/documentation/troca_de_titularidade/aprovar_lote)
- Cancel bank slip ownership exchange batch (/en/documentation/troca_de_titularidade/cancelar_lote)
- Include bank slips in an ownership exchange batch (/en/documentation/troca_de_titularidade/incluir_boletos)
- Introduction (/en/documentation/troca_de_titularidade/introducao)
- List bank slips from an ownership exchange batch (/en/documentation/troca_de_titularidade/listar_boletos_lote)
- List bank slip ownership exchange batches - destination (/en/documentation/troca_de_titularidade/listar_lotes_destino)
- List bank slip ownership exchange batches - source (/en/documentation/troca_de_titularidade/listar_lotes_origem)
- Remove boletos from an ownership exchange batch (/en/documentation/troca_de_titularidade/remover_boletos)
- Send bank slip ownership exchange batch (/en/documentation/troca_de_titularidade/validar_lote_e_enviar)

---

# Create Wallet

URL: /en/documentation/boletos/carteira/criar_carteira

:::danger Important
To register bolePix, it is necessary that an active random Pix key exists in the account where the boletos will be registered.
:::

Boleto wallets have a unique identification code (`requester_profile_code`) and specific default configurations for payment, discharge, protest, etc. of the boleto. The same account can have multiple boleto wallets, which allows the user to create multiple wallets with different default configurations. This dynamic facilitates the generation of boletos, with different configurations, in a more agile and automatic manner.

:::info Information
For all accounts, a boleto wallet is created with the client's default configurations. This default configuration pattern can be changed by contacting our support (suporte.baas@qitech.com.br). After account creation, it is also possible to change the account fees using the [**fee configuration endpoint**](/documentation/contas/consulta_de_tarifas).
:::

:::caution Attention!
The creation of boleto wallets is an asynchronous flow. After approval/rejection of wallet creation by CIP/Nuclea, the requester will be notified via [**webhook**](/documentation/boletos/v2/webhooks/carteira) about the result of such request.
:::

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile
METHOD POST

### Path parameters

| Field                   | Type   | Description                                                    | Characters |
|-------------------------|--------|--------------------------------------------------------------|------------|
| `account_key`           | uuidv4 | Unique account identification key, in uuid v4 format    | 36         |

Request Body

```json
{
  "request_control_key": "0868a24b-4a69-4138-ac4d-ecaeddf0005f",
  "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"
    }
  }
}
```

### Request Body Params

| Field                      | Type    | Description                                                                          | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|------------|
| `request_control_key` *    | uuidv4  | Unique request identification key used by the client in uuid v4 format  | 36         |
| `configuration_data` *     | object  | Wallet default configurations  | **[configuration_data Object](#configuration_data-object)** |

### configuration_data Object

| Field                      | Type    | Description                                                                          | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|------------|
| `max_payment_days` *      | integer | Maximum calendar days the boleto will remain available for payment after due date (can be at most 365) | -          |
| `write_off_settings`       | object  | Default discharge configuration      | **[write_off_settings Object](#write_off_settings-object)** |
| `protest_settings`         | object  | Default protest configuration       | **[protest_settings Object](#protest_settings-object)** |
| `bankruptcy_protest_settings` | object  | Default bankruptcy protest configuration | **[bankruptcy_protest_settings Object](#bankruptcy_protest_settings-object)** |
| `fine_settings`            | object  | Default fine configuration                 | **[fine_settings Object](#fine_settings-object)** |
| `interest_settings`        | object  | Default interest configuration        | **[interest_settings Object](#interest_settings-object)** |
| `qr_code_settings`         | object  | Default PIX QR Code configuration (for bolePix) | **[qr_code_settings Object](#qr_code_settings-object)** |
| `cnab_settings`            | object  | Default CNAB files configuration | **[cnab_settings Object](#cnab_settings-object)** |

### write_off_settings Object

| Field                     | Type    | Description                                                                   | Characters |
|---------------------------|---------|-----------------------------------------------------------------------------|------------|
| `days_to_write_off` *     | integer | Days after due date for the boleto to be automatically discharged     | -          |

### protest_settings Object
| Field                     | Type    | Description                                                                   | Characters |
|---------------------------|---------|-----------------------------------------------------------------------------|------------|
| `days_to_protest` *       | integer | Days after due date for the boleto to be automatically protested  | -          |

### bankruptcy_protest_settings Object

| Field                          | Type    | Description                                                                   | Characters  |
|--------------------------------|---------|-----------------------------------------------------------------------------|-------------|
| `days_to_bankruptcy_protest` * | integer | Days after due date for a bankruptcy protest process to be automatically initiated  | -           |

### fine_settings Object

Option 1: absolute amount fine (`fine_type=absolute`)

| Field                     | Type    | Description                                               | Characters                |
|---------------------------|---------|---------------------------------------------------------|-------------------------------------------------------------------------|
| `fine_type` *             | string  | Type of fine                                                       | **[fine_type Enumerators](#fine_type-enumerators)**                                              |
| `fine_amount` *           | float   | Absolute amount of the fine                                             | -                                                                        |
| `days_to_fine` *          | integer | Days after due date for the fine to be charged              | -                                                                        |

Option 2: percentage fine (`fine_type=percentage`)

| Field                     | Type    | Description                                                 | Characters                             |
|---------------------------|---------|-----------------------------------------------------------|---------------------------------------|
| `fine_type` *             | string  | Type of fine                                             | **[fine_type Enumerators](#fine_type-enumerators)** |
| `fine_percentage` *       | integer | Percentage amount of the fine, from 1 to 100                     | -                                      |
| `days_to_fine` *          | integer | Days after due date for the fine to be charged    | -                                      |

### fine_type Enumerators

| Enumerator         | Description             |
|--------------------|-----------------------|
| absolute           | absolute amount        |
| percentage         | percentage amount      |

### interest_settings Object

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

| Field                     | Type    | Description                                                                     | Characters                                                                                      |
|---------------------------|---------|-------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
| `interest_type` *         | string  | Type of interest       | **[interest_type Enumerators](#interest_type-enumerators)** |
| `interest_amount` *       | float   | Amount to be charged per determined time unit (business days or calendar days) | -                                                                                               |
| `days_to_interest` *      | integer | Days after due date to start charging interest                    | -                                                                                               |

Option 2: interest using percentage amounts (`interest_type=calendar_days_monthly_percentage`)

| Field                    | Type    | Description                                                                             | Characters                                                                                          |
|--------------------------|---------|---------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
| `interest_type` *        | string  | Type of interest       | **[interest_type Enumerators](#interest_type-enumerators)** |
| `interest_percentage` *  | integer | Percentage to be charged per determined time unit (business days or calendar days)                                                                      | -                                                                           |
| `days_to_interest` *     | integer | Days after due date to start charging interest                             | -                                                                                                   |

### interest_type Enumerators

| Enumerator                       | Description                                                            |
|----------------------------------|----------------------------------------------------------------------|
| calendar_days_daily_amount       | Daily amount over calendar days                                     |
| workdays_daily_amount            | Daily amount over business days                                        |
| calendar_days_monthly_percentage | Interest percentage charged monthly, based on calendar days |

### qr_code_settings Object

| Field                            | Type    | Description                                                                   | Characters  |
|----------------------------------|---------|-----------------------------------------------------------------------------|-------------|
| `pix_key` *                      | uuidv4  | Random type Pix key                                                 | 36          |
| `qr_code_on_discharge_enabled` * | boolean | Determines if QR Code information will appear in the return file (CNAB)  | -           |

:::info Information
The PIX copy and paste will be returned in the CNAB file at position 029 to 105.
:::

:::caution Attention!
If the `qr_code_settings` object is sent in the request, this wallet will have bolePix generation as its default configuration . BolePix are boletos whose payment is linked to a PIX QR Code. Therefore, the payer can make payment of the boletos either using their readable lines, or by reading the linked PIX QR Codes. If payment is made via QR Code, financial settlement happens instantly. Regarding notifications, two webhooks are sent: one upon PIX transfer (payment notice, boleto goes to `payment_notice` status); and another a few seconds or minutes later, after confirmation of discharge at CIP/Nuclea (paid, boleto goes to `paid` status).
:::

### cnab_settings Object

| Field                            | Type    | Description                                                                   | Characters  |
|----------------------------------|---------|-----------------------------------------------------------------------------|-------------|
| `default_bank`                   | string  | Default bank layout for CNAB file processing                            | **[default_bank Enumerators](#default_bank-enumerators)** |
| `preferred_layout`               | string  | Preferred layout for CNAB files                                         | **[preferred_layout Enumerators](#preferred_layout-enumerators)** |

### default_bank Enumerators

| Enumerator         | Description             |
|--------------------|-----------------------|
| santander          | Santander Bank       |
| itau               | Itaú Bank            |
| bradesco           | Bradesco Bank        |
| qi_scd             | QI SCD                |

### preferred_layout Enumerators

| Enumerator         | Description             |
|--------------------|-----------------------|
| 400                | CNAB 400 Layout       |
| 240                | CNAB 240 Layout       |

## Response

STATUS 202

Response Body

```json
{
  "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"
    }
  }
}

```

### Response Body Params

| Field                      | Type    | Description                                                                          | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------------------|
| `requester_profile_key` *  | uuidv4  | Unique wallet identification key in uuid v4 format  | 36      |
| `requester_profile_code` * | string  | Unique wallet identification code                    | 19      |
| `request_control_key` *    | uuidv4  | Unique request identification key used by the client in uuid v4 format | 36 |
| `account_key` *            | uuidv4  | Unique account identification key in uuid v4 format | 36 |
| `requester_profile_status` * | string | Wallet status | **[requester_profile_status Enumerators](#requester_profile_status-enumerators)** |
| `configuration_data` * | object | Wallet default configurations | **[configuration_data Object](#configuration_data-object)** |

### profile_status Enumerators

| Enumerator                       | Description                                                            |
|----------------------------------|----------------------------------------------------------------------|
| pending                          | Wallet accepted and pending confirmation                            |

## 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<br/>`status` | QI Code<br/>`code` | Title<br/>`title`                                 | Description (eng)<br/>`description`                                                                                       | Description (pt-br)<br/>`translation`                                                                                     |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 400                      | QIT000001            | Bad Request                                        | Schema Error                                                                                                            | Schema Inválido                                                                                                         |
| 404                      | BKS000001            | Not Found | Person not found with key: {`person_key`}`                                               | Pessoa não encontrada com a chave: {`person_key`}`                                               |
| 404                      | BKS000004            | Not Found | Pix key not found: `{pix_key}`                                               | Chave pix não encontrada: `{pix_key}`                                               |
| 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.                                                                 |
| 403                      | BKS000010            | Forbidden                                 | The pix key owner does not match the account owner.                                                                                     | O proprietário da chave pix não corresponde ao proprietário da conta.                                                             |
| 409                      | BKS000014            | Conflict           | Request control key already sent or duplicated sent: `{request_control_key}`                                                              | Chave de controle da requisição já utilizada ou enviada duplicada: `{request_control_key}`                                                                        |
| 400                      | BKS000047            | Bad Request             | It was not possible to consult the sent pix key at this time. Please try again in a few minutes.          | Não foi possível consultar a chave pix enviada no momento. Por favor, tente novamente em alguns minutos.                                                           |

---

# Edit wallet

URL: /en/documentation/boletos/carteira/editar_carteira

Wallet editing overrides the default settings (`configuration_data`) of the bill wallet and all its child objects.

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY
METHOD PUT

### 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         |

Request Body

```json
{
  "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": "248ebea3-9bdd-44b3-a8b9-7f2bd34cd7bf",
    "qr_code_on_discharge_enabled": false
  },
  "cnab_settings": {
    "default_bank": "qi_scd",
    "preferred_layout": "400"
  }
}
```

### Request Body Params

| Field                      | Type    | Description                                                                        | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|------------|
| `max_payment_days` *      | integer | Maximum calendar days the bill will remain available for payment after due date (can be at most 365) | -          |
| `write_off_settings`       | object  | Default write-off configuration      | **[write_off_settings object](#write_off_settings-object)** |
| `protest_settings`         | object  | Default protest configuration       | **[protest_settings object](#protest_settings-object)** |
| `bankruptcy_protest_settings` | object  | Default bankruptcy protest configuration | **[bankruptcy_protest_settings object](#bankruptcy_protest_settings-object)** |
| `fine_settings`            | object  | Default fine configuration                 | **[fine_settings object](#fine_settings-object)** |
| `interest_settings`        | object  | Default interest configuration        | **[interest_settings object](#interest_settings-object)** |
| `qr_code_settings`         | object  | Default PIX QR Code configuration (for bolePix) | **[qr_code_settings object](#qr_code_settings-object)** |
| `cnab_settings`            | object  | Default CNAB file configuration | **[cnab_settings object](#cnab_settings-object)** |

### write_off_settings object

| Field                     | Type    | Description                                                                 | Characters |
|---------------------------|---------|-----------------------------------------------------------------------------|------------|
| `days_to_write_off` *     | integer | Days after due date for the bill to be automatically written off           | -          |

### protest_settings object
| Field                     | Type    | Description                                                                 | Characters |
|---------------------------|---------|-----------------------------------------------------------------------------|------------|
| `days_to_protest` *       | integer | Days after due date for the bill to be automatically protested             | -          |

### bankruptcy_protest_settings object

| Field                          | Type    | Description                                                                 | Characters  |
|--------------------------------|---------|-----------------------------------------------------------------------------|-------------|
| `days_to_bankruptcy_protest` * | integer | Days after due date for a bankruptcy protest process to be automatically started  | -           |

### fine_settings object

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

| Field                     | Type    | Description                                               | Characters                |
|---------------------------|---------|---------------------------------------------------------|-------------------------------------------------------------------------|
| `fine_type` *             | string  | Fine type                                                       | **[fine_type enumerators](#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: percentage value fine (`fine_type=percentage`)

| Field                     | Type    | Description                                                 | Characters                             |
|---------------------------|---------|-----------------------------------------------------------|---------------------------------------|
| `fine_type` *             | string  | Fine type                                             | **[fine_type enumerators](#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    | -                                      |

### fine_type enumerators

| Enumerator         | Description           |
|--------------------|-----------------------|
| absolute           | absolute value        |
| percentage         | percentage value      |

### interest_settings object

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_type-enumerators)** |
| `interest_amount` *       | float   | Amount to be charged per determined time unit (business days 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_type-enumerators)** |
| `interest_percentage` *  | integer | Percentage to be charged per determined time unit (business days or calendar days)                                                                      | -                                                                           |
| `days_to_interest` *     | integer | Days after due date to start charging interest                             | -                                                                                                   |

### interest_type enumerators

| Enumerator                       | Description                                                      |
|----------------------------------|------------------------------------------------------------------|
| calendar_days_daily_amount       | Daily amount on calendar days                                    |
| workdays_daily_amount            | Daily amount on business days                                    |
| calendar_days_monthly_percentage | Monthly interest percentage charged based on calendar days      |

### qr_code_settings object

| Field                            | Type    | Description                                                                 | Characters  |
|----------------------------------|---------|-----------------------------------------------------------------------------|-------------|
| `pix_key` *                      | uuidv4  | Random type Pix key                                                         | 36          |
| `qr_code_on_discharge_enabled` * | boolean | Determines if QR Code information will appear in the return file (CNAB)    | -           |

:::info Information
The PIX copy and paste will be returned in the CNAB file at positions 029 to 105.
:::

:::caution Attention!
If the `qr_code_settings` object is sent in the request, this wallet will have bolePix generation as its default configuration . BolePix are bills whose payment is linked to a Pix QR Code. Therefore, the payer can make bill payments both using the bill's digital lines and by reading the linked Pix QR Codes. If payment is made via QR Code, financial settlement occurs instantly. Regarding notifications, two webhooks are sent: one at the time of the PIX transfer (payment notice, bill goes to `payment_notice` status); and another a few seconds or minutes later, after confirmation of discharge at CIP/Nuclea (paid, bill goes to `paid` status).
:::

### cnab_settings object

| Field                            | Type    | Description                                                                 | Characters  |
|----------------------------------|---------|-----------------------------------------------------------------------------|-------------|
| `default_bank`                   | string  | Default bank layout for CNAB file processing                            | **[default_bank enumerators](#default_bank-enumerators)** |
| `preferred_layout`               | string  | Preferred layout for CNAB files                                         | **[preferred_layout enumerators](#preferred_layout-enumerators)** |

### default_bank enumerators

| Enumerator         | Description           |
|--------------------|-----------------------|
| santander          | Banco Santander       |
| itau               | Banco Itaú            |
| bradesco           | Banco Bradesco        |
| qi_scd             | QI SCD                |

### preferred_layout enumerators

| Enumerator         | Description           |
|--------------------|-----------------------|
| 400                | CNAB 400 Layout       |
| 240                | CNAB 240 Layout       |

## Response

STATUS 200

Response Body

```json
{
  "requester_profile_key": "c92e8666-e310-4a72-b15e-753525684ae2",
  "requester_profile_code": "329-48-2628-2625918",
  "request_control_key": "727a5f00-1f86-4a7a-9aa5-c45cf8a2394c",
  "account_key": "e0089187-ab08-42c0-82f2-259d40726117",
  "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": "248ebea3-9bdd-44b3-a8b9-7f2bd34cd7bf",
      "qr_code_on_discharge_enabled": false
    },
    "cnab_settings": {
      "default_bank": "qi_scd",
      "preferred_layout": "400"
    }
  }
}
```

### Response Body Params

| Field                      | Type    | Description                                                                        | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------------------|
| `requester_profile_key` *  | uuidv4  | Unique wallet identification key in uuid v4 format  | 36      |
| `requester_profile_code` * | string  | Unique wallet identification code                    | 19      |
| `request_control_key` *    | uuidv4  | Unique request identification key used by the client in uuid v4 format | 36 |
| `account_key` *            | uuidv4  | Unique account identification key in uuid v4 format | 36 |
| `requester_profile_status` * | string | Wallet status | **[requester_profile_status enumerators](#requester_profile_status-enumerators)** |
| `configuration_data` * | object | Default wallet configurations | **[configuration_data object](#configuration_data-object)** |

### profile_status enumerators

| Enumerator                       | Description                                                      |
|----------------------------------|------------------------------------------------------------------|
| pending                          | Wallet accepted and pending confirmation                         |
| opened                           | Wallet opened                                                    |

## Error Response

STATUS 4xx

Response Body: Error

```json
{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}
```

| HTTP Status<br/>`status` | QI Code<br/>`code` | Title<br/>`title`                                 | Description (eng)<br/>`description`                                                                                       | Description (pt-br)<br/>`translation`                                                                                     |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 400                      | QIT000001            | Bad Request                                        | Schema Error                                                                                                            | Schema Inválido                                                                                                         |
| 404                      | BKS000001            | Not Found | Person not found with key: {`person_key`}`                                               | Pessoa não encontrada com a chave: {`person_key`}`                                               |
| 404                      | BKS000004            | Not Found | Pix key not found: `{pix_key}`                                               | Chave pix não encontrada: `{pix_key}`                                               |
| 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.                                                                 |
| 403                      | BKS000010            | Forbidden                                 | The pix key owner does not match the account owner.                                                                                     | O proprietário da chave pix não corresponde ao proprietário da conta.                                                             |
| 409                      | BKS000014            | Conflict           | Request control key already sent or duplicated sent: `{request_control_key}`                                                              | Chave de controle da requisição já utilizada ou enviada duplicada: `{request_control_key}`                                                                        |
| 400                      | BKS000047            | Bad Request             | It was not possible to consult the sent pix key at this time. Please try again in a few minutes.          | Não foi possível consultar a chave pix enviada no momento. Por favor, tente novamente em alguns minutos.                                                           |

---

# List Account Wallets

URL: /en/documentation/boletos/carteira/listar_carteiras

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

| Field                   | Type   | Description                                                  | Characters |
|-------------------------|--------|--------------------------------------------------------------|------------|
| `account_key`           | uuidv4 | Unique account 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         |
| `requester_profile_key`  | uuidv4 | Unique bank slip wallet identification key, in uuid v4 format             | 36         |
| `requester_profile_code` | string | Unique wallet identification code                                         | 19         |
| `page`                   | integer| Page number                                                               | -          |
| `page_size`              | integer| Page size                                                                 | -          |

## Response

STATUS 200

Response Body

```json
{
  "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

| Field          | Type         | Description                       | Characters                                                |
|----------------|--------------|-----------------------------------|-----------------------------------------------------------|
| `data` *       | object array | Bank slip wallets                 | **[requester_profile Object](#requester_profile-object)** |
| `pagination` * | object       | Pagination information            | **[pagination Object](#pagination-object)**               |

### requester_profile Object

| Field                      | Type    | Description                                                                        | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------------------|
| `requester_profile_key` *  | uuidv4  | Unique wallet identification key in uuid v4 format                               | 36      |
| `requester_profile_code` * | string  | Unique wallet identification code                                                 | 19      |
| `request_control_key` *    | uuidv4  | Unique request identification key used by the client in uuid v4 format           | 36 |
| `account_key` *            | uuidv4  | Unique account identification key in uuid v4 format                              | 36 |
| `requester_profile_status` * | string | Wallet status                                                                    | **[requester_profile_status Enumerators](#requester_profile_status-enumerators)** |
| `configuration_data` * | object | Wallet default settings                                                           | **[configuration_data Object](#configuration_data-object)** |

### requester_profile_status Enumerators

| Enumerator                       | Description                                                      |
|----------------------------------|------------------------------------------------------------------|
| pending                          | Accepted wallet pending confirmation                             |
| opened                           | Open wallet                                                      |

### pagination Object

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

### configuration_data Object

| Field                      | Type    | Description                                                                        | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|------------|
| `max_payment_days` *      | integer | Maximum calendar days the bank slip will be available for payment after due date (maximum 365) | -          |
| `write_off_settings`       | object  | Default write-off configuration                                                    | **[write_off_settings Object](#write_off_settings-object)** |
| `protest_settings`         | object  | Default protest configuration                                                      | **[protest_settings Object](#protest_settings-object)** |
| `bankruptcy_protest_settings` | object  | Default bankruptcy protest configuration                                        | **[bankruptcy_protest_settings Object](#bankruptcy_protest_settings-object)** |
| `fine_settings`            | object  | Default fine configuration                                                         | **[fine_setings Object](#fine_settings-object)** |
| `interest_settings`        | object  | Default interest configuration                                                     | **[interest_settings Object](#interest_settings-object)** |
| `qr_code_settings`         | object  | Default PIX QR Code configuration (for bolePix)                                   | **[qr_code_settings Object](#qr_code_settings-object)** |
| `cnab_settings`            | object  | Default CNAB file configuration                                                    | **[cnab_settings Object](#cnab_settings-object)** |

### write_off_settings Object

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

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

### bankruptcy_protest_settings Object

| Field                          | Type    | Description                                                                 | Characters  |
|--------------------------------|---------|-----------------------------------------------------------------------------|-------------|
| `days_to_bankruptcy_protest` * | integer | Days after due date to automatically start a bankruptcy protest process    | -           |

### fine_settings Object

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

| Field                     | Type    | Description                                             | Characters                |
|---------------------------|---------|---------------------------------------------------------|-------------------------------------------------------------------------|
| `fine_type` *             | string  | Fine type                                                                   | **[fine_type Enumerators](#fine_type-enumerators)**                                              |
| `fine_amount` *           | float   | Absolute value of the fine                                                  | -                                                                        |
| `days_to_fine` *          | integer | Days after due date for the fine to be charged                             | -                                                                        |

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

| Field                     | Type    | Description                                               | Characters                             |
|---------------------------|---------|-----------------------------------------------------------|---------------------------------------|
| `fine_type` *             | string  | Fine type                                                 | **[fine_type Enumerators](#fine_type-enumerators)** |
| `fine_percentage` *       | integer | Percentage value of the fine, from 1 to 100             | -                                      |
| `days_to_fine` *          | integer | Days after due date for the fine to be charged          | -                                      |

### fine_type Enumerators

| Enumerator         | Description           |
|--------------------|-----------------------|
| absolute           | absolute value        |
| percentage         | percentage value      |

### interest_settings Object

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_type-enumerators)** |
| `interest_amount` *       | float   | Amount to be charged per time unit (business 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_type-enumerators)** |
| `interest_percentage` *  | integer | Percentage to be charged per time unit (business or calendar days)                     | -                                                                           |
| `days_to_interest` *     | integer | Days after due date to start charging interest                                         | -                                                                                                   |

### interest_type Enumerators

| Enumerator                       | Description                                                      |
|----------------------------------|------------------------------------------------------------------|
| calendar_days_daily_amount       | Daily amount over calendar days                                  |
| workdays_daily_amount            | Daily amount over business days                                  |
| calendar_days_monthly_percentage | Monthly interest percentage charged based on calendar days      |

### qr_code_settings Object

| Field                            | Type    | Description                                                                 | Characters  |
|----------------------------------|---------|-----------------------------------------------------------------------------|-------------|
| `pix_key` *                      | uuidv4  | Random type PIX key                                                         | 36          |
| `qr_code_on_discharge_enabled` * | boolean | Determines if QR Code information will appear in the return file (CNAB)    | -           |

### cnab_settings Object

| Field                            | Type    | Description                                                                 | Characters  |
|----------------------------------|---------|-----------------------------------------------------------------------------|-------------|
| `default_bank`                   | string  | Default bank layout for CNAB file processing                               | **[default_bank Enumerators](#default_bank-enumerators)** |
| `preferred_layout`               | string  | Preferred layout for CNAB files                                            | **[preferred_layout Enumerators](#preferred_layout-enumerators)** |

### default_bank Enumerators

| Enumerator         | Description           |
|--------------------|-----------------------|
| santander          | Santander Bank        |
| itau               | Itaú Bank             |
| bradesco           | Bradesco Bank         |
| qi_scd             | QI SCD                |

### preferred_layout Enumerators

| Enumerator         | Description           |
|--------------------|-----------------------|
| 400                | CNAB 400 Layout       |
| 240                | CNAB 240 Layout       |

## 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<br/>`status` | QI Code<br/>`code` | Title<br/>`title`                                 | Description (eng)<br/>`description`                                                                                       | Description (ptbr)<br/>`translation`                                                                                     |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 400                      | QIT000001            | Bad Request                                        | Schema Error                                                                                                            | Schema Inválido                                                                                                         |
| 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                                                                 |
| 400                      | BKS000025            | Bad Request | Invalid bank slip status.      | Status de boleto inválido.                          |

---

# Query temporary file

URL: /en/documentation/boletos/cnab/consulta_por_chave

Querying a temporary CNAB file using its key returns detailed information about it, such as the number of occurrences that have already been processed and possible errors found in the file.

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /temporary_cnab_file/ TEMPORARY_CNAB_FILE_KEY
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         |
| `temporary_cnab_file_key` | uuidv4 | Unique temporary CNAB file identification key in uuid v4 format | 36         |

## Response

STATUS 200

Response Body: Accepted file (no errors)

```json
{
  "temporary_cnab_file_key": "fa4f094d-8475-4828-9105-99756914e14f",
  "temporary_cnab_file_name": "240827463_t.REM",
  "temporary_cnab_file_status": "read",
  "occurrence_quantity": 6,
  "total_processed_occurrences": 6,
  "created_at": "2024-08-28T15:09:30Z"
}
```

Response Body: Rejected file (with errors)

```json
{
  "temporary_cnab_file_key": "c16baa13-0969-46a7-a85f-6f975d266d9f",
  "temporary_cnab_file_name": "240905623.REM",
  "temporary_cnab_file_status": "rejected",
  "occurrence_quantity": 0,
  "total_processed_occurrences": 0,
  "created_at": "2024-09-10T15:59:25Z",
  "error_data": [
    {
      "code": "BKS000063",
      "title": "Bad Request",
      "description": "Invalid file code.",
      "translation": "Codigo de arquivo invalido.",
      "extra_fields": {
        "details": "Invalid file code. Expected: '1'. Got: '0'.",
        "file_line": 1,
        "details_pt_br": "Código de arquivo inválido. Esperado: '1'. Recebido: '0'.",
        "cnab_file_name": "240905623.REM",
        "cnab_inline_end_position": 2,
        "cnab_inline_start_position": 2
      }
    },
    {
      "code": "BKS000069",
      "title": "Bad Request",
      "description": "Invalid beneficiary account: beneficiary account is not the one that the requester profiles belongs to.",
      "translation": "Conta do beneficiario invalida: a conta do beneficiario nao e aquela a qual a carteira de boletos pertence.",
      "extra_fields": {
        "details": "Invalid beneficiary account header on header. Expected: '1927400'. Got: '3;53179'.",
        "file_line": 1,
        "details_pt_br": "Conta do beneficiário inválida no header. Esperado: '1927400'. Recebido: '3;53179'.",
        "cnab_file_name": "240905623.REM",
        "cnab_inline_end_position": 46,
        "cnab_inline_start_position": 40
      }
    },
    {
      "code": "BKS000064",
      "title": "Bad Request",
      "description": "Invalid bank code (014).",
      "translation": "Codigo do banco invalido (014).",
      "extra_fields": {
        "details": "Invalid bank code. Expected: '329'. Got: '014'",
        "bank_code": "014",
        "details_pt_br": "Código do banco inválido. Esperado: '329'. Recebido: '014'",
        "cnab_file_name": "240905623.REM"
      }
    },
    {
      "code": "BKS000056",
      "title": "Bad Request",
      "description": "Invalid record sequence.",
      "translation": "Sequencia invalida de registros.",
      "extra_fields": {
        "cnab_line": 1,
        "cnab_file_name": "240905623.REM"
      }
    },
    {
      "code": "BKS000056",
      "title": "Bad Request",
      "description": "Invalid record sequence.",
      "translation": "Sequencia invalida de registros.",
      "extra_fields": {
        "cnab_line": 2,
        "cnab_file_name": "240905623.REM"
      }
    },
    {
      "code": "BKS000086",
      "title": "Bad Request",
      "description": "File missing trailler record.",
      "translation": "Arquivo sem registro trailler.",
      "extra_fields": {
        "file_line": 3,
        "cnab_file_name": "240905623.REM"
      }
    }
  ]
}
```

### Response Body Params

| Field                      | Type    | Description                                                                          | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `temporary_cnab_file_key` *| uuidv4  | Unique temporary CNAB file identification key in uuid v4 format         | 36                                                |
| `temporary_cnab_file_name` *| uuidv4  | File name                                                                   | 100                                               |
| `temporary_cnab_file_status` *| string | Temporary CNAB file status | **[temporary_cnab_file_status Enumerators](#enumeradores-temporary_cnab_file_status)** |
| `occurrence_quantity` *        | integer  | Number of occurrences in the file                                          | -                                                 |
| `total_processed_occurrences` *| integer  | Number of occurrences already processed                                      | -                                                 |
| `error_data`                   | object array | Error objects found in the file, in JSON format, following the same pattern returned by the APIs | **[error_data Object](#objeto-error_data)**                                                |
| `created_at` *                 | string   | Timestamp of when the file was created in the database, in ISO Zulu format | 20                                         |

### Enumeradores temporary_cnab_file_status

| Enumerator                   | Description                                                                    |
|------------------------------|------------------------------------------------------------------------------|
| uploaded                     | upload successful, but file has not yet started being processed     |
| processing                   | file being read                                                           |
| read                         | file read and accepted                                                        |
| rejected                     | file read and rejected due to syntactic error                                  |

### Objeto error_data

| Field                      | Type    | Description                                                                          | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `code` *         | string  | Error code         | 9                                                |
| `title` *        | string  | Error title                                                                   | 100                                               |
| `description` *  | string  | Error description in English | 100 |
| `translation` *  | integer | Translation of error description                                          | 100                                               |
| `extra_fields`                 | object   | Additional information about the error | -                                         |

:::danger Important
The fields returned in the `extra_fields` object serve to provide additional information about the error and may vary. Therefore, they should not be mapped in a restrictive manner.
:::

## 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<br/>`status` | QI Code<br/>`code` | Title<br/>`title`                                 | Description (eng)<br/>`description`                                                                                       | Description (ptbr)<br/>`translation`                                                                                     |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 400                      | QIT000001            | Bad Request                                        | Schema Error                                                                                                            | Schema Inválido                                                                                                         |
| 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.                                                                 |
| 404                      | BKS000013            | Not Found | Requester profile not found         |               Carteira não encontrada                                                                 |
| 404                      | BKS000054            | Not Found | Remittance not found with key: `{temporary_cnab_file_key}`        |               Remessa não encontrada com a chave: `{temporary_cnab_file_key}`                                                                 |

---

# Remittance files (CNAB) - Introduction

URL: /en/documentation/boletos/cnab/introducao

:::info
The file transmitted in this call must follow the QI Tech Collection File Layout standard with 400 positions.
Here is the link to download the manual: [Layout de Cobrança - QI Tech versão 2.1.](https://storage.googleapis.com/live-doc-api/public_samples/Layout%20de%20Cobran%C3%A7a%20-%20QI%20Tech%20v2.1.pdf)
:::

Remittance files (CNAB) offer the possibility to send multiple boleto record instructions, along with other types of instructions (extension, discount, cancellation, etc.), for different boletos, in a single file. When sending instructions such as those mentioned (extension, discount, etc.) for existing boletos, the boleto is identified by the portfolio code (`requester_profile_code`) and by our number (`our_number`).

When uploading a CNAB file, if the request is successful (response code `202`), a temporary CNAB file (`TemporaryCNABFile`) will be created. It is possible to check the file processing status --- as well as possible errors, both in the file itself and in its occurrences ---, using the endpoints for [**temporary CNAB file query**](/documentation/boletos/cnab/consulta_por_chave) and [**its occurrences**](/documentation/boletos/cnab/listar_ocorrencias_temporarias).

The file will be rejected if any syntactic error is found. However, it is read entirely, or until a limit of 100 errors is reached, so that all errors can be returned and corrected in a more practical and efficient manner.

While the file is being read, temporary occurrences are created, which will only be processed if it is accepted. That is, if the file is rejected (status `rejected`), all its occurrences will also be . Furthermore, if the file is rejected, no more temporary occurrences are created for it. Therefore, it is common for rejected file entries to have fewer occurrences than the number of occurrences sent in the file.

On the other hand, when the file is completely read and accepted (status `read`), the creation of definitive occurrences begins, which will be the instructions that will actually take effect. If a temporary occurrence shows the status `rejected`, it means that some semantic error was found in it --- that is, some error in its content. In this case, there will be an `error_data` object along with it, which provides details about the reason for rejection. In contrast, if it shows the status `processed`, it means that the definitive occurrence has already been created and sent to CIP/Nuclea. More details about each of these entities are provided in the subsequent pages for querying files and temporary occurrences.

:::tip Credit Split via CNAB
To inform [**credit split**](/documentation/boletos/instrucoes/rateio_de_credito) (split payment) in CNAB files:

- **QI SCD (CNAB400 - QI Tech v2.1 layout):** detail record with `identificacao_registro = 3`. Full details in the **[Layout de Cobrança - QI Tech v2.1](https://storage.googleapis.com/live-doc-api/public_samples/Layout%20de%20Cobran%C3%A7a%20-%20QI%20Tech%20v2.1.pdf)**.
- **Bradesco (CNAB400 and CNAB240):** detail record type `3`.
- **Itaú (CNAB400 and CNAB240):** detail record type `4`.
- **Santander:** does not support credit split via CNAB. Use the REST endpoint [**Credit Split Update**](/documentation/boletos/instrucoes/rateio_de_credito) or include `split_payment_data` in the issuance via API.

**How to map N recipients:** Each split record fits up to **3 additional accounts** (account number + check digit + percentage). For more than 3 recipients, add **multiple split records in sequence** after the bank slip's main record — they are accumulated in the same occurrence. Example: 7 accounts = 3 records (3 + 3 + 1).

**Restrictions (all banks):**
- Only **percentage**-based calculation is supported (`calculation code = 2`).
- The sum of percentages (beneficiary + splits) must be exactly **100**.
- Total recipient limit follows the same as the REST API (up to 10 additional accounts).
- The `beneficiary_max_amount` field (split with maximum beneficiary amount and surplus directed to the first rule) is **REST API exclusive**. It is not supported via CNAB. For this scenario, use the REST endpoint for [**issuance**](/documentation/boletos/emissao/emissao_boleto_unico_padrao) or for [**credit split update**](/documentation/boletos/instrucoes/rateio_de_credito).
:::

---

# List temporary remittance files

URL: /en/documentation/boletos/cnab/listar_arquivos_temporarios

The listing of temporary CNAB files will return all temporary CNAB files from the wallet that match the query parameters sent in the request.

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /temporary_cnab_file
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              |
|-------------------------|--------|--------------------------------------------------------------|-------------------------|
| `temporary_cnab_file_status` | string | Status of the temporary CNAB file | **[temporary_cnab_file_status enumerators](#temporary_cnab_file_status-enumerators)** |
| `page`                  | integer| Page number                                                  | -                       |
| `page_size`             | integer| Page size                                                    | -                       |

### temporary_cnab_file_status enumerators

| Enumerator               | Description                                                                      |
|------------------------------|------------------------------------------------------------------------------|
| uploaded                     | upload completed successfully, but file processing has not started yet         |
| processing                   | file being read                                                              |
| read                         | file read and accepted                                                       |
| rejected                     | file read and rejected due to syntactic error                               |

## Response

STATUS 200

Response Body

```json
{
  "data": [
    {
      "temporary_cnab_file_key": "a6db5f8b-1ed7-4d13-9cbf-f3c4275e3ca3",
      "temporary_cnab_file_name": "240903573.REM",
      "temporary_cnab_file_status": "processing",
      "occurrence_quantity": null,
      "created_at": "2024-09-07T15:44:01Z"
    },
    {
      "temporary_cnab_file_key": "2351c4ae-9a01-4675-86e4-099a30dafa42",
      "temporary_cnab_file_name": "240904603.REM",
      "temporary_cnab_file_status": "rejected",
      "occurrence_quantity": 0,
      "created_at": "2024-09-06T12:35:50Z"
    },
    {
      "temporary_cnab_file_key": "fa4f094d-8475-4828-9105-99756914e14f",
      "temporary_cnab_file_name": "240827463_t.REM",
      "temporary_cnab_file_status": "read",
      "occurrence_quantity": 10424,
      "created_at": "2024-08-28T15:09:30Z"
    },
    {
      "temporary_cnab_file_key": "e99cea6d-0d1c-4ec3-a2c6-bc603aede7c6",
      "temporary_cnab_file_name": "240827443_t.REM",
      "temporary_cnab_file_status": "read",
      "occurrence_quantity": 542,
      "created_at": "2024-08-27T20:07:11Z"
    },
    {
      "temporary_cnab_file_key": "2351c4ae-9a01-4675-86e4-099a30dafa42",
      "temporary_cnab_file_name": "240812604.REM",
      "temporary_cnab_file_status": "rejected",
      "occurrence_quantity": 0,
      "created_at": "2024-08-12T12:52:13Z"
    }
  ],
  "pagination": {
    "current_page": 1,
    "rows_per_page": 100
  }
}
```

### Response Body Params

| Field            | Type         | Description                           | Characters                                  |
|------------------|--------------|---------------------------------------|---------------------------------------------|
| `data` *         | object array | Temporary CNAB files                  | **[temporary_cnab_file object](#temporary_cnab_file-object)**   |
| `pagination` *   | object       | Pagination information                | **[pagination object](#pagination-object)** |

### temporary_cnab_file object

| Field                      | Type    | Description                                                                        | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `temporary_cnab_file_key` *| uuidv4  | Unique identification key for the temporary CNAB file in uuid v4 format           | 36                                                |
| `temporary_cnab_file_name` *| uuidv4  | File name                                                                         | 100                                               |
| `temporary_cnab_file_status` *| string | Status of the temporary CNAB file | **[temporary_cnab_file_status enumerators](#temporary_cnab_file_status-enumerators)** |
| `occurrence_quantity` *        | integer  | Number of occurrences in the file                                                | -                                                 |
| `created_at` *                 | string   | Timestamp of file creation time in the database, in ISO Zulu format              | 20                                         |

### pagination object

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

## 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<br/>`status` | QI Code<br/>`code` | Title<br/>`title`                                 | Description (eng)<br/>`description`                                                                                       | Description (pt-br)<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                                                                 |

---

# List temporary occurrences

URL: /en/documentation/boletos/cnab/listar_ocorrencias_temporarias

The listing of temporary occurrences will return all temporary occurrences from a given CNAB file.

:::info
When a CNAB file is rejected due to syntactic error, temporary occurrences related to it are no longer created, since they would all be rejected because the file was rejected. Therefore, when the file is rejected, it is possible that the number of temporary occurrences related to the file is less than the number of occurrences sent in it.
:::

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /temporary_cnab_file / TEMPORARY_CNAB_FILE_KEY /occurrences
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              |
|-------------------------|--------|--------------------------------------------------------------|-------------------------|
| `occurrence_status`     | string | Temporary occurrence status                              | **[occurrence_status enumerators](#enumeradores-temporary_cnab_file_status)** |
| `occurrence_type`       | string | Temporary occurrence type                                | **[occurrence_type enumerators](#enumeradores-temporary_cnab_file_type)** |
| `page`                  | integer| Page number                                             | -                       |
| `page_size`             | integer| Page size                                            | -                       |

### occurrence_status enumerators

| Enumerator                   | Description                                                                    |
|------------------------------|------------------------------------------------------------------------------|
| pending                      | occurrence has not been processed yet                                          |
| processed                    | occurrence processed successfully                                            |
| rejected                     | occurrence processed and rejected due to semantic error                         |

### occurrence_type enumerators

| Enumerator                           | Description                                                                    |
|--------------------------------------|------------------------------------------------------------------------------|
| registration                         | bank slip registration                                                           |
| write_off                            | bank slip write-off                                                              |
| rebate                               | bank slip amount rebate                                                |
| cancel_rebate                        | rebate cancellation                                                   |
| extension                            | payment date extension                                             |
| protest_request                      | protest request                                                           |
| bankruptcy_protest_request           | bankruptcy protest request                                                |
| protest_cancel_and_write_off_request | protest request cancellation and bank slip write-off                         |
| protest_cancel_request               | protest request cancellation                                           |
| bank_slip_edit                       | edit other bank slip data                                             |

## Response

STATUS 200

Response Body

```json
{
    "data": [
        {
            "occurrence_key": "191f2220-1465-47d7-8c81-67d8f59f5af2",
            "occurrence_status": "rejected",
            "occurrence_type": "registration",
            "occurrence_our_number": 12455,
            "error_data": {
                "code": "BKS000069",
                "title": "Bad Request",
                "description": "Invalid beneficiary account: beneficiary account is not the one that the requester profiles belongs to.",
                "translation": "Conta do beneficiario invalida: a conta do beneficiario nao e aquela a qual a carteira de boletos pertence.",
                "extra_fields": {
                    "account_digit": "4",
                    "account_branch": "0001",
                    "account_number": "1927400"
                }
            }
        },
        {
            "occurrence_key": "adc0ce54-9e69-45ec-9220-fbfe0e3ba103",
            "occurrence_status": "rejected",
            "occurrence_type": "registration",
            "occurrence_our_number": 12453,
            "error_data": {
                "code": "BKS000069",
                "title": "Bad Request",
                "description": "Invalid beneficiary account: beneficiary account is not the one that the requester profiles belongs to.",
                "translation": "Conta do beneficiario invalida: a conta do beneficiario nao e aquela a qual a carteira de boletos pertence.",
                "extra_fields": {
                    "account_digit": "4",
                    "account_branch": "0001",
                    "account_number": "1927400"
                }
            }
        },
        {
            "occurrence_key": "0521c4db-b243-4599-af2f-c288a299948a",
            "occurrence_status": "rejected",
            "occurrence_type": "registration",
            "occurrence_our_number": 12452,
            "error_data": {
                "code": "BKS000069",
                "title": "Bad Request",
                "description": "Invalid beneficiary account: beneficiary account is not the one that the requester profiles belongs to.",
                "translation": "Conta do beneficiario invalida: a conta do beneficiario nao e aquela a qual a carteira de boletos pertence.",
                "extra_fields": {
                    "account_digit": "4",
                    "account_branch": "0001",
                    "account_number": "1927400"
                }
            }
        },
        {
            "occurrence_key": "f0875275-dea0-4e93-a665-a24e921d0a95",
            "occurrence_status": "rejected",
            "occurrence_type": "registration",
            "occurrence_our_number": 12451,
            "error_data": {
                "code": "BKS000069",
                "title": "Bad Request",
                "description": "Invalid beneficiary account: beneficiary account is not the one that the requester profiles belongs to.",
                "translation": "Conta do beneficiario invalida: a conta do beneficiario nao e aquela a qual a carteira de boletos pertence.",
                "extra_fields": {
                    "account_digit": "4",
                    "account_branch": "0001",
                    "account_number": "1927400"
                }
            }
        },
        {
            "occurrence_key": "98ac54d9-0b3c-45a6-86e1-4b79d25f6364",
            "occurrence_status": "rejected",
            "occurrence_type": "registration",
            "occurrence_our_number": 12450,
            "error_data": {
                "code": "BKS000069",
                "title": "Bad Request",
                "description": "Invalid beneficiary account: beneficiary account is not the one that the requester profiles belongs to.",
                "translation": "Conta do beneficiario invalida: a conta do beneficiario nao e aquela a qual a carteira de boletos pertence.",
                "extra_fields": {
                    "account_digit": "4",
                    "account_branch": "0001",
                    "account_number": "1927400"
                }
            }
        },
        {
            "occurrence_key": "dd2c8d76-d663-4dbb-9c8b-84a627156147",
            "occurrence_status": "rejected",
            "occurrence_type": "registration",
            "occurrence_our_number": 12449,
            "error_data": {
                "code": "BKS000069",
                "title": "Bad Request",
                "description": "Invalid beneficiary account: beneficiary account is not the one that the requester profiles belongs to.",
                "translation": "Conta do beneficiario invalida: a conta do beneficiario nao e aquela a qual a carteira de boletos pertence.",
                "extra_fields": {
                    "account_digit": "4",
                    "account_branch": "0001",
                    "account_number": "1927400"
                }
            }
        }
    ],
    "pagination": {
        "current_page": 1,
        "rows_per_page": 100
    }
}
```

### Response Body Params

| Field            | Type         | Description                             | Characters                                  |
|------------------|--------------|---------------------------------------|---------------------------------------------|
| `data` *         | object array | Temporary occurrences               | **[temporary_occurrence object](#objeto-temporary_occurrence)**   |
| `pagination` *   | object       | Pagination information              | **[pagination object](#objeto-pagination)** |

### temporary_cnab_file object

| Field                      | Type    | Description                                                                          | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `occurrence_key` *| uuidv4  | Unique temporary occurrence identification key in uuid v4 format         | 36                                                |
| `occurrence_status` * | string  | Temporary occurrence status                                                                   | **[temporary_occurrence_status enumerators](#enumeradores-temporary_occurrence_status)** |
| `occurrence_type` *   | string  | Temporary occurrence type | **[occurrence_type enumerators](#enumeradores-occurrence_type)** |
| `occurrence_our_number` *       | integer  | Number of occurrences in the file                                          | -                                                 |
| `error_data`                   | object | Error objects found in the file, in JSON format, in the same pattern returned by the APIs | **[error_data object](#objeto-error_data)**                                                |

### pagination object

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

### error_data object

| Field                      | Type    | Description                                                                          | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `code` *         | string  | Error code         | 9                                                |
| `title` *        | string  | Error title                                                                   | 100                                               |
| `description` *  | string  | Error description, in English | 100 |
| `translation` *  | integer | Error description translation                                          | 100                                               |
| `extra_fields`                 | object   | Additional information about the error | -                                         |

:::danger Important
The fields returned in the `extra_fields` object serve to provide additional information about the error and may vary. Therefore, they should not be mapped in a restrictive manner.
:::

## 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<br/>`status` | QI Code<br/>`code` | Title<br/>`title`                                 | Description (eng)<br/>`description`                                                                                       | Description (pt-br)<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                                                                 |
| 404                      | BKS000054            | Not Found | Remittance not found with key: `{temporary_cnab_file_key}`        |               Remessa não encontrada com a chave: `{temporary_cnab_file_key}`                                                                 |

---

# Upload CNAB file

URL: /en/documentation/boletos/cnab/upload_de_arquivo_remessa

:::caution Attention!
The call must be authenticated following the standard described in the [**Document upload**](/documentation/upload_de_documentos) section.
:::

CNAB files offer the possibility of sending multiple boleto record instructions, along with other types of instructions (extension, discount, cancellation, etc.), for different boletos, in a single file. When sending instructions like those mentioned (extension, discount, etc.) for existing boletos, the boleto is identified by the requester profile code (`requester_profile_code`) and our number (`our_number`).

:::info
When uploading a CNAB file, if the request is successful (response code `202`), a temporary CNAB file (`TemporaryCNABFile`) will be created. It is possible to check the file processing status --- as well as possible errors, both in the file itself and in its occurrences ---, using the [**temporary CNAB file query**](/documentation/boletos/cnab/consulta_por_chave) and [**its occurrences**](/documentation/boletos/cnab/listar_ocorrencias_temporarias) endpoints.
:::

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /cnab_file
METHOD POST

### Path parameters

| Field                   | Type   | Description                                                  | Characters |
|-------------------------|--------|--------------------------------------------------------------|------------|
| `account_key`           | uuidv4 | Unique account identification key, in uuid v4 format        | 36         |
| `requester_profile_key` | uuidv4 | Unique requester profile identification key, in uuid v4 format | 36         |

## Request Body Params

The following data should be sent as form-data in the request body:

| Field                   | Type   | Description                                                  | Characters |
|-------------------------|--------|--------------------------------------------------------------|------------|
| `file` *                | file   | CNAB file following the standard established by QI Tech     | -          |

## Response

STATUS 202

Response Body

```json
{
  "temporary_cnab_file_key": "f14e9bac-94ed-4eb1-87b4-7fd7b7a2d280",
  "temporary_cnab_file_status": "accepted"
}
```

### Response Body Params

| Field                          | Type    | Description                                                     | Characters                 |
|--------------------------------|---------|-----------------------------------------------------------------|----------------------------|
| `temporary_cnab_file_key` *    | uuidv4  | Unique CNAB file identification key in uuid v4 format          | 36                         |
| `temporary_cnab_file_status` * | string  | CNAB file status | **[temporary_cnab_file_status Enumerators](#enumeradores-cnab_file_status)** |

### temporary_cnab_file_status Enumerators

| Enumerator | Description                                                               |
|------------|---------------------------------------------------------------------------|
| uploaded   | Upload successful, but file has not yet started being processed          |
| processing | File being read                                                           |
| read       | File read and accepted                                                    |
| rejected   | File read and rejected (all file occurrences are rejected)               |

## 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<br/>`status` | QI Code<br/>`code` | Title<br/>`title`                                  | Description (eng)<br/>`description`                                                                                       | Description (ptbr)<br/>`translation`                                                                                     |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 400                      | QIT000001            | Bad Request                                        | Schema Error                                                                                                            | Schema Inválido                                                                                                         |
| 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.                                                                 |
| 404                      | BKS000013            | Not Found | Requester profile not found         |               Carteira não encontrada                                                                 |
| 400                      | BKS000022            | Bad Request                                        | Requester profile is not opened.                                                              | Carteira não está aberta.                          |
| 409                      | BKS000053            | Conflict                                           | CNAB file already received: '`<file_name>`'                                                   | Arquivo CNAB já recebido: '`<file_name>`'                          |

---

# Query bank slip by key

URL: /en/documentation/boletos/consulta/consulta_por_chave

Querying a bank slip using its key returns detailed information about it, such as all the instructions related to that bank slip.

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY
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         |
| `bank_slip_key`         | uuidv4 | Unique bank slip identification key, in uuid v4 format       | 36         |

## Response

STATUS 200

Response Body

```json
{
  "bank_slip_key": "4c2fa514-a44d-40f2-8d57-c0caf1b9165a",
  "request_control_key": "0dcb3182-4d7e-4526-8f92-c15cdbc51bad",
  "our_number": 26652176735,
  "document_number": "DOC4561237",
  "amount": "5000.00",
  "rebate_amount": "0.00",
  "expiration": "2024-07-12",
  "barcode": "32994978900005000000001546128483498231955340",
  "digitable_line": "32990001524612848349582319553408497890000500000",
  "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": 10.0,
    "days_to_interest": 2
  },
  "discounts_data": [
    {
      "discount_type": "absolute",
      "discount_amount": 50.0,
      "discount_number": 1,
      "discount_limit_date": "2024-07-12"
    }
  ],
  "payer_data": {
    "name": "Global Tech",
    "address": {
      "city": "Innovation City",
      "state": "SP",
      "number": "202",
      "street": "101 High St.",
      "complement": "Building A",
      "postal_code": "57099999",
      "neighborhood": "Tech Park"
    },
    "person_type": "legal",
    "document_number": "12345678000195"
  },
  "guarantor_data": {
    "name": "Jane Doe",
    "address": {
      "city": "Peaceful Town",
      "state": "RJ",
      "number": "303",
      "street": "202 Elm St.",
      "complement": "House 1",
      "postal_code": "57099999",
      "neighborhood": "Quiet Neighborhood"
    },
    "person_type": "natural",
    "document_number": "23456789012"
  },
  "qr_code_data": {
    "qr_code_key": "58bd3558-f214-4e83-9c88-1ac4c93db214",
    "pix_key": "f9b05a58-9dcf-49cb-bc7f-99c5b3f1fdcb",
    "receiver_conciliation_id": "a3861b53f5414b0ba6c9f800d7374474",
    "url": "00020126890014br.gov.bcb.pix2567qrcode-h.dev.qitech.app/bacen/cobv/a3861b53f5414b0ba6c9f800d73744745204000053039865802BR5922BeatrizCoutodeCarvalho6012SAOJOSEDORIO61081501410062070503***6304ED95",
    "image": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/wAALCAD0APQBAREA/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/9oACAEBAAA/APf6KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK+QPhl8Mv+Fjf2p/xN/wCz/sHlf8u3m79+/wD21xjZ79a7/wD4Zl/6m7/ym/8A22j/AIZl/wCpu/8AKb/9to/Zl/5mn/t0/wDa1H7TX/Mrf9vf/tGj9mX/AJmn/t0/9rVwHwy+Jv8Awrn+1P8AiUf2h9v8r/l58rZs3/7DZzv9ule//DL4Zf8ACuf7U/4m/wDaH2/yv+Xbytmzf/ttnO/26V5//wAMy/8AU3f+U3/7bR+01/zK3/b3/wC0a9A+JvxN/wCFc/2X/wASj+0Pt/m/8vPlbNmz/YbOd/t0o+JvxN/4Vz/Zf/Eo/tD7f5v/AC8+Vs2bP9hs53+3SvAPhl8Mv+Fjf2p/xN/7P+weV/y7ebv37/8AbXGNnv1r3/4m/E3/AIVz/Zf/ABKP7Q+3+b/y8+Vs2bP9hs53+3Sj4m/DL/hY39l/8Tf+z/sHm/8ALt5u/fs/21xjZ79a8A+Jvwy/4Vz/AGX/AMTf+0Pt/m/8u3lbNmz/AG2znf7dK+v6+QPib8Tf+Fjf2X/xKP7P+web/wAvPm79+z/YXGNnv1rv/wBpr/mVv+3v/wBo16B8Tfhl/wALG/sv/ib/ANn/AGDzf+Xbzd+/Z/trjGz3615//wAm5/8AUw/27/26eR5H/fzdu872xt7544D4ZfE3/hXP9qf8Sj+0Pt/lf8vPlbNm/wD2Gznf7dK+v6+QPhl8Mv8AhY39qf8AE3/s/wCweV/y7ebv37/9tcY2e/Wu/wD+GZf+pu/8pv8A9to/4Zl/6m7/AMpv/wBto/Zl/wCZp/7dP/a1fQFFFFfP/wCzL/zNP/bp/wC1q8Ar3/8AZl/5mn/t0/8Aa1H7Mv8AzNP/AG6f+1q4D4ZfDL/hY39qf8Tf+z/sHlf8u3m79+//AG1xjZ79a9/+GXxN/wCFjf2p/wASj+z/ALB5X/Lz5u/fv/2FxjZ79a8A+GXwy/4WN/an/E3/ALP+weV/y7ebv37/APbXGNnv1r6/rz/4ZfE3/hY39qf8Sj+z/sHlf8vPm79+/wD2FxjZ79a8A+Jvwy/4Vz/Zf/E3/tD7f5v/AC7eVs2bP9ts53+3Svf/AIZfE3/hY39qf8Sj+z/sHlf8vPm79+//AGFxjZ79a9Arz/4ZfDL/AIVz/an/ABN/7Q+3+V/y7eVs2b/9ts53+3SvP/2mv+ZW/wC3v/2jXAfE34m/8LG/sv8A4lH9n/YPN/5efN379n+wuMbPfrX1/XyB8Tfhl/wrn+y/+Jv/AGh9v83/AJdvK2bNn+22c7/bpX1/Xn/xN+GX/Cxv7L/4m/8AZ/2Dzf8Al283fv2f7a4xs9+tHxN+Jv8Awrn+y/8AiUf2h9v83/l58rZs2f7DZzv9uleAfDL4m/8ACuf7U/4lH9ofb/K/5efK2bN/+w2c7/bpXf8A/Jxn/Uvf2F/29+f5/wD3727fJ987u2OfQPhl8Tf+Fjf2p/xKP7P+weV/y8+bv37/APYXGNnv1rz/APZl/wCZp/7dP/a1eAV7/wDsy/8AM0/9un/taj9mX/maf+3T/wBrV9AUUUV8/wD7Mv8AzNP/AG6f+1qP+GZf+pu/8pv/ANtr0D4ZfDL/AIVz/an/ABN/7Q+3+V/y7eVs2b/9ts53+3SvP/2Zf+Zp/wC3T/2tXAfDL4Zf8LG/tT/ib/2f9g8r/l283fv3/wC2uMbPfrXf/sy/8zT/ANun/taj/hmX/qbv/Kb/APbaP2Zf+Zp/7dP/AGtR/wAm5/8AUw/27/26eR5H/fzdu872xt754P8Ak3P/AKmH+3f+3TyPI/7+bt3ne2NvfPB/w01/1KP/AJUv/tVH/Juf/Uw/27/26eR5H/fzdu872xt7544D4ZfDL/hY39qf8Tf+z/sHlf8ALt5u/fv/ANtcY2e/Wu//AOGZf+pu/wDKb/8Aba8Ar6/+GXxN/wCFjf2p/wASj+z/ALB5X/Lz5u/fv/2FxjZ79a8A+Jvwy/4Vz/Zf/E3/ALQ+3+b/AMu3lbNmz/bbOd/t0r3/AOGXxN/4WN/an/Eo/s/7B5X/AC8+bv37/wDYXGNnv1rz/wD4Zl/6m7/ym/8A22vQPhl8Tf8AhY39qf8AEo/s/wCweV/y8+bv37/9hcY2e/WvP/8AhmX/AKm7/wApv/22j9mX/maf+3T/ANrV9AV8/wD7Mv8AzNP/AG6f+1qP+GZf+pu/8pv/ANtr0D4ZfDL/AIVz/an/ABN/7Q+3+V/y7eVs2b/9ts53+3SvP/2Zf+Zp/wC3T/2tX0BRRRXz/wD8My/9Td/5Tf8A7bR/wzL/ANTd/wCU3/7bR/wzL/1N3/lN/wDttegfDL4Zf8K5/tT/AIm/9ofb/K/5dvK2bN/+22c7/bpXgHwy+Jv/AArn+1P+JR/aH2/yv+Xnytmzf/sNnO/26V7/APDL4Zf8K5/tT/ib/wBofb/K/wCXbytmzf8A7bZzv9ulHwy+GX/Cuf7U/wCJv/aH2/yv+Xbytmzf/ttnO/26UfDL4Zf8K5/tT/ib/wBofb/K/wCXbytmzf8A7bZzv9ulef8A/Juf/Uw/27/26eR5H/fzdu872xt7549A+GXwy/4Vz/an/E3/ALQ+3+V/y7eVs2b/APbbOd/t0o+GXwy/4Vz/AGp/xN/7Q+3+V/y7eVs2b/8AbbOd/t0rz/8AZl/5mn/t0/8Aa1H7Mv8AzNP/AG6f+1q9A+GXwy/4Vz/an/E3/tD7f5X/AC7eVs2b/wDbbOd/t0rwD4ZfE3/hXP8Aan/Eo/tD7f5X/Lz5WzZv/wBhs53+3Sj4ZfE3/hXP9qf8Sj+0Pt/lf8vPlbNm/wD2Gznf7dK7/wD5Nz/6mH+3f+3TyPI/7+bt3ne2NvfPHoHwy+GX/Cuf7U/4m/8AaH2/yv8Al28rZs3/AO22c7/bpR8Mvhl/wrn+1P8Aib/2h9v8r/l28rZs3/7bZzv9ulef/wDJuf8A1MP9u/8Abp5Hkf8Afzdu872xt754P2Zf+Zp/7dP/AGtXoHwy+GX/AArn+1P+Jv8A2h9v8r/l28rZs3/7bZzv9ulHwy+GX/Cuf7U/4m/9ofb/ACv+Xbytmzf/ALbZzv8AbpXn/wDwzL/1N3/lN/8AttH/AAzL/wBTd/5Tf/ttH/DMv/U3f+U3/wC216B8Mvhl/wAK5/tT/ib/ANofb/K/5dvK2bN/+22c7/bpXoFFFFfIHwy+Jv8Awrn+1P8AiUf2h9v8r/l58rZs3/7DZzv9ulHxN+GX/Cuf7L/4m/8AaH2/zf8Al28rZs2f7bZzv9ulef19f/DL4Zf8K5/tT/ib/wBofb/K/wCXbytmzf8A7bZzv9ulef8A7TX/ADK3/b3/AO0a+gK+QPib8Mv+Fc/2X/xN/wC0Pt/m/wDLt5WzZs/22znf7dK8/r6/+GXxN/4WN/an/Eo/s/7B5X/Lz5u/fv8A9hcY2e/Wj4m/E3/hXP8AZf8AxKP7Q+3+b/y8+Vs2bP8AYbOd/t0rwD4ZfDL/AIWN/an/ABN/7P8AsHlf8u3m79+//bXGNnv1r3/4ZfE3/hY39qf8Sj+z/sHlf8vPm79+/wD2FxjZ79a8A+GXwy/4WN/an/E3/s/7B5X/AC7ebv37/wDbXGNnv1o+Jvwy/wCFc/2X/wATf+0Pt/m/8u3lbNmz/bbOd/t0r3/4ZfDL/hXP9qf8Tf8AtD7f5X/Lt5WzZv8A9ts53+3SvP8A/k4z/qXv7C/7e/P8/wD797dvk++d3bHJ/wAMy/8AU3f+U3/7bX0BXz/+01/zK3/b3/7Ro/5Nz/6mH+3f+3TyPI/7+bt3ne2NvfPHoHwy+Jv/AAsb+1P+JR/Z/wBg8r/l583fv3/7C4xs9+teAfDL4Zf8LG/tT/ib/wBn/YPK/wCXbzd+/f8A7a4xs9+td/8A8m5/9TD/AG7/ANunkeR/383bvO9sbe+eD/hmX/qbv/Kb/wDba8Ar6/8Ahl8Mv+Fc/wBqf8Tf+0Pt/lf8u3lbNm//AG2znf7dKPhl8Tf+Fjf2p/xKP7P+weV/y8+bv37/APYXGNnv1r0CiiivP/hl8Mv+Fc/2p/xN/wC0Pt/lf8u3lbNm/wD22znf7dK8/wD+Gmv+pR/8qX/2qj/hmX/qbv8Aym//AG2j/hmX/qbv/Kb/APba9A+JvxN/4Vz/AGX/AMSj+0Pt/m/8vPlbNmz/AGGznf7dK8//AOGZf+pu/wDKb/8Aba9A+Jvwy/4WN/Zf/E3/ALP+web/AMu3m79+z/bXGNnv1o+Jvwy/4WN/Zf8AxN/7P+web/y7ebv37P8AbXGNnv1rz/8A4aa/6lH/AMqX/wBqr6Ar4Ar3/wD5OM/6l7+wv+3vz/P/AO/e3b5Pvnd2xyfsy/8AM0/9un/tauA+Jvwy/wCFc/2X/wATf+0Pt/m/8u3lbNmz/bbOd/t0rv8A/hmX/qbv/Kb/APbaP+Gmv+pR/wDKl/8Aaq4D4m/E3/hY39l/8Sj+z/sHm/8ALz5u/fs/2FxjZ79a7/8A5Nz/AOph/t3/ALdPI8j/AL+bt3ne2NvfPHoHwy+GX/Cuf7U/4m/9ofb/ACv+Xbytmzf/ALbZzv8AbpXn/wDybn/1MP8Abv8A26eR5H/fzdu872xt7544D4m/E3/hY39l/wDEo/s/7B5v/Lz5u/fs/wBhcY2e/Wvr+vn/APZl/wCZp/7dP/a1H7Mv/M0/9un/ALWo/wCTc/8AqYf7d/7dPI8j/v5u3ed7Y2988H7TX/Mrf9vf/tGvoCiiiivn/wDaa/5lb/t7/wDaNH/DTX/Uo/8AlS/+1V6B8Tfib/wrn+y/+JR/aH2/zf8Al58rZs2f7DZzv9ulef8A/DMv/U3f+U3/AO21wHxN+Jv/AAsb+y/+JR/Z/wBg83/l583fv2f7C4xs9+tef17/APsy/wDM0/8Abp/7WrgPhl8Mv+Fjf2p/xN/7P+weV/y7ebv37/8AbXGNnv1rv/2Zf+Zp/wC3T/2tR+01/wAyt/29/wDtGj/k4z/qXv7C/wC3vz/P/wC/e3b5Pvnd2xz9AV8//wDDMv8A1N3/AJTf/ttcB8Tfhl/wrn+y/wDib/2h9v8AN/5dvK2bNn+22c7/AG6V3/8AycZ/1L39hf8Ab35/n/8Afvbt8n3zu7Y5P2Zf+Zp/7dP/AGtR/wAm5/8AUw/27/26eR5H/fzdu872xt7549A+GXxN/wCFjf2p/wASj+z/ALB5X/Lz5u/fv/2FxjZ79a8A+GXwy/4WN/an/E3/ALP+weV/y7ebv37/APbXGNnv1r3/AOGXwy/4Vz/an/E3/tD7f5X/AC7eVs2b/wDbbOd/t0o+JvxN/wCFc/2X/wASj+0Pt/m/8vPlbNmz/YbOd/t0rz//AIaa/wCpR/8AKl/9qo/4Zl/6m7/ym/8A22vQPhl8Mv8AhXP9qf8AE3/tD7f5X/Lt5WzZv/22znf7dKPhl8Tf+Fjf2p/xKP7P+weV/wAvPm79+/8A2FxjZ79a8A+Jvwy/4Vz/AGX/AMTf+0Pt/m/8u3lbNmz/AG2znf7dK9/+GXxN/wCFjf2p/wASj+z/ALB5X/Lz5u/fv/2FxjZ79a9Aooor5/8A+Gmv+pR/8qX/ANqr6Ar5A+GXxN/4Vz/an/Eo/tD7f5X/AC8+Vs2b/wDYbOd/t0rv/wDk3P8A6mH+3f8At08jyP8Av5u3ed7Y2988H/Juf/Uw/wBu/wDbp5Hkf9/N27zvbG3vng/4aa/6lH/ypf8A2quA+JvxN/4WN/Zf/Eo/s/7B5v8Ay8+bv37P9hcY2e/Wvf8A4ZfDL/hXP9qf8Tf+0Pt/lf8ALt5WzZv/ANts53+3SvP/ANmX/maf+3T/ANrUf8My/wDU3f8AlN/+216B8Mvib/wsb+1P+JR/Z/2Dyv8Al583fv3/AOwuMbPfrXn/APycZ/1L39hf9vfn+f8A9+9u3yffO7tjk/4aa/6lH/ypf/aq9A+GXwy/4Vz/AGp/xN/7Q+3+V/y7eVs2b/8AbbOd/t0rwD4m/E3/AIWN/Zf/ABKP7P8AsHm/8vPm79+z/YXGNnv1r3/4ZfDL/hXP9qf8Tf8AtD7f5X/Lt5WzZv8A9ts53+3SvP8A/hpr/qUf/Kl/9qrgPhl8Tf8AhXP9qf8AEo/tD7f5X/Lz5WzZv/2Gznf7dK7/AP4Zl/6m7/ym/wD22j9mX/maf+3T/wBrUf8AJxn/AFL39hf9vfn+f/3727fJ987u2OT/AIaa/wCpR/8AKl/9qr0D4m/DL/hY39l/8Tf+z/sHm/8ALt5u/fs/21xjZ79a8/8A+GZf+pu/8pv/ANtr0D4ZfDL/AIVz/an/ABN/7Q+3+V/y7eVs2b/9ts53+3SvAPib8Mv+Fc/2X/xN/wC0Pt/m/wDLt5WzZs/22znf7dK7/wDZl/5mn/t0/wDa1fQFFFFef/DL4m/8LG/tT/iUf2f9g8r/AJefN379/wDsLjGz3614B8Tfhl/wrn+y/wDib/2h9v8AN/5dvK2bNn+22c7/AG6UfDL4m/8ACuf7U/4lH9ofb/K/5efK2bN/+w2c7/bpXf8A/DMv/U3f+U3/AO20f8nGf9S9/YX/AG9+f5//AH727fJ987u2OeA+GXwy/wCFjf2p/wATf+z/ALB5X/Lt5u/fv/21xjZ79a7/AP4aa/6lH/ypf/aq4D4m/DL/AIVz/Zf/ABN/7Q+3+b/y7eVs2bP9ts53+3Su/wD2Zf8Amaf+3T/2tXAfDL4Zf8LG/tT/AIm/9n/YPK/5dvN379/+2uMbPfrR8Tfib/wsb+y/+JR/Z/2Dzf8Al583fv2f7C4xs9+tHwy+GX/Cxv7U/wCJv/Z/2Dyv+Xbzd+/f/trjGz3615/X1/8ADL4Zf8K5/tT/AIm/9ofb/K/5dvK2bN/+22c7/bpXgHwy+Jv/AArn+1P+JR/aH2/yv+Xnytmzf/sNnO/26UfE34m/8LG/sv8A4lH9n/YPN/5efN379n+wuMbPfrXf/tNf8yt/29/+0aP+TjP+pe/sL/t78/z/APv3t2+T753dscn7Mv8AzNP/AG6f+1q4D4ZfDL/hY39qf8Tf+z/sHlf8u3m79+//AG1xjZ79a+v68/8Ahl8Tf+Fjf2p/xKP7P+weV/y8+bv37/8AYXGNnv1rz/8A5Nz/AOph/t3/ALdPI8j/AL+bt3ne2NvfPHoHxN+Jv/Cuf7L/AOJR/aH2/wA3/l58rZs2f7DZzv8AbpXgHwy+GX/Cxv7U/wCJv/Z/2Dyv+Xbzd+/f/trjGz360fDL4Zf8LG/tT/ib/wBn/YPK/wCXbzd+/f8A7a4xs9+tfX9FFFFfIHxN+GX/AArn+y/+Jv8A2h9v83/l28rZs2f7bZzv9uld/wD8m5/9TD/bv/bp5Hkf9/N27zvbG3vnjgPhl8Tf+Fc/2p/xKP7Q+3+V/wAvPlbNm/8A2Gznf7dKPib8Mv8AhXP9l/8AE3/tD7f5v/Lt5WzZs/22znf7dK7/AP5OM/6l7+wv+3vz/P8A+/e3b5Pvnd2xz6B8Mvib/wALG/tT/iUf2f8AYPK/5efN379/+wuMbPfrXyBX1/8AE34m/wDCuf7L/wCJR/aH2/zf+XnytmzZ/sNnO/26UfDL4m/8LG/tT/iUf2f9g8r/AJefN379/wDsLjGz3615/wDsy/8AM0/9un/taj/k3P8A6mH+3f8At08jyP8Av5u3ed7Y2988eAV9f/DL4m/8LG/tT/iUf2f9g8r/AJefN379/wDsLjGz3614B8Tfib/wsb+y/wDiUf2f9g83/l583fv2f7C4xs9+td/+01/zK3/b3/7Rr6Ar5/8A+TjP+pe/sL/t78/z/wDv3t2+T753dsc+gfDL4Zf8K5/tT/ib/wBofb/K/wCXbytmzf8A7bZzv9ulef8A/DMv/U3f+U3/AO21wHwy+GX/AAsb+1P+Jv8A2f8AYPK/5dvN379/+2uMbPfrXf8A/Jxn/Uvf2F/29+f5/wD3727fJ987u2OfQPib8Tf+Fc/2X/xKP7Q+3+b/AMvPlbNmz/YbOd/t0rz/AP5Nz/6mH+3f+3TyPI/7+bt3ne2NvfPB/wAm5/8AUw/27/26eR5H/fzdu872xt754+gK+QPhl8Mv+Fjf2p/xN/7P+weV/wAu3m79+/8A21xjZ79a+v6KKKK8/wDib8Tf+Fc/2X/xKP7Q+3+b/wAvPlbNmz/YbOd/t0rz/wDaa/5lb/t7/wDaNH7Mv/M0/wDbp/7Wo/5Nz/6mH+3f+3TyPI/7+bt3ne2NvfPB/wAMy/8AU3f+U3/7bXoHwy+GX/Cuf7U/4m/9ofb/ACv+Xbytmzf/ALbZzv8AbpR8Mvib/wALG/tT/iUf2f8AYPK/5efN379/+wuMbPfrXn//AA01/wBSj/5Uv/tVH/DMv/U3f+U3/wC21wHxN+Jv/Cxv7L/4lH9n/YPN/wCXnzd+/Z/sLjGz360fDL4m/wDCuf7U/wCJR/aH2/yv+Xnytmzf/sNnO/26UfE34Zf8K5/sv/ib/wBofb/N/wCXbytmzZ/ttnO/26V3/wDycZ/1L39hf9vfn+f/AN+9u3yffO7tjk/5OM/6l7+wv+3vz/P/AO/e3b5Pvnd2xz6B8Mvhl/wrn+1P+Jv/AGh9v8r/AJdvK2bN/wDttnO/26V4B8Tfib/wsb+y/wDiUf2f9g83/l583fv2f7C4xs9+tHxN+Jv/AAsb+y/+JR/Z/wBg83/l583fv2f7C4xs9+tHxN+GX/Cuf7L/AOJv/aH2/wA3/l28rZs2f7bZzv8AbpXv/wAMvhl/wrn+1P8Aib/2h9v8r/l28rZs3/7bZzv9ulHxN+GX/Cxv7L/4m/8AZ/2Dzf8Al283fv2f7a4xs9+tHxN+GX/Cxv7L/wCJv/Z/2Dzf+Xbzd+/Z/trjGz3614B8Mvhl/wALG/tT/ib/ANn/AGDyv+Xbzd+/f/trjGz3613/APybn/1MP9u/9unkeR/383bvO9sbe+ePoCvn/wD4Zl/6m7/ym/8A22j9pr/mVv8At7/9o0fsy/8AM0/9un/tavoCiiivn/8A4Zl/6m7/AMpv/wBtr6Ar5/8A2Zf+Zp/7dP8A2tR/wzL/ANTd/wCU3/7bR/ycZ/1L39hf9vfn+f8A9+9u3yffO7tjk/Zl/wCZp/7dP/a1H/Juf/Uw/wBu/wDbp5Hkf9/N27zvbG3vng/5Nz/6mH+3f+3TyPI/7+bt3ne2NvfPHoHxN+GX/Cxv7L/4m/8AZ/2Dzf8Al283fv2f7a4xs9+teAfE34Zf8K5/sv8A4m/9ofb/ADf+XbytmzZ/ttnO/wBulHxN+Jv/AAsb+y/+JR/Z/wBg83/l583fv2f7C4xs9+td/wD8NNf9Sj/5Uv8A7VXoHwy+GX/Cuf7U/wCJv/aH2/yv+Xbytmzf/ttnO/26V5//AMNNf9Sj/wCVL/7VR/ybn/1MP9u/9unkeR/383bvO9sbe+ePoCvn/wD5OM/6l7+wv+3vz/P/AO/e3b5Pvnd2xzwHwy+GX/Cxv7U/4m/9n/YPK/5dvN379/8AtrjGz3617/8ADL4Zf8K5/tT/AIm/9ofb/K/5dvK2bN/+22c7/bpXn/8AwzL/ANTd/wCU3/7bXgFe/wD/AA01/wBSj/5Uv/tVegfDL4Zf8K5/tT/ib/2h9v8AK/5dvK2bN/8AttnO/wBulef/APDMv/U3f+U3/wC216B8Mvhl/wAK5/tT/ib/ANofb/K/5dvK2bN/+22c7/bpR8Mvhl/wrn+1P+Jv/aH2/wAr/l28rZs3/wC22c7/AG6V6BRRRRXyB8Tfib/wsb+y/wDiUf2f9g83/l583fv2f7C4xs9+tHwy+GX/AAsb+1P+Jv8A2f8AYPK/5dvN379/+2uMbPfrR8Mvhl/wsb+1P+Jv/Z/2Dyv+Xbzd+/f/ALa4xs9+td//AMMy/wDU3f8AlN/+21wHwy+GX/Cxv7U/4m/9n/YPK/5dvN379/8AtrjGz3617/8ADL4Zf8K5/tT/AIm/9ofb/K/5dvK2bN/+22c7/bpXgHwy+GX/AAsb+1P+Jv8A2f8AYPK/5dvN379/+2uMbPfrR8Tfib/wsb+y/wDiUf2f9g83/l583fv2f7C4xs9+td//AMNNf9Sj/wCVL/7VR/ybn/1MP9u/9unkeR/383bvO9sbe+eD/hpr/qUf/Kl/9qo/4aa/6lH/AMqX/wBqrgPhl8Mv+Fjf2p/xN/7P+weV/wAu3m79+/8A21xjZ79a7/8A4Zl/6m7/AMpv/wBtrgPhl8Tf+Fc/2p/xKP7Q+3+V/wAvPlbNm/8A2Gznf7dK8/r6/wDhl8Tf+Fjf2p/xKP7P+weV/wAvPm79+/8A2FxjZ79aPhl8Mv8AhXP9qf8AE3/tD7f5X/Lt5WzZv/22znf7dK8//wCGmv8AqUf/ACpf/aqP+GZf+pu/8pv/ANtrgPib8Mv+Fc/2X/xN/wC0Pt/m/wDLt5WzZs/22znf7dKPib8Mv+Fc/wBl/wDE3/tD7f5v/Lt5WzZs/wBts53+3Sj4ZfDL/hY39qf8Tf8As/7B5X/Lt5u/fv8A9tcY2e/Wu/8A+GZf+pu/8pv/ANto/Zl/5mn/ALdP/a1cB8Tfhl/wrn+y/wDib/2h9v8AN/5dvK2bNn+22c7/AG6V7/8ADL4m/wDCxv7U/wCJR/Z/2Dyv+Xnzd+/f/sLjGz3616BRRRXyB8Tfhl/wrn+y/wDib/2h9v8AN/5dvK2bNn+22c7/AG6V7/8ADL4Zf8K5/tT/AIm/9ofb/K/5dvK2bN/+22c7/bpXn/7Mv/M0/wDbp/7Wr0D4ZfDL/hXP9qf8Tf8AtD7f5X/Lt5WzZv8A9ts53+3SvAPhl8Mv+Fjf2p/xN/7P+weV/wAu3m79+/8A21xjZ79a7/8Aaa/5lb/t7/8AaNH/AA01/wBSj/5Uv/tVcB8Mvib/AMK5/tT/AIlH9ofb/K/5efK2bN/+w2c7/bpXv/xN+Jv/AArn+y/+JR/aH2/zf+XnytmzZ/sNnO/26V4B8Tfib/wsb+y/+JR/Z/2Dzf8Al583fv2f7C4xs9+td/8AtNf8yt/29/8AtGuA+Jvwy/4Vz/Zf/E3/ALQ+3+b/AMu3lbNmz/bbOd/t0rv/ANmX/maf+3T/ANrV6B8Mvhl/wrn+1P8Aib/2h9v8r/l28rZs3/7bZzv9uleAfDL4m/8ACuf7U/4lH9ofb/K/5efK2bN/+w2c7/bpXf8A7Mv/ADNP/bp/7Wr0D4m/DL/hY39l/wDE3/s/7B5v/Lt5u/fs/wBtcY2e/WvAPib8Mv8AhXP9l/8AE3/tD7f5v/Lt5WzZs/22znf7dK9/+Jvwy/4WN/Zf/E3/ALP+web/AMu3m79+z/bXGNnv1rwD4ZfDL/hY39qf8Tf+z/sHlf8ALt5u/fv/ANtcY2e/Wvf/AIZfE3/hY39qf8Sj+z/sHlf8vPm79+//AGFxjZ79a9Ar5/8A2Zf+Zp/7dP8A2tXoHwy+GX/Cuf7U/wCJv/aH2/yv+Xbytmzf/ttnO/26V5/+zL/zNP8A26f+1q+gK8/+GXxN/wCFjf2p/wASj+z/ALB5X/Lz5u/fv/2FxjZ79a9Aooor5/8A+Gmv+pR/8qX/ANqo/wCTc/8AqYf7d/7dPI8j/v5u3ed7Y2988cB8Mvhl/wALG/tT/ib/ANn/AGDyv+Xbzd+/f/trjGz3613/APwzL/1N3/lN/wDttcB8Tfhl/wAK5/sv/ib/ANofb/N/5dvK2bNn+22c7/bpR8Tfhl/wrn+y/wDib/2h9v8AN/5dvK2bNn+22c7/AG6UfDL4m/8ACuf7U/4lH9ofb/K/5efK2bN/+w2c7/bpXf8A7Mv/ADNP/bp/7Wo/Zl/5mn/t0/8Aa1H/AAzL/wBTd/5Tf/ttH/DMv/U3f+U3/wC20f8ADTX/AFKP/lS/+1V4BXv/APwzL/1N3/lN/wDttegfDL4Zf8K5/tT/AIm/9ofb/K/5dvK2bN/+22c7/bpXgHwy+GX/AAsb+1P+Jv8A2f8AYPK/5dvN379/+2uMbPfrR8Tfhl/wrn+y/wDib/2h9v8AN/5dvK2bNn+22c7/AG6V9f15/wDDL4Zf8K5/tT/ib/2h9v8AK/5dvK2bN/8AttnO/wBulHxN+GX/AAsb+y/+Jv8A2f8AYPN/5dvN379n+2uMbPfrR8Tfhl/wsb+y/wDib/2f9g83/l283fv2f7a4xs9+teAfDL4Zf8LG/tT/AIm/9n/YPK/5dvN379/+2uMbPfrXf/8ADMv/AFN3/lN/+21wHwy+GX/Cxv7U/wCJv/Z/2Dyv+Xbzd+/f/trjGz3615/X1/8ADL4Zf8K5/tT/AIm/9ofb/K/5dvK2bN/+22c7/bpXn/7Mv/M0/wDbp/7Wr6Aooor5/wD+Gmv+pR/8qX/2quA+GXwy/wCFjf2p/wATf+z/ALB5X/Lt5u/fv/21xjZ79aPhl8Mv+Fjf2p/xN/7P+weV/wAu3m79+/8A21xjZ79a7/8A5Nz/AOph/t3/ALdPI8j/AL+bt3ne2NvfPB/w01/1KP8A5Uv/ALVXoHxN+Jv/AArn+y/+JR/aH2/zf+XnytmzZ/sNnO/26V5//wANNf8AUo/+VL/7VR/w01/1KP8A5Uv/ALVR/wAm5/8AUw/27/26eR5H/fzdu872xt7549A+Jvwy/wCFjf2X/wATf+z/ALB5v/Lt5u/fs/21xjZ79a8//wCGmv8AqUf/ACpf/aqP+TjP+pe/sL/t78/z/wDv3t2+T753dscn/Jxn/Uvf2F/29+f5/wD3727fJ987u2OeA+GXxN/4Vz/an/Eo/tD7f5X/AC8+Vs2b/wDYbOd/t0rv/wBpr/mVv+3v/wBo1wHxN+Jv/Cxv7L/4lH9n/YPN/wCXnzd+/Z/sLjGz360fDL4m/wDCuf7U/wCJR/aH2/yv+Xnytmzf/sNnO/26V7/8Tfib/wAK5/sv/iUf2h9v83/l58rZs2f7DZzv9ulHwy+GX/Cuf7U/4m/9ofb/ACv+Xbytmzf/ALbZzv8AbpXyBXv/APycZ/1L39hf9vfn+f8A9+9u3yffO7tjngPib8Tf+Fjf2X/xKP7P+web/wAvPm79+z/YXGNnv1o+Jvwy/wCFc/2X/wATf+0Pt/m/8u3lbNmz/bbOd/t0r3/4ZfDL/hXP9qf8Tf8AtD7f5X/Lt5WzZv8A9ts53+3SvP8A/hmX/qbv/Kb/APbaP2mv+ZW/7e//AGjX0BRRRRXz/wDsy/8AM0/9un/tavQPib8Mv+Fjf2X/AMTf+z/sHm/8u3m79+z/AG1xjZ79a8//AGmv+ZW/7e//AGjXAfE34Zf8K5/sv/ib/wBofb/N/wCXbytmzZ/ttnO/26V9f18//tNf8yt/29/+0a+gK8/+GXwy/wCFc/2p/wATf+0Pt/lf8u3lbNm//bbOd/t0rwD4m/DL/hXP9l/8Tf8AtD7f5v8Ay7eVs2bP9ts53+3Sj4ZfDL/hY39qf8Tf+z/sHlf8u3m79+//AG1xjZ79a8/r3/8A5OM/6l7+wv8At78/z/8Av3t2+T753dscn/DMv/U3f+U3/wC20f8AJuf/AFMP9u/9unkeR/383bvO9sbe+eOA+GXwy/4WN/an/E3/ALP+weV/y7ebv37/APbXGNnv1o+GXxN/4Vz/AGp/xKP7Q+3+V/y8+Vs2b/8AYbOd/t0o+JvxN/4WN/Zf/Eo/s/7B5v8Ay8+bv37P9hcY2e/Wvf8A4ZfE3/hY39qf8Sj+z/sHlf8ALz5u/fv/ANhcY2e/WvkCvr/4m/E3/hXP9l/8Sj+0Pt/m/wDLz5WzZs/2Gznf7dK8/wD2mv8AmVv+3v8A9o1wHwy+GX/Cxv7U/wCJv/Z/2Dyv+Xbzd+/f/trjGz3617/8Tfhl/wALG/sv/ib/ANn/AGDzf+Xbzd+/Z/trjGz360fE34Zf8LG/sv8A4m/9n/YPN/5dvN379n+2uMbPfrXn/wDw01/1KP8A5Uv/ALVR/wAm5/8AUw/27/26eR5H/fzdu872xt754P2Zf+Zp/wC3T/2tX0BRRRXwBXoHxN+GX/Cuf7L/AOJv/aH2/wA3/l28rZs2f7bZzv8AbpR8Mvib/wAK5/tT/iUf2h9v8r/l58rZs3/7DZzv9ule/wDwy+GX/Cuf7U/4m/8AaH2/yv8Al28rZs3/AO22c7/bpXn/AO01/wAyt/29/wDtGuA+JvxN/wCFjf2X/wASj+z/ALB5v/Lz5u/fs/2FxjZ79aPib8Tf+Fjf2X/xKP7P+web/wAvPm79+z/YXGNnv1o+JvxN/wCFjf2X/wASj+z/ALB5v/Lz5u/fs/2FxjZ79aPhl8Mv+Fjf2p/xN/7P+weV/wAu3m79+/8A21xjZ79a9/8Aib8Mv+Fjf2X/AMTf+z/sHm/8u3m79+z/AG1xjZ79a9Arz/4m/E3/AIVz/Zf/ABKP7Q+3+b/y8+Vs2bP9hs53+3SvkCvf/wBpr/mVv+3v/wBo16B8Tfhl/wALG/sv/ib/ANn/AGDzf+Xbzd+/Z/trjGz3615/+zL/AMzT/wBun/tauA+GXxN/4Vz/AGp/xKP7Q+3+V/y8+Vs2b/8AYbOd/t0o+GXxN/4Vz/an/Eo/tD7f5X/Lz5WzZv8A9hs53+3Svr+vn/8AZl/5mn/t0/8Aa1egfDL4m/8ACxv7U/4lH9n/AGDyv+Xnzd+/f/sLjGz3615//wANNf8AUo/+VL/7VR/wzL/1N3/lN/8AttegfDL4m/8ACxv7U/4lH9n/AGDyv+Xnzd+/f/sLjGz3615//wAnGf8AUvf2F/29+f5//fvbt8n3zu7Y59A+Jvwy/wCFjf2X/wATf+z/ALB5v/Lt5u/fs/21xjZ79aPhl8Mv+Fc/2p/xN/7Q+3+V/wAu3lbNm/8A22znf7dK9Aooorz/AOJvwy/4WN/Zf/E3/s/7B5v/AC7ebv37P9tcY2e/Wj4ZfE3/AIWN/an/ABKP7P8AsHlf8vPm79+//YXGNnv1r0CvkD4m/DL/AIVz/Zf/ABN/7Q+3+b/y7eVs2bP9ts53+3SvP6+v/hl8Tf8AhY39qf8AEo/s/wCweV/y8+bv37/9hcY2e/WvAPib8Mv+Fc/2X/xN/wC0Pt/m/wDLt5WzZs/22znf7dK7/wDaa/5lb/t7/wDaNH7TX/Mrf9vf/tGj/k4z/qXv7C/7e/P8/wD797dvk++d3bHJ+01/zK3/AG9/+0a4D4m/E3/hY39l/wDEo/s/7B5v/Lz5u/fs/wBhcY2e/Wu//wCTc/8AqYf7d/7dPI8j/v5u3ed7Y2988cB8Tfib/wALG/sv/iUf2f8AYPN/5efN379n+wuMbPfrXv8A8Tfib/wrn+y/+JR/aH2/zf8Al58rZs2f7DZzv9uleAfDL4Zf8LG/tT/ib/2f9g8r/l283fv3/wC2uMbPfrR8Mvhl/wALG/tT/ib/ANn/AGDyv+Xbzd+/f/trjGz360fE34m/8LG/sv8A4lH9n/YPN/5efN379n+wuMbPfrXf/sy/8zT/ANun/tauA+Jvwy/4Vz/Zf/E3/tD7f5v/AC7eVs2bP9ts53+3Svf/AIm/E3/hXP8AZf8AxKP7Q+3+b/y8+Vs2bP8AYbOd/t0rz/8AZl/5mn/t0/8Aa1H/ACbn/wBTD/bv/bp5Hkf9/N27zvbG3vnj6Ar5A+JvxN/4WN/Zf/Eo/s/7B5v/AC8+bv37P9hcY2e/WvP69/8A2Zf+Zp/7dP8A2tX0BRRRXwBXoHwy+GX/AAsb+1P+Jv8A2f8AYPK/5dvN379/+2uMbPfrXn9e/wD/AAzL/wBTd/5Tf/ttH/DTX/Uo/wDlS/8AtVH7TX/Mrf8Ab3/7RrgPhl8Mv+Fjf2p/xN/7P+weV/y7ebv37/8AbXGNnv1rv/8Ak4z/AKl7+wv+3vz/AD/+/e3b5Pvnd2xz6B8Tfib/AMK5/sv/AIlH9ofb/N/5efK2bNn+w2c7/bpXn/8Aybn/ANTD/bv/AG6eR5H/AH83bvO9sbe+ePQPib8Mv+Fjf2X/AMTf+z/sHm/8u3m79+z/AG1xjZ79aPib8Tf+Fc/2X/xKP7Q+3+b/AMvPlbNmz/YbOd/t0o+Jvwy/4WN/Zf8AxN/7P+web/y7ebv37P8AbXGNnv1rz/8A5OM/6l7+wv8At78/z/8Av3t2+T753dscn/Juf/Uw/wBu/wDbp5Hkf9/N27zvbG3vnj6Ar5//AGZf+Zp/7dP/AGtXoHwy+Jv/AAsb+1P+JR/Z/wBg8r/l583fv3/7C4xs9+tef/8ADMv/AFN3/lN/+21wHxN+GX/Cuf7L/wCJv/aH2/zf+XbytmzZ/ttnO/26V7/8Tfib/wAK5/sv/iUf2h9v83/l58rZs2f7DZzv9ulef/8ADTX/AFKP/lS/+1VwHwy+Jv8Awrn+1P8AiUf2h9v8r/l58rZs3/7DZzv9uld//wAnGf8AUvf2F/29+f5//fvbt8n3zu7Y59A+GXwy/wCFc/2p/wATf+0Pt/lf8u3lbNm//bbOd/t0rz//AJOM/wCpe/sL/t78/wA//v3t2+T753dsc/QFFFFFef8Awy+Jv/Cxv7U/4lH9n/YPK/5efN379/8AsLjGz3615/8AtNf8yt/29/8AtGuA+GXxN/4Vz/an/Eo/tD7f5X/Lz5WzZv8A9hs53+3Su/8A+Tc/+ph/t3/t08jyP+/m7d53tjb3zwf8m5/9TD/bv/bp5Hkf9/N27zvbG3vng/4Zl/6m7/ym/wD22j9mX/maf+3T/wBrUf8AJxn/AFL39hf9vfn+f/3727fJ987u2OfoCvn/AP5OM/6l7+wv+3vz/P8A+/e3b5Pvnd2xyf8ADMv/AFN3/lN/+20ftNf8yt/29/8AtGvQPhl8Tf8AhY39qf8AEo/s/wCweV/y8+bv37/9hcY2e/WvP/8Ahpr/AKlH/wAqX/2quA+Jvwy/4Vz/AGX/AMTf+0Pt/m/8u3lbNmz/AG2znf7dKPib8Tf+Fjf2X/xKP7P+web/AMvPm79+z/YXGNnv1r3/AOJvwy/4WN/Zf/E3/s/7B5v/AC7ebv37P9tcY2e/WvP/APhmX/qbv/Kb/wDbaP8Ak3P/AKmH+3f+3TyPI/7+bt3ne2NvfPB/w01/1KP/AJUv/tVegfDL4Zf8K5/tT/ib/wBofb/K/wCXbytmzf8A7bZzv9ulHwy+GX/Cuf7U/wCJv/aH2/yv+Xbytmzf/ttnO/26V4B8Mvib/wAK5/tT/iUf2h9v8r/l58rZs3/7DZzv9ule/wDxN+GX/Cxv7L/4m/8AZ/2Dzf8Al283fv2f7a4xs9+tfIFfX/xN+GX/AAsb+y/+Jv8A2f8AYPN/5dvN379n+2uMbPfrR8Mvib/wsb+1P+JR/Z/2Dyv+Xnzd+/f/ALC4xs9+tegUUUV8gfE34Zf8K5/sv/ib/wBofb/N/wCXbytmzZ/ttnO/26V3/wDycZ/1L39hf9vfn+f/AN+9u3yffO7tjk/4Zl/6m7/ym/8A22j/AIZl/wCpu/8AKb/9trgPib8Mv+Fc/wBl/wDE3/tD7f5v/Lt5WzZs/wBts53+3Sj4ZfDL/hY39qf8Tf8As/7B5X/Lt5u/fv8A9tcY2e/Wu/8A+GZf+pu/8pv/ANtr0D4ZfE3/AIWN/an/ABKP7P8AsHlf8vPm79+//YXGNnv1r5Ar3/8A5OM/6l7+wv8At78/z/8Av3t2+T753dsc+gfDL4Zf8K5/tT/ib/2h9v8AK/5dvK2bN/8AttnO/wBulef/APDTX/Uo/wDlS/8AtVegfDL4Zf8ACuf7U/4m/wDaH2/yv+Xbytmzf/ttnO/26UfDL4Zf8K5/tT/ib/2h9v8AK/5dvK2bN/8AttnO/wBulHwy+GX/AArn+1P+Jv8A2h9v8r/l28rZs3/7bZzv9ulHwy+Jv/Cxv7U/4lH9n/YPK/5efN379/8AsLjGz3614B8Tfib/AMLG/sv/AIlH9n/YPN/5efN379n+wuMbPfrXf/8ADMv/AFN3/lN/+216B8Tfhl/wsb+y/wDib/2f9g83/l283fv2f7a4xs9+tef/ALTX/Mrf9vf/ALRo/wCTjP8AqXv7C/7e/P8AP/797dvk++d3bHJ/w01/1KP/AJUv/tVH/DMv/U3f+U3/AO20f8nGf9S9/YX/AG9+f5//AH727fJ987u2OT/hmX/qbv8Aym//AG2vAK+v/hl8Tf8AhY39qf8AEo/s/wCweV/y8+bv37/9hcY2e/WvQKKKKK8/+Jvwy/4WN/Zf/E3/ALP+web/AMu3m79+z/bXGNnv1r0Cvn//AIZl/wCpu/8AKb/9to/Zl/5mn/t0/wDa1fQFfIHxN+GX/Cuf7L/4m/8AaH2/zf8Al28rZs2f7bZzv9ule/8Awy+GX/Cuf7U/4m/9ofb/ACv+Xbytmzf/ALbZzv8AbpR8Mvib/wALG/tT/iUf2f8AYPK/5efN379/+wuMbPfrXgHxN+Jv/Cxv7L/4lH9n/YPN/wCXnzd+/Z/sLjGz3613/wC01/zK3/b3/wC0a4D4ZfE3/hXP9qf8Sj+0Pt/lf8vPlbNm/wD2Gznf7dKPhl8Mv+Fjf2p/xN/7P+weV/y7ebv37/8AbXGNnv1rv/8AhmX/AKm7/wApv/22j9mX/maf+3T/ANrUf8My/wDU3f8AlN/+20f8nGf9S9/YX/b35/n/APfvbt8n3zu7Y59A+GXwy/4Vz/an/E3/ALQ+3+V/y7eVs2b/APbbOd/t0rz/APZl/wCZp/7dP/a1H/DMv/U3f+U3/wC216B8Tfib/wAK5/sv/iUf2h9v83/l58rZs2f7DZzv9ulef/sy/wDM0/8Abp/7WrgPhl8Mv+Fjf2p/xN/7P+weV/y7ebv37/8AbXGNnv1rv/8AhmX/AKm7/wApv/22j9mX/maf+3T/ANrUf8m5/wDUw/27/wBunkeR/wB/N27zvbG3vnj0D4ZfE3/hY39qf8Sj+z/sHlf8vPm79+//AGFxjZ79a9Aooor5A+GXwy/4WN/an/E3/s/7B5X/AC7ebv37/wDbXGNnv1rv/wDhmX/qbv8Aym//AG2j/hmX/qbv/Kb/APbaP2Zf+Zp/7dP/AGtR/wANNf8AUo/+VL/7VXoHwy+GX/Cuf7U/4m/9ofb/ACv+Xbytmzf/ALbZzv8AbpXgHwy+GX/Cxv7U/wCJv/Z/2Dyv+Xbzd+/f/trjGz3613//ACbn/wBTD/bv/bp5Hkf9/N27zvbG3vnjwCvr/wCJvxN/4Vz/AGX/AMSj+0Pt/m/8vPlbNmz/AGGznf7dK8//AOTc/wDqYf7d/wC3TyPI/wC/m7d53tjb3zwfsy/8zT/26f8Ataj9mX/maf8At0/9rV6B8Mvhl/wrn+1P+Jv/AGh9v8r/AJdvK2bN/wDttnO/26V4B8Mvib/wrn+1P+JR/aH2/wAr/l58rZs3/wCw2c7/AG6V7/8ADL4m/wDCxv7U/wCJR/Z/2Dyv+Xnzd+/f/sLjGz3615/+01/zK3/b3/7Ro/5Nz/6mH+3f+3TyPI/7+bt3ne2NvfPB/wAm5/8AUw/27/26eR5H/fzdu872xt7544D4ZfE3/hXP9qf8Sj+0Pt/lf8vPlbNm/wD2Gznf7dKPhl8Mv+Fjf2p/xN/7P+weV/y7ebv37/8AbXGNnv1rv/8Ak4z/AKl7+wv+3vz/AD/+/e3b5Pvnd2xyfsy/8zT/ANun/tavQPhl8Mv+Fc/2p/xN/wC0Pt/lf8u3lbNm/wD22znf7dK8/wD2Zf8Amaf+3T/2tX0BXn/wy+Jv/Cxv7U/4lH9n/YPK/wCXnzd+/f8A7C4xs9+tegUUUV8//sy/8zT/ANun/tavAK9//Zl/5mn/ALdP/a1H7Mv/ADNP/bp/7WrgPhl8Tf8AhXP9qf8AEo/tD7f5X/Lz5WzZv/2Gznf7dK9/+JvxN/4Vz/Zf/Eo/tD7f5v8Ay8+Vs2bP9hs53+3Sj4ZfDL/hXP8Aan/E3/tD7f5X/Lt5WzZv/wBts53+3Sj4m/E3/hXP9l/8Sj+0Pt/m/wDLz5WzZs/2Gznf7dK8/wD+Tc/+ph/t3/t08jyP+/m7d53tjb3zx9AV8/8A/Juf/Uw/27/26eR5H/fzdu872xt754P+Tc/+ph/t3/t08jyP+/m7d53tjb3zx4BXoHwy+GX/AAsb+1P+Jv8A2f8AYPK/5dvN379/+2uMbPfrXf8A/DMv/U3f+U3/AO216B8Tfhl/wsb+y/8Aib/2f9g83/l283fv2f7a4xs9+tef/wDDMv8A1N3/AJTf/ttegfE34m/8K5/sv/iUf2h9v83/AJefK2bNn+w2c7/bpR8Tfib/AMK5/sv/AIlH9ofb/N/5efK2bNn+w2c7/bpXn/8Aybn/ANTD/bv/AG6eR5H/AH83bvO9sbe+ePQPhl8Tf+Fjf2p/xKP7P+weV/y8+bv37/8AYXGNnv1rz/8AZl/5mn/t0/8Aa1eAV7//AMMy/wDU3f8AlN/+21wHxN+GX/Cuf7L/AOJv/aH2/wA3/l28rZs2f7bZzv8AbpR8Mvhl/wALG/tT/ib/ANn/AGDyv+Xbzd+/f/trjGz3619f0UUUV8//ALMv/M0/9un/ALWo/wCGZf8Aqbv/ACm//ba9A+GXwy/4Vz/an/E3/tD7f5X/AC7eVs2b/wDbbOd/t0rz/wDZl/5mn/t0/wDa1H/Juf8A1MP9u/8Abp5Hkf8Afzdu872xt7549A+Jvwy/4WN/Zf8AxN/7P+web/y7ebv37P8AbXGNnv1o+JvxN/4Vz/Zf/Eo/tD7f5v8Ay8+Vs2bP9hs53+3SvAPhl8Tf+Fc/2p/xKP7Q+3+V/wAvPlbNm/8A2Gznf7dKPhl8Mv8AhY39qf8AE3/s/wCweV/y7ebv37/9tcY2e/Wj4ZfDL/hY39qf8Tf+z/sHlf8ALt5u/fv/ANtcY2e/WvP6+v8A4ZfDL/hXP9qf8Tf+0Pt/lf8ALt5WzZv/ANts53+3Sj4ZfDL/AIVz/an/ABN/7Q+3+V/y7eVs2b/9ts53+3SvkCvQPhl8Mv8AhY39qf8AE3/s/wCweV/y7ebv37/9tcY2e/Wj4ZfE3/hXP9qf8Sj+0Pt/lf8ALz5WzZv/ANhs53+3SvP6K9//AOTc/wDqYf7d/wC3TyPI/wC/m7d53tjb3zwf8My/9Td/5Tf/ALbR/wAnGf8AUvf2F/29+f5//fvbt8n3zu7Y5+gK+f8A9pr/AJlb/t7/APaNeAV6B8Tfhl/wrn+y/wDib/2h9v8AN/5dvK2bNn+22c7/AG6V7/8AE34m/wDCuf7L/wCJR/aH2/zf+XnytmzZ/sNnO/26V6BRRRRXz/8A8My/9Td/5Tf/ALbR/wAMy/8AU3f+U3/7bR/wzL/1N3/lN/8AttegfDL4Zf8ACuf7U/4m/wDaH2/yv+Xbytmzf/ttnO/26V5//wAMy/8AU3f+U3/7bXoHxN+GX/Cxv7L/AOJv/Z/2Dzf+Xbzd+/Z/trjGz360fE34Zf8ACxv7L/4m/wDZ/wBg83/l283fv2f7a4xs9+tegV8//wDDMv8A1N3/AJTf/ttfQFfP/wDwzL/1N3/lN/8AttfQFfP/APwzL/1N3/lN/wDttfQFef8Awy+GX/Cuf7U/4m/9ofb/ACv+Xbytmzf/ALbZzv8AbpR8Mvhl/wAK5/tT/ib/ANofb/K/5dvK2bN/+22c7/bpXoFFef8Awy+GX/Cuf7U/4m/9ofb/ACv+Xbytmzf/ALbZzv8AbpR8Mvhl/wAK5/tT/ib/ANofb/K/5dvK2bN/+22c7/bpR8Tfhl/wsb+y/wDib/2f9g83/l283fv2f7a4xs9+tHwy+GX/AArn+1P+Jv8A2h9v8r/l28rZs3/7bZzv9ulHwy+GX/Cuf7U/4m/9ofb/ACv+Xbytmzf/ALbZzv8AbpR8Mvhl/wAK5/tT/ib/ANofb/K/5dvK2bN/+22c7/bpR8Mvhl/wrn+1P+Jv/aH2/wAr/l28rZs3/wC22c7/AG6UfDL4Zf8ACuf7U/4m/wDaH2/yv+Xbytmzf/ttnO/26V6BRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRRX//Z"
  },
  "payment_notice_data": {
    "payment_method": "account_debit",
    "payment_origin": "internet",
    "payment_notice_date": "2024-07-01"
  },
  "payment_data": {
    "paid_amount": 850.0,
    "paid_rebate_amount": 200.0,
    "paid_discount_amount": 0.0,
    "paid_fine_amount": 0.0,
    "paid_interest_amount": 50.0,
    "payment_method": "account_debit",
    "payment_origin": "internet",
    "payment_credit_date": "2024-07-02",
    "payment_date": "2024-07-01",
    "payment_bank": {
      "code": "341",
      "ispb": 60701190,
      "name": "ITAU UNIBANCO S.A."
    },
    "payment_branch": "0216"
  },
  "bank_slip_status": "registered",
  "occurrences": [
    {
      "request_control_key": "0dcb3182-4d7e-4526-8f92-c15cdbc51bad",
      "occurrence_key": "ec67408c-a149-418a-b89b-b9c9d3b6c403",
      "occurrence_type": "registration",
      "occurrence_status": "confirmed",
      "created_at": "2024-06-23T09:15:32Z"
    },
    {
      "request_control_key": "9618c632-7f4d-490b-8817-2bb72ec1e84a",
      "occurrence_key": "70d3e632-644d-499f-baac-f65f21fb8574",
      "occurrence_type": "rebate",
      "occurrence_status": "confirmed",
      "created_at": "2024-06-26T12:36:04Z"
    },
    {
      "request_control_key": "c2b2ba59-9c37-488d-823d-2c3bfc1e9108",
      "occurrence_key": "dbdd513c-e918-4d17-b194-b5ae3d979988",
      "occurrence_type": "cancel_rebate",
      "occurrence_status": "confirmed",
      "created_at": "2024-06-26T12:53:47Z"
    }
  ]
}
```

### Response Body Params

| Field                      | Type    | Description                                                                        | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `bank_slip_key      ` *    | uuidv4  | Unique bank slip identification key, in uuid v4 format                             | 36                                                |
| `request_control_key` *    | uuidv4  | Unique identification key of the request used by the client, in uuid v4 format    | 36                                                |
| `our_number` *             | integer | Unique bank slip identification number within the wallet                           | 11                                                |
| `bank_slip_status` *       | string | Bank slip status                                                                    | **[bank_slip_status Enumerators](#enumeradores-bank_slip_status)** |
| `protest_status` *         | string | Notary office protest status of the bank slip                                       | **[protest_status Enumerators](#enumeradores-protest_status)** |
| `document_number` *        | string  | Bank slip identification number                                                    | 10                                                |
| `amount` *                 | float   | Base amount of the bank slip                                                       | -                                                 |
| `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 that 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 number of calendar days the bank slip will remain available for payment, after the due date (max 365) | -          |
| `write_off_data`       | object  | Write-off settings      | **[write_off_data Object](#objeto-write_off_settings)** |
| `protest_data`         | object  | Protest settings       | **[protest_data Object](#objeto-protest_settings)** |
| `bankruptcy_protest_data` | object  | Bankruptcy protest settings | **[bankruptcy_protest_data Object](#objeto-bankruptcy_protest_settings)** |
| `fine_data`            | object  | Fine settings                 | **[fine_data Object](#objeto-fine_settings)** |
| `interest_data`        | object  | Interest settings        | **[interest_data Object](#objeto-interest_settings)** |
| `discounts_data`           | object array | Discounts           | **[discount Object](#objeto-discounts_data)** |
| `payer_data` *             | object  | Payer data                                                                         | **[payer_data Object](#objetos-payer_data-e-guarantor_data)** |
| `guarantor_data` *         | object  | Guarantor data                                                                     | **[guarantor_data Object](#objetos-payer_data-e-guarantor_data)** |
| `qr_code_data`             | object  | QR Code data                                                            | **[qr_code_data Object](#objeto-qr_code_data)** |
| `payment_notice_data`             | object or array  | Payment notice data                                                       | **[payment_notice_data Object or array](#objeto-ou-array-payment_notice_data)** |
| `payment_data`             | object or array  | Payment data                                                              | **[payment_data Object or array](#objeto-ou-array-payment_data)** |
| `guarantor_data`           | object  | Guarantor data                                                                     | **[guarantor_data Object](#objetos-payer_data-e-guarantor_data)** |
| `occurrences`              | object array | Instructions related to the bank slip                                         | **[bank_slip_occurrence Object](#objeto-bank_slip_occurrence)** |

:::info Information
The `amount` field is the base amount of the bank slip, i.e., it does not include the fine, interest, rebate, or discounts.
:::

### bank_slip_status Enumerators {#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                                                                    |

### protest_status Enumerators {#enumeradores-protest_status}

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

### write_off_data Object {#objeto-write_off_settings}

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

### protest_data Object {#objeto-protest_settings}

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

### bankruptcy_protest_data Object {#objeto-bankruptcy_protest_settings}

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

### fine_data Object {#objeto-fine_settings}

Option 1: fine as an absolute amount (`fine_type=absolute`)

| Field                     | Type    | Description                                             | Characters                |
|---------------------------|---------|---------------------------------------------------------|-------------------------------------------------------------------------|
| `fine_type` *             | string  | Fine type                                                           | **[fine_type Enumerators](#enumeradores-fine_type)**                                              |
| `fine_amount` *           | float   | Absolute fine amount                                                | -                                                                        |
| `days_to_fine` *          | integer | Days, after the due date, for the fine to be charged                | -                                                                        |

Option 2: fine as a percentage (`fine_type=percentage`)

| Field                     | Type    | Description                                               | Characters                             |
|---------------------------|---------|-----------------------------------------------------------|---------------------------------------|
| `fine_type` *             | string  | Fine type                                                | **[fine_type Enumerators](#enumeradores-fine_type)** |
| `fine_percentage` *       | integer | Fine percentage, from 1 to 100                           | -                                      |
| `days_to_fine` *          | integer | Days, after the due date, for the fine to be charged     | -                                      |

### fine_type Enumerators {#enumeradores-fine_type}

| Enumerator         | Description           |
|--------------------|-----------------------|
| absolute           | absolute amount       |
| percentage         | percentage            |

### interest_data Object {#objeto-interest_settings}

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

| Field                     | Type    | Description                                                                   | Characters                                                                                      |
|---------------------------|---------|-------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
| `interest_type` *         | string  | Interest type       | **[interest_type Enumerators](#enumeradores-interest_type)** |
| `interest_amount` *       | float   | Amount to be charged per defined unit of time (workdays or calendar days)     | -                                                                                               |
| `days_to_interest` *      | integer | Days, after the due date, for interest to start being charged                 | -                                                                                               |

Option 2: interest using percentages (`interest_type=calendar_days_monthly_percentage`)

| Field                    | Type    | Description                                                                            | Characters                                                                                          |
|--------------------------|---------|---------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
| `interest_type` *        | string  | Interest type       | **[interest_type Enumerators](#enumeradores-interest_type)** |
| `interest_percentage` *  | integer | Percentage to be charged per defined unit of time (workdays or calendar days)                                                                      | -                                                                           |
| `days_to_interest` *     | integer | Days, after the due date, for interest to start being charged                          | -                                                                                                   |

### interest_type Enumerators {#enumeradores-interest_type}

| Enumerator                       | Description                                                          |
|----------------------------------|----------------------------------------------------------------------|
| calendar_days_daily_amount       | Daily amount over calendar days                                      |
| workdays_daily_amount            | Daily amount over workdays                                           |
| calendar_days_monthly_percentage | Interest percentage charged monthly, based on calendar days          |

### discount Object {#objeto-discounts_data}

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

| Field                     | Type    | Description                                         | Characters                                                |
|---------------------------|---------|-----------------------------------------------------|-----------------------------------------------------------|
| `discount_amount` *       | float   | Absolute discount amount per unit of time                                                  | -                                                          |
| `discount_number` *       | integer | Discount number                                        | -                                                         |
| `discount_type` *         | string  | Discount settings using absolute amounts                                         | **[discount_type Enumerator](#enumeradores-discount_type)** |                                                       |
| `discount_limit_date` *   | string  | Deadline date for applying the discount   | 10                                                        |

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

| Field                     | Type    | Description                                         | Characters                                                |
|---------------------------|---------|-----------------------------------------------------|-----------------------------------------------------------|
| `discount_percentage` *   | float   | Discount percentage per unit of time                                                  | -                                                          |
| `discount_number` *       | integer | Discount number                                        | -                                                         |
| `discount_type` *         | string  | Discount settings using percentages                                         | **[discount_type Enumerator](#enumeradores-discount_type)** |                                                       |
| `discount_limit_date` *   | string  | Deadline date for applying the discount   | 10                                                        |

:::caution Warning!
A bank slip can have up to three discounts, and all discounts must be of the same type , i.e., they must have the same `discount_type`. Discounts must be numbered from 1 to 3, in ascending order and necessarily starting at 1. That is, if two discounts are sent in the request, they must necessarily be numbered 1 and 2.
:::

### discount_type Enumerators {#enumeradores-discount_type}

| Enumerator                                  | Description                                                              |
|---------------------------------------------|--------------------------------------------------------------------------|
| absolute                                    | Fixed amount                                                            |
| anticipation_calendar_days_daily_amount     | Daily early-payment discount amount, over calendar days                 |
| anticipation_workdays_daily_amount          | Daily early-payment discount amount, over workdays                      |
| percentage                                  | Fixed percentage                                                        |
| anticipation_calendar_days_daily_percentage | Monthly early-payment discount percentage, based on calendar days       |
| anticipation_workdays_daily_percentage      | Annual early-payment discount percentage, based on workdays             |

### payer_data and guarantor_data Objects {#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](#enumeradores-person_type)** |
| `contact`                 | object | Contact information                 | **[contact Object](#objeto-contact)**                     |
| `address`                 | object | Address                             | **[address Object](#objeto-address)**                     |

### person_type Enumerators {#enumeradores-person_type}

| Enumerator         | Description           |
|--------------------|-----------------------|
| natural            | natural person        |
| legal              | legal entity          |

### contact Object {#objeto-contact}

| Field                     | Type   | Description                       | Characters                         |
|---------------------------|--------|-----------------------------------|------------------------------------|
| `email`                   | string | Contact email                     | 320                                |
| `phone`                   | object | Contact phone                     | **[phone Object](#objeto-phone)**  |

### phone Object {#objeto-phone}

| Field                           | Type   | Description                                  | Characters |
|---------------------------------|--------|----------------------------------------------|------------|
| `international_dial_code` *     | string | International dialing code (DDI)             | 3          |
| `area_code` *                   | string | Area code (DDD)                              | 2          |
| `number` *                      | string | Phone number                                 | 9          |

### address Object {#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 (UF) | **[state Enumerator](#enumeradores-state)** |

### state Enumerators {#enumeradores-state}

| Enumerator         | Description           |
|--------------------|-----------------------|
| AC                 | Acre                  |
| AL                 | Alagoas               |
| AM                 | Amazonas              |
| AP                 | Amapá                 |
| BA                 | Bahia                 |
| CE                 | Ceará                 |
| DF                 | Federal District      |
| 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             |

### qr_code_data Object {#objeto-qr_code_data}
| Field                      | Type   | Description                                           | Characters              |
|----------------------------|--------|-------------------------------------------------------|-------------------------|
| `qr_code_key`              | uuidv4 | Unique QR Code identification key                     | 36                      |
| `pix_key`                  | uuidv4 | PIX key linked to the QR Code                         | 36                      |
| `receiver_conciliation_id` | uuidv4 | QR Code conciliation identifier                       | 36                      |
| `url`                      | string | QR Code URL (Pix Copy and Paste)                      | -                       |
| `image`                    | string | base64 of the QR Code URL (Pix Copy and Paste)        | -                       |

### payment_notice_data Object or array {#objeto-ou-array-payment_notice_data}

:::caution Warning!
The `payment_notice_data` field is returned as an **object** for bank slips without partial payment settings. For bank slips with partial payment settings, it is returned as an **array of objects**, since there may be multiple payments.
In addition, if the bank slip is paid via **QR Code**, this field will not be returned, since settlement occurs on the payment day.
:::

| Field                     | Type    | Description                                                                   | Characters                                                                                      |
|---------------------------|---------|-------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
| `payment_method`      | string  | Payment method  | **[payment_method Enumerators](#enumeradores-payment_method)** |
| `payment_origin`      | string  | Payment origin       | **[payment_origin Enumerators](#enumeradores-payment_origin)** |
| `payment_notice_date`      | string | Payment notice date | 10

### payment_data Object or array {#objeto-ou-array-payment_data}

:::caution Warning!
The `payment_data` field is returned as an **object** for bank slips without partial payment settings. For bank slips with partial payment settings, it is returned as an **array of objects**, since there may be multiple payments.
:::

| Field                     | Type    | Description                                                                   | Characters                                                                                      |
|---------------------------|---------|-------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
| `paid_amount`         | float  | Payment amount       | - |
| `paid_rebate_amount`       | float   | Paid rebate amount | -                                                                                               |
| `paid_discount_amount`      | float | Paid discount amount                    | -                                                                                               |
| `paid_fine_amount`      | float | Paid fine amount                    | -
| `paid_interest_amount`      | float | Paid interest amount                    | -
| `payment_method`      | string  | Payment method  | **[payment_method Enumerators](#enumeradores-payment_method)** |
| `payment_origin`      | string  | Payment origin       | **[payment_origin Enumerators](#enumeradores-payment_origin)** |
| `payment_credit_date`      | string | Payment credit date | 10
| `payment_bank`      | object | Bank where the bank slip was paid. Returned only after the bank slip is paid | **[payment_bank Object](#objeto-payment_bank)** |
| `payment_branch`      | string | Branch where the bank slip was paid. Returned only after the bank slip is paid | -

:::info Information
The `payment_bank` and `payment_branch` fields are only returned once the bank slip has been paid, i.e., when a confirmed payment occurrence exists. While the bank slip is unpaid, these fields will not be present in the response.
:::

### payment_bank Object {#objeto-payment_bank}

| Field  | Type    | Description                                | Characters |
|--------|---------|--------------------------------------------|------------|
| `code` | string  | Bank clearing code (3 digits)              | 3          |
| `ispb` | integer | Bank ISPB                                  | 8          |
| `name` | string  | Bank name                                  | -          |

### payment_method Enumerators {#enumeradores-payment_method}

| Enumerator         | Description                             |
|--------------------|-----------------------------------------|
| cash       | Cash                  |
| account_debit             | Account debit                |
| credit_card      | Credit card |
| check          | Check                  |

### payment_origin Enumerators

| Enumerator         | Description                             |
|--------------------|-----------------------------------------|
| cash       | Cash                  |
| account_debit             | Account debit                |
| credit_card      | Credit card |
| check          | Check                  |

### payment_origin Enumerators {#enumeradores-payment_origin}

| Enumerator           | Description                              |
|----------------------|------------------------------------------|
| phisical_cashier     | Branches - traditional locations         |
| taa                  | Self-service terminal                    |
| internet             | Internet (home/office bank)              |
| corban               | Banking correspondent                    |
| call_center          | Call center                              |
| eletronic_file       | Electronic file                          |
| dda                  | DDA                                      |
| digital_correspondent| Digital correspondent                    |
| qr_code              | Payment via Pix QR Code                  |

### bank_slip_occurrence Object {#objeto-bank_slip_occurrence}

| Field                   | Type   | Description                                                                       | Characters |
|-------------------------|--------|-----------------------------------------------------------------------------------|------------|
| `request_control_key` * | uuidv4 | Unique identification key of the request used by the client, in uuid v4 format    | 36         |
| `occurrence_key` *      | uuidv4 | Unique bank slip identification key, in uuid v4 format                            | 36         |
| `occurrence_type` *     | string | Occurrence type                                                                       | **[occurrence_type Enumerator](#enumeradores-occurrence_type)** |
| `occurrence_status` *   | string | Occurrence status                                                                     | **[occurrence_status Enumerator](#enumeradores-occurrence_status)** |
| `created_at` *          | string | Date, in ISO format (UTC - "YYYY-MM-DDTHH:MM:SSZ"), the occurrence was created     | 20         |

### occurrence_type Enumerators {#enumeradores-occurrence_type}

| Enumerator         | Description                             |
|--------------------|-----------------------------------------|
| registration       | Registration occurrence                 |
| write_off          | Write-off request occurrence            |
| rebate             | Rebate addition occurrence              |
| cancel_rebate      | Rebate cancellation occurrence          |
| discount           | Discount change occurrence              |
| fine               | Fine change occurrence                  |
| interest           | Interest change occurrence              |
| extension          | Extension occurrence                    |
| bank_slip_edit     | Occurrence of changes to other bank slip data |
| payment_notice     | Payment notice occurrence               |
| payment            | Payment settlement occurrence           |
| protest_request    | Protest request occurrence              |
| protest_request    | Bankruptcy protest request occurrence   |

### occurrence_status Enumerators {#enumeradores-occurrence_status}

| Enumerator         | Description                             |
|--------------------|-----------------------------------------|
| pending            | Sent to Nuclea/CIP for analysis         |
| rejected           | Rejected                                |
| confirmed          | Confirmed                               |

## 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<br/>`status` | QI code<br/>`code` | Title<br/>`title`                                 | Description (eng)<br/>`description`                                                                                       | Description (ptbr)<br/>`translation`                                                                                     |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 400                      | QIT000001            | Bad Request                                        | Schema Error                                                                                                            | Schema Inválido                                                                                                         |
| 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.                                                                 |
| 404                      | BKS000013            | Not Found | Requester profile not found         |               Carteira não encontrada                                                                 |
| 400                      | BKS000022            | Bad Request                                        | Requester profile is not opened.                                                              | Carteira não está aberta.                          |
| 404                      | BKS000029            | Not Found                                        | Bank slip not found for the given key (`{bank_slip_key}`).                                                              | Boleto não encontrado para a chave fornecida (`{bank_slip_key}`).                          |

---

# List Bank Slips

URL: /en/documentation/boletos/consulta/listar_boletos

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](#enumeradores-bank_slip_status)** |
| `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

```json
{
  "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": "paid",
      "payment_data": {
        "paid_amount": 8000.0,
        "payment_credit_date": "2024-07-15",
        "payment_date": "2024-07-14"
      }
    }
  ],
  "pagination": {
    "current_page": 1,
    "rows_per_page": 100
  }
}
```

### Response Body Params

| Field            | Type         | Description                             | Characters                                  |
|------------------|--------------|---------------------------------------|---------------------------------------------|
| `data` *         | object array | Bank slips                               | **[bank_slip Object](#objeto-bank_slip)**   |
| `pagination` *   | object       | Pagination information              | **[pagination Object](#objeto-pagination)** |

### 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](#enumeradores-bank_slip_status)** |
| `protest_status` *         | string | Bank slip protest status at notary office                                          | **[protest_status Enumerators](#enumeradores-protest_status)** |
| `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](#objeto-write_off_settings)** |
| `protest_data`         | object  | Protest configuration       | **[protest_data Object](#objeto-protest_settings)** |
| `bankruptcy_protest_data` | object  | Bankruptcy protest configuration | **[bankruptcy_protest_data Object](#objeto-bankruptcy_protest_settings)** |
| `fine_data`            | object  | Fine configuration                 | **[fine_data Object](#objeto-fine_settings)** |
| `interest_data`        | object  | Interest configuration        | **[interest_data Object](#objeto-interest_settings)** |
| `discounts_data`           | object array | Discounts           | **[discount Object](#objeto-discounts_data)** |
| `payer_data` *             | object  | Payer data                                                                   | **[payer_data Object](#objetos-payer_data-e-guarantor_data)** |
| `guarantor_data` *         | object  | Guarantor data                                                          | **[guarantor_data Object](#objetos-payer_data-e-guarantor_data)** |

### 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](#enumeradores-fine_type)**                                              |
| `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](#enumeradores-fine_type)** |
| `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](#enumeradores-interest_type)** |
| `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](#enumeradores-interest_type)** |
| `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](#enumeradores-discount_type)** |                                                       |
| `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](#enumeradores-discount_type)** |                                                       |
| `discount_limit_date` *   | string  | Limit date for discount application   | 10                                                        |

:::caution 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](#enumeradores-person_type)** |
| `contact`                 | object | Contact information              | **[contact Object](#objeto-contact)**                     |
| `address`                 | object | Address                            | **[address Object](#objeto-address)**                     |

### 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)**  |

### 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)** |

### 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

```json
{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}
```

| HTTP Code<br/>`status` | QI Code<br/>`code` | Title<br/>`title`                                 | Description (eng)<br/>`description`                                                                                       | Description (pt-br)<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                                                                 |

---

# Daily position report in Excel

URL: /en/documentation/boletos/consultar_v1/posicao_diaria_excel

## Request

ENDPOINT /bank_slip/duplicates_balance_excel
METHOD GET

:::caution Attention
The response body of this request will be an Excel file encoded in base64.
:::

### Query params

| Field | Type | Description | Characters |
|---|---|---|---|
| `beneficiary_key` | string | Beneficiary identification key (required if there is no requester_profile_code). | uuid key | 
| `requester_profile_code` | string | Wallet code (required if there is no beneficiary_key). | 10 | 
| `expiration_date` | date | Maximum expiration date (Format YYYY-MM-DD). | 10 | 

## Response

STATUS 200

Response Body

```json

O body de resposta desta request será um arquivo excel encodado em base64.

```

STATUS 400

Response Body

```json

{
  "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}
  
```

---

# Daily position report in JSON

URL: /en/documentation/boletos/consultar_v1/posicao_diaria_json

## Request

ENDPOINT /bank_slip/duplicates_balance
METHOD GET

### Query params

| Field | Type | Description | Characters |
|---|---|---|---|
| `beneficiary_key` | string | Beneficiary identification key (required if there is no requester_profile_code). | 10 | 
| `requester_profile_code` | string | Wallet code (required if there is no beneficiary_key). | 10 | 
| `expiration_date` | date | Maximum expiration date (Format YYYY-MM-DD). | 10 | 

## Response

STATUS 200

Response Body

```json

{
  "expire_after_90_days": 0,
  "expire_between_31_and_60_days": 0,
  "expire_between_61_and_90_days": 0,
  "expire_in_30_days": 0,
  "expired": 3,
  "expired_in_notary_office": 0,
  "expired_not_in_notary_office": 0,
  "paid": 0,
  "paid_after_due_date": 2,
  "paid_before_due_date": 0,
  "paid_on_due_date": 0,
  "to_expire": 0,
  "unpaid": 0
}
    

```

STATUS 400

Response Body

```json

{
  "data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}
    

```

---

# Solicitar 2ª via de boleto

URL: /en/documentation/boletos/consultar_v1/segunda_via_de_boleto

## Request

ENDPOINT /bank_slip/2-way/ BANK_SLIP_KEY
MÉTODO POST

### Path parameters

| Campo                   | Tipo   | Descrição                                                    | Caracteres |
|-------------------------|--------|--------------------------------------------------------------|------------|
| `bank_slip_key`         | uuidv4 | Chave única de identificação do boleto, no formato uuid v4   | 36         |

## Response

STATUS 200

Response Body

```json
{
  "amount": 3,
  "asset_type": {
    "created_at": "2019-02-01T16:44:11",
    "enumerator": "invoice",
    "translation_path": "bank_slip.AssetType.invoice"
  },
  "automatic_bankruptcy_protest": true,
  "automatic_protest": false,
  "automatic_write_off": false,
  "bank_slip_file": [
    {
      "barcode": "32998827300000003000001010000000000200670490",
      "created_at": "2020-05-19T18:46:41",
      "digitable_line": "32990001031000000000902006704908882730000000300",
      "url": "https://linkparadownload.com/arquivo.pdf"
    }
  ],
  "bank_slip_key": "96b32f1a-c2bd-41a4-b4b1-a169235be68b",
  "bank_slip_status": {
    "created_at": "2019-02-01T16:44:07",
    "enumerator": "accepted",
    "translation_path": "bank_slip.BankSlipStatus.accepted"
  },
  "bank_teller_instructions": "Boleto Teste",
  "beneficiary_account_branch": "0001",
  "beneficiary_account_key": "7cc3b1f7-8015-4073-8471-a3ba57e34975",
  "beneficiary_account_number": "67049",
  "beneficiary_document_number": "12345678905",
  "beneficiary_key": "b91195e3-0cf4-4fed-90cf-7f5bef29c2f0",
  "beneficiary_name": "Greg Brown",
  "billing_account_key": "7cc3b1f7-8015-4073-8471-a3ba57e34975",
  "business_date_expiration": "2020-06-01",
  "created_at": "2020-05-15T21:00:25",
  "days_before_fine": null,
  "days_before_interest": null,
  "days_to_bankruptcy_protest": 1,
  "days_to_protest": null,
  "days_to_write_off": null,
  "discount_limit_date": null,
  "discount_value": null,
  "document_number": "Parcela 1",
  "expenses": [],
  "expiration": "2020-06-01",
  "fine_percentage": 0.1,
  "guarantor_address": null,
  "guarantor_city": null,
  "guarantor_document": null,
  "guarantor_name": null,
  "guarantor_person_type": null,
  "guarantor_postal_code": "00000000",
  "guarantor_state": null,
  "historical_our_number": 2,
  "institution_registration_date": null,
  "interest_daily_value": 0.34,
  "lock_origin_type": null,
  "nfe_key": null,
  "nfe_url": null,
  "occurrences": [
    {
      "created_at": "2020-05-15T21:00:25",
      "discount_amount": null,
      "discount_limit_date": null,
      "iof_amount": null,
      "new_bank_slip_status": null,
      "new_due_date": "2020-06-01",
      "new_protest_status": {
        "created_at": "2019-02-01T16:44:08",
        "enumerator": "not_protested",
        "translation_path": "bank_slip.ProtestStatus.not_protested"
      },
      "notary_office_number": null,
      "notary_office_protocol": null,
      "occurrence_expenses": null,
      "occurrence_feedback": null,
      "occurrence_key": "c3ab3e01-f198-4e7e-9e01-7a8091b8bd72",
      "occurrence_reasons": [],
      "occurrence_type": {
        "created_at": "2019-02-01T16:44:14",
        "enumerator": "registration",
        "translation_path": "bank_slip.OccurrenceType.registration"
      },
      "old_bank_slip_status": {
        "created_at": "2019-02-01T16:44:07",
        "enumerator": "accepted",
        "translation_path": "bank_slip.BankSlipStatus.accepted"
      },
      "old_due_date": null,
      "old_protest_status": null,
      "paid_amount": null,
      "paid_fine_amount": null,
      "paid_interest_amount": null,
      "payment_bank": null,
      "payment_branch": null,
      "payment_credit_date": null,
      "payment_method": null,
      "payment_origin": null,
      "protest_confirmation": null,
      "protest_expenses": null,
      "rebate_amount": null,
      "registration_institution_occurrence_date": "2020-05-15",
      "registration_institution_occurrence_event": [
        {
          "cnab_file": {
            "cnab_key": "abfc9fba-28fb-4e75-afcb-f4647d7031bc",
            "company_code": null,
            "created_at": "2020-05-15T21:00:22",
            "downloads": [],
            "file_size": "None",
            "filename": null,
            "line_length": null,
            "remitter_key": "b91195e3-0cf4-4fed-90cf-7f5bef29c2f0",
            "requester_profile_code": null,
            "type": {
              "created_at": "2019-02-01T16:44:17",
              "enumerator": "api_instruction",
              "translation_path": "bank_slip.CNABFileType.api_instruction"
            },
            "url": null,
            "version": null
          },
          "cnab_file_occurrence_order": 1,
          "created_at": "2020-05-15T21:00:25",
          "new_status": {
            "created_at": "2019-02-01T16:44:15",
            "enumerator": "waiting_submission",
            "translation_path": "bank_slip.RegistrationInstitutionOccurrenceStatus.waiting_submission"
          },
          "old_status": null
        }
      ],
      "registration_institution_occurrence_status": {
        "created_at": "2019-02-01T16:44:15",
        "enumerator": "waiting_submission",
        "translation_path": "bank_slip.RegistrationInstitutionOccurrenceStatus.waiting_submission"
      },
      "requester_occurrence_event": [
        {
          "cnab_file": {
            "cnab_key": "abfc9fba-28fb-4e75-afcb-f4647d7031bc",
            "company_code": null,
            "created_at": "2020-05-15T21:00:22",
            "downloads": [],
            "file_size": "None",
            "filename": null,
            "line_length": null,
            "remitter_key": "b91195e3-0cf4-4fed-90cf-7f5bef29c2f0",
            "requester_profile_code": null,
            "type": {
              "created_at": "2019-02-01T16:44:17",
              "enumerator": "api_instruction",
              "translation_path": "bank_slip.CNABFileType.api_instruction"
            },
            "url": null,
            "version": null
          },
          "cnab_file_occurrence_order": 1,
          "created_at": "2020-05-15T21:00:25",
          "new_status": {
            "created_at": "2019-02-01T16:44:16",
            "enumerator": "accepted",
            "translation_path": "bank_slip.RequesterOccurrenceStatus.accepted"
          },
          "old_status": null
        }
      ],
      "requester_occurrence_status": {
        "created_at": "2019-02-01T16:44:16",
        "enumerator": "accepted",
        "translation_path": "bank_slip.RequesterOccurrenceStatus.accepted"
      }
    }
  ],
  "our_number": 2,
  "paid_amount": null,
  "paid_fine_amount": null,
  "paid_interest_amount": null,
  "participant_control_number": null,
  "payer_account_digit": null,
  "payer_account_number": null,
  "payer_account_type": null,
  "payer_address": "Rua Carlos tampaio, 204",
  "payer_bank": null,
  "payer_branch_digit": null,
  "payer_branch_number": null,
  "payer_document": "41651732825",
  "payer_name": "Beatriz Couto",
  "payer_person_type": {
    "created_at": "2019-02-01T16:44:09",
    "enumerator": "natural",
    "translation_path": "bank_slip.PersonType.natural"
  },
  "payer_postal_code": "00000000",
  "payment_date": null,
  "printing_policy": {
    "created_at": "2019-02-01T16:44:10",
    "enumerator": "no_printing",
    "translation_path": "bank_slip.PrintingPolicy.no_printing"
  },
  "protest_status": {
    "created_at": "2019-02-01T16:44:08",
    "enumerator": "not_protested",
    "translation_path": "bank_slip.ProtestStatus.not_protested"
  },
  "rebate_amount": null,
  "registration_institution": {
    "created_at": "2020-03-26T19:36:16",
    "enumerator": "qi_scd",
    "febraban_code": "329",
    "remittance_sequence": 72,
    "settlement_resource_account_key": "3e46d266-4fdb-4fd2-b87a-3e3de366afd4"
  },
  "requester_profile": 1,
  "requester_profile_code": "329-01-0001-0067049",
  "requester_registration_date": "2020-05-15"
}{
  "amount": 3,
  "asset_type": {
    "created_at": "2019-02-01T16:44:11",
    "enumerator": "invoice",
    "translation_path": "bank_slip.AssetType.invoice"
  },
  "automatic_bankruptcy_protest": true,
  "automatic_protest": false,
  "automatic_write_off": false,
  "bank_slip_file": [
    {
      "barcode": "32998827300000003000001010000000000200670490",
      "created_at": "2020-05-19T18:46:41",
      "digitable_line": "32990001031000000000902006704908882730000000300",
      "url": "https://linkparadownload.com/arquivo.pdf"
    }
  ],
  "bank_slip_key": "96b32f1a-c2bd-41a4-b4b1-a169235be68b",
  "bank_slip_status": {
    "created_at": "2019-02-01T16:44:07",
    "enumerator": "accepted",
    "translation_path": "bank_slip.BankSlipStatus.accepted"
  },
  "bank_teller_instructions": "Boleto Teste",
  "beneficiary_account_branch": "0001",
  "beneficiary_account_key": "7cc3b1f7-8015-4073-8471-a3ba57e34975",
  "beneficiary_account_number": "67049",
  "beneficiary_document_number": "12345678905",
  "beneficiary_key": "b91195e3-0cf4-4fed-90cf-7f5bef29c2f0",
  "beneficiary_name": "Greg Brown",
  "billing_account_key": "7cc3b1f7-8015-4073-8471-a3ba57e34975",
  "business_date_expiration": "2020-06-01",
  "created_at": "2020-05-15T21:00:25",
  "days_before_fine": null,
  "days_before_interest": null,
  "days_to_bankruptcy_protest": 1,
  "days_to_protest": null,
  "days_to_write_off": null,
  "discount_limit_date": null,
  "discount_value": null,
  "document_number": "Parcela 1",
  "expenses": [],
  "expiration": "2020-06-01",
  "fine_percentage": 0.1,
  "guarantor_address": null,
  "guarantor_city": null,
  "guarantor_document": null,
  "guarantor_name": null,
  "guarantor_person_type": null,
  "guarantor_postal_code": "00000000",
  "guarantor_state": null,
  "historical_our_number": 2,
  "institution_registration_date": null,
  "interest_daily_value": 0.34,
  "lock_origin_type": null,
  "nfe_key": null,
  "nfe_url": null,
  "occurrences": [
    {
      "created_at": "2020-05-15T21:00:25",
      "discount_amount": null,
      "discount_limit_date": null,
      "iof_amount": null,
      "new_bank_slip_status": null,
      "new_due_date": "2020-06-01",
      "new_protest_status": {
        "created_at": "2019-02-01T16:44:08",
        "enumerator": "not_protested",
        "translation_path": "bank_slip.ProtestStatus.not_protested"
      },
      "notary_office_number": null,
      "notary_office_protocol": null,
      "occurrence_expenses": null,
      "occurrence_feedback": null,
      "occurrence_key": "c3ab3e01-f198-4e7e-9e01-7a8091b8bd72",
      "occurrence_reasons": [],
      "occurrence_type": {
        "created_at": "2019-02-01T16:44:14",
        "enumerator": "registration",
        "translation_path": "bank_slip.OccurrenceType.registration"
      },
      "old_bank_slip_status": {
        "created_at": "2019-02-01T16:44:07",
        "enumerator": "accepted",
        "translation_path": "bank_slip.BankSlipStatus.accepted"
      },
      "old_due_date": null,
      "old_protest_status": null,
      "paid_amount": null,
      "paid_fine_amount": null,
      "paid_interest_amount": null,
      "payment_bank": null,
      "payment_branch": null,
      "payment_credit_date": null,
      "payment_method": null,
      "payment_origin": null,
      "protest_confirmation": null,
      "protest_expenses": null,
      "rebate_amount": null,
      "registration_institution_occurrence_date": "2020-05-15",
      "registration_institution_occurrence_event": [
        {
          "cnab_file": {
            "cnab_key": "abfc9fba-28fb-4e75-afcb-f4647d7031bc",
            "company_code": null,
            "created_at": "2020-05-15T21:00:22",
            "downloads": [],
            "file_size": "None",
            "filename": null,
            "line_length": null,
            "remitter_key": "b91195e3-0cf4-4fed-90cf-7f5bef29c2f0",
            "requester_profile_code": null,
            "type": {
              "created_at": "2019-02-01T16:44:17",
              "enumerator": "api_instruction",
              "translation_path": "bank_slip.CNABFileType.api_instruction"
            },
            "url": null,
            "version": null
          },
          "cnab_file_occurrence_order": 1,
          "created_at": "2020-05-15T21:00:25",
          "new_status": {
            "created_at": "2019-02-01T16:44:15",
            "enumerator": "waiting_submission",
            "translation_path": "bank_slip.RegistrationInstitutionOccurrenceStatus.waiting_submission"
          },
          "old_status": null
        }
      ],
      "registration_institution_occurrence_status": {
        "created_at": "2019-02-01T16:44:15",
        "enumerator": "waiting_submission",
        "translation_path": "bank_slip.RegistrationInstitutionOccurrenceStatus.waiting_submission"
      },
      "requester_occurrence_event": [
        {
          "cnab_file": {
            "cnab_key": "abfc9fba-28fb-4e75-afcb-f4647d7031bc",
            "company_code": null,
            "created_at": "2020-05-15T21:00:22",
            "downloads": [],
            "file_size": "None",
            "filename": null,
            "line_length": null,
            "remitter_key": "b91195e3-0cf4-4fed-90cf-7f5bef29c2f0",
            "requester_profile_code": null,
            "type": {
              "created_at": "2019-02-01T16:44:17",
              "enumerator": "api_instruction",
              "translation_path": "bank_slip.CNABFileType.api_instruction"
            },
            "url": null,
            "version": null
          },
          "cnab_file_occurrence_order": 1,
          "created_at": "2020-05-15T21:00:25",
          "new_status": {
            "created_at": "2019-02-01T16:44:16",
            "enumerator": "accepted",
            "translation_path": "bank_slip.RequesterOccurrenceStatus.accepted"
          },
          "old_status": null
        }
      ],
      "requester_occurrence_status": {
        "created_at": "2019-02-01T16:44:16",
        "enumerator": "accepted",
        "translation_path": "bank_slip.RequesterOccurrenceStatus.accepted"
      }
    }
  ],
  "our_number": 2,
  "paid_amount": null,
  "paid_fine_amount": null,
  "paid_interest_amount": null,
  "participant_control_number": null,
  "payer_account_digit": null,
  "payer_account_number": null,
  "payer_account_type": null,
  "payer_address": "Rua Carlos tampaio, 204",
  "payer_bank": null,
  "payer_branch_digit": null,
  "payer_branch_number": null,
  "payer_document": "41651732825",
  "payer_name": "Beatriz Couto",
  "payer_person_type": {
    "created_at": "2019-02-01T16:44:09",
    "enumerator": "natural",
    "translation_path": "bank_slip.PersonType.natural"
  },
  "payer_postal_code": "00000000",
  "payment_date": null,
  "printing_policy": {
    "created_at": "2019-02-01T16:44:10",
    "enumerator": "no_printing",
    "translation_path": "bank_slip.PrintingPolicy.no_printing"
  },
  "protest_status": {
    "created_at": "2019-02-01T16:44:08",
    "enumerator": "not_protested",
    "translation_path": "bank_slip.ProtestStatus.not_protested"
  },
  "rebate_amount": null,
  "registration_institution": {
    "created_at": "2020-03-26T19:36:16",
    "enumerator": "qi_scd",
    "febraban_code": "329",
    "remittance_sequence": 72,
    "settlement_resource_account_key": "3e46d266-4fdb-4fd2-b87a-3e3de366afd4"
  },
  "requester_profile": 1,
  "requester_profile_code": "329-01-0001-0067049",
  "requester_registration_date": "2020-05-15"
}{
  "amount": 3,
  "asset_type": {
    "created_at": "2019-02-01T16:44:11",
    "enumerator": "invoice",
    "translation_path": "bank_slip.AssetType.invoice"
  },
  "automatic_bankruptcy_protest": true,
  "automatic_protest": false,
  "automatic_write_off": false,
  "bank_slip_file": [
    {
      "barcode": "32998827300000003000001010000000000200670490",
      "created_at": "2020-05-19T18:46:41",
      "digitable_line": "32990001031000000000902006704908882730000000300",
      "url": "https://linkparadownload.com/arquivo.pdf"
    }
  ],
  "bank_slip_key": "96b32f1a-c2bd-41a4-b4b1-a169235be68b",
  "bank_slip_status": {
    "created_at": "2019-02-01T16:44:07",
    "enumerator": "accepted",
    "translation_path": "bank_slip.BankSlipStatus.accepted"
  },
  "bank_teller_instructions": "Boleto Teste",
  "beneficiary_account_branch": "0001",
  "beneficiary_account_key": "7cc3b1f7-8015-4073-8471-a3ba57e34975",
  "beneficiary_account_number": "67049",
  "beneficiary_document_number": "12345678905",
  "beneficiary_key": "b91195e3-0cf4-4fed-90cf-7f5bef29c2f0",
  "beneficiary_name": "Greg Brown",
  "billing_account_key": "7cc3b1f7-8015-4073-8471-a3ba57e34975",
  "business_date_expiration": "2020-06-01",
  "created_at": "2020-05-15T21:00:25",
  "days_before_fine": null,
  "days_before_interest": null,
  "days_to_bankruptcy_protest": 1,
  "days_to_protest": null,
  "days_to_write_off": null,
  "discount_limit_date": null,
  "discount_value": null,
  "document_number": "Parcela 1",
  "expenses": [],
  "expiration": "2020-06-01",
  "fine_percentage": 0.1,
  "guarantor_address": null,
  "guarantor_city": null,
  "guarantor_document": null,
  "guarantor_name": null,
  "guarantor_person_type": null,
  "guarantor_postal_code": "00000000",
  "guarantor_state": null,
  "historical_our_number": 2,
  "institution_registration_date": null,
  "interest_daily_value": 0.34,
  "lock_origin_type": null,
  "nfe_key": null,
  "nfe_url": null,
  "occurrences": [
    {
      "created_at": "2020-05-15T21:00:25",
      "discount_amount": null,
      "discount_limit_date": null,
      "iof_amount": null,
      "new_bank_slip_status": null,
      "new_due_date": "2020-06-01",
      "new_protest_status": {
        "created_at": "2019-02-01T16:44:08",
        "enumerator": "not_protested",
        "translation_path": "bank_slip.ProtestStatus.not_protested"
      },
      "notary_office_number": null,
      "notary_office_protocol": null,
      "occurrence_expenses": null,
      "occurrence_feedback": null,
      "occurrence_key": "c3ab3e01-f198-4e7e-9e01-7a8091b8bd72",
      "occurrence_reasons": [],
      "occurrence_type": {
        "created_at": "2019-02-01T16:44:14",
        "enumerator": "registration",
        "translation_path": "bank_slip.OccurrenceType.registration"
      },
      "old_bank_slip_status": {
        "created_at": "2019-02-01T16:44:07",
        "enumerator": "accepted",
        "translation_path": "bank_slip.BankSlipStatus.accepted"
      },
      "old_due_date": null,
      "old_protest_status": null,
      "paid_amount": null,
      "paid_fine_amount": null,
      "paid_interest_amount": null,
      "payment_bank": null,
      "payment_branch": null,
      "payment_credit_date": null,
      "payment_method": null,
      "payment_origin": null,
      "protest_confirmation": null,
      "protest_expenses": null,
      "rebate_amount": null,
      "registration_institution_occurrence_date": "2020-05-15",
      "registration_institution_occurrence_event": [
        {
          "cnab_file": {
            "cnab_key": "abfc9fba-28fb-4e75-afcb-f4647d7031bc",
            "company_code": null,
            "created_at": "2020-05-15T21:00:22",
            "downloads": [],
            "file_size": "None",
            "filename": null,
            "line_length": null,
            "remitter_key": "b91195e3-0cf4-4fed-90cf-7f5bef29c2f0",
            "requester_profile_code": null,
            "type": {
              "created_at": "2019-02-01T16:44:17",
              "enumerator": "api_instruction",
              "translation_path": "bank_slip.CNABFileType.api_instruction"
            },
            "url": null,
            "version": null
          },
          "cnab_file_occurrence_order": 1,
          "created_at": "2020-05-15T21:00:25",
          "new_status": {
            "created_at": "2019-02-01T16:44:15",
            "enumerator": "waiting_submission",
            "translation_path": "bank_slip.RegistrationInstitutionOccurrenceStatus.waiting_submission"
          },
          "old_status": null
        }
      ],
      "registration_institution_occurrence_status": {
        "created_at": "2019-02-01T16:44:15",
        "enumerator": "waiting_submission",
        "translation_path": "bank_slip.RegistrationInstitutionOccurrenceStatus.waiting_submission"
      },
      "requester_occurrence_event": [
        {
          "cnab_file": {
            "cnab_key": "abfc9fba-28fb-4e75-afcb-f4647d7031bc",
            "company_code": null,
            "created_at": "2020-05-15T21:00:22",
            "downloads": [],
            "file_size": "None",
            "filename": null,
            "line_length": null,
            "remitter_key": "b91195e3-0cf4-4fed-90cf-7f5bef29c2f0",
            "requester_profile_code": null,
            "type": {
              "created_at": "2019-02-01T16:44:17",
              "enumerator": "api_instruction",
              "translation_path": "bank_slip.CNABFileType.api_instruction"
            },
            "url": null,
            "version": null
          },
          "cnab_file_occurrence_order": 1,
          "created_at": "2020-05-15T21:00:25",
          "new_status": {
            "created_at": "2019-02-01T16:44:16",
            "enumerator": "accepted",
            "translation_path": "bank_slip.RequesterOccurrenceStatus.accepted"
          },
          "old_status": null
        }
      ],
      "requester_occurrence_status": {
        "created_at": "2019-02-01T16:44:16",
        "enumerator": "accepted",
        "translation_path": "bank_slip.RequesterOccurrenceStatus.accepted"
      }
    }
  ],
  "our_number": 2,
  "paid_amount": null,
  "paid_fine_amount": null,
  "paid_interest_amount": null,
  "participant_control_number": null,
  "payer_account_digit": null,
  "payer_account_number": null,
  "payer_account_type": null,
  "payer_address": "Rua Carlos tampaio, 204",
  "payer_bank": null,
  "payer_branch_digit": null,
  "payer_branch_number": null,
  "payer_document": "41651732825",
  "payer_name": "Beatriz Couto",
  "payer_person_type": {
    "created_at": "2019-02-01T16:44:09",
    "enumerator": "natural",
    "translation_path": "bank_slip.PersonType.natural"
  },
  "payer_postal_code": "00000000",
  "payment_date": null,
  "printing_policy": {
    "created_at": "2019-02-01T16:44:10",
    "enumerator": "no_printing",
    "translation_path": "bank_slip.PrintingPolicy.no_printing"
  },
  "protest_status": {
    "created_at": "2019-02-01T16:44:08",
    "enumerator": "not_protested",
    "translation_path": "bank_slip.ProtestStatus.not_protested"
  },
  "rebate_amount": null,
  "registration_institution": {
    "created_at": "2020-03-26T19:36:16",
    "enumerator": "qi_scd",
    "febraban_code": "329",
    "remittance_sequence": 72,
    "settlement_resource_account_key": "3e46d266-4fdb-4fd2-b87a-3e3de366afd4"
  },
  "requester_profile": 1,
  "requester_profile_code": "329-01-0001-0067049",
  "requester_registration_date": "2020-05-15"
}{
  "amount": 3,
  "asset_type": {
    "created_at": "2019-02-01T16:44:11",
    "enumerator": "invoice",
    "translation_path": "bank_slip.AssetType.invoice"
  },
  "automatic_bankruptcy_protest": true,
  "automatic_protest": false,
  "automatic_write_off": false,
  "bank_slip_file": [
    {
      "barcode": "32998827300000003000001010000000000200670490",
      "created_at": "2020-05-19T18:46:41",
      "digitable_line": "32990001031000000000902006704908882730000000300",
      "url": "https://linkparadownload.com/arquivo.pdf"
    }
  ],
  "bank_slip_key": "96b32f1a-c2bd-41a4-b4b1-a169235be68b",
  "bank_slip_status": {
    "created_at": "2019-02-01T16:44:07",
    "enumerator": "accepted",
    "translation_path": "bank_slip.BankSlipStatus.accepted"
  },
  "bank_teller_instructions": "Boleto Teste",
  "beneficiary_account_branch": "0001",
  "beneficiary_account_key": "7cc3b1f7-8015-4073-8471-a3ba57e34975",
  "beneficiary_account_number": "67049",
  "beneficiary_document_number": "12345678905",
  "beneficiary_key": "b91195e3-0cf4-4fed-90cf-7f5bef29c2f0",
  "beneficiary_name": "Greg Brown",
  "billing_account_key": "7cc3b1f7-8015-4073-8471-a3ba57e34975",
  "business_date_expiration": "2020-06-01",
  "created_at": "2020-05-15T21:00:25",
  "days_before_fine": null,
  "days_before_interest": null,
  "days_to_bankruptcy_protest": 1,
  "days_to_protest": null,
  "days_to_write_off": null,
  "discount_limit_date": null,
  "discount_value": null,
  "document_number": "Parcela 1",
  "expenses": [],
  "expiration": "2020-06-01",
  "fine_percentage": 0.1,
  "guarantor_address": null,
  "guarantor_city": null,
  "guarantor_document": null,
  "guarantor_name": null,
  "guarantor_person_type": null,
  "guarantor_postal_code": "00000000",
  "guarantor_state": null,
  "historical_our_number": 2,
  "institution_registration_date": null,
  "interest_daily_value": 0.34,
  "lock_origin_type": null,
  "nfe_key": null,
  "nfe_url": null,
  "occurrences": [
    {
      "created_at": "2020-05-15T21:00:25",
      "discount_amount": null,
      "discount_limit_date": null,
      "iof_amount": null,
      "new_bank_slip_status": null,
      "new_due_date": "2020-06-01",
      "new_protest_status": {
        "created_at": "2019-02-01T16:44:08",
        "enumerator": "not_protested",
        "translation_path": "bank_slip.ProtestStatus.not_protested"
      },
      "notary_office_number": null,
      "notary_office_protocol": null,
      "occurrence_expenses": null,
      "occurrence_feedback": null,
      "occurrence_key": "c3ab3e01-f198-4e7e-9e01-7a8091b8bd72",
      "occurrence_reasons": [],
      "occurrence_type": {
        "created_at": "2019-02-01T16:44:14",
        "enumerator": "registration",
        "translation_path": "bank_slip.OccurrenceType.registration"
      },
      "old_bank_slip_status": {
        "created_at": "2019-02-01T16:44:07",
        "enumerator": "accepted",
        "translation_path": "bank_slip.BankSlipStatus.accepted"
      },
      "old_due_date": null,
      "old_protest_status": null,
      "paid_amount": null,
      "paid_fine_amount": null,
      "paid_interest_amount": null,
      "payment_bank": null,
      "payment_branch": null,
      "payment_credit_date": null,
      "payment_method": null,
      "payment_origin": null,
      "protest_confirmation": null,
      "protest_expenses": null,
      "rebate_amount": null,
      "registration_institution_occurrence_date": "2020-05-15",
      "registration_institution_occurrence_event": [
        {
          "cnab_file": {
            "cnab_key": "abfc9fba-28fb-4e75-afcb-f4647d7031bc",
            "company_code": null,
            "created_at": "2020-05-15T21:00:22",
            "downloads": [],
            "file_size": "None",
            "filename": null,
            "line_length": null,
            "remitter_key": "b91195e3-0cf4-4fed-90cf-7f5bef29c2f0",
            "requester_profile_code": null,
            "type": {
              "created_at": "2019-02-01T16:44:17",
              "enumerator": "api_instruction",
              "translation_path": "bank_slip.CNABFileType.api_instruction"
            },
            "url": null,
            "version": null
          },
          "cnab_file_occurrence_order": 1,
          "created_at": "2020-05-15T21:00:25",
          "new_status": {
            "created_at": "2019-02-01T16:44:15",
            "enumerator": "waiting_submission",
            "translation_path": "bank_slip.RegistrationInstitutionOccurrenceStatus.waiting_submission"
          },
          "old_status": null
        }
      ],
      "registration_institution_occurrence_status": {
        "created_at": "2019-02-01T16:44:15",
        "enumerator": "waiting_submission",
        "translation_path": "bank_slip.RegistrationInstitutionOccurrenceStatus.waiting_submission"
      },
      "requester_occurrence_event": [
        {
          "cnab_file": {
            "cnab_key": "abfc9fba-28fb-4e75-afcb-f4647d7031bc",
            "company_code": null,
            "created_at": "2020-05-15T21:00:22",
            "downloads": [],
            "file_size": "None",
            "filename": null,
            "line_length": null,
            "remitter_key": "b91195e3-0cf4-4fed-90cf-7f5bef29c2f0",
            "requester_profile_code": null,
            "type": {
              "created_at": "2019-02-01T16:44:17",
              "enumerator": "api_instruction",
              "translation_path": "bank_slip.CNABFileType.api_instruction"
            },
            "url": null,
            "version": null
          },
          "cnab_file_occurrence_order": 1,
          "created_at": "2020-05-15T21:00:25",
          "new_status": {
            "created_at": "2019-02-01T16:44:16",
            "enumerator": "accepted",
            "translation_path": "bank_slip.RequesterOccurrenceStatus.accepted"
          },
          "old_status": null
        }
      ],
      "requester_occurrence_status": {
        "created_at": "2019-02-01T16:44:16",
        "enumerator": "accepted",
        "translation_path": "bank_slip.RequesterOccurrenceStatus.accepted"
      }
    }
  ],
  "our_number": 2,
  "paid_amount": null,
  "paid_fine_amount": null,
  "paid_interest_amount": null,
  "participant_control_number": null,
  "payer_account_digit": null,
  "payer_account_number": null,
  "payer_account_type": null,
  "payer_address": "Rua Carlos tampaio, 204",
  "payer_bank": null,
  "payer_branch_digit": null,
  "payer_branch_number": null,
  "payer_document": "41651732825",
  "payer_name": "Beatriz Couto",
  "payer_person_type": {
    "created_at": "2019-02-01T16:44:09",
    "enumerator": "natural",
    "translation_path": "bank_slip.PersonType.natural"
  },
  "payer_postal_code": "00000000",
  "payment_date": null,
  "printing_policy": {
    "created_at": "2019-02-01T16:44:10",
    "enumerator": "no_printing",
    "translation_path": "bank_slip.PrintingPolicy.no_printing"
  },
  "protest_status": {
    "created_at": "2019-02-01T16:44:08",
    "enumerator": "not_protested",
    "translation_path": "bank_slip.ProtestStatus.not_protested"
  },
  "rebate_amount": null,
  "registration_institution": {
    "created_at": "2020-03-26T19:36:16",
    "enumerator": "qi_scd",
    "febraban_code": "329",
    "remittance_sequence": 72,
    "settlement_resource_account_key": "3e46d266-4fdb-4fd2-b87a-3e3de366afd4"
  },
  "requester_profile": 1,
  "requester_profile_code": "329-01-0001-0067049",
  "requester_registration_date": "2020-05-15"
}{
  "amount": 3,
  "asset_type": {
    "created_at": "2019-02-01T16:44:11",
    "enumerator": "invoice",
    "translation_path": "bank_slip.AssetType.invoice"
  },
  "automatic_bankruptcy_protest": true,
  "automatic_protest": false,
  "automatic_write_off": false,
  "bank_slip_file": [
    {
      "barcode": "32998827300000003000001010000000000200670490",
      "created_at": "2020-05-19T18:46:41",
      "digitable_line": "32990001031000000000902006704908882730000000300",
      "url": "https://linkparadownload.com/arquivo.pdf"
    }
  ],
  "bank_slip_key": "96b32f1a-c2bd-41a4-b4b1-a169235be68b",
  "bank_slip_status": {
    "created_at": "2019-02-01T16:44:07",
    "enumerator": "accepted",
    "translation_path": "bank_slip.BankSlipStatus.accepted"
  },
  "bank_teller_instructions": "Boleto Teste",
  "beneficiary_account_branch": "0001",
  "beneficiary_account_key": "7cc3b1f7-8015-4073-8471-a3ba57e34975",
  "beneficiary_account_number": "67049",
  "beneficiary_document_number": "12345678905",
  "beneficiary_key": "b91195e3-0cf4-4fed-90cf-7f5bef29c2f0",
  "beneficiary_name": "Greg Brown",
  "billing_account_key": "7cc3b1f7-8015-4073-8471-a3ba57e34975",
  "business_date_expiration": "2020-06-01",
  "created_at": "2020-05-15T21:00:25",
  "days_before_fine": null,
  "days_before_interest": null,
  "days_to_bankruptcy_protest": 1,
  "days_to_protest": null,
  "days_to_write_off": null,
  "discount_limit_date": null,
  "discount_value": null,
  "document_number": "Parcela 1",
  "expenses": [],
  "expiration": "2020-06-01",
  "fine_percentage": 0.1,
  "guarantor_address": null,
  "guarantor_city": null,
  "guarantor_document": null,
  "guarantor_name": null,
  "guarantor_person_type": null,
  "guarantor_postal_code": "00000000",
  "guarantor_state": null,
  "historical_our_number": 2,
  "institution_registration_date": null,
  "interest_daily_value": 0.34,
  "lock_origin_type": null,
  "nfe_key": null,
  "nfe_url": null,
  "occurrences": [
    {
      "created_at": "2020-05-15T21:00:25",
      "discount_amount": null,
      "discount_limit_date": null,
      "iof_amount": null,
      "new_bank_slip_status": null,
      "new_due_date": "2020-06-01",
      "new_protest_status": {
        "created_at": "2019-02-01T16:44:08",
        "enumerator": "not_protested",
        "translation_path": "bank_slip.ProtestStatus.not_protested"
      },
      "notary_office_number": null,
      "notary_office_protocol": null,
      "occurrence_expenses": null,
      "occurrence_feedback": null,
      "occurrence_key": "c3ab3e01-f198-4e7e-9e01-7a8091b8bd72",
      "occurrence_reasons": [],
      "occurrence_type": {
        "created_at": "2019-02-01T16:44:14",
        "enumerator": "registration",
        "translation_path": "bank_slip.OccurrenceType.registration"
      },
      "old_bank_slip_status": {
        "created_at": "2019-02-01T16:44:07",
        "enumerator": "accepted",
        "translation_path": "bank_slip.BankSlipStatus.accepted"
      },
      "old_due_date": null,
      "old_protest_status": null,
      "paid_amount": null,
      "paid_fine_amount": null,
      "paid_interest_amount": null,
      "payment_bank": null,
      "payment_branch": null,
      "payment_credit_date": null,
      "payment_method": null,
      "payment_origin": null,
      "protest_confirmation": null,
      "protest_expenses": null,
      "rebate_amount": null,
      "registration_institution_occurrence_date": "2020-05-15",
      "registration_institution_occurrence_event": [
        {
          "cnab_file": {
            "cnab_key": "abfc9fba-28fb-4e75-afcb-f4647d7031bc",
            "company_code": null,
            "created_at": "2020-05-15T21:00:22",
            "downloads": [],
            "file_size": "None",
            "filename": null,
            "line_length": null,
            "remitter_key": "b91195e3-0cf4-4fed-90cf-7f5bef29c2f0",
            "requester_profile_code": null,
            "type": {
              "created_at": "2019-02-01T16:44:17",
              "enumerator": "api_instruction",
              "translation_path": "bank_slip.CNABFileType.api_instruction"
            },
            "url": null,
            "version": null
          },
          "cnab_file_occurrence_order": 1,
          "created_at": "2020-05-15T21:00:25",
          "new_status": {
            "created_at": "2019-02-01T16:44:15",
            "enumerator": "waiting_submission",
            "translation_path": "bank_slip.RegistrationInstitutionOccurrenceStatus.waiting_submission"
          },
          "old_status": null
        }
      ],
      "registration_institution_occurrence_status": {
        "created_at": "2019-02-01T16:44:15",
        "enumerator": "waiting_submission",
        "translation_path": "bank_slip.RegistrationInstitutionOccurrenceStatus.waiting_submission"
      },
      "requester_occurrence_event": [
        {
          "cnab_file": {
            "cnab_key": "abfc9fba-28fb-4e75-afcb-f4647d7031bc",
            "company_code": null,
            "created_at": "2020-05-15T21:00:22",
            "downloads": [],
            "file_size": "None",
            "filename": null,
            "line_length": null,
            "remitter_key": "b91195e3-0cf4-4fed-90cf-7f5bef29c2f0",
            "requester_profile_code": null,
            "type": {
              "created_at": "2019-02-01T16:44:17",
              "enumerator": "api_instruction",
              "translation_path": "bank_slip.CNABFileType.api_instruction"
            },
            "url": null,
            "version": null
          },
          "cnab_file_occurrence_order": 1,
          "created_at": "2020-05-15T21:00:25",
          "new_status": {
            "created_at": "2019-02-01T16:44:16",
            "enumerator": "accepted",
            "translation_path": "bank_slip.RequesterOccurrenceStatus.accepted"
          },
          "old_status": null
        }
      ],
      "requester_occurrence_status": {
        "created_at": "2019-02-01T16:44:16",
        "enumerator": "accepted",
        "translation_path": "bank_slip.RequesterOccurrenceStatus.accepted"
      }
    }
  ],
  "our_number": 2,
  "paid_amount": null,
  "paid_fine_amount": null,
  "paid_interest_amount": null,
  "participant_control_number": null,
  "payer_account_digit": null,
  "payer_account_number": null,
  "payer_account_type": null,
  "payer_address": "Rua Carlos tampaio, 204",
  "payer_bank": null,
  "payer_branch_digit": null,
  "payer_branch_number": null,
  "payer_document": "41651732825",
  "payer_name": "Beatriz Couto",
  "payer_person_type": {
    "created_at": "2019-02-01T16:44:09",
    "enumerator": "natural",
    "translation_path": "bank_slip.PersonType.natural"
  },
  "payer_postal_code": "00000000",
  "payment_date": null,
  "printing_policy": {
    "created_at": "2019-02-01T16:44:10",
    "enumerator": "no_printing",
    "translation_path": "bank_slip.PrintingPolicy.no_printing"
  },
  "protest_status": {
    "created_at": "2019-02-01T16:44:08",
    "enumerator": "not_protested",
    "translation_path": "bank_slip.ProtestStatus.not_protested"
  },
  "rebate_amount": null,
  "registration_institution": {
    "created_at": "2020-03-26T19:36:16",
    "enumerator": "qi_scd",
    "febraban_code": "329",
    "remittance_sequence": 72,
    "settlement_resource_account_key": "3e46d266-4fdb-4fd2-b87a-3e3de366afd4"
  },
  "requester_profile": 1,
  "requester_profile_code": "329-01-0001-0067049",
  "requester_registration_date": "2020-05-15"
}{
  "amount": 3,
  "asset_type": {
    "created_at": "2019-02-01T16:44:11",
    "enumerator": "invoice",
    "translation_path": "bank_slip.AssetType.invoice"
  },
  "automatic_bankruptcy_protest": true,
  "automatic_protest": false,
  "automatic_write_off": false,
  "bank_slip_file": [
    {
      "barcode": "32998827300000003000001010000000000200670490",
      "created_at": "2020-05-19T18:46:41",
      "digitable_line": "32990001031000000000902006704908882730000000300",
      "url": "https://linkparadownload.com/arquivo.pdf"
    }
  ],
  "bank_slip_key": "96b32f1a-c2bd-41a4-b4b1-a169235be68b",
  "bank_slip_status": {
    "created_at": "2019-02-01T16:44:07",
    "enumerator": "accepted",
    "translation_path": "bank_slip.BankSlipStatus.accepted"
  },
  "bank_teller_instructions": "Boleto Teste",
  "beneficiary_account_branch": "0001",
  "beneficiary_account_key": "7cc3b1f7-8015-4073-8471-a3ba57e34975",
  "beneficiary_account_number": "67049",
  "beneficiary_document_number": "12345678905",
  "beneficiary_key": "b91195e3-0cf4-4fed-90cf-7f5bef29c2f0",
  "beneficiary_name": "Greg Brown",
  "billing_account_key": "7cc3b1f7-8015-4073-8471-a3ba57e34975",
  "business_date_expiration": "2020-06-01",
  "created_at": "2020-05-15T21:00:25",
  "days_before_fine": null,
  "days_before_interest": null,
  "days_to_bankruptcy_protest": 1,
  "days_to_protest": null,
  "days_to_write_off": null,
  "discount_limit_date": null,
  "discount_value": null,
  "document_number": "Parcela 1",
  "expenses": [],
  "expiration": "2020-06-01",
  "fine_percentage": 0.1,
  "guarantor_address": null,
  "guarantor_city": null,
  "guarantor_document": null,
  "guarantor_name": null,
  "guarantor_person_type": null,
  "guarantor_postal_code": "00000000",
  "guarantor_state": null,
  "historical_our_number": 2,
  "institution_registration_date": null,
  "interest_daily_value": 0.34,
  "lock_origin_type": null,
  "nfe_key": null,
  "nfe_url": null,
  "occurrences": [
    {
      "created_at": "2020-05-15T21:00:25",
      "discount_amount": null,
      "discount_limit_date": null,
      "iof_amount": null,
      "new_bank_slip_status": null,
      "new_due_date": "2020-06-01",
      "new_protest_status": {
        "created_at": "2019-02-01T16:44:08",
        "enumerator": "not_protested",
        "translation_path": "bank_slip.ProtestStatus.not_protested"
      },
      "notary_office_number": null,
      "notary_office_protocol": null,
      "occurrence_expenses": null,
      "occurrence_feedback": null,
      "occurrence_key": "c3ab3e01-f198-4e7e-9e01-7a8091b8bd72",
      "occurrence_reasons": [],
      "occurrence_type": {
        "created_at": "2019-02-01T16:44:14",
        "enumerator": "registration",
        "translation_path": "bank_slip.OccurrenceType.registration"
      },
      "old_bank_slip_status": {
        "created_at": "2019-02-01T16:44:07",
        "enumerator": "accepted",
        "translation_path": "bank_slip.BankSlipStatus.accepted"
      },
      "old_due_date": null,
      "old_protest_status": null,
      "paid_amount": null,
      "paid_fine_amount": null,
      "paid_interest_amount": null,
      "payment_bank": null,
      "payment_branch": null,
      "payment_credit_date": null,
      "payment_method": null,
      "payment_origin": null,
      "protest_confirmation": null,
      "protest_expenses": null,
      "rebate_amount": null,
      "registration_institution_occurrence_date": "2020-05-15",
      "registration_institution_occurrence_event": [
        {
          "cnab_file": {
            "cnab_key": "abfc9fba-28fb-4e75-afcb-f4647d7031bc",
            "company_code": null,
            "created_at": "2020-05-15T21:00:22",
            "downloads": [],
            "file_size": "None",
            "filename": null,
            "line_length": null,
            "remitter_key": "b91195e3-0cf4-4fed-90cf-7f5bef29c2f0",
            "requester_profile_code": null,
            "type": {
              "created_at": "2019-02-01T16:44:17",
              "enumerator": "api_instruction",
              "translation_path": "bank_slip.CNABFileType.api_instruction"
            },
            "url": null,
            "version": null
          },
          "cnab_file_occurrence_order": 1,
          "created_at": "2020-05-15T21:00:25",
          "new_status": {
            "created_at": "2019-02-01T16:44:15",
            "enumerator": "waiting_submission",
            "translation_path": "bank_slip.RegistrationInstitutionOccurrenceStatus.waiting_submission"
          },
          "old_status": null
        }
      ],
      "registration_institution_occurrence_status": {
        "created_at": "2019-02-01T16:44:15",
        "enumerator": "waiting_submission",
        "translation_path": "bank_slip.RegistrationInstitutionOccurrenceStatus.waiting_submission"
      },
      "requester_occurrence_event": [
        {
          "cnab_file": {
            "cnab_key": "abfc9fba-28fb-4e75-afcb-f4647d7031bc",
            "company_code": null,
            "created_at": "2020-05-15T21:00:22",
            "downloads": [],
            "file_size": "None",
            "filename": null,
            "line_length": null,
            "remitter_key": "b91195e3-0cf4-4fed-90cf-7f5bef29c2f0",
            "requester_profile_code": null,
            "type": {
              "created_at": "2019-02-01T16:44:17",
              "enumerator": "api_instruction",
              "translation_path": "bank_slip.CNABFileType.api_instruction"
            },
            "url": null,
            "version": null
          },
          "cnab_file_occurrence_order": 1,
          "created_at": "2020-05-15T21:00:25",
          "new_status": {
            "created_at": "2019-02-01T16:44:16",
            "enumerator": "accepted",
            "translation_path": "bank_slip.RequesterOccurrenceStatus.accepted"
          },
          "old_status": null
        }
      ],
      "requester_occurrence_status": {
        "created_at": "2019-02-01T16:44:16",
        "enumerator": "accepted",
        "translation_path": "bank_slip.RequesterOccurrenceStatus.accepted"
      }
    }
  ],
  "our_number": 2,
  "paid_amount": null,
  "paid_fine_amount": null,
  "paid_interest_amount": null,
  "participant_control_number": null,
  "payer_account_digit": null,
  "payer_account_number": null,
  "payer_account_type": null,
  "payer_address": "Rua Carlos tampaio, 204",
  "payer_bank": null,
  "payer_branch_digit": null,
  "payer_branch_number": null,
  "payer_document": "41651732825",
  "payer_name": "Beatriz Couto",
  "payer_person_type": {
    "created_at": "2019-02-01T16:44:09",
    "enumerator": "natural",
    "translation_path": "bank_slip.PersonType.natural"
  },
  "payer_postal_code": "00000000",
  "payment_date": null,
  "printing_policy": {
    "created_at": "2019-02-01T16:44:10",
    "enumerator": "no_printing",
    "translation_path": "bank_slip.PrintingPolicy.no_printing"
  },
  "protest_status": {
    "created_at": "2019-02-01T16:44:08",
    "enumerator": "not_protested",
    "translation_path": "bank_slip.ProtestStatus.not_protested"
  },
  "rebate_amount": null,
  "registration_institution": {
    "created_at": "2020-03-26T19:36:16",
    "enumerator": "qi_scd",
    "febraban_code": "329",
    "remittance_sequence": 72,
    "settlement_resource_account_key": "3e46d266-4fdb-4fd2-b87a-3e3de366afd4"
  },
  "requester_profile": 1,
  "requester_profile_code": "329-01-0001-0067049",
  "requester_registration_date": "2020-05-15"
}{
  "amount": 3,
  "asset_type": {
    "created_at": "2019-02-01T16:44:11",
    "enumerator": "invoice",
    "translation_path": "bank_slip.AssetType.invoice"
  },
  "automatic_bankruptcy_protest": true,
  "automatic_protest": false,
  "automatic_write_off": false,
  "bank_slip_file": [
    {
      "barcode": "32998827300000003000001010000000000200670490",
      "created_at": "2020-05-19T18:46:41",
      "digitable_line": "32990001031000000000902006704908882730000000300",
      "url": "https://linkparadownload.com/arquivo.pdf"
    }
  ],
  "bank_slip_key": "96b32f1a-c2bd-41a4-b4b1-a169235be68b",
  "bank_slip_status": {
    "created_at": "2019-02-01T16:44:07",
    "enumerator": "accepted",
    "translation_path": "bank_slip.BankSlipStatus.accepted"
  },
  "bank_teller_instructions": "Boleto Teste",
  "beneficiary_account_branch": "0001",
  "beneficiary_account_key": "7cc3b1f7-8015-4073-8471-a3ba57e34975",
  "beneficiary_account_number": "67049",
  "beneficiary_document_number": "12345678905",
  "beneficiary_key": "b91195e3-0cf4-4fed-90cf-7f5bef29c2f0",
  "beneficiary_name": "Greg Brown",
  "billing_account_key": "7cc3b1f7-8015-4073-8471-a3ba57e34975",
  "business_date_expiration": "2020-06-01",
  "created_at": "2020-05-15T21:00:25",
  "days_before_fine": null,
  "days_before_interest": null,
  "days_to_bankruptcy_protest": 1,
  "days_to_protest": null,
  "days_to_write_off": null,
  "discount_limit_date": null,
  "discount_value": null,
  "document_number": "Parcela 1",
  "expenses": [],
  "expiration": "2020-06-01",
  "fine_percentage": 0.1,
  "guarantor_address": null,
  "guarantor_city": null,
  "guarantor_document": null,
  "guarantor_name": null,
  "guarantor_person_type": null,
  "guarantor_postal_code": "00000000",
  "guarantor_state": null,
  "historical_our_number": 2,
  "institution_registration_date": null,
  "interest_daily_value": 0.34,
  "lock_origin_type": null,
  "nfe_key": null,
  "nfe_url": null,
  "occurrences": [
    {
      "created_at": "2020-05-15T21:00:25",
      "discount_amount": null,
      "discount_limit_date": null,
      "iof_amount": null,
      "new_bank_slip_status": null,
      "new_due_date": "2020-06-01",
      "new_protest_status": {
        "created_at": "2019-02-01T16:44:08",
        "enumerator": "not_protested",
        "translation_path": "bank_slip.ProtestStatus.not_protested"
      },
      "notary_office_number": null,
      "notary_office_protocol": null,
      "occurrence_expenses": null,
      "occurrence_feedback": null,
      "occurrence_key": "c3ab3e01-f198-4e7e-9e01-7a8091b8bd72",
      "occurrence_reasons": [],
      "occurrence_type": {
        "created_at": "2019-02-01T16:44:14",
        "enumerator": "registration",
        "translation_path": "bank_slip.OccurrenceType.registration"
      },
      "old_bank_slip_status": {
        "created_at": "2019-02-01T16:44:07",
        "enumerator": "accepted",
        "translation_path": "bank_slip.BankSlipStatus.accepted"
      },
      "old_due_date": null,
      "old_protest_status": null,
      "paid_amount": null,
      "paid_fine_amount": null,
      "paid_interest_amount": null,
      "payment_bank": null,
      "payment_branch": null,
      "payment_credit_date": null,
      "payment_method": null,
      "payment_origin": null,
      "protest_confirmation": null,
      "protest_expenses": null,
      "rebate_amount": null,
      "registration_institution_occurrence_date": "2020-05-15",
      "registration_institution_occurrence_event": [
        {
          "cnab_file": {
            "cnab_key": "abfc9fba-28fb-4e75-afcb-f4647d7031bc",
            "company_code": null,
            "created_at": "2020-05-15T21:00:22",
            "downloads": [],
            "file_size": "None",
            "filename": null,
            "line_length": null,
            "remitter_key": "b91195e3-0cf4-4fed-90cf-7f5bef29c2f0",
            "requester_profile_code": null,
            "type": {
              "created_at": "2019-02-01T16:44:17",
              "enumerator": "api_instruction",
              "translation_path": "bank_slip.CNABFileType.api_instruction"
            },
            "url": null,
            "version": null
          },
          "cnab_file_occurrence_order": 1,
          "created_at": "2020-05-15T21:00:25",
          "new_status": {
            "created_at": "2019-02-01T16:44:15",
            "enumerator": "waiting_submission",
            "translation_path": "bank_slip.RegistrationInstitutionOccurrenceStatus.waiting_submission"
          },
          "old_status": null
        }
      ],
      "registration_institution_occurrence_status": {
        "created_at": "2019-02-01T16:44:15",
        "enumerator": "waiting_submission",
        "translation_path": "bank_slip.RegistrationInstitutionOccurrenceStatus.waiting_submission"
      },
      "requester_occurrence_event": [
        {
          "cnab_file": {
            "cnab_key": "abfc9fba-28fb-4e75-afcb-f4647d7031bc",
            "company_code": null,
            "created_at": "2020-05-15T21:00:22",
            "downloads": [],
            "file_size": "None",
            "filename": null,
            "line_length": null,
            "remitter_key": "b91195e3-0cf4-4fed-90cf-7f5bef29c2f0",
            "requester_profile_code": null,
            "type": {
              "created_at": "2019-02-01T16:44:17",
              "enumerator": "api_instruction",
              "translation_path": "bank_slip.CNABFileType.api_instruction"
            },
            "url": null,
            "version": null
          },
          "cnab_file_occurrence_order": 1,
          "created_at": "2020-05-15T21:00:25",
          "new_status": {
            "created_at": "2019-02-01T16:44:16",
            "enumerator": "accepted",
            "translation_path": "bank_slip.RequesterOccurrenceStatus.accepted"
          },
          "old_status": null
        }
      ],
      "requester_occurrence_status": {
        "created_at": "2019-02-01T16:44:16",
        "enumerator": "accepted",
        "translation_path": "bank_slip.RequesterOccurrenceStatus.accepted"
      }
    }
  ],
  "our_number": 2,
  "paid_amount": null,
  "paid_fine_amount": null,
  "paid_interest_amount": null,
  "participant_control_number": null,
  "payer_account_digit": null,
  "payer_account_number": null,
  "payer_account_type": null,
  "payer_address": "Rua Carlos tampaio, 204",
  "payer_bank": null,
  "payer_branch_digit": null,
  "payer_branch_number": null,
  "payer_document": "41651732825",
  "payer_name": "Beatriz Couto",
  "payer_person_type": {
    "created_at": "2019-02-01T16:44:09",
    "enumerator": "natural",
    "translation_path": "bank_slip.PersonType.natural"
  },
  "payer_postal_code": "00000000",
  "payment_date": null,
  "printing_policy": {
    "created_at": "2019-02-01T16:44:10",
    "enumerator": "no_printing",
    "translation_path": "bank_slip.PrintingPolicy.no_printing"
  },
  "protest_status": {
    "created_at": "2019-02-01T16:44:08",
    "enumerator": "not_protested",
    "translation_path": "bank_slip.ProtestStatus.not_protested"
  },
  "rebate_amount": null,
  "registration_institution": {
    "created_at": "2020-03-26T19:36:16",
    "enumerator": "qi_scd",
    "febraban_code": "329",
    "remittance_sequence": 72,
    "settlement_resource_account_key": "3e46d266-4fdb-4fd2-b87a-3e3de366afd4"
  },
  "requester_profile": 1,
  "requester_profile_code": "329-01-0001-0067049",
  "requester_registration_date": "2020-05-15"
}{
  "amount": 3,
  "asset_type": {
    "created_at": "2019-02-01T16:44:11",
    "enumerator": "invoice",
    "translation_path": "bank_slip.AssetType.invoice"
  },
  "automatic_bankruptcy_protest": true,
  "automatic_protest": false,
  "automatic_write_off": false,
  "bank_slip_file": [
    {
      "barcode": "32998827300000003000001010000000000200670490",
      "created_at": "2020-05-19T18:46:41",
      "digitable_line": "32990001031000000000902006704908882730000000300",
      "url": "https://linkparadownload.com/arquivo.pdf"
    }
  ],
  "bank_slip_key": "96b32f1a-c2bd-41a4-b4b1-a169235be68b",
  "bank_slip_status": {
    "created_at": "2019-02-01T16:44:07",
    "enumerator": "accepted",
    "translation_path": "bank_slip.BankSlipStatus.accepted"
  },
  "bank_teller_instructions": "Boleto Teste",
  "beneficiary_account_branch": "0001",
  "beneficiary_account_key": "7cc3b1f7-8015-4073-8471-a3ba57e34975",
  "beneficiary_account_number": "67049",
  "beneficiary_document_number": "12345678905",
  "beneficiary_key": "b91195e3-0cf4-4fed-90cf-7f5bef29c2f0",
  "beneficiary_name": "Greg Brown",
  "billing_account_key": "7cc3b1f7-8015-4073-8471-a3ba57e34975",
  "business_date_expiration": "2020-06-01",
  "created_at": "2020-05-15T21:00:25",
  "days_before_fine": null,
  "days_before_interest": null,
  "days_to_bankruptcy_protest": 1,
  "days_to_protest": null,
  "days_to_write_off": null,
  "discount_limit_date": null,
  "discount_value": null,
  "document_number": "Parcela 1",
  "expenses": [],
  "expiration": "2020-06-01",
  "fine_percentage": 0.1,
  "guarantor_address": null,
  "guarantor_city": null,
  "guarantor_document": null,
  "guarantor_name": null,
  "guarantor_person_type": null,
  "guarantor_postal_code": "00000000",
  "guarantor_state": null,
  "historical_our_number": 2,
  "institution_registration_date": null,
  "interest_daily_value": 0.34,
  "lock_origin_type": null,
  "nfe_key": null,
  "nfe_url": null,
  "occurrences": [
    {
      "created_at": "2020-05-15T21:00:25",
      "discount_amount": null,
      "discount_limit_date": null,
      "iof_amount": null,
      "new_bank_slip_status": null,
      "new_due_date": "2020-06-01",
      "new_protest_status": {
        "created_at": "2019-02-01T16:44:08",
        "enumerator": "not_protested",
        "translation_path": "bank_slip.ProtestStatus.not_protested"
      },
      "notary_office_number": null,
      "notary_office_protocol": null,
      "occurrence_expenses": null,
      "occurrence_feedback": null,
      "occurrence_key": "c3ab3e01-f198-4e7e-9e01-7a8091b8bd72",
      "occurrence_reasons": [],
      "occurrence_type": {
        "created_at": "2019-02-01T16:44:14",
        "enumerator": "registration",
        "translation_path": "bank_slip.OccurrenceType.registration"
      },
      "old_bank_slip_status": {
        "created_at": "2019-02-01T16:44:07",
        "enumerator": "accepted",
        "translation_path": "bank_slip.BankSlipStatus.accepted"
      },
      "old_due_date": null,
      "old_protest_status": null,
      "paid_amount": null,
      "paid_fine_amount": null,
      "paid_interest_amount": null,
      "payment_bank": null,
      "payment_branch": null,
      "payment_credit_date": null,
      "payment_method": null,
      "payment_origin": null,
      "protest_confirmation": null,
      "protest_expenses": null,
      "rebate_amount": null,
      "registration_institution_occurrence_date": "2020-05-15",
      "registration_institution_occurrence_event": [
        {
          "cnab_file": {
            "cnab_key": "abfc9fba-28fb-4e75-afcb-f4647d7031bc",
            "company_code": null,
            "created_at": "2020-05-15T21:00:22",
            "downloads": [],
            "file_size": "None",
            "filename": null,
            "line_length": null,
            "remitter_key": "b91195e3-0cf4-4fed-90cf-7f5bef29c2f0",
            "requester_profile_code": null,
            "type": {
              "created_at": "2019-02-01T16:44:17",
              "enumerator": "api_instruction",
              "translation_path": "bank_slip.CNABFileType.api_instruction"
            },
            "url": null,
            "version": null
          },
          "cnab_file_occurrence_order": 1,
          "created_at": "2020-05-15T21:00:25",
          "new_status": {
            "created_at": "2019-02-01T16:44:15",
            "enumerator": "waiting_submission",
            "translation_path": "bank_slip.RegistrationInstitutionOccurrenceStatus.waiting_submission"
          },
          "old_status": null
        }
      ],
      "registration_institution_occurrence_status": {
        "created_at": "2019-02-01T16:44:15",
        "enumerator": "waiting_submission",
        "translation_path": "bank_slip.RegistrationInstitutionOccurrenceStatus.waiting_submission"
      },
      "requester_occurrence_event": [
        {
          "cnab_file": {
            "cnab_key": "abfc9fba-28fb-4e75-afcb-f4647d7031bc",
            "company_code": null,
            "created_at": "2020-05-15T21:00:22",
            "downloads": [],
            "file_size": "None",
            "filename": null,
            "line_length": null,
            "remitter_key": "b91195e3-0cf4-4fed-90cf-7f5bef29c2f0",
            "requester_profile_code": null,
            "type": {
              "created_at": "2019-02-01T16:44:17",
              "enumerator": "api_instruction",
              "translation_path": "bank_slip.CNABFileType.api_instruction"
            },
            "url": null,
            "version": null
          },
          "cnab_file_occurrence_order": 1,
          "created_at": "2020-05-15T21:00:25",
          "new_status": {
            "created_at": "2019-02-01T16:44:16",
            "enumerator": "accepted",
            "translation_path": "bank_slip.RequesterOccurrenceStatus.accepted"
          },
          "old_status": null
        }
      ],
      "requester_occurrence_status": {
        "created_at": "2019-02-01T16:44:16",
        "enumerator": "accepted",
        "translation_path": "bank_slip.RequesterOccurrenceStatus.accepted"
      }
    }
  ],
  "our_number": 2,
  "paid_amount": null,
  "paid_fine_amount": null,
  "paid_interest_amount": null,
  "participant_control_number": null,
  "payer_account_digit": null,
  "payer_account_number": null,
  "payer_account_type": null,
  "payer_address": "Rua Carlos tampaio, 204",
  "payer_bank": null,
  "payer_branch_digit": null,
  "payer_branch_number": null,
  "payer_document": "41651732825",
  "payer_name": "Beatriz Couto",
  "payer_person_type": {
    "created_at": "2019-02-01T16:44:09",
    "enumerator": "natural",
    "translation_path": "bank_slip.PersonType.natural"
  },
  "payer_postal_code": "00000000",
  "payment_date": null,
  "printing_policy": {
    "created_at": "2019-02-01T16:44:10",
    "enumerator": "no_printing",
    "translation_path": "bank_slip.PrintingPolicy.no_printing"
  },
  "protest_status": {
    "created_at": "2019-02-01T16:44:08",
    "enumerator": "not_protested",
    "translation_path": "bank_slip.ProtestStatus.not_protested"
  },
  "rebate_amount": null,
  "registration_institution": {
    "created_at": "2020-03-26T19:36:16",
    "enumerator": "qi_scd",
    "febraban_code": "329",
    "remittance_sequence": 72,
    "settlement_resource_account_key": "3e46d266-4fdb-4fd2-b87a-3e3de366afd4"
  },
  "requester_profile": 1,
  "requester_profile_code": "329-01-0001-0067049",
  "requester_registration_date": "2020-05-15"
}
```

STATUS 400

Response Body

```json
{
    {"title": "Bad Request", "description": "Invalid request body.", "translation": "Corpo da requisição inválido.", "extra_fields": {}, "code": "LEG000069"}
    
}
```

---

# Emissão de boleto único (instantânea)

URL: /en/documentation/boletos/emissao/emissao_boleto_unico_instantanea

:::danger Importante
Para registrar bolePix, é necessário que exista uma chave Pix aleatória ativa na conta em que os boletos serão registrados.
:::

No caso do registro de boleto único de forma instantânea, a resposta da requisição de criação (resposta síncrona) já retorna o boleto registrado (ou não, para casos de rejeição). O tempo de confirmação/rejeição da Nuclea/CIP, a respeito do registro do boleto, está incluso no tempo de resposta desse endpoint.

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/instant
MÉTODO POST

### Path parameters

| Campo                   | Tipo   | Descrição                                                    | Caracteres |
|-------------------------|--------|--------------------------------------------------------------|------------|
| `account_key`           | uuidv4 | Chave única de identificação da conta, no formato uuid v4    | 36         |
| `requester_profile_key` | uuidv4 | Chave única de identificação da carteira, no formato uuid v4 | 36         |

Request Body

```json
{
  "request_control_key": "0d496b4d-01f6-48cd-8ec9-9ead1e43f156",
  "our_number": 123456789,
  "document_number": "DOC4561237",
  "amount": 5000.00,
  "expiration": "2025-01-01",
  "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.00, "days_to_fine": 10},
  "interest_data": {
    "interest_type": "workdays_daily_amount",
    "interest_amount": 10.00,
    "days_to_interest": 2,
  },
  "financial_instrument_type": "digital_commercial_invoice",
  "write_off_data": {"days_to_write_off": 365},
  "rebate_amount": 200.00,
  "discounts_data": [
    {
      "discount_amount": 50.00,
      "discount_number": 1,
      "discount_type": "absolute",
      "discount_limit_date": "2024-12-01",
    }
  ],
  "payer_data": {
    "name": "Global Tech",
    "contact": {
      "email": "finance@globaltech.com",
      "phone": {"country_code": "055", "area_code": "11", "number": "987654321"},
    },
    "address": {
      "street": "101 High St.",
      "neighborhood": "Tech Park",
      "number": "202",
      "postal_code": "01001000",
      "city": "Innovation City",
      "state": "SP",
      "complement": "Building A",
    },
    "document_number": "12345678000195",
    "person_type": "legal",
  },
  "guarantor_data": {
    "name": "Jane Doe",
    "contact": {
      "email": "jane.doe@qitech.com.br",
      "phone": {"country_code": "055", "area_code": "11", "number": "999999999"},
    },
    "address": {
      "street": "202 Elm St.",
      "neighborhood": "Quiet Neighborhood",
      "number": "303",
      "postal_code": "01001000",
      "city": "Peaceful Town",
      "state": "RJ",
      "complement": "House 1",
    },
    "document_number": "23456789012",
    "person_type": "natural",
  },
  "pix_key": "06797774-e050-419e-a91a-c64c919b52c7",
  "notification": {
    "document_number": "12345678000195",
    "name": "Global Tech",
    "email": "finance@globaltech.com",
    "phone": {"country_code": "055", "area_code": "11", "number": "987654321"},
    "send_2_way": true,
    "send_before_due_date": false,
    "send_after_due_date": false,
    "send_on_protest": false
  }
}
```

 
### Request Body Params

| Campo                      | Tipo    | Descrição                                                                          | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `request_control_key` *    | uuidv4  | Chave única de identificação da request utilizada pelo cliente no formato uuid v4  | 36                                                |
| `our_number`              | integer | Número único de identificação do boleto junto à carteira. Pode ser enviado pelo cliente e, caso não seja, a QI Tech irá gerar um                           | 11                                                |
| `document_number`          | string  | Número de identificação do boleto. Pode ser o número da nota fiscal eletrônica     | 10                                                |
| `participant_control_number` | string | Nº Controle do Participante                                                       |
25                                                |
| `amount` *                 | float   | Valor base do boleto                                                               | -                                                 |
| `expiration` *             | string  | Data de vencimento                                                                 | 10                                                |
| `bank_teller_instructions` | string  | Observações ao pagador do boleto. Aceita no máximo 320 caracteres, distribuídos em até 7 linhas. Cada linha pode conter no máximo 90 caracteres. Caso uma linha ultrapasse 90 caracteres, o texto será automaticamente quebrado em uma nova linha | 320                                               |
| `rebate_amount`            | float   | Valor de abatimento do boleto, que será aplicado em cima do valor base             | -                                                 |
| `max_payment_days`         | integer | Máximo de dias corridos que o boleto ficará disponível para pagamento, após o vencimento (pode ser no máximo 365) | -          |
| `financial_instrument_type`   | string  | Tipo de espécie do boleto | **[Enumeradores financial_instrument_type](#enumeradores-financial_instrument_type)** |
| `partial_payment_data`    | object  | Configurações de pagamento parcial                      | **[Objeto partial_payment_data](#objeto-partial_payment_data)** |
| `write_off_data`       | object  | Configuração de baixa      | **[Objeto write_off_data](#objeto-write_off_settings)** |
| `protest_data`         | object  | Configuração de protesto       | **[Objeto protest_data](#objeto-protest_settings)** |
| `bankruptcy_protest_data` | object  | Configuração de protesto falimentar | **[Objeto bankruptcy_protest_data](#objeto-bankruptcy_protest_settings)** |
| `fine_data`            | object  | Configuração de multa                 | **[Objeto fine_data](#objeto-fine_settings)** |
| `interest_data`        | object  | Configuração de juros        | **[Objeto interest_data](#objeto-interest_settings)** |
| `discounts_data`           | object array | Descontos           | **[Objeto discount](#objeto-discounts_data)** |
| `payer_data` *             | object  | Dados do pagador                                                                   | **[Objeto payer_data](#objetos-payer_data-e-guarantor_data)** |
| `guarantor_data`           | object  | Dados do sacador avalista                                                          | **[Objeto guarantor_data](#objetos-payer_data-e-guarantor_data)** |
| `pix_key`                  | uuidv4  | Chave pix do tipo aleatória                                                        | 36                                                |

:::info BolePix
Caso o parâmetro `pix_key`, opcional, seja enviado na request, será gerado um bolePix. BolePix é um boleto cujo pagamento é vinculado a um QR Code Pix. Sendo assim, o pagador pode realizar o pagamento do boleto tanto utilizando a linha digitável do mesmo, quanto através da leitura do QR Code Pix vinculado. Caso o pagamento seja feito via QR Code, a liquidação financeira se dá instantaneamente, enquanto os retornos bancários e webhooks envolvidos na liquidação serão gerados assim como é feito para um boleto comum.

Importante: para registrar um bolePix, é necessário que exista uma chave Pix aleatória ativa na conta em que boleto será registrado.
:::

:::tip Configurações Padrão da Carteira
Caso cada um dos campos `max_payment_days`, `write_off_data`, `protest_data`, `bankruptcy_protest_data`, `fine_data`, `interest_data` e `pix_key` não sejam enviados na request e a carteira possua configurações padrão (i.e. `max_payment_days`, `write_off_settings`, `protest_settings`, `bankruptcy_protest_settings`, `fine_settings`, `interest_settings` e `qr_code_settings`, respectivamente, no `configuration_data` do `requester_profile`), serão utilizadas tais configurações padrão para a emissão do título.
:::

:::caution Limitações e Restrições
- **Boletos de Pagamento Parcial:** Não é permitido o pagamento via QR Code Pix. Portanto, não é permitido enviar a `pix_key` no registro, nem ter uma configuração padrão de geração de bolePix para a carteira.

- **Boletos de Cartão de Crédito:** Não é necessário nem permitido enviar informações rebate, desconto, multa e juros. Isso se deve ao padrão do mercado, onde muitas Instituições Financeiras não aceitam o pagamento de boletos de cartão de crédito que contenham essas informações. A carteira também não pode ter essas configurações definidas como padrão. Sendo assim boletos desse tipo podem ser pagos parcialmente mesmo após o vencimento, sem incidência de juros, multas, descontos ou abatimentos na fatura corrente. Para aplicar esses valores é necessário incluí-los na próxima fatura, seja através da [ocorrência de edição de valor](/documentation/boletos/instrucoes/valor) do boleto ou emitindo um novo boleto que inclua esses valores. É possível enviar `amount = 0` para boletos deste tipo.

**Importante:** Boletos do tipo `credit_card` são obrigatoriamente de pagamento parcial, sendo assim é necessário fornecer as informações de `partial_payment_data` ou ter essa configuração padrão na carteira. Caso o campo `financial_instrument_type` não seja enviado, o valor padrão será `digital_commercial_invoice`.
:::

:::tip Recomendações de Carteiras
- **Carteira para Boletos Padrão:** Mantenha as configurações padrão para multas, juros e protesto
- **Carteira para Boletos de Pagamento Parcial:** Sem configuração de Pix e com regras específicas para pagamento parcial
- **Carteira para Boletos de Cartão de Crédito:** Sem configurações de multa, juros, desconto ou rebate

Criar carteiras específicas garante que as configurações padrão sejam adequadas para cada tipo de boleto e evita conflitos nas regras de negócio.
:::

:::info Máquina de Estados
A máquina de status para boletos de pagamento parcial possui algumas diferenças. Para mais detalhes, consulte a [introdução](/documentation/boletos/introducao) , onde há uma explicação sobre como aplicar a incidência de juros e multas no boleto seguindo as boas práticas do mercado.
:::

### Enumeradores financial_instrument_type

| Enumerador  | Descrição                        |
|-------------|----------------------------------|
| digital_commercial_invoice | DMI Duplicata Mercantil Indicação |
| credit_card | Cartão de Crédito |
| check | CH Cheque |
| digital_commercial | DM Duplicata Mercantil |
| digital_service_invoice | Duplicata de Serviço |
| digital_service_invoice_indication | DSI Duplicata de Serviço Indicação |
| digital_rural_invoice | DR Duplicata Rural |
| bill_of_exchange | LC Letra de Câmbio |
| commercial_credit_note | NCC Nota de Crédito Comercial |
| export_credit_note | NCE Nota de Crédito Exportação |
| industrial_credit_note | NCI Nota de Crédito Industrial |
| rural_credit_note | NCR Nota de Crédito Rural |
| promissory_note | NP Nota Promissória |
| rural_promissory_note | NPR Nota Promissória Rural |
| mercantile_triplicate | TM Triplicata Mercantil |
| service_triplicate | TS Triplicata de Serviço |
| insurance_note | NS Nota de Seguro |
| receipt | RC Recibo |
| printed_bank_slip | FAT Bloqueto |
| debit_note | ND Nota de Débito |
| insurance_policy | AP Apólice de Seguro |
| school_monthly_fee | ME Mensalidade Escolar |
| consortium_installment | PC Parcela de Consórcio |
| invoice | NF Nota Fiscal |
| debt_document | DD Documento de Dívida |
| rural_product_certificate | Cédula de Produto Rural |
| warrant | Warrant |
| state_active_debt | Dívida Ativa de Estado |
| municipal_active_debt | Dívida Ativa de Município |
| federal_active_debt | Dívida Ativa da União |
| condominium_charges | Encargos condominiais |
| proposal_bank_slip | Boleto proposta |
| deposit_and_contribution_bank_slip | Boleto de Depósito e Aporte |
| others | Outros |

### Objeto partial_payment_data

| Campo                             | Tipo    | Descrição                                                                 | Caracteres |
|-----------------------------------|---------|---------------------------------------------------------------------------|------------|
| `partial_payment_minimum_type` *  | string  | Tipo de valor mínimo para pagamento parcial                               | **[Enumeradores partial_payment_type](#enumeradores-partial_payment_type)** |
| `partial_payment_minimum_percentage` | float | Percentual mínimo permitido para o pagamento parcial                      | -          |
| `partial_payment_minimum_amount`  | float  | Valor mínimo permitido para o pagamento parcial                           | -          |
| `partial_payment_maximum_type`    | string  | Tipo de valor máximo para pagamento parcial                               | **[Enumeradores partial_payment_type](#enumeradores-partial_payment_type)** |
| `partial_payment_maximum_percentage` | float | Percentual máximo permitido para o pagamento parcial                      | -          |
| `partial_payment_maximum_amount`  | float  | Valor máximo permitido para o pagamento parcial                           | -          |
| `partial_payment_quantity` *      | integer | Quantidade de pagamentos parciais permitidos                              | -          |

:::caution Atenção!
De acordo com o valor enviado nos campos `partial_payment_minimum_type` e `partial_payment_maximum_type`, é necessário enviar o `partial_payment_minimum_amount` ou `partial_payment_minimum_percentage`, e o `partial_payment_maximum_amount` ou `partial_payment_maximum_percentage` correspondente.
:::

### Enumeradores partial_payment_type

| Enumerador  | Descrição                        |
|-------------|----------------------------------|
| absolute    | Valor absoluto                   |
| percentage  | Percentual                       |

### Objeto write_off_data

| Campo                     | Tipo    | Descrição                                                                   | Caracteres |
|---------------------------|---------|-----------------------------------------------------------------------------|------------|
| `days_to_write_off` *     | integer | Dias, após o vencimento, para que o boleto seja baixado automaticamente     | -          |

### Objeto protest_data

| Campo                     | Tipo    | Descrição                                                                   | Caracteres |
|---------------------------|---------|-----------------------------------------------------------------------------|------------|
| `days_to_protest` *       | integer | Dias, após o vencimento, para que o boleto seja protestado automaticamente  | -          |

### Objeto bankruptcy_protest_data

| Campo                          | Tipo    | Descrição                                                                   | Caracteres  |
|--------------------------------|---------|-----------------------------------------------------------------------------|------------|
| `days_to_bankruptcy_protest` * | integer | Dias, após o vencimento, para que o boleto seja protestado automaticamente  | -           |

### Objeto fine_data

Opção 1: multa em valor absoluto (`fine_type=absolute`)

| Campo                     | Tipo    | Descrição                                               | Caracteres                |
|---------------------------|---------|---------------------------------------------------------|-------------------------------------------------------------------------|
| `fine_type` *             | string  | Tipo da multa                                                       | **[Enumeradores fine_type](#enumeradores-fine_type)**                                              |
| `fine_amount` *           | float   | Valor absoluto da multa                                             | -                                                                        |
| `days_to_fine` *          | integer | Dias, após o vencimento, para que a multa seja cobrada              | -                                                                        |

Opção 2: multa em valor percentual (`fine_type=percentage`)

| Campo                     | Tipo    | Descrição                                                 | Caracteres                             |
|---------------------------|---------|-----------------------------------------------------------|---------------------------------------|
| `fine_type` *             | string  | Tipo da multa                                             | **[Enumeradores fine_type](#enumeradores-fine_type)** |
| `fine_percentage` *       | integer | Valor percentual da multa, de 1 a 100                     | -                                      |
| `days_to_fine` *          | integer | Dias, após o vencimento, para que a multa seja cobrada    | -                                      |

### Enumeradores fine_type

| Enumerador         | Descrição             |
|--------------------|-----------------------|
| absolute           | valor absoluto        |
| percentage         | valor percentual      |

### Objeto interest_data

Opção 1: juros utilizando valores absolutos (`interest_type=calendar_days_daily_amount` ou `interest_type=workdays_daily_amount`)

| Campo                     | Tipo    | Descrição                                                                     | Caracteres                                                                                      |
|---------------------------|---------|-------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
| `interest_type` *         | string  | Tipo de juros       | **[Enumeradores interest_type](#enumeradores-interest_type)** |
| `interest_amount` *       | float   | Valor a ser cobrado por unidade de tempo determinada (dias úteis ou corridos) | -                                                                                               |
| `days_to_interest` *      | integer | Dias, após o vencimento, para que comece a cobrar os juros                    | -                                                                                               |

Opção 2: juros utilizando valores percentuais (`interest_type=calendar_days_monthly_percentage`)

| Campo                    | Tipo    | Descrição                                                                             | Caracteres                                                                                          |
|--------------------------|---------|---------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
| `interest_type` *        | string  | Tipo de juros       | **[Enumeradores interest_type](#enumeradores-interest_type)** |
| `interest_percentage` *  | integer | Porcentagem a ser cobrada por unidade de tempo determinada (dias úteis ou corridos)                                                                      | -                                                                           |
| `days_to_interest` *     | integer | Dias, após o vencimento, para que comece a cobrar os juros                             | -                                                                                                   |

### Enumeradores interest_type

| Enumerador                       | Descrição                                                            |
|----------------------------------|----------------------------------------------------------------------|
| calendar_days_daily_amount       | Valor diário sobre dias corridos                                     |
| workdays_daily_amount            | Valor diário sobre dias úteis                                        |
| calendar_days_monthly_percentage | Porcentagem 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"]`)

| Campo                     | Tipo    | Descrição                                           | Caracteres                                                |
|---------------------------|---------|-----------------------------------------------------|-----------------------------------------------------------|
| `discount_amount` *       | float   | Valor absoluto de desconto por unidade de tempo                                            | -                                                          |
| `discount_number` *       | integer | Número do desconto                                     | -                                                         |
| `discount_type` *         | string  | Configuração do desconto em valores absolutos                                    | **[Enumerador discount_type](#enumeradores-discount_type)** |                                                       |
| `discount_limit_date` *   | string  | Data limite para aplicação do desconto   | 10                                                        |

Opção 2: descontos utilizando valores percentuais (`discount_type in ["percentage", "anticipation_calendar_days_daily_percentage", "anticipation_workdays_daily_percentage"]`)

| Campo                     | Tipo    | Descrição                                           | Caracteres                                                |
|---------------------------|---------|-----------------------------------------------------|-----------------------------------------------------------|
| `discount_percentage` *   | float   | Valor percentual de desconto por unidade de tempo                                            | -                                                          |
| `discount_number` *       | integer | Número do desconto                                     | -                                                         |
| `discount_type` *         | string  | Configuração do desconto em valores percentuais                                    | **[Enumerador discount_type](#enumeradores-discount_type)** |                                                       |
| `discount_limit_date` *   | string  | Data limite para aplicação do desconto   | 10                                                        |

:::caution 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

| Enumerador                                  | Descrição                                                                |
|---------------------------------------------|--------------------------------------------------------------------------|
| absolute                                    | Valor fixo                                                               |
| anticipation_calendar_days_daily_amount     | Valor diário de desconto de antecipação, sobre dias corridos             |
| anticipation_workdays_daily_amount          | Valor diário de desconto de antecipação, sobre dias úteis                |
| percentage                                  | Porcentagem fixa                                                         |
| anticipation_calendar_days_daily_percentage | Porcentagem mensal de desconto de antecipação, com base em dias corridos |
| anticipation_workdays_daily_percentage      | Porcentagem anual de desconto de antecipação, com base em dias úteis     |

### Objetos payer_data e guarantor_data

| Campo                     | Tipo   | Descrição                                                  | Caracteres|
|---------------------------|--------|-------------------------------------|-----------------------------------------------------------|
| `name` *                  | string | Nome completo                       | 100                                                       |
| `document_number` *       | string | Número do documento (CPF/CNPJ)      | 11 ou 14                                                  |
| `person_type` *           | string | Tipo da pessoa (física ou jurídica) | **[Enumeradores person_type](#enumeradores-person_type)** |
| `contact`                 | object | Informações de contato              | **[Objeto contact](#objeto-contact)**                     |
| `address`                 | object | Endereço                            | **[Objeto address](#objeto-address)**                     |

### Enumeradores person_type

| Enumerador         | Descrição             |
|--------------------|-----------------------|
| natural            | pessoa física         |
| legal              | pessoa jurídica       |

### Objeto contact

| Campo                     | Tipo   | Descrição                         | Caracteres                         |
|---------------------------|--------|-----------------------------------|------------------------------------|
| `email`                   | string | E-mail de contato                 | 320                                |
| `phone`                   | object | Telefone de contato               | **[Objeto phone](#objeto-phone)**  |

### Objeto phone

| Campo                           | Tipo   | Descrição                                    | Caracteres |
|---------------------------------|--------|----------------------------------------------|------------|
| `country_code` *     | string | Código DDI (Discagem Direta Internacional)   | 3          |
| `area_code` *                   | string | Código DDD (Discagem Direta à Distância)     | 2          |
| `number` *                      | string | Complemento                                  | 9          |

### Objeto address

| Campo                     | Tipo   | Descrição                                    | Caracteres |
|---------------------------|--------|----------------------------------------------|------------|
| `street` *                | string | Logradouro                                   | 500        |
| `number` *                | string | Número                                       | 6          |
| `complement`              | string | Complemento                                  | 500        |
| `neighborhood` *          | string | Bairro                                       | 100        |
| `postal_code` *           | string | CEP                                          | 8          |
| `city` *                  | string | Cidade                                       | 100        |
| `state` *                 | string | Estado (UF) | **[Enumerador state](#enumeradores-state)** |

### Enumeradores state

| Enumerador         | Descrição             |
|--------------------|-----------------------|
| 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                 | Exceção               |

### Objeto notification

| Campo                     | Tipo    | Descrição                                                                               | Caracteres |
|---------------------------|---------|-----------------------------------------------------------------------------------------|------------|
| `document_number` *       | string  | Número do documento de quem receberá as notificações (CPF/CNPJ)                         | 11 ou 14   |
| `name` *                  | string  | Nome de quem receberá as notificações                                                   | 100        |
| `email`                   | string  | E-mail para o qual serão enviadas as notificações                                       | 320        |
| `phone`                   | object  | Telefone de contato para o qual serão enviadas as notificações | **[Objeto phone](#objeto-phone)**   |
| `send_2_way` *            | boolean | Enviar segunda via                                                                      | -          |
| `send_before_due_date` *  | boolean | Enviar notificação ao pagador antes da data de vencimento                               | -          |
| `send_after_due_date` *   | boolean | Enviar notificação ao pagador quando o boleto vencer                                    | -          |
| `send_on_protest` *       | boolean | Enviar notificação ao entrar em fluxo de protesto                                       | -          |

## Response

STATUS 201

Response Body: Boleto registrado

```json
{
  "request_control_key": "6e290347-330d-4b3a-8ebb-2ac217ad6eb3",
  "bank_slip_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "bank_slip_status": "registered",
  "our_number": 92580722204,
  "barcode": "32998995900000892812147469258072220406456140",
  "digitable_line": "32992147466925807222704064561402899590000089281",
  "qr_code_data": {
    "qr_code_key": "bc5cb30c-8f98-4273-b405-3546da1d8d7a",
    "pix_key": "06797774-e050-419e-a91a-c64c919b52c7",
    "receiver_conciliation_id": "01GVGV9NXBCY287Z6CJ4S0ENW9",
    "url": "00020126830014br.gov.bcb.pix2561qrcode.qitech.app/bacen/cobv/58fd5103a8e64bbbab2fd49b0bd580145204000053039865802BR5925GONNFUNDODEINVESTIMENTOEM6012RiodeJaneiro6107226401262070503***6304EA0D",
    "image": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/wAALCAD0APQBAREA/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/9oACAEBAAA/APf6KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK+QPhl8Mv+Fjf2p/xN/wCz/sHlf8u3m79+/wD21xjZ79a7/wD4Zl/6m7/ym/8A22j/AIZl/wCpu/8AKb/9to/Zl/5mn/t0/wDa1egfE34Zf8LG/sv/AIm/9n/YPN/5dvN379n+2uMbPfrXgHwy+GX/AAsb+1P+Jv8A2f8AYPK/5dvN379/+2uMbPfrR8Tfib/wsb+y/wDiUf2f9g83/l583fv2f7C4xs9+td//AMm5/wDUw/27/wBunkeR/wB/N27zvbG3vnjwCvr/AOJvxN/4Vz/Zf/Eo/tD7f5v/AC8+Vs2bP9hs53+3SvkCvf8A9mX/AJmn/t0/9rUf8m5/9TD/AG7/ANunkeR/383bvO9sbe+ePQPhl8Mv+Fc/2p/xN/7Q+3+V/wAu3lbNm/8A22znf7dK8A+GXxN/4Vz/AGp/xKP7Q+3+V/y8+Vs2b/8AYbOd/t0o+GXxN/4Vz/an/Eo/tD7f5X/Lz5WzZv8A9hs53+3Svf8A4m/DL/hY39l/8Tf+z/sHm/8ALt5u/fs/21xjZ79a8/8A+GZf+pu/8pv/ANtr0D4ZfE3/AIWN/an/ABKP7P8AsHlf8vPm79+//YXGNnv1rwD4ZfE3/hXP9qf8Sj+0Pt/lf8vPlbNm/wD2Gznf7dK7/wD4aa/6lH/ypf8A2quA+GXxN/4Vz/an/Eo/tD7f5X/Lz5WzZv8A9hs53+3Svr+vkD4ZfDL/AIWN/an/ABN/7P8AsHlf8u3m79+//bXGNnv1rv8A/hmX/qbv/Kb/APbaP+GZf+pu/wDKb/8AbaP2Zf8Amaf+3T/2tX0BRRRXz/8Asy/8zT/26f8AtavAK9//AGZf+Zp/7dP/AGtR+zL/AMzT/wBun/tavQPib8Mv+Fjf2X/xN/7P+web/wAu3m79+z/bXGNnv1rz/wDZl/5mn/t0/wDa1cB8Mvib/wAK5/tT/iUf2h9v8r/l58rZs3/7DZzv9ule/wDwy+Jv/Cxv7U/4lH9n/YPK/wCXnzd+/f8A7C4xs9+teAfE34Zf8K5/sv8A4m/9ofb/ADf+XbytmzZ/ttnO/wBule//ABN+Jv8Awrn+y/8AiUf2h9v83/l58rZs2f7DZzv9uleAfDL4Zf8ACxv7U/4m/wDZ/wBg8r/l283fv3/7a4xs9+tHxN+GX/Cuf7L/AOJv/aH2/wA3/l28rZs2f7bZzv8AbpXv/wAMvhl/wrn+1P8Aib/2h9v8r/l28rZs3/7bZzv9ulef/tNf8yt/29/+0a9A+GXxN/4WN/an/Eo/s/7B5X/Lz5u/fv8A9hcY2e/WvP8A/k3P/qYf7d/7dPI8j/v5u3ed7Y2988cB8Tfhl/wrn+y/+Jv/AGh9v83/AJdvK2bNn+22c7/bpXf/APDTX/Uo/wDlS/8AtVcB8Tfhl/wrn+y/+Jv/AGh9v83/AJdvK2bNn+22c7/bpX1/Xz//AMm5/wDUw/27/wBunkeR/wB/N27zvbG3vng/5OM/6l7+wv8At78/z/8Av3t2+T753dsc+gfDL4m/8LG/tT/iUf2f9g8r/l583fv3/wCwuMbPfrXn/wCzL/zNP/bp/wC1q8Ar3/8AZl/5mn/t0/8Aa1H7Mv8AzNP/AG6f+1q+gKKKK+f/ANmX/maf+3T/ANrUf8My/wDU3f8AlN/+216B8Mvhl/wrn+1P+Jv/AGh9v8r/AJdvK2bN/wDttnO/26V5/wDsy/8AM0/9un/taj/k4z/qXv7C/wC3vz/P/wC/e3b5Pvnd2xyf8nGf9S9/YX/b35/n/wDfvbt8n3zu7Y5P2mv+ZW/7e/8A2jR+zL/zNP8A26f+1qP+Tc/+ph/t3/t08jyP+/m7d53tjb3zx4BXv/7TX/Mrf9vf/tGj/k3P/qYf7d/7dPI8j/v5u3ed7Y2988cB8Mvhl/wsb+1P+Jv/AGf9g8r/AJdvN379/wDtrjGz3613/wDwzL/1N3/lN/8AttH7Mv8AzNP/AG6f+1q4D4m/DL/hXP8AZf8AxN/7Q+3+b/y7eVs2bP8AbbOd/t0rv/8Ahpr/AKlH/wAqX/2qj/k4z/qXv7C/7e/P8/8A797dvk++d3bHJ/ybn/1MP9u/9unkeR/383bvO9sbe+ePQPhl8Mv+Fc/2p/xN/wC0Pt/lf8u3lbNm/wD22znf7dKPib8Mv+Fjf2X/AMTf+z/sHm/8u3m79+z/AG1xjZ79a8//AGZf+Zp/7dP/AGtX0BXz/wDsy/8AM0/9un/taj/hmX/qbv8Aym//AG2vQPhl8Mv+Fc/2p/xN/wC0Pt/lf8u3lbNm/wD22znf7dK8/wD2Zf8Amaf+3T/2tX0BRRRXz/8A8My/9Td/5Tf/ALbR/wAMy/8AU3f+U3/7bR/wzL/1N3/lN/8AttegfDL4Zf8ACuf7U/4m/wDaH2/yv+Xbytmzf/ttnO/26V5//wAm5/8AUw/27/26eR5H/fzdu872xt7549A+GXwy/wCFc/2p/wATf+0Pt/lf8u3lbNm//bbOd/t0rz/9mX/maf8At0/9rVwHwy+Jv/Cuf7U/4lH9ofb/ACv+Xnytmzf/ALDZzv8AbpR8Mvib/wAK5/tT/iUf2h9v8r/l58rZs3/7DZzv9ulHwy+Jv/Cuf7U/4lH9ofb/ACv+Xnytmzf/ALDZzv8AbpXf/sy/8zT/ANun/tavQPhl8Mv+Fc/2p/xN/wC0Pt/lf8u3lbNm/wD22znf7dK8/wD2Zf8Amaf+3T/2tXoHwy+GX/Cuf7U/4m/9ofb/ACv+Xbytmzf/ALbZzv8AbpXgHwy+Jv8Awrn+1P8AiUf2h9v8r/l58rZs3/7DZzv9uld/+zL/AMzT/wBun/tavQPhl8Mv+Fc/2p/xN/7Q+3+V/wAu3lbNm/8A22znf7dK8A+GXxN/4Vz/AGp/xKP7Q+3+V/y8+Vs2b/8AYbOd/t0o+GXxN/4Vz/an/Eo/tD7f5X/Lz5WzZv8A9hs53+3Su/8A2Zf+Zp/7dP8A2tR/ybn/ANTD/bv/AG6eR5H/AH83bvO9sbe+eD9mX/maf+3T/wBrUfsy/wDM0/8Abp/7Wo/4Zl/6m7/ym/8A22j/AIZl/wCpu/8AKb/9to/4Zl/6m7/ym/8A22vQPhl8Mv8AhXP9qf8AE3/tD7f5X/Lt5WzZv/22znf7dK9Aooor5/8A2Zf+Zp/7dP8A2tXAfE34m/8ACxv7L/4lH9n/AGDzf+Xnzd+/Z/sLjGz360fE34m/8LG/sv8A4lH9n/YPN/5efN379n+wuMbPfrXv/wAMvhl/wrn+1P8Aib/2h9v8r/l28rZs3/7bZzv9ulfIFFegfDL4m/8ACuf7U/4lH9ofb/K/5efK2bN/+w2c7/bpXf8A7TX/ADK3/b3/AO0a9A+GXxN/4WN/an/Eo/s/7B5X/Lz5u/fv/wBhcY2e/WvAPib8Mv8AhXP9l/8AE3/tD7f5v/Lt5WzZs/22znf7dKPib8Mv+Fc/2X/xN/7Q+3+b/wAu3lbNmz/bbOd/t0rv/wBmX/maf+3T/wBrVwHxN+GX/Cuf7L/4m/8AaH2/zf8Al28rZs2f7bZzv9ulHxN+GX/Cuf7L/wCJv/aH2/zf+XbytmzZ/ttnO/26V3//AAzL/wBTd/5Tf/ttH7TX/Mrf9vf/ALRrgPhl8Tf+Fc/2p/xKP7Q+3+V/y8+Vs2b/APYbOd/t0o+Jvwy/4Vz/AGX/AMTf+0Pt/m/8u3lbNmz/AG2znf7dK7//AJOM/wCpe/sL/t78/wA//v3t2+T753dscn/Juf8A1MP9u/8Abp5Hkf8Afzdu872xt7548Ar3/wD5Nz/6mH+3f+3TyPI/7+bt3ne2NvfPHAfE34Zf8K5/sv8A4m/9ofb/ADf+XbytmzZ/ttnO/wBuld/+01/zK3/b3/7Rr6Aorz/4ZfE3/hY39qf8Sj+z/sHlf8vPm79+/wD2FxjZ79a9Aooor5A+Jvwy/wCFc/2X/wATf+0Pt/m/8u3lbNmz/bbOd/t0o+JvxN/4WN/Zf/Eo/s/7B5v/AC8+bv37P9hcY2e/Wu//AGmv+ZW/7e//AGjXoHwy+GX/AArn+1P+Jv8A2h9v8r/l28rZs3/7bZzv9ulHwy+Jv/Cxv7U/4lH9n/YPK/5efN379/8AsLjGz3615/8A8nGf9S9/YX/b35/n/wDfvbt8n3zu7Y5+gK+QPib8Tf8AhY39l/8AEo/s/wCweb/y8+bv37P9hcY2e/Wvf/hl8Tf+Fjf2p/xKP7P+weV/y8+bv37/APYXGNnv1rz/AP4aa/6lH/ypf/aq9A+Jvwy/4WN/Zf8AxN/7P+web/y7ebv37P8AbXGNnv1r0CvkD4m/DL/hXP8AZf8AxN/7Q+3+b/y7eVs2bP8AbbOd/t0rv/8Ahpr/AKlH/wAqX/2qj/hmX/qbv/Kb/wDbaP8Ak3P/AKmH+3f+3TyPI/7+bt3ne2NvfPHoHxN+Jv8Awrn+y/8AiUf2h9v83/l58rZs2f7DZzv9ulHwy+GX/Cuf7U/4m/8AaH2/yv8Al28rZs3/AO22c7/bpXn/AO01/wAyt/29/wDtGj/hpr/qUf8Aypf/AGqj/k4z/qXv7C/7e/P8/wD797dvk++d3bHJ/wANNf8AUo/+VL/7VXAfE34Zf8K5/sv/AIm/9ofb/N/5dvK2bNn+22c7/bpR8Mvib/wrn+1P+JR/aH2/yv8Al58rZs3/AOw2c7/bpR8Mvhl/wsb+1P8Aib/2f9g8r/l283fv3/7a4xs9+tHwy+Jv/Cuf7U/4lH9ofb/K/wCXnytmzf8A7DZzv9ulfX9FFFFfP/8AwzL/ANTd/wCU3/7bXoHwy+GX/Cuf7U/4m/8AaH2/yv8Al28rZs3/AO22c7/bpXgHwy+GX/Cxv7U/4m/9n/YPK/5dvN379/8AtrjGz3613/8AwzL/ANTd/wCU3/7bR/w01/1KP/lS/wDtVegfDL4Zf8K5/tT/AIm/9ofb/K/5dvK2bN/+22c7/bpR8Mvib/wsb+1P+JR/Z/2Dyv8Al583fv3/AOwuMbPfrR8Mvhl/wrn+1P8Aib/2h9v8r/l28rZs3/7bZzv9uleAfE34Zf8ACuf7L/4m/wDaH2/zf+XbytmzZ/ttnO/26V3/AO01/wAyt/29/wDtGuA+GXwy/wCFjf2p/wATf+z/ALB5X/Lt5u/fv/21xjZ79a9/+Jvwy/4WN/Zf/E3/ALP+web/AMu3m79+z/bXGNnv1rwD4m/DL/hXP9l/8Tf+0Pt/m/8ALt5WzZs/22znf7dK9/8Aib8Tf+Fc/wBl/wDEo/tD7f5v/Lz5WzZs/wBhs53+3SvP/wBpr/mVv+3v/wBo0f8AJuf/AFMP9u/9unkeR/383bvO9sbe+eD9mX/maf8At0/9rV4BXoHwy+Jv/Cuf7U/4lH9ofb/K/wCXnytmzf8A7DZzv9uld/8A8m5/9TD/AG7/ANunkeR/383bvO9sbe+eOA+GXxN/4Vz/AGp/xKP7Q+3+V/y8+Vs2b/8AYbOd/t0rv/8Ak3P/AKmH+3f+3TyPI/7+bt3ne2NvfPHoHxN+GX/Cxv7L/wCJv/Z/2Dzf+Xbzd+/Z/trjGz3614B8Mvib/wAK5/tT/iUf2h9v8r/l58rZs3/7DZzv9ule/wDxN+Jv/Cuf7L/4lH9ofb/N/wCXnytmzZ/sNnO/26UfE34m/wDCuf7L/wCJR/aH2/zf+XnytmzZ/sNnO/26V5/+zL/zNP8A26f+1q+gKKKK+f8A/k3P/qYf7d/7dPI8j/v5u3ed7Y2988H/ACbn/wBTD/bv/bp5Hkf9/N27zvbG3vnjgPib8Mv+Fc/2X/xN/wC0Pt/m/wDLt5WzZs/22znf7dK9/wDhl8Mv+Fc/2p/xN/7Q+3+V/wAu3lbNm/8A22znf7dKPib8Mv8AhY39l/8AE3/s/wCweb/y7ebv37P9tcY2e/WvAPib8Mv+Fc/2X/xN/wC0Pt/m/wDLt5WzZs/22znf7dK8/r3/APaa/wCZW/7e/wD2jXAfDL4m/wDCuf7U/wCJR/aH2/yv+Xnytmzf/sNnO/26V7/8Mvhl/wAK5/tT/ib/ANofb/K/5dvK2bN/+22c7/bpXn//AA01/wBSj/5Uv/tVegfE34m/8K5/sv8A4lH9ofb/ADf+XnytmzZ/sNnO/wBulHxN+Jv/AArn+y/+JR/aH2/zf+XnytmzZ/sNnO/26V5/+01/zK3/AG9/+0aP2Zf+Zp/7dP8A2tR+zL/zNP8A26f+1qP+TjP+pe/sL/t78/z/APv3t2+T753dsc+AV7/+zL/zNP8A26f+1q9A+GXwy/4Vz/an/E3/ALQ+3+V/y7eVs2b/APbbOd/t0rwD4ZfDL/hY39qf8Tf+z/sHlf8ALt5u/fv/ANtcY2e/Wvf/AIm/E3/hXP8AZf8AxKP7Q+3+b/y8+Vs2bP8AYbOd/t0rwD4m/DL/AIVz/Zf/ABN/7Q+3+b/y7eVs2bP9ts53+3Su/wD2mv8AmVv+3v8A9o1wHwy+Jv8Awrn+1P8AiUf2h9v8r/l58rZs3/7DZzv9ulHxN+GX/Cuf7L/4m/8AaH2/zf8Al28rZs2f7bZzv9ule/8Awy+GX/Cuf7U/4m/9ofb/ACv+Xbytmzf/ALbZzv8AbpXoFFFFfIHwy+GX/Cxv7U/4m/8AZ/2Dyv8Al283fv3/AO2uMbPfrXf/APDMv/U3f+U3/wC20f8AJxn/AFL39hf9vfn+f/3727fJ987u2OfQPhl8Mv8AhXP9qf8AE3/tD7f5X/Lt5WzZv/22znf7dK8//wCGmv8AqUf/ACpf/aq8Ar3/AP4aa/6lH/ypf/aq9A+GXwy/4Vz/AGp/xN/7Q+3+V/y7eVs2b/8AbbOd/t0rwD4m/DL/AIVz/Zf/ABN/7Q+3+b/y7eVs2bP9ts53+3Svf/ib8Mv+Fjf2X/xN/wCz/sHm/wDLt5u/fs/21xjZ79a8/wD+TjP+pe/sL/t78/z/APv3t2+T753dsc+gfDL4m/8ACxv7U/4lH9n/AGDyv+Xnzd+/f/sLjGz360fDL4Zf8K5/tT/ib/2h9v8AK/5dvK2bN/8AttnO/wBulef/APJxn/Uvf2F/29+f5/8A3727fJ987u2OT/hpr/qUf/Kl/wDaqP2mv+ZW/wC3v/2jR+zL/wAzT/26f+1q8Ar3/wD4Zl/6m7/ym/8A22vQPhl8Tf8AhY39qf8AEo/s/wCweV/y8+bv37/9hcY2e/Wj4m/E3/hXP9l/8Sj+0Pt/m/8ALz5WzZs/2Gznf7dKPib8Mv8AhY39l/8AE3/s/wCweb/y7ebv37P9tcY2e/Wj4ZfE3/hY39qf8Sj+z/sHlf8ALz5u/fv/ANhcY2e/Wj4ZfDL/AIVz/an/ABN/7Q+3+V/y7eVs2b/9ts53+3SvQK+f/wDk4z/qXv7C/wC3vz/P/wC/e3b5Pvnd2xz9AUUUUV5/8Mvhl/wrn+1P+Jv/AGh9v8r/AJdvK2bN/wDttnO/26V5/wD8m5/9TD/bv/bp5Hkf9/N27zvbG3vnjwCvQPib8Mv+Fc/2X/xN/wC0Pt/m/wDLt5WzZs/22znf7dK7/wD5Nz/6mH+3f+3TyPI/7+bt3ne2NvfPHAfDL4m/8K5/tT/iUf2h9v8AK/5efK2bN/8AsNnO/wBulHwy+GX/AAsb+1P+Jv8A2f8AYPK/5dvN379/+2uMbPfrXf8A7TX/ADK3/b3/AO0a4D4m/DL/AIVz/Zf/ABN/7Q+3+b/y7eVs2bP9ts53+3Sj4ZfDL/hY39qf8Tf+z/sHlf8ALt5u/fv/ANtcY2e/Wu//AGmv+ZW/7e//AGjXoHxN+GX/AAsb+y/+Jv8A2f8AYPN/5dvN379n+2uMbPfrXoFfIHwy+Jv/AArn+1P+JR/aH2/yv+Xnytmzf/sNnO/26UfDL4Zf8LG/tT/ib/2f9g8r/l283fv3/wC2uMbPfrXf/wDDTX/Uo/8AlS/+1Ufsy/8AM0/9un/tavAK9A+GXwy/4WN/an/E3/s/7B5X/Lt5u/fv/wBtcY2e/Wu//wCGmv8AqUf/ACpf/aq4D4ZfE3/hXP8Aan/Eo/tD7f5X/Lz5WzZv/wBhs53+3Su//wCTjP8AqXv7C/7e/P8AP/797dvk++d3bHPoHxN+Jv8Awrn+y/8AiUf2h9v83/l58rZs2f7DZzv9ulHxN+Jv/Cuf7L/4lH9ofb/N/wCXnytmzZ/sNnO/26UfDL4m/wDCxv7U/wCJR/Z/2Dyv+Xnzd+/f/sLjGz360fE34m/8K5/sv/iUf2h9v83/AJefK2bNn+w2c7/bpR8Mvib/AMLG/tT/AIlH9n/YPK/5efN379/+wuMbPfrXoFFFFfIHwy+Jv/Cuf7U/4lH9ofb/ACv+Xnytmzf/ALDZzv8AbpX1/XwBXoHxN+GX/Cuf7L/4m/8AaH2/zf8Al28rZs2f7bZzv9ule/8Awy+Jv/Cxv7U/4lH9n/YPK/5efN379/8AsLjGz360fE34m/8ACuf7L/4lH9ofb/N/5efK2bNn+w2c7/bpR8Mvhl/wrn+1P+Jv/aH2/wAr/l28rZs3/wC22c7/AG6V5/8Asy/8zT/26f8AtauA+JvxN/4WN/Zf/Eo/s/7B5v8Ay8+bv37P9hcY2e/Wvf8A4m/E3/hXP9l/8Sj+0Pt/m/8ALz5WzZs/2Gznf7dK8A+JvxN/4WN/Zf8AxKP7P+web/y8+bv37P8AYXGNnv1r3/4m/E3/AIVz/Zf/ABKP7Q+3+b/y8+Vs2bP9hs53+3SvP/8Ak3P/AKmH+3f+3TyPI/7+bt3ne2NvfPB/w01/1KP/AJUv/tVegfE34m/8K5/sv/iUf2h9v83/AJefK2bNn+w2c7/bpXn/AO01/wAyt/29/wDtGj/hpr/qUf8Aypf/AGqvoCvkD4ZfE3/hXP8Aan/Eo/tD7f5X/Lz5WzZv/wBhs53+3Svf/ib8Tf8AhXP9l/8AEo/tD7f5v/Lz5WzZs/2Gznf7dK8//wCGZf8Aqbv/ACm//baP2mv+ZW/7e/8A2jR/ybn/ANTD/bv/AG6eR5H/AH83bvO9sbe+ePQPib8Tf+Fc/wBl/wDEo/tD7f5v/Lz5WzZs/wBhs53+3SvAPhl8Tf8AhXP9qf8AEo/tD7f5X/Lz5WzZv/2Gznf7dK9/+GXxN/4WN/an/Eo/s/7B5X/Lz5u/fv8A9hcY2e/Wj4ZfE3/hY39qf8Sj+z/sHlf8vPm79+//AGFxjZ79a9Aoooor5/8A2Zf+Zp/7dP8A2tR/wzL/ANTd/wCU3/7bR/ybn/1MP9u/9unkeR/383bvO9sbe+ePQPib8Tf+Fc/2X/xKP7Q+3+b/AMvPlbNmz/YbOd/t0o+JvxN/4Vz/AGX/AMSj+0Pt/m/8vPlbNmz/AGGznf7dK8A+Jvwy/wCFc/2X/wATf+0Pt/m/8u3lbNmz/bbOd/t0r3/4m/DL/hY39l/8Tf8As/7B5v8Ay7ebv37P9tcY2e/Wj4m/E3/hXP8AZf8AxKP7Q+3+b/y8+Vs2bP8AYbOd/t0r5Ar0D4ZfE3/hXP8Aan/Eo/tD7f5X/Lz5WzZv/wBhs53+3Su//wCGmv8AqUf/ACpf/aq4D4ZfE3/hXP8Aan/Eo/tD7f5X/Lz5WzZv/wBhs53+3Su//aa/5lb/ALe//aNcB8Mvhl/wsb+1P+Jv/Z/2Dyv+Xbzd+/f/ALa4xs9+tHxN+Jv/AAsb+y/+JR/Z/wBg83/l583fv2f7C4xs9+te/wDwy+GX/Cuf7U/4m/8AaH2/yv8Al28rZs3/AO22c7/bpXgHwy+GX/Cxv7U/4m/9n/YPK/5dvN379/8AtrjGz360fE34Zf8ACuf7L/4m/wDaH2/zf+XbytmzZ/ttnO/26V5/Xv8A+01/zK3/AG9/+0a4D4ZfDL/hY39qf8Tf+z/sHlf8u3m79+//AG1xjZ79a9/+GXxN/wCFjf2p/wASj+z/ALB5X/Lz5u/fv/2FxjZ79aPhl8Mv+Fc/2p/xN/7Q+3+V/wAu3lbNm/8A22znf7dK+QK9/wD2Zf8Amaf+3T/2tX0BRRRRXyB8Tfhl/wAK5/sv/ib/ANofb/N/5dvK2bNn+22c7/bpXf8A/DTX/Uo/+VL/AO1VwHwy+GX/AAsb+1P+Jv8A2f8AYPK/5dvN379/+2uMbPfrXf8A/DMv/U3f+U3/AO21wHwy+Jv/AArn+1P+JR/aH2/yv+Xnytmzf/sNnO/26UfDL4m/8K5/tT/iUf2h9v8AK/5efK2bN/8AsNnO/wBule//ABN+Jv8Awrn+y/8AiUf2h9v83/l58rZs2f7DZzv9uleAfE34m/8ACxv7L/4lH9n/AGDzf+Xnzd+/Z/sLjGz3615/XoHxN+Jv/Cxv7L/4lH9n/YPN/wCXnzd+/Z/sLjGz3613/wC01/zK3/b3/wC0a9A+GXwy/wCFc/2p/wATf+0Pt/lf8u3lbNm//bbOd/t0rwD4ZfDL/hY39qf8Tf8As/7B5X/Lt5u/fv8A9tcY2e/Wu/8A+GZf+pu/8pv/ANtrgPhl8Mv+Fjf2p/xN/wCz/sHlf8u3m79+/wD21xjZ79a8/r0D4ZfDL/hY39qf8Tf+z/sHlf8ALt5u/fv/ANtcY2e/Wj4m/E3/AIWN/Zf/ABKP7P8AsHm/8vPm79+z/YXGNnv1rv8A/hpr/qUf/Kl/9qr0D4m/DL/hY39l/wDE3/s/7B5v/Lt5u/fs/wBtcY2e/WvP/wBmX/maf+3T/wBrV6B8Mvib/wALG/tT/iUf2f8AYPK/5efN379/+wuMbPfrXgHwy+GX/Cxv7U/4m/8AZ/2Dyv8Al283fv3/AO2uMbPfrXf/APDMv/U3f+U3/wC20fsy/wDM0/8Abp/7WrgPib8Mv+Fc/wBl/wDE3/tD7f5v/Lt5WzZs/wBts53+3Svf/hl8Mv8AhXP9qf8AE3/tD7f5X/Lt5WzZv/22znf7dK9Aooorz/4m/DL/AIWN/Zf/ABN/7P8AsHm/8u3m79+z/bXGNnv1rwD4ZfE3/hXP9qf8Sj+0Pt/lf8vPlbNm/wD2Gznf7dK7/wDZl/5mn/t0/wDa1egfDL4Zf8K5/tT/AIm/9ofb/K/5dvK2bN/+22c7/bpXgHwy+GX/AAsb+1P+Jv8A2f8AYPK/5dvN379/+2uMbPfrR8Tfhl/wrn+y/wDib/2h9v8AN/5dvK2bNn+22c7/AG6V3/7TX/Mrf9vf/tGuA+GXxN/4Vz/an/Eo/tD7f5X/AC8+Vs2b/wDYbOd/t0o+Jvwy/wCFc/2X/wATf+0Pt/m/8u3lbNmz/bbOd/t0r6/rz/4ZfDL/AIVz/an/ABN/7Q+3+V/y7eVs2b/9ts53+3Sj4ZfDL/hXP9qf8Tf+0Pt/lf8ALt5WzZv/ANts53+3SvP/ANmX/maf+3T/ANrV6B8Mvhl/wrn+1P8Aib/2h9v8r/l28rZs3/7bZzv9uleAfDL4m/8ACuf7U/4lH9ofb/K/5efK2bN/+w2c7/bpX1/RRXyB8Tfib/wsb+y/+JR/Z/2Dzf8Al583fv2f7C4xs9+td/8A8m5/9TD/AG7/ANunkeR/383bvO9sbe+ePAK+v/ib8Tf+Fc/2X/xKP7Q+3+b/AMvPlbNmz/YbOd/t0rz/APZl/wCZp/7dP/a1egfDL4Zf8K5/tT/ib/2h9v8AK/5dvK2bN/8AttnO/wBuleAfDL4m/wDCuf7U/wCJR/aH2/yv+Xnytmzf/sNnO/26V7/8Tfhl/wALG/sv/ib/ANn/AGDzf+Xbzd+/Z/trjGz3615/+zL/AMzT/wBun/tavoCiiivP/ib8Tf8AhXP9l/8AEo/tD7f5v/Lz5WzZs/2Gznf7dK8//wCTc/8AqYf7d/7dPI8j/v5u3ed7Y2988H/DMv8A1N3/AJTf/ttH/DMv/U3f+U3/AO214BXv/wDwzL/1N3/lN/8AttH/AA01/wBSj/5Uv/tVH/DMv/U3f+U3/wC214BXoHwy+GX/AAsb+1P+Jv8A2f8AYPK/5dvN379/+2uMbPfrXf8A7Mv/ADNP/bp/7Wr0D4ZfE3/hY39qf8Sj+z/sHlf8vPm79+//AGFxjZ79a8//AOGZf+pu/wDKb/8Aba4D4ZfDL/hY39qf8Tf+z/sHlf8ALt5u/fv/ANtcY2e/Wj4ZfDL/AIWN/an/ABN/7P8AsHlf8u3m79+//bXGNnv1r3/4m/DL/hY39l/8Tf8As/7B5v8Ay7ebv37P9tcY2e/WvP8A9mX/AJmn/t0/9rV9AV8//wDDMv8A1N3/AJTf/ttH/Jxn/Uvf2F/29+f5/wD3727fJ987u2OfQPib8Mv+Fjf2X/xN/wCz/sHm/wDLt5u/fs/21xjZ79a9Ar5A+Jvwy/4Vz/Zf/E3/ALQ+3+b/AMu3lbNmz/bbOd/t0o+Jvwy/4Vz/AGX/AMTf+0Pt/m/8u3lbNmz/AG2znf7dK9/+GXwy/wCFc/2p/wATf+0Pt/lf8u3lbNm//bbOd/t0rz//AJOM/wCpe/sL/t78/wA//v3t2+T753dscn7Mv/M0/wDbp/7Wr6Aooorz/wCGXwy/4Vz/AGp/xN/7Q+3+V/y7eVs2b/8AbbOd/t0rz/8A4Zl/6m7/AMpv/wBto/Zl/wCZp/7dP/a1H/Juf/Uw/wBu/wDbp5Hkf9/N27zvbG3vng/Zl/5mn/t0/wDa1H/Juf8A1MP9u/8Abp5Hkf8Afzdu872xt7544D4ZfDL/AIWN/an/ABN/7P8AsHlf8u3m79+//bXGNnv1o+GXwy/4WN/an/E3/s/7B5X/AC7ebv37/wDbXGNnv1o+JvxN/wCFjf2X/wASj+z/ALB5v/Lz5u/fs/2FxjZ79aPhl8Mv+Fjf2p/xN/7P+weV/wAu3m79+/8A21xjZ79a7/8A5OM/6l7+wv8At78/z/8Av3t2+T753dsc8B8Mvib/AMK5/tT/AIlH9ofb/K/5efK2bN/+w2c7/bpXv/xN+GX/AAsb+y/+Jv8A2f8AYPN/5dvN379n+2uMbPfrXn//AA01/wBSj/5Uv/tVegfDL4m/8LG/tT/iUf2f9g8r/l583fv3/wCwuMbPfrXn/wCzL/zNP/bp/wC1q4D4ZfE3/hXP9qf8Sj+0Pt/lf8vPlbNm/wD2Gznf7dKPib8Mv+Fc/wBl/wDE3/tD7f5v/Lt5WzZs/wBts53+3Su//Zl/5mn/ALdP/a1fQFef/E34Zf8ACxv7L/4m/wDZ/wBg83/l283fv2f7a4xs9+tef/8ADTX/AFKP/lS/+1VwHxN+GX/Cuf7L/wCJv/aH2/zf+XbytmzZ/ttnO/26V5/Xv/8AwzL/ANTd/wCU3/7bR/ybn/1MP9u/9unkeR/383bvO9sbe+eD9mX/AJmn/t0/9rV9AUUUV8AUV7//AMnGf9S9/YX/AG9+f5//AH727fJ987u2OfQPhl8Mv+Fc/wBqf8Tf+0Pt/lf8u3lbNm//AG2znf7dK8A+Jvwy/wCFc/2X/wATf+0Pt/m/8u3lbNmz/bbOd/t0rv8A9pr/AJlb/t7/APaNH/DMv/U3f+U3/wC20f8ADMv/AFN3/lN/+216B8Mvhl/wrn+1P+Jv/aH2/wAr/l28rZs3/wC22c7/AG6V5/8A8nGf9S9/YX/b35/n/wDfvbt8n3zu7Y59A+Jvwy/4WN/Zf/E3/s/7B5v/AC7ebv37P9tcY2e/WvQK+QPib8Tf+Fjf2X/xKP7P+web/wAvPm79+z/YXGNnv1o+Jvwy/wCFc/2X/wATf+0Pt/m/8u3lbNmz/bbOd/t0r3/4m/DL/hY39l/8Tf8As/7B5v8Ay7ebv37P9tcY2e/Wj4ZfE3/hY39qf8Sj+z/sHlf8vPm79+//AGFxjZ79a8//AOTjP+pe/sL/ALe/P8//AL97dvk++d3bHPoHxN+Jv/Cuf7L/AOJR/aH2/wA3/l58rZs2f7DZzv8AbpR8Mvhl/wAK5/tT/ib/ANofb/K/5dvK2bN/+22c7/bpXgHxN+GX/Cuf7L/4m/8AaH2/zf8Al28rZs2f7bZzv9uld/8A8My/9Td/5Tf/ALbXoHxN+Jv/AArn+y/+JR/aH2/zf+XnytmzZ/sNnO/26V5/+zL/AMzT/wBun/taj/k3P/qYf7d/7dPI8j/v5u3ed7Y2988fQFfP/wDybn/1MP8Abv8A26eR5H/fzdu872xt754+gKKKKK+AK+v/AIZfE3/hY39qf8Sj+z/sHlf8vPm79+//AGFxjZ79aPhl8Tf+Fjf2p/xKP7P+weV/y8+bv37/APYXGNnv1rwD4m/DL/hXP9l/8Tf+0Pt/m/8ALt5WzZs/22znf7dK9/8Ahl8Mv+Fc/wBqf8Tf+0Pt/lf8u3lbNm//AG2znf7dK8//AOGZf+pu/wDKb/8Aba8Ar6/+Jvwy/wCFjf2X/wATf+z/ALB5v/Lt5u/fs/21xjZ79aPib8Mv+Fjf2X/xN/7P+web/wAu3m79+z/bXGNnv1rz/wD4Zl/6m7/ym/8A22j/AJNz/wCph/t3/t08jyP+/m7d53tjb3zx6B8Mvhl/wrn+1P8Aib/2h9v8r/l28rZs3/7bZzv9ulHwy+GX/Cuf7U/4m/8AaH2/yv8Al28rZs3/AO22c7/bpXgHwy+Jv/Cuf7U/4lH9ofb/ACv+Xnytmzf/ALDZzv8AbpXv/wAMvib/AMLG/tT/AIlH9n/YPK/5efN379/+wuMbPfrXgHxN+GX/AArn+y/+Jv8A2h9v83/l28rZs2f7bZzv9uld/wD8NNf9Sj/5Uv8A7VX0BXyB8Mvhl/wsb+1P+Jv/AGf9g8r/AJdvN379/wDtrjGz3619f18//wDDTX/Uo/8AlS/+1V6B8Tfhl/wsb+y/+Jv/AGf9g83/AJdvN379n+2uMbPfrR8Mvib/AMLG/tT/AIlH9n/YPK/5efN379/+wuMbPfrR8Mvib/wsb+1P+JR/Z/2Dyv8Al583fv3/AOwuMbPfrR8Tfhl/wsb+y/8Aib/2f9g83/l283fv2f7a4xs9+tef/sy/8zT/ANun/taj9mX/AJmn/t0/9rV9AUUUV8//ALTX/Mrf9vf/ALRo/wCGZf8Aqbv/ACm//ba+gK+f/wDk3P8A6mH+3f8At08jyP8Av5u3ed7Y2988eAUV7/8A8NNf9Sj/AOVL/wC1Uf8AJuf/AFMP9u/9unkeR/383bvO9sbe+ePQPib8Mv8AhY39l/8AE3/s/wCweb/y7ebv37P9tcY2e/WvP/8Ak4z/AKl7+wv+3vz/AD/+/e3b5Pvnd2xzwHwy+Jv/AArn+1P+JR/aH2/yv+Xnytmzf/sNnO/26UfDL4Zf8LG/tT/ib/2f9g8r/l283fv3/wC2uMbPfrXv/wATfib/AMK5/sv/AIlH9ofb/N/5efK2bNn+w2c7/bpXn/7Mv/M0/wDbp/7Wr0D4ZfDL/hXP9qf8Tf8AtD7f5X/Lt5WzZv8A9ts53+3Sj4ZfDL/hXP8Aan/E3/tD7f5X/Lt5WzZv/wBts53+3SvAPib8Mv8AhXP9l/8AE3/tD7f5v/Lt5WzZs/22znf7dKPhl8Mv+Fjf2p/xN/7P+weV/wAu3m79+/8A21xjZ79a7/8AZl/5mn/t0/8Aa1cB8Mvib/wrn+1P+JR/aH2/yv8Al58rZs3/AOw2c7/bpR8Mvib/AMK5/tT/AIlH9ofb/K/5efK2bN/+w2c7/bpXf/8AJuf/AFMP9u/9unkeR/383bvO9sbe+eOA+Jvwy/4Vz/Zf/E3/ALQ+3+b/AMu3lbNmz/bbOd/t0o+GXxN/4Vz/AGp/xKP7Q+3+V/y8+Vs2b/8AYbOd/t0rv/8Ak3P/AKmH+3f+3TyPI/7+bt3ne2NvfPB/w01/1KP/AJUv/tVegfDL4m/8LG/tT/iUf2f9g8r/AJefN379/wDsLjGz3616BRRRRXyB8Tfhl/wrn+y/+Jv/AGh9v83/AJdvK2bNn+22c7/bpR8Mvib/AMK5/tT/AIlH9ofb/K/5efK2bN/+w2c7/bpXv/wy+GX/AArn+1P+Jv8A2h9v8r/l28rZs3/7bZzv9ulHxN+GX/Cxv7L/AOJv/Z/2Dzf+Xbzd+/Z/trjGz3615/8A8My/9Td/5Tf/ALbXoHxN+Jv/AArn+y/+JR/aH2/zf+XnytmzZ/sNnO/26V4B8Mvhl/wsb+1P+Jv/AGf9g8r/AJdvN379/wDtrjGz3617/wDDL4m/8LG/tT/iUf2f9g8r/l583fv3/wCwuMbPfrXgHxN+Jv8Awsb+y/8AiUf2f9g83/l583fv2f7C4xs9+te//DL4m/8ACxv7U/4lH9n/AGDyv+Xnzd+/f/sLjGz3614B8Tfhl/wrn+y/+Jv/AGh9v83/AJdvK2bNn+22c7/bpXv/AMTfhl/wsb+y/wDib/2f9g83/l283fv2f7a4xs9+tegV5/8AE34Zf8LG/sv/AIm/9n/YPN/5dvN379n+2uMbPfrR8Tfib/wrn+y/+JR/aH2/zf8Al58rZs2f7DZzv9ulef8A/Jxn/Uvf2F/29+f5/wD3727fJ987u2OfAK9A+GXxN/4Vz/an/Eo/tD7f5X/Lz5WzZv8A9hs53+3Svf8A4m/E3/hXP9l/8Sj+0Pt/m/8ALz5WzZs/2Gznf7dKPhl8Mv8AhXP9qf8AE3/tD7f5X/Lt5WzZv/22znf7dK9Ar5A+JvxN/wCFjf2X/wASj+z/ALB5v/Lz5u/fs/2FxjZ79aPhl8Mv+Fjf2p/xN/7P+weV/wAu3m79+/8A21xjZ79a9/8Aib8Tf+Fc/wBl/wDEo/tD7f5v/Lz5WzZs/wBhs53+3SvQK8/+GXwy/wCFc/2p/wATf+0Pt/lf8u3lbNm//bbOd/t0r0CiiivkD4ZfE3/hXP8Aan/Eo/tD7f5X/Lz5WzZv/wBhs53+3Su//wCGZf8Aqbv/ACm//ba+gK8/+GXwy/4Vz/an/E3/ALQ+3+V/y7eVs2b/APbbOd/t0rz/AP4Zl/6m7/ym/wD22vQPib8Tf+Fc/wBl/wDEo/tD7f5v/Lz5WzZs/wBhs53+3SvQK8/+Jvwy/wCFjf2X/wATf+z/ALB5v/Lt5u/fs/21xjZ79a8//Zl/5mn/ALdP/a1cB8Tfib/wsb+y/wDiUf2f9g83/l583fv2f7C4xs9+te//AAy+GX/Cuf7U/wCJv/aH2/yv+Xbytmzf/ttnO/26UfE34m/8K5/sv/iUf2h9v83/AJefK2bNn+w2c7/bpR8Tfhl/wsb+y/8Aib/2f9g83/l283fv2f7a4xs9+tef/wDJuf8A1MP9u/8Abp5Hkf8Afzdu872xt754P+TjP+pe/sL/ALe/P8//AL97dvk++d3bHPoHwy+GX/Cuf7U/4m/9ofb/ACv+Xbytmzf/ALbZzv8AbpR8Mvhl/wAK5/tT/ib/ANofb/K/5dvK2bN/+22c7/bpXn//AAzL/wBTd/5Tf/tteAUV9f8AxN+Jv/Cuf7L/AOJR/aH2/wA3/l58rZs2f7DZzv8AbpXgHxN+Jv8Awsb+y/8AiUf2f9g83/l583fv2f7C4xs9+tfX9FfIHwy+Jv8Awrn+1P8AiUf2h9v8r/l58rZs3/7DZzv9ulHwy+Jv/Cuf7U/4lH9ofb/K/wCXnytmzf8A7DZzv9ule/8Awy+Jv/Cxv7U/4lH9n/YPK/5efN379/8AsLjGz3616BRRRXyB8Tfhl/wrn+y/+Jv/AGh9v83/AJdvK2bNn+22c7/bpXf/APJxn/Uvf2F/29+f5/8A3727fJ987u2OT/hmX/qbv/Kb/wDbaP8Ak3P/AKmH+3f+3TyPI/7+bt3ne2NvfPB/wzL/ANTd/wCU3/7bR+01/wAyt/29/wDtGj9mX/maf+3T/wBrV6B8Mvhl/wAK5/tT/ib/ANofb/K/5dvK2bN/+22c7/bpXn//AAzL/wBTd/5Tf/ttH/Juf/Uw/wBu/wDbp5Hkf9/N27zvbG3vnjgPhl8Mv+Fjf2p/xN/7P+weV/y7ebv37/8AbXGNnv1r3/4ZfDL/AIVz/an/ABN/7Q+3+V/y7eVs2b/9ts53+3SvP/2Zf+Zp/wC3T/2tXoHxN+GX/Cxv7L/4m/8AZ/2Dzf8Al283fv2f7a4xs9+tef8A/Jxn/Uvf2F/29+f5/wD3727fJ987u2OfQPib8Mv+Fjf2X/xN/wCz/sHm/wDLt5u/fs/21xjZ79a8/wD+Gmv+pR/8qX/2quA+JvxN/wCFjf2X/wASj+z/ALB5v/Lz5u/fs/2FxjZ79a9/+Jvwy/4WN/Zf/E3/ALP+web/AMu3m79+z/bXGNnv1rwD4m/DL/hXP9l/8Tf+0Pt/m/8ALt5WzZs/22znf7dKPib8Mv8AhXP9l/8AE3/tD7f5v/Lt5WzZs/22znf7dK9/+JvxN/4Vz/Zf/Eo/tD7f5v8Ay8+Vs2bP9hs53+3SvP8A9pr/AJlb/t7/APaNH/Juf/Uw/wBu/wDbp5Hkf9/N27zvbG3vng/Zl/5mn/t0/wDa1eAV7/8Asy/8zT/26f8AtavoCiiiivP/AIm/DL/hY39l/wDE3/s/7B5v/Lt5u/fs/wBtcY2e/WvQK8/+GXwy/wCFc/2p/wATf+0Pt/lf8u3lbNm//bbOd/t0o+GXxN/4WN/an/Eo/s/7B5X/AC8+bv37/wDYXGNnv1o+Jvwy/wCFjf2X/wATf+z/ALB5v/Lt5u/fs/21xjZ79a8//aa/5lb/ALe//aNH/Jxn/Uvf2F/29+f5/wD3727fJ987u2OfAK9//wCTjP8AqXv7C/7e/P8AP/797dvk++d3bHJ/w01/1KP/AJUv/tVH/DMv/U3f+U3/AO21wHwy+GX/AAsb+1P+Jv8A2f8AYPK/5dvN379/+2uMbPfrXf8A/DMv/U3f+U3/AO214BXv/wC01/zK3/b3/wC0aP8Ak4z/AKl7+wv+3vz/AD/+/e3b5Pvnd2xyftNf8yt/29/+0a4D4ZfE3/hXP9qf8Sj+0Pt/lf8ALz5WzZv/ANhs53+3Svf/AIZfDL/hXP8Aan/E3/tD7f5X/Lt5WzZv/wBts53+3SvAPhl8Mv8AhY39qf8AE3/s/wCweV/y7ebv37/9tcY2e/Wu/wD+Tc/+ph/t3/t08jyP+/m7d53tjb3zxwHwy+GX/Cxv7U/4m/8AZ/2Dyv8Al283fv3/AO2uMbPfrXf/APDMv/U3f+U3/wC21wHwy+Jv/Cuf7U/4lH9ofb/K/wCXnytmzf8A7DZzv9ule/8AxN+Jv/Cuf7L/AOJR/aH2/wA3/l58rZs2f7DZzv8AbpR8Mvib/wALG/tT/iUf2f8AYPK/5efN379/+wuMbPfrXoFFFFfIHwy+GX/Cxv7U/wCJv/Z/2Dyv+Xbzd+/f/trjGz3613//AAzL/wBTd/5Tf/ttH/DMv/U3f+U3/wC20fsy/wDM0/8Abp/7Wo/5OM/6l7+wv+3vz/P/AO/e3b5Pvnd2xyf8NNf9Sj/5Uv8A7VXAfDL4m/8ACuf7U/4lH9ofb/K/5efK2bN/+w2c7/bpR8Mvhl/wsb+1P+Jv/Z/2Dyv+Xbzd+/f/ALa4xs9+td//AMNNf9Sj/wCVL/7VR/ybn/1MP9u/9unkeR/383bvO9sbe+ePAK9//Zl/5mn/ALdP/a1H7Mv/ADNP/bp/7Wr0D4ZfDL/hXP8Aan/E3/tD7f5X/Lt5WzZv/wBts53+3SvAPhl8Mv8AhY39qf8AE3/s/wCweV/y7ebv37/9tcY2e/WvP69//Zl/5mn/ALdP/a1H7Mv/ADNP/bp/7Wo/aa/5lb/t7/8AaNegfDL4m/8ACxv7U/4lH9n/AGDyv+Xnzd+/f/sLjGz3615/+zL/AMzT/wBun/taj/k3P/qYf7d/7dPI8j/v5u3ed7Y2988H7Mv/ADNP/bp/7Wr0D4ZfDL/hXP8Aan/E3/tD7f5X/Lt5WzZv/wBts53+3SvkCvQPhl8Mv+Fjf2p/xN/7P+weV/y7ebv37/8AbXGNnv1r3/4ZfE3/AIWN/an/ABKP7P8AsHlf8vPm79+//YXGNnv1r0Ciiivn/wDZl/5mn/t0/wDa1eAV7/8Asy/8zT/26f8Ataj9mX/maf8At0/9rUf8nGf9S9/YX/b35/n/APfvbt8n3zu7Y59A+GXxN/4WN/an/Eo/s/7B5X/Lz5u/fv8A9hcY2e/WvP8A/hpr/qUf/Kl/9qrgPhl8Mv8AhY39qf8AE3/s/wCweV/y7ebv37/9tcY2e/WvP6+v/hl8Mv8AhXP9qf8AE3/tD7f5X/Lt5WzZv/22znf7dK8//aa/5lb/ALe//aNegfDL4m/8LG/tT/iUf2f9g8r/AJefN379/wDsLjGz3615/wD8My/9Td/5Tf8A7bR/wzL/ANTd/wCU3/7bXAfDL4Zf8LG/tT/ib/2f9g8r/l283fv3/wC2uMbPfrXv/wATfhl/wsb+y/8Aib/2f9g83/l283fv2f7a4xs9+tHwy+Jv/Cxv7U/4lH9n/YPK/wCXnzd+/f8A7C4xs9+tef8A/Juf/Uw/27/26eR5H/fzdu872xt7544D4m/DL/hXP9l/8Tf+0Pt/m/8ALt5WzZs/22znf7dK7/8A5Nz/AOph/t3/ALdPI8j/AL+bt3ne2NvfPHAfDL4m/wDCuf7U/wCJR/aH2/yv+Xnytmzf/sNnO/26V7/8Mvhl/wAK5/tT/ib/ANofb/K/5dvK2bN/+22c7/bpXgHxN+GX/Cuf7L/4m/8AaH2/zf8Al28rZs2f7bZzv9ulef0V9f8Awy+Jv/Cxv7U/4lH9n/YPK/5efN379/8AsLjGz3615/8Asy/8zT/26f8AtavoCiiivn/9mX/maf8At0/9rUf8My/9Td/5Tf8A7bXoHwy+GX/Cuf7U/wCJv/aH2/yv+Xbytmzf/ttnO/26V5/+zL/zNP8A26f+1q9A+Jvwy/4WN/Zf/E3/ALP+web/AMu3m79+z/bXGNnv1r0CvgCvr/4m/DL/AIWN/Zf/ABN/7P8AsHm/8u3m79+z/bXGNnv1o+JvxN/4Vz/Zf/Eo/tD7f5v/AC8+Vs2bP9hs53+3Sj4ZfDL/AIVz/an/ABN/7Q+3+V/y7eVs2b/9ts53+3SvP/2mv+ZW/wC3v/2jR/wzL/1N3/lN/wDttcB8Mvib/wAK5/tT/iUf2h9v8r/l58rZs3/7DZzv9ule/wDwy+GX/Cuf7U/4m/8AaH2/yv8Al28rZs3/AO22c7/bpR8Tfib/AMK5/sv/AIlH9ofb/N/5efK2bNn+w2c7/bpR8Tfhl/wsb+y/+Jv/AGf9g83/AJdvN379n+2uMbPfrXgHwy+Jv/Cuf7U/4lH9ofb/ACv+Xnytmzf/ALDZzv8AbpR8Mvhl/wALG/tT/ib/ANn/AGDyv+Xbzd+/f/trjGz3617/APDL4Zf8K5/tT/ib/wBofb/K/wCXbytmzf8A7bZzv9ulef8A/DMv/U3f+U3/AO21wHwy+Jv/AArn+1P+JR/aH2/yv+Xnytmzf/sNnO/26V3/AO01/wAyt/29/wDtGuA+GXxN/wCFc/2p/wASj+0Pt/lf8vPlbNm//YbOd/t0r3/4m/E3/hXP9l/8Sj+0Pt/m/wDLz5WzZs/2Gznf7dK8/wD2Zf8Amaf+3T/2tXAfE34Zf8K5/sv/AIm/9ofb/N/5dvK2bNn+22c7/bpXv/wy+GX/AArn+1P+Jv8A2h9v8r/l28rZs3/7bZzv9ulegUUUV8//APDMv/U3f+U3/wC20f8ADMv/AFN3/lN/+20f8My/9Td/5Tf/ALbXoHwy+GX/AArn+1P+Jv8A2h9v8r/l28rZs3/7bZzv9ulef/8ADMv/AFN3/lN/+20f8My/9Td/5Tf/ALbR/wAMy/8AU3f+U3/7bX0BXn/xN+GX/Cxv7L/4m/8AZ/2Dzf8Al283fv2f7a4xs9+tef8A/DMv/U3f+U3/AO216B8Mvhl/wrn+1P8Aib/2h9v8r/l28rZs3/7bZzv9ulHxN+GX/Cxv7L/4m/8AZ/2Dzf8Al283fv2f7a4xs9+tHwy+GX/Cuf7U/wCJv/aH2/yv+Xbytmzf/ttnO/26V6BXn/xN+GX/AAsb+y/+Jv8A2f8AYPN/5dvN379n+2uMbPfrR8Mvhl/wrn+1P+Jv/aH2/wAr/l28rZs3/wC22c7/AG6V5/8A8My/9Td/5Tf/ALbXoHwy+GX/AArn+1P+Jv8A2h9v8r/l28rZs3/7bZzv9ulef/8ADMv/AFN3/lN/+20f8My/9Td/5Tf/ALbXoHxN+GX/AAsb+y/+Jv8A2f8AYPN/5dvN379n+2uMbPfrR8Mvhl/wrn+1P+Jv/aH2/wAr/l28rZs3/wC22c7/AG6UfE34Zf8ACxv7L/4m/wDZ/wBg83/l283fv2f7a4xs9+tegV5/8Mvhl/wrn+1P+Jv/AGh9v8r/AJdvK2bN/wDttnO/26UfE34Zf8LG/sv/AIm/9n/YPN/5dvN379n+2uMbPfrXoFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFf/2Q=="
  }
}
```

STATUS 202

Response Body: Boleto pendente de registro

```json
{
  "request_control_key": "f14e9bac-94ed-4eb1-87b4-7fd7b7a2d280",
  "bank_slip_key": "e8599844-5cad-40b4-8716-cb4770d415b4",
  "bank_slip_status": "accepted"
}
```

:::info Informação
Caso seja retornado **HTTP Status 202** com o campo `bank_slip_status` com valor `accepted`, a emissão não deve ser retentada.

Esta emissão será processada assincronamente. É necessário verificar o status do boleto por meio
da consulta de boleto, ou aguardar o recebimento do webhook de confirmação descrito na [página de webhooks](/documentation/boletos/v2/webhooks/boleto).
:::

### Response Body Params

| Campo                   | Tipo   | Descrição                                                                         | Caracteres |
|-------------------------|--------|-----------------------------------------------------------------------------------|------------|
| `request_control_key` * | uuidv4 | Chave única de identificação da request utilizada pelo cliente no formato uuid v4 | 36         |
| `bank_slip_key` *       | uuidv4 | Chave única de identificação do boleto no formato uuid v4                         | 36         |
| `bank_slip_status` *    | string | Status do boleto       | **[Enumeradores bank_slip_status](#enumeradores-bank_slip_status)**   |
| `our_number` *          | integer| Número único de identificação do boleto junto à carteira                          | 11         |
| `barcode` *             | string | Código de barras do boleto                                                        | 44         |
| `digitable_line` *      | string | Linha digitável do boleto                                                         | 47         |
| `qr_code_data`          | object | Dados do QR Code                             | **[Objeto qr_code_data](#objeto-qr_code_data)** |
| `created_at` *          | string | Data, no formato ISO (UTC - "YYYY-MM-DDTHH:MM:SSZ"), da criação da ocorrência     | 20         |

### Enumeradores bank_slip_status

| Enumerador         | Descrição                               |
|--------------------|-----------------------------------------|
| accepted           | Boleto aceito mas ainda não registrado  |
| registered         | Boleto registrado                       |

### Objeto qr_code_data
| Campo                      | Tipo   | Descrição                                             | Caracteres              |
|----------------------------|--------|-------------------------------------------------------|-------------------------|
| `qr_code_key`              | uuidv4 | Chave única de identificação do QR Code               | 36                      |
| `pix_key`                  | uuidv4 | Chave PIX vinculada ao QR Code                        | 36                      |
| `receiver_conciliation_id` | uuidv4 | Identificador de conciliação do QR Code               | 36                      |
| `url`                      | string | URL (Pix Copia e Cola) do QR Code                     | -                       |
| `image`                    | string | base64 da URL (Pix Copia e Cola) do QR Code           | -                       |

## Error Response

STATUS 4xx

Response Body: Error

```json
{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}
```

| Código HTTP<br/>`status` | Código QI<br/>`code` | Título<br/>`title`                                 | Descrição (eng)<br/>`description`                                                                                       | Descrição (pt-br)<br/>`translation`                                                                                     |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 400                      | QIT000001            | Bad Request                                        | Schema Error                                                                                                            | Schema Inválido                                                                                                         |
| 404                      | BKS000004            | Not Found | Pix key not found: `{pix_key}`                                               | Chave pix não encontrada: `{pix_key}`                                               |
| 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.                                                                 |
| 403                      | BKS000010            | Forbidden                                 | The pix key owner does not match the account owner.                                                                                     | O proprietário da chave pix não corresponde ao proprietário da conta.                                                             |
| 404                      | BKS000013            | Not Found | Requester profile not found         |               Carteira não encontrada                                                                 |
| 409                      | BKS000014            | Conflict           | Request control key already sent or duplicated sent: `{request_control_key}`                                                              | Chave de controle da requisição já utilizada ou enviada duplicada: `{request_control_key}`                                                                        |
| 400                      | BKS000016            | Bad Request                                        | Expiration date must be greater than the current date and have a maximum of 3650 days from the current date.                                    | A data de vencimento deve ser maior que a data atual e possuir no máximo 3650 dias corridos a partir da data atual.                                     |
| 409                      | BKS000017            | Conflict                                        | Our number already used or duplicated sent: `{our_number}`                                                                                       | Nosso número já utilizado ou enviado duplicado: `{our_number}`                                                                               |
| 400                      | BKS000018            | Bad Request                                        | The discount dates must be less than the expiration date and increasing.                                                      | A data dos descontos devem ser menores que a de expiração e crescentes.                                               |
| 400                      | BKS000019            | Bad Request                                        | Payer address is required for protest.                                                                                       | Endereço do pagador é obrigatório para protesto.                                                                         |
| 500                      | BKS000021            | Internal Server Error                                  | Error while trying to generate QR Code.                                                               | Erro ao tentar gerar QR Code de pagamento.                                                           |
| 400                      | BKS000022            | Bad Request                                        | Requester profile is not opened.                                                              | Carteira não está aberta.                          |
| 400                      | BKS000023            | Bad Request             | The amount must be greater than zero.          | O valor deve ser maior que zero.                                                           |
| 400                      | BKS000024            | Bad Request             | Error while registering bank slip.          | Erro ao registrar boleto.                                                           |
| 400                      | BKS000026            | Bad Request                      | Guarantor address is required for protest.                                                                                        | Endereço do sacador é obrigatório para protesto.                                                                   |
| 404                      | BKS000028            | Not Found             | Notary office attended region not found for postal code: `{postal_code}`                                                          | Região de cartório não encontrada para o CEP: `{postal_code}`                                                                                 |
| 400                      | BKS000043            | Bad Request             | Invalid discount numbering. Discounts must be numbered in ascending order and start on 1.          | Numeração dos descontos inválida. Os descontos devem ser numerados em ordem crescente e começar em 1.                                                           |
| 400                      | BKS000045            | Bad Request                                        | Rebate amount can not be equal or greater than the bank slip amount.                                                              | O valor do rebate não pode ser igual ou maior do que o valor do boleto.                          |
| 400                      | BKS000047            | Bad Request             | It was not possible to consult the sent pix key at this time. Please try again in a few minutes.          | Não foi possível consultar a chave pix enviada no momento. Por favor, tente novamente em alguns minutos.                                                           |
| 400                      | BKS000125            | Bad Request             | Partial payment data is required for this bank slip species type.          | Os dados de pagamento parcial são obrigatórios para o tipo de boleto fornecido.                                                           |
| 400                      | BKS000128            | Bad Request             | QR code payment is not allowed for partial payment.          | Pagamento via QR code não é permitido para pagamento parcial.                                                           |
| 400                      | BKS000128            | Bad Request             | QR code payment is not allowed for partial payment.          | Pagamento via QR code não é permitido para pagamento parcial.                                                           |
| 400                      | BKS000131            | Bad Request             | Rebate amount is not allowed for this bank slip species type.          | O valor de abatimento não é permitido para o tipo de boleto fornecido.                                                           |
| 400                      | BKS000132            | Bad Request             | Discount data is not allowed for this bank slip species type.          | Os dados de desconto não são permitidos para o tipo de boleto fornecido.                                                           |
| 400                      | BKS000133            | Bad Request             | Fine data is not allowed for this bank slip species type.          | Os dados de multa não são permitidos para o tipo de boleto fornecido.                                                           |
| 400                      | BKS000134            | Bad Request             | Interest data is not allowed for this bank slip species type.          | Os dados de juros não são permitidos para o tipo de boleto fornecido.                                                           |
| 400                      | BKS000136            | Bad Request             | Only credit card financial instrument type can have zero amount.          | Apenas o tipo de instrumento financeiro cartão de crédito pode ter valor zero.                                                           |

---

# Emissão de boleto único (padrão)

URL: /en/documentation/boletos/emissao/emissao_boleto_unico_padrao

:::danger Importante
Para registrar bolePix, é necessário que exista uma chave Pix aleatória ativa na conta em que os boletos serão registrados.
:::

No fluxo padrão de registro de boleto, caso a requisição seja bem sucedida, a resposta retorna um boleto com o status `accepted` (o boleto foi aceito pela QI Tech). Após a confirmação/rejeição da Nuclea/CIP, o boleto passa para o status `registered` ou `rejected`.

:::caution Atenção!
Como trata-se de um registro assíncrono, o solicitante é notificado via [**webhook**](/documentation/boletos/v2/webhooks/boleto) assim que o boleto mudar de status de `accepted` para `registered` ou `rejected`.
:::

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip
MÉTODO POST

### Path parameters

| Campo                   | Tipo   | Descrição                                                    | Caracteres |
|-------------------------|--------|--------------------------------------------------------------|------------|
| `account_key`           | uuidv4 | Chave única de identificação da conta, no formato uuid v4    | 36         |
| `requester_profile_key` | uuidv4 | Chave única de identificação da carteira, no formato uuid v4 | 36         |

Request Body

```json
{
  "request_control_key": "0d496b4d-01f6-48cd-8ec9-9ead1e43f156",
  "our_number": 123456789,
  "document_number": "DOC4561237",
  "amount": 5000.00,
  "expiration": "2025-01-01",
  "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.00, "days_to_fine": 10},
  "interest_data": {
    "interest_type": "workdays_daily_amount",
    "interest_amount": 10.00,
    "days_to_interest": 2,
  },
  "financial_instrument_type": "digital_commercial_invoice",
  "write_off_data": {"days_to_write_off": 365},
  "rebate_amount": 200.00,
  "discounts_data": [
    {
      "discount_amount": 50.00,
      "discount_number": 1,
      "discount_type": "absolute",
      "discount_limit_date": "2024-12-01",
    }
  ],
  "payer_data": {
    "name": "Global Tech",
    "contact": {
      "email": "finance@globaltech.com",
      "phone": {"country_code": "055", "area_code": "11", "number": "987654321"},
    },
    "address": {
      "street": "101 High St.",
      "neighborhood": "Tech Park",
      "number": "202",
      "postal_code": "01001000",
      "city": "Innovation City",
      "state": "SP",
      "complement": "Building A",
    },
    "document_number": "12345678000195",
    "person_type": "legal",
  },
  "guarantor_data": {
    "name": "Jane Doe",
    "contact": {
      "email": "jane.doe@qitech.com.br",
      "phone": {"country_code": "055", "area_code": "11", "number": "999999999"},
    },
    "address": {
      "street": "202 Elm St.",
      "neighborhood": "Quiet Neighborhood",
      "number": "303",
      "postal_code": "01001000",
      "city": "Peaceful Town",
      "state": "RJ",
      "complement": "House 1",
    },
    "document_number": "23456789012",
    "person_type": "natural",
  },
  "pix_key": "4d25d8fc-0074-42bb-b0a4-dd12b1cd0e98",
  "notification": {
    "document_number": "12345678000195",
    "name": "Global Tech",
    "email": "finance@globaltech.com",
    "phone": {"country_code": "055", "area_code": "11", "number": "987654321"},
    "send_2_way": true,
    "send_before_due_date": false,
    "send_after_due_date": false,
    "send_on_protest": false
  },
  "split_payment_data": {
    "beneficiary_settlement_percentage": 70,
    "split_payment_rules": [
      {
        "percentage": 20,
        "document_number": "12345678901",
        "account_owner_name": "John Smith",
        "account_number": "1234567",
        "account_digit": "8"
      },
      {
        "percentage": 10,
        "document_number": "10987654321",
        "account_owner_name": "Mary Johnson",
        "account_number": "7654321",
        "account_digit": "0"
      }
    ]
  }
}
```

### Request Body

| Campo                      | Tipo    | Descrição                                                                          | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `request_control_key` *    | uuidv4  | Chave única de identificação da request utilizada pelo cliente no formato uuid v4  | 36                                                |
| `our_number`               | integer | Número único de identificação do boleto junto à carteira. Pode ser enviado pelo cliente e, caso não seja, a QI Tech irá gerar um                           | 11                                                |
| `document_number`          | string  | Número de identificação do boleto. Pode ser o número da nota fiscal eletrônica     | 10                                                |
| `participant_control_number` | string | Nº Controle do Participante                                                       |25                                                |
| `amount` *                 | float   | Valor base do boleto                                                               | -                                                 |
| `expiration` *             | string  | Data de vencimento                                                                 | 10                                                |
| `bank_teller_instructions` | string  | Observações ao pagador do boleto. Aceita no máximo 320 caracteres, distribuídos em até 7 linhas. Cada linha pode conter no máximo 90 caracteres. Caso uma linha ultrapasse 90 caracteres, o texto será automaticamente quebrado em uma nova linha | 320                                               |
| `rebate_amount`            | float   | Valor de abatimento do boleto, que será aplicado em cima do valor base             | -                                                 |
| `max_payment_days`         | integer | Máximo de dias corridos que o boleto ficará disponível para pagamento, após o vencimento (pode ser no máximo 365) | -          |
| `financial_instrument_type`   | string  | Tipo de espécie do boleto | **[Enumeradores financial_instrument_type](#enumeradores-financial_instrument_type)** |
| `partial_payment_data`    | object  | Configurações de pagamento parcial                      | **[Objeto partial_payment_data](#objeto-partial_payment_data)** |
| `write_off_data`       | object  | Configuração de baixa      | **[Objeto write_off_data](#objeto-write_off_settings)** |
| `protest_data`         | object  | Configuração de protesto       | **[Objeto protest_data](#objeto-protest_settings)** |
| `bankruptcy_protest_data` | object  | Configuração de protesto falimentar | **[Objeto bankruptcy_protest_data](#objeto-bankruptcy_protest_settings)** |
| `fine_data`            | object  | Configuração de multa                 | **[Objeto fine_data](#objeto-fine_settings)** |
| `interest_data`        | object  | Configuração de juros        | **[Objeto interest_data](#objeto-interest_settings)** |
| `discounts_data`           | object array | Descontos           | **[Objeto discount](#objeto-discounts_data)** |
| `payer_data` *             | object  | Dados do pagador                                                                   | **[Objeto payer_data](#objetos-payer_data-e-guarantor_data)** |
| `guarantor_data`           | object  | Dados do sacador avalista                                                          | **[Objeto guarantor_data](#objetos-payer_data-e-guarantor_data)** |
| `pix_key`                  | uuidv4  | Chave pix do tipo aleatória                                                        | 36                                                |
| `notification`             | object | Configurações de notificação do pagador                                             | **[Objeto notification](#objeto-notification)** |
| `split_payment_data`       | object | Credit split (split payment) settings of the bank slip                              | **[split_payment_data Object](#objeto-split_payment_data)** |

:::info BolePix
Caso o parâmetro `pix_key`, opcional, seja enviado na request, será gerado um bolePix. BolePix é um boleto cujo pagamento é vinculado a um QR Code Pix. Sendo assim, o pagador pode realizar o pagamento do boleto tanto utilizando a linha digitável do mesmo, quanto através da leitura do QR Code Pix vinculado. Caso o pagamento seja feito via QR Code, a liquidação financeira se dá instantaneamente, enquanto os retornos bancários e webhooks envolvidos na liquidação serão gerados assim como é feito para um boleto comum.

Importante: para registrar um bolePix, é necessário que exista uma chave Pix aleatória ativa na conta em que boleto será registrado.
:::

:::tip Configurações Padrão da Carteira
Caso cada um dos campos `max_payment_days`, `write_off_data`, `protest_data`, `bankruptcy_protest_data`, `fine_data`, `interest_data` e `pix_key` não sejam enviados na request e a carteira possua configurações padrão (i.e. `max_payment_days`, `write_off_settings`, `protest_settings`, `bankruptcy_protest_settings`, `fine_settings`, `interest_settings` e `qr_code_settings`, respectivamente, no `configuration_data` do `requester_profile`), serão utilizadas tais configurações padrão para a emissão do título.
:::

:::caution Limitações e Restrições
- **Boletos de Pagamento Parcial:** Não é permitido o pagamento via QR Code Pix. Portanto, não é permitido enviar a `pix_key` no registro, nem ter uma configuração padrão de geração de bolePix para a carteira.

- **Boletos de Cartão de Crédito:** Não é necessário nem permitido enviar informações rebate, desconto, multa e juros. Isso se deve ao padrão do mercado, onde muitas Instituições Financeiras não aceitam o pagamento de boletos de cartão de crédito que contenham essas informações. A carteira também não pode ter essas configurações definidas como padrão. Sendo assim boletos desse tipo podem ser pagos parcialmente mesmo após o vencimento, sem incidência de juros, multas, descontos ou abatimentos na fatura corrente. Para aplicar esses valores é necessário incluí-los na próxima fatura, seja através da [ocorrência de edição de valor](/documentation/boletos/instrucoes/valor) do boleto ou emitindo um novo boleto que inclua esses valores. É possível enviar `amount = 0` para boletos deste tipo.

**Importante:** Boletos do tipo `credit_card` são obrigatoriamente de pagamento parcial, sendo assim é necessário fornecer as informações de `partial_payment_data` ou ter essa configuração padrão na carteira. Caso o campo `financial_instrument_type` não seja enviado, o valor padrão será `digital_commercial_invoice`.
:::

:::tip Recomendações de Carteiras
- **Carteira para Boletos Padrão:** Mantenha as configurações padrão para multas, juros e protesto
- **Carteira para Boletos de Pagamento Parcial:** Sem configuração de Pix e com regras específicas para pagamento parcial
- **Carteira para Boletos de Cartão de Crédito:** Sem configurações de multa, juros, desconto ou rebate

Criar carteiras específicas garante que as configurações padrão sejam adequadas para cada tipo de boleto e evita conflitos nas regras de negócio.
:::

:::info Máquina de Estados
A máquina de status para boletos de pagamento parcial possui algumas diferenças. Para mais detalhes, consulte a [introdução](/documentation/boletos/introducao) , onde há uma explicação sobre como aplicar a incidência de juros e multas no boleto seguindo as boas práticas do mercado.
:::

### Enumeradores financial_instrument_type

| Enumerador  | Descrição                        |
|-------------|----------------------------------|
| digital_commercial_invoice | DMI Duplicata Mercantil Indicação |
| credit_card | Cartão de Crédito |
| check | CH Cheque |
| digital_commercial | DM Duplicata Mercantil |
| digital_service_invoice | Duplicata de Serviço |
| digital_service_invoice_indication | DSI Duplicata de Serviço Indicação |
| digital_rural_invoice | DR Duplicata Rural |
| bill_of_exchange | LC Letra de Câmbio |
| commercial_credit_note | NCC Nota de Crédito Comercial |
| export_credit_note | NCE Nota de Crédito Exportação |
| industrial_credit_note | NCI Nota de Crédito Industrial |
| rural_credit_note | NCR Nota de Crédito Rural |
| promissory_note | NP Nota Promissória |
| rural_promissory_note | NPR Nota Promissória Rural |
| mercantile_triplicate | TM Triplicata Mercantil |
| service_triplicate | TS Triplicata de Serviço |
| insurance_note | NS Nota de Seguro |
| receipt | RC Recibo |
| printed_bank_slip | FAT Bloqueto |
| debit_note | ND Nota de Débito |
| insurance_policy | AP Apólice de Seguro |
| school_monthly_fee | ME Mensalidade Escolar |
| consortium_installment | PC Parcela de Consórcio |
| invoice | NF Nota Fiscal |
| debt_document | DD Documento de Dívida |
| rural_product_certificate | Cédula de Produto Rural |
| warrant | Warrant |
| state_active_debt | Dívida Ativa de Estado |
| municipal_active_debt | Dívida Ativa de Município |
| federal_active_debt | Dívida Ativa da União |
| condominium_charges | Encargos condominiais |
| proposal_bank_slip | Boleto proposta |
| deposit_and_contribution_bank_slip | Boleto de Depósito e Aporte |
| others | Outros |

### Objeto split_payment_data

Allows configuring the **credit split** (split payment) of the bank slip, distributing the settled amount between the bank slip's beneficiary and up to 10 additional accounts. The destination accounts must be open and registered with QI Tech, and the sum of percentages (beneficiary + rules) must be exactly 100.

| Field                                  | Type         | Description                                                                                              | Characters |
|----------------------------------------|--------------|----------------------------------------------------------------------------------------------------------|------------|
| `beneficiary_settlement_percentage` *  | float        | Percentage of the settled amount allocated to the bank slip's beneficiary. Accepts values from 0 to 100. | -          |
| `beneficiary_max_amount`               | float        | Maximum amount the beneficiary receives at settlement. When the paid amount exceeds this limit, the surplus is fully directed to the first rule of the `split_payment_rules` array. Accepts values greater than 0 and less than or equal to the bank slip amount. | - |
| `split_payment_rules` *                | object array | List of split rules. Minimum 1, maximum 10 rules.                                                        | **[split_payment_rule Object](#objeto-split_payment_rule)** |

#### Objeto split_payment_rule

| Field                  | Type    | Description                                                                                          | Characters |
|------------------------|---------|------------------------------------------------------------------------------------------------------|------------|
| `percentage` *         | float   | Percentage of the settled amount allocated to this account. Accepts values from 0 to 100. Use `0` when this rule is meant exclusively to receive the surplus from `beneficiary_max_amount`. | - |
| `document_number` *    | string  | CPF/CNPJ of the destination account holder.                                                          | 11 or 14   |
| `account_owner_name` * | string  | Name of the destination account holder.                                                              | 100        |
| `account_number` *     | string  | Destination account number.                                                                          | 20         |
| `account_digit` *      | string  | Destination account check digit.                                                                     | 2          |

:::caution Attention!
- The sum of `beneficiary_settlement_percentage` and the percentages in each item of `split_payment_rules` must be exactly **100**.
- The `document_number` must be unique across rules and different from the beneficiary.
- The split applies to all settlement flows of the bank slip (SILOC, STR, notary office and Pix QR Code).
- `beneficiary_max_amount`, when provided, must be greater than 0 and less than or equal to the bank slip amount. It is required whenever any rule has `percentage = 0`.
- Only **one** rule per bank slip may have `percentage = 0` (the surplus recipient).
- After issuance, you can update the split via the [**credit split update endpoint**](/documentation/boletos/instrucoes/rateio_de_credito), as long as the bank slip is in `registered` status and has not yet been paid.
:::

:::tip Use case: directing late fees and interest to a separate account
To have the beneficiary always receive the bank slip's face value while a different account receives the interest/late fees on overdue payments, configure `beneficiary_settlement_percentage = 100` + `beneficiary_max_amount = ` + a single rule with `percentage = 0` pointing to the surplus recipient account. See the full walkthrough in [**Credit Split Update**](/documentation/boletos/instrucoes/rateio_de_credito#use-case-directing-late-fees-and-interest-to-a-separate-account).
:::

### Objeto partial_payment_data

| Campo                             | Tipo    | Descrição                                                                 | Caracteres |
|-----------------------------------|---------|---------------------------------------------------------------------------|------------|
| `partial_payment_minimum_type` *  | string  | Tipo de valor mínimo para pagamento parcial                               | **[Enumeradores partial_payment_type](#enumeradores-partial_payment_type)** |
| `partial_payment_minimum_percentage` | float | Percentual mínimo permitido para o pagamento parcial                      | -          |
| `partial_payment_minimum_amount`  | float  | Valor mínimo permitido para o pagamento parcial                           | -          |
| `partial_payment_maximum_type`    | string  | Tipo de valor máximo para pagamento parcial                               | **[Enumeradores partial_payment_type](#enumeradores-partial_payment_type)** |
| `partial_payment_maximum_percentage` | float | Percentual máximo permitido para o pagamento parcial                      | -          |
| `partial_payment_maximum_amount`  | float  | Valor máximo permitido para o pagamento parcial                           | -          |
| `partial_payment_quantity` *      | integer | Quantidade de pagamentos parciais permitidos                              | -          |

:::caution Atenção!
De acordo com o valor enviado nos campos `partial_payment_minimum_type` e `partial_payment_maximum_type`, é necessário enviar o `partial_payment_minimum_amount` ou `partial_payment_minimum_percentage`, e o `partial_payment_maximum_amount` ou `partial_payment_maximum_percentage` correspondente.
:::

### Enumeradores partial_payment_type

| Enumerador  | Descrição                        |
|-------------|----------------------------------|
| absolute    | Valor absoluto                   |
| percentage  | Percentual                       |

### Objeto write_off_data

| Campo                     | Tipo    | Descrição                                                                   | Caracteres |
|---------------------------|---------|-----------------------------------------------------------------------------|------------|
| `days_to_write_off` *     | integer | Dias, após o vencimento, para que o boleto seja baixado automaticamente     | -          |

### Objeto protest_data

| Campo                     | Tipo    | Descrição                                                                   | Caracteres |
|---------------------------|---------|-----------------------------------------------------------------------------|------------|
| `days_to_protest` *       | integer | Dias, após o vencimento, para que o boleto seja protestado automaticamente  | -          |

### Objeto bankruptcy_protest_data

| Campo                          | Tipo    | Descrição                                                                   | Caracteres  |
|--------------------------------|---------|-----------------------------------------------------------------------------|------------|
| `days_to_bankruptcy_protest` * | integer | Dias, após o vencimento, para que o boleto seja protestado automaticamente  | -           |

### Objeto fine_data

Opção 1: multa em valor absoluto (`fine_type=absolute`)

| Campo                     | Tipo    | Descrição                                               | Caracteres                |
|---------------------------|---------|---------------------------------------------------------|-------------------------------------------------------------------------|
| `fine_type` *             | string  | Tipo da multa                                                       | **[Enumeradores fine_type](#enumeradores-fine_type)**                                              |
| `fine_amount` *           | float   | Valor absoluto da multa                                             | -                                                                        |
| `days_to_fine` *          | integer | Dias, após o vencimento, para que a multa seja cobrada              | -                                                                        |

Opção 2: multa em valor percentual (`fine_type=percentage`)

| Campo                     | Tipo    | Descrição                                                 | Caracteres                             |
|---------------------------|---------|-----------------------------------------------------------|---------------------------------------|
| `fine_type` *             | string  | Tipo da multa                                             | **[Enumeradores fine_type](#enumeradores-fine_type)** |
| `fine_percentage` *       | integer | Valor percentual da multa, de 1 a 100                     | -                                      |
| `days_to_fine` *          | integer | Dias, após o vencimento, para que a multa seja cobrada    | -                                      |

### Enumeradores fine_type

| Enumerador         | Descrição             |
|--------------------|-----------------------|
| absolute           | valor absoluto        |
| percentage         | valor percentual      |

### Objeto interest_data

Opção 1: juros utilizando valores absolutos (`interest_type=calendar_days_daily_amount` ou `interest_type=workdays_daily_amount`)

| Campo                     | Tipo    | Descrição                                                                     | Caracteres                                                                                      |
|---------------------------|---------|-------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
| `interest_type` *         | string  | Tipo de juros       | **[Enumeradores interest_type](#enumeradores-interest_type)** |
| `interest_amount` *       | float   | Valor a ser cobrado por unidade de tempo determinada (dias úteis ou corridos) | -                                                                                               |
| `days_to_interest` *      | integer | Dias, após o vencimento, para que comece a cobrar os juros                    | -                                                                                               |

Opção 2: juros utilizando valores percentuais (`interest_type=calendar_days_monthly_percentage`)

| Campo                    | Tipo    | Descrição                                                                             | Caracteres                                                                                          |
|--------------------------|---------|---------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
| `interest_type` *        | string  | Tipo de juros       | **[Enumeradores interest_type](#enumeradores-interest_type)** |
| `interest_percentage` *  | integer | Porcentagem a ser cobrada por unidade de tempo determinada (dias úteis ou corridos)                                                                      | -                                                                           |
| `days_to_interest` *     | integer | Dias, após o vencimento, para que comece a cobrar os juros                             | -                                                                                                   |

### Enumeradores interest_type

| Enumerador                       | Descrição                                                            |
|----------------------------------|----------------------------------------------------------------------|
| calendar_days_daily_amount       | Valor diário sobre dias corridos                                     |
| workdays_daily_amount            | Valor diário sobre dias úteis                                        |
| calendar_days_monthly_percentage | Porcentagem 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"]`)

| Campo                     | Tipo    | Descrição                                           | Caracteres                                                |
|---------------------------|---------|-----------------------------------------------------|-----------------------------------------------------------|
| `discount_amount` *       | float   | Valor absoluto de desconto por unidade de tempo                                            | -                                                          |
| `discount_number` *       | integer | Número do desconto                                     | -                                                         |
| `discount_type` *         | string  | Configuração do desconto em valores absolutos                                    | **[Enumerador discount_type](#enumeradores-discount_type)** |                                                       |
| `discount_limit_date` *   | string  | Data limite para aplicação do desconto   | 10                                                        |

Opção 2: descontos utilizando valores percentuais (`discount_type in ["percentage", "anticipation_calendar_days_daily_percentage", "anticipation_workdays_daily_percentage"]`)

| Campo                     | Tipo    | Descrição                                           | Caracteres                                                |
|---------------------------|---------|-----------------------------------------------------|-----------------------------------------------------------|
| `discount_percentage` *   | float   | Valor percentual de desconto por unidade de tempo                                            | -                                                          |
| `discount_number` *       | integer | Número do desconto                                     | -                                                         |
| `discount_type` *         | string  | Configuração do desconto em valores percentuais                                    | **[Enumerador discount_type](#enumeradores-discount_type)** |                                                       |
| `discount_limit_date` *   | string  | Data limite para aplicação do desconto   | 10                                                        |

:::caution 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

| Enumerador                                  | Descrição                                                                |
|---------------------------------------------|--------------------------------------------------------------------------|
| absolute                                    | Valor fixo                                                               |
| anticipation_calendar_days_daily_amount     | Valor diário de desconto de antecipação, sobre dias corridos             |
| anticipation_workdays_daily_amount          | Valor diário de desconto de antecipação, sobre dias úteis                |
| percentage                                  | Porcentagem fixa                                                         |
| anticipation_calendar_days_daily_percentage | Porcentagem mensal de desconto de antecipação, com base em dias corridos |
| anticipation_workdays_daily_percentage      | Porcentagem anual de desconto de antecipação, com base em dias úteis     |

### Objetos payer_data e guarantor_data

| Campo                     | Tipo   | Descrição                                                  | Caracteres|
|---------------------------|--------|-------------------------------------|-----------------------------------------------------------|
| `name` *                  | string | Nome completo                       | 100                                                       |
| `document_number` *       | string | Número do documento (CPF/CNPJ)      | 11 ou 14                                                  |
| `person_type` *           | string | Tipo da pessoa (física ou jurídica) | **[Enumeradores person_type](#enumeradores-person_type)** |
| `contact`                 | object | Informações de contato              | **[Objeto contact](#objeto-contact)**                     |
| `address`                 | object | Endereço                            | **[Objeto address](#objeto-address)**                     |

### Enumeradores person_type

| Enumerador         | Descrição             |
|--------------------|-----------------------|
| natural            | pessoa física         |
| legal              | pessoa jurídica       |

### Objeto contact

| Campo                     | Tipo   | Descrição                         | Caracteres                         |
|---------------------------|--------|-----------------------------------|------------------------------------|
| `email`                   | string | E-mail de contato                 | 320                                |
| `phone`                   | object | Telefone de contato               | **[Objeto phone](#objeto-phone)**  |

### Objeto phone

| Campo                           | Tipo   | Descrição                                    | Caracteres |
|---------------------------------|--------|----------------------------------------------|------------|
| `country_code` *     | string | Código DDI (Discagem Direta Internacional)   | 3          |
| `area_code` *                   | string | Código DDD (Discagem Direta à Distância)     | 2          |
| `number` *                      | string | Complemento                                  | 9          |

### Objeto address

| Campo                     | Tipo   | Descrição                                    | Caracteres |
|---------------------------|--------|----------------------------------------------|------------|
| `street` *                | string | Logradouro                                   | 500        |
| `number` *                | string | Número                                       | 6          |
| `complement`              | string | Complemento                                  | 500        |
| `neighborhood` *          | string | Bairro                                       | 100        |
| `postal_code` *           | string | CEP                                          | 8          |
| `city` *                  | string | Cidade                                       | 100        |
| `state` *                 | string | Estado (UF) | **[Enumerador state](#enumeradores-state)** |

### Enumeradores state

| Enumerador         | Descrição             |
|--------------------|-----------------------|
| 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                 | Exceção               |

### Objeto notification

| Campo                     | Tipo    | Descrição                                                                               | Caracteres |
|---------------------------|---------|-----------------------------------------------------------------------------------------|------------|
| `document_number` *       | string  | Número do documento de quem receberá as notificações (CPF/CNPJ)                         | 11 ou 14   |
| `name` *                  | string  | Nome de quem receberá as notificações                                                   | 100        |
| `email`                   | string  | E-mail para o qual serão enviadas as notificações                                       | 320        |
| `phone`                   | object  | Telefone de contato para o qual serão enviadas as notificações | **[Objeto phone](#objeto-phone)**   |
| `send_2_way` *            | boolean | Enviar segunda via                                                                      | -          |
| `send_before_due_date` *  | boolean | Enviar notificação ao pagador antes da data de vencimento                               | -          |
| `send_after_due_date` *   | boolean | Enviar notificação ao pagador quando o boleto vencer                                    | -          |
| `send_on_protest` *       | boolean | Enviar notificação ao entrar em fluxo de protesto                                       | -          |

## Response

STATUS 202

Response Body

```json
{
  "request_control_key": "0d496b4d-01f6-48cd-8ec9-9ead1e43f156",
  "bank_slip_key": "8cb70dea-9fb0-4a68-9572-99a72849c8d6",
  "bank_slip_status": "accepted",
  "our_number": 67215548222,
  "barcode": "32995995900000892811606496721554822228569790",
  "digitable_line": "32991606429672155482022285697904599590000089281",
  "qr_code_data": {
    "qr_code_key": "a92b180a-4aa5-47c2-8a71-4e7bbb074410",
    "pix_key": "4d25d8fc-0074-42bb-b0a4-dd12b1cd0e98",
    "receiver_conciliation_id": "01GVGV9NXBCY287Z6CJ4S0ENW9",
    "url": "00020126830014br.gov.bcb.pix2561qrcode.qitech.app/bacen/cobv/58fd5103a8e64bbbab2fd49b0bd580145204000053039865802BR5925GONNFUNDODEINVESTIMENTOEM6012RiodeJaneiro6107226401262070503***6304EA0D",
    "image": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/wAALCAD0APQBAREA/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/9oACAEBAAA/APf6KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK+QPhl8Mv+Fjf2p/xN/wCz/sHlf8u3m79+/wD21xjZ79a7/wD4Zl/6m7/ym/8A22j/AIZl/wCpu/8AKb/9to/Zl/5mn/t0/wDa1egfE34Zf8LG/sv/AIm/9n/YPN/5dvN379n+2uMbPfrXgHwy+GX/AAsb+1P+Jv8A2f8AYPK/5dvN379/+2uMbPfrR8Tfib/wsb+y/wDiUf2f9g83/l583fv2f7C4xs9+td//AMm5/wDUw/27/wBunkeR/wB/N27zvbG3vnjwCvr/AOJvxN/4Vz/Zf/Eo/tD7f5v/AC8+Vs2bP9hs53+3SvkCvf8A9mX/AJmn/t0/9rUf8m5/9TD/AG7/ANunkeR/383bvO9sbe+ePQPhl8Mv+Fc/2p/xN/7Q+3+V/wAu3lbNm/8A22znf7dK8A+GXxN/4Vz/AGp/xKP7Q+3+V/y8+Vs2b/8AYbOd/t0o+GXxN/4Vz/an/Eo/tD7f5X/Lz5WzZv8A9hs53+3Svf8A4m/DL/hY39l/8Tf+z/sHm/8ALt5u/fs/21xjZ79a8/8A+GZf+pu/8pv/ANtr0D4ZfE3/AIWN/an/ABKP7P8AsHlf8vPm79+//YXGNnv1rwD4ZfE3/hXP9qf8Sj+0Pt/lf8vPlbNm/wD2Gznf7dK7/wD4aa/6lH/ypf8A2quA+GXxN/4Vz/an/Eo/tD7f5X/Lz5WzZv8A9hs53+3Svr+vkD4ZfDL/AIWN/an/ABN/7P8AsHlf8u3m79+//bXGNnv1rv8A/hmX/qbv/Kb/APbaP+GZf+pu/wDKb/8AbaP2Zf8Amaf+3T/2tX0BRRRXz/8Asy/8zT/26f8AtavAK9//AGZf+Zp/7dP/AGtR+zL/AMzT/wBun/tavQPib8Mv+Fjf2X/xN/7P+web/wAu3m79+z/bXGNnv1rz/wDZl/5mn/t0/wDa1cB8Mvib/wAK5/tT/iUf2h9v8r/l58rZs3/7DZzv9ule/wDwy+Jv/Cxv7U/4lH9n/YPK/wCXnzd+/f8A7C4xs9+teAfE34Zf8K5/sv8A4m/9ofb/ADf+XbytmzZ/ttnO/wBule//ABN+Jv8Awrn+y/8AiUf2h9v83/l58rZs2f7DZzv9uleAfDL4Zf8ACxv7U/4m/wDZ/wBg8r/l283fv3/7a4xs9+tHxN+GX/Cuf7L/AOJv/aH2/wA3/l28rZs2f7bZzv8AbpXv/wAMvhl/wrn+1P8Aib/2h9v8r/l28rZs3/7bZzv9ulef/tNf8yt/29/+0a9A+GXxN/4WN/an/Eo/s/7B5X/Lz5u/fv8A9hcY2e/WvP8A/k3P/qYf7d/7dPI8j/v5u3ed7Y2988cB8Tfhl/wrn+y/+Jv/AGh9v83/AJdvK2bNn+22c7/bpXf/APDTX/Uo/wDlS/8AtVcB8Tfhl/wrn+y/+Jv/AGh9v83/AJdvK2bNn+22c7/bpX1/Xz//AMm5/wDUw/27/wBunkeR/wB/N27zvbG3vng/5OM/6l7+wv8At78/z/8Av3t2+T753dsc+gfDL4m/8LG/tT/iUf2f9g8r/l583fv3/wCwuMbPfrXn/wCzL/zNP/bp/wC1q8Ar3/8AZl/5mn/t0/8Aa1H7Mv8AzNP/AG6f+1q+gKKKK+f/ANmX/maf+3T/ANrUf8My/wDU3f8AlN/+216B8Mvhl/wrn+1P+Jv/AGh9v8r/AJdvK2bN/wDttnO/26V5/wDsy/8AM0/9un/taj/k4z/qXv7C/wC3vz/P/wC/e3b5Pvnd2xyf8nGf9S9/YX/b35/n/wDfvbt8n3zu7Y5P2mv+ZW/7e/8A2jR+zL/zNP8A26f+1qP+Tc/+ph/t3/t08jyP+/m7d53tjb3zx4BXv/7TX/Mrf9vf/tGj/k3P/qYf7d/7dPI8j/v5u3ed7Y2988cB8Mvhl/wsb+1P+Jv/AGf9g8r/AJdvN379/wDtrjGz3613/wDwzL/1N3/lN/8AttH7Mv8AzNP/AG6f+1q4D4m/DL/hXP8AZf8AxN/7Q+3+b/y7eVs2bP8AbbOd/t0rv/8Ahpr/AKlH/wAqX/2qj/k4z/qXv7C/7e/P8/8A797dvk++d3bHJ/ybn/1MP9u/9unkeR/383bvO9sbe+ePQPhl8Mv+Fc/2p/xN/wC0Pt/lf8u3lbNm/wD22znf7dKPib8Mv+Fjf2X/AMTf+z/sHm/8u3m79+z/AG1xjZ79a8//AGZf+Zp/7dP/AGtX0BXz/wDsy/8AM0/9un/taj/hmX/qbv8Aym//AG2vQPhl8Mv+Fc/2p/xN/wC0Pt/lf8u3lbNm/wD22znf7dK8/wD2Zf8Amaf+3T/2tX0BRRRXz/8A8My/9Td/5Tf/ALbR/wAMy/8AU3f+U3/7bR/wzL/1N3/lN/8AttegfDL4Zf8ACuf7U/4m/wDaH2/yv+Xbytmzf/ttnO/26V5//wAm5/8AUw/27/26eR5H/fzdu872xt7549A+GXwy/wCFc/2p/wATf+0Pt/lf8u3lbNm//bbOd/t0rz/9mX/maf8At0/9rVwHwy+Jv/Cuf7U/4lH9ofb/ACv+Xnytmzf/ALDZzv8AbpR8Mvib/wAK5/tT/iUf2h9v8r/l58rZs3/7DZzv9ulHwy+Jv/Cuf7U/4lH9ofb/ACv+Xnytmzf/ALDZzv8AbpXf/sy/8zT/ANun/tavQPhl8Mv+Fc/2p/xN/wC0Pt/lf8u3lbNm/wD22znf7dK8/wD2Zf8Amaf+3T/2tXoHwy+GX/Cuf7U/4m/9ofb/ACv+Xbytmzf/ALbZzv8AbpXgHwy+Jv8Awrn+1P8AiUf2h9v8r/l58rZs3/7DZzv9uld/+zL/AMzT/wBun/tavQPhl8Mv+Fc/2p/xN/7Q+3+V/wAu3lbNm/8A22znf7dK8A+GXxN/4Vz/AGp/xKP7Q+3+V/y8+Vs2b/8AYbOd/t0o+GXxN/4Vz/an/Eo/tD7f5X/Lz5WzZv8A9hs53+3Su/8A2Zf+Zp/7dP8A2tR/ybn/ANTD/bv/AG6eR5H/AH83bvO9sbe+eD9mX/maf+3T/wBrUfsy/wDM0/8Abp/7Wo/4Zl/6m7/ym/8A22j/AIZl/wCpu/8AKb/9to/4Zl/6m7/ym/8A22vQPhl8Mv8AhXP9qf8AE3/tD7f5X/Lt5WzZv/22znf7dK9Aooor5/8A2Zf+Zp/7dP8A2tXAfE34m/8ACxv7L/4lH9n/AGDzf+Xnzd+/Z/sLjGz360fE34m/8LG/sv8A4lH9n/YPN/5efN379n+wuMbPfrXv/wAMvhl/wrn+1P8Aib/2h9v8r/l28rZs3/7bZzv9ulfIFFegfDL4m/8ACuf7U/4lH9ofb/K/5efK2bN/+w2c7/bpXf8A7TX/ADK3/b3/AO0a9A+GXxN/4WN/an/Eo/s/7B5X/Lz5u/fv/wBhcY2e/WvAPib8Mv8AhXP9l/8AE3/tD7f5v/Lt5WzZs/22znf7dKPib8Mv+Fc/2X/xN/7Q+3+b/wAu3lbNmz/bbOd/t0rv/wBmX/maf+3T/wBrVwHxN+GX/Cuf7L/4m/8AaH2/zf8Al28rZs2f7bZzv9ulHxN+GX/Cuf7L/wCJv/aH2/zf+XbytmzZ/ttnO/26V3//AAzL/wBTd/5Tf/ttH7TX/Mrf9vf/ALRrgPhl8Tf+Fc/2p/xKP7Q+3+V/y8+Vs2b/APYbOd/t0o+Jvwy/4Vz/AGX/AMTf+0Pt/m/8u3lbNmz/AG2znf7dK7//AJOM/wCpe/sL/t78/wA//v3t2+T753dscn/Juf8A1MP9u/8Abp5Hkf8Afzdu872xt7548Ar3/wD5Nz/6mH+3f+3TyPI/7+bt3ne2NvfPHAfE34Zf8K5/sv8A4m/9ofb/ADf+XbytmzZ/ttnO/wBuld/+01/zK3/b3/7Rr6Aorz/4ZfE3/hY39qf8Sj+z/sHlf8vPm79+/wD2FxjZ79a9Aooor5A+Jvwy/wCFc/2X/wATf+0Pt/m/8u3lbNmz/bbOd/t0o+JvxN/4WN/Zf/Eo/s/7B5v/AC8+bv37P9hcY2e/Wu//AGmv+ZW/7e//AGjXoHwy+GX/AArn+1P+Jv8A2h9v8r/l28rZs3/7bZzv9ulHwy+Jv/Cxv7U/4lH9n/YPK/5efN379/8AsLjGz3615/8A8nGf9S9/YX/b35/n/wDfvbt8n3zu7Y5+gK+QPib8Tf8AhY39l/8AEo/s/wCweb/y8+bv37P9hcY2e/Wvf/hl8Tf+Fjf2p/xKP7P+weV/y8+bv37/APYXGNnv1rz/AP4aa/6lH/ypf/aq9A+Jvwy/4WN/Zf8AxN/7P+web/y7ebv37P8AbXGNnv1r0CvkD4m/DL/hXP8AZf8AxN/7Q+3+b/y7eVs2bP8AbbOd/t0rv/8Ahpr/AKlH/wAqX/2qj/hmX/qbv/Kb/wDbaP8Ak3P/AKmH+3f+3TyPI/7+bt3ne2NvfPHoHxN+Jv8Awrn+y/8AiUf2h9v83/l58rZs2f7DZzv9ulHwy+GX/Cuf7U/4m/8AaH2/yv8Al28rZs3/AO22c7/bpXn/AO01/wAyt/29/wDtGj/hpr/qUf8Aypf/AGqj/k4z/qXv7C/7e/P8/wD797dvk++d3bHJ/wANNf8AUo/+VL/7VXAfE34Zf8K5/sv/AIm/9ofb/N/5dvK2bNn+22c7/bpR8Mvib/wrn+1P+JR/aH2/yv8Al58rZs3/AOw2c7/bpR8Mvhl/wsb+1P8Aib/2f9g8r/l283fv3/7a4xs9+tHwy+Jv/Cuf7U/4lH9ofb/K/wCXnytmzf8A7DZzv9ulfX9FFFFfP/8AwzL/ANTd/wCU3/7bXoHwy+GX/Cuf7U/4m/8AaH2/yv8Al28rZs3/AO22c7/bpXgHwy+GX/Cxv7U/4m/9n/YPK/5dvN379/8AtrjGz3613/8AwzL/ANTd/wCU3/7bR/w01/1KP/lS/wDtVegfDL4Zf8K5/tT/AIm/9ofb/K/5dvK2bN/+22c7/bpR8Mvib/wsb+1P+JR/Z/2Dyv8Al583fv3/AOwuMbPfrR8Mvhl/wrn+1P8Aib/2h9v8r/l28rZs3/7bZzv9uleAfE34Zf8ACuf7L/4m/wDaH2/zf+XbytmzZ/ttnO/26V3/AO01/wAyt/29/wDtGuA+GXwy/wCFjf2p/wATf+z/ALB5X/Lt5u/fv/21xjZ79a9/+Jvwy/4WN/Zf/E3/ALP+web/AMu3m79+z/bXGNnv1rwD4m/DL/hXP9l/8Tf+0Pt/m/8ALt5WzZs/22znf7dK9/8Aib8Tf+Fc/wBl/wDEo/tD7f5v/Lz5WzZs/wBhs53+3SvP/wBpr/mVv+3v/wBo0f8AJuf/AFMP9u/9unkeR/383bvO9sbe+eD9mX/maf8At0/9rV4BXoHwy+Jv/Cuf7U/4lH9ofb/K/wCXnytmzf8A7DZzv9uld/8A8m5/9TD/AG7/ANunkeR/383bvO9sbe+eOA+GXxN/4Vz/AGp/xKP7Q+3+V/y8+Vs2b/8AYbOd/t0rv/8Ak3P/AKmH+3f+3TyPI/7+bt3ne2NvfPHoHxN+GX/Cxv7L/wCJv/Z/2Dzf+Xbzd+/Z/trjGz3614B8Mvib/wAK5/tT/iUf2h9v8r/l58rZs3/7DZzv9ule/wDxN+Jv/Cuf7L/4lH9ofb/N/wCXnytmzZ/sNnO/26UfE34m/wDCuf7L/wCJR/aH2/zf+XnytmzZ/sNnO/26V5/+zL/zNP8A26f+1q+gKKKK+f8A/k3P/qYf7d/7dPI8j/v5u3ed7Y2988H/ACbn/wBTD/bv/bp5Hkf9/N27zvbG3vnjgPib8Mv+Fc/2X/xN/wC0Pt/m/wDLt5WzZs/22znf7dK9/wDhl8Mv+Fc/2p/xN/7Q+3+V/wAu3lbNm/8A22znf7dKPib8Mv8AhY39l/8AE3/s/wCweb/y7ebv37P9tcY2e/WvAPib8Mv+Fc/2X/xN/wC0Pt/m/wDLt5WzZs/22znf7dK8/r3/APaa/wCZW/7e/wD2jXAfDL4m/wDCuf7U/wCJR/aH2/yv+Xnytmzf/sNnO/26V7/8Mvhl/wAK5/tT/ib/ANofb/K/5dvK2bN/+22c7/bpXn//AA01/wBSj/5Uv/tVegfE34m/8K5/sv8A4lH9ofb/ADf+XnytmzZ/sNnO/wBulHxN+Jv/AArn+y/+JR/aH2/zf+XnytmzZ/sNnO/26V5/+01/zK3/AG9/+0aP2Zf+Zp/7dP8A2tR+zL/zNP8A26f+1qP+TjP+pe/sL/t78/z/APv3t2+T753dsc+AV7/+zL/zNP8A26f+1q9A+GXwy/4Vz/an/E3/ALQ+3+V/y7eVs2b/APbbOd/t0rwD4ZfDL/hY39qf8Tf+z/sHlf8ALt5u/fv/ANtcY2e/Wvf/AIm/E3/hXP8AZf8AxKP7Q+3+b/y8+Vs2bP8AYbOd/t0rwD4m/DL/AIVz/Zf/ABN/7Q+3+b/y7eVs2bP9ts53+3Su/wD2mv8AmVv+3v8A9o1wHwy+Jv8Awrn+1P8AiUf2h9v8r/l58rZs3/7DZzv9ulHxN+GX/Cuf7L/4m/8AaH2/zf8Al28rZs2f7bZzv9ule/8Awy+GX/Cuf7U/4m/9ofb/ACv+Xbytmzf/ALbZzv8AbpXoFFFFfIHwy+GX/Cxv7U/4m/8AZ/2Dyv8Al283fv3/AO2uMbPfrXf/APDMv/U3f+U3/wC20f8AJxn/AFL39hf9vfn+f/3727fJ987u2OfQPhl8Mv8AhXP9qf8AE3/tD7f5X/Lt5WzZv/22znf7dK8//wCGmv8AqUf/ACpf/aq8Ar3/AP4aa/6lH/ypf/aq9A+GXwy/4Vz/AGp/xN/7Q+3+V/y7eVs2b/8AbbOd/t0rwD4m/DL/AIVz/Zf/ABN/7Q+3+b/y7eVs2bP9ts53+3Svf/ib8Mv+Fjf2X/xN/wCz/sHm/wDLt5u/fs/21xjZ79a8/wD+TjP+pe/sL/t78/z/APv3t2+T753dsc+gfDL4m/8ACxv7U/4lH9n/AGDyv+Xnzd+/f/sLjGz360fDL4Zf8K5/tT/ib/2h9v8AK/5dvK2bN/8AttnO/wBulef/APJxn/Uvf2F/29+f5/8A3727fJ987u2OT/hpr/qUf/Kl/wDaqP2mv+ZW/wC3v/2jR+zL/wAzT/26f+1q8Ar3/wD4Zl/6m7/ym/8A22vQPhl8Tf8AhY39qf8AEo/s/wCweV/y8+bv37/9hcY2e/Wj4m/E3/hXP9l/8Sj+0Pt/m/8ALz5WzZs/2Gznf7dKPib8Mv8AhY39l/8AE3/s/wCweb/y7ebv37P9tcY2e/Wj4ZfE3/hY39qf8Sj+z/sHlf8ALz5u/fv/ANhcY2e/Wj4ZfDL/AIVz/an/ABN/7Q+3+V/y7eVs2b/9ts53+3SvQK+f/wDk4z/qXv7C/wC3vz/P/wC/e3b5Pvnd2xz9AUUUUV5/8Mvhl/wrn+1P+Jv/AGh9v8r/AJdvK2bN/wDttnO/26V5/wD8m5/9TD/bv/bp5Hkf9/N27zvbG3vnjwCvQPib8Mv+Fc/2X/xN/wC0Pt/m/wDLt5WzZs/22znf7dK7/wD5Nz/6mH+3f+3TyPI/7+bt3ne2NvfPHAfDL4m/8K5/tT/iUf2h9v8AK/5efK2bN/8AsNnO/wBulHwy+GX/AAsb+1P+Jv8A2f8AYPK/5dvN379/+2uMbPfrXf8A7TX/ADK3/b3/AO0a4D4m/DL/AIVz/Zf/ABN/7Q+3+b/y7eVs2bP9ts53+3Sj4ZfDL/hY39qf8Tf+z/sHlf8ALt5u/fv/ANtcY2e/Wu//AGmv+ZW/7e//AGjXoHxN+GX/AAsb+y/+Jv8A2f8AYPN/5dvN379n+2uMbPfrXoFfIHwy+Jv/AArn+1P+JR/aH2/yv+Xnytmzf/sNnO/26UfDL4Zf8LG/tT/ib/2f9g8r/l283fv3/wC2uMbPfrXf/wDDTX/Uo/8AlS/+1Ufsy/8AM0/9un/tavAK9A+GXwy/4WN/an/E3/s/7B5X/Lt5u/fv/wBtcY2e/Wu//wCGmv8AqUf/ACpf/aq4D4ZfE3/hXP8Aan/Eo/tD7f5X/Lz5WzZv/wBhs53+3Su//wCTjP8AqXv7C/7e/P8AP/797dvk++d3bHPoHxN+Jv8Awrn+y/8AiUf2h9v83/l58rZs2f7DZzv9ulHxN+Jv/Cuf7L/4lH9ofb/N/wCXnytmzZ/sNnO/26UfDL4m/wDCxv7U/wCJR/Z/2Dyv+Xnzd+/f/sLjGz360fE34m/8K5/sv/iUf2h9v83/AJefK2bNn+w2c7/bpR8Mvib/AMLG/tT/AIlH9n/YPK/5efN379/+wuMbPfrXoFFFFfIHwy+Jv/Cuf7U/4lH9ofb/ACv+Xnytmzf/ALDZzv8AbpX1/XwBXoHxN+GX/Cuf7L/4m/8AaH2/zf8Al28rZs2f7bZzv9ule/8Awy+Jv/Cxv7U/4lH9n/YPK/5efN379/8AsLjGz360fE34m/8ACuf7L/4lH9ofb/N/5efK2bNn+w2c7/bpR8Mvhl/wrn+1P+Jv/aH2/wAr/l28rZs3/wC22c7/AG6V5/8Asy/8zT/26f8AtauA+JvxN/4WN/Zf/Eo/s/7B5v8Ay8+bv37P9hcY2e/Wvf8A4m/E3/hXP9l/8Sj+0Pt/m/8ALz5WzZs/2Gznf7dK8A+JvxN/4WN/Zf8AxKP7P+web/y8+bv37P8AYXGNnv1r3/4m/E3/AIVz/Zf/ABKP7Q+3+b/y8+Vs2bP9hs53+3SvP/8Ak3P/AKmH+3f+3TyPI/7+bt3ne2NvfPB/w01/1KP/AJUv/tVegfE34m/8K5/sv/iUf2h9v83/AJefK2bNn+w2c7/bpXn/AO01/wAyt/29/wDtGj/hpr/qUf8Aypf/AGqvoCvkD4ZfE3/hXP8Aan/Eo/tD7f5X/Lz5WzZv/wBhs53+3Svf/ib8Tf8AhXP9l/8AEo/tD7f5v/Lz5WzZs/2Gznf7dK8//wCGZf8Aqbv/ACm//baP2mv+ZW/7e/8A2jR/ybn/ANTD/bv/AG6eR5H/AH83bvO9sbe+ePQPib8Tf+Fc/wBl/wDEo/tD7f5v/Lz5WzZs/wBhs53+3SvAPhl8Tf8AhXP9qf8AEo/tD7f5X/Lz5WzZv/2Gznf7dK9/+GXxN/4WN/an/Eo/s/7B5X/Lz5u/fv8A9hcY2e/Wj4ZfE3/hY39qf8Sj+z/sHlf8vPm79+//AGFxjZ79a9Aoooor5/8A2Zf+Zp/7dP8A2tR/wzL/ANTd/wCU3/7bR/ybn/1MP9u/9unkeR/383bvO9sbe+ePQPib8Tf+Fc/2X/xKP7Q+3+b/AMvPlbNmz/YbOd/t0o+JvxN/4Vz/AGX/AMSj+0Pt/m/8vPlbNmz/AGGznf7dK8A+Jvwy/wCFc/2X/wATf+0Pt/m/8u3lbNmz/bbOd/t0r3/4m/DL/hY39l/8Tf8As/7B5v8Ay7ebv37P9tcY2e/Wj4m/E3/hXP8AZf8AxKP7Q+3+b/y8+Vs2bP8AYbOd/t0r5Ar0D4ZfE3/hXP8Aan/Eo/tD7f5X/Lz5WzZv/wBhs53+3Su//wCGmv8AqUf/ACpf/aq4D4ZfE3/hXP8Aan/Eo/tD7f5X/Lz5WzZv/wBhs53+3Su//aa/5lb/ALe//aNcB8Mvhl/wsb+1P+Jv/Z/2Dyv+Xbzd+/f/ALa4xs9+tHxN+Jv/AAsb+y/+JR/Z/wBg83/l583fv2f7C4xs9+te/wDwy+GX/Cuf7U/4m/8AaH2/yv8Al28rZs3/AO22c7/bpXgHwy+GX/Cxv7U/4m/9n/YPK/5dvN379/8AtrjGz360fE34Zf8ACuf7L/4m/wDaH2/zf+XbytmzZ/ttnO/26V5/Xv8A+01/zK3/AG9/+0a4D4ZfDL/hY39qf8Tf+z/sHlf8u3m79+//AG1xjZ79a9/+GXxN/wCFjf2p/wASj+z/ALB5X/Lz5u/fv/2FxjZ79aPhl8Mv+Fc/2p/xN/7Q+3+V/wAu3lbNm/8A22znf7dK+QK9/wD2Zf8Amaf+3T/2tX0BRRRRXyB8Tfhl/wAK5/sv/ib/ANofb/N/5dvK2bNn+22c7/bpXf8A/DTX/Uo/+VL/AO1VwHwy+GX/AAsb+1P+Jv8A2f8AYPK/5dvN379/+2uMbPfrXf8A/DMv/U3f+U3/AO21wHwy+Jv/AArn+1P+JR/aH2/yv+Xnytmzf/sNnO/26UfDL4m/8K5/tT/iUf2h9v8AK/5efK2bN/8AsNnO/wBule//ABN+Jv8Awrn+y/8AiUf2h9v83/l58rZs2f7DZzv9uleAfE34m/8ACxv7L/4lH9n/AGDzf+Xnzd+/Z/sLjGz3615/XoHxN+Jv/Cxv7L/4lH9n/YPN/wCXnzd+/Z/sLjGz3613/wC01/zK3/b3/wC0a9A+GXwy/wCFc/2p/wATf+0Pt/lf8u3lbNm//bbOd/t0rwD4ZfDL/hY39qf8Tf8As/7B5X/Lt5u/fv8A9tcY2e/Wu/8A+GZf+pu/8pv/ANtrgPhl8Mv+Fjf2p/xN/wCz/sHlf8u3m79+/wD21xjZ79a8/r0D4ZfDL/hY39qf8Tf+z/sHlf8ALt5u/fv/ANtcY2e/Wj4m/E3/AIWN/Zf/ABKP7P8AsHm/8vPm79+z/YXGNnv1rv8A/hpr/qUf/Kl/9qr0D4m/DL/hY39l/wDE3/s/7B5v/Lt5u/fs/wBtcY2e/WvP/wBmX/maf+3T/wBrV6B8Mvib/wALG/tT/iUf2f8AYPK/5efN379/+wuMbPfrXgHwy+GX/Cxv7U/4m/8AZ/2Dyv8Al283fv3/AO2uMbPfrXf/APDMv/U3f+U3/wC20fsy/wDM0/8Abp/7WrgPib8Mv+Fc/wBl/wDE3/tD7f5v/Lt5WzZs/wBts53+3Svf/hl8Mv8AhXP9qf8AE3/tD7f5X/Lt5WzZv/22znf7dK9Aooorz/4m/DL/AIWN/Zf/ABN/7P8AsHm/8u3m79+z/bXGNnv1rwD4ZfE3/hXP9qf8Sj+0Pt/lf8vPlbNm/wD2Gznf7dK7/wDZl/5mn/t0/wDa1egfDL4Zf8K5/tT/AIm/9ofb/K/5dvK2bN/+22c7/bpXgHwy+GX/AAsb+1P+Jv8A2f8AYPK/5dvN379/+2uMbPfrR8Tfhl/wrn+y/wDib/2h9v8AN/5dvK2bNn+22c7/AG6V3/7TX/Mrf9vf/tGuA+GXxN/4Vz/an/Eo/tD7f5X/AC8+Vs2b/wDYbOd/t0o+Jvwy/wCFc/2X/wATf+0Pt/m/8u3lbNmz/bbOd/t0r6/rz/4ZfDL/AIVz/an/ABN/7Q+3+V/y7eVs2b/9ts53+3Sj4ZfDL/hXP9qf8Tf+0Pt/lf8ALt5WzZv/ANts53+3SvP/ANmX/maf+3T/ANrV6B8Mvhl/wrn+1P8Aib/2h9v8r/l28rZs3/7bZzv9uleAfDL4m/8ACuf7U/4lH9ofb/K/5efK2bN/+w2c7/bpX1/RRXyB8Tfib/wsb+y/+JR/Z/2Dzf8Al583fv2f7C4xs9+td/8A8m5/9TD/AG7/ANunkeR/383bvO9sbe+ePAK+v/ib8Tf+Fc/2X/xKP7Q+3+b/AMvPlbNmz/YbOd/t0rz/APZl/wCZp/7dP/a1egfDL4Zf8K5/tT/ib/2h9v8AK/5dvK2bN/8AttnO/wBuleAfDL4m/wDCuf7U/wCJR/aH2/yv+Xnytmzf/sNnO/26V7/8Tfhl/wALG/sv/ib/ANn/AGDzf+Xbzd+/Z/trjGz3615/+zL/AMzT/wBun/tavoCiiivP/ib8Tf8AhXP9l/8AEo/tD7f5v/Lz5WzZs/2Gznf7dK8//wCTc/8AqYf7d/7dPI8j/v5u3ed7Y2988H/DMv8A1N3/AJTf/ttH/DMv/U3f+U3/AO214BXv/wDwzL/1N3/lN/8AttH/AA01/wBSj/5Uv/tVH/DMv/U3f+U3/wC214BXoHwy+GX/AAsb+1P+Jv8A2f8AYPK/5dvN379/+2uMbPfrXf8A7Mv/ADNP/bp/7Wr0D4ZfE3/hY39qf8Sj+z/sHlf8vPm79+//AGFxjZ79a8//AOGZf+pu/wDKb/8Aba4D4ZfDL/hY39qf8Tf+z/sHlf8ALt5u/fv/ANtcY2e/Wj4ZfDL/AIWN/an/ABN/7P8AsHlf8u3m79+//bXGNnv1r3/4m/DL/hY39l/8Tf8As/7B5v8Ay7ebv37P9tcY2e/WvP8A9mX/AJmn/t0/9rV9AV8//wDDMv8A1N3/AJTf/ttH/Jxn/Uvf2F/29+f5/wD3727fJ987u2OfQPib8Mv+Fjf2X/xN/wCz/sHm/wDLt5u/fs/21xjZ79a9Ar5A+Jvwy/4Vz/Zf/E3/ALQ+3+b/AMu3lbNmz/bbOd/t0o+Jvwy/4Vz/AGX/AMTf+0Pt/m/8u3lbNmz/AG2znf7dK9/+GXwy/wCFc/2p/wATf+0Pt/lf8u3lbNm//bbOd/t0rz//AJOM/wCpe/sL/t78/wA//v3t2+T753dscn7Mv/M0/wDbp/7Wr6Aooorz/wCGXwy/4Vz/AGp/xN/7Q+3+V/y7eVs2b/8AbbOd/t0rz/8A4Zl/6m7/AMpv/wBto/Zl/wCZp/7dP/a1H/Juf/Uw/wBu/wDbp5Hkf9/N27zvbG3vng/Zl/5mn/t0/wDa1H/Juf8A1MP9u/8Abp5Hkf8Afzdu872xt7544D4ZfDL/AIWN/an/ABN/7P8AsHlf8u3m79+//bXGNnv1o+GXwy/4WN/an/E3/s/7B5X/AC7ebv37/wDbXGNnv1o+JvxN/wCFjf2X/wASj+z/ALB5v/Lz5u/fs/2FxjZ79aPhl8Mv+Fjf2p/xN/7P+weV/wAu3m79+/8A21xjZ79a7/8A5OM/6l7+wv8At78/z/8Av3t2+T753dsc8B8Mvib/AMK5/tT/AIlH9ofb/K/5efK2bN/+w2c7/bpXv/xN+GX/AAsb+y/+Jv8A2f8AYPN/5dvN379n+2uMbPfrXn//AA01/wBSj/5Uv/tVegfDL4m/8LG/tT/iUf2f9g8r/l583fv3/wCwuMbPfrXn/wCzL/zNP/bp/wC1q4D4ZfE3/hXP9qf8Sj+0Pt/lf8vPlbNm/wD2Gznf7dKPib8Mv+Fc/wBl/wDE3/tD7f5v/Lt5WzZs/wBts53+3Su//Zl/5mn/ALdP/a1fQFef/E34Zf8ACxv7L/4m/wDZ/wBg83/l283fv2f7a4xs9+tef/8ADTX/AFKP/lS/+1VwHxN+GX/Cuf7L/wCJv/aH2/zf+XbytmzZ/ttnO/26V5/Xv/8AwzL/ANTd/wCU3/7bR/ybn/1MP9u/9unkeR/383bvO9sbe+eD9mX/AJmn/t0/9rV9AUUUV8AUV7//AMnGf9S9/YX/AG9+f5//AH727fJ987u2OfQPhl8Mv+Fc/wBqf8Tf+0Pt/lf8u3lbNm//AG2znf7dK8A+Jvwy/wCFc/2X/wATf+0Pt/m/8u3lbNmz/bbOd/t0rv8A9pr/AJlb/t7/APaNH/DMv/U3f+U3/wC20f8ADMv/AFN3/lN/+216B8Mvhl/wrn+1P+Jv/aH2/wAr/l28rZs3/wC22c7/AG6V5/8A8nGf9S9/YX/b35/n/wDfvbt8n3zu7Y59A+Jvwy/4WN/Zf/E3/s/7B5v/AC7ebv37P9tcY2e/WvQK+QPib8Tf+Fjf2X/xKP7P+web/wAvPm79+z/YXGNnv1o+Jvwy/wCFc/2X/wATf+0Pt/m/8u3lbNmz/bbOd/t0r3/4m/DL/hY39l/8Tf8As/7B5v8Ay7ebv37P9tcY2e/Wj4ZfE3/hY39qf8Sj+z/sHlf8vPm79+//AGFxjZ79a8//AOTjP+pe/sL/ALe/P8//AL97dvk++d3bHPoHxN+Jv/Cuf7L/AOJR/aH2/wA3/l58rZs2f7DZzv8AbpR8Mvhl/wAK5/tT/ib/ANofb/K/5dvK2bN/+22c7/bpXgHxN+GX/Cuf7L/4m/8AaH2/zf8Al28rZs2f7bZzv9uld/8A8My/9Td/5Tf/ALbXoHxN+Jv/AArn+y/+JR/aH2/zf+XnytmzZ/sNnO/26V5/+zL/AMzT/wBun/taj/k3P/qYf7d/7dPI8j/v5u3ed7Y2988fQFfP/wDybn/1MP8Abv8A26eR5H/fzdu872xt754+gKKKKK+AK+v/AIZfE3/hY39qf8Sj+z/sHlf8vPm79+//AGFxjZ79aPhl8Tf+Fjf2p/xKP7P+weV/y8+bv37/APYXGNnv1rwD4m/DL/hXP9l/8Tf+0Pt/m/8ALt5WzZs/22znf7dK9/8Ahl8Mv+Fc/wBqf8Tf+0Pt/lf8u3lbNm//AG2znf7dK8//AOGZf+pu/wDKb/8Aba8Ar6/+Jvwy/wCFjf2X/wATf+z/ALB5v/Lt5u/fs/21xjZ79aPib8Mv+Fjf2X/xN/7P+web/wAu3m79+z/bXGNnv1rz/wD4Zl/6m7/ym/8A22j/AJNz/wCph/t3/t08jyP+/m7d53tjb3zx6B8Mvhl/wrn+1P8Aib/2h9v8r/l28rZs3/7bZzv9ulHwy+GX/Cuf7U/4m/8AaH2/yv8Al28rZs3/AO22c7/bpXgHwy+Jv/Cuf7U/4lH9ofb/ACv+Xnytmzf/ALDZzv8AbpXv/wAMvib/AMLG/tT/AIlH9n/YPK/5efN379/+wuMbPfrXgHxN+GX/AArn+y/+Jv8A2h9v83/l28rZs2f7bZzv9uld/wD8NNf9Sj/5Uv8A7VX0BXyB8Mvhl/wsb+1P+Jv/AGf9g8r/AJdvN379/wDtrjGz3619f18//wDDTX/Uo/8AlS/+1V6B8Tfhl/wsb+y/+Jv/AGf9g83/AJdvN379n+2uMbPfrR8Mvib/AMLG/tT/AIlH9n/YPK/5efN379/+wuMbPfrR8Mvib/wsb+1P+JR/Z/2Dyv8Al583fv3/AOwuMbPfrR8Tfhl/wsb+y/8Aib/2f9g83/l283fv2f7a4xs9+tef/sy/8zT/ANun/taj9mX/AJmn/t0/9rV9AUUUV8//ALTX/Mrf9vf/ALRo/wCGZf8Aqbv/ACm//ba+gK+f/wDk3P8A6mH+3f8At08jyP8Av5u3ed7Y2988eAUV7/8A8NNf9Sj/AOVL/wC1Uf8AJuf/AFMP9u/9unkeR/383bvO9sbe+ePQPib8Mv8AhY39l/8AE3/s/wCweb/y7ebv37P9tcY2e/WvP/8Ak4z/AKl7+wv+3vz/AD/+/e3b5Pvnd2xzwHwy+Jv/AArn+1P+JR/aH2/yv+Xnytmzf/sNnO/26UfDL4Zf8LG/tT/ib/2f9g8r/l283fv3/wC2uMbPfrXv/wATfib/AMK5/sv/AIlH9ofb/N/5efK2bNn+w2c7/bpXn/7Mv/M0/wDbp/7Wr0D4ZfDL/hXP9qf8Tf8AtD7f5X/Lt5WzZv8A9ts53+3Sj4ZfDL/hXP8Aan/E3/tD7f5X/Lt5WzZv/wBts53+3SvAPib8Mv8AhXP9l/8AE3/tD7f5v/Lt5WzZs/22znf7dKPhl8Mv+Fjf2p/xN/7P+weV/wAu3m79+/8A21xjZ79a7/8AZl/5mn/t0/8Aa1cB8Mvib/wrn+1P+JR/aH2/yv8Al58rZs3/AOw2c7/bpR8Mvib/AMK5/tT/AIlH9ofb/K/5efK2bN/+w2c7/bpXf/8AJuf/AFMP9u/9unkeR/383bvO9sbe+eOA+Jvwy/4Vz/Zf/E3/ALQ+3+b/AMu3lbNmz/bbOd/t0o+GXxN/4Vz/AGp/xKP7Q+3+V/y8+Vs2b/8AYbOd/t0rv/8Ak3P/AKmH+3f+3TyPI/7+bt3ne2NvfPB/w01/1KP/AJUv/tVegfDL4m/8LG/tT/iUf2f9g8r/AJefN379/wDsLjGz3616BRRRRXyB8Tfhl/wrn+y/+Jv/AGh9v83/AJdvK2bNn+22c7/bpR8Mvib/AMK5/tT/AIlH9ofb/K/5efK2bN/+w2c7/bpXv/wy+GX/AArn+1P+Jv8A2h9v8r/l28rZs3/7bZzv9ulHxN+GX/Cxv7L/AOJv/Z/2Dzf+Xbzd+/Z/trjGz3615/8A8My/9Td/5Tf/ALbXoHxN+Jv/AArn+y/+JR/aH2/zf+XnytmzZ/sNnO/26V4B8Mvhl/wsb+1P+Jv/AGf9g8r/AJdvN379/wDtrjGz3617/wDDL4m/8LG/tT/iUf2f9g8r/l583fv3/wCwuMbPfrXgHxN+Jv8Awsb+y/8AiUf2f9g83/l583fv2f7C4xs9+te//DL4m/8ACxv7U/4lH9n/AGDyv+Xnzd+/f/sLjGz3614B8Tfhl/wrn+y/+Jv/AGh9v83/AJdvK2bNn+22c7/bpXv/AMTfhl/wsb+y/wDib/2f9g83/l283fv2f7a4xs9+tegV5/8AE34Zf8LG/sv/AIm/9n/YPN/5dvN379n+2uMbPfrR8Tfib/wrn+y/+JR/aH2/zf8Al58rZs2f7DZzv9ulef8A/Jxn/Uvf2F/29+f5/wD3727fJ987u2OfAK9A+GXxN/4Vz/an/Eo/tD7f5X/Lz5WzZv8A9hs53+3Svf8A4m/E3/hXP9l/8Sj+0Pt/m/8ALz5WzZs/2Gznf7dKPhl8Mv8AhXP9qf8AE3/tD7f5X/Lt5WzZv/22znf7dK9Ar5A+JvxN/wCFjf2X/wASj+z/ALB5v/Lz5u/fs/2FxjZ79aPhl8Mv+Fjf2p/xN/7P+weV/wAu3m79+/8A21xjZ79a9/8Aib8Tf+Fc/wBl/wDEo/tD7f5v/Lz5WzZs/wBhs53+3SvQK8/+GXwy/wCFc/2p/wATf+0Pt/lf8u3lbNm//bbOd/t0r0CiiivkD4ZfE3/hXP8Aan/Eo/tD7f5X/Lz5WzZv/wBhs53+3Su//wCGZf8Aqbv/ACm//ba+gK8/+GXwy/4Vz/an/E3/ALQ+3+V/y7eVs2b/APbbOd/t0rz/AP4Zl/6m7/ym/wD22vQPib8Tf+Fc/wBl/wDEo/tD7f5v/Lz5WzZs/wBhs53+3SvQK8/+Jvwy/wCFjf2X/wATf+z/ALB5v/Lt5u/fs/21xjZ79a8//Zl/5mn/ALdP/a1cB8Tfib/wsb+y/wDiUf2f9g83/l583fv2f7C4xs9+te//AAy+GX/Cuf7U/wCJv/aH2/yv+Xbytmzf/ttnO/26UfE34m/8K5/sv/iUf2h9v83/AJefK2bNn+w2c7/bpR8Tfhl/wsb+y/8Aib/2f9g83/l283fv2f7a4xs9+tef/wDJuf8A1MP9u/8Abp5Hkf8Afzdu872xt754P+TjP+pe/sL/ALe/P8//AL97dvk++d3bHPoHwy+GX/Cuf7U/4m/9ofb/ACv+Xbytmzf/ALbZzv8AbpR8Mvhl/wAK5/tT/ib/ANofb/K/5dvK2bN/+22c7/bpXn//AAzL/wBTd/5Tf/tteAUV9f8AxN+Jv/Cuf7L/AOJR/aH2/wA3/l58rZs2f7DZzv8AbpXgHxN+Jv8Awsb+y/8AiUf2f9g83/l583fv2f7C4xs9+tfX9FfIHwy+Jv8Awrn+1P8AiUf2h9v8r/l58rZs3/7DZzv9ulHwy+Jv/Cuf7U/4lH9ofb/K/wCXnytmzf8A7DZzv9ule/8Awy+Jv/Cxv7U/4lH9n/YPK/5efN379/8AsLjGz3616BRRRXyB8Tfhl/wrn+y/+Jv/AGh9v83/AJdvK2bNn+22c7/bpXf/APJxn/Uvf2F/29+f5/8A3727fJ987u2OT/hmX/qbv/Kb/wDbaP8Ak3P/AKmH+3f+3TyPI/7+bt3ne2NvfPB/wzL/ANTd/wCU3/7bR+01/wAyt/29/wDtGj9mX/maf+3T/wBrV6B8Mvhl/wAK5/tT/ib/ANofb/K/5dvK2bN/+22c7/bpXn//AAzL/wBTd/5Tf/ttH/Juf/Uw/wBu/wDbp5Hkf9/N27zvbG3vnjgPhl8Mv+Fjf2p/xN/7P+weV/y7ebv37/8AbXGNnv1r3/4ZfDL/AIVz/an/ABN/7Q+3+V/y7eVs2b/9ts53+3SvP/2Zf+Zp/wC3T/2tXoHxN+GX/Cxv7L/4m/8AZ/2Dzf8Al283fv2f7a4xs9+tef8A/Jxn/Uvf2F/29+f5/wD3727fJ987u2OfQPib8Mv+Fjf2X/xN/wCz/sHm/wDLt5u/fs/21xjZ79a8/wD+Gmv+pR/8qX/2quA+JvxN/wCFjf2X/wASj+z/ALB5v/Lz5u/fs/2FxjZ79a9/+Jvwy/4WN/Zf/E3/ALP+web/AMu3m79+z/bXGNnv1rwD4m/DL/hXP9l/8Tf+0Pt/m/8ALt5WzZs/22znf7dKPib8Mv8AhXP9l/8AE3/tD7f5v/Lt5WzZs/22znf7dK9/+JvxN/4Vz/Zf/Eo/tD7f5v8Ay8+Vs2bP9hs53+3SvP8A9pr/AJlb/t7/APaNH/Juf/Uw/wBu/wDbp5Hkf9/N27zvbG3vng/Zl/5mn/t0/wDa1eAV7/8Asy/8zT/26f8AtavoCiiiivP/AIm/DL/hY39l/wDE3/s/7B5v/Lt5u/fs/wBtcY2e/WvQK8/+GXwy/wCFc/2p/wATf+0Pt/lf8u3lbNm//bbOd/t0o+GXxN/4WN/an/Eo/s/7B5X/AC8+bv37/wDYXGNnv1o+Jvwy/wCFjf2X/wATf+z/ALB5v/Lt5u/fs/21xjZ79a8//aa/5lb/ALe//aNH/Jxn/Uvf2F/29+f5/wD3727fJ987u2OfAK9//wCTjP8AqXv7C/7e/P8AP/797dvk++d3bHJ/w01/1KP/AJUv/tVH/DMv/U3f+U3/AO21wHwy+GX/AAsb+1P+Jv8A2f8AYPK/5dvN379/+2uMbPfrXf8A/DMv/U3f+U3/AO214BXv/wC01/zK3/b3/wC0aP8Ak4z/AKl7+wv+3vz/AD/+/e3b5Pvnd2xyftNf8yt/29/+0a4D4ZfE3/hXP9qf8Sj+0Pt/lf8ALz5WzZv/ANhs53+3Svf/AIZfDL/hXP8Aan/E3/tD7f5X/Lt5WzZv/wBts53+3SvAPhl8Mv8AhY39qf8AE3/s/wCweV/y7ebv37/9tcY2e/Wu/wD+Tc/+ph/t3/t08jyP+/m7d53tjb3zxwHwy+GX/Cxv7U/4m/8AZ/2Dyv8Al283fv3/AO2uMbPfrXf/APDMv/U3f+U3/wC21wHwy+Jv/Cuf7U/4lH9ofb/K/wCXnytmzf8A7DZzv9ule/8AxN+Jv/Cuf7L/AOJR/aH2/wA3/l58rZs2f7DZzv8AbpR8Mvib/wALG/tT/iUf2f8AYPK/5efN379/+wuMbPfrXoFFFFfIHwy+GX/Cxv7U/wCJv/Z/2Dyv+Xbzd+/f/trjGz3613//AAzL/wBTd/5Tf/ttH/DMv/U3f+U3/wC20fsy/wDM0/8Abp/7Wo/5OM/6l7+wv+3vz/P/AO/e3b5Pvnd2xyf8NNf9Sj/5Uv8A7VXAfDL4m/8ACuf7U/4lH9ofb/K/5efK2bN/+w2c7/bpR8Mvhl/wsb+1P+Jv/Z/2Dyv+Xbzd+/f/ALa4xs9+td//AMNNf9Sj/wCVL/7VR/ybn/1MP9u/9unkeR/383bvO9sbe+ePAK9//Zl/5mn/ALdP/a1H7Mv/ADNP/bp/7Wr0D4ZfDL/hXP8Aan/E3/tD7f5X/Lt5WzZv/wBts53+3SvAPhl8Mv8AhY39qf8AE3/s/wCweV/y7ebv37/9tcY2e/WvP69//Zl/5mn/ALdP/a1H7Mv/ADNP/bp/7Wo/aa/5lb/t7/8AaNegfDL4m/8ACxv7U/4lH9n/AGDyv+Xnzd+/f/sLjGz3615/+zL/AMzT/wBun/taj/k3P/qYf7d/7dPI8j/v5u3ed7Y2988H7Mv/ADNP/bp/7Wr0D4ZfDL/hXP8Aan/E3/tD7f5X/Lt5WzZv/wBts53+3SvkCvQPhl8Mv+Fjf2p/xN/7P+weV/y7ebv37/8AbXGNnv1r3/4ZfE3/AIWN/an/ABKP7P8AsHlf8vPm79+//YXGNnv1r0Ciiivn/wDZl/5mn/t0/wDa1eAV7/8Asy/8zT/26f8Ataj9mX/maf8At0/9rUf8nGf9S9/YX/b35/n/APfvbt8n3zu7Y59A+GXxN/4WN/an/Eo/s/7B5X/Lz5u/fv8A9hcY2e/WvP8A/hpr/qUf/Kl/9qrgPhl8Mv8AhY39qf8AE3/s/wCweV/y7ebv37/9tcY2e/WvP6+v/hl8Mv8AhXP9qf8AE3/tD7f5X/Lt5WzZv/22znf7dK8//aa/5lb/ALe//aNegfDL4m/8LG/tT/iUf2f9g8r/AJefN379/wDsLjGz3615/wD8My/9Td/5Tf8A7bR/wzL/ANTd/wCU3/7bXAfDL4Zf8LG/tT/ib/2f9g8r/l283fv3/wC2uMbPfrXv/wATfhl/wsb+y/8Aib/2f9g83/l283fv2f7a4xs9+tHwy+Jv/Cxv7U/4lH9n/YPK/wCXnzd+/f8A7C4xs9+tef8A/Juf/Uw/27/26eR5H/fzdu872xt7544D4m/DL/hXP9l/8Tf+0Pt/m/8ALt5WzZs/22znf7dK7/8A5Nz/AOph/t3/ALdPI8j/AL+bt3ne2NvfPHAfDL4m/wDCuf7U/wCJR/aH2/yv+Xnytmzf/sNnO/26V7/8Mvhl/wAK5/tT/ib/ANofb/K/5dvK2bN/+22c7/bpXgHxN+GX/Cuf7L/4m/8AaH2/zf8Al28rZs2f7bZzv9ulef0V9f8Awy+Jv/Cxv7U/4lH9n/YPK/5efN379/8AsLjGz3615/8Asy/8zT/26f8AtavoCiiivn/9mX/maf8At0/9rUf8My/9Td/5Tf8A7bXoHwy+GX/Cuf7U/wCJv/aH2/yv+Xbytmzf/ttnO/26V5/+zL/zNP8A26f+1q9A+Jvwy/4WN/Zf/E3/ALP+web/AMu3m79+z/bXGNnv1r0CvgCvr/4m/DL/AIWN/Zf/ABN/7P8AsHm/8u3m79+z/bXGNnv1o+JvxN/4Vz/Zf/Eo/tD7f5v/AC8+Vs2bP9hs53+3Sj4ZfDL/AIVz/an/ABN/7Q+3+V/y7eVs2b/9ts53+3SvP/2mv+ZW/wC3v/2jR/wzL/1N3/lN/wDttcB8Mvib/wAK5/tT/iUf2h9v8r/l58rZs3/7DZzv9ule/wDwy+GX/Cuf7U/4m/8AaH2/yv8Al28rZs3/AO22c7/bpR8Tfib/AMK5/sv/AIlH9ofb/N/5efK2bNn+w2c7/bpR8Tfhl/wsb+y/+Jv/AGf9g83/AJdvN379n+2uMbPfrXgHwy+Jv/Cuf7U/4lH9ofb/ACv+Xnytmzf/ALDZzv8AbpR8Mvhl/wALG/tT/ib/ANn/AGDyv+Xbzd+/f/trjGz3617/APDL4Zf8K5/tT/ib/wBofb/K/wCXbytmzf8A7bZzv9ulef8A/DMv/U3f+U3/AO21wHwy+Jv/AArn+1P+JR/aH2/yv+Xnytmzf/sNnO/26V3/AO01/wAyt/29/wDtGuA+GXxN/wCFc/2p/wASj+0Pt/lf8vPlbNm//YbOd/t0r3/4m/E3/hXP9l/8Sj+0Pt/m/wDLz5WzZs/2Gznf7dK8/wD2Zf8Amaf+3T/2tXAfE34Zf8K5/sv/AIm/9ofb/N/5dvK2bNn+22c7/bpXv/wy+GX/AArn+1P+Jv8A2h9v8r/l28rZs3/7bZzv9ulegUUUV8//APDMv/U3f+U3/wC20f8ADMv/AFN3/lN/+20f8My/9Td/5Tf/ALbXoHwy+GX/AArn+1P+Jv8A2h9v8r/l28rZs3/7bZzv9ulef/8ADMv/AFN3/lN/+20f8My/9Td/5Tf/ALbR/wAMy/8AU3f+U3/7bX0BXn/xN+GX/Cxv7L/4m/8AZ/2Dzf8Al283fv2f7a4xs9+tef8A/DMv/U3f+U3/AO216B8Mvhl/wrn+1P8Aib/2h9v8r/l28rZs3/7bZzv9ulHxN+GX/Cxv7L/4m/8AZ/2Dzf8Al283fv2f7a4xs9+tHwy+GX/Cuf7U/wCJv/aH2/yv+Xbytmzf/ttnO/26V6BXn/xN+GX/AAsb+y/+Jv8A2f8AYPN/5dvN379n+2uMbPfrR8Mvhl/wrn+1P+Jv/aH2/wAr/l28rZs3/wC22c7/AG6V5/8A8My/9Td/5Tf/ALbXoHwy+GX/AArn+1P+Jv8A2h9v8r/l28rZs3/7bZzv9ulef/8ADMv/AFN3/lN/+20f8My/9Td/5Tf/ALbXoHxN+GX/AAsb+y/+Jv8A2f8AYPN/5dvN379n+2uMbPfrR8Mvhl/wrn+1P+Jv/aH2/wAr/l28rZs3/wC22c7/AG6UfE34Zf8ACxv7L/4m/wDZ/wBg83/l283fv2f7a4xs9+tegV5/8Mvhl/wrn+1P+Jv/AGh9v8r/AJdvK2bN/wDttnO/26UfE34Zf8LG/sv/AIm/9n/YPN/5dvN379n+2uMbPfrXoFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFf/2Q=="
  }
}
```

### Response Body Params

| Campo                   | Tipo   | Descrição                                                                         | Caracteres |
|-------------------------|--------|-----------------------------------------------------------------------------------|------------|
| `request_control_key` * | uuidv4 | Chave única de identificação da request utilizada pelo cliente no formato uuid v4 | 36         |
| `bank_slip_key` *       | uuidv4 | Chave única de identificação do boleto no formato uuid v4                         | 36         |
| `bank_slip_status` *    | string | Status do boleto       | **[Enumeradores bank_slip_status](#enumeradores-bank_slip_status)**   |
| `our_number` *          | integer| Número único de identificação do boleto junto à carteira                          | 11         |
| `barcode` *             | string | Código de barras do boleto                                                        | 44         |
| `digitable_line` *      | string | Linha digitável do boleto                                                         | 47         |
| `qr_code_data`          | object | Dados do QR Code                             | **[Objeto qr_code_data](#objeto-qr_code_data)** |
| `created_at` *          | string | Data, no formato ISO (UTC - "YYYY-MM-DDTHH:MM:SSZ"), da criação da ocorrência     | 20         |

### Enumeradores bank_slip_status

| Enumerador         | Descrição                               |
|--------------------|-----------------------------------------|
| accepted           | Boleto aceito mas ainda não registrado  |

### Objeto qr_code_data
| Campo                      | Tipo   | Descrição                                             | Caracteres              |
|----------------------------|--------|-------------------------------------------------------|-------------------------|
| `qr_code_key`              | uuidv4 | Chave única de identificação do QR Code               | 36                      |
| `pix_key`                  | uuidv4 | Chave PIX vinculada ao QR Code                        | 36                      |
| `receiver_conciliation_id` | uuidv4 | Identificador de conciliação do QR Code               | 36                      |
| `url`                      | string | URL (Pix Copia e Cola) do QR Code                     | -                       |
| `image`                    | string | base64 da URL (Pix Copia e Cola) do QR Code           | -                       |

## Error Response

STATUS 4xx

Response Body: Error

```json
{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}
```

| Código HTTP<br/>`status` | Código QI<br/>`code` | Título<br/>`title`                                 | Descrição (eng)<br/>`description`                                                                                       | Descrição (pt-br)<br/>`translation`                                                                                     |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 400                      | QIT000001            | Bad Request                                        | Schema Error                                                                                                            | Schema Inválido                                                                                                         |
| 404                      | BKS000004            | Not Found | Pix key not found: `{pix_key}`                                               | Chave pix não encontrada: `{pix_key}`                                               |
| 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.                                                                 |
| 403                      | BKS000010            | Forbidden                                 | The pix key owner does not match the account owner.                                                                                     | O proprietário da chave pix não corresponde ao proprietário da conta.                                                             |
| 404                      | BKS000013            | Not Found | Requester profile not found         |               Carteira não encontrada                                                                 |
| 409                      | BKS000014            | Conflict           | Request control key already sent or duplicated sent: `{request_control_key}`                                                              | Chave de controle da requisição já utilizada ou enviada duplicada: `{request_control_key}`                                                                        |
| 400                      | BKS000016            | Bad Request                                        | Expiration date must be greater than the current date and have a maximum of 3650 days from the current date.                                    | A data de vencimento deve ser maior que a data atual e possuir no máximo 3650 dias corridos a partir da data atual.                                     |
| 409                      | BKS000017            | Conflict                                        | Our number already used or duplicated sent: `{our_number}`                                                                                       | Nosso número já utilizado ou enviado duplicado: `{our_number}`                                                                               |
| 400                      | BKS000018            | Bad Request                                        | The discount dates must be less than the expiration date and increasing.                                                      | A data dos descontos devem ser menores que a de expiração e crescentes.                                               |
| 400                      | BKS000019            | Bad Request                                        | Payer address is required for protest.                                                                                       | Endereço do pagador é obrigatório para protesto.                                                                         |
| 500                      | BKS000021            | Internal Server Error                                  | Error while trying to generate QR Code.                                                               | Erro ao tentar gerar QR Code de pagamento.                                                           |
| 400                      | BKS000022            | Bad Request                                        | Requester profile is not opened.                                                              | Carteira não está aberta.                          |
| 400                      | BKS000026            | Bad Request                      | Guarantor address is required for protest.                                                                                        | Endereço do sacador é obrigatório para protesto.                                                                   |
| 404                      | BKS000028            | Not Found             | Notary office attended region not found for postal code: `{postal_code}`                                                          | Região de cartório não encontrada para o CEP: `{postal_code}`                                                                                 |
| 400                      | BKS000043            | Bad Request             | Invalid discount numbering. Discounts must be numbered in ascending order and start on 1.          | Numeração dos descontos inválida. Os descontos devem ser numerados em ordem crescente e começar em 1.                                                           |
| 400                      | BKS000045            | Bad Request                                        | Rebate amount can not be equal or greater than the bank slip amount.                                                              | O valor do rebate não pode ser igual ou maior do que o valor do boleto.                          |
| 400                      | BKS000047            | Bad Request             | It was not possible to consult the sent pix key at this time. Please try again in a few minutes.          | Não foi possível consultar a chave pix enviada no momento. Por favor, tente novamente em alguns minutos.                                                           |
| 400                      | BKS000125            | Bad Request             | Partial payment data is required for this bank slip species type.          | Os dados de pagamento parcial são obrigatórios para o tipo de boleto fornecido.                                                           |
| 400                      | BKS000128            | Bad Request             | QR code payment is not allowed for partial payment.          | Pagamento via QR code não é permitido para pagamento parcial.                                                           |
| 400                      | BKS000128            | Bad Request             | QR code payment is not allowed for partial payment.          | Pagamento via QR code não é permitido para pagamento parcial.                                                           |
| 400                      | BKS000131            | Bad Request             | Rebate amount is not allowed for this bank slip species type.          | O valor de abatimento não é permitido para o tipo de boleto fornecido.                                                           |
| 400                      | BKS000132            | Bad Request             | Discount data is not allowed for this bank slip species type.          | Os dados de desconto não são permitidos para o tipo de boleto fornecido.                                                           |
| 400                      | BKS000133            | Bad Request             | Fine data is not allowed for this bank slip species type.          | Os dados de multa não são permitidos para o tipo de boleto fornecido.                                                           |
| 400                      | BKS000134            | Bad Request             | Interest data is not allowed for this bank slip species type.          | Os dados de juros não são permitidos para o tipo de boleto fornecido.                                                           |
| 400                      | BKS000136            | Bad Request             | Only credit card financial instrument type can have zero amount.          | Apenas o tipo de instrumento financeiro cartão de crédito pode ter valor zero.                                                           |

---

# Emissão de boletos em lote

URL: /en/documentation/boletos/emissao/emissao_em_lote

:::danger Importante
Para registrar bolePix, é necessário que exista uma chave Pix aleatória ativa na conta em que os boletos serão registrados.
:::

A emissão de boletos em lote é feita somente de maneira assíncrona. Caso um dos boletos falhe na validação das informações fornecidas, nenhum dos boletos será registrado nessa mesma requisição.

:::caution Atenção!
Como tratam-se de um registros assíncronos, o solicitante é notificado via [**webhook**](/documentation/boletos/v2/webhooks/boleto) assim que cada um dos boletos mudar de status de `accepted` para `registered` ou `rejected`.
:::

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/batch
MÉTODO POST

### Path parameters

| Campo                   | Tipo   | Descrição                                                    | Caracteres |
|-------------------------|--------|--------------------------------------------------------------|------------|
| `account_key`           | uuidv4 | Chave única de identificação da conta, no formato uuid v4    | 36         |
| `requester_profile_key` | uuidv4 | Chave única de identificação da carteira, no formato uuid v4 | 36         |

Request Body

```json
{
  "bank_slips": [
    {
      "request_control_key": "c86d8902-a5ae-4d1f-8872-e6fea1268aab",
      "our_number": 123456789,
      "document_number": "DOC4561237",
      "amount": 5000.00,
      "expiration": "2025-01-01",
      "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.00, "days_to_fine": 10},
      "interest_data": {
        "interest_type": "workdays_daily_amount",
        "interest_amount": 10.00,
        "days_to_interest": 2,
      },
      "financial_instrument_type": "digital_commercial_invoice",
      "write_off_data": {"days_to_write_off": 365},
      "rebate_amount": 200.00,
      "discounts_data": [
        {
          "discount_amount": 50.00,
          "discount_number": 1,
          "discount_type": "absolute",
          "discount_limit_date": "2025-01-01",
        }
      ],
      "payer_data": {
        "name": "Global Tech",
        "contact": {
          "email": "finance@globaltech.com",
          "phone": {"country_code": "055", "area_code": "11", "number": "987654321"},
        },
        "address": {
          "street": "101 High St.",
          "neighborhood": "Tech Park",
          "number": "202",
          "postal_code": "49069234",
          "city": "Innovation City",
          "state": "SP",
          "complement": "Building A",
        },
        "document_number": "12345678000195",
        "person_type": "legal",
      },
      "guarantor_data": {
        "name": "Jane Doe",
        "contact": {
          "email": "jane.doe@qitech.com.br",
          "phone": {"country_code": "055", "area_code": "11", "number": "999999999"},
        },
        "address": {
          "street": "202 Elm St.",
          "neighborhood": "Quiet Neighborhood",
          "number": "303",
          "postal_code": "35700854",
          "city": "Peaceful Town",
          "state": "RJ",
          "complement": "House 1",
        },
        "document_number": "23456789012",
        "person_type": "natural",
      },
      "pix_key": "78252991-d26d-4d6b-8c50-be3233ffabf7",
      "notification": {
        "document_number": "12345678000195",
        "name": "Global Tech",
        "email": "finance@globaltech.com",
        "phone": {"country_code": "055", "area_code": "11", "number": "987654321"},
        "send_2_way": true,
        "send_before_due_date": true,
        "send_after_due_date": true,
        "send_on_protest": true
      }
    },
    {
      "request_control_key": "b3a428fd-58ee-4d6f-8872-633874ebf5e2",
      "our_number": 987654321,
      "document_number": "DOC4561237",
      "amount": 5000.00,
      "expiration": "2025-01-01",
      "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.00, "days_to_fine": 10},
      "interest_data": {
        "interest_type": "workdays_daily_amount",
        "interest_amount": 10.00,
        "days_to_interest": 2
      },
      "financial_instrument_type": "digital_commercial_invoice",
      "write_off_data": {"days_to_write_off": 365},
      "rebate_amount": 200.00,
      "discounts_data": [
        {
          "discount_amount": 50.00,
          "discount_number": 1,
          "discount_type": "absolute",
          "discount_limit_date": "2025-01-01"
        }
      ],
      "payer_data": {
        "name": "Global Tech",
        "contact": {
          "email": "finance@globaltech.com",
          "phone": {"country_code": "055", "area_code": "11", "number": "987654321"},
        },
        "address": {
          "street": "101 High St.",
          "neighborhood": "Tech Park",
          "number": "202",
          "postal_code": "79071231",
          "city": "Innovation City",
          "state": "SP",
          "complement": "Building A"
        },
        "document_number": "12345678000195",
        "person_type": "legal"
      },
      "guarantor_data": {
        "name": "Jane Doe",
        "contact": {
          "email": "jane.doe@qitech.com.br",
          "phone": {"country_code": "055", "area_code": "11", "number": "999999999"},
        },
        "address": {
          "street": "202 Elm St.",
          "neighborhood": "Quiet Neighborhood",
          "number": "303",
          "postal_code": "65066380",
          "city": "Peaceful Town",
          "state": "RJ",
          "complement": "House 1"
        },
        "document_number": "23456789012",
        "person_type": "natural"
      }
    }
  ]
}
```

### Request Body Params

| Campo            | Tipo          | Descrição                             | Caracteres                                |
|------------------|---------------|---------------------------------------|-------------------------------------------|
| `bank_slips` *   | Array de **[Objeto bank_slip](#objeto-bank_slip)**  | Lista de boletos a serem registrados  | - |

### Objeto bank_slip

| Campo                      | Tipo    | Descrição                                                                          | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `request_control_key` *    | uuidv4  | Chave única de identificação da request utilizada pelo cliente no formato uuid v4  | 36                                                |
| `our_number`               | integer | Número único de identificação do boleto junto à carteira. Pode ser enviado pelo cliente e, caso não seja, a QI Tech irá gerar um                           | 11                                                |
| `document_number`          | string  | Número de identificação do boleto                                                  | 10                                                |
| `participant_control_number` | string | Nº Controle do Participante                                                       |
25                                                |
| `amount` *                 | float   | Valor base do boleto                                                               | -                                                 |
| `expiration` *             | string  | Data de vencimento                                                                 | 10                                                |
| `bank_teller_instructions` | string  | Instruções adicionais de registro, que constarão no PDF do boleto. Aceita no máximo 320 caracteres, distribuídos em até 7 linhas. Cada linha pode conter no máximo 90 caracteres. Caso uma linha ultrapasse 90 caracteres, o texto será automaticamente quebrado em uma nova linha | 320                                               |
| `rebate_amount`            | float   | Valor de abatimento do boleto, que será aplicado em cima do valor base             | -                                                 |
| `max_payment_days`         | integer | Máximo de dias corridos que o boleto ficará disponível para pagamento, após o vencimento (pode ser no máximo 365) | -          |
| `financial_instrument_type`   | string  | Tipo de espécie do boleto | **[Enumeradores financial_instrument_type](#enumeradores-financial_instrument_type)** |
| `partial_payment_data`    | object  | Configurações de pagamento parcial                      | **[Objeto partial_payment_data](#objeto-partial_payment_data)** |
| `write_off_data`       | object  | Configuração de baixa      | **[Objeto write_off_data](#objeto-write_off_settings)** |
| `protest_data`         | object  | Configuração de protesto       | **[Objeto protest_data](#objeto-protest_settings)** |
| `bankruptcy_protest_data` | object  | Configuração de protesto falimentar | **[Objeto bankruptcy_protest_data](#objeto-bankruptcy_protest_settings)** |
| `fine_data`            | object  | Configuração de multa                 | **[Objeto fine_data](#objeto-fine_settings)** |
| `interest_data`        | object  | Configuração de juros        | **[Objeto interest_data](#objeto-interest_settings)** |
| `discounts_data`           | object array | Descontos           | **[Objeto discount](#objeto-discounts_data)** |
| `payer_data` *             | object  | Dados do pagador                                                                   | **[Objeto payer_data](#objetos-payer_data-e-guarantor_data)** |
| `guarantor_data`           | object  | Dados do sacador avalista                                                          | **[Objeto guarantor_data](#objetos-payer_data-e-guarantor_data)** |
| `pix_key`                  | uuidv4  | Chave pix do tipo aleatória                                                        | 36                                                |

:::info BolePix
Caso o parâmetro `pix_key`, opcional, seja enviado na request, será gerado um bolePix. BolePix é um boleto cujo pagamento é vinculado a um QR Code Pix. Sendo assim, o pagador pode realizar o pagamento do boleto tanto utilizando a linha digitável do mesmo, quanto através da leitura do QR Code Pix vinculado. Caso o pagamento seja feito via QR Code, a liquidação financeira se dá instantaneamente, enquanto os retornos bancários e webhooks envolvidos na liquidação serão gerados assim como é feito para um boleto comum.

Importante: para registrar um bolePix, é necessário que exista uma chave Pix aleatória ativa na conta em que boleto será registrado.
:::

:::tip Configurações Padrão da Carteira
Caso cada um dos campos `max_payment_days`, `write_off_data`, `protest_data`, `bankruptcy_protest_data`, `fine_data`, `interest_data` e `pix_key` não sejam enviados na request e a carteira possua configurações padrão (i.e. `max_payment_days`, `write_off_settings`, `protest_settings`, `bankruptcy_protest_settings`, `fine_settings`, `interest_settings` e `qr_code_settings`, respectivamente, no `configuration_data` do `requester_profile`), serão utilizadas tais configurações padrão para a emissão do título.
:::

:::caution Limitações e Restrições
- **Boletos de Pagamento Parcial:** Não é permitido o pagamento via QR Code Pix. Portanto, não é permitido enviar a `pix_key` no registro, nem ter uma configuração padrão de geração de bolePix para a carteira.

- **Boletos de Cartão de Crédito:** Não é necessário nem permitido enviar informações rebate, desconto, multa e juros. Isso se deve ao padrão do mercado, onde muitas Instituições Financeiras não aceitam o pagamento de boletos de cartão de crédito que contenham essas informações. A carteira também não pode ter essas configurações definidas como padrão. Sendo assim boletos desse tipo podem ser pagos parcialmente mesmo após o vencimento, sem incidência de juros, multas, descontos ou abatimentos na fatura corrente. Para aplicar esses valores é necessário incluí-los na próxima fatura, seja através da [ocorrência de edição de valor](/documentation/boletos/instrucoes/valor) do boleto ou emitindo um novo boleto que inclua esses valores. É possível enviar `amount = 0` para boletos deste tipo.

**Importante:** Boletos do tipo `credit_card` são obrigatoriamente de pagamento parcial, sendo assim é necessário fornecer as informações de `partial_payment_data` ou ter essa configuração padrão na carteira. Caso o campo `financial_instrument_type` não seja enviado, o valor padrão será `digital_commercial_invoice`.
:::

:::tip Recomendações de Carteiras
- **Carteira para Boletos Padrão:** Mantenha as configurações padrão para multas, juros e protesto
- **Carteira para Boletos de Pagamento Parcial:** Sem configuração de Pix e com regras específicas para pagamento parcial
- **Carteira para Boletos de Cartão de Crédito:** Sem configurações de multa, juros, desconto ou rebate

Criar carteiras específicas garante que as configurações padrão sejam adequadas para cada tipo de boleto e evita conflitos nas regras de negócio.
:::

:::info Máquina de Estados
A máquina de status para boletos de pagamento parcial possui algumas diferenças. Para mais detalhes, consulte a [introdução](/documentation/boletos/introducao) , onde há uma explicação sobre como aplicar a incidência de juros e multas no boleto seguindo as boas práticas do mercado.
:::

### Enumeradores financial_instrument_type

| Enumerador  | Descrição                        |
|-------------|----------------------------------|
| digital_commercial_invoice | DMI Duplicata Mercantil Indicação |
| credit_card | Cartão de Crédito |
| check | CH Cheque |
| digital_commercial | DM Duplicata Mercantil |
| digital_service_invoice | Duplicata de Serviço |
| digital_service_invoice_indication | DSI Duplicata de Serviço Indicação |
| digital_rural_invoice | DR Duplicata Rural |
| bill_of_exchange | LC Letra de Câmbio |
| commercial_credit_note | NCC Nota de Crédito Comercial |
| export_credit_note | NCE Nota de Crédito Exportação |
| industrial_credit_note | NCI Nota de Crédito Industrial |
| rural_credit_note | NCR Nota de Crédito Rural |
| promissory_note | NP Nota Promissória |
| rural_promissory_note | NPR Nota Promissória Rural |
| mercantile_triplicate | TM Triplicata Mercantil |
| service_triplicate | TS Triplicata de Serviço |
| insurance_note | NS Nota de Seguro |
| receipt | RC Recibo |
| printed_bank_slip | FAT Bloqueto |
| debit_note | ND Nota de Débito |
| insurance_policy | AP Apólice de Seguro |
| school_monthly_fee | ME Mensalidade Escolar |
| consortium_installment | PC Parcela de Consórcio |
| invoice | NF Nota Fiscal |
| debt_document | DD Documento de Dívida |
| rural_product_certificate | Cédula de Produto Rural |
| warrant | Warrant |
| state_active_debt | Dívida Ativa de Estado |
| municipal_active_debt | Dívida Ativa de Município |
| federal_active_debt | Dívida Ativa da União |
| condominium_charges | Encargos condominiais |
| proposal_bank_slip | Boleto proposta |
| deposit_and_contribution_bank_slip | Boleto de Depósito e Aporte |
| others | Outros |

### Objeto partial_payment_data

| Campo                             | Tipo    | Descrição                                                                 | Caracteres |
|-----------------------------------|---------|---------------------------------------------------------------------------|------------|
| `partial_payment_minimum_type` *  | string  | Tipo de valor mínimo para pagamento parcial                               | **[Enumeradores partial_payment_type](#enumeradores-partial_payment_type)** |
| `partial_payment_minimum_percentage` | float | Percentual mínimo permitido para o pagamento parcial                      | -          |
| `partial_payment_minimum_amount`  | float  | Valor mínimo permitido para o pagamento parcial                           | -          |
| `partial_payment_maximum_type`    | string  | Tipo de valor máximo para pagamento parcial                               | **[Enumeradores partial_payment_type](#enumeradores-partial_payment_type)** |
| `partial_payment_maximum_percentage` | float | Percentual máximo permitido para o pagamento parcial                      | -          |
| `partial_payment_maximum_amount`  | float  | Valor máximo permitido para o pagamento parcial                           | -          |
| `partial_payment_quantity` *      | integer | Quantidade de pagamentos parciais permitidos                              | -          |

:::caution Atenção!
De acordo com o valor enviado nos campos `partial_payment_minimum_type` e `partial_payment_maximum_type`, é necessário enviar o `partial_payment_minimum_amount` ou `partial_payment_minimum_percentage`, e o `partial_payment_maximum_amount` ou `partial_payment_maximum_percentage` correspondente.
:::

### Enumeradores partial_payment_type

| Enumerador  | Descrição                        |
|-------------|----------------------------------|
| absolute    | Valor absoluto                   |
| percentage  | Percentual                       |

### Objeto write_off_data

| Campo                     | Tipo    | Descrição                                                                   | Caracteres |
|---------------------------|---------|-----------------------------------------------------------------------------|------------|
| `days_to_write_off` *     | integer | Dias, após o vencimento, para que o boleto seja baixado automaticamente     | -          |

### Objeto protest_data

| Campo                     | Tipo    | Descrição                                                                   | Caracteres |
|---------------------------|---------|-----------------------------------------------------------------------------|------------|
| `days_to_protest` *       | integer | Dias, após o vencimento, para que o boleto seja protestado automaticamente  | -          |

### Objeto bankruptcy_protest_data

| Campo                          | Tipo    | Descrição                                                                   | Caracteres  |
|--------------------------------|---------|-----------------------------------------------------------------------------|------------|
| `days_to_bankruptcy_protest` * | integer | Dias, após o vencimento, para que o boleto seja protestado automaticamente  | -           |

### Objeto fine_data

Opção 1: multa em valor absoluto (`fine_type=absolute`)

| Campo                     | Tipo    | Descrição                                               | Caracteres                |
|---------------------------|---------|---------------------------------------------------------|-------------------------------------------------------------------------|
| `fine_type` *             | string  | Tipo da multa                                                       | **[Enumeradores fine_type](#enumeradores-fine_type)**                                              |
| `fine_amount` *           | float   | Valor absoluto da multa                                             | -                                                                        |
| `days_to_fine` *          | integer | Dias, após o vencimento, para que a multa seja cobrada              | -                                                                        |

Opção 2: multa em valor percentual (`fine_type=percentage`)

| Campo                     | Tipo    | Descrição                                                 | Caracteres                             |
|---------------------------|---------|-----------------------------------------------------------|---------------------------------------|
| `fine_type` *             | string  | Tipo da multa                                             | **[Enumeradores fine_type](#enumeradores-fine_type)** |
| `fine_percentage` *       | integer | Valor percentual da multa, de 1 a 100                     | -                                      |
| `days_to_fine` *          | integer | Dias, após o vencimento, para que a multa seja cobrada    | -                                      |

### Enumeradores fine_type

| Enumerador         | Descrição             |
|--------------------|-----------------------|
| absolute           | valor absoluto        |
| percentage         | valor percentual      |

### Objeto interest_data

Opção 1: juros utilizando valores absolutos (`interest_type=calendar_days_daily_amount` ou `interest_type=workdays_daily_amount`)

| Campo                     | Tipo    | Descrição                                                                     | Caracteres                                                                                      |
|---------------------------|---------|-------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
| `interest_type` *         | string  | Tipo de juros       | **[Enumeradores interest_type](#enumeradores-interest_type)** |
| `interest_amount` *       | float   | Valor a ser cobrado por unidade de tempo determinada (dias úteis ou corridos) | -                                                                                               |
| `days_to_interest` *      | integer | Dias, após o vencimento, para que comece a cobrar os juros                    | -                                                                                               |

Opção 2: juros utilizando valores percentuais (`interest_type=calendar_days_monthly_percentage`)

| Campo                    | Tipo    | Descrição                                                                             | Caracteres                                                                                          |
|--------------------------|---------|---------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------|
| `interest_type` *        | string  | Tipo de juros       | **[Enumeradores interest_type](#enumeradores-interest_type)** |
| `interest_percentage` *  | integer | Porcentagem a ser cobrada por unidade de tempo determinada (dias úteis ou corridos)                                                                      | -                                                                           |
| `days_to_interest` *     | integer | Dias, após o vencimento, para que comece a cobrar os juros                             | -                                                                                                   |

### Enumeradores interest_type

| Enumerador                       | Descrição                                                            |
|----------------------------------|----------------------------------------------------------------------|
| calendar_days_daily_amount       | Valor diário sobre dias corridos                                     |
| workdays_daily_amount            | Valor diário sobre dias úteis                                        |
| calendar_days_monthly_percentage | Porcentagem 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"]`)

| Campo                     | Tipo    | Descrição                                           | Caracteres                                                |
|---------------------------|---------|-----------------------------------------------------|-----------------------------------------------------------|
| `discount_amount` *       | float   | Valor absoluto de desconto por unidade de tempo                                            | -                                                          |
| `discount_number` *       | integer | Número do desconto                                     | -                                                         |
| `discount_type` *         | string  | Configuração do desconto em valores absolutos                                    | **[Enumerador discount_type](#enumeradores-discount_type)** |                                                       |
| `discount_limit_date` *   | string  | Data limite para aplicação do desconto   | 10                                                        |

Opção 2: descontos utilizando valores percentuais (`discount_type in ["percentage", "anticipation_calendar_days_daily_percentage", "anticipation_workdays_daily_percentage"]`)

| Campo                     | Tipo    | Descrição                                           | Caracteres                                                |
|---------------------------|---------|-----------------------------------------------------|-----------------------------------------------------------|
| `discount_percentage` *   | float   | Valor percentual de desconto por unidade de tempo                                            | -                                                          |
| `discount_number` *       | integer | Número do desconto                                     | -                                                         |
| `discount_type` *         | string  | Configuração do desconto em valores percentuais                                    | **[Enumerador discount_type](#enumeradores-discount_type)** |                                                       |
| `discount_limit_date` *   | string  | Data limite para aplicação do desconto   | 10                                                        |

:::caution 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

| Enumerador                                  | Descrição                                                                |
|---------------------------------------------|--------------------------------------------------------------------------|
| absolute                                    | Valor fixo                                                               |
| anticipation_calendar_days_daily_amount     | Valor diário de desconto de antecipação, sobre dias corridos             |
| anticipation_workdays_daily_amount          | Valor diário de desconto de antecipação, sobre dias úteis                |
| percentage                                  | Porcentagem fixa                                                         |
| anticipation_calendar_days_daily_percentage | Porcentagem mensal de desconto de antecipação, com base em dias corridos |
| anticipation_workdays_daily_percentage      | Porcentagem anual de desconto de antecipação, com base em dias úteis     |

### Objetos payer_data e guarantor_data

| Campo                     | Tipo   | Descrição                                                  | Caracteres|
|---------------------------|--------|-------------------------------------|-----------------------------------------------------------|
| `name` *                  | string | Nome completo                       | 100                                                       |
| `document_number` *       | string | Número do documento (CPF/CNPJ)      | 11 ou 14                                                  |
| `person_type` *           | string | Tipo da pessoa (física ou jurídica) | **[Enumeradores person_type](#enumeradores-person_type)** |
| `contact`                 | object | Informações de contato              | **[Objeto contact](#objeto-contact)**                     |
| `address`                 | object | Endereço                            | **[Objeto address](#objeto-address)**                     |

### Enumeradores person_type

| Enumerador         | Descrição             |
|--------------------|-----------------------|
| natural            | pessoa física         |
| legal              | pessoa jurídica       |

### Objeto contact

| Campo                     | Tipo   | Descrição                         | Caracteres                         |
|---------------------------|--------|-----------------------------------|------------------------------------|
| `email`                   | string | E-mail de contato                 | 320                                |
| `phone`                   | object | Telefone de contato               | **[Objeto phone](#objeto-phone)**  |

### Objeto phone

| Campo                           | Tipo   | Descrição                                    | Caracteres |
|---------------------------------|--------|----------------------------------------------|------------|
| `country_code` *     | string | Código DDI (Discagem Direta Internacional)   | 3          |
| `area_code` *                   | string | Código DDD (Discagem Direta à Distância)     | 2          |
| `number` *                      | string | Complemento                                  | 9          |

### Objeto address

| Campo                     | Tipo   | Descrição                                    | Caracteres |
|---------------------------|--------|----------------------------------------------|------------|
| `street` *                | string | Logradouro                                   | 500        |
| `number` *                | string | Número                                       | 6          |
| `complement`              | string | Complemento                                  | 500        |
| `neighborhood` *          | string | Bairro                                       | 100        |
| `postal_code` *           | string | CEP                                          | 8          |
| `city` *                  | string | Cidade                                       | 100        |
| `state` *                 | string | Estado (UF) | **[Enumerador state](#enumeradores-state)** |

### Enumeradores state

| Enumerador         | Descrição             |
|--------------------|-----------------------|
| 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                 | Exceção               |

### Objeto notification

| Campo                     | Tipo    | Descrição                                                                               | Caracteres |
|---------------------------|---------|-----------------------------------------------------------------------------------------|------------|
| `document_number` *       | string  | Número do documento de quem receberá as notificações (CPF/CNPJ)                         | 11 ou 14   |
| `name` *                  | string  | Nome de quem receberá as notificações                                                   | 100        |
| `email`                   | string  | E-mail para o qual serão enviadas as notificações                                       | 320        |
| `phone`                   | object  | Telefone de contato para o qual serão enviadas as notificações | **[Objeto phone](#objeto-phone)**   |
| `send_2_way` *            | boolean | Enviar segunda via                                                                      | -          |
| `send_before_due_date` *  | boolean | Enviar notificação ao pagador antes da data de vencimento                               | -          |
| `send_after_due_date` *   | boolean | Enviar notificação ao pagador quando o boleto vencer                                    | -          |
| `send_on_protest` *       | boolean | Enviar notificação ao entrar em fluxo de protesto                                       | -          |

## Response

STATUS 202

Response Body

```json
{
  "bank_slips": [
    {
      "request_control_key": "c86d8902-a5ae-4d1f-8872-e6fea1268aab",
      "bank_slip_key": "053c7074-c55c-49aa-b94d-629e8d2424cf",
      "bank_slip_status": "accepted",
      "our_number": 123456789,
      "barcode": "32992995900000892814549111682910713279164650",
      "digitable_line": "32994549121168291071332791646501299590000089281",
      "qr_code_data": {
        "qr_code_key": "0a6ffa83-63ec-438f-95be-76e1ab8329e5",
        "pix_key": "78252991-d26d-4d6b-8c50-be3233ffabf7",
        "receiver_conciliation_id": "01GVGV9NXBCY287Z6CJ4S0ENW9",
        "url": "00020126830014br.gov.bcb.pix2561qrcode.qitech.app/bacen/cobv/58fd5103a8e64bbbab2fd49b0bd580145204000053039865802BR5925GONNFUNDODEINVESTIMENTOEM6012RiodeJaneiro6107226401262070503***6304EA0D",
        "image": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/wAALCAD0APQBAREA/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/9oACAEBAAA/APf6KKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKKK+QPhl8Mv+Fjf2p/xN/wCz/sHlf8u3m79+/wD21xjZ79a7/wD4Zl/6m7/ym/8A22j/AIZl/wCpu/8AKb/9to/Zl/5mn/t0/wDa1egfE34Zf8LG/sv/AIm/9n/YPN/5dvN379n+2uMbPfrXgHwy+GX/AAsb+1P+Jv8A2f8AYPK/5dvN379/+2uMbPfrR8Tfib/wsb+y/wDiUf2f9g83/l583fv2f7C4xs9+td//AMm5/wDUw/27/wBunkeR/wB/N27zvbG3vnjwCvr/AOJvxN/4Vz/Zf/Eo/tD7f5v/AC8+Vs2bP9hs53+3SvkCvf8A9mX/AJmn/t0/9rUf8m5/9TD/AG7/ANunkeR/383bvO9sbe+ePQPhl8Mv+Fc/2p/xN/7Q+3+V/wAu3lbNm/8A22znf7dK8A+GXxN/4Vz/AGp/xKP7Q+3+V/y8+Vs2b/8AYbOd/t0o+GXxN/4Vz/an/Eo/tD7f5X/Lz5WzZv8A9hs53+3Svf8A4m/DL/hY39l/8Tf+z/sHm/8ALt5u/fs/21xjZ79a8/8A+GZf+pu/8pv/ANtr0D4ZfE3/AIWN/an/ABKP7P8AsHlf8vPm79+//YXGNnv1rwD4ZfE3/hXP9qf8Sj+0Pt/lf8vPlbNm/wD2Gznf7dK7/wD4aa/6lH/ypf8A2quA+GXxN/4Vz/an/Eo/tD7f5X/Lz5WzZv8A9hs53+3Svr+vkD4ZfDL/AIWN/an/ABN/7P8AsHlf8u3m79+//bXGNnv1rv8A/hmX/qbv/Kb/APbaP+GZf+pu/wDKb/8AbaP2Zf8Amaf+3T/2tX0BRRRXz/8Asy/8zT/26f8AtavAK9//AGZf+Zp/7dP/AGtR+zL/AMzT/wBun/tavQPib8Mv+Fjf2X/xN/7P+web/wAu3m79+z/bXGNnv1rz/wDZl/5mn/t0/wDa1cB8Mvib/wAK5/tT/iUf2h9v8r/l58rZs3/7DZzv9ule/wDwy+Jv/Cxv7U/4lH9n/YPK/wCXnzd+/f8A7C4xs9+teAfE34Zf8K5/sv8A4m/9ofb/ADf+XbytmzZ/ttnO/wBule//ABN+Jv8Awrn+y/8AiUf2h9v83/l58rZs2f7DZzv9uleAfDL4Zf8ACxv7U/4m/wDZ/wBg8r/l283fv3/7a4xs9+tHxN+GX/Cuf7L/AOJv/aH2/wA3/l28rZs2f7bZzv8AbpXv/wAMvhl/wrn+1P8Aib/2h9v8r/l28rZs3/7bZzv9ulef/tNf8yt/29/+0a9A+GXxN/4WN/an/Eo/s/7B5X/Lz5u/fv8A9hcY2e/WvP8A/k3P/qYf7d/7dPI8j/v5u3ed7Y2988cB8Tfhl/wrn+y/+Jv/AGh9v83/AJdvK2bNn+22c7/bpXf/APDTX/Uo/wDlS/8AtVcB8Tfhl/wrn+y/+Jv/AGh9v83/AJdvK2bNn+22c7/bpX1/Xz//AMm5/wDUw/27/wBunkeR/wB/N27zvbG3vng/5OM/6l7+wv8At78/z/8Av3t2+T753dsc+gfDL4m/8LG/tT/iUf2f9g8r/l583fv3/wCwuMbPfrXn/wCzL/zNP/bp/wC1q8Ar3/8AZl/5mn/t0/8Aa1H7Mv8AzNP/AG6f+1q+gKKKK+f/ANmX/maf+3T/ANrUf8My/wDU3f8AlN/+216B8Mvhl/wrn+1P+Jv/AGh9v8r/AJdvK2bN/wDttnO/26V5/wDsy/8AM0/9un/taj/k4z/qXv7C/wC3vz/P/wC/e3b5Pvnd2xyf8nGf9S9/YX/b35/n/wDfvbt8n3zu7Y5P2mv+ZW/7e/8A2jR+zL/zNP8A26f+1qP+Tc/+ph/t3/t08jyP+/m7d53tjb3zx4BXv/7TX/Mrf9vf/tGj/k3P/qYf7d/7dPI8j/v5u3ed7Y2988cB8Mvhl/wsb+1P+Jv/AGf9g8r/AJdvN379/wDtrjGz3613/wDwzL/1N3/lN/8AttH7Mv8AzNP/AG6f+1q4D4m/DL/hXP8AZf8AxN/7Q+3+b/y7eVs2bP8AbbOd/t0rv/8Ahpr/AKlH/wAqX/2qj/k4z/qXv7C/7e/P8/8A797dvk++d3bHJ/ybn/1MP9u/9unkeR/383bvO9sbe+ePQPhl8Mv+Fc/2p/xN/wC0Pt/lf8u3lbNm/wD22znf7dKPib8Mv+Fjf2X/AMTf+z/sHm/8u3m79+z/AG1xjZ79a8//AGZf+Zp/7dP/AGtX0BXz/wDsy/8AM0/9un/taj/hmX/qbv8Aym//AG2vQPhl8Mv+Fc/2p/xN/wC0Pt/lf8u3lbNm/wD22znf7dK8/wD2Zf8Amaf+3T/2tX0BRRRXz/8A8My/9Td/5Tf/ALbR/wAMy/8AU3f+U3/7bR/wzL/1N3/lN/8AttegfDL4Zf8ACuf7U/4m/wDaH2/yv+Xbytmzf/ttnO/26V5//wAm5/8AUw/27/26eR5H/fzdu872xt7549A+GXwy/wCFc/2p/wATf+0Pt/lf8u3lbNm//bbOd/t0rz/9mX/maf8At0/9rVwHwy+Jv/Cuf7U/4lH9ofb/ACv+Xnytmzf/ALDZzv8AbpR8Mvib/wAK5/tT/iUf2h9v8r/l58rZs3/7DZzv9ulHwy+Jv/Cuf7U/4lH9ofb/ACv+Xnytmzf/ALDZzv8AbpXf/sy/8zT/ANun/tavQPhl8Mv+Fc/2p/xN/wC0Pt/lf8u3lbNm/wD22znf7dK8/wD2Zf8Amaf+3T/2tXoHwy+GX/Cuf7U/4m/9ofb/ACv+Xbytmzf/ALbZzv8AbpXgHwy+Jv8Awrn+1P8AiUf2h9v8r/l58rZs3/7DZzv9uld/+zL/AMzT/wBun/tavQPhl8Mv+Fc/2p/xN/7Q+3+V/wAu3lbNm/8A22znf7dK8A+GXxN/4Vz/AGp/xKP7Q+3+V/y8+Vs2b/8AYbOd/t0o+GXxN/4Vz/an/Eo/tD7f5X/Lz5WzZv8A9hs53+3Su/8A2Zf+Zp/7dP8A2tR/ybn/ANTD/bv/AG6eR5H/AH83bvO9sbe+eD9mX/maf+3T/wBrUfsy/wDM0/8Abp/7Wo/4Zl/6m7/ym/8A22j/AIZl/wCpu/8AKb/9to/4Zl/6m7/ym/8A22vQPhl8Mv8AhXP9qf8AE3/tD7f5X/Lt5WzZv/22znf7dK9Aooor5/8A2Zf+Zp/7dP8A2tXAfE34m/8ACxv7L/4lH9n/AGDzf+Xnzd+/Z/sLjGz360fE34m/8LG/sv8A4lH9n/YPN/5efN379n+wuMbPfrXv/wAMvhl/wrn+1P8Aib/2h9v8r/l28rZs3/7bZzv9ulfIFFegfDL4m/8ACuf7U/4lH9ofb/K/5efK2bN/+w2c7/bpXf8A7TX/ADK3/b3/AO0a9A+GXxN/4WN/an/Eo/s/7B5X/Lz5u/fv/wBhcY2e/WvAPib8Mv8AhXP9l/8AE3/tD7f5v/Lt5WzZs/22znf7dKPib8Mv+Fc/2X/xN/7Q+3+b/wAu3lbNmz/bbOd/t0rv/wBmX/maf+3T/wBrVwHxN+GX/Cuf7L/4m/8AaH2/zf8Al28rZs2f7bZzv9ulHxN+GX/Cuf7L/wCJv/aH2/zf+XbytmzZ/ttnO/26V3//AAzL/wBTd/5Tf/ttH7TX/Mrf9vf/ALRrgPhl8Tf+Fc/2p/xKP7Q+3+V/y8+Vs2b/APYbOd/t0o+Jvwy/4Vz/AGX/AMTf+0Pt/m/8u3lbNmz/AG2znf7dK7//AJOM/wCpe/sL/t78/wA//v3t2+T753dscn/Juf8A1MP9u/8Abp5Hkf8Afzdu872xt7548Ar3/wD5Nz/6mH+3f+3TyPI/7+bt3ne2NvfPHAfE34Zf8K5/sv8A4m/9ofb/ADf+XbytmzZ/ttnO/wBuld/+01/zK3/b3/7Rr6Aorz/4ZfE3/hY39qf8Sj+z/sHlf8vPm79+/wD2FxjZ79a9Aooor5A+Jvwy/wCFc/2X/wATf+0Pt/m/8u3lbNmz/bbOd/t0o+JvxN/4WN/Zf/Eo/s/7B5v/AC8+bv37P9hcY2e/Wu//AGmv+ZW/7e//AGjXoHwy+GX/AArn+1P+Jv8A2h9v8r/l28rZs3/7bZzv9ulHwy+Jv/Cxv7U/4lH9n/YPK/5efN379/8AsLjGz3615/8A8nGf9S9/YX/b35/n/wDfvbt8n3zu7Y5+gK+QPib8Tf8AhY39l/8AEo/s/wCweb/y8+bv37P9hcY2e/Wvf/hl8Tf+Fjf2p/xKP7P+weV/y8+bv37/APYXGNnv1rz/AP4aa/6lH/ypf/aq9A+Jvwy/4WN/Zf8AxN/7P+web/y7ebv37P8AbXGNnv1r0CvkD4m/DL/hXP8AZf8AxN/7Q+3+b/y7eVs2bP8AbbOd/t0rv/8Ahpr/AKlH/wAqX/2qj/hmX/qbv/Kb/wDbaP8Ak3P/AKmH+3f+3TyPI/7+bt3ne2NvfPHoHxN+Jv8Awrn+y/8AiUf2h9v83/l58rZs2f7DZzv9ulHwy+GX/Cuf7U/4m/8AaH2/yv8Al28rZs3/AO22c7/bpXn/AO01/wAyt/29/wDtGj/hpr/qUf8Aypf/AGqj/k4z/qXv7C/7e/P8/wD797dvk++d3bHJ/wANNf8AUo/+VL/7VXAfE34Zf8K5/sv/AIm/9ofb/N/5dvK2bNn+22c7/bpR8Mvib/wrn+1P+JR/aH2/yv8Al58rZs3/AOw2c7/bpR8Mvhl/wsb+1P8Aib/2f9g8r/l283fv3/7a4xs9+tHwy+Jv/Cuf7U/4lH9ofb/K/wCXnytmzf8A7DZzv9ulfX9FFFFfP/8AwzL/ANTd/wCU3/7bXoHwy+GX/Cuf7U/4m/8AaH2/yv8Al28rZs3/AO22c7/bpXgHwy+GX/Cxv7U/4m/9n/YPK/5dvN379/8AtrjGz3613/8AwzL/ANTd/wCU3/7bR/w01/1KP/lS/wDtVegfDL4Zf8K5/tT/AIm/9ofb/K/5dvK2bN/+22c7/bpR8Mvib/wsb+1P+JR/Z/2Dyv8Al583fv3/AOwuMbPfrR8Mvhl/wrn+1P8Aib/2h9v8r/l28rZs3/7bZzv9uleAfE34Zf8ACuf7L/4m/wDaH2/zf+XbytmzZ/ttnO/26V3/AO01/wAyt/29/wDtGuA+GXwy/wCFjf2p/wATf+z/ALB5X/Lt5u/fv/21xjZ79a9/+Jvwy/4WN/Zf/E3/ALP+web/AMu3m79+z/bXGNnv1rwD4m/DL/hXP9l/8Tf+0Pt/m/8ALt5WzZs/22znf7dK9/8Aib8Tf+Fc/wBl/wDEo/tD7f5v/Lz5WzZs/wBhs53+3SvP/wBpr/mVv+3v/wBo0f8AJuf/AFMP9u/9unkeR/383bvO9sbe+eD9mX/maf8At0/9rV4BXoHwy+Jv/Cuf7U/4lH9ofb/K/wCXnytmzf8A7DZzv9uld/8A8m5/9TD/AG7/ANunkeR/383bvO9sbe+eOA+GXxN/4Vz/AGp/xKP7Q+3+V/y8+Vs2b/8AYbOd/t0rv/8Ak3P/AKmH+3f+3TyPI/7+bt3ne2NvfPHoHxN+GX/Cxv7L/wCJv/Z/2Dzf+Xbzd+/Z/trjGz3614B8Mvib/wAK5/tT/iUf2h9v8r/l58rZs3/7DZzv9ule/wDxN+Jv/Cuf7L/4lH9ofb/N/wCXnytmzZ/sNnO/26UfE34m/wDCuf7L/wCJR/aH2/zf+XnytmzZ/sNnO/26V5/+zL/zNP8A26f+1q+gKKKK+f8A/k3P/qYf7d/7dPI8j/v5u3ed7Y2988H/ACbn/wBTD/bv/bp5Hkf9/N27zvbG3vnjgPib8Mv+Fc/2X/xN/wC0Pt/m/wDLt5WzZs/22znf7dK9/wDhl8Mv+Fc/2p/xN/7Q+3+V/wAu3lbNm/8A22znf7dKPib8Mv8AhY39l/8AE3/s/wCweb/y7ebv37P9tcY2e/WvAPib8Mv+Fc/2X/xN/wC0Pt/m/wDLt5WzZs/22znf7dK8/r3/APaa/wCZW/7e/wD2jXAfDL4m/wDCuf7U/wCJR/aH2/yv+Xnytmzf/sNnO/26V7/8Mvhl/wAK5/tT/ib/ANofb/K/5dvK2bN/+22c7/bpXn//AA01/wBSj/5Uv/tVegfE34m/8K5/sv8A4lH9ofb/ADf+XnytmzZ/sNnO/wBulHxN+Jv/AArn+y/+JR/aH2/zf+XnytmzZ/sNnO/26V5/+01/zK3/AG9/+0aP2Zf+Zp/7dP8A2tR+zL/zNP8A26f+1qP+TjP+pe/sL/t78/z/APv3t2+T753dsc+AV7/+zL/zNP8A26f+1q9A+GXwy/4Vz/an/E3/ALQ+3+V/y7eVs2b/APbbOd/t0rwD4ZfDL/hY39qf8Tf+z/sHlf8ALt5u/fv/ANtcY2e/Wvf/AIm/E3/hXP8AZf8AxKP7Q+3+b/y8+Vs2bP8AYbOd/t0rwD4m/DL/AIVz/Zf/ABN/7Q+3+b/y7eVs2bP9ts53+3Su/wD2mv8AmVv+3v8A9o1wHwy+Jv8Awrn+1P8AiUf2h9v8r/l58rZs3/7DZzv9ulHxN+GX/Cuf7L/4m/8AaH2/zf8Al28rZs2f7bZzv9ule/8Awy+GX/Cuf7U/4m/9ofb/ACv+Xbytmzf/ALbZzv8AbpXoFFFFfIHwy+GX/Cxv7U/4m/8AZ/2Dyv8Al283fv3/AO2uMbPfrXf/APDMv/U3f+U3/wC20f8AJxn/AFL39hf9vfn+f/3727fJ987u2OfQPhl8Mv8AhXP9qf8AE3/tD7f5X/Lt5WzZv/22znf7dK8//wCGmv8AqUf/ACpf/aq8Ar3/AP4aa/6lH/ypf/aq9A+GXwy/4Vz/AGp/xN/7Q+3+V/y7eVs2b/8AbbOd/t0rwD4m/DL/AIVz/Zf/ABN/7Q+3+b/y7eVs2bP9ts53+3Svf/ib8Mv+Fjf2X/xN/wCz/sHm/wDLt5u/fs/21xjZ79a8/wD+TjP+pe/sL/t78/z/APv3t2+T753dsc+gfDL4m/8ACxv7U/4lH9n/AGDyv+Xnzd+/f/sLjGz360fDL4Zf8K5/tT/ib/2h9v8AK/5dvK2bN/8AttnO/wBulef/APJxn/Uvf2F/29+f5/8A3727fJ987u2OT/hpr/qUf/Kl/wDaqP2mv+ZW/wC3v/2jR+zL/wAzT/26f+1q8Ar3/wD4Zl/6m7/ym/8A22vQPhl8Tf8AhY39qf8AEo/s/wCweV/y8+bv37/9hcY2e/Wj4m/E3/hXP9l/8Sj+0Pt/m/8ALz5WzZs/2Gznf7dKPib8Mv8AhY39l/8AE3/s/wCweb/y7ebv37P9tcY2e/Wj4ZfE3/hY39qf8Sj+z/sHlf8ALz5u/fv/ANhcY2e/Wj4ZfDL/AIVz/an/ABN/7Q+3+V/y7eVs2b/9ts53+3SvQK+f/wDk4z/qXv7C/wC3vz/P/wC/e3b5Pvnd2xz9AUUUUV5/8Mvhl/wrn+1P+Jv/AGh9v8r/AJdvK2bN/wDttnO/26V5/wD8m5/9TD/bv/bp5Hkf9/N27zvbG3vnjwCvQPib8Mv+Fc/2X/xN/wC0Pt/m/wDLt5WzZs/22znf7dK7/wD5Nz/6mH+3f+3TyPI/7+bt3ne2NvfPHAfDL4m/8K5/tT/iUf2h9v8AK/5efK2bN/8AsNnO/wBulHwy+GX/AAsb+1P+Jv8A2f8AYPK/5dvN379/+2uMbPfrXf8A7TX/ADK3/b3/AO0a4D4m/DL/AIVz/Zf/ABN/7Q+3+b/y7eVs2bP9ts53+3Sj4ZfDL/hY39qf8Tf+z/sHlf8ALt5u/fv/ANtcY2e/Wu//AGmv+ZW/7e//AGjXoHxN+GX/AAsb+y/+Jv8A2f8AYPN/5dvN379n+2uMbPfrXoFfIHwy+Jv/AArn+1P+JR/aH2/yv+Xnytmzf/sNnO/26UfDL4Zf8LG/tT/ib/2f9g8r/l283fv3/wC2uMbPfrXf/wDDTX/Uo/8AlS/+1Ufsy/8AM0/9un/tavAK9A+GXwy/4WN/an/E3/s/7B5X/Lt5u/fv/wBtcY2e/Wu//wCGmv8AqUf/ACpf/aq4D4ZfE3/hXP8Aan/Eo/tD7f5X/Lz5WzZv/wBhs53+3Su//wCTjP8AqXv7C/7e/P8AP/797dvk++d3bHPoHxN+Jv8Awrn+y/8AiUf2h9v83/l58rZs2f7DZzv9ulHxN+Jv/Cuf7L/4lH9ofb/N/wCXnytmzZ/sNnO/26UfDL4m/wDCxv7U/wCJR/Z/2Dyv+Xnzd+/f/sLjGz360fE34m/8K5/sv/iUf2h9v83/AJefK2bNn+w2c7/bpR8Mvib/AMLG/tT/AIlH9n/YPK/5efN379/+wuMbPfrXoFFFFfIHwy+Jv/Cuf7U/4lH9ofb/ACv+Xnytmzf/ALDZzv8AbpX1/XwBXoHxN+GX/Cuf7L/4m/8AaH2/zf8Al28rZs2f7bZzv9ule/8Awy+Jv/Cxv7U/4lH9n/YPK/5efN379/8AsLjGz360fE34m/8ACuf7L/4lH9ofb/N/5efK2bNn+w2c7/bpR8Mvhl/wrn+1P+Jv/aH2/wAr/l28rZs3/wC22c7/AG6V5/8Asy/8zT/26f8AtauA+JvxN/4WN/Zf/Eo/s/7B5v8Ay8+bv37P9hcY2e/Wvf8A4m/E3/hXP9l/8Sj+0Pt/m/8ALz5WzZs/2Gznf7dK8A+JvxN/4WN/Zf8AxKP7P+web/y8+bv37P8AYXGNnv1r3/4m/E3/AIVz/Zf/ABKP7Q+3+b/y8+Vs2bP9hs53+3SvP/8Ak3P/AKmH+3f+3TyPI/7+bt3ne2NvfPB/w01/1KP/AJUv/tVegfE34m/8K5/sv/iUf2h9v83/AJefK2bNn+w2c7/bpXn/AO01/wAyt/29/wDtGj/hpr/qUf8Aypf/AGqvoCvkD4ZfE3/hXP8Aan/Eo/tD7f5X/Lz5WzZv/wBhs53+3Svf/ib8Tf8AhXP9l/8AEo/tD7f5v/Lz5WzZs/2Gznf7dK8//wCGZf8Aqbv/ACm//baP2mv+ZW/7e/8A2jR/ybn/ANTD/bv/AG6eR5H/AH83bvO9sbe+ePQPib8Tf+Fc/wBl/wDEo/tD7f5v/Lz5WzZs/wBhs53+3SvAPhl8Tf8AhXP9qf8AEo/tD7f5X/Lz5WzZv/2Gznf7dK9/+GXxN/4WN/an/Eo/s/7B5X/Lz5u/fv8A9hcY2e/Wj4ZfE3/hY39qf8Sj+z/sHlf8vPm79+//AGFxjZ79a9Aoooor5/8A2Zf+Zp/7dP8A2tR/wzL/ANTd/wCU3/7bR/ybn/1MP9u/9unkeR/383bvO9sbe+ePQPib8Tf+Fc/2X/xKP7Q+3+b/AMvPlbNmz/YbOd/t0o+JvxN/4Vz/AGX/AMSj+0Pt/m/8vPlbNmz/AGGznf7dK8A+Jvwy/wCFc/2X/wATf+0Pt/m/8u3lbNmz/bbOd/t0r3/4m/DL/hY39l/8Tf8As/7B5v8Ay7ebv37P9tcY2e/Wj4m/E3/hXP8AZf8AxKP7Q+3+b/y8+Vs2bP8AYbOd/t0r5Ar0D4ZfE3/hXP8Aan/Eo/tD7f5X/Lz5WzZv/wBhs53+3Su//wCGmv8AqUf/ACpf/aq4D4ZfE3/hXP8Aan/Eo/tD7f5X/Lz5WzZv/wBhs53+3Su//aa/5lb/ALe//aNcB8Mvhl/wsb+1P+Jv/Z/2Dyv+Xbzd+/f/ALa4xs9+tHxN+Jv/AAsb+y/+JR/Z/wBg83/l583fv2f7C4xs9+te/wDwy+GX/Cuf7U/4m/8AaH2/yv8Al28rZs3/AO22c7/bpXgHwy+GX/Cxv7U/4m/9n/YPK/5dvN379/8AtrjGz360fE34Zf8ACuf7L/4m/wDaH2/zf+XbytmzZ/ttnO/26V5/Xv8A+01/zK3/AG9/+0a4D4ZfDL/hY39qf8Tf+z/sHlf8u3m79+//AG1xjZ79a9/+GXxN/wCFjf2p/wASj+z/ALB5X/Lz5u/fv/2FxjZ79aPhl8Mv+Fc/2p/xN/7Q+3+V/wAu3lbNm/8A22znf7dK+QK9/wD2Zf8Amaf+3T/2tX0BRRRRXyB8Tfhl/wAK5/sv/ib/ANofb/N/5dvK2bNn+22c7/bpXf8A/DTX/Uo/+VL/AO1VwHwy+GX/AAsb+1P+Jv8A2f8AYPK/5dvN379/+2uMbPfrXf8A/DMv/U3f+U3/AO21wHwy+Jv/AArn+1P+JR/aH2/yv+Xnytmzf/sNnO/26UfDL4m/8K5/tT/iUf2h9v8AK/5efK2bN/8AsNnO/wBule//ABN+Jv8Awrn+y/8AiUf2h9v83/l58rZs2f7DZzv9uleAfE34m/8ACxv7L/4lH9n/AGDzf+Xnzd+/Z/sLjGz3615/XoHxN+Jv/Cxv7L/4lH9n/YPN/wCXnzd+/Z/sLjGz3613/wC01/zK3/b3/wC0a9A+GXwy/wCFc/2p/wATf+0Pt/lf8u3lbNm//bbOd/t0rwD4ZfDL/hY39qf8Tf8As/7B5X/Lt5u/fv8A9tcY2e/Wu/8A+GZf+pu/8pv/ANtrgPhl8Mv+Fjf2p/xN/wCz/sHlf8u3m79+/wD21xjZ79a8/r0D4ZfDL/hY39qf8Tf+z/sHlf8ALt5u/fv/ANtcY2e/Wj4m/E3/AIWN/Zf/ABKP7P8AsHm/8vPm79+z/YXGNnv1rv8A/hpr/qUf/Kl/9qr0D4m/DL/hY39l/wDE3/s/7B5v/Lt5u/fs/wBtcY2e/WvP/wBmX/maf+3T/wBrV6B8Mvib/wALG/tT/iUf2f8AYPK/5efN379/+wuMbPfrXgHwy+GX/Cxv7U/4m/8AZ/2Dyv8Al283fv3/AO2uMbPfrXf/APDMv/U3f+U3/wC20fsy/wDM0/8Abp/7WrgPib8Mv+Fc/wBl/wDE3/tD7f5v/Lt5WzZs/wBts53+3Svf/hl8Mv8AhXP9qf8AE3/tD7f5X/Lt5WzZv/22znf7dK9Aooorz/4m/DL/AIWN/Zf/ABN/7P8AsHm/8u3m79+z/bXGNnv1rwD4ZfE3/hXP9qf8Sj+0Pt/lf8vPlbNm/wD2Gznf7dK7/wDZl/5mn/t0/wDa1egfDL4Zf8K5/tT/AIm/9ofb/K/5dvK2bN/+22c7/bpXgHwy+GX/AAsb+1P+Jv8A2f8AYPK/5dvN379/+2uMbPfrR8Tfhl/wrn+y/wDib/2h9v8AN/5dvK2bNn+22c7/AG6V3/7TX/Mrf9vf/tGuA+GXxN/4Vz/an/Eo/tD7f5X/AC8+Vs2b/wDYbOd/t0o+Jvwy/wCFc/2X/wATf+0Pt/m/8u3lbNmz/bbOd/t0r6/rz/4ZfDL/AIVz/an/ABN/7Q+3+V/y7eVs2b/9ts53+3Sj4ZfDL/hXP9qf8Tf+0Pt/lf8ALt5WzZv/ANts53+3SvP/ANmX/maf+3T/ANrV6B8Mvhl/wrn+1P8Aib/2h9v8r/l28rZs3/7bZzv9uleAfDL4m/8ACuf7U/4lH9ofb/K/5efK2bN/+w2c7/bpX1/RRXyB8Tfib/wsb+y/+JR/Z/2Dzf8Al583fv2f7C4xs9+td/8A8m5/9TD/AG7/ANunkeR/383bvO9sbe+ePAK+v/ib8Tf+Fc/2X/xKP7Q+3+b/AMvPlbNmz/YbOd/t0rz/APZl/wCZp/7dP/a1egfDL4Zf8K5/tT/ib/2h9v8AK/5dvK2bN/8AttnO/wBuleAfDL4m/wDCuf7U/wCJR/aH2/yv+Xnytmzf/sNnO/26V7/8Tfhl/wALG/sv/ib/ANn/AGDzf+Xbzd+/Z/trjGz3615/+zL/AMzT/wBun/tavoCiiivP/ib8Tf8AhXP9l/8AEo/tD7f5v/Lz5WzZs/2Gznf7dK8//wCTc/8AqYf7d/7dPI8j/v5u3ed7Y2988H/DMv8A1N3/AJTf/ttH/DMv/U3f+U3/AO214BXv/wDwzL/1N3/lN/8AttH/AA01/wBSj/5Uv/tVH/DMv/U3f+U3/wC214BXoHwy+GX/AAsb+1P+Jv8A2f8AYPK/5dvN379/+2uMbPfrXf8A7Mv/ADNP/bp/7Wr0D4ZfE3/hY39qf8Sj+z/sHlf8vPm79+//AGFxjZ79a8//AOGZf+pu/wDKb/8Aba4D4ZfDL/hY39qf8Tf+z/sHlf8ALt5u/fv/ANtcY2e/Wj4ZfDL/AIWN/an/ABN/7P8AsHlf8u3m79+//bXGNnv1r3/4m/DL/hY39l/8Tf8As/7B5v8Ay7ebv37P9tcY2e/WvP8A9mX/AJmn/t0/9rV9AV8//wDDMv8A1N3/AJTf/ttH/Jxn/Uvf2F/29+f5/wD3727fJ987u2OfQPib8Mv+Fjf2X/xN/wCz/sHm/wDLt5u/fs/21xjZ79a9Ar5A+Jvwy/4Vz/Zf/E3/ALQ+3+b/AMu3lbNmz/bbOd/t0o+Jvwy/4Vz/AGX/AMTf+0Pt/m/8u3lbNmz/AG2znf7dK9/+GXwy/wCFc/2p/wATf+0Pt/lf8u3lbNm//bbOd/t0rz//AJOM/wCpe/sL/t78/wA//v3t2+T753dscn7Mv/M0/wDbp/7Wr6Aooorz/wCGXwy/4Vz/AGp/xN/7Q+3+V/y7eVs2b/8AbbOd/t0rz/8A4Zl/6m7/AMpv/wBto/Zl/wCZp/7dP/a1H/Juf/Uw/wBu/wDbp5Hkf9/N27zvbG3vng/Zl/5mn/t0/wDa1H/Juf8A1MP9u/8Abp5Hkf8Afzdu872xt7544D4ZfDL/AIWN/an/ABN/7P8AsHlf8u3m79+//bXGNnv1o+GXwy/4WN/an/E3/s/7B5X/AC7ebv37/wDbXGNnv1o+JvxN/wCFjf2X/wASj+z/ALB5v/Lz5u/fs/2FxjZ79aPhl8Mv+Fjf2p/xN/7P+weV/wAu3m79+/8A21xjZ79a7/8A5OM/6l7+wv8At78/z/8Av3t2+T753dsc8B8Mvib/AMK5/tT/AIlH9ofb/K/5efK2bN/+w2c7/bpXv/xN+GX/AAsb+y/+Jv8A2f8AYPN/5dvN379n+2uMbPfrXn//AA01/wBSj/5Uv/tVegfDL4m/8LG/tT/iUf2f9g8r/l583fv3/wCwuMbPfrXn/wCzL/zNP/bp/wC1q4D4ZfE3/hXP9qf8Sj+0Pt/lf8vPlbNm/wD2Gznf7dKPib8Mv+Fc/wBl/wDE3/tD7f5v/Lt5WzZs/wBts53+3Su//Zl/5mn/ALdP/a1fQFef/E34Zf8ACxv7L/4m/wDZ/wBg83/l283fv2f7a4xs9+tef/8ADTX/AFKP/lS/+1VwHxN+GX/Cuf7L/wCJv/aH2/zf+XbytmzZ/ttnO/26V5/Xv/8AwzL/ANTd/wCU3/7bR/ybn/1MP9u/9unkeR/383bvO9sbe+eD9mX/AJmn/t0/9rV9AUUUV8AUV7//AMnGf9S9/YX/AG9+f5//AH727fJ987u2OfQPhl8Mv+Fc/wBqf8Tf+0Pt/lf8u3lbNm//AG2znf7dK8A+Jvwy/wCFc/2X/wATf+0Pt/m/8u3lbNmz/bbOd/t0rv8A9pr/AJlb/t7/APaNH/DMv/U3f+U3/wC20f8ADMv/AFN3/lN/+216B8Mvhl/wrn+1P+Jv/aH2/wAr/l28rZs3/wC22c7/AG6V5/8A8nGf9S9/YX/b35/n/wDfvbt8n3zu7Y59A+Jvwy/4WN/Zf/E3/s/7B5v/AC7ebv37P9tcY2e/WvQK+QPib8Tf+Fjf2X/xKP7P+web/wAvPm79+z/YXGNnv1o+Jvwy/wCFc/2X/wATf+0Pt/m/8u3lbNmz/bbOd/t0r3/4m/DL/hY39l/8Tf8As/7B5v8Ay7ebv37P9tcY2e/Wj4ZfE3/hY39qf8Sj+z/sHlf8vPm79+//AGFxjZ79a8//AOTjP+pe/sL/ALe/P8//AL97dvk++d3bHPoHxN+Jv/Cuf7L/AOJR/aH2/wA3/l58rZs2f7DZzv8AbpR8Mvhl/wAK5/tT/ib/ANofb/K/5dvK2bN/+22c7/bpXgHxN+GX/Cuf7L/4m/8AaH2/zf8Al28rZs2f7bZzv9uld/8A8My/9Td/5Tf/ALbXoHxN+Jv/AArn+y/+JR/aH2/zf+XnytmzZ/sNnO/26V5/+zL/AMzT/wBun/taj/k3P/qYf7d/7dPI8j/v5u3ed7Y2988fQFfP/wDybn/1MP8Abv8A26eR5H/fzdu872xt754+gKKKKK+AK+v/AIZfE3/hY39qf8Sj+z/sHlf8vPm79+//AGFxjZ79aPhl8Tf+Fjf2p/xKP7P+weV/y8+bv37/APYXGNnv1rwD4m/DL/hXP9l/8Tf+0Pt/m/8ALt5WzZs/22znf7dK9/8Ahl8Mv+Fc/wBqf8Tf+0Pt/lf8u3lbNm//AG2znf7dK8//AOGZf+pu/wDKb/8Aba8Ar6/+Jvwy/wCFjf2X/wATf+z/ALB5v/Lt5u/fs/21xjZ79aPib8Mv+Fjf2X/xN/7P+web/wAu3m79+z/bXGNnv1rz/wD4Zl/6m7/ym/8A22j/AJNz/wCph/t3/t08jyP+/m7d53tjb3zx6B8Mvhl/wrn+1P8Aib/2h9v8r/l28rZs3/7bZzv9ulHwy+GX/Cuf7U/4m/8AaH2/yv8Al28rZs3/AO22c7/bpXgHwy+Jv/Cuf7U/4lH9ofb/ACv+Xnytmzf/ALDZzv8AbpXv/wAMvib/AMLG/tT/AIlH9n/YPK/5efN379/+wuMbPfrXgHxN+GX/AArn+y/+Jv8A2h9v83/l28rZs2f7bZzv9uld/wD8NNf9Sj/5Uv8A7VX0BXyB8Mvhl/wsb+1P+Jv/AGf9g8r/AJdvN379/wDtrjGz3619f18//wDDTX/Uo/8AlS/+1V6B8Tfhl/wsb+y/+Jv/AGf9g83/AJdvN379n+2uMbPfrR8Mvib/AMLG/tT/AIlH9n/YPK/5efN379/+wuMbPfrR8Mvib/wsb+1P+JR/Z/2Dyv8Al583fv3/AOwuMbPfrR8Tfhl/wsb+y/8Aib/2f9g83/l283fv2f7a4xs9+tef/sy/8zT/ANun/taj9mX/AJmn/t0/9rV9AUUUV8//ALTX/Mrf9vf/ALRo/wCGZf8Aqbv/ACm//ba+gK+f/wDk3P8A6mH+3f8At08jyP8Av5u3ed7Y2988eAUV7/8A8NNf9Sj/AOVL/wC1Uf8AJuf/AFMP9u/9unkeR/383bvO9sbe+ePQPib8Mv8AhY39l/8AE3/s/wCweb/y7ebv37P9tcY2e/WvP/8Ak4z/AKl7+wv+3vz/AD/+/e3b5Pvnd2xzwHwy+Jv/AArn+1P+JR/aH2/yv+Xnytmzf/sNnO/26UfDL4Zf8LG/tT/ib/2f9g8r/l283fv3/wC2uMbPfrXv/wATfib/AMK5/sv/AIlH9ofb/N/5efK2bNn+w2c7/bpXn/7Mv/M0/wDbp/7Wr0D4ZfDL/hXP9qf8Tf8AtD7f5X/Lt5WzZv8A9ts53+3Sj4ZfDL/hXP8Aan/E3/tD7f5X/Lt5WzZv/wBts53+3SvAPib8Mv8AhXP9l/8AE3/tD7f5v/Lt5WzZs/22znf7dKPhl8Mv+Fjf2p/xN/7P+weV/wAu3m79+/8A21xjZ79a7/8AZl/5mn/t0/8Aa1cB8Mvib/wrn+1P+JR/aH2/yv8Al58rZs3/AOw2c7/bpR8Mvib/AMK5/tT/AIlH9ofb/K/5efK2bN/+w2c7/bpXf/8AJuf/AFMP9u/9unkeR/383bvO9sbe+eOA+Jvwy/4Vz/Zf/E3/ALQ+3+b/AMu3lbNmz/bbOd/t0o+GXxN/4Vz/AGp/xKP7Q+3+V/y8+Vs2b/8AYbOd/t0rv/8Ak3P/AKmH+3f+3TyPI/7+bt3ne2NvfPB/w01/1KP/AJUv/tVegfDL4m/8LG/tT/iUf2f9g8r/AJefN379/wDsLjGz3616BRRRRXyB8Tfhl/wrn+y/+Jv/AGh9v83/AJdvK2bNn+22c7/bpR8Mvib/AMK5/tT/AIlH9ofb/K/5efK2bN/+w2c7/bpXv/wy+GX/AArn+1P+Jv8A2h9v8r/l28rZs3/7bZzv9ulHxN+GX/Cxv7L/AOJv/Z/2Dzf+Xbzd+/Z/trjGz3615/8A8My/9Td/5Tf/ALbXoHxN+Jv/AArn+y/+JR/aH2/zf+XnytmzZ/sNnO/26V4B8Mvhl/wsb+1P+Jv/AGf9g8r/AJdvN379/wDtrjGz3617/wDDL4m/8LG/tT/iUf2f9g8r/l583fv3/wCwuMbPfrXgHxN+Jv8Awsb+y/8AiUf2f9g83/l583fv2f7C4xs9+te//DL4m/8ACxv7U/4lH9n/AGDyv+Xnzd+/f/sLjGz3614B8Tfhl/wrn+y/+Jv/AGh9v83/AJdvK2bNn+22c7/bpXv/AMTfhl/wsb+y/wDib/2f9g83/l283fv2f7a4xs9+tegV5/8AE34Zf8LG/sv/AIm/9n/YPN/5dvN379n+2uMbPfrR8Tfib/wrn+y/+JR/aH2/zf8Al58rZs2f7DZzv9ulef8A/Jxn/Uvf2F/29+f5/wD3727fJ987u2OfAK9A+GXxN/4Vz/an/Eo/tD7f5X/Lz5WzZv8A9hs53+3Svf8A4m/E3/hXP9l/8Sj+0Pt/m/8ALz5WzZs/2Gznf7dKPhl8Mv8AhXP9qf8AE3/tD7f5X/Lt5WzZv/22znf7dK9Ar5A+JvxN/wCFjf2X/wASj+z/ALB5v/Lz5u/fs/2FxjZ79aPhl8Mv+Fjf2p/xN/7P+weV/wAu3m79+/8A21xjZ79a9/8Aib8Tf+Fc/wBl/wDEo/tD7f5v/Lz5WzZs/wBhs53+3SvQK8/+GXwy/wCFc/2p/wATf+0Pt/lf8u3lbNm//bbOd/t0r0CiiivkD4ZfE3/hXP8Aan/Eo/tD7f5X/Lz5WzZv/wBhs53+3Su//wCGZf8Aqbv/ACm//ba+gK8/+GXwy/4Vz/an/E3/ALQ+3+V/y7eVs2b/APbbOd/t0rz/AP4Zl/6m7/ym/wD22vQPib8Tf+Fc/wBl/wDEo/tD7f5v/Lz5WzZs/wBhs53+3SvQK8/+Jvwy/wCFjf2X/wATf+z/ALB5v/Lt5u/fs/21xjZ79a8//Zl/5mn/ALdP/a1cB8Tfib/wsb+y/wDiUf2f9g83/l583fv2f7C4xs9+te//AAy+GX/Cuf7U/wCJv/aH2/yv+Xbytmzf/ttnO/26UfE34m/8K5/sv/iUf2h9v83/AJefK2bNn+w2c7/bpR8Tfhl/wsb+y/8Aib/2f9g83/l283fv2f7a4xs9+tef/wDJuf8A1MP9u/8Abp5Hkf8Afzdu872xt754P+TjP+pe/sL/ALe/P8//AL97dvk++d3bHPoHwy+GX/Cuf7U/4m/9ofb/ACv+Xbytmzf/ALbZzv8AbpR8Mvhl/wAK5/tT/ib/ANofb/K/5dvK2bN/+22c7/bpXn//AAzL/wBTd/5Tf/tteAUV9f8AxN+Jv/Cuf7L/AOJR/aH2/wA3/l58rZs2f7DZzv8AbpXgHxN+Jv8Awsb+y/8AiUf2f9g83/l583fv2f7C4xs9+tfX9FfIHwy+Jv8Awrn+1P8AiUf2h9v8r/l58rZs3/7DZzv9ulHwy+Jv/Cuf7U/4lH9ofb/K/wCXnytmzf8A7DZzv9ule/8Awy+Jv/Cxv7U/4lH9n/YPK/5efN379/8AsLjGz3616BRRRXyB8Tfhl/wrn+y/+Jv/AGh9v83/AJdvK2bNn+22c7/bpXf/APJxn/Uvf2F/29+f5/8A3727fJ987u2OT/hmX/qbv/Kb/wDbaP8Ak3P/AKmH+3f+3TyPI/7+bt3ne2NvfPB/wzL/ANTd/wCU3/7bR+01/wAyt/29/wDtGj9mX/maf+3T/wBrV6B8Mvhl/wAK5/tT/ib/ANofb/K/5dvK2bN/+22c7/bpXn//AAzL/wBTd/5Tf/ttH/Juf/Uw/wBu/wDbp5Hkf9/N27zvbG3vnjgPhl8Mv+Fjf2p/xN/7P+weV/y7ebv37/8AbXGNnv1r3/4ZfDL/AIVz/an/ABN/7Q+3+V/y7eVs2b/9ts53+3SvP/2Zf+Zp/wC3T/2tXoHxN+GX/Cxv7L/4m/8AZ/2Dzf8Al283fv2f7a4xs9+tef8A/Jxn/Uvf2F/29+f5/wD3727fJ987u2OfQPib8Mv+Fjf2X/xN/wCz/sHm/wDLt5u/fs/21xjZ79a8/wD+Gmv+pR/8qX/2quA+JvxN/wCFjf2X/wASj+z/ALB5v/Lz5u/fs/2FxjZ79a9/+Jvwy/4WN/Zf/E3/ALP+web/AMu3m79+z/bXGNnv1rwD4m/DL/hXP9l/8Tf+0Pt/m/8ALt5WzZs/22znf7dKPib8Mv8AhXP9l/8AE3/tD7f5v/Lt5WzZs/22znf7dK9/+JvxN/4Vz/Zf/Eo/tD7f5v8Ay8+Vs2bP9hs53+3SvP8A9pr/AJlb/t7/APaNH/Juf/Uw/wBu/wDbp5Hkf9/N27zvbG3vng/Zl/5mn/t0/wDa1eAV7/8Asy/8zT/26f8AtavoCiiiivP/AIm/DL/hY39l/wDE3/s/7B5v/Lt5u/fs/wBtcY2e/WvQK8/+GXwy/wCFc/2p/wATf+0Pt/lf8u3lbNm//bbOd/t0o+GXxN/4WN/an/Eo/s/7B5X/AC8+bv37/wDYXGNnv1o+Jvwy/wCFjf2X/wATf+z/ALB5v/Lt5u/fs/21xjZ79a8//aa/5lb/ALe//aNH/Jxn/Uvf2F/29+f5/wD3727fJ987u2OfAK9//wCTjP8AqXv7C/7e/P8AP/797dvk++d3bHJ/w01/1KP/AJUv/tVH/DMv/U3f+U3/AO21wHwy+GX/AAsb+1P+Jv8A2f8AYPK/5dvN379/+2uMbPfrXf8A/DMv/U3f+U3/AO214BXv/wC01/zK3/b3/wC0aP8Ak4z/AKl7+wv+3vz/AD/+/e3b5Pvnd2xyftNf8yt/29/+0a4D4ZfE3/hXP9qf8Sj+0Pt/lf8ALz5WzZv/ANhs53+3Svf/AIZfDL/hXP8Aan/E3/tD7f5X/Lt5WzZv/wBts53+3SvAPhl8Mv8AhY39qf8AE3/s/wCweV/y7ebv37/9tcY2e/Wu/wD+Tc/+ph/t3/t08jyP+/m7d53tjb3zxwHwy+GX/Cxv7U/4m/8AZ/2Dyv8Al283fv3/AO2uMbPfrXf/APDMv/U3f+U3/wC21wHwy+Jv/Cuf7U/4lH9ofb/K/wCXnytmzf8A7DZzv9ule/8AxN+Jv/Cuf7L/AOJR/aH2/wA3/l58rZs2f7DZzv8AbpR8Mvib/wALG/tT/iUf2f8AYPK/5efN379/+wuMbPfrXoFFFFfIHwy+GX/Cxv7U/wCJv/Z/2Dyv+Xbzd+/f/trjGz3613//AAzL/wBTd/5Tf/ttH/DMv/U3f+U3/wC20fsy/wDM0/8Abp/7Wo/5OM/6l7+wv+3vz/P/AO/e3b5Pvnd2xyf8NNf9Sj/5Uv8A7VXAfDL4m/8ACuf7U/4lH9ofb/K/5efK2bN/+w2c7/bpR8Mvhl/wsb+1P+Jv/Z/2Dyv+Xbzd+/f/ALa4xs9+td//AMNNf9Sj/wCVL/7VR/ybn/1MP9u/9unkeR/383bvO9sbe+ePAK9//Zl/5mn/ALdP/a1H7Mv/ADNP/bp/7Wr0D4ZfDL/hXP8Aan/E3/tD7f5X/Lt5WzZv/wBts53+3SvAPhl8Mv8AhY39qf8AE3/s/wCweV/y7ebv37/9tcY2e/WvP69//Zl/5mn/ALdP/a1H7Mv/ADNP/bp/7Wo/aa/5lb/t7/8AaNegfDL4m/8ACxv7U/4lH9n/AGDyv+Xnzd+/f/sLjGz3615/+zL/AMzT/wBun/taj/k3P/qYf7d/7dPI8j/v5u3ed7Y2988H7Mv/ADNP/bp/7Wr0D4ZfDL/hXP8Aan/E3/tD7f5X/Lt5WzZv/wBts53+3SvkCvQPhl8Mv+Fjf2p/xN/7P+weV/y7ebv37/8AbXGNnv1r3/4ZfE3/AIWN/an/ABKP7P8AsHlf8vPm79+//YXGNnv1r0Ciiivn/wDZl/5mn/t0/wDa1eAV7/8Asy/8zT/26f8Ataj9mX/maf8At0/9rUf8nGf9S9/YX/b35/n/APfvbt8n3zu7Y59A+GXxN/4WN/an/Eo/s/7B5X/Lz5u/fv8A9hcY2e/WvP8A/hpr/qUf/Kl/9qrgPhl8Mv8AhY39qf8AE3/s/wCweV/y7ebv37/9tcY2e/WvP6+v/hl8Mv8AhXP9qf8AE3/tD7f5X/Lt5WzZv/22znf7dK8//aa/5lb/ALe//aNegfDL4m/8LG/tT/iUf2f9g8r/AJefN379/wDsLjGz3615/wD8My/9Td/5Tf8A7bR/wzL/ANTd/wCU3/7bXAfDL4Zf8LG/tT/ib/2f9g8r/l283fv3/wC2uMbPfrXv/wATfhl/wsb+y/8Aib/2f9g83/l283fv2f7a4xs9+tHwy+Jv/Cxv7U/4lH9n/YPK/wCXnzd+/f8A7C4xs9+tef8A/Juf/Uw/27/26eR5H/fzdu872xt7544D4m/DL/hXP9l/8Tf+0Pt/m/8ALt5WzZs/22znf7dK7/8A5Nz/AOph/t3/ALdPI8j/AL+bt3ne2NvfPHAfDL4m/wDCuf7U/wCJR/aH2/yv+Xnytmzf/sNnO/26V7/8Mvhl/wAK5/tT/ib/ANofb/K/5dvK2bN/+22c7/bpXgHxN+GX/Cuf7L/4m/8AaH2/zf8Al28rZs2f7bZzv9ulef0V9f8Awy+Jv/Cxv7U/4lH9n/YPK/5efN379/8AsLjGz3615/8Asy/8zT/26f8AtavoCiiivn/9mX/maf8At0/9rUf8My/9Td/5Tf8A7bXoHwy+GX/Cuf7U/wCJv/aH2/yv+Xbytmzf/ttnO/26V5/+zL/zNP8A26f+1q9A+Jvwy/4WN/Zf/E3/ALP+web/AMu3m79+z/bXGNnv1r0CvgCvr/4m/DL/AIWN/Zf/ABN/7P8AsHm/8u3m79+z/bXGNnv1o+JvxN/4Vz/Zf/Eo/tD7f5v/AC8+Vs2bP9hs53+3Sj4ZfDL/AIVz/an/ABN/7Q+3+V/y7eVs2b/9ts53+3SvP/2mv+ZW/wC3v/2jR/wzL/1N3/lN/wDttcB8Mvib/wAK5/tT/iUf2h9v8r/l58rZs3/7DZzv9ule/wDwy+GX/Cuf7U/4m/8AaH2/yv8Al28rZs3/AO22c7/bpR8Tfib/AMK5/sv/AIlH9ofb/N/5efK2bNn+w2c7/bpR8Tfhl/wsb+y/+Jv/AGf9g83/AJdvN379n+2uMbPfrXgHwy+Jv/Cuf7U/4lH9ofb/ACv+Xnytmzf/ALDZzv8AbpR8Mvhl/wALG/tT/ib/ANn/AGDyv+Xbzd+/f/trjGz3617/APDL4Zf8K5/tT/ib/wBofb/K/wCXbytmzf8A7bZzv9ulef8A/DMv/U3f+U3/AO21wHwy+Jv/AArn+1P+JR/aH2/yv+Xnytmzf/sNnO/26V3/AO01/wAyt/29/wDtGuA+GXxN/wCFc/2p/wASj+0Pt/lf8vPlbNm//YbOd/t0r3/4m/E3/hXP9l/8Sj+0Pt/m/wDLz5WzZs/2Gznf7dK8/wD2Zf8Amaf+3T/2tXAfE34Zf8K5/sv/AIm/9ofb/N/5dvK2bNn+22c7/bpXv/wy+GX/AArn+1P+Jv8A2h9v8r/l28rZs3/7bZzv9ulegUUUV8//APDMv/U3f+U3/wC20f8ADMv/AFN3/lN/+20f8My/9Td/5Tf/ALbXoHwy+GX/AArn+1P+Jv8A2h9v8r/l28rZs3/7bZzv9ulef/8ADMv/AFN3/lN/+20f8My/9Td/5Tf/ALbR/wAMy/8AU3f+U3/7bX0BXn/xN+GX/Cxv7L/4m/8AZ/2Dzf8Al283fv2f7a4xs9+tef8A/DMv/U3f+U3/AO216B8Mvhl/wrn+1P8Aib/2h9v8r/l28rZs3/7bZzv9ulHxN+GX/Cxv7L/4m/8AZ/2Dzf8Al283fv2f7a4xs9+tHwy+GX/Cuf7U/wCJv/aH2/yv+Xbytmzf/ttnO/26V6BXn/xN+GX/AAsb+y/+Jv8A2f8AYPN/5dvN379n+2uMbPfrR8Mvhl/wrn+1P+Jv/aH2/wAr/l28rZs3/wC22c7/AG6V5/8A8My/9Td/5Tf/ALbXoHwy+GX/AArn+1P+Jv8A2h9v8r/l28rZs3/7bZzv9ulef/8ADMv/AFN3/lN/+20f8My/9Td/5Tf/ALbXoHxN+GX/AAsb+y/+Jv8A2f8AYPN/5dvN379n+2uMbPfrR8Mvhl/wrn+1P+Jv/aH2/wAr/l28rZs3/wC22c7/AG6UfE34Zf8ACxv7L/4m/wDZ/wBg83/l283fv2f7a4xs9+tegV5/8Mvhl/wrn+1P+Jv/AGh9v8r/AJdvK2bN/wDttnO/26UfE34Zf8LG/sv/AIm/9n/YPN/5dvN379n+2uMbPfrXoFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFf/2Q=="
      }
    },
    {
      "request_control_key": "b3a428fd-58ee-4d6f-8872-633874ebf5e2",
      "bank_slip_key": "4056f1f1-a6ea-4162-8bac-b1ce2546a9bf",
      "bank_slip_status": "accepted",
      "our_number": 987654321,
      "barcode": "",
      "digitable_line":
    }
  ]
}
```

STATUS 4xx

### Response Body Params

| Campo                      | Tipo    | Descrição                                                                          | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `bank_slips`               | Array de **[Objeto bank_slip_response](#objeto-bank_slip_response)** | Descontos                                                                          | - |

### Objeto bank_slip_response

| Campo                   | Tipo   | Descrição                                                                         | Caracteres |
|-------------------------|--------|-----------------------------------------------------------------------------------|------------|
| `request_control_key` * | uuidv4 | Chave única de identificação da request utilizada pelo cliente no formato uuid v4 | 36         |
| `bank_slip_key` *       | uuidv4 | Chave única de identificação do boleto no formato uuid v4                         | 36         |
| `bank_slip_status` *    | string | Status do boleto       | **[Enumeradores bank_slip_status](#enumeradores-bank_slip_status)**   |
| `our_number` *          | integer| Número único de identificação do boleto junto à carteira                          | 11         |
| `barcode` *             | string | Código de barras do boleto                                                        | 44         |
| `digitable_line` *      | string | Linha digitável do boleto                                                         | 47         |
| `qr_code_data`          | object | Dados do QR Code                             | **[Objeto qr_code_data](#objeto-qr_code_data)** |
| `created_at` *          | string | Data, no formato ISO (UTC - "YYYY-MM-DDTHH:MM:SSZ"), da criação da ocorrência     | 20         |

### Enumeradores bank_slip_status

| Enumerador         | Descrição                               |
|--------------------|-----------------------------------------|
| accepted           | Boleto aceito mas ainda não registrado  |

### Objeto qr_code_data
| Campo                      | Tipo   | Descrição                                             | Caracteres              |
|----------------------------|--------|-------------------------------------------------------|-------------------------|
| `qr_code_key`              | uuidv4 | Chave única de identificação do QR Code               | 36                      |
| `pix_key`                  | uuidv4 | Chave PIX vinculada ao QR Code                        | 36                      |
| `receiver_conciliation_id` | uuidv4 | Identificador de conciliação do QR Code               | 36                      |
| `url`                      | string | URL (Pix Copia e Cola) do QR Code                     | -                       |
| `image`                    | string | base64 da URL (Pix Copia e Cola) do QR Code           | -                       |

## Error Response

Response Body: Error

```json
{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}
```

| Código HTTP<br/>`status` | Código QI<br/>`code` | Título<br/>`title`                                 | Descrição (eng)<br/>`description`                                                                                       | Descrição (pt-br)<br/>`translation`                                                                                     |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 400                      | QIT000001            | Bad Request                                        | Schema Error                                                                                                            | Schema Inválido                                                                                                         |
| 404                      | BKS000004            | Not Found | Pix key not found: `{pix_key}`                                               | Chave pix não encontrada: `{pix_key}`                                               |
| 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.                                                                 |
| 403                      | BKS000010            | Forbidden                                 | The pix key owner does not match the account owner.                                                                                     | O proprietário da chave pix não corresponde ao proprietário da conta.                                                             |
| 404                      | BKS000013            | Not Found | Requester profile not found         |               Carteira não encontrada                                                                 |
| 409                      | BKS000014            | Conflict           | Request control key already sent or duplicated sent: `{request_control_key}`                                                              | Chave de controle da requisição já utilizada ou enviada duplicada: `{request_control_key}`                                                                        |
| 400                      | BKS000016            | Bad Request                                        | Expiration date must be greater than the current date and have a maximum of 3650 days from the current date.                                    | A data de vencimento deve ser maior que a data atual e possuir no máximo 3650 dias corridos a partir da data atual.                                     |
| 409                      | BKS000017            | Conflict                                        | Our number already used or duplicated sent: `{our_number}`                                                                                       | Nosso número já utilizado ou enviado duplicado: `{our_number}`                                                                               |
| 400                      | BKS000018            | Bad Request                                        | The discount dates must be less than the expiration date and increasing.                                                      | A data dos descontos devem ser menores que a de expiração e crescentes.                                               |
| 400                      | BKS000019            | Bad Request                                        | Payer address is required for protest.                                                                                       | Endereço do pagador é obrigatório para protesto.                                                                         |
| 500                      | BKS000021            | Internal Server Error                                  | Error while trying to generate QR Code.                                                               | Erro ao tentar gerar QR Code de pagamento.                                                           |
| 400                      | BKS000022            | Bad Request                                        | Requester profile is not opened.                                                              | Carteira não está aberta.                          |
| 400                      | BKS000026            | Bad Request                      | Guarantor address is required for protest.                                                                                        | Endereço do sacador é obrigatório para protesto.                                                                   |
| 404                      | BKS000028            | Not Found             | Notary office attended region not found for postal code: `{postal_code}`                                                          | Região de cartório não encontrada para o CEP: `{postal_code}`                                                                                 |
| 400                      | BKS000043            | Bad Request             | Invalid discount numbering. Discounts must be numbered in ascending order and start on 1.          | Numeração dos descontos inválida. Os descontos devem ser numerados em ordem crescente e começar em 1.                                                           |
| 400                      | BKS000045            | Bad Request                                        | Rebate amount can not be equal or greater than the bank slip amount.                                                              | O valor do rebate não pode ser igual ou maior do que o valor do boleto.                          |
| 400                      | BKS000047            | Bad Request             | It was not possible to consult the sent pix key at this time. Please try again in a few minutes.          | Não foi possível consultar a chave pix enviada no momento. Por favor, tente novamente em alguns minutos.                                                           |
| 400                      | BKS000125            | Bad Request             | Partial payment data is required for this bank slip species type.          | Os dados de pagamento parcial são obrigatórios para o tipo de boleto fornecido.                                                           |
| 400                      | BKS000128            | Bad Request             | QR code payment is not allowed for partial payment.          | Pagamento via QR code não é permitido para pagamento parcial.                                                           |
| 400                      | BKS000128            | Bad Request             | QR code payment is not allowed for partial payment.          | Pagamento via QR code não é permitido para pagamento parcial.                                                           |
| 400                      | BKS000131            | Bad Request             | Rebate amount is not allowed for this bank slip species type.          | O valor de abatimento não é permitido para o tipo de boleto fornecido.                                                           |
| 400                      | BKS000132            | Bad Request             | Discount data is not allowed for this bank slip species type.          | Os dados de desconto não são permitidos para o tipo de boleto fornecido.                                                           |
| 400                      | BKS000133            | Bad Request             | Fine data is not allowed for this bank slip species type.          | Os dados de multa não são permitidos para o tipo de boleto fornecido.                                                           |
| 400                      | BKS000134            | Bad Request             | Interest data is not allowed for this bank slip species type.          | Os dados de juros não são permitidos para o tipo de boleto fornecido.                                                           |
| 400                      | BKS000136            | Bad Request             | Only credit card financial instrument type can have zero amount.          | Apenas o tipo de instrumento financeiro cartão de crédito pode ter valor zero.                                                           |

---

# Rebate cancellation

URL: /en/documentation/boletos/instrucoes/abatimento/cancelar_abatimento

Canceling a rebate means canceling the existing rebate for the bank slip. The cancellation must be performed if there is interest in removing the rebate or creating a new one.

:::caution Attention!
If there is any pending rebate cancellation request awaiting confirmation, or there is no active rebate, it is not possible to request the cancellation of a rebate.

Note: the rebate amount (`rebate_amount`) sent in the bank slip registration counts as an active rebate (if it is greater than R$0.00).
:::

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /cancel_rebate
METHOD POST

### 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         |
| `bank_slip_key`         | uuidv4 | Unique bank slip identification key, in uuid v4 format      | 36         |

Request Body

```json
{
  "request_control_key": "86864aec-a6c8-462e-8460-b05ef5a1eb62"
}
```

### Request Body Params

| Field                      | Type    | Description                                                                        | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|------------|
| `request_control_key` *    | uuidv4  | Unique request identification key used by the client in uuid v4 format            | 36         |

## Response

STATUS 202

Response Body

```json
{
  "occurrence_key": "539cefc8-382e-4fef-80e1-978a3a178a5c",
  "bank_slip_key": "d402e91a-32ac-4428-8357-d71824b113b5"
}
```

### Response Body Params

| Field              | Type   | Description                                                                       | Characters |
|--------------------|--------|-----------------------------------------------------------------------------------|------------|
| `occurrence_key` * | uuidv4 | Unique occurrence (instruction) identification key in uuid v4 format             | 36         |
| `bank_slip_key` *  | uuidv4 | Unique bank slip identification key in uuid v4 format                            | 36         |

### 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<br/>`status` | QI Code<br/>`code` | Title<br/>`title`                                 | Description (eng)<br/>`description`                                                                                       | Description (pt-br)<br/>`translation`                                                                                     |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 400                      | QIT000001            | Bad Request                                        | Schema Error                                                                                                            | Schema Inválido                                                                                                         |
| 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.                                                                 |
| 404                      | BKS000013            | Not Found | Requester profile not found         |               Carteira não encontrada                                                                 |
| 409                      | BKS000014            | Conflict | Request control key already sent or duplicated sent: `<request_control_key>` | Chave de controle da requisição já utilizada ou enviada duplicada: `<request_control_key>` |
| 400                      | BKS000022            | Bad Request                                        | Requester profile is not opened.                                                              | Carteira não está aberta.                          |
| 404                      | BKS000029            | Not Found                                        | Bank slip not found for the given key (`{bank_slip_key}`).                                                              | Boleto não encontrado para a chave fornecida (`{bank_slip_key}`).                          |
| 400                      | BKS000031            | Bad Request                                        | Bank slip must have an active rebate.                                                              | O boleto deve possuir um rebate ativo.                          |
| 400                      | BKS000032            | Bad Request                                        | Bank slip must be in 'registered' status.                                                              | O boleto deve possuir o status 'registered'.                          |
| 409                      | BKS000034            | Bad Request                                        | There is already a pending cancel rebate occurrence for this bank slip.                                                              | Já existe uma ocorrência de cancelamento de rebate pendente para este boleto.                          |

---

# Create Rebate

URL: /en/documentation/boletos/instrucoes/abatimento/criar_abatimento

Creating a rebate for the bank slip means reducing part of the base value of the title to decrease the final amount.

:::caution Attention!
If there is any pending rebate request waiting for confirmation, or any active rebate, creating a new rebate is not allowed. If there is an active rebate and you want to change it, a rebate cancellation request must be sent first. Once it is confirmed, it is possible to create another rebate.

Note: the rebate amount (`rebate_amount`) sent in the bank slip registration does not count as a pending rebate request, but counts as an active rebate request.
:::

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /rebate
METHOD POST

### 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         |
| `bank_slip_key`         | uuidv4 | Unique bank slip identification key, in uuid v4 format      | 36         |

Request Body

```json
{
  "request_control_key": "d66b807a-25fa-4e21-b198-9beb221a29ce",
  "rebate_amount": 150.00
}
```

### Request Body Params

| Field                     | Type    | Description                                                                        | Characters |
|---------------------------|---------|------------------------------------------------------------------------------------|------------|
| `request_control_key` *   | uuidv4  | Unique request identification key used by the client in uuid v4 format            | 36         |
| `rebate_amount` *         | float   | Absolute rebate amount                                                             | -          |

## Response

STATUS 202

Response Body

```json
{
  "occurrence_key": "7f01165b-fdd0-4f59-b231-42170ea90131",
  "bank_slip_key": "dad779c1-5e1c-422e-9f36-c704916a87cf"
}
```

### Response Body Params

| Field             | Type   | Description                                                                       | Characters |
|-------------------|--------|-----------------------------------------------------------------------------------|------------|
| `occurrence_key` *| uuidv4 | Unique occurrence (instruction) identification key in uuid v4 format             | 36         |
| `bank_slip_key` * | uuidv4 | Unique bank slip identification key in uuid v4 format                            | 36         |

### 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<br/>`status` | QI Code<br/>`code` | Title<br/>`title`                                 | Description (eng)<br/>`description`                                                                                       | Description (pt-br)<br/>`translation`                                                                                     |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 400                      | QIT000001            | Bad Request                                        | Schema Error                                                                                                            | Schema Inválido                                                                                                         |
| 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.                                                                 |
| 404                      | BKS000013            | Not Found | Requester profile not found         |               Carteira não encontrada                                                                 |
| 409                      | BKS000014            | Conflict | Request control key already sent or duplicated sent: `<request_control_key>` | Chave de controle da requisição já utilizada ou enviada duplicada: `<request_control_key>` |
| 400                      | BKS000022            | Bad Request                                        | Requester profile is not opened.                                                              | Carteira não está aberta.                          |
| 404                      | BKS000029            | Not Found                                        | Bank slip not found for the given key (`{bank_slip_key}`).                                                              | Boleto não encontrado para a chave fornecida (`{bank_slip_key}`).                          |
| 409                      | BKS000030            | Conflict                                        | There is already a pending rebate occurrence for this bank slip.                                                              | Já existe uma ocorrência de rebate pendente para este boleto.                          |
| 400                      | BKS000032            | Bad Request                                        | Bank slip must be in 'registered' status.                                                              | O boleto deve possuir o status 'registered'.                          |
| 409                      | BKS000033            | Conflict                                        | This bank slip already has an active rebate. You must send a 'cancel_rebate' occurrence before trying to create another one. one.                                                              | Este boleto já possui um rebate ativo. Você deve mandar uma ocorrência do tipo 'cancel_rebate' antes de tentar criar outro.                          |
| 400                      | BKS000045            | Bad Request                                        | Rebate amount can not be equal or greater than the bank slip amount.                                                              | O valor do rebate não pode ser igual ou maior do que o valor do boleto.                          |

---

# Write-off

URL: /en/documentation/boletos/instrucoes/baixa

When a bank slip is written off, it becomes unavailable for payment. In other words, the bank slip is "canceled".

:::caution Attention!
If there is any write-off request pending confirmation, creating a new request is not allowed.
:::

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /write_off
METHOD POST

### 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         |
| `bank_slip_key`         | uuidv4 | Unique bank slip identification key, in uuid v4 format        | 36         |

Request Body

```json
{
  "request_control_key": "614a451d-3b82-460e-bcc0-2caf3dde711f"
}
```

### Request Body Params

| Field                      | Type    | Description                                                                          | Characters |
|----------------------------|---------|--------------------------------------------------------------------------------------|------------|
| `request_control_key` *    | uuidv4  | Unique request identification key used by the client in uuid v4 format              | 36         |

## Response

STATUS 202

Response Body

```json
{
  "occurrence_key": "2552bd64-950b-437e-a53a-a133ffea03d7",
  "bank_slip_key": "960f78d4-4426-4762-98da-3ce3713ae0a5"
}
```

### Response Body Params

| Field              | Type   | Description                                                                         | Characters |
|--------------------|--------|-------------------------------------------------------------------------------------|------------|
| `occurrence_key` * | uuidv4 | Unique occurrence (instruction) identification key in uuid v4 format               | 36         |
| `bank_slip_key` *  | uuidv4 | Unique bank slip identification key in uuid v4 format                              | 36         |

### 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<br/>`status` | QI Code<br/>`code` | Title<br/>`title`                                 | Description (eng)<br/>`description`                                                                                       | Description (pt-br)<br/>`translation`                                                                                     |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 400                      | QIT000001            | Bad Request                                        | Schema Error                                                                                                            | Schema Inválido                                                                                                         |
| 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.                                                                 |
| 404                      | BKS000013            | Not Found | Requester profile not found         |               Carteira não encontrada                                                                 |
| 409                      | BKS000014            | Conflict | Request control key already sent or duplicated sent: `<request_control_key>` | Chave de controle da requisição já utilizada ou enviada duplicada: `<request_control_key>` |
| 400                      | BKS000022            | Bad Request                                        | Requester profile is not opened.                                                              | Carteira não está aberta.                          |
| 404                      | BKS000029            | Not Found                                        | Bank slip not found for the given key (`{bank_slip_key}`).                                                              | Boleto não encontrado para a chave fornecida (`{bank_slip_key}`).                          |
| 400                      | BKS000032            | Bad Request                                        | Bank slip must be in 'registered' status.                                                              | O boleto deve possuir o status 'registered'.                          |
| 409                      | BKS000049            | Conflict                                        | There is already a pending write off occurrence for this bank slip. Please, wait for the confirmation of this occurrence before sending another one. one.                                                              | Já existe uma ocorrência de baixa pendente para este boleto. Por favor, aguarde a confirmação dessa ocorrência antes de enviar outra.                          |

---

# Discount

URL: /en/documentation/boletos/instrucoes/desconto

The discount instruction is used to apply discounts with various calculation rule possibilities. If discounts already exist for the bank slip in question, and a discount instruction is accepted, the previously existing discounts will be overwritten.

:::caution Attention!
If there is any pending discount addition request awaiting confirmation, creating a new request is not allowed.
:::

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /discount
METHOD POST

### 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         |
| `bank_slip_key`         | uuidv4 | Unique bank slip identification key, in uuid v4 format  | 36         |

Request Body

```json
{
    "request_control_key": "2e2f0053-a988-40c7-ad17-41c4c4da861e",
    "discounts_data": [
        {
            "discount_type": "anticipation_workdays_daily_percentage",
            "discount_percentage": 2,
            "discount_number": 1,
            "discount_limit_date": "2024-12-01"
        },
        {
            "discount_type": "anticipation_workdays_daily_percentage",
            "discount_percentage": 1,
            "discount_number": 2,
            "discount_limit_date": "2025-01-02"
        }
    ]
}
```

### Request Body Params

| Field                      | Type    | Description                                                                        | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|------------|
| `request_control_key` *    | uuidv4  | Unique request identification key used by the client in uuid v4 format            | 36         |
| `discounts_data`           | object array | Discounts                                  | **[discount object](#discount-object)** |

### discount object

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_type-enumerators)** |
| `discount_limit_date` *   | string  | Discount application limit date                     | 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_type-enumerators)** |
| `discount_limit_date` *   | string  | Discount application limit date                     | 10                                                        |

:::caution 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, in ascending order and necessarily starting at 1. That is, if two discounts are sent in the request, they must necessarily be numbered 1 and 2.
:::

### discount_type enumerators

| Enumerator                                  | Description                                                          |
|---------------------------------------------|----------------------------------------------------------------------|
| absolute                                    | Fixed value                                                          |
| anticipation_calendar_days_daily_amount     | Daily anticipation discount amount, over calendar days               |
| anticipation_workdays_daily_amount          | Daily anticipation discount amount, over business days               |
| 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 business days      |

## Response

STATUS 202

Response Body

```json
{
  "occurrence_key": "aaf64135-6bd8-4d49-be6f-e8f884b20ee7",
  "bank_slip_key": "470cfcae-159b-4de4-ad22-2d3b2dd717f7"
}
```

### Response Body Params

| Field              | Type   | Description                                                               | Characters |
|--------------------|--------|---------------------------------------------------------------------------|------------|
| `occurrence_key` * | uuidv4 | Unique occurrence (instruction) identification key in uuid v4 format     | 36         |
| `bank_slip_key` *  | uuidv4 | Unique bank slip identification key in uuid v4 format                    | 36         |

### 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<br/>`status` | QI Code<br/>`code` | Title<br/>`title`                                 | Description (eng)<br/>`description`                                                                                       | Description (pt-br)<br/>`translation`                                                                                     |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 400                      | QIT000001            | Bad Request                                        | Schema Error                                                                                                            | Schema Inválido                                                                                                         |
| 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.                                                                 |
| 404                      | BKS000013            | Not Found | Requester profile not found         |               Carteira não encontrada                                                                 |
| 409                      | BKS000014            | Conflict | Request control key already sent or duplicated sent: `<request_control_key>` | Chave de controle da requisição já utilizada ou enviada duplicada: `<request_control_key>` |
| 400                      | BKS000018            | Bad Request                                        | The discount dates must be less than the expiration date and increasing.                                                              | A data dos descontos devem ser menores que a de expiração e crescentes.                         |
| 400                      | BKS000022            | Bad Request                                        | Requester profile is not opened.                                                              | Carteira não está aberta.                          |
| 404                      | BKS000029            | Not Found                                        | Bank slip not found for the given key (`{bank_slip_key}`).                                                              | Boleto não encontrado para a chave fornecida (`{bank_slip_key}`).                          |
| 400                      | BKS000032            | Bad Request                                        | Bank slip must be in 'registered' status.                                                              | O boleto deve possuir o status 'registered'.                          |
| 400                      | BKS000043            | Bad Request                                        | Invalid discount numbering. Discounts must be numbered in ascending order and start on 1.                                                              | Numeração dos descontos inválida. Os descontos devem ser numerados em ordem crescente e começar em 1.                          |
| 400                      | BKS000046            | Bad Request                                        | Invalid discount type. All types in the discount list must be the same.                                                              | Tipo de desconto inválido. Todos os tipos da lista de descontos devem ser iguais.                          |
| 409                      | BKS000048            | Conflict                                        | There is already a pending discount occurrence for this bank slip. Please, wait for the confirmation of this occurrence before sending another one.                                                              | Já existe uma ocorrência de desconto pendente para este boleto. Por favor, aguarde a confirmação dessa ocorrência antes de enviar outra.                          |

---

# Edit

URL: /en/documentation/boletos/instrucoes/edicao

The edit instruction serves to modify configurable data of the bank slip after its issuance, such as automatic write-off settings, protest, bankruptcy protest, and payer data. This instruction allows updating multiple aspects of the bank slip in a single request.

:::caution Attention!
The bank slip must be in 'registered' status for it to be editable. At least one of the data fields (`write_off_data`, `protest_data`, `bankruptcy_protest_data` or `payer_data`) must be provided along with the `request_control_key`.
:::

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /bank_slip_edit
METHOD POST

### 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         |
| `bank_slip_key`         | uuidv4 | Unique bank slip identification key, in uuid v4 format       | 36         |

Request Body

```json
{
  "request_control_key": "c4dd443a-6e2f-4261-8f28-adfa4c0d4c5b",
  "write_off_data": {"days_to_write_off": 365},
  "protest_data": {"days_to_protest": 7},
  "bankruptcy_protest_data": {"days_to_bankruptcy_protest": 14},
  "payer_data": {
    "contact": {
      "email": "finance@globaltech.com",
      "phone": {"international_dial_code": "055", "area_code": "11", "number": "987654321"},
    },
    "address": {
      "street": "101 High St.",
      "neighborhood": "Tech Park",
      "number": "202",
      "postal_code": "01001000",
      "city": "Innovation City",
      "state": "SP",
      "complement": "Building A",
    },
  },
}
```

### Request Body Params

| Field                      | Type    | Description                                                                        | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|------------|
| `request_control_key` *    | uuidv4  | Unique request identification key used by the client in uuid v4 format            | 36         |
| `write_off_data`           | object  | Automatic write-off settings (null to remove)                                     | **[write_off_data Object](#write_off_data-object)** |
| `protest_data`             | object  | Protest settings (null to remove)                                                 | **[protest_data Object](#protest_data-object)** |
| `bankruptcy_protest_data`  | object  | Bankruptcy protest settings (null to remove)                                      | **[bankruptcy_protest_data Object](#bankruptcy_protest_data-object)** |
| `payer_data`               | object  | Payer data (`address` null or `contact` null to remove)                          | **[payer_data Object](#payer_data-object)** |

:::info Note
At least one of the data fields (`write_off_data`, `protest_data`, `bankruptcy_protest_data` or `payer_data`) must be provided in the request.
:::

### write_off_data Object

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

### protest_data Object

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

### bankruptcy_protest_data Object

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

### payer_data Object

| Field                     | Type   | Description                                                    | Characters|
|---------------------------|--------|----------------------------------------------------------------|-----------|
| `contact`                 | object | Contact information                                            | **[contact Object](#contact-object)**                     |
| `address`                 | object | Address                                                        | **[address Object](#address-object)**                     |

### contact Object

| Field                     | Type   | Description                       | Characters                         |
|---------------------------|--------|-----------------------------------|------------------------------------|
| `email`                   | string | Contact email                     | 320                                |
| `phone`                   | object | Contact phone                     | **[phone Object](#phone-object)**  |

### phone Object

| Field                           | Type   | Description                                      | Characters |
|---------------------------------|--------|--------------------------------------------------|------------|
| `international_dial_code` *     | string | International Direct Dialing Code               | 3          |
| `area_code` *                   | string | Area Code                                        | 2          |
| `number` *                      | string | Number                                           | 9          |

### address Object

| 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](#state-enumerators)** |

### state Enumerators

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

## Response

STATUS 200

Response Body

```json
{
  "occurrence_key": "5a745b65-9a2c-44eb-b43e-c80ef5429d94",
  "bank_slip_key": "fdafdffa-cbd4-4f3c-8e3d-990428305161"
}
```

### Response Body Params

| Field              | Type   | Description                                                                       | Characters |
|--------------------|--------|-----------------------------------------------------------------------------------|------------|
| `occurrence_key` * | uuidv4 | Unique occurrence (instruction) identification key in uuid v4 format             | 36         |
| `bank_slip_key` *  | uuidv4 | Unique bank slip identification key in uuid v4 format                            | 36         |

### 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<br/>`status` | QI Code<br/>`code` | Title<br/>`title`                                  | Description (eng)<br/>`description`                                                                                     | Description (pt-br)<br/>`translation`                                                                                     |
|------------------------|--------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 400                    | QIT000001          | Bad Request                                        | Schema Error                                                                                                            | Schema Inválido                                                                                                         |
| 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.                                                                                       |
| 404                    | BKS000013          | Not Found                                          | Requester profile not found                                                                                            | Carteira não encontrada                                                                                                 |
| 409                    | BKS000014          | Conflict                                           | Request control key already sent or duplicated sent: `<request_control_key>`                                           | Chave de controle da requisição já utilizada ou enviada duplicada: `<request_control_key>`                             |
| 400                    | BKS000022          | Bad Request                                        | Requester profile is not opened.                                                                                       | Carteira não está aberta.                                                                                              |
| 404                    | BKS000029          | Not Found                                          | Bank slip not found for the given key (`{bank_slip_key}`).                                                             | Boleto não encontrado para a chave fornecida (`{bank_slip_key}`).                                                      |
| 400                    | BKS000032          | Bad Request                                        | Bank slip must be in 'registered' status.                                                                              | O boleto deve possuir o status 'registered'.                                                                           |

---

# Extension

URL: /en/documentation/boletos/instrucoes/extensao

The extension request serves to extend the due date of the bank slip.

:::caution Attention!
If there is any extension request pending confirmation, creating a new request is not allowed.
:::

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /extension
METHOD POST

### 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         |
| `bank_slip_key`         | uuidv4 | Unique bank slip identification key, in uuid v4 format      | 36         |

Request Body

```json
{
  "request_control_key": "2e2f0053-a988-40c7-ad17-41c4c4da861e",
  "new_expiration_date": "2025-01-01"
}
```

### Request Body Params

| Field                      | Type    | Description                                                                        | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|------------|
| `request_control_key` *    | uuidv4  | Unique request identification key used by the client in uuid v4 format            | 36         |
| `new_expiration_date` *    | string  | New expiration date, in "YYYY-MM-DD" format                                       | 10         |

## Response

STATUS 202

Response Body

```json
{
  "occurrence_key": "6f2eb385-898f-4fa3-96df-80a76a30ad01",
  "bank_slip_key": "0d462dda-7412-444f-ace9-375e4ab43c2f"
}
```

### Response Body Params

| Field              | Type   | Description                                                                       | Characters |
|--------------------|--------|-----------------------------------------------------------------------------------|------------|
| `occurrence_key` * | uuidv4 | Unique occurrence (instruction) identification key in uuid v4 format             | 36         |
| `bank_slip_key` *  | uuidv4 | Unique bank slip identification key in uuid v4 format                            | 36         |

### 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<br/>`status` | QI Code<br/>`code` | Title<br/>`title`                                 | Description (eng)<br/>`description`                                                                                       | Description (pt-br)<br/>`translation`                                                                                     |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 400                      | QIT000001            | Bad Request                                        | Schema Error                                                                                                            | Schema Inválido                                                                                                         |
| 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.                                                                 |
| 404                      | BKS000013            | Not Found | Requester profile not found         |               Carteira não encontrada                                                                 |
| 409                      | BKS000014            | Conflict | Request control key already sent or duplicated sent: `<request_control_key>` | Chave de controle da requisição já utilizada ou enviada duplicada: `<request_control_key>` |
| 400                      | BKS000022            | Bad Request                                        | Requester profile is not opened.                                                              | Carteira não está aberta.                          |
| 404                      | BKS000029            | Not Found                                        | Bank slip not found for the given key (`{bank_slip_key}`).                                                              | Boleto não encontrado para a chave fornecida (`{bank_slip_key}`).                          |
| 400                      | BKS000032            | Bad Request                                        | Bank slip must be in 'registered' status.                                                              | O boleto deve possuir o status 'registered'.                          |
| 400                      | BKS000041            | Bad Request                                        | The new expiration date must be greater than the current expiration date.                                                              | A nova data de expiração deve ser posterior à data de expiração atual.                          |
| 409                      | BKS000042            | Conflict                                        | There is already a pending extension occurrence for this bank slip. Please, wait for the confirmation of this occurrence before sending another one.                                                              | Já existe uma ocorrência de extensão pendente para este boleto. Por favor, aguarde a confirmação dessa ocorrência antes de enviar outra.                          |

---

# Interest

URL: /en/documentation/boletos/instrucoes/juros

The interest instruction is used to configure the interest that will be applied if the bank slip is paid after the due date. If there is already an interest configuration for the bank slip in question, and an interest instruction is accepted, the previously existing configuration will be overwritten.

:::caution Attention!
If there is any pending interest instruction awaiting confirmation, sending a new instruction is not allowed.
:::

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /interest
METHOD POST

### 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         |
| `bank_slip_key`         | uuidv4 | Unique bank slip identification key in uuid v4 format         | 36         |

Request Body

```json
{
  "request_control_key": "c4dd443a-6e2f-4261-8f28-adfa4c0d4c5b",
  "interest_data": {
    "interest_type": "calendar_days_daily_amount",
    "interest_amount": 50.00,
    "days_to_interest": 5
  }
}
```

### Request Body Params

| Field                      | Type    | Description                                                                       | Characters |
|----------------------------|---------|-----------------------------------------------------------------------------------|------------|
| `request_control_key` *    | uuidv4  | Unique request identification key used by the client in uuid v4 format           | 36         |
| `interest_data`            | object  | Interest configurations                      | **[interest_data Object](#interest_data-object)** |

### interest_data Object

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_type-enumerators)** |
| `interest_amount` *       | float   | Amount to be charged per determined time unit (working days or calendar days)     | -                                                                                               |
| `days_to_interest` *      | integer | Days after due date for interest to start being charged                           | -                                                                                               |

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_type-enumerators)** |
| `interest_percentage` *  | integer | Percentage to be charged per determined time unit (working days or calendar days)      | -                                                                           |
| `days_to_interest` *     | integer | Days after due date for interest to start being charged                                | -                                                                                                   |

### interest_type Enumerators

| Enumerator                       | Description                                                      |
|----------------------------------|------------------------------------------------------------------|
| calendar_days_daily_amount       | Daily amount on calendar days                                    |
| workdays_daily_amount            | Daily amount on working days                                     |
| calendar_days_monthly_percentage | Monthly interest percentage charged based on calendar days       |

## Response

STATUS 202

Response Body

```json
{
  "occurrence_key": "5a745b65-9a2c-44eb-b43e-c80ef5429d94",
  "bank_slip_key": "fdafdffa-cbd4-4f3c-8e3d-990428305161"
}
```

### Response Body Params

| Field              | Type   | Description                                                                       | Characters |
|--------------------|--------|-----------------------------------------------------------------------------------|------------|
| `occurrence_key` * | uuidv4 | Unique occurrence (instruction) identification key in uuid v4 format             | 36         |
| `bank_slip_key` *  | uuidv4 | Unique bank slip identification key in uuid v4 format                            | 36         |

### Error Response

STATUS 4xx

Response Body: Error

```json
{
  "title": "titulo",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "codigo",
  "extra_fields": {}
}
```

| HTTP Status<br/>`status` | QI Code<br/>`code` | Title<br/>`title`                                 | Description (eng)<br/>`description`                                                                                       | Description (pt-br)<br/>`translation`                                                                                     |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 400                      | QIT000001            | Bad Request                                        | Schema Error                                                                                                            | Schema Inválido                                                                                                         |
| 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.                                                                 |
| 404                      | BKS000013            | Not Found | Requester profile not found         |               Carteira não encontrada                                                                 |
| 409                      | BKS000014            | Conflict | Request control key already sent or duplicated sent: `<request_control_key>` | Chave de controle da requisição já utilizada ou enviada duplicada: `<request_control_key>` |
| 400                      | BKS000018            | Bad Request                                        | The discount dates must be less than the expiration date and increasing.                                                              | A data dos descontos devem ser menores que a de expiração e crescentes.                         |
| 400                      | BKS000022            | Bad Request                                        | Requester profile is not opened.                                                              | Carteira não está aberta.                          |
| 404                      | BKS000029            | Not Found                                        | Bank slip not found for the given key (`{bank_slip_key}`).                                                              | Boleto não encontrado para a chave fornecida (`{bank_slip_key}`).                          |
| 400                      | BKS000032            | Bad Request                                        | Bank slip must be in 'registered' status.                                                              | O boleto deve possuir o status 'registered'.                          |
| 409                      | BKS000051            | Conflict                                        | There is already a pending interest occurrence for this bank slip. Please, wait for the confirmation of this occurrence before sending another one.                                                              | Já existe uma ocorrência de juros pendente para este boleto. Por favor, aguarde a confirmação dessa ocorrência antes de enviar outra.                          |

---

# Query instruction batch

URL: /en/documentation/boletos/instrucoes/lote/consultar_lote_de_instrucoes

Returns the detail of a previously created batch, with the list of generated occurrences and the individual status of each one, along with basic data of the related bank slip.

## Request

ENDPOINT /v2/bank_slip/account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /occurrence_batches/ BATCH_KEY /results
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         |
| `batch_key`             | uuidv4 | Batch key (returned by the create POST)                     | 36         |

## Response

STATUS 200

Response Body

```json
{
  "batch_key": "f2d3e1b9-4a5c-46e7-8f12-9a8b7c6d5e4f",
  "requester_profile_key": "8217da98-3e26-4ca5-8b86-698bfa50b0df",
  "occurrence_type": "extension",
  "occurrence_quantity": 2,
  "accepted_quantity": 2,
  "created_at": "2026-06-09T17:08:33Z",
  "items": [
    {
      "bank_slip_key": "960f78d4-4426-4762-98da-3ce3713ae0a5",
      "occurrence_key": "2552bd64-950b-437e-a53a-a133ffea03d7",
      "request_control_key": "c86d8902-a5ae-4d1f-8872-e6fea1268aab",
      "occurrence_type": "extension",
      "payer_name": "Global Tech",
      "payer_document": "12345678000195",
      "amount": 5000.00,
      "our_number": "123456789",
      "requester_occurrence_status": "accepted",
      "registration_institution_occurrence_status": "submitted",
      "created_at": "2026-06-09T17:08:33Z"
    }
  ]
}
```

### Response Body Params

| Field                     | Type    | Description                                                                              |
|---------------------------|---------|------------------------------------------------------------------------------------------|
| `batch_key` *             | uuidv4  | Batch key                                                                                |
| `requester_profile_key` * | uuidv4  | Key of the wallet that owns the batch                                                    |
| `occurrence_type` *       | string  | Instruction type of the batch                                                            |
| `occurrence_quantity` *   | integer | Total number of items sent in the batch                                                  |
| `accepted_quantity` *     | integer | Number of items accepted in the batch                                                    |
| `created_at` *            | string  | UTC creation date/time of the batch (ISO 8601 with `Z` suffix)                           |
| `items` *                 | array   | List of occurrences generated by the batch. See **[item object](#item-object)**          |

### item object

| Field                                          | Type    | Description                                                                              |
|------------------------------------------------|---------|------------------------------------------------------------------------------------------|
| `bank_slip_key` *                              | uuidv4  | Bank slip key of the occurrence                                                          |
| `occurrence_key` *                             | uuidv4  | Unique key of the created occurrence                                                     |
| `request_control_key` *                        | string  | Item's client-provided control key                                                       |
| `occurrence_type` *                            | string  | Instruction type                                                                         |
| `payer_name`                                   | string  | Bank slip payer name                                                                     |
| `payer_document`                               | string  | Payer document                                                                           |
| `amount`                                       | float   | Bank slip base amount                                                                    |
| `our_number`                                   | string  | Bank slip "our number"                                                                   |
| `requester_occurrence_status`                  | string  | Occurrence status from the requester's perspective (e.g. `accepted`, `rejected`)         |
| `registration_institution_occurrence_status`   | string  | Occurrence status at the registration institution (e.g. `submitted`, `confirmed`)        |
| `created_at` *                                 | string  | UTC creation date/time of the occurrence (ISO 8601 with `Z` suffix)                      |

### Error Response

STATUS 4xx

Response Body: Error

```json
{
  "title": "title",
  "description": "description in English",
  "translation": "descrição em português",
  "code": "code",
  "extra_fields": {}
}
```

| HTTP code<br/>`status` | QI code<br/>`code` | Title<br/>`title` | Description (eng)<br/>`description`                              | Description (pt-br)<br/>`translation`                              |
|------------------------|--------------------|--------------------|------------------------------------------------------------------|--------------------------------------------------------------------|
| 404                    | BKS000013          | Not Found          | Requester profile not found                                      | Carteira não encontrada                                            |

:::caution Attention!
When the `batch_key` does not exist or does not belong to the informed `requester_profile_key`, the API returns the same `BKS000013` ("Requester profile not found"). Check whether the `batch_key` was created under the wallet used in the query.
:::

---

# Create instruction batch

URL: /en/documentation/boletos/instrucoes/lote/criar_lote_de_instrucoes

Allows sending, in a single request, multiple instructions of the same type (write-off, rebate, extension, protest, etc.) over distinct bank slips. QI Tech validates the whole batch and either accepts every item or processes none.

- If **any** item fails semantic validation, **no** items in the batch are processed. The error response details, per rejected item, the reason for rejection.
- If every item passes, the occurrences are created and processed individually, asynchronously. The requester is notified via [**webhook**](/documentation/boletos/v2/webhooks/boleto) as each occurrence changes status.

:::info Idempotency
The batch-level `request_control_key` guarantees idempotency: resending the same key returns the batch already created, without duplication.

Each item also has its own `request_control_key` and is individually idempotent. Resending an item with a `request_control_key` already used makes the entire batch be rejected.
:::

:::caution Attention!
This operation is only available for wallets registered with the **QI SCD** registration institution.
:::

## Request

ENDPOINT /v2/bank_slip/account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /occurrence_batches
METHOD POST

### 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         |

Request Body

```json
{
  "request_control_key": "614a451d-3b82-460e-bcc0-2caf3dde711f",
  "occurrence_type": "extension",
  "items": [
    {
      "bank_slip_key": "960f78d4-4426-4762-98da-3ce3713ae0a5",
      "request_control_key": "c86d8902-a5ae-4d1f-8872-e6fea1268aab",
      "new_due_date": "2026-08-15"
    },
    {
      "bank_slip_key": "5e3a1b2c-7d9f-4e88-9012-3a4b5c6d7e8f",
      "request_control_key": "b3a428fd-58ee-4d6f-8872-633874ebf5e2",
      "new_due_date": "2026-08-20"
    }
  ]
}
```

### Request Body Params

| Field                   | Type                                          | Description                                                                       | Characters |
|-------------------------|-----------------------------------------------|-----------------------------------------------------------------------------------|------------|
| `request_control_key` * | string                                        | Unique batch key, defined by the client. Ensures batch idempotency                 | 1–64       |
| `occurrence_type` *     | string                                        | Instruction type applied to every item. See **[occurrence_type enumerators](#occurrence_type-enumerators)** | -          |
| `items` *               | Array of **[item object](#item-object)**      | List of instructions (minimum 1, maximum 10000)                                    | -          |

### occurrence_type enumerators

| Enumerator               | Description                                                       |
|--------------------------|-------------------------------------------------------------------|
| `extension`              | Due-date extension — requires `new_due_date` on each item          |
| `rebate`                 | Apply rebate — requires `rebate_amount` on each item               |
| `cancel_rebate`          | Cancel a previously applied rebate                                 |
| `write_off`              | Write off the bank slip                                            |
| `protest_request`        | Protest request                                                    |
| `protest_cancel_request` | Withdraw a pending protest request                                 |
| `protest_remove_request` | Remove (cancel) a registered protest                               |

### item object

| Field                   | Type     | Description                                                                       | Characters |
|-------------------------|----------|-----------------------------------------------------------------------------------|------------|
| `bank_slip_key` *       | uuidv4   | Key of the bank slip the instruction will be applied to                            | 36         |
| `request_control_key` * | string   | Unique item key, defined by the client. Ensures per-item idempotency               | 1–64       |
| `new_due_date`          | string   | New due date (`YYYY-MM-DD`). Required when `occurrence_type=extension`             | 10         |
| `rebate_amount`         | float    | Rebate amount. Required when `occurrence_type=rebate`                              | -          |

## Response

STATUS 201

Response Body

```json
{
  "batch_key": "f2d3e1b9-4a5c-46e7-8f12-9a8b7c6d5e4f",
  "occurrence_quantity": 2,
  "accepted_quantity": 2,
  "semantic_errors": []
}
```

### Response Body Params

| Field                   | Type    | Description                                                                                 | Characters |
|-------------------------|---------|---------------------------------------------------------------------------------------------|------------|
| `batch_key` *           | uuidv4  | Unique batch key. Use it to query the batch detail                                          | 36         |
| `occurrence_quantity` * | integer | Total number of items sent in the batch                                                     | -          |
| `accepted_quantity` *   | integer | Number of items accepted in the batch                                                       | -          |
| `semantic_errors` *     | array   | Empty array on success. On semantic rejection, see **[Error Response](#error-response)**    | -          |

### Error Response

STATUS 4xx

Response Body: Error

```json
{
  "title": "title",
  "description": "description in English",
  "translation": "descrição em português",
  "code": "code",
  "extra_fields": {}
}
```

On semantic rejection (`BLP000112`), the `reasons` field of the response details every rejected item:

Response Body: Semantic rejection

```json
{
  "title": "Unprocessable Entity",
  "description": "Rejected Remittance",
  "translation": "Remessa Rejeitada",
  "code": "BLP000112",
  "reasons": [
    {
      "occurrence_sequence": "0",
      "bank_slip_key": "960f78d4-4426-4762-98da-3ce3713ae0a5",
      "request_control_key": "c86d8902-a5ae-4d1f-8872-e6fea1268aab",
      "errors": [
        {
          "reason_code": "15",
          "translation_pt_br": "Boleto não encontrado",
          "translation_en_us": "Bank slip not found",
          "created_at": "2026-06-09T17:08:33"
        }
      ]
    }
  ]
}
```

### `reasons[]` object fields

| Field                       | Type    | Description                                                                          |
|-----------------------------|---------|--------------------------------------------------------------------------------------|
| `occurrence_sequence` *     | string  | Item position in the request's `items` array (starting at `"0"`)                     |
| `bank_slip_key` *           | uuidv4  | Bank slip key of the rejected item                                                   |
| `request_control_key` *     | string  | Item's client-provided control key                                                   |
| `errors` *                  | array   | List of rejection reasons (an item may have multiple)                                |
| `errors[].reason_code` *    | string  | Rejection reason code (Febraban standard)                                            |
| `errors[].translation_pt_br`| string  | Portuguese description of the reason                                                 |
| `errors[].translation_en_us`| string  | English description of the reason                                                    |
| `errors[].created_at`       | string  | Catalog registration date of the reason                                              |

### Error codes

| HTTP code<br/>`status` | QI code<br/>`code` | Title<br/>`title`    | Description (eng)<br/>`description`                                                         | Description (pt-br)<br/>`translation`                                                        |
|------------------------|--------------------|----------------------|---------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|
| 400                    | QIT000001          | Bad Request          | Schema Error                                                                                | Schema Inválido                                                                              |
| 400                    | BKS000141          | Bad Request          | Bank slip registration is restricted to QI SCD.                                             | Registro de boleto permitido apenas para QI SCD.                                             |
| 404                    | BKS000013          | Not Found            | Requester profile not found                                                                 | Carteira não encontrada                                                                      |
| 409                    | BKS000014          | Conflict             | Request control key already sent or duplicated sent: `<request_control_key>`                | Chave de controle da requisição já utilizada ou enviada duplicada: `<request_control_key>`   |
| 422                    | BLP000112          | Unprocessable Entity | Rejected Remittance                                                                         | Remessa Rejeitada                                                                            |

---

# List instruction batches

URL: /en/documentation/boletos/instrucoes/lote/listar_lotes_de_instrucoes

Lists, with pagination, the instruction batches created for a wallet, with optional filters by instruction type and date range.

## Request

ENDPOINT /v2/bank_slip/account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /occurrence_batches
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                                                                                  |
|-------------------|---------|----------------------------------------------------------------------------------------------|
| `page`            | integer | Query page (default `1`)                                                                     |
| `page_size`       | integer | Number of batches per page (default `20`, max `100`)                                         |
| `occurrence_type` | string  | Filter by instruction type. Accepts the same enumerators as the create POST                  |
| `from_date`       | string  | Start date, inclusive, in `YYYY-MM-DD` format. Filters over the batch's `created_at`         |
| `to_date`         | string  | End date, inclusive, in `YYYY-MM-DD` format. Filters over the batch's `created_at`           |

## Response

STATUS 200

Response Body

```json
{
  "data": [
    {
      "batch_key": "f2d3e1b9-4a5c-46e7-8f12-9a8b7c6d5e4f",
      "request_control_key": "614a451d-3b82-460e-bcc0-2caf3dde711f",
      "requester_profile_key": "8217da98-3e26-4ca5-8b86-698bfa50b0df",
      "occurrence_type": "extension",
      "occurrence_quantity": 14,
      "accepted_quantity": 14,
      "created_at": "2026-06-09T17:08:33Z"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 20,
    "total": 1
  }
}
```

### Response Body Params

| Field                            | Type    | Description                                                              |
|----------------------------------|---------|--------------------------------------------------------------------------|
| `data` *                         | array   | List of batches on the current page                                      |
| `data[].batch_key` *             | uuidv4  | Batch key                                                                |
| `data[].request_control_key` *   | string  | Client-provided control key from batch creation                          |
| `data[].requester_profile_key` * | uuidv4  | Key of the wallet that owns the batch                                    |
| `data[].occurrence_type` *       | string  | Instruction type of the batch                                            |
| `data[].occurrence_quantity` *   | integer | Total number of items sent in the batch                                  |
| `data[].accepted_quantity` *     | integer | Number of items accepted in the batch                                    |
| `data[].created_at` *            | string  | UTC creation date/time of the batch (ISO 8601 with `Z` suffix)           |
| `pagination` *                   | object  | Pagination metadata                                                      |
| `pagination.page` *              | integer | Current page                                                             |
| `pagination.page_size` *         | integer | Page size                                                                |
| `pagination.total` *             | integer | Total number of batches matching the filters                             |

### Error Response

STATUS 4xx

| HTTP code<br/>`status` | QI code<br/>`code` | Title<br/>`title` | Description (eng)<br/>`description` | Description (pt-br)<br/>`translation` |
|------------------------|--------------------|--------------------|-------------------------------------|---------------------------------------|
| 400                    | QIT000001          | Bad Request        | Schema Error                        | Schema Inválido                       |
| 404                    | BKS000013          | Not Found          | Requester profile not found         | Carteira não encontrada               |

---

# Fine

URL: /en/documentation/boletos/instrucoes/multa

The fine instruction is used to configure the fine that will be applied if the bank slip is paid after the due date. If a fine configuration already exists for the bank slip in question, and a fine instruction is accepted, the previously existing configuration will be overwritten.

:::caution Attention!
If there is any fine instruction pending confirmation, sending a new instruction is not allowed.
:::

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /fine
MÉTODO POST

### 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         |
| `bank_slip_key`         | uuidv4 | Unique bank slip identification key, in uuid v4 format      | 36         |

Request Body

```json
{
  "request_control_key": "c4dd443a-6e2f-4261-8f28-adfa4c0d4c5b",
  "fine_data": {
    "fine_type": "absolute",
    "fine_amount": 50.00,
    "days_to_fine": 5
  }
}
```

### Request Body Params

| Field                      | Type    | Description                                                                        | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|------------|
| `request_control_key` *    | uuidv4  | Unique request identification key used by the client in uuid v4 format            | 36         |
| `interest_data`            | object  | Fine configurations                                                                | **[fine_data Object](#fine_data-object)** |

### fine_data Object

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

| Field                     | Type    | Description                                               | Characters                |
|---------------------------|---------|---------------------------------------------------------|-------------------------------------------------------------------------|
| `fine_type` *             | string  | Fine type                                                       | **[fine_type Enumerators](#fine_type-enumerators)**                                              |
| `fine_amount` *           | float   | Absolute fine amount                                             | -                                                                        |
| `days_to_fine` *          | integer | Days after due date for the fine to be charged              | -                                                                        |

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

| Field                     | Type    | Description                                                 | Characters                             |
|---------------------------|---------|-----------------------------------------------------------|---------------------------------------|
| `fine_type` *             | string  | Fine type                                             | **[fine_type Enumerators](#fine_type-enumerators)** |
| `fine_percentage` *       | integer | Percentage fine amount, from 1 to 100                     | -                                      |
| `days_to_fine` *          | integer | Days after due date for the fine to be charged    | -                                      |

### fine_type Enumerators

| Enumerator         | Description           |
|--------------------|-----------------------|
| absolute           | absolute value        |
| percentage         | percentage value      |

## Response

STATUS 202

Response Body

```json
{
  "occurrence_key": "aaf64135-6bd8-4d49-be6f-e8f884b20ee7",
  "bank_slip_key": "470cfcae-159b-4de4-ad22-2d3b2dd717f7"
}
```

### Response Body Params

| Field              | Type   | Description                                                                       | Characters |
|--------------------|--------|-----------------------------------------------------------------------------------|------------|
| `occurrence_key` * | uuidv4 | Unique occurrence (instruction) identification key in uuid v4 format             | 36         |
| `bank_slip_key` *  | uuidv4 | Unique bank slip identification key in uuid v4 format                            | 36         |

### 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<br/>`status` | QI Code<br/>`code` | Title<br/>`title`                                 | Description (eng)<br/>`description`                                                                                       | Description (pt-br)<br/>`translation`                                                                                     |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 400                      | QIT000001            | Bad Request                                        | Schema Error                                                                                                            | Schema Inválido                                                                                                         |
| 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.                                                                 |
| 404                      | BKS000013            | Not Found | Requester profile not found         |               Carteira não encontrada                                                                 |
| 409                      | BKS000014            | Conflict | Request control key already sent or duplicated sent: `<request_control_key>` | Chave de controle da requisição já utilizada ou enviada duplicada: `<request_control_key>` |
| 400                      | BKS000018            | Bad Request                                        | The discount dates must be less than the expiration date and increasing.                                                              | A data dos descontos devem ser menores que a de expiração e crescentes.                         |
| 400                      | BKS000022            | Bad Request                                        | Requester profile is not opened.                                                              | Carteira não está aberta.                          |
| 404                      | BKS000029            | Not Found                                        | Bank slip not found for the given key (`{bank_slip_key}`).                                                              | Boleto não encontrado para a chave fornecida (`{bank_slip_key}`).                          |
| 400                      | BKS000032            | Bad Request                                        | Bank slip must be in 'registered' status.                                                              | O boleto deve possuir o status 'registered'.                          |
| 409                      | BKS000050            | Conflict                                        | There is already a pending fine occurrence for this bank slip. Please, wait for the confirmation of this occurrence before sending another one.                                                              | Já existe uma ocorrência de multa pendente para este boleto. Por favor, aguarde a confirmação dessa ocorrência antes de enviar outra.                          |

---

# Partial Payment

URL: /en/documentation/boletos/instrucoes/pagamento_parcial

The partial payment instruction allows editing partial payment configurations for a bank slip, as long as the bank slip has already been registered with partial payment active. If there is already a partial payment configuration for the bank slip in question, and a new instruction is accepted, the previously existing configuration will be overwritten.

:::caution Attention!
If there is any partial payment instruction pending confirmation, it is not allowed to send a new instruction.
:::

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /partial_payment
METHOD POST

### 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         |
| `bank_slip_key`         | uuidv4 | Unique bank slip identification key, in uuid v4 format   | 36         |

Request Body

```json
{
    "request_control_key": "01234567-89ab-cdef-0123-456789abcdef",
    "partial_payment_data": {
        "partial_payment_minimum_type": "absolute",
        "partial_payment_minimum_amount": 50.00,
        "partial_payment_maximum_type": "absolute",
        "partial_payment_maximum_amount": 1000.00,
        "partial_payment_quantity": 3
    }
}
```

### Request Body Params

| Field                      | Type    | Description                                                                          | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|------------|
| `request_control_key` *    | uuidv4  | Unique request identification key used by the client in uuid v4 format  | 36         |
| `partial_payment_data` *    | object  | Partial payment configurations                      | **[partial_payment_data Object](#partial_payment_data-object)** |

### partial_payment_data Object

| Field                             | Type    | Description                                                                 | Characters |
|-----------------------------------|---------|---------------------------------------------------------------------------|------------|
| `partial_payment_minimum_type` *  | string  | Minimum value type for partial payment                               | **[partial_payment_type Enumerators](#partial_payment_type-enumerators)** |
| `partial_payment_minimum_percentage` | float | Minimum percentage allowed for partial payment                      | -          |
| `partial_payment_minimum_amount`  | float  | Minimum amount allowed for partial payment                           | -          |
| `partial_payment_maximum_type`    | string  | Maximum value type for partial payment                               | **[partial_payment_type Enumerators](#partial_payment_type-enumerators)** |
| `partial_payment_maximum_percentage` | float | Maximum percentage allowed for partial payment                      | -          |
| `partial_payment_maximum_amount`  | float  | Maximum amount allowed for partial payment                           | -          |
| `partial_payment_quantity` *      | integer | Number of partial payments allowed                              | -          |

:::caution Attention!
According to the value sent in the `partial_payment_minimum_type` and `partial_payment_maximum_type` fields, it is necessary to send the corresponding `partial_payment_minimum_amount` or `partial_payment_minimum_percentage`, and the `partial_payment_maximum_amount` or `partial_payment_maximum_percentage`.
:::

### partial_payment_type Enumerators

| Enumerator  | Description                        |
|-------------|----------------------------------|
| absolute    | Absolute value                   |
| percentage  | Percentage                       |

## Response

STATUS 202

Response Body

```json
{
  "occurrence_key": "5a745b65-9a2c-44eb-b43e-c80ef5429d94",
  "bank_slip_key": "fdafdffa-cbd4-4f3c-8e3d-990428305161"
}
```

### Response Body Params

| Field              | Type   | Description                                                                         | Characters |
|--------------------|--------|-----------------------------------------------------------------------------------|------------|
| `occurrence_key` * | uuidv4 | Unique occurrence (instruction) identification key in uuid v4 format         | 36         |
| `bank_slip_key` *  | uuidv4 | Unique bank slip identification key in uuid v4 format                         | 36         |

### 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<br/>`status` | QI Code<br/>`code` | Title<br/>`title`                                 | Description (eng)<br/>`description`                                                                                       | Description (pt-br)<br/>`translation`                                                                                     |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 400                      | QIT000001            | Bad Request                                        | Schema Error                                                                                                            | Schema Inválido                                                                                                         |
| 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.                                                                 |
| 404                      | BKS000013            | Not Found | Requester profile not found         |               Carteira não encontrada                                                                 |
| 409                      | BKS000014            | Conflict | Request control key already sent or duplicated sent: `<request_control_key>` | Chave de controle da requisição já utilizada ou enviada duplicada: `<request_control_key>` |
| 400                      | BKS000022            | Bad Request                                        | Requester profile is not opened.                                                              | Carteira não está aberta.                          |
| 404                      | BKS000029            | Not Found                                        | Bank slip not found for the given key (`{bank_slip_key}`).                                                              | Boleto não encontrado para a chave fornecida (`{bank_slip_key}`).                          |
| 400                      | BKS000032            | Bad Request                                        | Bank slip must be in 'registered' status.                                                              | O boleto deve possuir o status 'registered'.                          |
| 409                      | BKS000126            | Conflict                                        | There is already a pending partial payment occurrence for this bank slip. Please, wait for the confirmation of this occurrence before sending another one.                                                              | Já existe uma ocorrência de pagamento parcial pendente para este boleto. Por favor, aguarde a confirmação dessa ocorrência antes de enviar outra.                          |
| 400                      | BKS000127            | Bad Request                                        | Partial payment data is not set for this bank slip.                                                              | Os dados de pagamento parcial não estão configurados para este boleto.                          |

---

# Protest instrument query

URL: /en/documentation/boletos/instrucoes/protesto/consulta_instrumento_de_protesto

The protest instrument is an official document issued by the protest registry office, which proves the execution of the collection process. It is issued after the protest is registered, if the debtor has not paid the debt after being notified.

:::caution Attention!
It is only possible to query the protest instrument of the title after it has been effectively protested (`protest_status` has the value `protested`).
:::

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /protest_instrument
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         |
| `bank_slip_key`         | uuidv4 | Unique bank slip identification key, in uuid v4 format      | 36         |

## Response

STATUS 200

Response Body

```json
{
  "bank_slip_key": "bc34e9b1-42e4-4f17-bfc0-c88f29d5230e",
  "file_url": "https://storage.googleapis.com/live-bank-slip-api/protest_instrument/bc34e9b1-42e4-4f17-bfc0-c88f29d5230e.pdf"
}
```

### Response Body Params

| Field                      | Type    | Description                                                                        | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `bank_slip_key` *          | uuidv4  | Unique bank slip identification key in uuid v4 format                             | 36                                                |
| `file_url` *               | string  | File URL, in PDF format, containing the protest instrument document               | -                                                 |

## 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<br/>`status` | QI Code<br/>`code` | Title<br/>`title`                                 | Description (eng)<br/>`description`                                                                                       | Description (ptbr)<br/>`translation`                                                                                     |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 400                      | QIT000001            | Bad Request                                        | Schema Error                                                                                                            | Schema Inválido                                                                                                         |
| 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.                                                                 |
| 404                      | BKS000013            | Not Found | Requester profile not found         |               Carteira não encontrada                                                                 |
| 404                      | BKS000029            | Not Found                                        | Bank slip not found for the given key (`{bank_slip_key}`).                                                              | Boleto não encontrado para a chave fornecida (`{bank_slip_key}`).                          |
| 400                      | BKS000081            | Bad Request | The protest instrument will be available only after bank slip's protest confirmation. | O instrumento de protesto só estará disponível após a confirmação do protesto do título. |
| 500                      | BKS000105            | Internal Server Error | Could not fetch protest instrument for the given 'bank_slip_key' at this moment. Please, try again later. | Não foi possível recuperar o instrumento de protesto para a chave ('bank_slip_key') fornecida. Por favor, tente novamente mais tarde. |
| 404                      | BKS000106            | Not Found | No protest found for the given bank slip. | Nenhum protesto foi encontrado para o boleto fornecido. |

---

# Query protest by key

URL: /en/documentation/boletos/instrucoes/protesto/consulta_por_chave

Querying a protest using its key returns detailed information about it.

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /protest/ BANK_SLIP_KEY
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         |
| `bank_slip_key`         | uuidv4 | Unique bank slip identification key in uuid v4 format   | 36         |

## Response

STATUS 200

Response Body

```json
{
  "protest_key": "bc34e9b1-42e4-4f17-bfc0-c88f29d5230e",
  "request_control_key": "59515878-50e9-466b-b40d-1aac3939c3fd",
  "protest_status": "protested",
  "bank_slip_key": "7d3d262b-9b55-44cd-8355-2f00d5b1d142",
  "requester_profile_code": "329-09-0001-1467576",
  "protest_type": "protest",
  "protocol_number": "0000672016",
  "protocol_date": "2012-12-16",
  "notary_office": {
    "city": "VITORIA",
    "uf": "ES"
  }
}
```

### Response Body Params

| Field                      | Type    | Description                                                                          | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `protest_key      ` *      | uuidv4  | Unique protest identification key in uuid v4 format                        | 36                                                |
| `request_control_key` *    | uuidv4  | Unique identification key of the request used by the client in uuid v4 format  | 36                                                |
| `protest_status` *         | string  | Protest status                                                                 | **[protest_status Enumerators](#protest_status-enumerators)**   |
| `bank_slip_key` *          | uuidv4  | Unique bank slip identification key in uuid v4 format                          | 36                                                |
| `requester_profile_code` * | string  | Unique wallet identification code                                          | 10                                                |
| `protest_type` *           | string  | Protest type                                                                   | **[protest_type Enumerators](#protest_type-enumerators)**       |
| `protocol_number`          | string  | Protocol number                                                                | 10                                                |
| `protocol_date`            | string  | Protocol date (format "YYYY-MM-DD")                                           | 10                                                |
| `notary_office`            | object  | Protest notary office data                                                      | **[notary_office Object](#notary_office-object)**                         |

### protest_status Enumerators

| Enumerator                   | Description                                                                      |
|------------------------------|--------------------------------------------------------------------------------|
| accepted                     | Accepted but not yet sent to the protest notary offices         |
| submitted                    | Sent to the notary office                                                        |
| cancellation_requested       | Protest suspension requested                                                |
| cancelled                    | Submission cancelled or protest suspended                                           |
| rejected                     | Protest request rejected                                                   |
| at_notary_office             | At the protest notary office, in the three-day period                                  |
| paid_at_notary_office        | Title paid at the notary office                                                        |
| protested                    | Title protested and settled                                                    |
| removal_requested            | Title already protested, with cancellation requested                              |
| removed                      | Protest cancelled                                                             |

### protest_type Enumerators

| Enumerator                   | Description                                                                      |
|------------------------------|--------------------------------------------------------------------------------|
| protest                      | Common protest                                                                 |
| bankruptcy_protest           | Bankruptcy protest                                                            |

### notary_office Object

| Field                      | Type    | Description                                                                          | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `city` *                   | string  | Protest notary office city                                                     |  -                                                 |
| `uf` *                     | string  | Protest notary office state (UF)                                                | 2                                                 |

## 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<br/>`status` | QI Code<br/>`code` | Title<br/>`title`                                 | Description (eng)<br/>`description`                                                                                       | Description (ptbr)<br/>`translation`                                                                                     |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 400                      | QIT000001            | Bad Request                                        | Schema Error                                                                                                            | Schema Inválido                                                                                                         |
| 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.                                                                 |
| 404                      | BKS000013            | Not Found | Requester profile not found         |               Carteira não encontrada                                                                 |
| 404                      | BKS000029            | Not Found                                        | Bank slip not found for the given key (`{bank_slip_key}`).                                                              | Boleto não encontrado para a chave fornecida (`{bank_slip_key}`).                          |
| 404                      | BKS000106            | Not Found | No protest found for the given bank slip. | Nenhum protesto foi encontrado para o boleto fornecido. |

---

# Protest withdrawal (protest stoppage)

URL: /en/documentation/boletos/instrucoes/protesto/desistencia_de_protesto

It is possible to withdraw a protest request by sending a `protest_cancel_request` instruction.

:::caution Attention!
The `protest_cancel_request` occurrence, by itself, does not cancel the bank slip. If the exit from the notary office is caused by a `protest_cancel_request` occurrence, another `notary_office_exit` occurrence is created, which is sent to CIP/Nuclea to unblock the bank slip for payment. Once it is confirmed, the bank slip can be paid again via the typeable line. If it is desired that the bank slip be canceled after the protest withdrawal, the ideal is to send a [**protest withdrawal and bank slip cancellation**](/documentation/boletos/instrucoes/protesto/desistencia_de_protesto_e_baixa_do_boleto) instruction.
:::

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /protest_cancel_request
METHOD POST

### 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         |
| `bank_slip_key`         | uuidv4 | Unique bank slip identification key, in uuid v4 format      | 36         |

Request Body

```json
{
  "request_control_key": "614a451d-3b82-460e-bcc0-2caf3dde711f"
}
```

### Request Body Params

| Field                      | Type    | Description                                                                        | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|------------|
| `request_control_key` *    | uuidv4  | Unique request identification key used by the client in uuid v4 format            | 36         |

## Response

STATUS 202

Response Body

```json
{
  "occurrence_key": "2552bd64-950b-437e-a53a-a133ffea03d7",
  "bank_slip_key": "960f78d4-4426-4762-98da-3ce3713ae0a5"
}
```

### Response Body Params

| Field              | Type   | Description                                                                       | Characters |
|--------------------|--------|-----------------------------------------------------------------------------------|------------|
| `occurrence_key` * | uuidv4 | Unique occurrence (instruction) identification key in uuid v4 format             | 36         |
| `bank_slip_key` *  | uuidv4 | Unique bank slip identification key in uuid v4 format                            | 36         |

### 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<br/>`status` | QI Code<br/>`code` | Title<br/>`title`                                 | Description (eng)<br/>`description`                                                                                       | Description (pt-br)<br/>`translation`                                                                                     |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 400                      | QIT000001            | Bad Request                                        | Schema Error                                                                                                            | Schema Inválido                                                                                                         |
| 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.                                                                 |
| 404                      | BKS000013            | Not Found | Requester profile not found         |               Carteira não encontrada                                                                 |
| 409                      | BKS000014            | Conflict | Request control key already sent or duplicated sent: `<request_control_key>` | Chave de controle da requisição já utilizada ou enviada duplicada: `<request_control_key>` |
| 400                      | BKS000019            | Bad Request | Payer address is required for protest. | Endereço do pagador é obrigatório para protesto. |
| 400                      | BKS000022            | Bad Request                                        | Requester profile is not opened.                                                              | Carteira não está aberta.                          |
| 404                      | BKS000029            | Not Found                                        | Bank slip not found for the given key (`{bank_slip_key}`).                                                              | Boleto não encontrado para a chave fornecida (`{bank_slip_key}`).                          |
| 400                      | BKS000032            | Bad Request                                        | Bank slip must be in 'registered' status.                                                              | O boleto deve possuir o status 'registered'.                          |
| 400                      | BKS000076            | Bad Request | Bank slip must have an ongoing protest request. | O boleto deve ter um pedido de protesto em vigência. |
| 400                      | BKS000077            | Bad Request | Invalid bank slip protest status to cancel protest request. | Status de protesto do boleto inválido para desistir do pedido de protesto. |

---

# Protest withdrawal (stay) and bank slip write-off

URL: /en/documentation/boletos/instrucoes/protesto/desistencia_de_protesto_e_baixa_do_boleto

Another way to withdraw a protest request is by sending a `protest_cancel_and_write_off_request` instruction.

:::caution Warning!
The `protest_cancel_and_write_off_request` instruction also writes off the bank slip in CIP/Nuclea. As soon as it is confirmed, a `write_off` occurrence is automatically created and sent to Nuclea.
:::

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /protest_cancel_and_write_off_request
METHOD POST

### 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         |
| `bank_slip_key`         | uuidv4 | Unique bank slip identification key, in uuid v4 format        | 36         |

Request Body

```json
{
  "request_control_key": "614a451d-3b82-460e-bcc0-2caf3dde711f"
}
```

### Request Body Params

| Field                      | Type    | Description                                                                        | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|------------|
| `request_control_key` *    | uuidv4  | Unique request identification key used by the client in uuid v4 format            | 36         |

## Response

STATUS 202

Response Body

```json
{
  "occurrence_key": "2552bd64-950b-437e-a53a-a133ffea03d7",
  "bank_slip_key": "960f78d4-4426-4762-98da-3ce3713ae0a5"
}
```

### Response Body Params

| Field              | Type   | Description                                                                       | Characters |
|--------------------|--------|-----------------------------------------------------------------------------------|------------|
| `occurrence_key` * | uuidv4 | Unique occurrence (instruction) identification key in uuid v4 format             | 36         |
| `bank_slip_key` *  | uuidv4 | Unique bank slip identification key in uuid v4 format                            | 36         |

### 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<br/>`status` | QI Code<br/>`code` | Title<br/>`title`                                 | Description (eng)<br/>`description`                                                                                       | Description (pt-br)<br/>`translation`                                                                                     |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 400                      | QIT000001            | Bad Request                                        | Schema Error                                                                                                            | Schema Inválido                                                                                                         |
| 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.                                                                 |
| 404                      | BKS000013            | Not Found | Requester profile not found         |               Carteira não encontrada                                                                 |
| 409                      | BKS000014            | Conflict | Request control key already sent or duplicated sent: `<request_control_key>` | Chave de controle da requisição já utilizada ou enviada duplicada: `<request_control_key>` |
| 400                      | BKS000019            | Bad Request | Payer address is required for protest. | Endereço do pagador é obrigatório para protesto. |
| 400                      | BKS000022            | Bad Request                                        | Requester profile is not opened.                                                              | Carteira não está aberta.                          |
| 404                      | BKS000029            | Not Found                                        | Bank slip not found for the given key (`{bank_slip_key}`).                                                              | Boleto não encontrado para a chave fornecida (`{bank_slip_key}`).                          |
| 400                      | BKS000032            | Bad Request                                        | Bank slip must be in 'registered' status.                                                              | O boleto deve possuir o status 'registered'.                          |
| 400                      | BKS000076            | Bad Request | Bank slip must have an ongoing protest request. | O boleto deve ter um pedido de protesto em vigência. |
| 400                      | BKS000077            | Bad Request | Invalid bank slip protest status to cancel protest request. | Status de protesto do boleto inválido para desistir do pedido de protesto. |

---

# Introduction

URL: /en/documentation/boletos/instrucoes/protesto/introducao

## Notary office protest

A notary office protest request can be made after the boleto's due date, and serves to have the payer notified to pay the bill at the notary office. If they fail to do so, a public record of default is made in their name, in addition to having their name included in credit protection agencies, such as Serasa.

## Protest flow

### Protest request

The protest flow for a boleto is initiated with a protest request : an instruction of type `protest_request`. From the moment the protest request is accepted by CIP/Nuclea (the `protest_request` instruction is confirmed), the boleto becomes blocked for payment, which means the payer can only pay it at the notary office. Additionally, a `notary_office_entry` occurrence is also created, which refers to sending the protest request to the notary office. Protest request remittances are sent daily to notary offices at 9 AM, therefore, if protest request instructions are received after this time, they are only sent to notary offices the following day.

On subsequent days, the notary office must confirm the entry of the bill into the notary office (the `notary_office_entry` occurrence is confirmed) and, with this, the triduum period begins. The triduum is the 3 business day period for the payer to pay the boleto at the notary office, and if they fail to do so, the bill will be protested. If the bill is paid at the notary office, a `notary_office_payment_notice` type occurrence is created for the boleto in question and it is settled the following day. In this latter case, a `payment_write_off` instruction is also automatically generated, so that the boleto is written off with CIP/Nuclea.

If the triduum period ends and the boleto is not paid and there is no withdrawal from the protest, the boleto is protested. At this moment, a `protest_write_off` instruction is generated to write off the boleto at CIP/Nuclea, and the bill's life cycle ends.

### Withdrawal (suspension) of protest request

If issues regarding the bill are resolved directly between the payer and the drawer guarantor, until the boleto is actually protested (that is, until the last day of the triduum), it is possible to send a `protest_cancel_request` instruction, which withdraws the protest request; or a `protest_cancel_and_write_off_request` instruction, which withdraws the protest request and also writes off the boleto at CIP/Nuclea. It's worth noting that the `protest_cancel_request` occurrence, by itself, does not write off the boleto. If the exit from the notary office is caused by a `protest_cancel_request` type occurrence, another `notary_office_exit` occurrence is created, which is sent to CIP/Nuclea to unblock the boleto for payment. As soon as it is confirmed, the boleto can again be paid via the typed line. On the other hand, if the exit from the notary office is caused by a `protest_cancel_and_write_off_request` type occurrence, a `write_off` occurrence is automatically created, which writes off the boleto at CIP/Nuclea.

### Removal (cancellation) of protest request

If the pending issue between the payer and drawer guarantor is resolved after the boleto has already been protested, it is possible to send a `protest_remove_request` type instruction, which removes the public default record and any record, linked to this boleto, that has tarnished the payer's name. If the occurrence is confirmed (accepted by the notary office), the protest is removed and no more instructions are created for this boleto, since it is already written off at CIP/Nuclea.

---

# List protests

URL: /en/documentation/boletos/instrucoes/protesto/listar_protestos

The protest listing will return all protests in notary offices for bank slips from the wallet that match the query parameters sent in the request.

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /protests
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              |
|-------------------------|--------|--------------------------------------------------------------|-------------------------|
| `protest_key`           | uuidv4 | Unique protest identification key, in uuid v4 format | 36                      |
| `request_control_key`   | uuidv4 | Unique request identification key, in uuid v4 format  | 36                      |
| `protest_status`        | string | Protest status | **[protest_status enumerators](#enumeradores-protest_status)**   |
| `bank_slip_key`         | uuidv4 | Unique bank slip identification key, in uuid v4 format   | 36                      |
| `protocol_number`       | string | Protocol number                                          | 36                      |
| `protocol_date`         | string | Protocol date (format "YYYY-MM-DD")                     | 10                      |
| `page_size`             | integer| Page size                                            | -                       |
| `from_date`             | string | Start date (format "YYYY-MM-DD")                          | 10                      |
| `to_date`               | string | End date (format "YYYY-MM-DD")                            | 10                      |

### protest_status enumerators

| Enumerator                   | Description                                                                      |
|------------------------------|--------------------------------------------------------------------------------|
| accepted                     | Accepted, but not yet sent to the protest notary offices         |
| submitted                    | Sent to notary office                                                        |
| cancellation_requested       | Protest suspension requested                                                |
| cancelled                    | Sending cancelled, or protest suspended                                           |
| rejected                     | Protest request rejected                                                   |
| at_notary_office             | At protest notary office, in triduum period                                  |
| paid_at_notary_office        | Title paid at notary office                                                        |
| protested                    | Title protested and settled                                                    |
| removal_requested            | Title already protested, with cancellation requested                              |
| removed                      | Protest cancelled                                                             |

## Response

STATUS 200

Response Body

```json
{
    "data": [
        {
            "protest_key": "ad44278d-7cf1-4ac7-9545-410649a47dde",
            "request_control_key": "7e40ebab-f00c-4dbf-88be-ff34434ab358",
            "protest_status": "protested",
            "bank_slip_key": "7bf086ac-f520-4498-abd4-5a7d2173fd1c",
            "requester_profile_code": "329-09-0001-1467576",
            "protest_type": "protest",
            "protocol_number": "0000000004",
            "protocol_date": "2024-11-27",
            "notary_office": {
                "city": "SAO PAULO",
                "uf": "SP"
            }
        },
        {
            "protest_key": "0087f425-5e54-4b4c-ab17-a57bc80f223a",
            "request_control_key": "c413cedc-78ac-4deb-ace8-d94d4e98197c",
            "protest_status": "at_notary_office",
            "bank_slip_key": "e345c0b3-012b-4a4b-9d6b-6981f40b1a7c",
            "requester_profile_code": "329-09-0001-1467576",
            "protest_type": "protest",
            "protocol_number": "0000000016",
            "protocol_date": "2024-12-10",
            "notary_office": {
                "city": "RIO DE JANEIRO",
                "uf": "RJ"
            }
        },
        {
            "protest_key": "bc34e9b1-42e4-4f17-bfc0-c88f29d5230e",
            "request_control_key": "59515878-50e9-466b-b40d-1aac3939c3fd",
            "protest_status": "accepted",
            "bank_slip_key": "7d3d262b-9b55-44cd-8355-2f00d5b1d142",
            "requester_profile_code": "329-09-0001-1467576",
            "protest_type": "protest"
        }
    ],
    "pagination": {
        "current_page": 1,
        "rows_per_page": 100
    }
}
```

### Response Body Params

| Field            | Type         | Description                             | Characters                                  |
|------------------|--------------|---------------------------------------|---------------------------------------------|
| `data` *         | object array | Protests                             | **[protest object](#objeto-protest)**       |
| `pagination` *   | object       | Pagination information              | **[pagination object](#objeto-pagination)** |

### protest object

| Field                      | Type    | Description                                                                          | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `protest_key      ` *      | uuidv4  | Unique protest identification key in uuid v4 format                        | 36                                                |
| `request_control_key` *    | uuidv4  | Unique request identification key used by the client in uuid v4 format  | 36                                                |
| `protest_status` *         | string  | Protest status                                                                 | **[protest_status enumerators](#enumeradores-protest_status)**   |
| `bank_slip_key` *          | uuidv4  | Unique bank slip identification key in uuid v4 format                          | 36                                                |
| `requester_profile_code` * | string  | Unique wallet identification code                                          | 10                                                |
| `protest_type` *           | string  | Protest type                                                                   | **[protest_type enumerators](#enumeradores-protest_type)**       |
| `protocol_number`          | string  | Protocol number                                                                | 10                                                |
| `protocol_date`            | string  | Protocol date (format "YYYY-MM-DD")                                           | 10                                                |
| `notary_office`            | object  | Protest notary office data                                                      | **[notary_office object](#objeto-notary_office)**                         |

### pagination object

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

### protest_type enumerators

| Enumerator                   | Description                                                                      |
|------------------------------|--------------------------------------------------------------------------------|
| protest                      | Common protest                                                                 |
| bankruptcy_protest           | Bankruptcy protest                                                            |

### protest_status enumerators

| Enumerator                   | Description                                                                      |
|------------------------------|--------------------------------------------------------------------------------|
| accepted                     | Accepted, but not yet sent to the protest notary offices         |
| submitted                    | Sent to notary office                                                        |
| cancellation_requested       | Protest suspension requested                                                |
| cancelled                    | Sending cancelled, or protest suspended                                           |
| rejected                     | Protest request rejected                                                   |
| at_notary_office             | At protest notary office, in triduum period                                  |
| paid_at_notary_office        | Title paid at notary office                                                        |
| protested                    | Title protested and settled                                                    |
| removal_requested            | Title already protested, with cancellation requested                              |
| removed                      | Protest cancelled                                                             |

### notary_office object

| Field                      | Type    | Description                                                                          | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `city` *                   | string  | Protest notary office city                                                     |  -                                                 |
| `uf` *                     | string  | Protest notary office state (UF)                                                | 2                                                 |

## 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<br/>`status` | QI Code<br/>`code` | Title<br/>`title`                                 | Description (eng)<br/>`description`                                                                                       | Description (pt-br)<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                                                                 |

---

# Protest request

URL: /en/documentation/boletos/instrucoes/protesto/pedido_de_protesto

A protest request at a notary office can be made after the due date of the bank slip, and serves to have the payer notified to pay the instrument at the notary office. If they do not do so, a public record is made in their name of the default, in addition to having their name included in credit protection agencies, such as Serasa.

:::caution Attention!
To send a protest request, it is mandatory that the payer's address is present on the bank slip. If it is not, it is possible to send an instruction to edit the bank slip. Furthermore, if a bank slip is in the protest flow, sending a new request is not permitted.
:::

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /protest_request
METHOD POST

### 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         |
| `bank_slip_key`         | uuidv4 | Unique bank slip identification key, in uuid v4 format      | 36         |

Request Body

```json
{
  "request_control_key": "614a451d-3b82-460e-bcc0-2caf3dde711f",
  "protest_type": "protest"
}
```

### Request Body Params

| Field                      | Type    | Description                                                                        | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|------------|
| `request_control_key` *    | uuidv4  | Unique request identification key used by the client in uuid v4 format            | 36         |
| `protest_type` *           | string  | Type of protest (common or bankruptcy)                                             | **[Enumerators protest_type](#enumerators-protest_type)** |

### Enumerators protest_type

| Enumerator                                  | Description                                                              |
|---------------------------------------------|--------------------------------------------------------------------------|
| protest                                     | Common protest                                                           |
| bankruptcy_protest                          | Bankruptcy protest                                                       |

## Response

STATUS 202

Response Body

```json
{
  "occurrence_key": "2552bd64-950b-437e-a53a-a133ffea03d7",
  "bank_slip_key": "960f78d4-4426-4762-98da-3ce3713ae0a5"
}
```

### Response Body Params

| Field              | Type   | Description                                                                       | Characters |
|--------------------|--------|-----------------------------------------------------------------------------------|------------|
| `occurrence_key` * | uuidv4 | Unique occurrence (instruction) identification key in uuid v4 format             | 36         |
| `bank_slip_key` *  | uuidv4 | Unique bank slip identification key in uuid v4 format                            | 36         |

### 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<br/>`status` | QI Code<br/>`code` | Title<br/>`title`                                 | Description (eng)<br/>`description`                                                                                       | Description (pt-br)<br/>`translation`                                                                                     |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 400                      | QIT000001            | Bad Request                                        | Schema Error                                                                                                            | Schema Inválido                                                                                                         |
| 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.                                                                 |
| 404                      | BKS000013            | Not Found | Requester profile not found         |               Carteira não encontrada                                                                 |
| 409                      | BKS000014            | Conflict | Request control key already sent or duplicated sent: `<request_control_key>` | Chave de controle da requisição já utilizada ou enviada duplicada: `<request_control_key>` |
| 400                      | BKS000019            | Bad Request | Payer address is required for protest. | Endereço do pagador é obrigatório para protesto. |
| 400                      | BKS000022            | Bad Request                                        | Requester profile is not opened.                                                              | Carteira não está aberta.                          |
| 404                      | BKS000028            | Not Found | Notary office attended region not found for postal code: `<postal_code>` | Região de cartório não encontrada para o CEP: `<postal_code>` |
| 404                      | BKS000029            | Not Found                                        | Bank slip not found for the given key (`{bank_slip_key}`).                                                              | Boleto não encontrado para a chave fornecida (`{bank_slip_key}`).                          |
| 400                      | BKS000032            | Bad Request                                        | Bank slip must be in 'registered' status.                                                              | O boleto deve possuir o status 'registered'.                          |
| 409                      | BKS000075            | Conflict                                        | An open protest request already exists for the given 'bank_slip_key'.                                                              | Já existe um pedido de protesto em aberto para a 'bank_slip_key' fornecida.                          |
| 400                      | BKS000080            | Bad Request                                        | A protest request can only be sent after bank slip's business expiration date.                                                              | Um pedido de protesto só pode ser enviado após o dia útil de expiração do boleto.                          |

---

# Protest Removal

URL: /en/documentation/boletos/instrucoes/protesto/sustacao_de_protesto

If the dispute between the payer and drawer guarantor is resolved after the bank slip has already been protested, it is possible to send an instruction of type `protest_remove_request`, which removes the public record of default and any record, linked to this bank slip, that has tainted the payer's name.

:::caution Attention!
If the occurrence is confirmed (accepted by the notary office), the protest is removed and no further instructions are created for this bank slip, since it is already settled in CIP/Nuclea.
:::

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /protest_remove_request
METHOD POST

### 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         |
| `bank_slip_key`         | uuidv4 | Unique bank slip identification key, in uuid v4 format   | 36         |

Request Body

```json
{
  "request_control_key": "614a451d-3b82-460e-bcc0-2caf3dde711f"
}
```

### Request Body Params

| Field                      | Type    | Description                                                                          | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|------------|
| `request_control_key` *    | uuidv4  | Unique request identification key used by the client in uuid v4 format  | 36         |

## Response

STATUS 202

Response Body

```json
{
  "occurrence_key": "2552bd64-950b-437e-a53a-a133ffea03d7",
  "bank_slip_key": "960f78d4-4426-4762-98da-3ce3713ae0a5"
}
```

### Response Body Params

| Field              | Type   | Description                                                                         | Characters |
|--------------------|--------|-----------------------------------------------------------------------------------|------------|
| `occurrence_key` * | uuidv4 | Unique occurrence (instruction) identification key in uuid v4 format         | 36         |
| `bank_slip_key` *  | uuidv4 | Unique bank slip identification key in uuid v4 format                         | 36         |

### 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<br/>`status` | QI Code<br/>`code` | Title<br/>`title`                                 | Description (eng)<br/>`description`                                                                                       | Description (pt-br)<br/>`translation`                                                                                     |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 400                      | QIT000001            | Bad Request                                        | Schema Error                                                                                                            | Schema Inválido                                                                                                         |
| 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.                                                                 |
| 404                      | BKS000013            | Not Found | Requester profile not found         |               Carteira não encontrada                                                                 |
| 409                      | BKS000014            | Conflict | Request control key already sent or duplicated sent: `<request_control_key>` | Chave de controle da requisição já utilizada ou enviada duplicada: `<request_control_key>` |
| 400                      | BKS000019            | Bad Request | Payer address is required for protest. | Endereço do pagador é obrigatório para protesto. |
| 400                      | BKS000022            | Bad Request                                        | Requester profile is not opened.                                                              | Carteira não está aberta.                          |
| 404                      | BKS000029            | Not Found                                        | Bank slip not found for the given key (`{bank_slip_key}`).                                                              | Boleto não encontrado para a chave fornecida (`{bank_slip_key}`).                          |
| 400                      | BKS000032            | Bad Request                                        | Bank slip must be in 'registered' status.                                                              | O boleto deve possuir o status 'registered'.                          |
| 400                      | BKS000076            | Bad Request | Bank slip must have an ongoing protest request. | O boleto deve ter um pedido de protesto em vigência. |
| 400                      | BKS000078            | Bad Request | Bank slip's protest_status must be 'protested' to send a protest remove request. | Status de protesto (protest_status) do boleto deve ser 'protested' para enviar um pedido de remoção de protesto. |

---

# Credit Split Update

URL: /en/documentation/boletos/instrucoes/rateio_de_credito

This endpoint allows updating the **credit split** (split payment) of a previously issued bank slip. The new rules fully replace the existing ones and apply to the next settlement of the bank slip.

:::caution Attention!
- The bank slip must be in `registered` status and not yet paid.
- The sum of `beneficiary_settlement_percentage` and the percentages in each item of `split_payment_rules` must be exactly **100**.
- The payload **replaces** all existing split rules (it is not incremental).
- The split applies to all settlement flows of the bank slip (SILOC, STR, notary office and Pix QR Code), including bank slips with QR Code already issued — in this case, the rules are also automatically updated on the QR Code.
- The accounts in the split rules must be open and registered with QI Tech (QI Tech will look them up by the `document_number`, `account_number` and `account_digit` provided).
:::

## Request

ENDPOINT /v2/bank_slip/account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /split_payment
METHOD PUT

### Path parameters

| Field                   | Type   | Description                                                            | Characters |
|-------------------------|--------|------------------------------------------------------------------------|------------|
| `account_key`           | uuidv4 | Unique identification key of the account in which the bank slip was issued | 36         |
| `requester_profile_key` | uuidv4 | Unique identification key of the wallet                                | 36         |
| `bank_slip_key`         | uuidv4 | Unique identification key of the bank slip                             | 36         |

Request Body

```json
{
  "beneficiary_settlement_percentage": 70,
  "split_payment_rules": [
    {
      "percentage": 20,
      "document_number": "12345678901",
      "account_owner_name": "John Smith",
      "account_number": "1234567",
      "account_digit": "8"
    },
    {
      "percentage": 10,
      "document_number": "10987654321",
      "account_owner_name": "Mary Johnson",
      "account_number": "7654321",
      "account_digit": "0"
    }
  ]
}
```

### Request Body Params

| Field                                  | Type         | Description                                                                                              | Characters |
|----------------------------------------|--------------|----------------------------------------------------------------------------------------------------------|------------|
| `beneficiary_settlement_percentage` *  | float        | Percentage of the settled amount allocated to the bank slip's beneficiary. Accepts values from 0 to 100. | -          |
| `beneficiary_max_amount`               | float        | Maximum amount the beneficiary receives at settlement. When the paid amount exceeds this limit, the surplus is fully directed to the first rule of the `split_payment_rules` array. Accepts values greater than 0 and less than or equal to the bank slip amount. | - |
| `split_payment_rules` *                | object array | List of split rules. Minimum 1, maximum 10 rules.                                                        | **[split_payment_rule Object](#objeto-split_payment_rule)** |

### Objeto split_payment_rule

| Field                  | Type    | Description                                                                                          | Characters |
|------------------------|---------|------------------------------------------------------------------------------------------------------|------------|
| `percentage` *         | float   | Percentage of the settled amount allocated to this account. Accepts values from 0 to 100. Use `0` when this rule is meant exclusively to receive the surplus from `beneficiary_max_amount`. | - |
| `document_number` *    | string  | CPF/CNPJ of the destination account holder.                                                          | 11 or 14   |
| `account_owner_name` * | string  | Name of the destination account holder.                                                              | 100        |
| `account_number` *     | string  | Destination account number.                                                                          | 20         |
| `account_digit` *      | string  | Destination account check digit.                                                                     | 2          |

## Use case: directing late fees and interest to a separate account

> **How can I configure the split so that interest and late fees that exceed the bank slip's face value are directed to a different account?**

This scenario is common for platforms that issue bank slips on behalf of third parties (schools, condominiums, marketplaces), where the bank slip's owner should always receive the face value and the platform receives the additional interest/late fee in case of overdue payment.

It is configured by combining `beneficiary_max_amount` with a split rule with `percentage = 0`:

```json
{
  "beneficiary_settlement_percentage": 100,
  "beneficiary_max_amount": 1000.00,
  "split_payment_rules": [
    {
      "percentage": 0,
      "document_number": "12345678000199",
      "account_owner_name": "Billing Platform",
      "account_number": "1234567",
      "account_digit": "8"
    }
  ]
}
```

**How the calculation works** considering a bank slip of R$ 1,000.00:

| Scenario | Paid amount | Beneficiary receives | Platform receives |
|---|---|---|---|
| Paid on time | R$ 1,000.00 | R$ 1,000.00 | R$ 0.00 (no settlement generated) |
| Paid late (with R$ 100.00 interest/fee) | R$ 1,100.00 | R$ 1,000.00 | R$ 100.00 |
| Partial late payment | R$ 950.00 | R$ 950.00 | R$ 0.00 |

The rule is: the beneficiary receives **at most** `beneficiary_max_amount`; any amount paid above this is fully directed to the **first** rule in `split_payment_rules`.

:::caution Attention!
- `beneficiary_max_amount` must be greater than 0 and less than or equal to the bank slip amount (`amount`).
- When any rule has `percentage = 0`, the `beneficiary_max_amount` field is required.
- Only **one** rule in `split_payment_rules` may have `percentage = 0` per bank slip (the surplus recipient).
:::

## Response

STATUS 204

Response Body

```json
{}
```

## Error Response

STATUS 4xx

Response Body: Error

```json
{
  "title": "title",
  "description": "description in English",
  "translation": "descrição em portugues",
  "code": "code",
  "extra_fields": {}
}
```

| HTTP Code<br/>`status` | QI Code<br/>`code` | Title<br/>`title`         | Description (eng)<br/>`description`                                                          | Description (pt-br)<br/>`translation`                                                                     |
|------------------------|--------------------|---------------------------|----------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------|
| 400                    | QIT000001          | Bad Request               | Schema Error                                                                                 | Schema Inválido                                                                                           |
| 404                    | BKS000029          | Not Found                 | Bank slip not found for the given key (`{bank_slip_key}`).                                   | Boleto não encontrado para a chave fornecida (`{bank_slip_key}`).                                         |
| 400                    | BKS000032          | Bad Request               | Bank slip must be in 'registered' status.                                                    | O boleto deve possuir o status 'registered'.                                                              |
| 422                    | BKS000157          | Unprocessable Entity      | Could not find an account matching the provided split payment account data.                 | Não foi possível encontrar uma conta com os dados informados na regra de split payment.                   |
| 400                    | BKS000158          | Bad Request               | The beneficiary_max_amount must be greater than 0 and not greater than the bank slip amount. | O beneficiary_max_amount deve ser maior que 0 e não pode ser maior que o valor do boleto.                 |
| 400                    | BKS000159          | Bad Request               | Split payment rules with percentage equal to 0 require beneficiary_max_amount to be set.     | Regras de split payment com percentual igual a 0 exigem o campo beneficiary_max_amount preenchido.        |
| 400                    | BKS000160          | Bad Request               | Only one split payment rule with percentage equal to 0 is allowed.                           | É permitido apenas uma regra de split payment com percentual igual a 0.                                   |

---

# Amount

URL: /en/documentation/boletos/instrucoes/valor

The amount instruction allows changing the value of a bank slip, provided the bank slip has already been registered. If there is already a pending amount instruction awaiting confirmation for the bank slip in question, sending a new instruction is not allowed.

:::caution Attention!
If there is any amount instruction pending confirmation, sending a new instruction is not allowed.
:::

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /amount
METHOD POST

### 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         |
| `bank_slip_key`         | uuidv4 | Unique bank slip identification key, in uuid v4 format        | 36         |

Request Body

```json
{
    "request_control_key": "01234567-89ab-cdef-0123-456789abcdef",
    "amount": 150.50
}
```

### Request Body Params

| Field                      | Type    | Description                                                                        | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|------------|
| `request_control_key` *    | uuidv4  | Unique request identification key used by the client in uuid v4 format            | 36         |
| `amount` *                 | number  | New bank slip amount (must be different from the current amount)                  | -          |

:::caution Attention!
The amount must be different from the current bank slip amount and must have at most 2 decimal places.
:::

## Response

STATUS 202

Response Body

```json
{
  "occurrence_key": "5a745b65-9a2c-44eb-b43e-c80ef5429d94",
  "bank_slip_key": "fdafdffa-cbd4-4f3c-8e3d-990428305161"
}
```

### Response Body Params

| Field              | Type   | Description                                                                       | Characters |
|--------------------|--------|-----------------------------------------------------------------------------------|------------|
| `occurrence_key` * | uuidv4 | Unique occurrence (instruction) identification key in uuid v4 format             | 36         |
| `bank_slip_key` *  | uuidv4 | Unique bank slip identification key in uuid v4 format                            | 36         |

### 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<br/>`status` | QI Code<br/>`code` | Title<br/>`title`                                 | Description (eng)<br/>`description`                                                                                       | Description (pt-br)<br/>`translation`                                                                                     |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 400                      | QIT000001            | Bad Request                                        | Schema Error                                                                                                            | Schema Inválido                                                                                                         |
| 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.                                                                 |
| 404                      | BKS000013            | Not Found | Requester profile not found         |               Carteira não encontrada                                                                 |
| 409                      | BKS000014            | Conflict | Request control key already sent or duplicated sent: `<request_control_key>` | Chave de controle da requisição já utilizada ou enviada duplicada: `<request_control_key>` |
| 400                      | BKS000022            | Bad Request                                        | Requester profile is not opened.                                                              | Carteira não está aberta.                          |
| 404                      | BKS000029            | Not Found                                        | Bank slip not found for the given key (`{bank_slip_key}`).                                                              | Boleto não encontrado para a chave fornecida (`{bank_slip_key}`).                          |
| 400                      | BKS000032            | Bad Request                                        | Bank slip must be in 'registered' status.                                                              | O boleto deve possuir o status 'registered'.                          |
| 409                      | BKS000135            | Conflict                                        | An amount occurrence already exists for this bank slip.                                                              | Já existe uma ocorrência de valor para este boleto.                          |
| 400                      | BKS000136            | Bad Request                                        | Only credit card financial instrument type can have zero amount.                                                              | Apenas o tipo de instrumento financeiro cartão de crédito pode ter valor zero.                          |
| 400                      | BKS000137            | Bad Request                                        | Amount must be different from bank slip amount.                                                              | O valor deve ser diferente do valor do boleto.                          |

---

# Introduction

URL: /en/documentation/boletos/introducao

The billing wallet is the service that allows the issuance of bank slips. There are various types of wallets, and each one defines how slips will be generated, the costs, settlement fees, credited account, and various configurations that will enable the bank to perform the correct billing. During the account opening at QI Tech, a wallet within QI and a wallet at Bradesco, with QI Tech's global billing configurations, are automatically available to the client.
Moreover, if the client is interested in the registration or modification of a wallet with different configurations from the global configuration, they can request the service from our team.

## How does slip issuance work?
QI Tech's APIs allow the abstraction of the life cycle of a slip through a state machine, where we have the following statuses:

### Registration Request
- accepted: Slip issuance request has entered the registration queue;
- rejected: Slip issuance request rejected, when the registration request contains a semantic error that prevents registration.

### Registration Completed
- registered: Slip registered and available for payment.

### Payment Notification
- payment_notice: Slip payment notice, this notification is sent when the slip is paid, but financial settlement has not yet occurred.
- notary_office_payment_notice: Slip payment notice, this notification is sent when the slip is paid at a notary office, but financial settlement has not yet occurred.

### Settlement
- paid: Slip paid - settled with financial settlement.
- written_off: Slip written off without financial settlement.

---

# List settlement groups

URL: /en/documentation/boletos/liquidacao/listar_grupos_de_liquidacao

:::info Information
In our system, settlement groups are a way to reconcile transactions with settled bank slips. This process (settlement) describes the transfer of a paid bank slip amount to the account that should receive this payment. In summary, whenever QI receives information that a bank slip has been paid by another bank or, in the case of protested bank slips, by the notary office, a settlement is created for that specific bank slip. Subsequently, **settlement groups** are created, which represent batches of settlements grouped by type.

At a later moment, the payment transaction for this settlement group is made to the client's account. The **transaction_key** of this transaction is then saved for reconciliation purposes, so you can see all the bank slips that were settled in a specific transaction. For example, if you have five R$ 5.00 bank slips each, where one was paid via notary office, one was paid via QR Code PIX and the other three were paid using the typed line or barcode by another bank, five settlements will be created for these bank slips. Then, these settlements will be grouped into three settlement groups: one of R$ 15.00 with the three bank slips paid using the typed line or barcode, for which a single transaction will be made, another of R$ 5.00 for the bank slip paid via QR Code PIX and the last one also of R$ 5.00 with the bank slip paid via notary office.
:::

The settlement groups listing will return all settlement groups of the account that fit the query parameters sent in the request.

## Request

ENDPOINT /account/ ACCOUNT_KEY /bank_slip_settlement_groups
METHOD GET

### Path parameters

| Field                   | Type   | Description                                                    | Characters |
|-------------------------|--------|--------------------------------------------------------------|------------|
| `account_key`           | uuidv4 | Unique account identification key    | 36         |

### Query parameters

| Field                   | Type   | Description                                                    | Characters              |
|-------------------------|--------|--------------------------------------------------------------|-------------------------|
| `bank_slip_settlement_group_key`         | uuidv4 | Unique settlement group identification key   | 36                      |
| `transaction_key`             | uuidv4 | Unique settlement group transaction identification key                           | 36                                                |
| `bank_slip_settlement_group_status`      | string | Settlement group status | **[Enumerators bank_slip_settlement_group_status](#enumerators-bank_slip_settlement_group_status)** |
| `date_from`            | string    | Start date. Format "YYYY-MM-DD".                                      |
| `date_to`              | string    | End date. Format "YYYY-MM-DD".                                        |
| `page`                  | integer| Page number                                             | -                       |
| `page_size`             | integer| Page size                                            | -                       |

## Response

STATUS 200

Response Body

```json
{
    "data": [
        {
            "bank_slip_settlement_group_key": "5ba0b0cf-ac4a-4c91-819d-d6c46d70e3ab",
            "account_key": "96015228-4905-42fc-bda6-e70e0e552b6b",
            "transaction_key": "6704d927-9e0d-411d-8c44-c377c0c56637",
            "amount": 1069.24,
            "bank_slip_settlement_group_type": "notary_office",
            "bank_slip_settlement_group_status": "settled",
            "bank_slip_settlement_quantity": 1
        },
        {
            "bank_slip_settlement_group_key": "feda6069-c0cf-4148-b881-a475737330ab",
            "account_key": "96015228-4905-42fc-bda6-e70e0e552b6b",
            "transaction_key": "00d557de-78ca-4871-b254-2852499660e2",
            "amount": 2400.0,
            "bank_slip_settlement_group_type": "siloc",
            "bank_slip_settlement_group_status": "settled",
            "bank_slip_settlement_quantity": 303
        },
        {
            "bank_slip_settlement_group_key": "5493030c-ba1c-44de-9e85-5aaee0afe46d",
            "account_key": "96015228-4905-42fc-bda6-e70e0e552b6b",
            "transaction_key": "b42c4d0a-8060-41d7-bd00-17889cc76485",
            "amount": 250.0,
            "bank_slip_settlement_group_type": "siloc",
            "bank_slip_settlement_group_status": "settled",
            "bank_slip_settlement_quantity": 50
        },
        {
            "bank_slip_settlement_group_key": "f33c087d-cbae-47a9-bd5a-e6a8ecc04ed2",
            "account_key": "96015228-4905-42fc-bda6-e70e0e552b6b",
            "transaction_key": "6ee57aea-b589-4dff-9555-200c34380154",
            "amount": 4024800.0,
            "bank_slip_settlement_group_type": "str",
            "bank_slip_settlement_group_status": "settled",
            "bank_slip_settlement_quantity": 16
        },
        {
            "bank_slip_settlement_group_key": "27b9b2b7-549e-406e-9f41-c71e0cb08b00",
            "account_key": "96015228-4905-42fc-bda6-e70e0e552b6b",
            "transaction_key": "36aa7a00-6741-41d5-99e9-ce620fed5823",
            "amount": 300.0,
            "bank_slip_settlement_group_type": "split_payment",
            "bank_slip_settlement_group_status": "settled",
            "bank_slip_settlement_quantity": 1,
            "settlement_date": "2026-04-23"
        }
    ],
    "pagination": {
        "current_page": 1,
        "rows_per_page": 100
    }
}
```

### Response Body Params

| Field            | Type         | Description                             | Characters                                  |
|------------------|--------------|---------------------------------------|---------------------------------------------|
| `data`          | object array | Bank slips                               | **[Object bank_slip_settlement_group](#object-bank_slip_settlement_group)**   |
| `pagination`    | object       | Pagination information              | **[Object pagination](#object-pagination)** |

### Object bank_slip_settlement_group

| Field                      | Type    | Description                                                                          | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `bank_slip_settlement_group_key      `     | uuidv4  | Unique bank slip identification key in uuid v4 format                          | 36                                                |
| `account_key`     | uuidv4  | Unique account identification key | 36                                                |
| `transaction_key`             | uuidv4 | Unique settlement group transaction identification key                           | 36                                                |
| `amount`                  | float   | Total settled amount                                                               | -
| `bank_slip_settlement_group_type`      | string | Settlement group type | **[Enumerators bank_slip_settlement_group_type](#enumerators-bank_slip_settlement_group_type)** |
| `bank_slip_settlement_group_status`      | string | Settlement group status | **[Enumerators bank_slip_settlement_group_status](#enumerators-bank_slip_settlement_group_status)** |
| `bank_slip_settlement_quantity`              | integer  |  Number of settlements in the group  | - |

### Object pagination

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

### Enumerators bank_slip_settlement_group_type

| Enumerator                   | Description                                                                    |
|------------------------------|------------------------------------------------------------------------------|
| siloc                        | for payment of securities (security value less than R$ 250,000)                          |
| qr_code                      | for payment of securities made via QR Code |
| str                          | for payment of VR securities (security value greater than R$ 250,000) |
| notary_office                | for payment of securities made via notary office             |
| split_payment                | settlement group destined to a recipient account from the bank slip's [**credit split**](/documentation/boletos/instrucoes/rateio_de_credito) |

:::tip Bank slips with credit split
When a bank slip has a [**credit split**](/documentation/boletos/instrucoes/rateio_de_credito) configured, payment generates one settlement group per recipient:
- The group for the **bank slip's beneficiary** keeps the original settlement flow type (`siloc`, `qr_code`, `str` or `notary_office`).
- The groups for the **split recipient accounts** are created with the `split_payment` type.

Each account involved (beneficiary and recipients) can list its own settlement group by calling this endpoint with its own `account_key` — this way, recipients can reconcile exactly how much they received from each bank slip.
:::

### Enumerators bank_slip_settlement_group_status

| Enumerator                   | Description                                                                    |
|------------------------------|------------------------------------------------------------------------------|
| pending                      | settlement group created but transaction not performed  |
| settled                      | settlement group created and transaction performed |

## 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<br/>`status` | QI Code<br/>`code` | Title<br/>`title`                                 | Description (eng)<br/>`description`                                                                                       | Description (pt-br)<br/>`translation`                                                                                     |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 400                      | QIT000001            | Bad Request                                        | Schema Error                                                                                                            | Schema Inválido                                                                                                         |
| 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                      | BKS000095            | Bad Request | Invalid bank slip settlement group status.         |               Status de grupo de liquidação de boleto inválido. |

---

# List Settlements

URL: /en/documentation/boletos/liquidacao/listar_liquidacoes

:::info Information
In our system, **settlements** describe the transfer of value from a paid bank slip to the account that should receive that payment. In summary, whenever QI receives information that a bank slip has been paid by another bank or, in the case of protested bank slips, by the notary office, a settlement is created for that specific bank slip. Subsequently, settlement groups are created to which they will always be linked, representing batches of settlements grouped by type.

At a later moment, a payment transaction is performed for this settlement group to the client's account. The **transaction_key** of this transaction is then saved for reconciliation purposes, so you can see all bank slips that were settled in a specific transaction. For example, if you have five bank slips of R$ 5.00 each, where one was paid via notary office, one was paid via PIX QR Code, and the other three were paid using the barcode or typed line by another bank, five settlements will be created for these bank slips. Then, these settlements will be grouped into three settlement groups: one of R$ 15.00 with the three bank slips paid using the barcode or typed line, for which a single transaction will be performed, another of R$ 5.00 for the bank slip paid via PIX QR Code, and the last one also of R$ 5.00 with the bank slip paid via notary office.
:::

The settlement listing will return all settlements from the settlement group sent in the request.

## Request

ENDPOINT /account/ ACCOUNT_KEY /bank_slip_settlement_group/ BANK_SLIP_SETTLEMENT_GROUP_KEY /bank_slip_settlements
METHOD GET

### Path parameters

| Field                   | Type   | Description                                                    | Characters |
|-------------------------|--------|--------------------------------------------------------------|------------|
| `account_key`           | uuidv4 | Unique account identification key    | 36         |
| `bank_slip_settlement_group_key`         | uuidv4 | Unique settlement group identification key   | 

## Response

STATUS 200

Response Body

```json
{
    "data": [
        {
            "settlement_key": "388eac3a-4138-421c-86af-f6fe3d1a9419",
            "amount": 4800.0,
            "account_key": "96015228-4905-42fc-bda6-e70e0e552b6b",
            "bank_slip_key": "d39e243b-8532-4006-9ffd-17607d5d1620",
            "barcode": "32991981000275000002269450000000043200779790"
        },
        {
            "settlement_key": "c3d7c62e-73fa-473f-b5a2-82e9b8a7f9bb",
            "amount": 1.0,
            "account_key": "96015228-4905-42fc-bda6-e70e0e552b6b",
            "bank_slip_key": "3088ffdd-dec0-4fa3-8643-995d6809a2e6",
            "barcode": "32999980300000001000001370000000000100828480"
        }
    ],
    "pagination": {
        "current_page": 1,
        "rows_per_page": 100
    }
}
```

### Response Body Params

| Field            | Type         | Description                             | Characters                                  |
|------------------|--------------|---------------------------------------|---------------------------------------------|
| `data`          | object array | Bank slips                               | **[bank_slip_settlement object](#bank_slip_settlement-object)**   |
| `pagination`    | object       | Pagination information              | **[pagination object](#pagination-object)** |

### bank_slip_settlement object

| Field                      | Type    | Description                                                                          | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `settlement_key      `     | uuidv4  | Unique settlement identification key                          | 36                                                |
| `account_key`     | uuidv4  | Unique account identification key | 36                                                |
| `amount`                  | float   | Settled amount                                                               | -
| `bank_slip_key      `     | uuidv4  | Unique bank slip identification key in uuid v4 format                          |
| `barcode`              | string  | Bank slip barcode                                                         |

### pagination object

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

## 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<br/>`status` | QI Code<br/>`code` | Title<br/>`title`                                 | Description (eng)<br/>`description`                                                                                       | Description (pt-br)<br/>`translation`                                                                                     |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 400                      | QIT000001            | Bad Request                                        | Schema Error                                                                                                            | Schema Inválido                                                                                                         |
| 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                      | BKS000093            | Bad Request | Settlement group not found for the given key.         |   Grupo de liquidação não encontrado para a chave fornecida. |

---

# Scenario simulation

URL: /en/documentation/boletos/liquidacao/simulacao_de_cenarios_de_liquidacao

This page describes how to simulate the execution of actions performed by external agents to test the bank slip settlement flow. These simulations are useful for homologation and integration testing.

:::info Information
There is no return payload (response body) in these requests. They simulate external actions and return only the HTTP status.
:::

## 1 - Payment notice simulation

Simulates a bank slip payment notice, changing its status to `payment_notice`.

ENDPOINT /mock/bank_slip/payment_notice
METHOD POST

Request Body

```json
{
    "bank_slip_key": "0d00b0e2-af11-472f-11f0-11f3330bae33",
    "paid_amount": 12.0,
    "payment_method": "cash",
    "payment_type": "full_interbank"
}
```

### Request Body Object

| Field                            | Type    | Description                                                          | Max. Chars.  |
|----------------------------------|---------|----------------------------------------------------------------------|--------------|
| **bank_slip_key***               | string  | Bank slip unique key                                                 | 36           |
| **paid_amount**                  | float   | Payment amount. If not provided, uses the original bank slip value  | -            |
| **payment_method**               | string  | Payment method used                                                  | -            |
| **payment_type**                 | string  | Interbank payment type                                              | -            |

### payment_method Enumerators

| Enumerator      | Description                  |
|-----------------|------------------------------|
| `cash`          | Cash                         |
| `account_debit` | Account debit                |
| `credit_card`   | Credit card                  |
| `check`         | Check                        |

### payment_type Enumerators

| Enumerator              | Description                  |
|-------------------------|------------------------------|
| `full_interbank`        | Full interbank payment       |
| `partial_interbank`     | Partial interbank payment    |

:::tip Behavior
- If `paid_amount` is not provided, the original bank slip value will be used
- If `payment_type` is not provided, it will be considered as full payment (`full_interbank`)
- The simulation creates a payment notice occurrence
- The bank slip will be moved to `payment_notice` status after simulation
- **Important**: For `partial_interbank`, the bank slip status is not changed. This option is used to simulate cases of partial payment bank slips, as explained in the [introduction](/documentation/boletos/introducao)
:::

## 2 - Bank slip settlement simulation

Simulates payment and financial settlement of a bank slip, changing its status to `paid`.

ENDPOINT /mock/bank_slip/settlement
METHOD POST

Request Body

```json
{
    "bank_slip_key": "0d00b0e2-af11-472f-11f0-11f3330bae33",
    "paid_amount": 12.0,
    "payment_method": "cash"
}
```

### Request Body Object

| Field                            | Type    | Description                                                          | Max. Chars.  |
|----------------------------------|---------|----------------------------------------------------------------------|--------------|
| **bank_slip_key***               | string  | Bank slip unique key                                                 | 36           |
| **paid_amount**                  | float   | Settlement payment amount. If not provided, uses the original bank slip value | -            |
| **payment_method**               | string  | Payment method used                                                  | -            |

### payment_method Enumerators

| Enumerator      | Description                  |
|-----------------|------------------------------|
| `cash`          | Cash                         |
| `account_debit` | Account debit                |
| `credit_card`   | Credit card                  |
| `check`         | Check                        |

:::tip Behavior
- If `paid_amount` is not provided, the original bank slip value will be used
- The simulation creates a payment occurrence with code 65 (payment) by default
- The bank slip will be moved to `paid` status after simulation
:::

---

# List discharge files

URL: /en/documentation/boletos/retorno/listar_arquivos_retorno

:::info
The files provided in the URLs returned by this endpoint follow the QI Tech Return File Layout standard with 400 positions.
Download the manual here: [Layout de Cobrança - QI Tech versão 2.1.](https://storage.googleapis.com/live-doc-api/public_samples/Layout%20de%20Cobran%C3%A7a%20-%20QI%20Tech%20v2.1.pdf)
:::

Discharge files are used for reconciliation. Each Transaction Record line (Type 1) refers to an instruction (whether for issuance, extension, discount, etc.) that was confirmed or rejected by CIP/Nuclea on the previous day.

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /discharge_files
METHOD GET

### Path parameters

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

### Query parameters

| Field                   | Type   | Description                                                    | Characters              |
|-------------------------|--------|--------------------------------------------------------------|-------------------------|
| `discharge_file_key`         | uuidv4 | Unique discharge file identification key, in uuid v4 format   | 36                      |
| `page`                  | integer| Page number                                             | -                       |
| `page_size`             | integer| Page size                                            | -                       |
| `from_date`             | string| Start date (format "YYYY-MM-DD")                           | 10                      |
| `to_date`               | string| End date (format "YYYY-MM-DD")                             | 10                      |

## Response

STATUS 200

Response Body

```json
{
    "data": [
        {
            "discharge_file_key": "f1a8fe59-29cd-49e5-8d18-55194869b45c",
            "discharge_file_name": "CB15102401.RET",
            "discharge_file_url": "https://storage.googleapis.com/local-bank-slip-api/2024/61a746ca-05bf-429d-99c3-3fba0f9fbea7/329-20-7336-3073959/discharge/CB15102401.RET",
            "reference_date": "2024-10-15"
        }
    ],
    "pagination": {
        "current_page": 1,
        "rows_per_page": 100
    }
}
```

### Response Body Params

| Field            | Type         | Description                             | Characters                                  |
|------------------|--------------|---------------------------------------|---------------------------------------------|
| `data`          | object array | Discharge files                               | **[discharge_file object](#discharge_file-object)**   |
| `pagination`    | object       | Pagination information              | **[pagination object](#pagination-object)** |

### discharge_file object

| Field                      | Type    | Description                                                                          | Characters |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `discharge_file_key      `     | uuidv4  | Unique discharge file identification key in uuid v4 format                          | 36                                                |
| `discharge_file_name`     | string  | Discharge file name | -                                                |
| `discharge_file_url`             | string | Discharge file URL                           | -                                                |
| `reference_date`                  | string   | Discharge file reference date in YYYY-MM-DD format                                                               | 10 |

### pagination object

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

## 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<br/>`status` | QI Code<br/>`code` | Title<br/>`title`                                 | Description (eng)<br/>`description`                                                                                       | Description (pt-br)<br/>`translation`                                                                                     |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 400                      | QIT000001            | Bad Request                                        | Schema Error                                                                                                            | Schema Inválido                                                                                                         |
| 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                      | 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                                                                 |
| 400                      | BKS000052            | Bad Request        | Invalid account status.                                                                            | Status da conta inválido.                                                                                 |

---

# Bank Slip Webhooks

URL: /en/documentation/boletos/webhooks/boleto

:::danger Warning!
QI Tech webhooks should not be mapped in a restrictive way. 
Additional fields may be included in the webhook payloads returned in our APIs.
:::

:::info Webhook Resending
You can query and resend webhooks following the detailed instructions in the documentation: [Webhook Resending](/documentation/notificacoes/reenvio_de_notificacoes).
:::

## Introduction

Throughout the bank slip lifecycle within our system, webhooks will be sent with the following bank slip status (`bank_slip_status`):

| Enumerator                    | Translation                    | Description                                                       |
|-------------------------------|--------------------------------|------------------------------------------------------------------------------------------------|
|  registered                   | registered                     | Bank slip registered and available for payment |
|  rejected                     | rejected                      | Bank slip issuance request rejected due to validation errors                               |
|  payment_notice               | payment notice             | Bank slip payment notice (bank slip paid but payment not yet settled)                    |
|  notary_office_payment_notice | notary office payment notice | Notary office bank slip payment notice (bank slip paid but payment not yet settled)                    |
|  paid                         | paid                           | Bank slip paid and financially settled                         |
|  written_off                  | written off                        | Bank slip written off (can no longer be paid) and without financial settlement                              |
|  payment_blocked              | payment blocked       | Payment blocked due to protest flow                    |

And webhooks are sent whenever occurrences of the following types are confirmed (`occurrence_type`):

| Enumerator                    | Translation                    | Description                                                                    |
|-------------------------------|--------------------------------|------------------------------------------------------------------------------|
|  registration                 | registration                       | Bank slip registration                                                           |
|  rebate                       | rebate                     | Rebate of part of the title base value                                  |
|  cancel_rebate                | rebate cancellation     | Cancellation of existing rebate                                         |
|  extension                    | extension                       | Extension of title expiration date                                      |
|  write_off                    | write off                          | Bank slip write off                                                              |
|  protest_write_off            | protest write off             | Bank slip write off due to notary office protest                                     |
|  payment_write_off            | payment write off            | Bank slip write off due to payment                                                |
|  discount                     | discount                       | Discount changes                                                      |
|  fine                         | fine                          | Fine changes                                                           |
|  interest                     | interest                          | Interest changes                                                         |
|  protest_request              | protest request             | Notary office protest request                                               |
|  bankruptcy_protest_request   | bankruptcy protest request  | Notary office bankruptcy protest request                                    |
|  notary_office_entry          | notary office entry            | Title entry into notary office occurrence                                  |
|  protest_cancel_request       | protest request withdrawal | Current protest request withdrawal                                |
|  protest_remove_request       | protest suspension           | Title protest suspension                                               |
|  notary_office_exit           | notary office exit              | Title exit from notary office occurrence                                    |
|  payment_notice               | payment notice             | Bank slip payment notice (bank slip paid but payment not yet settled) |
|  notary_office_payment_notice | notary office payment notice | Notary office bank slip payment notice (bank slip paid but payment not yet settled)  |
|  payment                      | payment                      | Notification that the bank slip was paid and written off                               |

:::info Information
The timeout for our webhook response is 10 seconds.
:::

## Examples
----

### Registration

Webhook Body: accepted occurrence

```json
{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"bank_slip_key": "11b13b2c-4204-41b3-8596-2ee7ecbde38c",
		"bank_slip_status": "registered",
		"occurrence_key": "9077cc0b-5bbd-4432-888e-6bf6384c250a",
		"occurrence_type": "registration",
		"occurrence_status": "confirmed"
	}
}
```

Webhook Body: rejected occurrence

```json
{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"bank_slip_key": "ae783ed7-b892-4e48-8480-b045e3b492f5",
		"bank_slip_status": "rejected",
		"occurrence_key": "db04719d-4370-4f3f-82b7-d72d3db2f39e",
		"occurrence_type": "registration",
		"occurrence_status": "rejected"
	}
}
```

### Rebate/rebate cancellation

Webhook Body: rebate

```json
{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"bank_slip_key": "11b13b2c-4204-41b3-8596-2ee7ecbde38c",
		"bank_slip_status": "registered",
		"occurrence_key": "db04719d-4370-4f3f-82b7-d72d3db2f39e",
		"occurrence_type": "rebate",
		"occurrence_status": "confirmed"
	}
}
```

Webhook Body: rebate cancellation

```json
{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"bank_slip_key": "11b13b2c-4204-41b3-8596-2ee7ecbde38c",
		"bank_slip_status": "registered",
		"occurrence_key": "db04719d-4370-4f3f-82b7-d72d3db2f39e",
		"occurrence_type": "cancel_rebate",
		"occurrence_status": "confirmed"
	}
}
```

### Extension

Webhook Body

```json
{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"bank_slip_key": "11b13b2c-4204-41b3-8596-2ee7ecbde38c",
		"bank_slip_status": "registered",
		"occurrence_key": "db04719d-4370-4f3f-82b7-d72d3db2f39e",
		"occurrence_type": "extension",
		"occurrence_status": "confirmed"
	}
}
```

### Discount

Webhook Body

```json
{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"bank_slip_key": "a8df1c2e-77ff-49ea-9e7a-8fd536a6e357",
		"bank_slip_status": "registered",
		"occurrence_key": "db04719d-4370-4f3f-82b7-d72d3db2f39e",
		"occurrence_type": "discount",
		"occurrence_status": "confirmed"
	}
}
```

### Interest

Webhook Body

```json
{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"bank_slip_key": "69f3f345-07c5-4c80-a8dd-51054afdad01",
		"bank_slip_status": "registered",
		"occurrence_key": "8550e47a-7554-455c-bdd8-cf0c048a277c",
		"occurrence_type": "interest",
		"occurrence_status": "confirmed"
	}
}
```

### Fine

Webhook Body

```json
{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"bank_slip_key": "97e6edab-b793-4eb6-a1a7-0a27e1d5c73e",
		"bank_slip_status": "registered",
		"occurrence_key": "47b06bdb-c006-47a7-81f2-7aac7fff823b",
		"occurrence_type": "fine",
		"occurrence_status": "confirmed"
	}
}
```

### Write Off

The `occurrence_reason` field is optional and is sent when the bank provides the reason for the write-off. It contains the reason code and name provided by the financial institution.

Webhook Body: without reason

```json
{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"bank_slip_key": "45c21054-57fd-4d28-8d5a-0cdc5cb29670",
		"bank_slip_status": "written_off",
		"occurrence_key": "0b92bd47-fae5-46c0-8c40-e5aebc9ecd28",
		"occurrence_type": "write_off",
		"occurrence_status": "confirmed"
	}
}
```

Webhook Body: with reason

```json
{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2026-05-04T21:12:07.877Z",
	"data": {
		"bank_slip_key": "25add0b0-cb2d-4be4-8f22-4305a4dd9793",
		"bank_slip_status": "written_off",
		"occurrence_key": "ca71f446-be05-47cc-b470-234e4806344c",
		"occurrence_type": "write_off",
		"occurrence_status": "confirmed",
		"occurrence_reason": {
			"bank_reason_code": "16",
			"bank_reason_name": "Título Baixado pelo Banco por decurso de Prazo"
		}
	}
}
```

### Protest Write Off

Webhook Body

```json
{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-10-25T18:05:01.395Z",
	"data": {
		"bank_slip_key": "7182639f-dea5-46c6-99c6-af0d94d772cb",
		"bank_slip_status": "written_off",
		"occurrence_key": "93380917-beee-4f3e-af01-6c24e140d53d",
		"occurrence_type": "protest_write_off",
		"occurrence_status": "confirmed"
	}
}
```

### Payment Write Off

Webhook Body

```json
{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-10-18T18:02:15.152Z",
	"data": {
		"bank_slip_key": "40d6a1bc-cfed-4444-a901-e02ecc169ce5",
		"bank_slip_status": "written_off",
		"occurrence_key": "78221daa-945f-485b-b39c-97ef0e251afe",
		"occurrence_type": "payment_write_off",
		"occurrence_status": "confirmed"
	}
}
```

### Protest Request

Webhook Body

```json
{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-10-16T20:54:13.013Z",
	"data": {
		"bank_slip_key": "f03c5fec-b31c-402a-b832-80da8a493653",
		"bank_slip_status": "payment_blocked",
		"occurrence_key": "304958f6-cdf2-4fb1-b8f3-5482030bf0eb",
		"occurrence_type": "protest_request",
		"occurrence_status": "confirmed"
	}
}
```

### Bankruptcy Protest Request

Webhook Body

```json
{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-10-16T20:54:13.013Z",
	"data": {
		"bank_slip_key": "21aeefb4-4fa1-4e32-b2bb-32a7486128f0",
		"bank_slip_status": "payment_blocked",
		"occurrence_key": "11a7e9e8-4667-471b-bc3f-2f65f77e22e9",
		"occurrence_type": "bankruptcy_protest_request",
		"occurrence_status": "confirmed"
	}
}
```

### Notary Office Entry

Webhook Body

```json
{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-10-17T18:00:48.341Z",
	"data": {
		"bank_slip_key": "5bc4c1d4-d51b-4b0b-b308-81850d04e523",
		"bank_slip_status": "payment_blocked",
		"occurrence_key": "159e6e3f-fce5-4362-829e-1595fc14d66c",
		"occurrence_type": "notary_office_entry",
		"occurrence_status": "confirmed"
	}
}
```

### Protest Cancellation

Webhook Body

```json
{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-10-23T18:00:52.374Z",
	"data": {
		"bank_slip_key": "96d2a896-f2da-484c-8d40-20fabbde15ee",
		"bank_slip_status": "registered",
		"occurrence_key": "2505fedf-0061-478b-b45e-8420b755ebbb",
		"occurrence_type": "protest_cancel_request",
		"occurrence_status": "confirmed"
	}
}
```

### Protest Suspension

Webhook Body

```json
{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-10-30T18:01:00.452Z",
	"data": {
		"bank_slip_key": "878d462e-be4e-40bd-b797-b831fef87f48",
		"bank_slip_status": "written_off",
		"occurrence_key": "cb08785d-0a4d-41f4-a64c-bafe730b175b",
		"occurrence_type": "protest_remove_request",
		"occurrence_status": "confirmed"
	}
}
```

### Notary Office Exit

Webhook Body

```json
{
	"webhook_type": "baas.bank_slip.occurrence",
	"webhook_datetime": "2024-11-01T18:01:01.949Z",
	"data": {
		"bank_slip_key": "79d07a3d-3953-4195-a2e2-bbbf10635f27",
		"bank_slip_status": "registered",
		"occurrence_key": "c703b04c-7334-40fe-bf8d-b43bd991dbab",
		"occurrence_type": "notary_office_exit",
		"occurrence_status": "confirmed"
	}
}
```

### Payment Notice

First webhook: bank slip was paid, but not yet settled

Webhook Body

```json
{
	"webhook_type": "baas.bank_slip.payment_notice",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"bank_slip_key": "db04719d-4370-4f3f-82b7-d72d3db2f39e",
		"bank_slip_status": "payment_notice",
		"occurrence_key": "d0341ad7-aa87-4dad-929b-38c8c9218f23",
		"occurrence_type": "payment_notice",
		"occurrence_status": "confirmed"
	}
}
```

### Notary Office Payment Notice

First webhook: bank slip was paid at notary office, but not yet settled

Webhook Body

```json
{
	"webhook_type": "baas.bank_slip.notary_office_payment_notice",
	"webhook_datetime": "2024-10-16T18:00:43.621Z",
	"data": {
		"bank_slip_key": "05f2b81b-b241-4e72-9b2c-7312257a0284",
		"bank_slip_status": "notary_office_payment_notice",
		"occurrence_key": "3ecab7b1-c991-4d91-8d71-08a34eec1d7d",
		"occurrence_type": "notary_office_payment_notice",
		"occurrence_status": "confirmed"
	}
}
```

### Payment

Webhook Body

```json
{
	"webhook_type": "baas.bank_slip.payment",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"bank_slip_key": "db04719d-4370-4f3f-82b7-d72d3db2f39e",
		"bank_slip_status": "paid",
		"occurrence_key": "db04719d-4370-4f3f-82b7-d72d3db2f39e",
		"occurrence_type": "payment",
		"occurrence_status": "confirmed",
		"paid_amount": 850.0,
		"paid_rebate_amount": 200.0,
		"paid_discount_amount": 0.0,
		"paid_fine_amount": 0.0,
		"paid_interest_amount": 50.0,
		"payment_method": "account_debit",
		"payment_origin": "qr_code",
		"payment_credit_date": "2024-07-02",
		"payment_bank": {
			"code": "341",
			"ispb": 60701190,
			"name": "ITAU UNIBANCO S.A."
		},
		"payment_branch": "0216"
	}
}
```

:::info Information
The `payment_bank` and `payment_branch` fields indicate the bank and branch where the bank slip was paid. They are only populated when this information is received upon payment settlement; if the paying bank is not identified, `payment_bank` is returned as `null`.
:::

### payment_method Enumerators

| Enumerator         | Description                               |
|--------------------|-----------------------------------------|
| cash       | Cash                  |
| account_debit             | Account debit                |
| credit_card      | Credit card |
| check          | Check                  |

### payment_origin Enumerators

| Enumerator           | Description                                |
|----------------------|------------------------------------------|
| phisical_cashier     | Branches - Traditional posts           |
| taa                  | Self-service terminal             |
| internet             | Internet (home/office bank)              |
| corban               | Banking correspondent                  |
| call_center          | Call center     |
| eletronic_file       | Electronic file                       |
| dda                  | DDA                                       |
| digital_correspondent| Digital correspondent                   |
| qr_code              | Pix QR Code payment                |

---

# Bank slip wallet webhooks

URL: /en/documentation/boletos/webhooks/carteira

:::danger Warning!
QI Tech webhooks should not be mapped in a restrictive manner. 
Additional fields may be included in the webhook payloads returned by our APIs.
:::

:::info Webhook Resending
You can check and resend webhooks following the detailed instructions in the documentation: [Webhook Resending](/documentation/notificacoes/reenvio_de_notificacoes).
:::

## Introduction

After creating a wallet (`requester_profile`) within our system, webhooks will be sent with the following status:

| Enumerator                    | Translation            | Description                                                |
|-------------------------------|------------------------|------------------------------------------------------------|
|  opened                       | open                   | Bank slip wallet opened and ready to register bank slips  |

:::info Information
The timeout for our webhook responses is 10 seconds.
:::

## Examples
----

### Opening confirmation

Webhook Body

```json
{
	"webhook_type": "baas.bank_slip.requester_profile",
	"webhook_datetime": "2024-08-13T21:35:55.679Z",
	"data": {
		"requester_profile_key": "fd86d9b1-2a5e-4e03-9a59-a043c7632c97",
		"request_control_key": "0868a24b-4a69-4138-ac4d-ecaeddf0005f",
		"requester_profile_code": "329-04-2338-2625918",
		"requester_profile_status": "opened"
	}
}
```

---

# Settlement webhooks

URL: /en/documentation/boletos/webhooks/liquidacao

:::danger Attention!
QI Tech webhooks should not be mapped in a restrictive manner. 
Additional fields may be included in the webhook payloads returned by our APIs.
:::

:::info Webhook Resending
You can check and resend webhooks following the detailed instructions in the documentation: [Webhook Resending](/documentation/notificacoes/reenvio_de_notificacoes).
:::

## Introduction

In our system, settlement groups are a way to reconcile transactions with settled bank slips. This process (settlement) describes the transfer of value from a paid bank slip to the account that should receive this payment. In summary, whenever QI receives information that a bank slip has been paid by another bank or, in the case of protested bank slips, by the notary office, a settlement is created for that specific bank slip. Subsequently, **settlement groups** are created, which represent batches of settlements grouped by type.

At a later time, the payment transaction for this settlement group is made to the client's account. The **transaction_key** of this transaction is then saved for reconciliation purposes, so you can see all the bank slips that were settled in a specific transaction. For example, if you have five bank slips of R$ 5.00 each, where one was paid via notary office, one was paid via QR Code PIX and the other three were paid using the payment line or barcode by another bank, five settlements will be created for these bank slips. Then, these settlements will be grouped into three settlement groups: one of R$ 15.00 with the three bank slips paid using the payment line or barcode, for which a single transaction will be made, another of R$ 5.00 for the bank slip paid via QR Code PIX and the last one also of R$ 5.00 with the bank slip paid via notary office.

:::info Information
The timeout for response from our webhooks is 10 seconds.
:::

## Examples
----

### Settlement group

Webhook Body

```json
{
    "webhook_type": "baas.bank_slip.bank_slip_settlement_group",
    "webhook_datetime": "2024-08-13T21:35:55.679Z",
    "data": {
        "bank_slip_settlement_group_key": "87e6687b-d02b-45dc-b5b8-b51e16ec0a03",
        "amount": 1,
        "bank_slip_settlement_group_type": "siloc",
        "bank_slip_settlement_group_status": "settled",
        "transaction_key": "fc60a57e-c6ac-4e39-a3cf-2dc3c491dac6"
    }
}
```

### bank_slip_settlement_group_type enumerators

| Enumerator                   | Description                                                                    |
|------------------------------|------------------------------------------------------------------------------|
| siloc                        | for payment of securities (security value less than R$ 250,000)                          |
| qr_code                      | for payment of securities made via QR Code |
| str                          | for payment of VR securities (security value greater than R$ 250,000) |
| notary_office                | for payment of securities made via notary office             |

### bank_slip_settlement_group_status enumerators

| Enumerator                   | Description                                                                    |
|------------------------------|------------------------------------------------------------------------------|
| pending                      | settlement group created but transaction was not executed  |
| settled                      | settlement group created and transaction executed |

---

# Return file Webhooks

URL: /en/documentation/boletos/webhooks/retorno

Return files are used for reconciliation. In them, each Transaction Record line (Type 1) refers to an instruction (whether issuance, extension, discount, etc.) that was confirmed or rejected by CIP/Nuclea on the previous day.

:::danger Attention!
QI Tech webhooks should not be mapped in a restrictive manner. 
Additional fields may be included in the webhook payloads returned in our APIs.
:::

:::info Webhook Resending
You can consult and resend webhooks by following the detailed instructions in the documentation: [Webhook Resending](/documentation/notificacoes/reenvio_de_notificacoes).
:::

:::info Information
The timeout for our webhook response is 10 seconds.
:::

## Examples
----

### Return file

Webhook Body

```json
{
    "webhook_type": "baas.bank_slip.discharge_file",
    "webhook_datetime": "2024-08-13T21:35:55.679Z",
    "data": {
        "discharge_file_key": "f1a8fe59-29cd-49e5-8d18-55194869b45c",
        "reference_date": "2024-10-15",
        "requester_profile_key": "fc60a57e-c6ac-4e39-a3cf-2dc3c491dac6",
        "discharge_file_url": "https://storage.googleapis.com/local-bank-slip-api/2024/61a746ca-05bf-429d-99c3-3fba0f9fbea7/329-20-7336-3073959/discharge/CB15102401.RET",
        "cnab_bank": "qi_scd",
        "cnab_layout": "400",
    }
}
```

:::info Supported Banks
Currently, the return file webhook supports the following banks:
- Bradesco (bradesco)
- Itaú (itau)
- QI SCD (qi_scd)
- Santander (santander)
:::

:::info Supported Layouts
Currently, the return file webhook supports the following CNAB layouts:
- CNAB 400 (400)
:::

---

# Open bank slip ownership exchange batch

URL: /en/documentation/troca_de_titularidade/abrir_lote

This endpoint will create a bank slip ownership exchange batch. 
The batch is created without any bank slips, and the bank slips will need to be inserted through the [bank slip inclusion endpoint](/incluir_boletos).

## Request

ENDPOINT /account/ ACCOUNT-KEY /requester_profile/ REQUESTER-PROFILE-KEY /bank_slip_ownership_exchange_batch/stream
METHOD POST

### Path parameters

| Field         | Type   | Description                                                                                                              | Characters |
|---------------|--------|------------------------------------------------------------------------------------------------------------------------|------------|
| `ACCOUNT-KEY` | uuidv4 | Unique identification key of the origin account, where the bank slips were originally registered.                      | 36         |
| `REQUESTER-PROFILE-KEY` | uuidv4 | Unique identification key of the origin billing portfolio, where the bank slips were originally registered. | 36         |

Request Body - Billing portfolio UUID key

```json
{
	"request_control_key": "66c9399a-1463-4e2b-acc0-7ee447f81bf0",
	"new_requester_profile_key": "e494067f-5bd4-4819-b64f-0687bd217f45",
	"new_pix_key": "2376da91-86ad-4a0b-a466-f0f5acf53e24"
}
```

Request Body - Billing portfolio code

```json
{
	"request_control_key": "66c9399a-1463-4e2b-acc0-7ee447f81bf0",
	"new_requester_profile_code": "329-09-0001-1234567",
	"new_pix_key": "2376da91-86ad-4a0b-a466-f0f5acf53e24"
}
```

:::info Bank slip billing portfolio code
The Billing Portfolio Code is a string that follows the following pattern:

[ Bank Number ] + [ Portfolio Code ] + [ Account Branch Number ] + [ Account Number with 7 characters and without check digit ]

By default, at QI Tech, the Bank Number, Portfolio Code and Branch will always be `329`, `09` and `0001`, respectively.

Therefore, the Billing Portfolio Code for account 5308318-3 will be: `329-09-0001-5308318`.
:::

## Body Params
| Field | Type | Description | Characters |
|---|------|-----------| --|
|`request_control_key`| uuidv4 | Unique identification key of the request on this endpoint. Used to avoid duplication in the API call. |36|
|`new_requester_profile_key`| uuidv4 | Unique identification key of the destination billing portfolio. It's the billing portfolio where the bank slips will be transferred. You can obtain this key through the [account billing portfolios query endpoint](../boletos/carteira/listar_carteiras) |36|
|`new_requester_profile_code`| string | Destination billing portfolio code. It's the billing portfolio where the bank slips will be transferred. |19|
|`new_pix_key` | string | PIX key of the destination account for the ownership exchange (for bolepix cases). | 255 |

## Response

STATUS 202

Response Body

```json
{
    "bank_slip_ownership_exchange_batch_key": "243c9369-ce8b-49df-969c-d891c2fc8c21",
    "request_control_key": "66c9399a-1463-4e2b-acc0-7ee447f81bf0",
    "bank_slip_ownership_exchange_batch_status": "open",
    "new_requester_profile_key": "e494067f-5bd4-4819-b64f-0687bd217f45",
    "new_requester_profile_code": "329-09-0001-8703524",
    "new_requester_profile_owner_name": "Fulano de Tal",
    "new_requester_profile_owner_document_number": "70896538000101",
    "new_requester_profile_account_number": "8703524",
    "new_requester_profile_account_digit": "1",
    "new_requester_profile_account_branch": "0001",
    "new_pix_key": "2376da91-86ad-4a0b-a466-f0f5acf53e24",
    "total_bank_slip_count": 0,
    "total_amount": 0
}
```

## Response Params
| Field                                         | Type  | Description                                                                                                                                                                                                                                                                   | Characters                                                                                                          |
|-----------------------------------------------|-------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|
| `bank_slip_ownership_exchange_batch_key`      | uuidv4 | Unique identification key of the ownership exchange batch.                                                                                                                                                                                                                        | 36                                                                                                                  |
| `request_control_key`                         | uuidv4 | Unique identification key of the request on this endpoint. Used to avoid duplication in the API call.                                                                                                                                                            | 36                                                                                                                  |
| `bank_slip_ownership_exchange_batch_status`   | enum  | Status of the ownership exchange batch.                                                                                                                                                                                                                                               | [Enumerators `bank_slip_ownership_exchange_batch_status`](#enumerators-bank_slip_ownership_exchange_batch_status) |
| `new_requester_profile_key`                   | uuidv4 | Unique identification key of the destination billing portfolio. It's the billing portfolio where the bank slips will be transferred. You can obtain this key through the [account billing portfolios query endpoint](../boletos/carteira/listar_carteiras) | 36                                                                                                                  |
| `new_requester_profile_code`                  | string | Destination billing portfolio code. It's the billing portfolio where the bank slips will be transferred.                                                                                                                                                                    | 19                                                                                                                  |
| `new_requester_profile_owner_name`            | string | Name of the destination account holder and beneficiary of the destination billing portfolio.                                                                                                                                                                                   | 255                                                                                                                 |
| `new_requester_profile_owner_document_number` | string | Document number (CPF/CNPJ) of the destination account holder and beneficiary of the destination billing portfolio.                                                                                                                                                         | 255                                                                                                                 |
| `new_requester_profile_account_number`        | string | Destination account number for the ownership exchange.                                                                                                                                                                                                                                   | 7                                                                                                                   |
| `new_requester_profile_account_digit`         | string | Check digit of the destination account for the ownership exchange.                                                                                                                                                                                                                       | 1                                                                                                                   |
| `new_requester_profile_account_branch`        | string | Branch number of the destination account for the ownership exchange.                                                                                                                                                                                                                        | 4                                                                                                                   |
| `new_pix_key`                                 | string | PIX key of the destination account for the ownership exchange (for bolepix cases).                                                                                                                                                                                                     | 255                                                                                                                 |
| `total_bank_slip_count`                       | float | Total number of bank slips in the ownership exchange batch.                                                                                                                                                                                                                                     | -                                                                                                                   |
| `total_amount`                                 | float | Sum of the face value of bank slips in the ownership exchange batch.                                                                                                                                                                                               | -                                                                                                                   |                                                                                                                                                                                                               

### Enumerators bank_slip_ownership_exchange_batch_status
| Enumerator | Description                                                                                              |
|------------|--------------------------------------------------------------------------------------------------------|
| open       | The batch was created and is still open for bank slip inclusion/exclusion.                               |
| sent     | Bank slip selection has been completed and the ownership exchange batch is pending approval. The approving party needs to perform the approval                  |
| processing | Bank slip selection has been completed and the ownership exchange of bank slips contained in the batch is being processed. |
| approved | Bank slips contained in the batch have already been transferred to the recipient |
| cancelled   | Ownership exchange batch cancelled. |
| rejected | Ownership exchange batch rejected. |

---

# Approve Bank Slip Ownership Exchange Batch

URL: /en/documentation/troca_de_titularidade/aprovar_lote

Once the ownership exchange batch has been sent through ```/send```, it is necessary to approve the ownership exchange.

The approval must be done by the destination account and requester, which will be the new owners responsible for the bank slips after the ownership exchange. If the ownership exchange is between accounts of the same requester, it's sufficient to change the account-key.

## Request

ENDPOINT /account/ ACCOUNT-KEY /requester_profile/ REQUESTER-PROFILE-KEY /bank_slip_ownership_exchange_batch/ BANK-SLIP-OWNERSHIP-EXCHANGE-BATCH-KEY /approve
METHOD PATCH

### Path parameters

| Field                                    | Type   | Description                                                                                                        | Characters |
|------------------------------------------|--------|--------------------------------------------------------------------------------------------------------------------|------------|
| `ACCOUNT-KEY`                            | uuidv4 | Unique identification key of the destination account where the bank slips will be sent.                | 36         |
| `REQUESTER-PROFILE-KEY`                  | uuidv4 | Unique identification key of the destination wallet where the bank slips will be transferred. | 36         |
| `BANK-SLIP-OWNERSHIP-EXCHANGE-BATCH-KEY` | uuidv4 | Unique identification key of the ownership exchange batch.                                                             | 36         |

Request Body

```json
{}
```

## Response

STATUS 200

Response Body

```json
{
    "bank_slip_ownership_exchange_batch_key": "243c9369-ce8b-49df-969c-d891c2fc8c21",
    "request_control_key": "66c9399a-1463-4e2b-acc0-7ee447f81bf0",
    "bank_slip_ownership_exchange_batch_status": "processing",
    "new_requester_profile_key": "e494067f-5bd4-4819-b64f-0687bd217f45",
    "new_requester_profile_code": "329-09-0001-8703524",
    "new_requester_profile_owner_name": "Fulano de Tal",
    "new_requester_profile_owner_document_number": "70896538000101",
    "new_requester_profile_account_number": "8703524",
    "new_requester_profile_account_digit": "1",
    "new_requester_profile_account_branch": "0001",
    "new_pix_key": "2376da91-86ad-4a0b-a466-f0f5acf53e24",
    "total_bank_slip_count": 3,
    "total_amount": 750.00
}
```

## Response Params
| Field | Type | Description | Characters                                                                                                          |
|---|------|-----------|---------------------------------------------------------------------------------------------------------------------|
| `bank_slip_ownership_exchange_batch_key`      | uuidv4 | Unique identification key of the ownership exchange batch.                                                                                                                                                                                                                        | 36                                                                                                                  |
| `request_control_key`                         | uuidv4 | Unique identification key of the request on this endpoint. Used to avoid duplication in API calls.                                                                                                                                                            | 36                                                                                                                  |
| `bank_slip_ownership_exchange_batch_status`   | enum  | Status of the ownership exchange batch.                                                                                                                                                                                                                                               | [Enumerators `bank_slip_ownership_exchange_batch_status`](#enumerators-bank_slip_ownership_exchange_batch_status) |
| `new_requester_profile_key`                   | uuidv4 | Unique identification key of the destination collection wallet. It is the collection wallet to which the bank slips will be transferred. You can obtain this key through the [account collection wallets query endpoint](../boletos/carteira/listar_carteiras) | 36                                                                                                                  |
| `new_requester_profile_code`                  | string | Code of the destination collection wallet. It is the collection wallet to which the bank slips will be transferred.                                                                                                                                                                    | 19                                                                                                                  |
| `new_requester_profile_owner_name`            | string | Name of the destination account holder and beneficiary of the destination collection wallet.                                                                                                                                                                                   | 255                                                                                                                 |
| `new_requester_profile_owner_document_number` | string | Document number (CPF/CNPJ) of the destination account holder and beneficiary of the destination collection wallet.                                                                                                                                                         | 255                                                                                                                 |
| `new_requester_profile_account_number`        | string | Destination account number for the ownership exchange.                                                                                                                                                                                                                                   | 7                                                                                                                   |
| `new_requester_profile_account_digit`         | string | Check digit of the destination account for the ownership exchange.                                                                                                                                                                                                                       | 1                                                                                                                   |
| `new_requester_profile_account_branch`        | string | Branch number of the destination account for the ownership exchange.                                                                                                                                                                                                                        | 4                                                                                                                   |
| `new_pix_key`                                 | string | PIX key of the destination account for the ownership exchange (for bolepix cases).                                                                                                                                                                                                     | 255                                                                                                                 |
| `total_bank_slip_count`                       | float | Total number of bank slips in the ownership exchange batch.                                                                                                                                                                                                                                     | -                                                                                                                   |
| `total_amount`                                | float | Sum of the face value of bank slips in the ownership exchange batch. | -                                                                                                                   |                                                                                                                                                                                                               

### Enumerators bank_slip_ownership_exchange_batch_status
| Enumerator | Description                                                                                              |
|------------|--------------------------------------------------------------------------------------------------------|
| open       | The batch has been created and is still open for adding/removing bank slips.                               |
| closed     | The batch is closed and the ownership exchange of the bank slips contained in the batch has been completed.                  |
| processing | Bank slip selection has been completed and the ownership exchange of bank slips contained in the batch is being processed. |
| pending_approval | Bank slip selection has been completed and the ownership exchange batch is pending approval. The approving party can remove bank slips from the batch. |
| canceled   | Ownership exchange batch canceled. |
| rejected | Ownership exchange batch rejected. |

---

# Cancel bank slip ownership exchange batch

URL: /en/documentation/troca_de_titularidade/cancelar_lote

## Request

ENDPOINT /bank_slip/account/ ACCOUNT-KEY /requester_profile/ REQUESTER-PROFILE-KEY /bank_slip_ownership_exchange_batch/ BANK-SLIP-OWNERSHIP-EXCHANGE-BATCH-KEY /cancel
METHOD PATCH

### Path parameters

| Field                                    | Type   | Description                                                                                                              | Characters |
|------------------------------------------|--------|------------------------------------------------------------------------------------------------------------------------|------------|
| `ACCOUNT-KEY`                            | uuidv4 | Unique identification key of the source account, where the bank slips were originally registered.                      | 36         |
| `REQUESTER-PROFILE-KEY`                  | uuidv4 | Unique identification key of the source billing portfolio, where the bank slips were originally registered. | 36         |
| `BANK-SLIP-OWNERSHIP-EXCHANGE-BATCH-KEY` | uuidv4 |Unique identification key of the ownership exchange batch.| 36         |

Request Body

```json
{}
```

## Response

STATUS 200

Response Body

```json
{
    "bank_slip_ownership_exchange_batch_key": "243c9369-ce8b-49df-969c-d891c2fc8c21",
    "request_control_key": "66c9399a-1463-4e2b-acc0-7ee447f81bf0",
    "bank_slip_ownership_exchange_batch_status": "canceled",
    "new_requester_profile_key": "e494067f-5bd4-4819-b64f-0687bd217f45",
    "new_requester_profile_code": "329-09-0001-8703524",
    "new_requester_profile_owner_name": "Fulano de Tal",
    "new_requester_profile_owner_document_number": "70896538000101",
    "new_requester_profile_account_number": "8703524",
    "new_requester_profile_account_digit": "1",
    "new_requester_profile_account_branch": "0001",
    "new_pix_key": "2376da91-86ad-4a0b-a466-f0f5acf53e24",
    "total_bank_slip_count": 3,
    "total_amount": 750.00
}
```

## Response Params
| Field | Type | Description | Characters                                                                                                          |
|---|------|-----------|---------------------------------------------------------------------------------------------------------------------|
| `bank_slip_ownership_exchange_batch_key`      | uuidv4 | Unique identification key of the ownership exchange batch.                                                                                                                                                                                                                        | 36                                                                                                                  |
| `request_control_key`                         | uuidv4 | Unique identification key of the request to this endpoint. Used to prevent duplicates in API calls.                                                                                                                                                            | 36                                                                                                                  |
| `bank_slip_ownership_exchange_batch_status`   | enum  | Status of the ownership exchange batch.                                                                                                                                                                                                                                               | [Enumerators `bank_slip_ownership_exchange_batch_status`](#enumerators-bank_slip_ownership_exchange_batch_status) |
| `new_requester_profile_key`                   | uuidv4 | Unique identification key of the destination billing portfolio. This is the billing portfolio to which the bank slips will be transferred. You can get this key through the [endpoint for querying billing portfolios of an account](../boletos/carteira/listar_carteiras) | 36                                                                                                                  |
| `new_requester_profile_code`                  | string | Code of the destination billing portfolio. This is the billing portfolio to which the bank slips will be transferred.                                                                                                                                                                    | 19                                                                                                                  |
| `new_requester_profile_owner_name`            | string | Name of the destination account holder and beneficiary of the destination billing portfolio.                                                                                                                                                                                   | 255                                                                                                                 |
| `new_requester_profile_owner_document_number` | string | Document number (CPF/CNPJ) of the destination account holder and beneficiary of the destination billing portfolio.                                                                                                                                                         | 255                                                                                                                 |
| `new_requester_profile_account_number`        | string | Destination account number for the ownership exchange.                                                                                                                                                                                                                                   | 7                                                                                                                   |
| `new_requester_profile_account_digit`         | string | Check digit of the destination account for the ownership exchange.                                                                                                                                                                                                                       | 1                                                                                                                   |
| `new_requester_profile_account_branch`        | string | Branch number of the destination account for the ownership exchange.                                                                                                                                                                                                                        | 4                                                                                                                   |
| `new_pix_key`                                 | string | PIX key of the destination account for the ownership exchange (for bolepix cases).                                                                                                                                                                                                     | 255                                                                                                                 |
| `total_bank_slip_count`                       | float | Total number of bank slips in the ownership exchange batch.                                                                                                                                                                                                                                     | -                                                                                                                   |
| `total_amount`                                | float | Sum of the face value of the bank slips in the ownership exchange batch. | -                                                                                                                   |                                                                                                                                                                                                               

### Enumerators bank_slip_ownership_exchange_batch_status
| Enumerator | Description                                                                                              |
|------------|--------------------------------------------------------------------------------------------------------|
| open       | The batch was created and is still open for inclusion/exclusion of bank slips.                               |
| closed     | The batch is closed and the ownership exchange of the bank slips contained in the batch has been completed.                  |
| processing | Bank slip selection has been completed and the ownership exchange of the bank slips contained in the batch is being processed. |
| pending_approval | Bank slip selection has been completed and the ownership exchange batch is pending approval. The approving party can remove bank slips from the batch. |
| canceled   | Ownership exchange batch canceled. |
| rejected | Ownership exchange batch rejected. |

---

# Include bank slips in an ownership exchange batch

URL: /en/documentation/troca_de_titularidade/incluir_boletos

This endpoint is used to include bank slips in a bank slip ownership exchange batch.

## Request

ENDPOINT /account/ ACCOUNT-KEY /requester_profile/ REQUESTER-PROFILE-KEY /bank_slip_ownership_exchange_batch/ BANK-SLIP-OWNERSHIP-EXCHANGE-BATCH-KEY /append
METHOD PATCH

### Path parameters

| Field                                    | Type   | Description                                                                                                              | Characters |
|------------------------------------------|--------|------------------------------------------------------------------------------------------------------------------------|------------|
| `ACCOUNT-KEY`                            | uuidv4 | Unique identification key for the source account where the bank slips were originally registered.                      | 36         |
| `REQUESTER-PROFILE-KEY`                  | uuidv4 | Unique identification key for the source billing portfolio where the bank slips were originally registered. | 36         |
| `BANK-SLIP-OWNERSHIP-EXCHANGE-BATCH-KEY` | uuidv4 |Unique identification key for the ownership exchange batch.| 36         |

Request Body

```json
{
	"bank_slips": [
		"b21c5b5a-a71f-4672-9254-022401cd15f6",
		"8197e3d0-1500-439f-9f9d-d243115542fa",
		"8293b817-bed9-418a-8c1e-ec8ef5a31468"
	]
}
```

:::caution Warning!
The list of bank slips provided in the `bank_slips` object in the payload has a limitation of 10,000 bank slips per request. 
:::

## Response

STATUS 200

Response Body

```json
{
    "bank_slip_ownership_exchange_batch_key": "243c9369-ce8b-49df-969c-d891c2fc8c21",
    "request_control_key": "66c9399a-1463-4e2b-acc0-7ee447f81bf0",
    "bank_slip_ownership_exchange_batch_status": "open",
    "new_requester_profile_key": "e494067f-5bd4-4819-b64f-0687bd217f45",
    "new_requester_profile_code": "329-09-0001-8703524",
    "new_requester_profile_owner_name": "Fulano de Tal",
    "new_requester_profile_owner_document_number": "70896538000101",
    "new_requester_profile_account_number": "8703524",
    "new_requester_profile_account_digit": "1",
    "new_requester_profile_account_branch": "0001",
    "new_pix_key": "2376da91-86ad-4a0b-a466-f0f5acf53e24",
    "total_bank_slip_count": 3,
    "total_amount": 750.00
}
```

## Response Params
| Field | Type | Description | Characters                                                                                                          |
|---|------|-----------|---------------------------------------------------------------------------------------------------------------------|
| `bank_slip_ownership_exchange_batch_key`      | uuidv4 | Unique identification key for the ownership exchange batch.                                                                                                                                                                                                                        | 36                                                                                                                  |
| `request_control_key`                         | uuidv4 | Unique identification key for the request to this endpoint. Used to avoid duplication in API calls.                                                                                                                                                            | 36                                                                                                                  |
| `bank_slip_ownership_exchange_batch_status`   | enum  | Status of the ownership exchange batch.                                                                                                                                                                                                                                               | [Enumerators `bank_slip_ownership_exchange_batch_status`](#enumerators-bank_slip_ownership_exchange_batch_status) |
| `new_requester_profile_key`                   | uuidv4 | Unique identification key for the destination billing portfolio. This is the billing portfolio where the bank slips will be transferred. You can obtain this key through the [endpoint for querying billing portfolios of an account](../boletos/carteira/listar_carteiras) | 36                                                                                                                  |
| `new_requester_profile_code`                  | string | Code for the destination billing portfolio. This is the billing portfolio where the bank slips will be transferred.                                                                                                                                                                    | 19                                                                                                                  |
| `new_requester_profile_owner_name`            | string | Name of the destination account holder and beneficiary of the destination billing portfolio.                                                                                                                                                                                   | 255                                                                                                                 |
| `new_requester_profile_owner_document_number` | string | Document number (CPF/CNPJ) of the destination account holder and beneficiary of the destination billing portfolio.                                                                                                                                                         | 255                                                                                                                 |
| `new_requester_profile_account_number`        | string | Destination account number for the ownership exchange.                                                                                                                                                                                                                                   | 7                                                                                                                   |
| `new_requester_profile_account_digit`         | string | Check digit for the destination account of the ownership exchange.                                                                                                                                                                                                                       | 1                                                                                                                   |
| `new_requester_profile_account_branch`        | string | Branch number for the destination account of the ownership exchange.                                                                                                                                                                                                                        | 4                                                                                                                   |
| `new_pix_key`                                 | string | PIX key for the destination account of the ownership exchange (for PIX bank slip cases).                                                                                                                                                                                                     | 255                                                                                                                 |
| `total_bank_slip_count`                       | float | Total number of bank slips in the ownership exchange batch.                                                                                                                                                                                                                                     | -                                                                                                                   |
| `total_amount`                                | float | Sum of the face value of the bank slips in the ownership exchange batch. | -                                                                                                                   |                                                                                                                                                                                                               

### Enumerators bank_slip_ownership_exchange_batch_status
| Enumerator | Description                                                                                              |
|------------|--------------------------------------------------------------------------------------------------------|
| open       | The batch was created and is still open for inclusion/exclusion of bank slips.                               |
| sent     | The bank slip selection was completed and the ownership exchange batch is pending approval. The approving party needs to perform the approval                  |
| processing | The bank slip selection was completed and the ownership exchange of the bank slips contained in the batch is being processed. |
| approved | The bank slips contained in the batch have already been transferred to the recipient |
| cancelled   | Ownership exchange batch cancelled. |
| rejected | Ownership exchange batch rejected. |

---

# Introduction

URL: /en/documentation/troca_de_titularidade/introducao

The transfer of ownership of bank slips **(tombamento)** consists of the process of changing the collection portfolio and settlement account associated with already registered bank slips.

In an ownership transfer, there will always be **an origin account and collection portfolio and a destination account and collection portfolio.**

- The **origin account and portfolio** are those where the bank slips were originally registered.

- The **destination account and portfolio** are those to which the bank slips will be transferred (tombado).

**What is changed?**
- Collection portfolio
- Settlement account

**What is NOT changed?**
- Billing beneficiary data
- Payment slip number for payment
- Pix QR Code for payment (in BolePix cases)

## Use Cases

### Collateral composition
Collection bank slips from a portfolio can be used in composing collateral for a credit operation.
In this scenario, the destination account holder tomba the bank slips from their simple collection portfolio to the collection portfolio linked to the operation's collateral account.

### Assignment of credit rights
In cases where the collection bank slip is linked to an anticipated credit right, it is possible — after completing the anticipation — to tombar the bank slips to the portfolio of the new creditor of the anticipated right.

:::caution Attention!
The bank slip ownership transfer API **does not formalize** the fiduciary assignment or the anticipation of credit rights.
It only reflects what should happen with the financial flow of the asset linked to the tombado collection bank slip.
:::

## Process Flow
Bank slip tombamento is the process of transferring ownership of registered bank slips from one portfolio to another.
This flow consists of four main stages, which must be executed in sequence through API calls.

Below, we describe how each of them works.

**1. Batch opening**

The first step consists of creating a tombamento batch, which will group all bank slips to be transferred.
As soon as the batch is created, it is returned with the initial status `opened`.
At this stage, the origin account keys, destination portfolio, and the new associated Pix key must be informed.

**2. Including bank slips in the batch**

With the batch open, it is possible to add the bank slips that will be included in the ownership transfer.
During this stage, the batch status remains `opened`, indicating that it is still in preparation and can receive new bank slips.

**3. Sending the bank slips**

After including all desired bank slips, it is necessary to send the batch for processing.
At the moment the sending is performed, the batch status is updated to `sent`, and a webhook is triggered to inform the status change.
This sending marks the beginning of the tombamento operational flow.

**4. Tombamento approval**

Finally, batch approval must be performed by the destination account, confirming the ownership transfer of the bank slips.
After approval, the batch status changes to `processing`, indicating that the tombamento is in progress.
When the process is completed successfully, the system sends a final webhook with status `approved`, confirming that the ownership transfer has been finalized.

We share below the link that presents an organizational chart of the complete flow, including the associated endpoints and respective status changes at each stage of the process:

---

# List bank slips from an ownership exchange batch

URL: /en/documentation/troca_de_titularidade/listar_boletos_lote

Use this endpoint to list all bank slips included in the queried ownership exchange batch.

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip_ownership_exchange_batch/ BANK_SLIP_OWNERSHIP_EXCHANGE_BATCH_KEY /bank_slips
METHOD GET

### Path parameters

| Field         | Type   | Description                                                                                                              | Characters |
|---------------|--------|--------------------------------------------------------------------------------------------------------------------------|------------|
| `account_key` | uuidv4 | Unique identification key of the source account, where the bank slips were originally registered.                      | 36         |
| `requester_profile_key` | uuidv4 | Unique identification key of the source billing portfolio, where the bank slips were originally registered. | 36         |
| `bank_slip_ownership_exchange_batch_key` | uuidv4 |Unique identification key of the ownership exchange batch.| 36         |

### Query parameters

| Field                | Description                                  |
|----------------------|--------------------------------------------|
| `page_number`        | Current page being queried     |
| `page_size`          | Number of results per page        |

## Response

STATUS 200

Response Body

```json
{
    "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,
                "days_to_fine": 10
            },
            "interest_data": {
                "interest_type": "workdays_daily_amount",
                "interest_amount": 5,
                "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 Params

[Bank slip listing object](../boletos/consulta/listar_boletos#response-body-params)

---

# List bank slip ownership exchange batches - destination

URL: /en/documentation/troca_de_titularidade/listar_lotes_destino

Use this endpoint to list bank slip ownership exchange batches from the destination account — that is, the account to which the bank slips were transferred.

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip_ownership_exchange_batches/incoming
METHOD GET

### Path parameters

| Field         | Type   | Description                                                                                             | Characters |
|---------------|--------|---------------------------------------------------------------------------------------------------------|------------|
| `account_key` | uuidv4 | Unique identification key of the destination account, to which the bank slips will be transferred.                | 36         |
| `requester_profile_key` | uuidv4 | Unique identification key of the destination collection portfolio, to which the bank slips will be transferred. | 36         |

### Query parameters

| Field                | Description                                  |
|----------------------|--------------------------------------------|
| `page_number`        | Current page being queried     |
| `page_size`          | Number of results per page        |

## Response

STATUS 200

Response Body

```json
{
	"data": [
        {
            "bank_slip_exchange_batch_key": "186e73f1-456f-4265-8cb0-b32722041580",
            "request_control_key": "fa7fa38c-0356-4345-98ef-21a089d9a39a",
            "bank_slip_ownership_exchange_batch_status": "processing",
            "old_requester_profile_key": "01a30518-0b2e-4dd1-a105-8f8bf31868a2",
            "old_requester_profile_code": "329-09-0001-5963550",
            "old_requester_profile_owner_document_number": "02602536000102",
            "old_requester_profile_owner_name": "Coca Cola",
            "old_requester_profile_account_number": "5963550",
            "old_requester_profile_account_digit": "7",
            "old_requester_profile_account_branch": "0001",
            "old_pix_key": "2376da91-86ad-4a0b-a466-f0f5acf53e24",
            "total_bank_slip_count": 200,
            "total_amount": 38145.58
        },
        {
            "bank_slip_exchange_batch_key": "8a5bbded-72ff-4642-8830-f2a5a73eb62c",
            "request_control_key": "d3725802-7e56-4196-8182-2747ea18e96a",
            "bank_slip_ownership_exchange_batch_status": "open",
            "old_requester_profile_key": "316052e8-a017-4fb9-9939-9ce0390fa053",
            "old_requester_profile_code": "329-09-0001-4743630",
            "old_requester_profile_owner_document_number": "40500359000142",
            "old_requester_profile_owner_name": "QI SCD",
            "old_requester_profile_account_number": "4743630",
            "old_requester_profile_account_digit": "1",
            "old_requester_profile_account_branch": "0001",
            "old_pix_key": "2376da91-86ad-4a0b-a466-f0f5acf53e24",
            "total_bank_slip_count": 450,
            "total_amount": 548682.19
        },
        {
            "bank_slip_exchange_batch_key": "6f749806-8768-44ab-b7de-1f0d94d0a61a",
            "request_control_key": "1c1551f2-c6e7-42d5-b78d-1f7662128a33",
            "bank_slip_ownership_exchange_batch_status": "closed",
            "old_requester_profile_key": "8bfdd50f-97fd-4f29-bc53-b542a914f2d6",
            "old_requester_profile_code": "329-09-0001-7390371",
            "old_requester_profile_owner_document_number": "56000040000198",
            "old_requester_profile_name": "Meta",
            "old_requester_profile_account_number": "7390371",
            "old_requester_profile_account_digit": "7",
            "old_requester_profile_account_branch": "0001",
            "old_pix_key": "2376da91-86ad-4a0b-a466-f0f5acf53e24",
            "total_bank_slip_count": 40,
            "total_amount": 67245.96
        }
	],
	"pagination": {
		"current_page": 1,
		"rows_per_page": 100
	}
}
```

## Response Params
| Field                                         | Type  | Description                                                                                                                                                                                                                                          | Characters                                                                                                          |
|-----------------------------------------------|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|
| `bank_slip_ownership_exchange_batch_key`      | uuidv4 | Unique identification key of the ownership exchange batch.                                                                                                                                                                                               | 36                                                                                                                  |
| `request_control_key`                         | uuidv4 | Unique identification key of the request to this endpoint. Used to prevent duplicate API calls.                                                                                                                                   | 36                                                                                                                  |
| `bank_slip_ownership_exchange_batch_status`   | enum  | Status of the ownership exchange batch.                                                                                                                                                                                                                      | [Enumerators `bank_slip_ownership_exchange_batch_status`](#enumerators-bank_slip_ownership_exchange_batch_status) |
| `old_requester_profile_key`                   | uuidv4 | Unique identification key of the destination collection portfolio, to which the bank slips will be transferred. You can obtain this key through the [endpoint to query collection portfolios of an account](../boletos/carteira/listar_carteiras) | 36                                                                                                                  |
| `old_requester_profile_code`                  | string | Code of the destination collection portfolio, to which the bank slips will be transferred.                                                                                                                                                                    | 19                                                                                                                  |
| `old_requester_profile_owner_name`            | string | Name of the destination account holder and beneficiary of the destination collection portfolio.                                                                                                                                                          | 255                                                                                                                 |
| `old_requester_profile_owner_document_number` | string | Document number (CPF/CNPJ) of the destination account holder and beneficiary of the destination collection portfolio.                                                                                                                                | 255                                                                                                                 |
| `old_requester_profile_account_number`        | string | Account number of the ownership transfer destination.                                                                                                                                                                                                          | 7                                                                                                                   |
| `old_requester_profile_account_digit`         | string | Check digit of the ownership transfer destination account.                                                                                                                                                                                              | 1                                                                                                                   |
| `old_requester_profile_account_branch`        | string | Branch number of the ownership transfer destination account.                                                                                                                                                                                               | 4                                                                                                                   |
| `old_pix_key`                                 | string | PIX key of the ownership transfer destination account (for bolepix cases).                                                                                                                                                                            | 255                                                                                                                 |
| `total_bank_slip_count`                       | float | Total number of bank slips in the ownership exchange batch.                                                                                                                                                                                                            | -                                                                                                                   |
| `total_amount`                                 | float | Sum of the face value of bank slips in the ownership exchange batch.                                                                                                                                                                                      | -                                                                                                                   |                                                                                                                                                                                                               

### Enumerators bank_slip_ownership_exchange_batch_status
| Enumerator | Description                                                                                              |
|------------|--------------------------------------------------------------------------------------------------------|
| open       | The batch was created and is still open for inclusion/exclusion of bank slips.                               |
| sent     | Bank slip selection has been completed and the ownership exchange batch is pending approval. The approving party needs to perform the approval.                  |
| processing | Bank slip selection has been completed and the ownership transfer of bank slips contained in the batch is being processed. |
| approved | The bank slips contained in the batch have already been transferred to the recipient. |
| cancelled   | Ownership exchange batch cancelled. |
| rejected | Ownership exchange batch rejected. |

---

# List bank slip ownership exchange batches - source

URL: /en/documentation/troca_de_titularidade/listar_lotes_origem

Use this endpoint to list bank slip ownership exchange batches from the source account, i.e., the account where the bank slips were originally registered.

## Request

ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip_ownership_exchange_batches/outgoing
MÉTODO GET

### Path parameters

| Field         | Type   | Description                                                                                                              | Characters |
|---------------|--------|------------------------------------------------------------------------------------------------------------------------|------------|
| `ACCOUNT-KEY` | uuidv4 | Unique identification key of the source account where the bank slips were originally registered.                      | 36         |
| `REQUESTER-PROFILE-KEY` | uuidv4 | Unique identification key of the source collection wallet where the bank slips were originally registered. | 36         |

### Query parameters

| Field                | Description                                  |
|----------------------|--------------------------------------------|
| `page_number`        | Current page being queried     |
| `page_size`          | Number of results per page        |

## Response

STATUS 200

Response Body

```json
{
	"data": [
        {
            "bank_slip_exchange_batch_key": "186e73f1-456f-4265-8cb0-b32722041580",
            "request_control_key": "fa7fa38c-0356-4345-98ef-21a089d9a39a",
            "bank_slip_ownership_exchange_batch_status": "processing",
            "new_requester_profile_key": "01a30518-0b2e-4dd1-a105-8f8bf31868a2",
            "new_requester_profile_code": "329-09-0001-5963550",
            "new_requester_profile_owner_document_number": "02602536000102",
            "new_requester_profile_owner_name": "Coca Cola",
            "new_requester_profile_account_number": "5963550",
            "new_requester_profile_account_digit": "7",
            "new_requester_profile_account_branch": "0001",
            "new_pix_key": "2376da91-86ad-4a0b-a466-f0f5acf53e24",
            "total_bank_slip_count": 200,
            "total_amount": 38145.58
        },
        {
            "bank_slip_exchange_batch_key": "8a5bbded-72ff-4642-8830-f2a5a73eb62c",
            "request_control_key": "d3725802-7e56-4196-8182-2747ea18e96a",
            "bank_slip_ownership_exchange_batch_status": "open",
            "new_requester_profile_key": "316052e8-a017-4fb9-9939-9ce0390fa053",
            "new_requester_profile_code": "329-09-0001-4743630",
            "new_requester_profile_owner_document_number": "40500359000142",
            "new_requester_profile_owner_name": "QI SCD",
            "new_requester_profile_account_number": "4743630",
            "new_requester_profile_account_digit": "1",
            "new_requester_profile_account_branch": "0001",
            "new_pix_key": "2376da91-86ad-4a0b-a466-f0f5acf53e24",
            "total_bank_slip_count": 450,
            "total_amount": 548682.19
        },
        {
            "bank_slip_exchange_batch_key": "6f749806-8768-44ab-b7de-1f0d94d0a61a",
            "request_control_key": "1c1551f2-c6e7-42d5-b78d-1f7662128a33",
            "bank_slip_ownership_exchange_batch_status": "closed",
            "new_requester_profile_key": "8bfdd50f-97fd-4f29-bc53-b542a914f2d6",
            "new_requester_profile_code": "329-09-0001-7390371",
            "new_requester_profile_owner_document_number": "56000040000198",
            "new_requester_profile_name": "Meta",
            "new_requester_profile_account_number": "7390371",
            "new_requester_profile_account_digit": "7",
            "new_requester_profile_account_branch": "0001",
            "new_pix_key": "2376da91-86ad-4a0b-a466-f0f5acf53e24",
            "total_bank_slip_count": 40,
            "total_amount": 67245.96
        }
	],
	"pagination": {
		"current_page": 1,
		"rows_per_page": 100
	}
}
```

## Response Params
| Field                                         | Type  | Description                                                                                                                                                                                                                                                                   | Characters                                                                                                          |
|-----------------------------------------------|-------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|
| `bank_slip_ownership_exchange_batch_key`      | uuidv4 | Unique identification key of the ownership exchange batch.                                                                                                                                                                                                                        | 36                                                                                                                  |
| `request_control_key`                         | uuidv4 | Unique identification key of the request to this endpoint. Used to avoid duplication in API calls.                                                                                                                                                            | 36                                                                                                                  |
| `bank_slip_ownership_exchange_batch_status`   | enum  | Status of the ownership exchange batch.                                                                                                                                                                                                                                               | [Enumerators `bank_slip_ownership_exchange_batch_status`](#enumeradores-bank_slip_ownership_exchange_batch_status) |
| `new_requester_profile_key`                   | uuidv4 | Unique identification key of the destination collection wallet. This is the collection wallet where the bank slips will be transferred to. You can get this key through the [endpoint for querying collection wallets of an account](../boletos/carteira/listar_carteiras) | 36                                                                                                                  |
| `new_requester_profile_code`                  | string | Code of the destination collection wallet. This is the collection wallet where the bank slips will be transferred to.                                                                                                                                                                    | 19                                                                                                                  |
| `new_requester_profile_owner_name`            | string | Name of the destination account holder and beneficiary of the destination collection wallet.                                                                                                                                                                                   | 255                                                                                                                 |
| `new_requester_profile_owner_document_number` | string | Document number (CPF/CNPJ) of the destination account holder and beneficiary of the destination collection wallet.                                                                                                                                                         | 255                                                                                                                 |
| `new_requester_profile_account_number`        | string | Account number of the ownership exchange destination.                                                                                                                                                                                                                                   | 7                                                                                                                   |
| `new_requester_profile_account_digit`         | string | Check digit of the ownership exchange destination account.                                                                                                                                                                                                                       | 1                                                                                                                   |
| `new_requester_profile_account_branch`        | string | Branch number of the ownership exchange destination account.                                                                                                                                                                                                                        | 4                                                                                                                   |
| `new_pix_key`                                 | string | PIX key of the ownership exchange destination account (for bolepix cases).                                                                                                                                                                                                     | 255                                                                                                                 |
| `total_bank_slip_count`                       | float | Total number of bank slips in the ownership exchange batch.                                                                                                                                                                                                                                     | -                                                                                                                   |
| `total_amount`                                 | float | Sum of the face value of bank slips in the ownership exchange batch.                                                                                                                                                                                                               | -                                                                                                                   |                                                                                                                                                                                                               

### Enumerators bank_slip_ownership_exchange_batch_status
| Enumerator | Description                                                                                              |
|------------|--------------------------------------------------------------------------------------------------------|
| open       | The batch has been created and is still open for inclusion/exclusion of bank slips.                               |
| sent     | The selection of bank slips has been completed and the ownership exchange batch is pending approval. The approving party needs to perform the approval.                  |
| processing | The selection of bank slips has been completed and the ownership exchange of bank slips contained in the batch is being processed. |
| approved | The bank slips contained in the batch have already been transferred to the recipient. |
| cancelled   | Ownership exchange batch cancelled. |
| rejected | Ownership exchange batch rejected. |

---

# Remove boletos from an ownership exchange batch

URL: /en/documentation/troca_de_titularidade/remover_boletos

This endpoint is used to remove boletos from a boleto ownership exchange batch with status `open`.

## Request

ENDPOINT /account/ ACCOUNT-KEY /requester_profile/ REQUESTER-PROFILE-KEY /bank_slip_ownership_exchange_batch/ BANK-SLIP-OWNERSHIP-EXCHANGE-BATCH-KEY /remove
METHOD PATCH

### Path parameters

| Field                                    | Type   | Description                                                                                                              | Characters |
|------------------------------------------|--------|------------------------------------------------------------------------------------------------------------------------|------------|
| `ACCOUNT-KEY`                            | uuidv4 | Unique identification key of the origin account, where the boletos were originally registered.                      | 36         |
| `REQUESTER-PROFILE-KEY`                  | uuidv4 | Unique identification key of the origin billing profile, where the boletos were originally registered. | 36         |
| `BANK-SLIP-OWNERSHIP-EXCHANGE-BATCH-KEY` | uuidv4 |Unique identification key of the ownership exchange batch.| 36         |

Request Body

```json
{
	"bank_slips": [
		"b21c5b5a-a71f-4672-9254-022401cd15f6",
		"8197e3d0-1500-439f-9f9d-d243115542fa",
		"8293b817-bed9-418a-8c1e-ec8ef5a31468"
	]
}
```

:::caution Attention!
The list of boletos informed in the `bank_slips` object in the payload has a limitation of 10,000 boletos per request. 
:::

## Response

STATUS 200

Response Body

```json
{
    "bank_slip_ownership_exchange_batch_key": "243c9369-ce8b-49df-969c-d891c2fc8c21",
    "request_control_key": "66c9399a-1463-4e2b-acc0-7ee447f81bf0",
    "bank_slip_ownership_exchange_batch_status": "open",
    "new_requester_profile_key": "e494067f-5bd4-4819-b64f-0687bd217f45",
    "new_requester_profile_code": "329-09-0001-8703524",
    "new_requester_profile_owner_name": "Fulano de Tal",
    "new_requester_profile_owner_document_number": "70896538000101",
    "new_requester_profile_account_number": "8703524",
    "new_requester_profile_account_digit": "1",
    "new_requester_profile_account_branch": "0001",
    "new_pix_key": "2376da91-86ad-4a0b-a466-f0f5acf53e24",
    "total_bank_slip_count": 0,
    "total_amount": 0
}
```

## Response Params
| Field | Type | Description | Characters                                                                                                          |
|---|------|-----------|---------------------------------------------------------------------------------------------------------------------|
| `bank_slip_ownership_exchange_batch_key`      | uuidv4 | Unique identification key of the ownership exchange batch.                                                                                                                                                                                                                        | 36                                                                                                                  |
| `request_control_key`                         | uuidv4 | Unique identification key of the request to this endpoint. Used to prevent duplication in API calls.                                                                                                                                                            | 36                                                                                                                  |
| `bank_slip_ownership_exchange_batch_status`   | enum  | Status of the ownership exchange batch.                                                                                                                                                                                                                                               | [Enumerators `bank_slip_ownership_exchange_batch_status`](#enumerators-bank_slip_ownership_exchange_batch_status) |
| `new_requester_profile_key`                   | uuidv4 | Unique identification key of the destination billing profile. It is the billing profile to which the boletos will be transferred. You can obtain this key through the [endpoint for querying billing profiles of an account](../boletos/carteira/listar_carteiras) | 36                                                                                                                  |
| `new_requester_profile_code`                  | string | Code of the destination billing profile. It is the billing profile to which the boletos will be transferred.                                                                                                                                                                    | 19                                                                                                                  |
| `new_requester_profile_owner_name`            | string | Name of the destination account holder and beneficiary of the destination billing profile.                                                                                                                                                                                   | 255                                                                                                                 |
| `new_requester_profile_owner_document_number` | string | Document number (CPF/CNPJ) of the destination account holder and beneficiary of the destination billing profile.                                                                                                                                                         | 255                                                                                                                 |
| `new_requester_profile_account_number`        | string | Destination account number for the ownership exchange.                                                                                                                                                                                                                                   | 7                                                                                                                   |
| `new_requester_profile_account_digit`         | string | Check digit of the destination account for the ownership exchange.                                                                                                                                                                                                                       | 1                                                                                                                   |
| `new_requester_profile_account_branch`        | string | Branch number of the destination account for the ownership exchange.                                                                                                                                                                                                                        | 4                                                                                                                   |
| `new_pix_key`                                 | string | PIX key of the destination account for the ownership exchange (for bolepix cases).                                                                                                                                                                                                     | 255                                                                                                                 |
| `total_bank_slip_count`                       | float | Total number of boletos in the ownership exchange batch.                                                                                                                                                                                                                                     | -                                                                                                                   |
| `total_amount`                                | float | Sum of the face value of boletos in the ownership exchange batch. | -                                                                                                                   |                                                                                                                                                                                                               

### Enumerators bank_slip_ownership_exchange_batch_status
| Enumerator | Description                                                                                              |
|------------|--------------------------------------------------------------------------------------------------------|
| open       | The batch was created and is still open for inclusion/exclusion of boletos.                               |
| sent     | The boleto selection has been completed and the ownership exchange batch is pending approval. The approving party needs to perform the approval                  |
| processing | The boleto selection has been completed and the ownership exchange of boletos contained in the batch is being processed. |
| approved | The boletos contained in the batch have already been transferred to the recipient |
| cancelled   | Ownership exchange batch cancelled. |
| rejected | Ownership exchange batch rejected. |

---

# Send bank slip ownership exchange batch

URL: /en/documentation/troca_de_titularidade/validar_lote_e_enviar

This endpoint is used to close the batch and start processing the ownership transfer. When making the request, the batch will be validated and the status changed to sent, where both parties involved will receive a webhook related to the ownership exchange.

:::danger Attention!
This endpoint should only be triggered when the insertion of bank slips is completed and the proper formalizations between the origin and destination counterparts of the ownership exchange are concluded.
:::

## Request

ENDPOINT /account/ ACCOUNT-KEY /requester_profile/ REQUESTER-PROFILE-KEY /bank_slip_ownership_exchange_batch/ BANK-SLIP-OWNERSHIP-EXCHANGE-BATCH-KEY /send
METHOD PATCH

### Path parameters

| Field                                    | Type   | Description                                                                                                        | Characters |
|------------------------------------------|--------|------------------------------------------------------------------------------------------------------------------|------------|
| `ACCOUNT-KEY`                            | uuidv4 | Unique identification key of the origin account, where the bank slips were originally registered.                | 36         |
| `REQUESTER-PROFILE-KEY`                  | uuidv4 | Unique identification key of the origin billing portfolio, where the bank slips were originally registered. | 36         |
| `BANK-SLIP-OWNERSHIP-EXCHANGE-BATCH-KEY` | uuidv4 | Unique identification key of the ownership exchange batch.                                                             | 36         |

Request Body

```json
{}
```

## Response

STATUS 200

Response Body

```json
{
    "bank_slip_ownership_exchange_batch_key": "243c9369-ce8b-49df-969c-d891c2fc8c21",
    "request_control_key": "66c9399a-1463-4e2b-acc0-7ee447f81bf0",
    "bank_slip_ownership_exchange_batch_status": "processing",
    "new_requester_profile_key": "e494067f-5bd4-4819-b64f-0687bd217f45",
    "new_requester_profile_code": "329-09-0001-8703524",
    "new_requester_profile_owner_name": "Fulano de Tal",
    "new_requester_profile_owner_document_number": "70896538000101",
    "new_requester_profile_account_number": "8703524",
    "new_requester_profile_account_digit": "1",
    "new_requester_profile_account_branch": "0001",
    "new_pix_key": "2376da91-86ad-4a0b-a466-f0f5acf53e24",
    "total_bank_slip_count": 3,
    "total_amount": 750.00
}
```

## Response Params
| Field | Type | Description | Characters                                                                                                          |
|---|------|-----------|---------------------------------------------------------------------------------------------------------------------|
| `bank_slip_ownership_exchange_batch_key`      | uuidv4 | Unique identification key of the ownership exchange batch.                                                                                                                                                                                                                        | 36                                                                                                                  |
| `request_control_key`                         | uuidv4 | Unique identification key of the request in this endpoint. Used to avoid duplicity in API calls.                                                                                                                                                            | 36                                                                                                                  |
| `bank_slip_ownership_exchange_batch_status`   | enum  | Status of the ownership exchange batch.                                                                                                                                                                                                                                               | [Enumerators `bank_slip_ownership_exchange_batch_status`](#enumerators-bank_slip_ownership_exchange_batch_status) |
| `new_requester_profile_key`                   | uuidv4 | Unique identification key of the destination billing portfolio. This is the billing portfolio where the bank slips will be transferred to. You can obtain this key through the [billing portfolio query endpoint for an account](../boletos/carteira/listar_carteiras) | 36                                                                                                                  |
| `new_requester_profile_code`                  | string | Code of the destination billing portfolio. This is the billing portfolio where the bank slips will be transferred to.                                                                                                                                                                    | 19                                                                                                                  |
| `new_requester_profile_owner_name`            | string | Name of the destination account holder and beneficiary of the destination billing portfolio.                                                                                                                                                                                   | 255                                                                                                                 |
| `new_requester_profile_owner_document_number` | string | Document number (CPF/CNPJ) of the destination account holder and beneficiary of the destination billing portfolio.                                                                                                                                                         | 255                                                                                                                 |
| `new_requester_profile_account_number`        | string | Destination account number for the ownership exchange.                                                                                                                                                                                                                                   | 7                                                                                                                   |
| `new_requester_profile_account_digit`         | string | Check digit of the destination account for the ownership exchange.                                                                                                                                                                                                                       | 1                                                                                                                   |
| `new_requester_profile_account_branch`        | string | Branch number of the destination account for the ownership exchange.                                                                                                                                                                                                                        | 4                                                                                                                   |
| `new_pix_key`                                 | string | PIX key of the destination account for the ownership exchange (for bolepix cases).                                                                                                                                                                                                     | 255                                                                                                                 |
| `total_bank_slip_count`                       | float | Total number of bank slips in the ownership exchange batch.                                                                                                                                                                                                                                     | -                                                                                                                   |
| `total_amount`                                | float | Sum of the face value of the bank slips in the ownership exchange batch. | -                                                                                                                   |                                                                                                                                                                                                               

### Enumerators bank_slip_ownership_exchange_batch_status
| Enumerator | Description                                                                                              |
|------------|--------------------------------------------------------------------------------------------------------|
| open       | The batch was created and is still open for inclusion/exclusion of bank slips.                               |
| closed     | The batch is closed and the ownership exchange of the bank slips contained in the batch has been completed.                  |
| processing | The selection of bank slips has been completed and the ownership exchange of the bank slips contained in the batch is being processed. |
| pending_approval | The selection of bank slips has been completed and the ownership exchange batch is pending approval. The approving party can remove bank slips from the batch. |
| canceled   | Ownership exchange batch canceled. |
| rejected | Ownership exchange batch rejected. |