# 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:
- Criar carteira (/documentation/boletos/carteira/criar_carteira)
- Editar carteira (/documentation/boletos/carteira/editar_carteira)
- Listar carteiras da conta (/documentation/boletos/carteira/listar_carteiras)
- Consultar arquivo temporário (/documentation/boletos/cnab/consulta_por_chave)
- Arquivos remessa (CNAB) - Introdução (/documentation/boletos/cnab/introducao)
- Listar arquivos remessa temporários (/documentation/boletos/cnab/listar_arquivos_temporarios)
- Listar ocorrências temporárias (/documentation/boletos/cnab/listar_ocorrencias_temporarias)
- Upload de arquivo remessa (CNAB) (/documentation/boletos/cnab/upload_de_arquivo_remessa)
- Consulta de boleto por chave (/documentation/boletos/consulta/consulta_por_chave)
- Listar boletos (/documentation/boletos/consulta/listar_boletos)
- Relatório de posição diária em Excel (/documentation/boletos/consultar_v1/posicao_diaria_excel)
- Relatório de posição diária em JSON (/documentation/boletos/consultar_v1/posicao_diaria_json)
- Solicitar 2ª via de boleto (/documentation/boletos/consultar_v1/segunda_via_de_boleto)
- Emissão de boleto único (instantânea) (/documentation/boletos/emissao/emissao_boleto_unico_instantanea)
- Emissão de boleto único (padrão) (/documentation/boletos/emissao/emissao_boleto_unico_padrao)
- Emissão de boletos em lote (/documentation/boletos/emissao/emissao_em_lote)
- Cancelamento de abatimento (/documentation/boletos/instrucoes/abatimento/cancelar_abatimento)
- Criar abatimento (/documentation/boletos/instrucoes/abatimento/criar_abatimento)
- Baixa (/documentation/boletos/instrucoes/baixa)
- Desconto (/documentation/boletos/instrucoes/desconto)
- Edição (/documentation/boletos/instrucoes/edicao)
- Prorrogação (/documentation/boletos/instrucoes/extensao)
- Juros (/documentation/boletos/instrucoes/juros)
- Consultar lote de instruções (/documentation/boletos/instrucoes/lote/consultar_lote_de_instrucoes)
- Criar lote de instruções (/documentation/boletos/instrucoes/lote/criar_lote_de_instrucoes)
- Listar lotes de instruções (/documentation/boletos/instrucoes/lote/listar_lotes_de_instrucoes)
- Multa (/documentation/boletos/instrucoes/multa)
- Pagamento Parcial (/documentation/boletos/instrucoes/pagamento_parcial)
- Consulta de instrumento de protesto (/documentation/boletos/instrucoes/protesto/consulta_instrumento_de_protesto)
- Consulta de protesto por chave (/documentation/boletos/instrucoes/protesto/consulta_por_chave)
- Desistência (sustação) de protesto (/documentation/boletos/instrucoes/protesto/desistencia_de_protesto)
- Desistência (sustação) de protesto e baixa do boleto (/documentation/boletos/instrucoes/protesto/desistencia_de_protesto_e_baixa_do_boleto)
- Introdução (/documentation/boletos/instrucoes/protesto/introducao)
- Listar protestos (/documentation/boletos/instrucoes/protesto/listar_protestos)
- Pedido de protesto (/documentation/boletos/instrucoes/protesto/pedido_de_protesto)
- Sustação de protesto (/documentation/boletos/instrucoes/protesto/sustacao_de_protesto)
- Atualização de Rateio de Crédito (/documentation/boletos/instrucoes/rateio_de_credito)
- Valor (/documentation/boletos/instrucoes/valor)
- Introdução (/documentation/boletos/introducao)
- Listar grupos de liquidação (/documentation/boletos/liquidacao/listar_grupos_de_liquidacao)
- Listar liquidações (/documentation/boletos/liquidacao/listar_liquidacoes)
- Simulação de cenários (/documentation/boletos/liquidacao/simulacao_de_cenarios_de_liquidacao)
- Listar arquivos retorno (/documentation/boletos/retorno/listar_arquivos_retorno)
- Webhooks de boletos (/documentation/boletos/webhooks/boleto)
- Webhooks de carteiras de boletos (/documentation/boletos/webhooks/carteira)
- Webhooks de liquidação (/documentation/boletos/webhooks/liquidacao)
- Webhooks de arquivos retorno (/documentation/boletos/webhooks/retorno)
- Abrir lote de tombamento de boletos (/documentation/troca_de_titularidade/abrir_lote)
- Aprovar lote de tombamento de boletos (/documentation/troca_de_titularidade/aprovar_lote)
- Cancelar lote de tombamento de boletos (/documentation/troca_de_titularidade/cancelar_lote)
- Incluir boletos em um lote de tombamento (/documentation/troca_de_titularidade/incluir_boletos)
- Introdução (/documentation/troca_de_titularidade/introducao)
- Listar boletos de um lote de tombamento (/documentation/troca_de_titularidade/listar_boletos_lote)
- Listar lotes de tombamento de boletos - destino (/documentation/troca_de_titularidade/listar_lotes_destino)
- Listar lotes de tombamento de boletos - origem (/documentation/troca_de_titularidade/listar_lotes_origem)
- Remover boletos em um lote de tombamento (/documentation/troca_de_titularidade/remover_boletos)
- Enviar lote de tombamento de boletos (/documentation/troca_de_titularidade/validar_lote_e_enviar)
---
# Criar carteira
URL: /documentation/boletos/carteira/criar_carteira
:::danger Importante
Para registrar bolePix, é necessário que exista uma chave Pix aleatória ativa na conta em que os boletos serão registrados.
:::
As carteiras de boleto possuem um código de identificação único (`requester_profile_code`) e configurações padrão específicas de pagamento, baixa, protesto etc. do boleto. Uma mesma conta pode ter várias carteiras de boleto, o que permite ao usuário criar várias carteiras com configurações padrão diferente. Tal dinâmica facilita a geração de boletos, com diferentes configurações, de maneira mais ágil e automática.
:::info Informação
Para todas as contas, é criada uma carteira de boletos com as configurações padrão do cliente. Esse padrão de configurações pode ser alterado entrando em contato com nosso suporte (suporte.baas@qitech.com.br). Após a criação da conta, é possível alterar também as tarifas da conta utilizando o [**endpoint de configuração de tarifas**](/documentation/contas/consulta_de_tarifas).
:::
:::caution Atenção!
A criação de carteiras de boletos é um fluxo assíncrono. Após a aprovação/rejeição da criação da carteira pela CIP/Nuclea, o solicitante será notificado via [**webhook**](/documentation/boletos/v2/webhooks/carteira) sobre o resultado de tal solicitação.
:::
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profile
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 |
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
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|------------|
| `request_control_key` * | uuidv4 | Chave única de identificação da request utilizada pelo cliente no formato uuid v4 | 36 |
| `configuration_data` * | object | Configurações padrão da carteira | **[Objeto configuration_data](#objeto-configuration_data)** |
### Objeto configuration_data
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|------------|
| `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) | - |
| `write_off_settings` | object | Configuração padrão de baixa | **[Objeto write_off_settings](#objeto-write_off_settings)** |
| `protest_settings` | object | Configuração padrão de protesto | **[Objeto protest_settings](#objeto-protest_settings)** |
| `bankruptcy_protest_settings` | object | Configuração padrão de protesto falimentar | **[Objeto bankruptcy_protest_settings](#objeto-bankruptcy_protest_settings)** |
| `fine_settings` | object | Configuração padrão de multa | **[Objeto fine_setings](#objeto-fine_settings)** |
| `interest_settings` | object | Configuração padrão de juros | **[Objeto interest_settings](#objeto-interest_settings)** |
| `qr_code_settings` | object | Configuração padrão de QR Code PIX (para bolePix) | **[Objeto qr_code_settings](#objeto-qr_code_settings)** |
| `cnab_settings` | object | Configuração padrão de arquivos CNAB | **[Objeto cnab_settings](#objeto-cnab_settings)** |
### Objeto write_off_settings
| Campo | Tipo | Descrição | Caracteres |
|---------------------------|---------|-----------------------------------------------------------------------------|------------|
| `days_to_write_off` * | integer | Dias, após o vencimento, para que o boleto seja baixado automaticamente | - |
### Objeto protest_settings
| Campo | Tipo | Descrição | Caracteres |
|---------------------------|---------|-----------------------------------------------------------------------------|------------|
| `days_to_protest` * | integer | Dias, após o vencimento, para que o boleto seja protestado automaticamente | - |
### Objeto bankruptcy_protest_settings
| Campo | Tipo | Descrição | Caracteres |
|--------------------------------|---------|-----------------------------------------------------------------------------|-------------|
| `days_to_bankruptcy_protest` * | integer | Dias, após o vencimento, para que seja iniciado um processo de protesto falimentar automaticamente | - |
### Objeto fine_settings
Opção 1: multa em valor absoluto (`fine_type=absolute`)
| 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_settings
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 qr_code_settings
| Campo | Tipo | Descrição | Caracteres |
|----------------------------------|---------|-----------------------------------------------------------------------------|-------------|
| `pix_key` * | uuidv4 | Chave Pix do tipo aleatória | 36 |
| `qr_code_on_discharge_enabled` * | boolean | Determina se as informações do QR Code constarão no arquivo retorno (CNAB) | - |
:::info Informação
O PIX copia e cola será retornado no arquivo CNAB na posição 029 a 105.
:::
:::caution Atenção!
Caso o objeto `qr_code_settings` seja enviado na request, essa carteira terá como configuração padrão a geração de bolePix. BolePix são boletos cujo pagamento é vinculado a um QR Code Pix. Sendo assim, o pagador pode realizar o pagamento dos boletos tanto utilizando as linhas digitáveis dos mesmos, quanto através da leitura dos QR Codes Pix vinculados. Caso o pagamento seja feito via QR Code, a liquidação financeira se dá instantaneamente. Já em relação às notificações, são enviados dois webhooks: um no ato da transferência PIX (aviso de pagamento, boleto vai para o status `payment_notice`); e outro alguns segundos ou minutos depois, após a confirmação da baixa na CIP/Nuclea (pago, boleto vai para o status `paid`).
:::
### Objeto cnab_settings
| Campo | Tipo | Descrição | Caracteres |
|----------------------------------|---------|-----------------------------------------------------------------------------|-------------|
| `default_bank` | string | Layout do banco padrão para processamento de arquivos CNAB | **[Enumeradores default_bank](#enumeradores-default_bank)** |
| `preferred_layout` | string | Layout preferido para arquivos CNAB | **[Enumeradores preferred_layout](#enumeradores-preferred_layout)** |
### Enumeradores default_bank
| Enumerador | Descrição |
|--------------------|-----------------------|
| santander | Banco Santander |
| itau | Banco Itaú |
| bradesco | Banco Bradesco |
| qi_scd | QI SCD |
### Enumeradores preferred_layout
| Enumerador | Descrição |
|--------------------|-----------------------|
| 400 | Layout CNAB 400 |
| 240 | Layout CNAB 240 |
## 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
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------------------|
| `requester_profile_key` * | uuidv4 | Chave única de identificação da carteira no formato uuid v4 | 36 |
| `requester_profile_code` * | string | Código único de identificação da carteira | 19 |
| `request_control_key` * | uuidv4 | Chave única de identificação da request utilizada pelo cliente no formato uuid v4 | 36 |
| `account_key` * | uuidv4 | Chave única de identificação da conta no formato uuid v4 | 36 |
| `requester_profile_status` * | string | Status da carteira | **[Enumeradores requester_profile_status](#enumeradores-requester_profile_status)** |
| `configuration_data` * | object | Configurações padrão da carteira | **[Objeto configuration_data](#objeto-configuration_data)** |
### Enumeradores profile_status
| Enumerador | Descrição |
|----------------------------------|----------------------------------------------------------------------|
| pending | Carteira aceita e pendente de confirmação |
## 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-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. |
---
# Editar carteira
URL: /documentation/boletos/carteira/editar_carteira
A edição de carteira sobrepõe as configurações padrão (`configuration_data`) da carteira de boletos e todos os seus objetos filhos.
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY
MÉTODO PUT
### 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
{
"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
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|------------|
| `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) | - |
| `write_off_settings` | object | Configuração padrão de baixa | **[Objeto write_off_settings](#objeto-write_off_settings)** |
| `protest_settings` | object | Configuração padrão de protesto | **[Objeto protest_settings](#objeto-protest_settings)** |
| `bankruptcy_protest_settings` | object | Configuração padrão de protesto falimentar | **[Objeto bankruptcy_protest_settings](#objeto-bankruptcy_protest_settings)** |
| `fine_settings` | object | Configuração padrão de multa | **[Objeto fine_setings](#objeto-fine_settings)** |
| `interest_settings` | object | Configuração padrão de juros | **[Objeto interest_settings](#objeto-interest_settings)** |
| `qr_code_settings` | object | Configuração padrão de QR Code PIX (para bolePix) | **[Objeto qr_code_settings](#objeto-qr_code_settings)** |
| `cnab_settings` | object | Configuração padrão de arquivos CNAB | **[Objeto cnab_settings](#objeto-cnab_settings)** |
### Objeto write_off_settings
| Campo | Tipo | Descrição | Caracteres |
|---------------------------|---------|-----------------------------------------------------------------------------|------------|
| `days_to_write_off` * | integer | Dias, após o vencimento, para que o boleto seja baixado automaticamente | - |
### Objeto protest_settings
| Campo | Tipo | Descrição | Caracteres |
|---------------------------|---------|-----------------------------------------------------------------------------|------------|
| `days_to_protest` * | integer | Dias, após o vencimento, para que o boleto seja protestado automaticamente | - |
### Objeto bankruptcy_protest_settings
| Campo | Tipo | Descrição | Caracteres |
|--------------------------------|---------|-----------------------------------------------------------------------------|-------------|
| `days_to_bankruptcy_protest` * | integer | Dias, após o vencimento, para que seja iniciado um processo de protesto falimentar automaticamente | - |
### Objeto fine_settings
Opção 1: multa em valor absoluto (`fine_type=absolute`)
| 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_settings
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 qr_code_settings
| Campo | Tipo | Descrição | Caracteres |
|----------------------------------|---------|-----------------------------------------------------------------------------|-------------|
| `pix_key` * | uuidv4 | Chave Pix do tipo aleatória | 36 |
| `qr_code_on_discharge_enabled` * | boolean | Determina se as informações do QR Code constarão no arquivo retorno (CNAB) | - |
:::info Informação
O PIX copia e cola será retornado no arquivo CNAB na posição 029 a 105.
:::
:::caution Atenção!
Caso o objeto `qr_code_settings` seja enviado na request, essa carteira terá como configuração padrão a geração de bolePix. BolePix são boletos cujo pagamento é vinculado a um QR Code Pix. Sendo assim, o pagador pode realizar o pagamento dos boletos tanto utilizando as linhas digitáveis dos mesmos, quanto através da leitura dos QR Codes Pix vinculados. Caso o pagamento seja feito via QR Code, a liquidação financeira se dá instantaneamente. Já em relação às notificações, são enviados dois webhooks: um no ato da transferência PIX (aviso de pagamento, boleto vai para o status `payment_notice`); e outro alguns segundos ou minutos depois, após a confirmação da baixa na CIP/Nuclea (pago, boleto vai para o status `paid`).
:::
### Objeto cnab_settings
| Campo | Tipo | Descrição | Caracteres |
|----------------------------------|---------|-----------------------------------------------------------------------------|-------------|
| `default_bank` | string | Layout do banco padrão para processamento de arquivos CNAB | **[Enumeradores default_bank](#enumeradores-default_bank)** |
| `preferred_layout` | string | Layout preferido para arquivos CNAB | **[Enumeradores preferred_layout](#enumeradores-preferred_layout)** |
### Enumeradores default_bank
| Enumerador | Descrição |
|--------------------|-----------------------|
| santander | Banco Santander |
| itau | Banco Itaú |
| bradesco | Banco Bradesco |
| qi_scd | QI SCD |
### Enumeradores preferred_layout
| Enumerador | Descrição |
|--------------------|-----------------------|
| 400 | Layout CNAB 400 |
| 240 | Layout CNAB 240 |
## 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
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------------------|
| `requester_profile_key` * | uuidv4 | Chave única de identificação da carteira no formato uuid v4 | 36 |
| `requester_profile_code` * | string | Código único de identificação da carteira | 19 |
| `request_control_key` * | uuidv4 | Chave única de identificação da request utilizada pelo cliente no formato uuid v4 | 36 |
| `account_key` * | uuidv4 | Chave única de identificação da conta no formato uuid v4 | 36 |
| `requester_profile_status` * | string | Status da carteira | **[Enumeradores requester_profile_status](#enumeradores-requester_profile_status)** |
| `configuration_data` * | object | Configurações padrão da carteira | **[Objeto configuration_data](#objeto-configuration_data)** |
### Enumeradores profile_status
| Enumerador | Descrição |
|----------------------------------|----------------------------------------------------------------------|
| pending | Carteira aceita e pendente de confirmação |
| opened | Carteira aberta |
## 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-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. |
---
# Listar carteiras da conta
URL: /documentation/boletos/carteira/listar_carteiras
A listagem de carteiras retornará todas as carteiras de boletos da conta que se enquadrarem nos query parameters enviados na request.
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profiles
MÉTODO GET
### Path parameters
| Campo | Tipo | Descrição | Caracteres |
|-------------------------|--------|--------------------------------------------------------------|------------|
| `account_key` | uuidv4 | Chave única de identificação da conta, no formato uuid v4 | 36 |
### Query parameters
| Campo | Tipo | Descrição | Caracteres |
|--------------------------|--------|---------------------------------------------------------------------------|------------|
| `request_control_key` | uuidv4 | Chave única de identificação da request, no formato uuid v4 | 36 |
| `requester_profile_key` | uuidv4 | Chave única de identificação da carteira de boletos, no formato uuid v4 | 36 |
| `requester_profile_code` | string | Código único de identificação da carteira | 19 |
| `page` | integer| Número da página | - |
| `page_size` | integer| Tamanho da página | - |
## 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
| Campo | Tipo | Descrição | Caracteres |
|----------------|--------------|-----------------------------------|-----------------------------------------------------------|
| `data` * | object array | Carteiras de boletos | **[Objeto requester_profile](#objeto-requester_profile)** |
| `pagination` * | object | Informações de paginação | **[Objeto pagination](#objeto-pagination)** |
### Objeto requester_profile
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------------------|
| `requester_profile_key` * | uuidv4 | Chave única de identificação da carteira no formato uuid v4 | 36 |
| `requester_profile_code` * | string | Código único de identificação da carteira | 19 |
| `request_control_key` * | uuidv4 | Chave única de identificação da request utilizada pelo cliente no formato uuid v4 | 36 |
| `account_key` * | uuidv4 | Chave única de identificação da conta no formato uuid v4 | 36 |
| `requester_profile_status` * | string | Status da carteira | **[Enumeradores requester_profile_status](#enumeradores-requester_profile_status)** |
| `configuration_data` * | object | Configurações padrão da carteira | **[Objeto configuration_data](#objeto-configuration_data)** |
### Enumeradores requester_profile_status
| Enumerador | Descrição |
|----------------------------------|----------------------------------------------------------------------|
| pending | Carteira aceita e pendente de confirmação |
| opened | Carteira aberta |
### Objeto pagination
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|--------------------------------------------------------------|------------|
| `current_page` * | integer | Página atual | - |
| `rows_per_page` * | integer | Itens por página | - |
### Objeto configuration_data
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|------------|
| `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) | - |
| `write_off_settings` | object | Configuração padrão de baixa | **[Objeto write_off_settings](#objeto-write_off_settings)** |
| `protest_settings` | object | Configuração padrão de protesto | **[Objeto protest_settings](#objeto-protest_settings)** |
| `bankruptcy_protest_settings` | object | Configuração padrão de protesto falimentar | **[Objeto bankruptcy_protest_settings](#objeto-bankruptcy_protest_settings)** |
| `fine_settings` | object | Configuração padrão de multa | **[Objeto fine_setings](#objeto-fine_settings)** |
| `interest_settings` | object | Configuração padrão de juros | **[Objeto interest_settings](#objeto-interest_settings)** |
| `qr_code_settings` | object | Configuração padrão de QR Code PIX (para bolePix) | **[Objeto qr_code_settings](#objeto-qr_code_settings)** |
| `cnab_settings` | object | Configuração padrão de arquivos CNAB | **[Objeto cnab_settings](#objeto-cnab_settings)** |
### Objeto write_off_settings
| Campo | Tipo | Descrição | Caracteres |
|---------------------------|---------|-----------------------------------------------------------------------------|------------|
| `days_to_write_off` * | integer | Dias, após o vencimento, para que o boleto seja baixado automaticamente | - |
### Objeto protest_settings
| Campo | Tipo | Descrição | Caracteres |
|---------------------------|---------|-----------------------------------------------------------------------------|------------|
| `days_to_protest` * | integer | Dias, após o vencimento, para que o boleto seja protestado automaticamente | - |
### Objeto bankruptcy_protest_settings
| Campo | Tipo | Descrição | Caracteres |
|--------------------------------|---------|-----------------------------------------------------------------------------|-------------|
| `days_to_bankruptcy_protest` * | integer | Dias, após o vencimento, para que seja iniciado um processo de protesto falimentar automaticamente | - |
### Objeto fine_settings
Opção 1: multa em valor absoluto (`fine_type=absolute`)
| 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_settings
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 qr_code_settings
| Campo | Tipo | Descrição | Caracteres |
|----------------------------------|---------|-----------------------------------------------------------------------------|-------------|
| `pix_key` * | uuidv4 | Chave Pix do tipo aleatória | 36 |
| `qr_code_on_discharge_enabled` * | boolean | Determina se as informações do QR Code constarão no arquivo retorno (CNAB) | - |
### Objeto cnab_settings
| Campo | Tipo | Descrição | Caracteres |
|----------------------------------|---------|-----------------------------------------------------------------------------|-------------|
| `default_bank` | string | Layout do banco padrão para processamento de arquivos CNAB | **[Enumeradores default_bank](#enumeradores-default_bank)** |
| `preferred_layout` | string | Layout preferido para arquivos CNAB | **[Enumeradores preferred_layout](#enumeradores-preferred_layout)** |
### Enumeradores default_bank
| Enumerador | Descrição |
|--------------------|-----------------------|
| santander | Banco Santander |
| itau | Banco Itaú |
| bradesco | Banco Bradesco |
| qi_scd | QI SCD |
### Enumeradores preferred_layout
| Enumerador | Descrição |
|--------------------|-----------------------|
| 400 | Layout CNAB 400 |
| 240 | Layout CNAB 240 |
## 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (ptbr)
`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. |
---
# Consultar arquivo temporário
URL: /documentation/boletos/cnab/consulta_por_chave
A consulta de um arquivo CNAB temporário, utilizando sua chave, retorna informações detalhadas sobre o mesmo, como, por exemplo, a quantidade de ocorrências que já foram processadas e possíveis erros encontrados no arquivo.
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /temporary_cnab_file/ TEMPORARY_CNAB_FILE_KEY
MÉTODO GET
### 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 |
| `temporary_cnab_file_key` | uuidv4 | Chave única de identificação do arquivo CNAB temporário, no formato uuid v4 | 36 |
## Response
STATUS 200
Response Body: Arquivo aceito (sem erros)
```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: Arquivo rejeitado (com erros)
```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
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `temporary_cnab_file_key` *| uuidv4 | Chave única de identificação do arquivo CNAB temporário no formato uuid v4 | 36 |
| `temporary_cnab_file_name` *| uuidv4 | Nome do arquivo | 100 |
| `temporary_cnab_file_status` *| string | Status do arquivo CNAB temporário | **[Enumeradores temporary_cnab_file_status](#enumeradores-temporary_cnab_file_status)** |
| `occurrence_quantity` * | integer | Quantidade de ocorrências no arquivo | - |
| `total_processed_occurrences` *| integer | Quantidade de ocorrências já processadas | - |
| `error_data` | object array | Objetos, em JSON, dos erros encontrados no arquivo, no mesmo padrão retornado pelas APIs | **[Objeto error_data](#objeto-error_data)** |
| `created_at` * | string | Timestamp do horário de criação do arquivo na base de dados, no formato ISO Zulu | 20 |
### Enumeradores temporary_cnab_file_status
| Enumerador | Descrição |
|------------------------------|------------------------------------------------------------------------------|
| uploaded | upload feito com sucesso, mas arquivo ainda não começou a ser processado |
| processing | arquivo sendo lido |
| read | arquivo lido e aceito |
| rejected | arquivo lido e rejeitado por erro sintático |
### Objeto error_data
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `code` * | string | Código do erro | 9 |
| `title` * | string | Título do erro | 100 |
| `description` * | string | Descrição do erro, em inglês | 100 |
| `translation` * | integer | Tradução da descrição do erro | 100 |
| `extra_fields` | object | Informações adicionais sobre o erro | - |
:::danger Importante
Os campos retornados no objeto `extra_fields` servem para fornecer informações adicionais sobre o erro e podem variar. Portanto, não devem ser mapeados de maneira restrita.
:::
## 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (ptbr)
`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}` |
---
# Arquivos remessa (CNAB) - Introdução
URL: /documentation/boletos/cnab/introducao
:::info
O arquivo transmitido nesta chamada deve seguir o padrão de Layout de Arquivo de Cobrança com 400 posições da QI Tech.
Segue link para download do 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)
:::
Os arquivos remessa (CNAB) oferecem a possibilidade de enviar várias instruções de registros de boleto, juntamente com outros tipos de instrução (extensão, abatimento, baixa etc.), para diferentes boletos, em um único arquivo. Ao enviar instruções como as mencionadas (extensão, abatimento etc.), para boletos já existentes, o boleto é identificado pelo código da carteira (`requester_profile_code`) e pelo nosso número (`our_number`).
Ao fazer o upload de um arquivo CNAB, caso a requisição tenha sucesso (código de resposta `202`), será criado um arquivo CNAB temporário (`TemporaryCNABFile`). É possível consultar o status de processamento do arquivo --- bem como possíveis erros, tanto no próprio arquivo quanto em suas ocorrências ---, utilizando os endpoints de [**consulta de arquivo CNAB temporário**](/documentation/boletos/cnab/consulta_por_chave) e [**suas ocorrências**](/documentation/boletos/cnab/listar_ocorrencias_temporarias).
O arquivo será rejeitado caso seja encontrado qualquer erro sintático. No entanto, ele é lido integralmente, ou até que sejam encontrados um limite de 100 erros, para que todos os erros possam ser retornados e corrigidos de maneira mais prática e eficiente.
Enquanto o arquivo é lido, são criadas ocorrências temporárias , que só serão processadas caso ele seja aceito. Ou seja, se o arquivo for rejeitado (status `rejected`), todas as suas ocorrências também serão . Ademais, se o arquivo for rejeitado, não são mais criadas ocorrências temporárias para o mesmo. Portanto, é comum que as entradas de arquivos rejeitados possuam menos ocorrências do que a quantidade de ocorrências enviada no arquivo.
Por outro lado, no momento em que o arquivo é totalmente lido e aceito (status `read`), inicia-se a criação das ocorrências definitivas, que serão as instruções que valerão de fato. Se uma ocorrência temporária apresenta o status `rejected` (rejeitada), significa que foi encontrado algum erro semântico na mesma --- ou seja, algum erro no seu conteúdo. Nesse caso, haverá um objeto `error_data` junto a mesma, que fornece detalhes acerca do motivo de rejeição. Em contrapartida, se apresentar o status `processed`, significa que a ocorrência definitiva já foi criada e enviada para a CIP/Nuclea. Maiores detalhes a respeito de cada uma dessas entidades são fornecidos nas páginas subsequentes, de consulta de arquivos e ocorrências temporárias.
:::tip Rateio de Crédito via CNAB
Para informar [**rateio de crédito**](/documentation/boletos/instrucoes/rateio_de_credito) (split de pagamento) em arquivos CNAB:
- **QI SCD (CNAB400 - layout QI Tech v2.1):** registro de detalhe com `identificacao_registro = 3`. Detalhes completos no **[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 e CNAB240):** registro de detalhe tipo `3`.
- **Itaú (CNAB400 e CNAB240):** registro de detalhe tipo `4`.
- **Santander:** não suporta rateio de crédito via CNAB. Use o endpoint REST [**Atualização de Rateio de Crédito**](/documentation/boletos/instrucoes/rateio_de_credito) ou inclua `split_payment_data` na emissão via API.
**Como mapear N rateados:** Cada registro de rateio comporta até **3 contas adicionais** (número da conta + dígito + percentual). Para mais de 3 rateados, adicione **múltiplos registros de rateio em sequência** após o registro principal do boleto — eles são acumulados na mesma ocorrência. Exemplo: 7 contas = 3 registros (3 + 3 + 1).
**Restrições (todos os bancos):**
- Apenas o cálculo por **percentual** é suportado (`código de cálculo = 2`).
- A soma dos percentuais (beneficiário + rateios) deve ser exatamente **100**.
- Limite total de rateados respeita o mesmo da API REST (até 10 contas adicionais).
- O campo `beneficiary_max_amount` (rateio com valor máximo do beneficiário e excedente para a primeira regra) é **exclusivo da API REST**. Não é suportado via CNAB. Para esse cenário, use o endpoint REST de [**emissão**](/documentation/boletos/emissao/emissao_boleto_unico_padrao) ou de [**atualização de rateio de crédito**](/documentation/boletos/instrucoes/rateio_de_credito).
:::
---
# Listar arquivos remessa temporários
URL: /documentation/boletos/cnab/listar_arquivos_temporarios
A listagem de arquivos CNAB temporários retornará todos os arquivos CNAB temporários da carteira que se enquadrarem nos query parameters enviados na request.
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /temporary_cnab_file
MÉTODO GET
### 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 |
### Query parameters
| Campo | Tipo | Descrição | Caracteres |
|-------------------------|--------|--------------------------------------------------------------|-------------------------|
| `temporary_cnab_file_status` | string | Status do arquivo CNAB temporário | **[Enumeradores temporary_cnab_file_status](#enumeradores-temporary_cnab_file_status)** |
| `page` | integer| Número da página | - |
| `page_size` | integer| Tamanho da página | - |
### Enumeradores temporary_cnab_file_status
| Enumerador | Descrição |
|------------------------------|------------------------------------------------------------------------------|
| uploaded | upload feito com sucesso, mas arquivo ainda não começou a ser processado |
| processing | arquivo sendo lido |
| read | arquivo lido e aceito |
| rejected | arquivo lido e rejeitado por erro sintático |
## 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
| Campo | Tipo | Descrição | Caracteres |
|------------------|--------------|---------------------------------------|---------------------------------------------|
| `data` * | object array | Arquivos CNAB temporários | **[Objeto temporary_cnab_file](#objeto-temporary_cnab_file)** |
| `pagination` * | object | Informações de paginação | **[Objeto pagination](#objeto-pagination)** |
### Objeto temporary_cnab_file
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `temporary_cnab_file_key` *| uuidv4 | Chave única de identificação do arquivo CNAB temporário no formato uuid v4 | 36 |
| `temporary_cnab_file_name` *| uuidv4 | Nome do arquivo | 100 |
| `temporary_cnab_file_status` *| string | Status do arquivo CNAB temporário | **[Enumeradores temporary_cnab_file_status](#enumeradores-temporary_cnab_file_status)** |
| `occurrence_quantity` * | integer | Quantidade de ocorrências no arquivo | - |
| `created_at` * | string | Timestamp do horário de criação do arquivo na base de dados, no formato ISO Zulu | 20 |
### Objeto pagination
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------------------|
| `current_page` * | integer | Página atual | - |
| `rows_per_page` * | integer | Itens por página | - |
## 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-br)
`translation` |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 403 | BKS000005 | Forbidden | User is not allowed to do this action | Usuário não tem autorização para fazer essa ação |
| 404 | BKS000006 | Not Found | The source account key was not found. | A chave da conta de origem não foi encontrada. |
| 400 | BKS000007 | Bad Request | It was not possible to consult the source account at this time. Please try again in a few minutes. | Não foi possível consultar a conta de origem neste momento. Por favor, tente novamente em alguns minutos. |
| 400 | BKS000008 | Bad Request | The source account is closed. | A conta de origem está fechada. |
| 400 | BKS000009 | Bad Request | The source account is blocked. | A conta de origem está bloqueada. |
| 400 | BKS000012 | Bad Request | Invalid integer value for page or size query string parameters. | Valor inválido para parâmetros de página ou tamanho de página. |
| 404 | BKS000013 | Not Found | Requester profile not found | Carteira não encontrada |
---
# Listar ocorrências temporárias
URL: /documentation/boletos/cnab/listar_ocorrencias_temporarias
A listagem de ocorrências temporárias retornará todas as ocorrências temporárias de um dado arquivo CNAB.
:::info
Quando no momento em que um arquivo CNAB é rejeitado por erro sintático, não são mais criadas ocorrências temporárias referentes ao mesmo, visto que todas seriam rejeitadas porque o arquivo foi rejeitado. Portanto, quando o arquivo é rejeitado, é possível que o número de ocorrências temporárias relacionadas ao arquivo seja menor que o número de ocorrências enviadas no mesmo.
:::
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /temporary_cnab_file / TEMPORARY_CNAB_FILE_KEY /occurrences
MÉTODO GET
### 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 |
### Query parameters
| Campo | Tipo | Descrição | Caracteres |
|-------------------------|--------|--------------------------------------------------------------|-------------------------|
| `occurrence_status` | string | Status da ocorrência temporária | **[Enumeradores occurrence_status](#enumeradores-temporary_cnab_file_status)** |
| `occurrence_type` | string | Tipo da ocorrência temporária | **[Enumeradores occurrence_type](#enumeradores-temporary_cnab_file_type)** |
| `page` | integer| Número da página | - |
| `page_size` | integer| Tamanho da página | - |
### Enumeradores occurrence_status
| Enumerador | Descrição |
|------------------------------|------------------------------------------------------------------------------|
| pending | ocorrência ainda não foi processada |
| processed | ocorrência processada com sucesso |
| rejected | ocorrência processada e rejeitada por erro semântico |
### Enumeradores occurrence_type
| Enumerador | Descrição |
|--------------------------------------|------------------------------------------------------------------------------|
| registration | registro de boleto |
| write_off | baixa de boleto |
| rebate | abatimento de valor do boleto |
| cancel_rebate | cancelamento de abatimento |
| extension | prorrogação da data de pagamento |
| protest_request | pedido de protesto |
| bankruptcy_protest_request | pedido de protesto falimentar |
| protest_cancel_and_write_off_request | cancelamento de pedido de protesto e baixa do boleto |
| protest_cancel_request | cancelamento de pedido de protesto |
| bank_slip_edit | edição de demais dados do boleto |
## 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
| Campo | Tipo | Descrição | Caracteres |
|------------------|--------------|---------------------------------------|---------------------------------------------|
| `data` * | object array | Ocorrências temporárias | **[Objeto temporary_occurrence](#objeto-temporary_occurrence)** |
| `pagination` * | object | Informações de paginação | **[Objeto pagination](#objeto-pagination)** |
### Objeto temporary_cnab_file
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `occurrence_key` *| uuidv4 | Chave única de identificação da ocorrência temporária no formato uuid v4 | 36 |
| `occurrence_status` * | string | Status da ocorrência temporária | **[Enumeradores temporary_occurrence_status](#enumeradores-temporary_occurrence_status)** |
| `occurrence_type` * | string | Tipo da ocorrência temporária | **[Enumeradores occurrence_type](#enumeradores-occurrence_type)** |
| `occurrence_our_number` * | integer | Quantidade de ocorrências no arquivo | - |
| `error_data` | object | Objetos, em JSON, dos erros encontrados no arquivo, no mesmo padrão retornado pelas APIs | **[Objeto error_data](#objeto-error_data)** |
### Objeto pagination
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------------------|
| `current_page` * | integer | Página atual | - |
| `rows_per_page` * | integer | Itens por página | - |
### Objeto error_data
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `code` * | string | Código do erro | 9 |
| `title` * | string | Título do erro | 100 |
| `description` * | string | Descrição do erro, em inglês | 100 |
| `translation` * | integer | Tradução da descrição do erro | 100 |
| `extra_fields` | object | Informações adicionais sobre o erro | - |
:::danger Importante
Os campos retornados no objeto `extra_fields` servem para fornecer informações adicionais sobre o erro e podem variar. Portanto, não devem ser mapeados de maneira restrita.
:::
## 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-br)
`translation` |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 403 | BKS000005 | Forbidden | User is not allowed to do this action | Usuário não tem autorização para fazer essa ação |
| 404 | BKS000006 | Not Found | The source account key was not found. | A chave da conta de origem não foi encontrada. |
| 400 | BKS000007 | Bad Request | It was not possible to consult the source account at this time. Please try again in a few minutes. | Não foi possível consultar a conta de origem neste momento. Por favor, tente novamente em alguns minutos. |
| 400 | BKS000008 | Bad Request | The source account is closed. | A conta de origem está fechada. |
| 400 | BKS000009 | Bad Request | The source account is blocked. | A conta de origem está bloqueada. |
| 400 | BKS000012 | Bad Request | Invalid integer value for page or size query string parameters. | Valor inválido para parâmetros de página ou tamanho de página. |
| 404 | BKS000013 | Not Found | Requester profile not found | Carteira não encontrada |
| 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 de arquivo remessa (CNAB)
URL: /documentation/boletos/cnab/upload_de_arquivo_remessa
:::caution Atenção!
A chamada deve ser autenticada seguindo o padrão descrito na seção de [**Upload de documentos**](/documentation/upload_de_documentos).
:::
Os arquivos remessa (CNAB) oferecem a possibilidade de enviar várias instruções de registros de boleto, juntamente com outros tipos de instrução (extensão, abatimento, baixa etc.), para diferentes boletos, em um único arquivo. Ao enviar instruções como as mencionadas (extensão, abatimento etc.), para boletos já existentes, o boleto é identificado pelo código da carteira (`requester_profile_code`) e pelo nosso número (`our_number`).
:::info
Ao fazer o upload de um arquivo CNAB, caso a requisição tenha sucesso (código de resposta `202`), será criado um arquivo CNAB temporário (`TemporaryCNABFile`). É possível consultar o status de processamento do arquivo --- bem como possíveis erros, tanto no próprio arquivo quanto em suas ocorrências ---, utilizando os endpoints de [**consulta de arquivo CNAB temporário**](/documentation/boletos/cnab/consulta_por_chave) e [**suas ocorrências**](/documentation/boletos/cnab/listar_ocorrencias_temporarias).
:::
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /cnab_file
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 Params
Deverão ser enviados os seguintes dados, como form-data , no body da request:
| Campo | Tipo | Descrição | Caracteres |
|-------------------------|--------|--------------------------------------------------------------|------------|
| `file` * | file | Arquivo CNAB no padrão estipulado pela 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
| Campo | Tipo | Descrição | Caracteres |
|--------------------------------|---------|-----------------------------------------------------------------|----------------------------|
| `temporary_cnab_file_key` * | uuidv4 | Chave única de identificação do arquivo CNAB no formato uuid v4 | 36 |
| `temporary_cnab_file_status` * | string | Status do arquivo CNAB | **[Enumeradores temporary_cnab_file_status](#enumeradores-cnab_file_status)** |
### Enumeradores temporary_cnab_file_status
| Enumerador | Descrição |
|------------|---------------------------------------------------------------------------|
| uploaded | Upload feito com sucesso, mas arquivo ainda não começou a ser processado |
| processing | Arquivo sendo lido |
| read | Arquivo lido e aceito |
| rejected | Arquivo lido e rejeitado (todas as ocorrências do arquivo são rejeitadas) |
## 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (ptbr)
`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: '``' | Arquivo CNAB já recebido: '``' |
---
# Consulta de boleto por chave
URL: /documentation/boletos/consulta/consulta_por_chave
A consulta de um boleto, utilizando sua chave, retorna informações detalhadas sobre o mesmo, como, por exemplo, todas as instruções referentes àquele boleto.
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY
MÉTODO GET
### 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 |
| `bank_slip_key` | uuidv4 | Chave única de identificação do boleto, no formato uuid v4 | 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
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `bank_slip_key ` * | uuidv4 | Chave única de identificação do boleto no formato uuid v4 | 36 |
| `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 | 11 |
| `bank_slip_status` * | string | Status do boleto | **[Enumeradores bank_slip_status](#enumeradores-bank_slip_status)** |
| `protest_status` * | string | Status de protesto, em cartório, do boleto | **[Enumeradores protest_status](#enumeradores-protest_status)** |
| `document_number` * | string | Número de identificação do boleto | 10 |
| `amount` * | float | Valor base do boleto | - |
| `expiration` * | string | Data de vencimento | 10 |
| `barcode` * | string | Código de barras do boleto | 44 |
| `digitable_line` * | string | Linha digitável do boleto | 47 |
| `bank_teller_instructions` | string | Instruções adicionais de registro, que constarão no PDF do boleto | 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) | - |
| `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)** |
| `qr_code_data` | object | Dados do QR Code | **[Objeto qr_code_data](#objeto-qr_code_data)** |
| `payment_notice_data` | object ou array | Dados do aviso de pagamento | **[Objeto ou array payment_notice_data](#objeto-ou-array-payment_notice_data)** |
| `payment_data` | object ou array | Dados do pagamento | **[Objeto ou array payment_data](#objeto-ou-array-payment_data)** |
| `guarantor_data` | object | Dados do sacador avalista | **[Objeto guarantor_data](#objetos-payer_data-e-guarantor_data)** |
| `occurrences` | object array | Instruções referentes ao boleto | **[Objeto bank_slip_occurrence](#objeto-bank_slip_occurrence)** |
:::info Informação
O campo `amount` é o valor base do boleto, ou seja, não considera o valor da multa (fine), juros (interest), abatimento (rebate) e descontos (discounts).
:::
### Enumeradores bank_slip_status
| Enumerador | Descrição |
|------------------------------|--------------------------------------------------------------------------------|
| accepted | Aceito e enviado para a Nuclea/CIP para análise |
| rejected | Registro rejeitado pela Nuclea/CIP |
| payment_notice | Aviso de pagamento (boleto pago mas pagamento ainda não liquidado) |
| notary_office_payment_notice | Aviso de pagamento em cartório (boleto pago mas pagamento ainda não liquidado) |
| registered | Registro confirmado pela Nuclea/CIP |
| payment_blocked | Bloqueado para pagamento (em fluxo de protesto) |
| paid | Pago |
| written_off | Baixado |
### Enumeradores protest_status
| Enumerador | Descrição |
|------------------------------|--------------------------------------------------------------------------------|
| not_protested | Boleto sem fluxo de protesto iniciado |
| protest_requested | Protesto em cartório solicitado |
| notary_office_entry | Boleto no cartório, em período de tríduo |
| protest_cancel_requested | Desistência do protesto solicitada |
| notary_office_exit | Boleto saiu do cartório |
| protested | Boleto protestado |
| paid_at_notary_office | Pago no cartório |
| judicially_suspended | Protesto suspenso judicialmente |
| protest_remove_requested | Remoção do protesto solicitada |
### 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 |
|---------------------------------|--------|----------------------------------------------|------------|
| `international_dial_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 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 | - |
### Objeto ou array payment_notice_data
:::caution Atenção!
O campo `payment_notice_data` será retornado como um **objeto** para boletos sem configuração de pagamento parcial. Para boletos com configuração de pagamento parcial, será retornado como um **array de objetos**, já que pode haver múltiplos pagamentos.
Além disso, caso o boleto seja pago via **QR Code**, esse campo não será retornado, dado que a liquidação ocorre no dia do pagamento.
:::
| Campo | Tipo | Descrição | Caracteres |
|---------------------------|---------|-------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
| `payment_method` | string | Método de pagamento | **[Enumeradores payment_method](#enumeradores-payment_method)** |
| `payment_origin` | string | Origem de pagamento | **[Enumeradores payment_origin](#enumeradores-payment_origin)** |
| `payment_notice_date` | string | Data do aviso do pagamento | 10
### Objeto ou array payment_data
:::caution Atenção!
O campo `payment_data` será retornado como um **objeto** para boletos sem configuração de pagamento parcial. Para boletos com configuração de pagamento parcial, será retornado como um **array de objetos**, já que pode haver múltiplos pagamentos.
:::
| Campo | Tipo | Descrição | Caracteres |
|---------------------------|---------|-------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------|
| `paid_amount` | float | Valor do pagamento | - |
| `paid_rebate_amount` | float | Valor pago de abatimento | - |
| `paid_discount_amount` | float | Valor pago de desconto | - |
| `paid_fine_amount` | float | Valor pago de multa | -
| `paid_interest_amount` | float | Valor pago de juros | -
| `payment_method` | string | Método de pagamento | **[Enumeradores payment_method](#enumeradores-payment_method)** |
| `payment_origin` | string | Origem de pagamento | **[Enumeradores payment_origin](#enumeradores-payment_origin)** |
| `payment_credit_date` | string | Data do crédito do pagamento | 10
| `payment_bank` | object | Banco em que o boleto foi pago. Retornado somente após o pagamento do boleto | **[Objeto payment_bank](#objeto-payment_bank)** |
| `payment_branch` | string | Agência em que o boleto foi pago. Retornado somente após o pagamento do boleto | -
:::info Informação
Os campos `payment_bank` e `payment_branch` só são retornados quando o boleto já foi pago, ou seja, quando existe uma ocorrência de pagamento confirmada. Enquanto o boleto não for pago, esses campos não estarão presentes na resposta.
:::
### Objeto payment_bank
| Campo | Tipo | Descrição | Caracteres |
|--------|---------|--------------------------------------------|------------|
| `code` | string | Código de compensação do banco (3 dígitos) | 3 |
| `ispb` | integer | ISPB do banco | 8 |
| `name` | string | Nome do banco | - |
### Enumeradores payment_method
| Enumerador | Descrição |
|--------------------|-----------------------------------------|
| cash | Espécie |
| account_debit | Débito em conta |
| credit_card | Cartão de crédito |
| check | Cheque |
### Enumeradores payment_origin
| Enumerador | Descrição |
|--------------------|-----------------------------------------|
| cash | Espécie |
| account_debit | Débito em conta |
| credit_card | Cartão de crédito |
| check | Cheque |
### Enumeradores payment_origin
| Enumerador | Descrição |
|----------------------|------------------------------------------|
| phisical_cashier | Agências - Postos tradicionais |
| taa | Terminal de Auto-atendimento |
| internet | Internet (home/office bank) |
| corban | Correspondente bancário |
| call_center | Central de atendimento (call center) |
| eletronic_file | Arquivo eletrônico |
| dda | DDA |
| digital_correspondent| Correspondente Digital |
| qr_code | Pagamento via Pix QR Code |
### Objeto bank_slip_occurrence
| Campo | Tipo | Descrição | Caracteres |
|-------------------------|--------|-----------------------------------------------------------------------------------|------------|
| `request_control_key` * | uuidv4 | Chave única de identificação da request utilizada pelo cliente no formato uuid v4 | 36 |
| `occurrence_key` * | uuidv4 | Chave única de identificação do boleto no formato uuid v4 | 36 |
| `occurrence_type` * | string | Tipo da ocorrência | **[Enumerador occurrence_type](#enumeradores-occurrence_type)** |
| `occurrence_status` * | string | Status da ocorrência | **[Enumerador occurrence_status](#enumeradores-occurrence_status)** |
| `created_at` * | string | Data, no formato ISO (UTC - "YYYY-MM-DDTHH:MM:SSZ"), da criação da ocorrência | 20 |
### Enumeradores occurrence_type
| Enumerador | Descrição |
|--------------------|-----------------------------------------|
| registration | Ocorrência de registro |
| write_off | Ocorrência de pedido de baixa |
| rebate | Ocorrência de adição de abatimento |
| cancel_rebate | Ocorrência de cancelamento de abatimento|
| discount | Ocorrência de alteração de descontos |
| fine | Ocorrência de alteração de multa |
| interest | Ocorrência de alteração de juros |
| extension | Ocorrência de extensão |
| bank_slip_edit | Ocorrência de alteração de outros dados do boleto |
| payment_notice | Ocorrência de aviso de pagamento |
| payment | Ocorrência de liquidação do pagamento |
| protest_request | Ocorrência de pedido de protesto |
| protest_request | Ocorrência de pedido de protesto falimentar |
### Enumeradores occurrence_status
| Enumerador | Descrição |
|--------------------|-----------------------------------------|
| pending | Enviada para a Nuclea/CIP para análise |
| rejected | Rejeitada |
| confirmed | Confirmada |
## 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (ptbr)
`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}`). |
---
# Listar boletos
URL: /documentation/boletos/consulta/listar_boletos
A listagem de boletos retornará todos os boletos da carteira que se enquadrarem nos query parameters enviados na request.
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slips
MÉTODO GET
### 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 |
### Query parameters
| Campo | Tipo | Descrição | Caracteres |
|-------------------------|--------|--------------------------------------------------------------|-------------------------|
| `request_control_key` | uuidv4 | Chave única de identificação da request, 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)** |
| `page` | integer| Número da página | - |
| `page_size` | integer| Tamanho da página | - |
| `from_date` | string | Data de registro inicial (formato "AAAA-MM-DD") | 10 |
| `to_date` | string | Data de registro final (formato "AAAA-MM-DD") | 10 |
### Enumeradores bank_slip_status
| Enumerador | Descrição |
|------------------------------|--------------------------------------------------------------------------------|
| accepted | Aceito e enviado para a Nuclea/CIP para análise |
| rejected | Registro rejeitado pela Nuclea/CIP |
| payment_notice | Aviso de pagamento (boleto pago mas pagamento ainda não liquidado) |
| notary_office_payment_notice | Aviso de pagamento em cartório (boleto pago mas pagamento ainda não liquidado) |
| registered | Registro confirmado pela Nuclea/CIP |
| payment_blocked | Bloqueado para pagamento (em fluxo de protesto) |
| paid | Pago |
| written_off | Baixado |
## 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
| Campo | Tipo | Descrição | Caracteres |
|------------------|--------------|---------------------------------------|---------------------------------------------|
| `data` * | object array | Boletos | **[Objeto bank_slip](#objeto-bank_slip)** |
| `pagination` * | object | Informações de paginação | **[Objeto pagination](#objeto-pagination)** |
### Objeto bank_slip
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `bank_slip_key ` * | uuidv4 | Chave única de identificação do boleto no formato uuid v4 | 36 |
| `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 | 11 |
| `bank_slip_status` * | string | Status do boleto | **[Enumeradores bank_slip_status](#enumeradores-bank_slip_status)** |
| `protest_status` * | string | Status de protesto, em cartório, do boleto | **[Enumeradores protest_status](#enumeradores-protest_status)** |
| `document_number` * | string | Número de identificação do boleto | 10 |
| `amount` * | float | Valor base do boleto | - |
| `expiration` * | string | Data de vencimento | 10 |
| `barcode` * | string | Código de barras do boleto | 44 |
| `digitable_line` * | string | Linha digitável do boleto | 47 |
| `bank_teller_instructions` | string | Instruções adicionais de registro, que constarão no PDF do boleto | 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) | - |
| `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)** |
### Objeto pagination
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------------------|
| `current_page` * | integer | Página atual | - |
| `rows_per_page` * | integer | Itens por página | - |
### Enumeradores protest_status
| Enumerador | Descrição |
|------------------------------|--------------------------------------------------------------------------------|
| not_protested | Boleto sem fluxo de protesto iniciado |
| protest_requested | Protesto em cartório solicitado |
| notary_office_entry | Boleto no cartório, em período de tríduo |
| protest_cancel_requested | Desistência do protesto solicitada |
| notary_office_exit | Boleto saiu do cartório |
| protested | Boleto protestado |
| paid_at_notary_office | Pago no cartório |
| judicially_suspended | Protesto suspenso judicialmente |
| protest_remove_requested | Remoção do protesto solicitada |
### 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 |
|---------------------------------|--------|----------------------------------------------|------------|
| `international_dial_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 |
## 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-br)
`translation` |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 403 | BKS000005 | Forbidden | User is not allowed to do this action | Usuário não tem autorização para fazer essa ação |
| 404 | BKS000006 | Not Found | The source account key was not found. | A chave da conta de origem não foi encontrada. |
| 400 | BKS000007 | Bad Request | It was not possible to consult the source account at this time. Please try again in a few minutes. | Não foi possível consultar a conta de origem neste momento. Por favor, tente novamente em alguns minutos. |
| 400 | BKS000008 | Bad Request | The source account is closed. | A conta de origem está fechada. |
| 400 | BKS000009 | Bad Request | The source account is blocked. | A conta de origem está bloqueada. |
| 400 | BKS000012 | Bad Request | Invalid integer value for page or size query string parameters. | Valor inválido para parâmetros de página ou tamanho de página. |
| 404 | BKS000013 | Not Found | Requester profile not found | Carteira não encontrada |
---
# Relatório de posição diária em Excel
URL: /documentation/boletos/consultar_v1/posicao_diaria_excel
## Request
ENDPOINT /bank_slip/duplicates_balance_excel
MÉTODO GET
:::caution Atenção
O body de resposta desta request será um arquivo excel encodado em base64.
:::
### Query params
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
| `beneficiary_key` | string | Chave de identificação do beneficiário (obrigatória caso não haja um requester_profile_code). | chave uuid |
| `requester_profile_code` | string | Código da carteira (obrigatório caso não haja uma beneficiary_key). | 10 |
| `expiration_date` | date | Data máxima de vencimento (Formato YYYY-MM-DD). | 10 |
| `content_type` | string | Filtra os boletos incluídos no relatório pelo status. Valores aceitos: `paid`, `unpaid`, `expired`, `written_off`. | - |
## 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\"}"
}
```
---
# Relatório de posição diária em JSON
URL: /documentation/boletos/consultar_v1/posicao_diaria_json
## Request
ENDPOINT /bank_slip/duplicates_balance
MÉTODO GET
### Query params
| Campo | Tipo | Descrição | Caracteres |
|---|---|---|---|
| `beneficiary_key` | string | Chave de identificação do beneficiário (obrigatória caso não haja um requester_profile_code). | 10 |
| `requester_profile_code` | string | Código da carteira (obrigatório caso não haja uma beneficiary_key). | 10 |
| `expiration_date` | date | Data máxima de vencimento (Formato 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: /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: /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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-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: /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": "João da Silva",
"account_number": "1234567",
"account_digit": "8"
},
{
"percentage": 10,
"document_number": "10987654321",
"account_owner_name": "Maria Souza",
"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 | Configurações de rateio de crédito do boleto (split de pagamento) | **[Objeto split_payment_data](#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
Permite configurar o **rateio de crédito** (split de pagamento) do boleto, distribuindo o valor liquidado entre o beneficiário do boleto e até 10 contas adicionais. As contas dos rateados precisam estar abertas e cadastradas na QI Tech, e a soma dos percentuais (beneficiário + regras) deve ser exatamente 100.
| Campo | Tipo | Descrição | Caracteres |
|----------------------------------------|--------------|----------------------------------------------------------------------------------------------------|------------|
| `beneficiary_settlement_percentage` * | float | Percentual do valor liquidado destinado ao beneficiário do boleto. Aceita valor de 0 a 100 | - |
| `beneficiary_max_amount` | float | Valor máximo que o beneficiário recebe na liquidação. Quando o valor pago exceder este limite, o excedente é direcionado integralmente para a primeira regra do array `split_payment_rules`. Aceita valor maior que 0 e menor ou igual ao valor do boleto | - |
| `split_payment_rules` * | object array | Lista de regras de rateio. Mínimo 1, máximo 10 regras | **[Objeto split_payment_rule](#objeto-split_payment_rule)** |
#### Objeto split_payment_rule
| Campo | Tipo | Descrição | Caracteres |
|------------------------|---------|------------------------------------------------------------------------------------------|------------|
| `percentage` * | float | Percentual do valor liquidado destinado a esta conta. Aceita valor de 0 a 100. Use `0` quando esta regra for destinada exclusivamente a receber o excedente do `beneficiary_max_amount` | - |
| `document_number` * | string | CPF/CNPJ do titular da conta destino | 11 ou 14 |
| `account_owner_name` * | string | Nome do titular da conta destino | 100 |
| `account_number` * | string | Número da conta destino | 20 |
| `account_digit` * | string | Dígito verificador da conta destino | 2 |
:::caution Atenção!
- A soma de `beneficiary_settlement_percentage` com os percentuais de cada item de `split_payment_rules` deve ser exatamente igual a **100**.
- O `document_number` deve ser único entre as regras e diferente do beneficiário.
- O rateio é aplicado em todos os fluxos de liquidação do boleto (SILOC, STR, cartório e Pix QR Code).
- `beneficiary_max_amount`, quando enviado, deve ser maior que 0 e menor ou igual ao valor do boleto. É obrigatório sempre que alguma regra tiver `percentage = 0`.
- Apenas **uma** regra pode ter `percentage = 0` por boleto (a destinatária do excedente).
- Após a emissão, é possível atualizar o rateio com a [**ocorrência de atualização de rateio de crédito**](/documentation/boletos/instrucoes/rateio_de_credito), desde que o boleto esteja com o status `registered` e ainda não tenha sido pago.
:::
:::tip Caso de uso: receber juros/multa em conta separada
Para que o beneficiário receba sempre o valor de face do boleto e uma conta diferente receba os juros/multa em casos de atraso, configure `beneficiary_settlement_percentage = 100` + `beneficiary_max_amount = ` + uma única regra com `percentage = 0` apontando para a conta destino do excedente. Veja o passo a passo completo em [**Atualização de Rateio de Crédito**](/documentation/boletos/instrucoes/rateio_de_credito#caso-de-uso-receber-juros-e-multa-em-uma-conta-separada).
:::
### 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-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: /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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-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. |
---
# Cancelamento de abatimento
URL: /documentation/boletos/instrucoes/abatimento/cancelar_abatimento
Cancelar um abatimento significa cancelar o abatimento existente para o boleto. O cancelamento deve ser efetuado caso seja de interesse remover o abatimento ou então criar um novo.
:::caution Atenção!
Caso exista algum pedido de cancelamento de abatimento pendente de confirmação, ou não exista abatimento ativo, não é possível solicitar o cancelamento de um abatimento.
Obs.: o valor de abatimento (`rebate_amount`) enviado no registro do boleto conta como um abatimento ativo (caso seja maior que R$0,00).
:::
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /cancel_rebate
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 |
| `bank_slip_key` | uuidv4 | Chave única de identificação do boleto, no formato uuid v4 | 36 |
Request Body
```json
{
"request_control_key": "86864aec-a6c8-462e-8460-b05ef5a1eb62"
}
```
### 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 |
## Response
STATUS 202
Response Body
```json
{
"occurrence_key": "539cefc8-382e-4fef-80e1-978a3a178a5c",
"bank_slip_key": "d402e91a-32ac-4428-8357-d71824b113b5"
}
```
### Response Body Params
| Campo | Tipo | Descrição | Caracteres |
|--------------------|--------|-----------------------------------------------------------------------------------|------------|
| `occurrence_key` * | uuidv4 | Chave única de identificação da ocorrência (instrução) no formato uuid v4 | 36 |
| `bank_slip_key` * | uuidv4 | Chave única de identificação do boleto no formato uuid v4 | 36 |
### 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-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: `` | Chave de controle da requisição já utilizada ou enviada duplicada: `` |
| 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. |
---
# Criar abatimento
URL: /documentation/boletos/instrucoes/abatimento/criar_abatimento
Criar um abatimento para o boleto significa abater parte do valor base do título, para diminuir o valor final.
:::caution Atenção!
Caso exista algum pedido de abatimento pendente de confirmação, ou algum abatimento ativo, não é permitida a criação de um novo abatimento. Se houver algum abatimento ativo e for de interesse mudá-lo, primeiro deve ser enviada uma requisição de cancelamento de abatimento. Assim que a mesma for confirmada, é possível criar outro abatimento.
Obs.: o valor de abatimento (`rebate_amount`) enviado no registro do boleto não conta como um pedido de abatimento em aberto , mas conta como um pedido de abatimento ativo.
:::
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /rebate
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 |
| `bank_slip_key` | uuidv4 | Chave única de identificação do boleto, no formato uuid v4 | 36 |
Request Body
```json
{
"request_control_key": "d66b807a-25fa-4e21-b198-9beb221a29ce",
"rebate_amount": 150.00
}
```
### 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 |
| `rebate_amount` * | float | Valor absoluto do abatimento | - |
## Response
STATUS 202
Response Body
```json
{
"occurrence_key": "7f01165b-fdd0-4f59-b231-42170ea90131",
"bank_slip_key": "dad779c1-5e1c-422e-9f36-c704916a87cf"
}
```
### Response Body Params
| Campo | Tipo | Descrição | Caracteres |
|--------------------|--------|-----------------------------------------------------------------------------------|------------|
| `occurrence_key` * | uuidv4 | Chave única de identificação da ocorrência (instrução) no formato uuid v4 | 36 |
| `bank_slip_key` * | uuidv4 | Chave única de identificação do boleto no formato uuid v4 | 36 |
### 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-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: `` | Chave de controle da requisição já utilizada ou enviada duplicada: `` |
| 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. |
---
# Baixa
URL: /documentation/boletos/instrucoes/baixa
Quando um boleto é baixado, torna-se indisponível para pagamento. Ou seja, o boleto é "cancelado".
:::caution Atenção!
Caso exista algum pedido de baixa pendente de confirmação, não é permitida a criação de um novo pedido.
:::
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /write_off
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 |
| `bank_slip_key` | uuidv4 | Chave única de identificação do boleto, no formato uuid v4 | 36 |
Request Body
```json
{
"request_control_key": "614a451d-3b82-460e-bcc0-2caf3dde711f"
}
```
### 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 |
## Response
STATUS 202
Response Body
```json
{
"occurrence_key": "2552bd64-950b-437e-a53a-a133ffea03d7",
"bank_slip_key": "960f78d4-4426-4762-98da-3ce3713ae0a5"
}
```
### Response Body Params
| Campo | Tipo | Descrição | Caracteres |
|--------------------|--------|-----------------------------------------------------------------------------------|------------|
| `occurrence_key` * | uuidv4 | Chave única de identificação da ocorrência (instrução) no formato uuid v4 | 36 |
| `bank_slip_key` * | uuidv4 | Chave única de identificação do boleto no formato uuid v4 | 36 |
### 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-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: `` | Chave de controle da requisição já utilizada ou enviada duplicada: `` |
| 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. |
---
# Desconto
URL: /documentation/boletos/instrucoes/desconto
A instrução de desconto serve para aplicar descontos com diversas possibilidades de regras de cálculo. Caso já existam descontos para o boleto em questão, e seja aceita uma instrução de desconto, os descontos existentes previamente serão sobrescritos.
:::caution Atenção!
Caso exista algum pedido de acréscimo de desconto pendente de confirmação, não é permitida a criação de um novo pedido.
:::
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /discount
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 |
| `bank_slip_key` | uuidv4 | Chave única de identificação do boleto, no formato uuid v4 | 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
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|------------|
| `request_control_key` * | uuidv4 | Chave única de identificação da request utilizada pelo cliente no formato uuid v4 | 36 |
| `discounts_data` | object array | Descontos | **[Objeto discount](#objeto-discounts_data)** |
### 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 |
## Response
STATUS 202
Response Body
```json
{
"occurrence_key": "aaf64135-6bd8-4d49-be6f-e8f884b20ee7",
"bank_slip_key": "470cfcae-159b-4de4-ad22-2d3b2dd717f7"
}
```
### Response Body Params
| Campo | Tipo | Descrição | Caracteres |
|--------------------|--------|-----------------------------------------------------------------------------------|------------|
| `occurrence_key` * | uuidv4 | Chave única de identificação da ocorrência (instrução) no formato uuid v4 | 36 |
| `bank_slip_key` * | uuidv4 | Chave única de identificação do boleto no formato uuid v4 | 36 |
### 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-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: `` | Chave de controle da requisição já utilizada ou enviada duplicada: `` |
| 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. |
---
# Edição
URL: /documentation/boletos/instrucoes/edicao
A instrução de edição serve para modificar dados configuráveis do boleto após sua emissão, como configurações de baixa automática, protesto, protesto falimentar e dados do pagador. Esta instrução permite atualizar múltiplos aspectos do boleto em uma única requisição.
:::caution Atenção!
O boleto deve estar no status 'registered' para que seja possível editá-lo. Ao menos um dos campos de dados (`write_off_data`, `protest_data`, `bankruptcy_protest_data` ou `payer_data`) deve ser informado junto com o `request_control_key`.
:::
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /bank_slip_edit
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 |
| `bank_slip_key` | uuidv4 | Chave única de identificação do boleto, no formato uuid v4 | 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
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|------------|
| `request_control_key` * | uuidv4 | Chave única de identificação da request utilizada pelo cliente no formato uuid v4 | 36 |
| `write_off_data` | object | Configurações de baixa automática (null para remover) | **[Objeto write_off_data](#objeto-write_off_data)** |
| `protest_data` | object | Configurações de protesto (null para remover) | **[Objeto protest_data](#objeto-protest_data)** |
| `bankruptcy_protest_data` | object | Configurações de protesto falimentar (null para remover) | **[Objeto bankruptcy_protest_data](#objeto-bankruptcy_protest_data)** |
| `payer_data` | object | Dados do pagador (`address` null ou `contact` null para remover) | **[Objeto payer_data](#objeto-payer_data)** |
:::info Observação
Pelo menos um dos campos de dados (`write_off_data`, `protest_data`, `bankruptcy_protest_data` ou `payer_data`) deve ser informado na requisição.
:::
### 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 payer_data
| Campo | Tipo | Descrição | Caracteres|
|---------------------------|--------|-------------------------------------|-----------------------------------------------------------|
| `contact` | object | Informações de contato | **[Objeto contact](#objeto-contact)** |
| `address` | object | Endereço | **[Objeto address](#objeto-address)** |
### 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 |
|---------------------------------|--------|----------------------------------------------|------------|
| `international_dial_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 |
## Response
STATUS 200
Response Body
```json
{
"occurrence_key": "5a745b65-9a2c-44eb-b43e-c80ef5429d94",
"bank_slip_key": "fdafdffa-cbd4-4f3c-8e3d-990428305161"
}
```
### Response Body Params
| Campo | Tipo | Descrição | Caracteres |
|--------------------|--------|-----------------------------------------------------------------------------------|------------|
| `occurrence_key` * | uuidv4 | Chave única de identificação da ocorrência (instrução) no formato uuid v4 | 36 |
| `bank_slip_key` * | uuidv4 | Chave única de identificação do boleto no formato uuid v4 | 36 |
### 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-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: `` | Chave de controle da requisição já utilizada ou enviada duplicada: `` |
| 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'. |
---
# Prorrogação
URL: /documentation/boletos/instrucoes/extensao
O pedido de prorrogação serve para estender a data de vencimento do título.
:::caution Atenção!
Caso exista algum pedido de prorrogação pendente de confirmação, não é permitida a criação de um novo pedido.
:::
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /extension
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 |
| `bank_slip_key` | uuidv4 | Chave única de identificação do boleto, no formato uuid v4 | 36 |
Request Body
```json
{
"request_control_key": "2e2f0053-a988-40c7-ad17-41c4c4da861e",
"new_expiration_date": "2025-01-01"
}
```
### 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 |
| `new_expiration_date` * | string | Nova data de expiração, no formato "YYYY-MM-DD" | 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
| Campo | Tipo | Descrição | Caracteres |
|--------------------|--------|-----------------------------------------------------------------------------------|------------|
| `occurrence_key` * | uuidv4 | Chave única de identificação da ocorrência (instrução) no formato uuid v4 | 36 |
| `bank_slip_key` * | uuidv4 | Chave única de identificação do boleto no formato uuid v4 | 36 |
### 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-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: `` | Chave de controle da requisição já utilizada ou enviada duplicada: `` |
| 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. |
---
# Juros
URL: /documentation/boletos/instrucoes/juros
A instrução de juros serve para configurar os juros que serão aplicados caso o boleto seja pago após a data limite. Caso já exista uma configuração de juros para o boleto em questão, e seja aceita uma instrução de juros, a configuração existente previamente será sobrescrita.
:::caution Atenção!
Caso exista alguma instrução de juros pendente de confirmação, não é permitido o envio de uma nova instrução.
:::
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /interest
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 |
| `bank_slip_key` | uuidv4 | Chave única de identificação do boleto, no formato uuid v4 | 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
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|------------|
| `request_control_key` * | uuidv4 | Chave única de identificação da request utilizada pelo cliente no formato uuid v4 | 36 |
| `interest_data` | object | Configurações de juros | **[Objeto interest_data](#objeto-interest_data)** |
### 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 |
## Response
STATUS 202
Response Body
```json
{
"occurrence_key": "5a745b65-9a2c-44eb-b43e-c80ef5429d94",
"bank_slip_key": "fdafdffa-cbd4-4f3c-8e3d-990428305161"
}
```
### Response Body Params
| Campo | Tipo | Descrição | Caracteres |
|--------------------|--------|-----------------------------------------------------------------------------------|------------|
| `occurrence_key` * | uuidv4 | Chave única de identificação da ocorrência (instrução) no formato uuid v4 | 36 |
| `bank_slip_key` * | uuidv4 | Chave única de identificação do boleto no formato uuid v4 | 36 |
### 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-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: `` | Chave de controle da requisição já utilizada ou enviada duplicada: `` |
| 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. |
---
# Consultar lote de instruções
URL: /documentation/boletos/instrucoes/lote/consultar_lote_de_instrucoes
Retorna o detalhe de um lote previamente criado, com a lista de ocorrências geradas e o status individual de cada uma, junto com os dados básicos do boleto associado.
## Request
ENDPOINT /v2/bank_slip/account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /occurrence_batches/ BATCH_KEY /results
MÉTODO GET
### 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 |
| `batch_key` | uuidv4 | Chave do lote (retornada pelo POST de criação) | 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
| Campo | Tipo | Descrição |
|---------------------------|---------|------------------------------------------------------------------------------------------|
| `batch_key` * | uuidv4 | Chave do lote |
| `requester_profile_key` * | uuidv4 | Chave da carteira dona do lote |
| `occurrence_type` * | string | Tipo de instrução do lote |
| `occurrence_quantity` * | integer | Quantidade total de itens enviados no lote |
| `accepted_quantity` * | integer | Quantidade de itens aceitos no lote |
| `created_at` * | string | Data/hora UTC de criação do lote (ISO 8601 com sufixo `Z`) |
| `items` * | array | Lista de ocorrências geradas pelo lote. Veja **[Objeto item](#objeto-item)** |
### Objeto item
| Campo | Tipo | Descrição |
|------------------------------------------------|---------|----------------------------------------------------------------------------------------|
| `bank_slip_key` * | uuidv4 | Chave do boleto da ocorrência |
| `occurrence_key` * | uuidv4 | Chave única da ocorrência criada |
| `request_control_key` * | string | Chave de controle informada pelo cliente para o item |
| `occurrence_type` * | string | Tipo de instrução |
| `payer_name` | string | Nome do pagador do boleto |
| `payer_document` | string | Documento do pagador |
| `amount` | float | Valor base do boleto |
| `our_number` | string | Nosso número do boleto |
| `requester_occurrence_status` | string | Status da ocorrência do ponto de vista do solicitante (ex.: `accepted`, `rejected`) |
| `registration_institution_occurrence_status` | string | Status do processamento na instituição registradora (ex.: `submitted`, `confirmed`) |
| `created_at` * | string | Data/hora UTC de criação da ocorrência (ISO 8601 com sufixo `Z`) |
### 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-br)
`translation` |
|--------------------------|----------------------|--------------------|----------------------------------------------------------------|------------------------------------------------------------------|
| 404 | BKS000013 | Not Found | Requester profile not found | Carteira não encontrada |
:::caution Atenção!
Quando o `batch_key` não existe ou não pertence à `requester_profile_key` informada, a API retorna o mesmo `BKS000013` ("Carteira não encontrada"). Verifique se o `batch_key` foi criado sob a carteira utilizada na consulta.
:::
---
# Criar lote de instruções
URL: /documentation/boletos/instrucoes/lote/criar_lote_de_instrucoes
Permite o envio, em uma única requisição, de múltiplas instruções de mesmo tipo (baixa, abatimento, prorrogação, protesto etc.) sobre boletos distintos. A QI Tech valida o lote inteiro e, ou todos os itens são aceitos, ou nenhum é processado.
- Se **qualquer** item falhar na validação semântica, **nenhum** item do lote é processado. A resposta de erro detalha, por item rejeitado, o motivo da rejeição.
- Se todos os itens passarem, as ocorrências são criadas e processadas individualmente, de forma assíncrona. O solicitante é notificado via [**webhook**](/documentation/boletos/v2/webhooks/boleto) à medida que cada ocorrência muda de status.
:::info Idempotência
A `request_control_key` do lote garante idempotência no nível do lote: reenviar a mesma chave retorna o lote já criado, sem duplicação.
Cada item do lote também possui sua própria `request_control_key` e é idempotente individualmente. Reenviar um item com `request_control_key` já existente faz o lote inteiro ser rejeitado.
:::
:::caution Atenção!
Esta operação está disponível apenas para carteiras registradas na instituição registradora **QI SCD**.
:::
## Request
ENDPOINT /v2/bank_slip/account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /occurrence_batches
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": "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
| Campo | Tipo | Descrição | Caracteres |
|-------------------------|-----------------------------------------------|------------------------------------------------------------------------------------|------------|
| `request_control_key` * | string | Chave única do lote, definida pelo cliente. Garante idempotência do lote | 1–64 |
| `occurrence_type` * | string | Tipo de instrução aplicada a todos os itens. Veja **[Enumeradores occurrence_type](#enumeradores-occurrence_type)** | - |
| `items` * | Array de **[Objeto item](#objeto-item)** | Lista de instruções (mínimo 1, máximo 10000) | - |
### Enumeradores occurrence_type
| Enumerador | Descrição |
|--------------------------|------------------------------------------------------------|
| `extension` | Prorrogação de vencimento — requer `new_due_date` no item |
| `rebate` | Concessão de abatimento — requer `rebate_amount` no item |
| `cancel_rebate` | Cancelamento de abatimento |
| `write_off` | Baixa do boleto |
| `protest_request` | Pedido de protesto |
| `protest_cancel_request` | Desistência (sustação) do pedido de protesto |
| `protest_remove_request` | Remoção (cancelamento) do protesto |
### Objeto item
| Campo | Tipo | Descrição | Caracteres |
|-------------------------|----------|--------------------------------------------------------------------------------------|------------|
| `bank_slip_key` * | uuidv4 | Chave do boleto sobre o qual a instrução será aplicada | 36 |
| `request_control_key` * | string | Chave única do item, definida pelo cliente. Garante idempotência por item | 1–64 |
| `new_due_date` | string | Nova data de vencimento (`YYYY-MM-DD`). Obrigatório para `occurrence_type=extension` | 10 |
| `rebate_amount` | float | Valor de abatimento. Obrigatório para `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
| Campo | Tipo | Descrição | Caracteres |
|-------------------------|---------|----------------------------------------------------------------------------------------|------------|
| `batch_key` * | uuidv4 | Chave única do lote. Utilize para consultar o detalhe do lote | 36 |
| `occurrence_quantity` * | integer | Quantidade total de itens enviados no lote | - |
| `accepted_quantity` * | integer | Quantidade de itens aceitos no lote | - |
| `semantic_errors` * | array | Lista vazia em caso de sucesso. Em caso de rejeição semântica, ver **[Error Response](#error-response)** | - |
### Error Response
STATUS 4xx
Response Body: Error
```json
{
"title": "titulo",
"description": "description in English",
"translation": "descrição em portugues",
"code": "codigo",
"extra_fields": {}
}
```
Em caso de rejeição semântica (`BLP000112`), o campo `reasons` da resposta detalha cada item rejeitado:
Response Body: Rejeição semântica
```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"
}
]
}
]
}
```
### Campos do objeto `reasons[]`
| Campo | Tipo | Descrição |
|-------------------------|---------|------------------------------------------------------------------------------------|
| `occurrence_sequence` * | string | Posição do item no array `items` da requisição (começando em `"0"`) |
| `bank_slip_key` * | uuidv4 | Chave do boleto do item rejeitado |
| `request_control_key` * | string | Chave de controle informada pelo cliente para o item |
| `errors` * | array | Lista de motivos da rejeição (um item pode ter múltiplos motivos) |
| `errors[].reason_code` * | string | Código do motivo de rejeição (padrão Febraban) |
| `errors[].translation_pt_br` | string | Descrição em português do motivo |
| `errors[].translation_en_us` | string | Descrição em inglês do motivo |
| `errors[].created_at` | string | Data/hora de cadastro do motivo no catálogo |
### Códigos de erro
| Código HTTP
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-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: `` | Chave de controle da requisição já utilizada ou enviada duplicada: `` |
| 422 | BLP000112 | Unprocessable Entity | Rejected Remittance | Remessa Rejeitada |
---
# Listar lotes de instruções
URL: /documentation/boletos/instrucoes/lote/listar_lotes_de_instrucoes
Lista, de forma paginada, os lotes de instruções criados para uma carteira, com filtros opcionais por tipo de instrução e intervalo de datas.
## Request
ENDPOINT /v2/bank_slip/account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /occurrence_batches
MÉTODO GET
### 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 |
### Query Parameters
| Campo | Tipo | Descrição |
|-------------------|---------|----------------------------------------------------------------------------------------------------|
| `page` | integer | Página da consulta (padrão `1`) |
| `page_size` | integer | Quantidade de lotes por página (padrão `20`, máximo `100`) |
| `occurrence_type` | string | Filtra pelo tipo de instrução do lote. Aceita os mesmos enumeradores do POST de criação |
| `from_date` | string | Data inicial, inclusiva, no formato `YYYY-MM-DD`. Filtra sobre o `created_at` do lote |
| `to_date` | string | Data final, inclusiva, no formato `YYYY-MM-DD`. Filtra sobre o `created_at` do lote |
## 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
| Campo | Tipo | Descrição |
|----------------------------------|---------|----------------------------------------------------------------------------|
| `data` * | array | Lista de lotes da página atual |
| `data[].batch_key` * | uuidv4 | Chave do lote |
| `data[].request_control_key` * | string | Chave de controle informada pelo cliente na criação do lote |
| `data[].requester_profile_key` * | uuidv4 | Chave da carteira dona do lote |
| `data[].occurrence_type` * | string | Tipo de instrução do lote |
| `data[].occurrence_quantity` * | integer | Quantidade total de itens enviados no lote |
| `data[].accepted_quantity` * | integer | Quantidade de itens aceitos no lote |
| `data[].created_at` * | string | Data/hora UTC de criação do lote (ISO 8601 com sufixo `Z`) |
| `pagination` * | object | Metadados de paginação |
| `pagination.page` * | integer | Página atual |
| `pagination.page_size` * | integer | Tamanho da página |
| `pagination.total` * | integer | Quantidade total de lotes que atendem aos filtros |
### Error Response
STATUS 4xx
| Código HTTP
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-br)
`translation` |
|--------------------------|----------------------|--------------------|-----------------------------------|-------------------------------------|
| 400 | QIT000001 | Bad Request | Schema Error | Schema Inválido |
| 404 | BKS000013 | Not Found | Requester profile not found | Carteira não encontrada |
---
# Multa
URL: /documentation/boletos/instrucoes/multa
A instrução de multa serve para configurar a multa que será aplicada caso o boleto seja pago após a data limite. Caso já exista uma configuração de multa para o boleto em questão, e seja aceita uma instrução de multa, a configuração existente previamente será sobrescrita.
:::caution Atenção!
Caso exista alguma instrução de multa pendente de confirmação, não é permitido o envio de uma nova instrução.
:::
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /fine
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 |
| `bank_slip_key` | uuidv4 | Chave única de identificação do boleto, no formato uuid v4 | 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
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|------------|
| `request_control_key` * | uuidv4 | Chave única de identificação da request utilizada pelo cliente no formato uuid v4 | 36 |
| `interest_data` | object | Configurações de multa | **[Objeto fine_data](#objeto-fine_data)** |
### 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 |
## Response
STATUS 202
Response Body
```json
{
"occurrence_key": "aaf64135-6bd8-4d49-be6f-e8f884b20ee7",
"bank_slip_key": "470cfcae-159b-4de4-ad22-2d3b2dd717f7"
}
```
### Response Body Params
| Campo | Tipo | Descrição | Caracteres |
|--------------------|--------|-----------------------------------------------------------------------------------|------------|
| `occurrence_key` * | uuidv4 | Chave única de identificação da ocorrência (instrução) no formato uuid v4 | 36 |
| `bank_slip_key` * | uuidv4 | Chave única de identificação do boleto no formato uuid v4 | 36 |
### 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-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: `` | Chave de controle da requisição já utilizada ou enviada duplicada: `` |
| 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. |
---
# Pagamento Parcial
URL: /documentation/boletos/instrucoes/pagamento_parcial
A instrução de pagamento parcial permite editar as configurações de pagamento parcial para um boleto, desde que o boleto já tenha sido registrado com o pagamento parcial ativo. Caso já exista uma configuração de pagamento parcial para o boleto em questão, e seja aceita uma nova instrução, a configuração existente previamente será sobrescrita.
:::caution Atenção!
Caso exista alguma instrução de pagamento parcial pendente de confirmação, não é permitido o envio de uma nova instrução.
:::
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /partial_payment
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 |
| `bank_slip_key` | uuidv4 | Chave única de identificação do boleto, no formato uuid v4 | 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
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|------------|
| `request_control_key` * | uuidv4 | Chave única de identificação da request utilizada pelo cliente no formato uuid v4 | 36 |
| `partial_payment_data` * | object | Configurações de pagamento parcial | **[Objeto partial_payment_data](#objeto-partial_payment_data)** |
### 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 |
## Response
STATUS 202
Response Body
```json
{
"occurrence_key": "5a745b65-9a2c-44eb-b43e-c80ef5429d94",
"bank_slip_key": "fdafdffa-cbd4-4f3c-8e3d-990428305161"
}
```
### Response Body Params
| Campo | Tipo | Descrição | Caracteres |
|--------------------|--------|-----------------------------------------------------------------------------------|------------|
| `occurrence_key` * | uuidv4 | Chave única de identificação da ocorrência (instrução) no formato uuid v4 | 36 |
| `bank_slip_key` * | uuidv4 | Chave única de identificação do boleto no formato uuid v4 | 36 |
### 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-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: `` | Chave de controle da requisição já utilizada ou enviada duplicada: `` |
| 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. |
---
# Consulta de instrumento de protesto
URL: /documentation/boletos/instrucoes/protesto/consulta_instrumento_de_protesto
O instrumento de protesto é um documento oficial emitido pelo cartório de protesto, que comprova a execução do processo de cobrança. Ele é emitido após a lavratura do protesto, caso o devedor não tenha pago a dívida após ser intimado.
:::caution Atenção!
Só é possível consultar o instrumento de protesto do título após o mesmo ser efetivamente protestado (`protest_status` possui o valor `protested`).
:::
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /protest_instrument
MÉTODO GET
### 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 |
| `bank_slip_key` | uuidv4 | Chave única de identificação do boleto, no formato uuid v4 | 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
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `bank_slip_key` * | uuidv4 | Chave única de identificação do boleto no formato uuid v4 | 36 |
| `file_url` * | string | URL do arquivo, em PDF, contendo o documento do instrumento de protesto | - |
## 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (ptbr)
`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. |
---
# Consulta de protesto por chave
URL: /documentation/boletos/instrucoes/protesto/consulta_por_chave
A consulta de um protesto, utilizando sua chave, retorna informações detalhadas a respeito do mesmo.
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /protest/ BANK_SLIP_KEY
MÉTODO GET
### 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 |
| `bank_slip_key` | uuidv4 | Chave única de identificação do boleto, no formato uuid v4 | 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
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `protest_key ` * | uuidv4 | Chave única de identificação do protesto no formato uuid v4 | 36 |
| `request_control_key` * | uuidv4 | Chave única de identificação da request utilizada pelo cliente no formato uuid v4 | 36 |
| `protest_status` * | string | Status do protesto | **[Enumeradores protest_status](#enumeradores-protest_status)** |
| `bank_slip_key` * | uuidv4 | Chave única de identificação do boleto no formato uuid v4 | 36 |
| `requester_profile_code` * | string | Código único de identificação da carteira | 10 |
| `protest_type` * | string | Tipo de protesto | **[Enumeradores protest_type](#enumeradores-protest_type)** |
| `protocol_number` | string | Número do protocolo | 10 |
| `protocol_date` | string | Data do protocolo (formato "AAAA-MM-DD") | 10 |
| `notary_office` | object | Dados do cartório de protesto | **[Objeto notary_office](#objeto-notary_office)** |
### Enumeradores protest_status
| Enumerador | Descrição |
|------------------------------|--------------------------------------------------------------------------------|
| accepted | Aceito, mas ainda não enviado para os cartórios de protesto de títulos |
| submitted | Enviado para o cartório |
| cancellation_requested | Sustação de protesto solicitada |
| cancelled | Envio cancelado, ou protesto sustado |
| rejected | Pedido de protesto rejeitado |
| at_notary_office | No cartório de protesto, em período de tríduo |
| paid_at_notary_office | Título pago em cartório |
| protested | Título protestado e baixado |
| removal_requested | Título já protestado, com cancelamento solicitado |
| removed | Protesto cancelado |
### Enumeradores protest_type
| Enumerador | Descrição |
|------------------------------|--------------------------------------------------------------------------------|
| protest | Protesto comum |
| bankruptcy_protest | Protesto falimentar |
### Objeto notary_office
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `city` * | string | Cidade do cartório de protesto | - |
| `uf` * | string | Estado (UF) do cartório de protesto | 2 |
## 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (ptbr)
`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. |
---
# Desistência (sustação) de protesto
URL: /documentation/boletos/instrucoes/protesto/desistencia_de_protesto
É possível desistir de um pedido de protesto enviando uma instrução de `protest_cancel_request`.
:::caution Atenção!
A ocorrência de `protest_cancel_request`, por si só, não baixa o boleto. Se a saída do cartório for ocasionada por uma ocorrência do tipo `protest_cancel_request`, é criada outra ocorrência de `notary_office_exit`, a qual é enviada para a CIP/Nuclea para desbloquear o boleto para pagamento. Assim que ela é confirmada, o boleto volta a poder ser pago via linha digitável. Caso seja de interesse que o boleto seja baixado após a desistência de protesto, o ideal é enviar uma instrução de [**desistência de protesto e baixa do boleto**](/documentation/boletos/instrucoes/protesto/desistencia_de_protesto_e_baixa_do_boleto).
:::
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /protest_cancel_request
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 |
| `bank_slip_key` | uuidv4 | Chave única de identificação do boleto, no formato uuid v4 | 36 |
Request Body
```json
{
"request_control_key": "614a451d-3b82-460e-bcc0-2caf3dde711f"
}
```
### 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 |
## Response
STATUS 202
Response Body
```json
{
"occurrence_key": "2552bd64-950b-437e-a53a-a133ffea03d7",
"bank_slip_key": "960f78d4-4426-4762-98da-3ce3713ae0a5"
}
```
### Response Body Params
| Campo | Tipo | Descrição | Caracteres |
|--------------------|--------|-----------------------------------------------------------------------------------|------------|
| `occurrence_key` * | uuidv4 | Chave única de identificação da ocorrência (instrução) no formato uuid v4 | 36 |
| `bank_slip_key` * | uuidv4 | Chave única de identificação do boleto no formato uuid v4 | 36 |
### 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-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: `` | Chave de controle da requisição já utilizada ou enviada duplicada: `` |
| 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. |
---
# Desistência (sustação) de protesto e baixa do boleto
URL: /documentation/boletos/instrucoes/protesto/desistencia_de_protesto_e_baixa_do_boleto
Outra forma de desistir de um pedido de protesto é enviando uma instrução de `protest_cancel_and_write_off_request`.
:::caution Atenção!
A instrução de `protest_cancel_and_write_off_request` também baixa o boleto na CIP/Nuclea. Assim que ela é confirmada, é automaticamente criada uma ocorrência de `write_off` e a mesma é enviada para Nuclea.
:::
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /protest_cancel_and_write_off_request
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 |
| `bank_slip_key` | uuidv4 | Chave única de identificação do boleto, no formato uuid v4 | 36 |
Request Body
```json
{
"request_control_key": "614a451d-3b82-460e-bcc0-2caf3dde711f"
}
```
### 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 |
## Response
STATUS 202
Response Body
```json
{
"occurrence_key": "2552bd64-950b-437e-a53a-a133ffea03d7",
"bank_slip_key": "960f78d4-4426-4762-98da-3ce3713ae0a5"
}
```
### Response Body Params
| Campo | Tipo | Descrição | Caracteres |
|--------------------|--------|-----------------------------------------------------------------------------------|------------|
| `occurrence_key` * | uuidv4 | Chave única de identificação da ocorrência (instrução) no formato uuid v4 | 36 |
| `bank_slip_key` * | uuidv4 | Chave única de identificação do boleto no formato uuid v4 | 36 |
### 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-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: `` | Chave de controle da requisição já utilizada ou enviada duplicada: `` |
| 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. |
---
# Introdução
URL: /documentation/boletos/instrucoes/protesto/introducao
## Protesto em cartório
Um pedido de protesto em cartório pode ser feito após a data de vencimento do boleto, e serve para fazer com que o pagador seja intimado a pagar o título em cartório. Caso não o faça, é feito um registro público, em seu nome, da inadimplência, além de ter seu nome incluído em órgãos de proteção ao crédito, como a Serasa.
## Fluxo de protesto
### Pedido de protesto
O fluxo de protesto, para um boleto, é iniciado com um pedido de protesto : uma instrução do tipo `protest_request`. A partir do momento em que o pedido de protesto é aceito pela CIP/Nuclea (a instrução de `protest_request` é confirmada), o boleto passa a ficar bloqueado para pagamento, o que significa que o pagador passa a poder pagá-lo somente junto ao cartório. Além disso, também é criada uma ocorrência de `notary_office_entry`, que diz respeito ao envio do pedido de protesto para o cartório. As remessas de pedidos de protesto são enviados diariamente aos cartórios às 9 horas da manhã, portanto, caso sejam recebidas instruções de pedido de protesto após esse horário, elas são enviadas para os cartórios somente no dia seguinte.
Nos dias subsequentes, o cartório deve confirmar a entrada do título em cartório (a ocorrência de `notary_office_entry` é confirmada) e, com isso, inicia-se o período do tríduo. O tríduo é o prazo de 3 dias úteis para que o pagador pague o boleto no cartório sendo que, caso não o faça, o título será protestado. Se o título for pago em cartório, é criada ocorrência do tipo `notary_office_payment_notice` para o boleto em questão e o mesmo é liquidado no dia seguinte. Nesse último caso, também é gerada automaticamente uma instrução de `payment_write_off`, para que o boleto seja baixado junto à CIP/Nuclea.
Caso o período do tríduo termine e o boleto não seja pago e não haja desistência do protesto, o boleto é protestado. Nesse momento, é gerada uma instrução de `protest_write_off` para baixar o boleto na CIP/Nuclea, e encerra-se o ciclo de vida do título.
### Desistência (sustação) do pedido de protesto
Caso as questões referentes ao título sejam resolvidas diretamente entre o pagador e o sacador avalista, até o boleto ser de fato protestado (isto é, até o último dia do tríduo), é possível enviar uma instrução de `protest_cancel_request`, que desiste do pedido de protesto; ou uma instrução de `protest_cancel_and_write_off_request`, que desiste do pedido de protesto e também baixa o boleto na CIP/Nuclea. Vale ressaltar que a ocorrência de `protest_cancel_request`, por si só, não baixa o boleto. Se a saída do cartório for ocasionada por uma ocorrência do tipo `protest_cancel_request`, é criada outra ocorrência de `notary_office_exit`, a qual é enviada para a CIP/Nuclea para desbloquear o boleto para pagamento. Assim que ela é confirmada, o boleto volta a poder ser pago via linha digitável. Por outro lado, se a saída do cartório for ocasionada por uma ocorrência do tipo `protest_cancel_and_write_off_request`, é criada automaticamente uma ocorrência de `write_off`, a qual baixa o boleto na CIP/Nuclea.
### Remoção (cancelamento) do pedido de protesto
Caso a pendência entre o pagador e sacador avalista seja resolvida após o boleto já ter sido protestado, é possível enviar uma instrução do tipo `protest_remove_request`, a qual remove o registro público de inadimplência e qualquer registro, atrelado a esse boleto, que tenha sujado o nome do pagador. Caso a ocorrência seja confirmada (aceita pelo cartório), o protesto é removido e não é criada mais nenhuma instrução para este boleto, uma vez que ele já está baixado na CIP/Nuclea.
---
# Listar protestos
URL: /documentation/boletos/instrucoes/protesto/listar_protestos
A listagem de protestos retornará todos os protestos em cartório de boletos da carteira que se enquadrarem nos query parameters enviados na request.
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /protests
MÉTODO GET
### 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 |
### Query parameters
| Campo | Tipo | Descrição | Caracteres |
|-------------------------|--------|--------------------------------------------------------------|-------------------------|
| `protest_key` | uuidv4 | Chave única de identificação do protesto, no formato uuid v4 | 36 |
| `request_control_key` | uuidv4 | Chave única de identificação da request, no formato uuid v4 | 36 |
| `protest_status` | string | Status do protesto | **[Enumeradores protest_status](#enumeradores-protest_status)** |
| `bank_slip_key` | uuidv4 | Chave única de identificação do boleto, no formato uuid v4 | 36 |
| `protocol_number` | string | Número do protocolo | 36 |
| `protocol_date` | string | Data do protocolo (formato "AAAA-MM-DD") | 10 |
| `page_size` | integer| Tamanho da página | - |
| `from_date` | string | Data inicial (formato "AAAA-MM-DD") | 10 |
| `to_date` | string | Data final (formato "AAAA-MM-DD") | 10 |
### Enumeradores protest_status
| Enumerador | Descrição |
|------------------------------|--------------------------------------------------------------------------------|
| accepted | Aceito, mas ainda não enviado para os cartórios de protesto de títulos |
| submitted | Enviado para o cartório |
| cancellation_requested | Sustação de protesto solicitada |
| cancelled | Envio cancelado, ou protesto sustado |
| rejected | Pedido de protesto rejeitado |
| at_notary_office | No cartório de protesto, em período de tríduo |
| paid_at_notary_office | Título pago em cartório |
| protested | Título protestado e baixado |
| removal_requested | Título já protestado, com cancelamento solicitado |
| removed | Protesto cancelado |
## 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
| Campo | Tipo | Descrição | Caracteres |
|------------------|--------------|---------------------------------------|---------------------------------------------|
| `data` * | object array | Protestos | **[Objeto protest](#objeto-protest)** |
| `pagination` * | object | Informações de paginação | **[Objeto pagination](#objeto-pagination)** |
### Objeto protest
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `protest_key ` * | uuidv4 | Chave única de identificação do protesto no formato uuid v4 | 36 |
| `request_control_key` * | uuidv4 | Chave única de identificação da request utilizada pelo cliente no formato uuid v4 | 36 |
| `protest_status` * | string | Status do protesto | **[Enumeradores protest_status](#enumeradores-protest_status)** |
| `bank_slip_key` * | uuidv4 | Chave única de identificação do boleto no formato uuid v4 | 36 |
| `requester_profile_code` * | string | Código único de identificação da carteira | 10 |
| `protest_type` * | string | Tipo de protesto | **[Enumeradores protest_type](#enumeradores-protest_type)** |
| `protocol_number` | string | Número do protocolo | 10 |
| `protocol_date` | string | Data do protocolo (formato "AAAA-MM-DD") | 10 |
| `notary_office` | object | Dados do cartório de protesto | **[Objeto notary_office](#objeto-notary_office)** |
### Objeto pagination
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------------------|
| `current_page` * | integer | Página atual | - |
| `rows_per_page` * | integer | Itens por página | - |
### Enumeradores protest_type
| Enumerador | Descrição |
|------------------------------|--------------------------------------------------------------------------------|
| protest | Protesto comum |
| bankruptcy_protest | Protesto falimentar |
### Enumeradores protest_status
| Enumerador | Descrição |
|------------------------------|--------------------------------------------------------------------------------|
| accepted | Aceito, mas ainda não enviado para os cartórios de protesto de títulos |
| submitted | Enviado para o cartório |
| cancellation_requested | Sustação de protesto solicitada |
| cancelled | Envio cancelado, ou protesto sustado |
| rejected | Pedido de protesto rejeitado |
| at_notary_office | No cartório de protesto, em período de tríduo |
| paid_at_notary_office | Título pago em cartório |
| protested | Título protestado e baixado |
| removal_requested | Título já protestado, com cancelamento solicitado |
| removed | Protesto cancelado |
### Objeto notary_office
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `city` * | string | Cidade do cartório de protesto | - |
| `uf` * | string | Estado (UF) do cartório de protesto | 2 |
## 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-br)
`translation` |
|--------------------------|----------------------|----------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------|
| 403 | BKS000005 | Forbidden | User is not allowed to do this action | Usuário não tem autorização para fazer essa ação |
| 404 | BKS000006 | Not Found | The source account key was not found. | A chave da conta de origem não foi encontrada. |
| 400 | BKS000007 | Bad Request | It was not possible to consult the source account at this time. Please try again in a few minutes. | Não foi possível consultar a conta de origem neste momento. Por favor, tente novamente em alguns minutos. |
| 400 | BKS000008 | Bad Request | The source account is closed. | A conta de origem está fechada. |
| 400 | BKS000009 | Bad Request | The source account is blocked. | A conta de origem está bloqueada. |
| 400 | BKS000012 | Bad Request | Invalid integer value for page or size query string parameters. | Valor inválido para parâmetros de página ou tamanho de página. |
| 404 | BKS000013 | Not Found | Requester profile not found | Carteira não encontrada |
---
# Pedido de protesto
URL: /documentation/boletos/instrucoes/protesto/pedido_de_protesto
Um pedido de protesto em cartório pode ser feito após a data de vencimento do boleto, e serve para fazer com que o pagador seja intimado a pagar o título em cartório. Caso não o faça, é feito um registro público, em seu nome, da inadimplência, além de ter seu nome incluído em órgãos de proteção ao crédito, como a Serasa.
:::caution Atenção!
Para enviar um pedido de protesto, é obrigatório que o endereço do pagador esteja presente no boleto. Caso não esteja, é possível enviar uma instrução de edição do boleto. Ademais, caso exista um boleto esteja em fluxo de protesto, não é permitido o envio de um novo pedido.
:::
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /protest_request
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 |
| `bank_slip_key` | uuidv4 | Chave única de identificação do boleto, no formato uuid v4 | 36 |
Request Body
```json
{
"request_control_key": "614a451d-3b82-460e-bcc0-2caf3dde711f",
"protest_type": "protest"
}
```
### 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 |
| `protest_type` * | string | Tipo de protesto (comum ou falimentar) | **[Enumeradores protest_type](#enumeradores-protest_type)** |
### Enumeradores protest_type
| Enumerador | Descrição |
|---------------------------------------------|--------------------------------------------------------------------------|
| protest | Protesto comum |
| bankruptcy_protest | Protesto falimentar |
## Response
STATUS 202
Response Body
```json
{
"occurrence_key": "2552bd64-950b-437e-a53a-a133ffea03d7",
"bank_slip_key": "960f78d4-4426-4762-98da-3ce3713ae0a5"
}
```
### Response Body Params
| Campo | Tipo | Descrição | Caracteres |
|--------------------|--------|-----------------------------------------------------------------------------------|------------|
| `occurrence_key` * | uuidv4 | Chave única de identificação da ocorrência (instrução) no formato uuid v4 | 36 |
| `bank_slip_key` * | uuidv4 | Chave única de identificação do boleto no formato uuid v4 | 36 |
### 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-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: `` | Chave de controle da requisição já utilizada ou enviada duplicada: `` |
| 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: `` | Região de cartório não encontrada para o CEP: `` |
| 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. |
---
# Sustação de protesto
URL: /documentation/boletos/instrucoes/protesto/sustacao_de_protesto
Caso a pendência entre o pagador e sacador avalista seja resolvida após o boleto já ter sido protestado, é possível enviar uma instrução do tipo `protest_remove_request`, a qual remove o registro público de inadimplência e qualquer registro, atrelado a esse boleto, que tenha sujado o nome do pagador.
:::caution Atenção!
Caso a ocorrência seja confirmada (aceita pelo cartório), o protesto é removido e não é criada mais nenhuma instrução para este boleto, uma vez que ele já está baixado na CIP/Nuclea.
:::
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /protest_remove_request
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 |
| `bank_slip_key` | uuidv4 | Chave única de identificação do boleto, no formato uuid v4 | 36 |
Request Body
```json
{
"request_control_key": "614a451d-3b82-460e-bcc0-2caf3dde711f"
}
```
### 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 |
## Response
STATUS 202
Response Body
```json
{
"occurrence_key": "2552bd64-950b-437e-a53a-a133ffea03d7",
"bank_slip_key": "960f78d4-4426-4762-98da-3ce3713ae0a5"
}
```
### Response Body Params
| Campo | Tipo | Descrição | Caracteres |
|--------------------|--------|-----------------------------------------------------------------------------------|------------|
| `occurrence_key` * | uuidv4 | Chave única de identificação da ocorrência (instrução) no formato uuid v4 | 36 |
| `bank_slip_key` * | uuidv4 | Chave única de identificação do boleto no formato uuid v4 | 36 |
### 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-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: `` | Chave de controle da requisição já utilizada ou enviada duplicada: `` |
| 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. |
---
# Atualização de Rateio de Crédito
URL: /documentation/boletos/instrucoes/rateio_de_credito
Este endpoint permite atualizar o **rateio de crédito** (split de pagamento) de um boleto previamente emitido. As novas regras substituem integralmente as anteriores e passam a valer para a próxima liquidação do boleto.
:::caution Atenção!
- O boleto precisa estar com o status `registered` e ainda não pago.
- A soma de `beneficiary_settlement_percentage` com os percentuais de cada item de `split_payment_rules` deve ser exatamente igual a **100**.
- O envio do payload **substitui** todas as regras de rateio existentes (não é incremental).
- O rateio passa a valer para todos os fluxos de liquidação do boleto (SILOC, STR, cartório e Pix QR Code), inclusive em boletos com QR Code já emitido — neste caso, as regras também serão atualizadas no QR Code automaticamente.
- As contas das regras de rateio precisam estar abertas e cadastradas na QI Tech (a QI Tech consultará pelo `document_number`, `account_number` e `account_digit` informados).
:::
## Request
ENDPOINT /v2/bank_slip/account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /split_payment
MÉTODO PUT
### Path parameters
| Campo | Tipo | Descrição | Caracteres |
|-------------------------|--------|-------------------------------------------------------------------|------------|
| `account_key` | uuidv4 | Chave única de identificação da conta em que o boleto foi emitido | 36 |
| `requester_profile_key` | uuidv4 | Chave única de identificação da carteira | 36 |
| `bank_slip_key` | uuidv4 | Chave única de identificação do boleto | 36 |
Request Body
```json
{
"beneficiary_settlement_percentage": 70,
"split_payment_rules": [
{
"percentage": 20,
"document_number": "12345678901",
"account_owner_name": "João da Silva",
"account_number": "1234567",
"account_digit": "8"
},
{
"percentage": 10,
"document_number": "10987654321",
"account_owner_name": "Maria Souza",
"account_number": "7654321",
"account_digit": "0"
}
]
}
```
### Request Body Params
| Campo | Tipo | Descrição | Caracteres |
|----------------------------------------|--------------|----------------------------------------------------------------------------------------------------|------------|
| `beneficiary_settlement_percentage` * | float | Percentual do valor liquidado destinado ao beneficiário do boleto. Aceita valor de 0 a 100 | - |
| `beneficiary_max_amount` | float | Valor máximo que o beneficiário recebe na liquidação. Quando o valor pago exceder este limite, o excedente é direcionado integralmente para a primeira regra do array `split_payment_rules`. Aceita valor maior que 0 e menor ou igual ao valor do boleto | - |
| `split_payment_rules` * | object array | Lista de regras de rateio. Mínimo 1, máximo 10 regras | **[Objeto split_payment_rule](#objeto-split_payment_rule)** |
### Objeto split_payment_rule
| Campo | Tipo | Descrição | Caracteres |
|------------------------|---------|------------------------------------------------------------------------------------------|------------|
| `percentage` * | float | Percentual do valor liquidado destinado a esta conta. Aceita valor de 0 a 100. Use `0` quando esta regra for destinada exclusivamente a receber o excedente do `beneficiary_max_amount` | - |
| `document_number` * | string | CPF/CNPJ do titular da conta destino | 11 ou 14 |
| `account_owner_name` * | string | Nome do titular da conta destino | 100 |
| `account_number` * | string | Número da conta destino | 20 |
| `account_digit` * | string | Dígito verificador da conta destino | 2 |
## Caso de uso: receber juros e multa em uma conta separada
> **Como configurar para que o juros e multa que excederem o valor de face do boleto sejam direcionados a uma conta diferente do beneficiário?**
Esse cenário é comum em plataformas que emitem boletos em nome de terceiros (escolas, condomínios, marketplaces), onde o titular do boleto deve receber sempre o valor de face e a plataforma fica com a parcela adicional de juros/multa em casos de pagamento em atraso.
A configuração é feita combinando `beneficiary_max_amount` com uma regra de rateio com `percentage = 0`:
```json
{
"beneficiary_settlement_percentage": 100,
"beneficiary_max_amount": 1000.00,
"split_payment_rules": [
{
"percentage": 0,
"document_number": "12345678000199",
"account_owner_name": "Plataforma de Cobrança",
"account_number": "1234567",
"account_digit": "8"
}
]
}
```
**Como o cálculo funciona** considerando um boleto de R$ 1.000,00:
| Cenário | Valor pago | Beneficiário recebe | Plataforma recebe |
|---|---|---|---|
| Pagamento em dia | R$ 1.000,00 | R$ 1.000,00 | R$ 0,00 (sem settlement gerado) |
| Pagamento em atraso (com R$ 100,00 de juros/multa) | R$ 1.100,00 | R$ 1.000,00 | R$ 100,00 |
| Pagamento parcial em atraso | R$ 950,00 | R$ 950,00 | R$ 0,00 |
A regra é: o beneficiário recebe **no máximo** `beneficiary_max_amount`; qualquer valor pago acima disso é direcionado integralmente para a **primeira** regra de `split_payment_rules`.
:::caution Atenção!
- `beneficiary_max_amount` deve ser maior que 0 e menor ou igual ao valor do boleto (`amount`).
- Quando alguma regra tem `percentage = 0`, o campo `beneficiary_max_amount` é obrigatório.
- Apenas **uma** regra de `split_payment_rules` pode ter `percentage = 0` por boleto (a destinatária do excedente).
:::
## Response
STATUS 204
Response Body
```json
{}
```
## 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-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. |
---
# Valor
URL: /documentation/boletos/instrucoes/valor
A instrução de valor permite alterar o valor de um boleto, desde que o boleto já tenha sido registrado. Caso já exista uma instrução de valor pendente de confirmação para o boleto em questão, não é permitido o envio de uma nova instrução.
:::caution Atenção!
Caso exista alguma instrução de valor pendente de confirmação, não é permitido o envio de uma nova instrução.
:::
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip/ BANK_SLIP_KEY /amount
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 |
| `bank_slip_key` | uuidv4 | Chave única de identificação do boleto, no formato uuid v4 | 36 |
Request Body
```json
{
"request_control_key": "01234567-89ab-cdef-0123-456789abcdef",
"amount": 150.50
}
```
### 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 |
| `amount` * | number | Novo valor do boleto (deve ser diferente do valor atual) | - |
:::caution Atenção!
O valor deve ser diferente do valor atual do boleto e deve ter no máximo 2 casas decimais.
:::
## Response
STATUS 202
Response Body
```json
{
"occurrence_key": "5a745b65-9a2c-44eb-b43e-c80ef5429d94",
"bank_slip_key": "fdafdffa-cbd4-4f3c-8e3d-990428305161"
}
```
### Response Body Params
| Campo | Tipo | Descrição | Caracteres |
|--------------------|--------|-----------------------------------------------------------------------------------|------------|
| `occurrence_key` * | uuidv4 | Chave única de identificação da ocorrência (instrução) no formato uuid v4 | 36 |
| `bank_slip_key` * | uuidv4 | Chave única de identificação do boleto no formato uuid v4 | 36 |
### 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-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: `` | Chave de controle da requisição já utilizada ou enviada duplicada: `` |
| 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. |
---
# Introdução
URL: /documentation/boletos/introducao
## Boleto bancário
Um boleto bancário geralmente está relacionado a cobranças. São caracterizados por terem linhas digitáveis que não são iniciadas com dígito 8. Possui registro na Câmara Interbancária de Pagamento (CIP/Núclea) e pode ser pago em instituições financeiras e de pagamento autorizadas a funcionar pelo Banco Central.
## Carteira de cobrança
De antemão, vale ressaltar que, nessa documentação, as carteiras de cobrança são chamadas de `requester_profile`. A carteira de cobrança está necessariamente relacionada a uma conta e carrega configurações padrão específicas (de juros, multa, protesto etc.) no que diz respeito ao registro de boletos. Uma vez atribuídas tais configurações padrão --- na criação ou edição da carteira de cobrança ---, sempre que o usuário registrar um boleto, sem mandar alguma dessas configurações, será utilizada a configuração padrão para o parâmetro em questão.
:::info Exemplo
Ao criar a carteira de cobrança, o usuário enviou uma configuração de multa para a carteira que faz com que, caso o pagador atrase o pagamento em 5 dias ou mais, será cobrado R$10,00 de multa. Ao registrar o boleto, essa configuração pode ser sobrescrita; por exemplo, pode-se optar por cobrar uma multa de R$15,00, ou até mesmo não cobrar multa nenhuma. No entanto, caso tal configuração não seja sobrescrita no momento do registro do boleto, valerá a configuração padrão da carteira (a aplicação dos R$10,00 de multa, caso o pagador atrase mais de 5 dias no pagamento).
:::
É possível criar várias carteiras de cobrança para uma mesma conta, e uma carteira inicial --- sem nenhuma configuração padrão ---, é criada juntamente com a abertura de conta na QI Tech. A possibilidade de se criar várias carteiras de cobrança permite a criação de diferentes carteiras com diferentes configurações padrão; e as configurações padrão, por sua vez, facilitam o registro de vários boletos com configurações em comum, uma vez que configurações de multa, juros etc. não precisam ser enviadas sempre que se deseja registrar um boleto.
## Máquina de estados do boleto
Os boletos, ao longo de seu ciclo de vida, podem passar pelos seguintes status:
| Enumerador | Tradução | Descrição |
|-------------------------------|--------------------------|------------------------------------------------------------------------------|
| accepted | aceito | Boleto aceito e pendente de confirmação junto à CIP/Nuclea |
| rejected | rejeitado | O registro do boleto não foi aceito |
| registered | registrado | Boleto registrado junto à CIP/Nuclea |
| payment_blocked | bloqueado para pagamento | Boleto bloqueado para pagamento na CIP/Nuclea por estar em fluxo de protesto |
| written_off | baixado | Boleto baixado (não está mais disponível para pagamento) |
| payment_notice | pagamento notificado | O boleto pago e baixado, mas ainda sem liquidação financeira |
| paid | pago | Boleto pago, baixado e liquidado financeiramente |
### Transições de estado
- `accepted` -> `rejected`: registro do boleto não foi aceito junto à CIP/Nuclea;
- `accepted` -> `registered`: registro do boleto aceito junto à CIP/Nuclea;
- `registered` -> `written_off`: boleto foi baixado sem ser pago;
- `registered` -> `payment_notice`: boleto foi pago e baixado, mas ainda não foi liquidado financeiramente;
- `payment_notice` -> `paid`: após o pagamento, boleto foi liquidado financeiramente;
- `registered` -> `payment_blocked`: pagamento do boleto foi bloqueado, devido ao início de um fluxo de protesto;
- `payment_blocked` -> `notary_office_payment_notice`: boleto foi pago em cartório e baixado, mas ainda não foi liquidado financeiramente;
- `notary_office_payment_notice` -> `paid`: após o pagamento em cartório, boleto foi liquidado financeiramente;
- `payment_blocked` -> `written_off`: boleto foi protestado.
:::caution Atenção
Para boletos com configurações de pagamento parcial, a transição de status funciona de maneira diferente. Após receber um pagamento, os boletos com configurações de pagamento parcial continuam no status de `registered` caso o pagamento enviado pelo outro banco tenha sido uma baixa parcial interbancária. Você receberá os webhooks de [payment notice](/documentation/boletos/webhooks/boleto) e [payment](/documentation/boletos/webhooks/boleto) normalmente, porém o boleto continua no status de `registered`. O boleto só mudará para o status de `payment_notice` e posteriormente para `paid` caso uma baixa integral interbancária seja enviada pelo banco pagante junto à CIP/Núclea. Caso queira baixar o boleto a qualquer momento ou quando o valor total tenha sido pago, mas nenhuma baixa integral interbancária tenha sido enviada pela outra instituição, você pode enviar uma [ocorrência de baixa](/documentation/boletos/instrucoes/baixa).
Para boletos do tipo **cartão de crédito** (`credit_card`), é importante observar que estes não recebem baixa integral interbancária. Portanto, será sempre de responsabilidade do cliente realizar a baixa manual do boleto, ou o mesmo será baixado automaticamente D+7 após a data máxima de pagamento (conforme configuração de `max_payment_days`).
:::
## Registro de boletos
### Via API
Fluxo de registro padrão
Caso o sistema receba uma requisição de registro de boleto pelo [**fluxo de registro padrão**](/documentation/boletos/emissao/emissao_boleto_unico_padrao), e tal requisição seja aceita --- isto é, caso não haja nenhuma inconsistência com as informações enviadas ---, será devolvido como resposta um boleto com o status `accepted`, mas ainda não é certeza de que o mesmo será de fato registrado. Após o envio do boleto para a CIP/Nuclea e o recebimento da resposta, o boleto passa para o status `rejected` ou para o status `accepted`.
Fluxo de registro em lote
A emissão de boletos em lote é feita de forma assíncrona, onde, se algum boleto falhar na validação, nenhum será registrado. O solicitante é notificado via [**webhook**](/documentation/boletos/v2/webhooks/boleto) quando os boletos mudam de status. Para mais detalhes, consulte a [**documentação completa**](/documentation/boletos/emissao/emissao_em_lote).
Fluxo de registro instantâneo
Há também uma outra opção para o registro de boletos: o [**fluxo de registro instantâneo**](/documentation/boletos/emissao/emissao_boleto_unico_instantanea). Nesse fluxo, o registro do boleto é processado de maneira síncrona e a resposta da API já retorna a informação se o boleto foi aceito ou rejeitado; ou seja, é devolvido como resposta um boleto que já possui status `accepted` ou `rejected`. O tempo de confirmação/rejeição da Nuclea/CIP, a respeito do registro do boleto, está incluso no tempo de resposta desse endpoint.
### Via arquivo de remessa
A solicitação de registro de boletos via arquivo surte exatamente o mesmo resultado final do registro via API. A diferença é que, quando registrando via arquivo, deve-se considerar o tempo de processamento do arquivo no tempo total para registro do boleto. Portanto, geralmente trata-se de um registro mais demorado do que o registro via API.
Em contrapartida, ao registrar via arquivo, é possível registrar um volume muito alto de boletos de uma vez só.
---
# Listar grupos de liquidação
URL: /documentation/boletos/liquidacao/listar_grupos_de_liquidacao
:::info Informação
Em nosso sistema, os grupos de liquidação são uma forma de conciliar as transações com os boletos liquidados. Esse processo (liquidação) descreve a transferência do valor de um boleto pago para a conta que deve receber esse pagamento. Resumidamente, sempre que a QI recebe a informação de que um boleto foi pago por outro banco ou, no caso de boletos protestados, pelo cartório, é criada uma liquidação para esse boleto específico. Posteriormente, são criados os **grupos de liquidação**, que representam lotes de liquidações agrupadas por tipo.
Em um momento posterior, é realizada a transação de pagamento desse grupo de liquidação para a conta do cliente. A **transaction_key** dessa transação é então salva para fins de conciliação, dessa foma você pode ver todos os boletos que foram liquidados em uma determinada transação. Por exemplo, se você tiver cinco boletos de R$ 5,00 cada, sendo que um foi pago via cartório, um foi pago via QR Code PIX e os outros três foram pagos utilizando a linha digitável ou código de barras por outro banco, serão criadas cinco liquidações referentes a esses boletos. Em seguida, essas liquidações serão agrupadas em três grupos de liquidação: um de R$ 15,00 com os três boletos pagos utilizando a linha digitável ou código de barras, para os quais será realizada uma única transação, outro de R$ 5,00 para o boleto pago via QR Code PIX e o último também de R$ 5,00 com o boleto pago via cartório.
:::
A listagem de grupos de liquidação retornará todos os grupos de liquidação da conta que se enquadrarem nos query parameters enviados na request.
## Request
ENDPOINT /account/ ACCOUNT_KEY /bank_slip_settlement_groups
MÉTODO GET
### Path parameters
| Campo | Tipo | Descrição | Caracteres |
|-------------------------|--------|--------------------------------------------------------------|------------|
| `account_key` | uuidv4 | Chave única de identificação da conta | 36 |
### Query parameters
| Campo | Tipo | Descrição | Caracteres |
|-------------------------|--------|--------------------------------------------------------------|-------------------------|
| `bank_slip_settlement_group_key` | uuidv4 | Chave única de identificação do grupo de liquidação | 36 |
| `transaction_key` | uuidv4 | Chave única de identificação da transação do grupo de liquidação | 36 |
| `bank_slip_settlement_group_status` | string | Status do grupo de liquidação | **[Enumeradores bank_slip_settlement_group_status](#enumeradores-bank_slip_settlement_group_status)** |
| `date_from` | string | Data inicial. Formato "YYYY-MM-DD". |
| `date_to` | string | Data final. Formato "YYYY-MM-DD". |
| `page` | integer| Número da página | - |
| `page_size` | integer| Tamanho da página | - |
## 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
| Campo | Tipo | Descrição | Caracteres |
|------------------|--------------|---------------------------------------|---------------------------------------------|
| `data` | object array | Boletos | **[Objeto bank_slip_settlement_group](#objeto-bank_slip_settlement_group)** |
| `pagination` | object | Informações de paginação | **[Objeto pagination](#objeto-pagination)** |
### Objeto bank_slip_settlement_group
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `bank_slip_settlement_group_key ` | uuidv4 | Chave única de identificação do boleto no formato uuid v4 | 36 |
| `account_key` | uuidv4 | Chave única de identificação da conta | 36 |
| `transaction_key` | uuidv4 | Chave única de identificação da transação do grupo de liquidação | 36 |
| `amount` | float | Valor total liquidado | -
| `bank_slip_settlement_group_type` | string | Tipo do grupo de liquidação | **[Enumeradores bank_slip_settlement_group_type](#enumeradores-bank_slip_settlement_group_type)** |
| `bank_slip_settlement_group_status` | string | Status do grupo de liquidação | **[Enumeradores bank_slip_settlement_group_status](#enumeradores-bank_slip_settlement_group_status)** |
| `bank_slip_settlement_quantity` | integer | Quantidade de liquidações do grupo | - |
### Objeto pagination
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------------------|
| `current_page` | integer | Página atual | - |
| `rows_per_page` | integer | Itens por página | - |
### Enumeradores bank_slip_settlement_group_type
| Enumerador | Descrição |
|------------------------------|------------------------------------------------------------------------------|
| siloc | para pagamento de títulos (valor do título menor que R$ 250.000) |
| qr_code | para pagamento de títulos realizados via QR Code |
| str | para pagamento de títulos VR (valor do título maior que R$ 250.000) |
| notary_office | para pagamento de títulos realizados via cartório |
| split_payment | grupo de liquidação destinado a uma conta rateada do [**rateio de crédito**](/documentation/boletos/instrucoes/rateio_de_credito) do boleto |
:::tip Boletos com rateio de crédito
Quando um boleto tem [**rateio de crédito**](/documentation/boletos/instrucoes/rateio_de_credito) configurado, o pagamento gera um grupo de liquidação por destinatário:
- O grupo da conta do **beneficiário do boleto** mantém o tipo original do fluxo de liquidação (`siloc`, `qr_code`, `str` ou `notary_office`).
- Os grupos das **contas rateadas** são criados com o tipo `split_payment`.
Cada conta envolvida (beneficiário e rateadas) consegue listar o seu próprio grupo de liquidação chamando este endpoint com a sua `account_key` — assim, os rateados conseguem conciliar exatamente quanto receberam de cada boleto.
:::
### Enumeradores bank_slip_settlement_group_status
| Enumerador | Descrição |
|------------------------------|------------------------------------------------------------------------------|
| pending | grupo de liquidação criado mas a transação não foi realizada |
| settled | grupo de liquidação criado e transação realizada |
## 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-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. |
---
# Listar liquidações
URL: /documentation/boletos/liquidacao/listar_liquidacoes
:::info Informação
Em nosso sistema, as **liquidações** descrevem a transferência do valor de um boleto pago para a conta que deve receber esse pagamento. Resumidamente, sempre que a QI recebe a informação de que um boleto foi pago por outro banco ou, no caso de boletos protestados, pelo cartório, é criada uma liquidação para esse boleto específico. Posteriormente, são criados os grupos de liquidação aos quais elas sempre estarão atreladas, que representam lotes de liquidações agrupadas por tipo.
Em um momento posterior, é realizada a transação de pagamento desse grupo de liquidação para a conta do cliente. A **transaction_key** dessa transação é então salva para fins de conciliação, dessa foma você pode ver todos os boletos que foram liquidados em uma determinada transação. Por exemplo, se você tiver cinco boletos de R$ 5,00 cada, sendo que um foi pago via cartório, um foi pago via QR Code PIX e os outros três foram pagos utilizando a linha digitável ou código de barras por outro banco, serão criadas cinco liquidações referentes a esses boletos. Em seguida, essas liquidações serão agrupadas em três grupos de liquidação: um de R$ 15,00 com os três boletos pagos utilizando a linha digitável ou código de barras, para os quais será realizada uma única transação, outro de R$ 5,00 para o boleto pago via QR Code PIX e o último também de R$ 5,00 com o boleto pago via cartório.
:::
A listagem de liquidações retornará todas as liquidações do grupo de liquidação enviado na request.
## Request
ENDPOINT /account/ ACCOUNT_KEY /bank_slip_settlement_group/ BANK_SLIP_SETTLEMENT_GROUP_KEY /bank_slip_settlements
MÉTODO GET
### Path parameters
| Campo | Tipo | Descrição | Caracteres |
|-------------------------|--------|--------------------------------------------------------------|------------|
| `account_key` | uuidv4 | Chave única de identificação da conta | 36 |
| `bank_slip_settlement_group_key` | uuidv4 | Chave única de identificação do grupo de liquidação |
## 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
| Campo | Tipo | Descrição | Caracteres |
|------------------|--------------|---------------------------------------|---------------------------------------------|
| `data` | object array | Boletos | **[Objeto bank_slip_settlement](#objeto-bank_slip_settlement_group)** |
| `pagination` | object | Informações de paginação | **[Objeto pagination](#objeto-pagination)** |
### Objeto bank_slip_settlement
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `settlement_key ` | uuidv4 | Chave única de identificação da liquidação | 36 |
| `account_key` | uuidv4 | Chave única de identificação da conta | 36 |
| `amount` | float | Valor liquidado | -
| `bank_slip_key ` | uuidv4 | Chave única de identificação do boleto no formato uuid v4 |
| `barcode` | string | Código de barras do boleto |
### Objeto pagination
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------------------|
| `current_page` | integer | Página atual | - |
| `rows_per_page` | integer | Itens por página | - |
## 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-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. |
---
# Simulação de cenários
URL: /documentation/boletos/liquidacao/simulacao_de_cenarios_de_liquidacao
Esta página descreve como simular a efetivação de ações feitas por agentes externos para testar o fluxo de liquidação de boletos. Essas simulações são úteis para homologação e testes de integração.
:::info Informação
Não há payload de retorno (response body) nessas requisições. Elas simulam ações externas e retornam apenas o status HTTP.
:::
## 1 - Simulação de aviso de pagamento
Simula o aviso de pagamento de um boleto, alterando seu status para `payment_notice`.
ENDPOINT /mock/bank_slip/payment_notice
MÉTODO POST
Request Body
```json
{
"bank_slip_key": "0d00b0e2-af11-472f-11f0-11f3330bae33",
"paid_amount": 12.0,
"payment_method": "cash",
"payment_type": "full_interbank"
}
```
### Objeto Request Body
| Campo | Tipo | Descrição | Máx. Caract. |
|----------------------------------|---------|----------------------------------------------------------------------|--------------|
| **bank_slip_key*** | string | Chave unitária do boleto | 36 |
| **paid_amount** | float | Valor do pagamento. Se não informado, usa o valor original do boleto | - |
| **payment_method** | string | Método de pagamento utilizado | - |
| **payment_type** | string | Tipo de pagamento interbancário | - |
### Enumeradores payment_method
| Enumerador | Descrição |
|-----------------|------------------------------|
| `cash` | Dinheiro |
| `account_debit` | Débito em conta |
| `credit_card` | Cartão de crédito |
| `check` | Cheque |
### Enumeradores payment_type
| Enumerador | Descrição |
|-------------------------|------------------------------|
| `full_interbank` | Pagamento integral interbancário |
| `partial_interbank` | Pagamento parcial interbancário |
:::tip Comportamento
- Se `paid_amount` não for informado, será utilizado o valor original do boleto
- Se `payment_type` não for informado, será considerado como pagamento integral (`full_interbank`)
- A simulação cria uma ocorrência de aviso de pagamento
- O boleto será movido para o status `payment_notice` após a simulação
- **Importante**: Para `partial_interbank`, o status do boleto não é alterado. Esta opção é utilizada para simular casos de boletos de pagamento parcial, conforme explicado na [introdução](/documentation/boletos/introducao)
:::
## 2 - Simulação de liquidação de boleto
Simula o pagamento e liquidação financeira de um boleto, alterando seu status para `paid`.
ENDPOINT /mock/bank_slip/settlement
MÉTODO POST
Request Body
```json
{
"bank_slip_key": "0d00b0e2-af11-472f-11f0-11f3330bae33",
"paid_amount": 12.0,
"payment_method": "cash"
}
```
### Objeto Request Body
| Campo | Tipo | Descrição | Máx. Caract. |
|----------------------------------|---------|----------------------------------------------------------------------|--------------|
| **bank_slip_key*** | string | Chave unitária do boleto | 36 |
| **paid_amount** | float | Valor do pagamento da liquidação. Se não informado, usa o valor original do boleto | - |
| **payment_method** | string | Método de pagamento utilizado | - |
### Enumeradores payment_method
| Enumerador | Descrição |
|-----------------|------------------------------|
| `cash` | Dinheiro |
| `account_debit` | Débito em conta |
| `credit_card` | Cartão de crédito |
| `check` | Cheque |
:::tip Comportamento
- Se `paid_amount` não for informado, será utilizado o valor original do boleto
- A simulação cria uma ocorrência de pagamento com código 65 (pagamento) por padrão
- O boleto será movido para o status `paid` após a simulação
:::
---
# Listar arquivos retorno
URL: /documentation/boletos/retorno/listar_arquivos_retorno
:::info
Os arquivos disponibilizados nas URLs fornecidas na resposta desse endpoint seguem o padrão de Layout de Arquivo de Retorno com 400 posições da QI Tech.
Segue link para download do 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)
:::
Os arquivos retorno servem para conciliação. Nele, cada linha de Registro de Transação (Tipo 1) diz respeito a uma instrução (seja de emissão, prorrogação, abatimento etc.) que foi confirmada ou rejeitada pela CIP/Nuclea no dia anterior.
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /discharge_files
MÉTODO GET
### Path parameters
| Campo | Tipo | Descrição | Caracteres |
|-------------------------|--------|--------------------------------------------------------------|------------|
| `account_key` | uuidv4 | Chave única de identificação da conta | 36 |
| `requester_profile_key` | uuidv4 | Chave única de identificação da carteira, no formato uuid v4 | 36 |
### Query parameters
| Campo | Tipo | Descrição | Caracteres |
|-------------------------|--------|--------------------------------------------------------------|-------------------------|
| `discharge_file_key` | uuidv4 | Chave única de identificação do arquivo retorno, no formato uuid v4 | 36 |
| `page` | integer| Número da página | - |
| `page_size` | integer| Tamanho da página | - |
| `from_date` | string| Data inicial (formato "AAAA-MM-DD") | 10 |
| `to_date` | string| Data final (formato "AAAA-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
| Campo | Tipo | Descrição | Caracteres |
|------------------|--------------|---------------------------------------|---------------------------------------------|
| `data` | object array | Arquivos retorno | **[Objeto discharge_file](#objeto-discharge_file)** |
| `pagination` | object | Informações de paginação | **[Objeto pagination](#objeto-pagination)** |
### Objeto discharge_file
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------|
| `discharge_file_key ` | uuidv4 | Chave única de identificação do arquivo retorno no formato uuid v4 | 36 |
| `discharge_file_name` | string | Nome do arquivo retorno | - |
| `discharge_file_url` | string | URL do arquivo retorno | - |
| `reference_date` | string | Data de referencia do aquivo retorno no formato YYYY-MM-DD | 10 |
### Objeto pagination
| Campo | Tipo | Descrição | Caracteres |
|----------------------------|---------|------------------------------------------------------------------------------------|--------------------------------------------------------------|
| `current_page` | integer | Página atual | - |
| `rows_per_page` | integer | Itens por página | - |
## 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
`status` | Código QI
`code` | Título
`title` | Descrição (eng)
`description` | Descrição (pt-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. |
---
# Webhooks de boletos
URL: /documentation/boletos/webhooks/boleto
:::danger Atenção!
Os webhooks da QI Tech não devem ser mapeadas de forma restrita.
Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs.
:::
:::info Reenvio de Webhooks
Você pode consultar e reenviar webhooks seguindo as instruções detalhadas na documentação: [Reenvio de Webhooks](/documentation/notificacoes/reenvio_de_notificacoes).
:::
## Introdução
Ao longo do ciclo de vida dos boletos, dentro do nosso sistema, serão enviados webhooks com os seguintes status do boleto (`bank_slip_status`):
| Enumerador | Tradução | Descrição |
|-------------------------------|--------------------------------|------------------------------------------------------------------------------------------------|
| registered | registrado | Boleto registrado e disponível para pagamento |
| rejected | rejeitado | Solicitação de emissão de boleto rejeitada por erros de validação |
| payment_notice | aviso de pagamento | Aviso de pagamento do boleto (boleto pago mas pagamento ainda não liquidado) |
| notary_office_payment_notice | aviso de pagamento em cartório | Aviso de pagamento em cartório do boleto (boleto pago mas pagamento ainda não liquidado) |
| paid | pago | Boleto pago e liquidado financeiramente |
| written_off | baixado | Boleto baixado (não pode mais ser pago) e sem liquidação financeira |
| payment_blocked | bloqueado para pagamento | Bloqueado para pagamento devido a fluxo de protesto |
E os webhooks são enviados sempre que são confirmadas ocorrências dos seguintes tipos (`occurrence_type`):
| Enumerador | Tradução | Descrição |
|-------------------------------|--------------------------------|------------------------------------------------------------------------------|
| registration | registro | Registro do boleto |
| rebate | abatimento | Abatimento de parte do valor base do título |
| cancel_rebate | cancelamento de abatimento | Cancelamento de abatimento existente |
| extension | extensão | Extensão da data de expiração do título |
| write_off | baixa | Baixa do boleto |
| protest_write_off | baixa por protesto | Baixa do boleto por protesto em cartório |
| payment_write_off | baixa por pagamento | Baixa do boleto por pagamento |
| discount | desconto | Alteração dos descontos |
| fine | multa | Alteração da multa |
| interest | juros | Alterações dos juros |
| protest_request | pedido de protesto | Pedido de protesto em cartório |
| bankruptcy_protest_request | pedido de protesto falimentar | Pedido de protesto falimentar em cartório |
| notary_office_entry | entrada em cartório | Ocorrência de entrada do título em cartório |
| protest_cancel_request | desistência de pedido de protesto | Desistência do pedido de protesto corrente |
| protest_remove_request | sustação de protesto | Sustação do protesto do título |
| notary_office_exit | saída do cartório | Ocorrência de saída do título do cartório |
| payment_notice | aviso de pagamento | Aviso de pagamento do boleto (boleto pago mas pagamento ainda não liquidado) |
| notary_office_payment_notice | aviso de pagamento em cartório | Aviso de pagamento em cartório do boleto (boleto pago mas pagamento ainda não liquidado) |
| payment | pagamento | Notificação de que o boleto foi pago e baixado |
:::info Informação
O timeout para resposta de nosso webhooks é de 10 segundos.
:::
## Exemplos
----
### Registro
Webhook Body: ocorrência aceita
```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: ocorrência rejeitada
```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"
}
}
```
### Abatimento/cancelamento de abatimento
Webhook Body: abatimento
```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: cancelamento de abatimento
```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"
}
}
```
### Prorrogação
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"
}
}
```
### Desconto
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"
}
}
```
### Juros
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"
}
}
```
### Multa
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"
}
}
```
### Baixa
O campo `occurrence_reason` é opcional e enviado quando o banco informa o motivo da baixa. Ele contém o código e o nome do motivo fornecidos pela instituição financeira.
Webhook Body: sem motivo
```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: com motivo
```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"
}
}
}
```
### Baixa por protesto
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"
}
}
```
### Baixa por pagamento
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"
}
}
```
### Pedido de protesto
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"
}
}
```
### Pedido de protesto falimentar
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"
}
}
```
### Entrada em cartório
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"
}
}
```
### Cancelamento de protesto
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"
}
}
```
### Sustação de protesto
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"
}
}
```
### Saída do cartório
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"
}
}
```
### Aviso de pagamento
Primeiro webhook: boleto foi pago, mas ainda não foi liquidado
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"
}
}
```
### Aviso de pagamento em cartório
Primeiro webhook: boleto foi pago em cartório, mas ainda não foi liquidado
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"
}
}
```
### Pagamento
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 Informação
Os campos `payment_bank` e `payment_branch` indicam o banco e a agência em que o boleto foi pago. Eles só são preenchidos quando essa informação é recebida na liquidação do pagamento; caso o banco pagador não seja identificado, `payment_bank` será retornado como `null`.
:::
### Enumeradores payment_origin
| Enumerador | Descrição |
|--------------------|-----------------------------------------|
| cash | Espécie |
| account_debit | Débito em conta |
| credit_card | Cartão de crédito |
| check | Cheque |
### Enumeradores payment_origin
| Enumerador | Descrição |
|----------------------|------------------------------------------|
| phisical_cashier | Agências - Postos tradicionais |
| taa | Terminal de Auto-atendimento |
| internet | Internet (home/office bank) |
| corban | Correspondente bancário |
| call_center | Central de atendimento (call center) |
| eletronic_file | Arquivo eletrônico |
| dda | DDA |
| digital_correspondent| Correspondente Digital |
| qr_code | Pagamento via Pix QR Code |
---
# Webhooks de carteiras de boletos
URL: /documentation/boletos/webhooks/carteira
:::danger Atenção!
Os webhooks da QI Tech não devem ser mapeadas de forma restrita.
Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs.
:::
:::info Reenvio de Webhooks
Você pode consultar e reenviar webhooks seguindo as instruções detalhadas na documentação: [Reenvio de Webhooks](/documentation/notificacoes/reenvio_de_notificacoes).
:::
## Introdução
Após a criação de uma carteira (`requester_profile`) dentro do nosso sistema, serão enviados webhooks com os seguintes status:
| Enumerador | Tradução | Descrição |
|-------------------------------|------------------------|------------------------------------------------------------|
| opened | aberto | Carteira de boletos aberta e pronta para registrar boletos |
:::info Informação
O timeout para resposta de nosso webhooks é de 10 segundos.
:::
## Exemplos
----
### Confirmação de abertura
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"
}
}
```
---
# Webhooks de liquidação
URL: /documentation/boletos/webhooks/liquidacao
:::danger Atenção!
Os webhooks da QI Tech não devem ser mapeadas de forma restrita.
Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs.
:::
:::info Reenvio de Webhooks
Você pode consultar e reenviar webhooks seguindo as instruções detalhadas na documentação: [Reenvio de Webhooks](/documentation/notificacoes/reenvio_de_notificacoes).
:::
## Introdução
Em nosso sistema, os grupos de liquidação são uma forma de conciliar as transações com os boletos liquidados. Esse processo (liquidação) descreve a transferência do valor de um boleto pago para a conta que deve receber esse pagamento. Resumidamente, sempre que a QI recebe a informação de que um boleto foi pago por outro banco ou, no caso de boletos protestados, pelo cartório, é criada uma liquidação para esse boleto específico. Posteriormente, são criados os **grupos de liquidação**, que representam lotes de liquidações agrupadas por tipo.
Em um momento posterior, é realizada a transação de pagamento desse grupo de liquidação para a conta do cliente. A **transaction_key** dessa transação é então salva para fins de conciliação, dessa foma você pode ver todos os boletos que foram liquidados em uma determinada transação. Por exemplo, se você tiver cinco boletos de R$ 5,00 cada, sendo que um foi pago via cartório, um foi pago via QR Code PIX e os outros três foram pagos utilizando a linha digitável ou código de barras por outro banco, serão criadas cinco liquidações referentes a esses boletos. Em seguida, essas liquidações serão agrupadas em três grupos de liquidação: um de R$ 15,00 com os três boletos pagos utilizando a linha digitável ou código de barras, para os quais será realizada uma única transação, outro de R$ 5,00 para o boleto pago via QR Code PIX e o último também de R$ 5,00 com o boleto pago via cartório.
:::info Informação
O timeout para resposta de nosso webhooks é de 10 segundos.
:::
## Exemplos
----
### Grupo de liquidação
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"
}
}
```
### Enumeradores bank_slip_settlement_group_type
| Enumerador | Descrição |
|------------------------------|------------------------------------------------------------------------------|
| siloc | para pagamento de títulos (valor do título menor que R$ 250.000) |
| qr_code | para pagamento de títulos realizados via QR Code |
| str | para pagamento de títulos VR (valor do título maior que R$ 250.000) |
| notary_office | para pagamento de títulos realizados via cartório |
### Enumeradores bank_slip_settlement_group_status
| Enumerador | Descrição |
|------------------------------|------------------------------------------------------------------------------|
| pending | grupo de liquidação criado mas a transação não foi realizada |
| settled | grupo de liquidação criado e transação realizada |
---
# Webhooks de arquivos retorno
URL: /documentation/boletos/webhooks/retorno
Os arquivos retorno servem para conciliação. Nele, cada linha de Registro de Transação (Tipo 1) diz respeito a uma instrução (seja de emissão, prorrogação, abatimento etc.) que foi confirmada ou rejeitada pela CIP/Nuclea no dia anterior.
:::danger Atenção!
Os webhooks da QI Tech não devem ser mapeadas de forma restrita.
Campos adicionais podem ser incluídos aos payloads dos webhooks retornados em nossas APIs.
:::
:::info Reenvio de Webhooks
Você pode consultar e reenviar webhooks seguindo as instruções detalhadas na documentação: [Reenvio de Webhooks](/documentation/notificacoes/reenvio_de_notificacoes).
:::
:::info Informação
O timeout para resposta de nosso webhooks é de 10 segundos.
:::
## Exemplos
----
### Arquivo retorno
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 Bancos Suportados
Atualmente, o webhook de arquivo retorno suporta os seguintes bancos:
- Bradesco (bradesco)
- Itaú (itau)
- QI SCD (qi_scd)
- Santander (santander)
:::
:::info Layouts Suportados
Atualmente, o webhook de arquivo retorno suporta os seguintes layouts CNAB:
- CNAB 400 (400)
:::
---
# Abrir lote de tombamento de boletos
URL: /documentation/troca_de_titularidade/abrir_lote
Esse endpoint criará um lote de tombamento de boletos.
O lote é criado sem nenhum boleto, e os boletos precisarão ser inseridos através do endpoint de [inclusão de boletos](/incluir_boletos).
## Request
ENDPOINT /account/ ACCOUNT-KEY /requester_profile/ REQUESTER-PROFILE-KEY /bank_slip_ownership_exchange_batch/stream
MÉTODO POST
### Path parameters
| Campo | Tipo | Descrição | Caracteres |
|---------------|--------|------------------------------------------------------------------------------------------------------------------------|------------|
| `ACCOUNT-KEY` | uuidv4 | Chave única de identificação da conta de origem, onde os boletos foram originalmente registrados. | 36 |
| `REQUESTER-PROFILE-KEY` | uuidv4 | Chave única de identificação da carteira de cobrança de origem, onde os boletos foram originalmente registrados. | 36 |
Request Body - Chave UUID da carteira de cobrança
```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 - Código da carteira de cobrança
```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 Código da Carteira de Cobrança de boletos
O Código da Carteira de Cobrança é uma string que segue o seguinte padrão:
[ Número do Banco ] + [ Código da Carteira ] + [ Número da Agência da Conta ] + [ Número da Conta com 7 caracteres e sem dígito verificador ]
Por padrão, na QI Tech, o Número do Banco, o Código da Carteira e a Agência, sempre serão `329`, `09` e `0001`, respectivamente.
Sendo assim, o Código da Carteira de Cobrança da conta 5308318-3, será: `329-09-0001-5308318`.
:::
## Body Params
| Campo | Tipo | Descrição | Caracteres |
|---|------|-----------| --|
|`request_control_key`| uuidv4 | Chave única de identificação da requisição neste endpoint. Utilizada para evitar duplicidade na chamada via API. |36|
|`new_requester_profile_key`| uuidv4 | Chave única de identificação da carteira de cobrança de destino. É a carteira de cobrança para onde os boletos serão tombados. Você consegue opter essa chave através do [endpoint de consulta de carteiras de cobrança de uma conta](../boletos/carteira/listar_carteiras) |36|
|`new_requester_profile_code`| string | Código da carteira de cobrança de destino. É a carteira de cobrança para onde os boletos serão tombados. |19|
|`new_pix_key` | string | Chave pix da conta de destino do tombamento (para os casos de bolepix). | 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
| Campo | Tipo | Descrição | Caracteres |
|-----------------------------------------------|-------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|
| `bank_slip_ownership_exchange_batch_key` | uuidv4 | Chave única de indentificação do lote de tombamento. | 36 |
| `request_control_key` | uuidv4 | Chave única de identificação da requisição neste endpoint. Utilizada para evitar duplicidade na chamada via API. | 36 |
| `bank_slip_ownership_exchange_batch_status` | enum | Status do lote de tombamento. | [Enumeradores `bank_slip_ownership_exchange_batch_status`](#enumeradores-bank_slip_ownership_exchange_batch_status) |
| `new_requester_profile_key` | uuidv4 | Chave única de identificação da carteira de cobrança de destino. É a carteira de cobrança para onde os boletos serão tombados. Você consegue opter essa chave através do [endpoint de consulta de carteiras de cobrança de uma conta](../boletos/carteira/listar_carteiras) | 36 |
| `new_requester_profile_code` | string | Código da carteira de cobrança de destino. É a carteira de cobrança para onde os boletos serão tombados. | 19 |
| `new_requester_profile_owner_name` | string | Nome do titular da conta de destino e do beneficiário da carteira de cobrança de destino. | 255 |
| `new_requester_profile_owner_document_number` | string | Número do documento (CPF/CNPJ) do titular da conta de destino e do beneficiário da carteira de cobrança de destino. | 255 |
| `new_requester_profile_account_number` | string | Número da conta de destino do tombamento. | 7 |
| `new_requester_profile_account_digit` | string | Dígito verificador da conta de destino do tombamento. | 1 |
| `new_requester_profile_account_branch` | string | Número da agência da conta de destino do tombamento. | 4 |
| `new_pix_key` | string | Chave pix da conta de destino do tombamento (para os casos de bolepix). | 255 |
| `total_bank_slip_count` | float | Total de boletos no lote de tombamento. | - |
| `total_amount` | float | Somatória do valor de face dos boletos no lote de tombamento. | - |
### Enumeradores bank_slip_ownership_exchange_batch_status
| Enumerador | Descrição |
|------------|--------------------------------------------------------------------------------------------------------|
| open | O lote foi criado e ainda está aberto para inclusão/exclusão de boletos. |
| sent | A seleção dos boletos foi concluída e o lote de tombamento esta pendente de aprovação. A parte aprovadora necessita realizar a aprovação |
| processing | A seleção dos boletos foi concluída e o tombamento dos boletos contidos no lote esta sendo processado. |
| approved | Os boletos contidos no lote já foram tombados o destinatário |
| cancelled | Lote de tombamento cancelado. |
| rejected | Lote de tomabamento rejeitado. |
---
# Aprovar lote de tombamento de boletos
URL: /documentation/troca_de_titularidade/aprovar_lote
Uma vez que foi feito o envio do lote de tombamento através do ```/send```, é necessário realizar a aprovação do tombamento.
A aprovação deve ser feita pela conta e requester de destino, que serão os novos responsáveis pelos boletos após o tombamento. Se o tombamento for entre contas do mesmo requester, basta fazer a alteração da account-key.
## Request
ENDPOINT /account/ ACCOUNT-KEY /requester_profile/ REQUESTER-PROFILE-KEY /bank_slip_ownership_exchange_batch/ BANK-SLIP-OWNERSHIP-EXCHANGE-BATCH-KEY /approve
MÉTODO PATCH
### Path parameters
| Campo | Tipo | Descrição | Caracteres |
|------------------------------------------|--------|------------------------------------------------------------------------------------------------------------------|------------|
| `ACCOUNT-KEY` | uuidv4 | Chave única de identificação da conta de destino, onde os boletos serão enviados. | 36 |
| `REQUESTER-PROFILE-KEY` | uuidv4 | Chave única de identificação da carteira de destino, onde os boletos serão transferidos. | 36 |
| `BANK-SLIP-OWNERSHIP-EXCHANGE-BATCH-KEY` | uuidv4 | Chave única de indentificação do lote de tombamento. | 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
| Campo | Tipo | Descrição | Caracteres |
|---|------|-----------|---------------------------------------------------------------------------------------------------------------------|
| `bank_slip_ownership_exchange_batch_key` | uuidv4 | Chave única de indentificação do lote de tombamento. | 36 |
| `request_control_key` | uuidv4 | Chave única de identificação da requisição neste endpoint. Utilizada para evitar duplicidade na chamada via API. | 36 |
| `bank_slip_ownership_exchange_batch_status` | enum | Status do lote de tombamento. | [Enumeradores `bank_slip_ownership_exchange_batch_status`](#enumeradores-bank_slip_ownership_exchange_batch_status) |
| `new_requester_profile_key` | uuidv4 | Chave única de identificação da carteira de cobrança de destino. É a carteira de cobrança para onde os boletos serão tombados. Você consegue opter essa chave através do [endpoint de consulta de carteiras de cobrança de uma conta](../boletos/carteira/listar_carteiras) | 36 |
| `new_requester_profile_code` | string | Código da carteira de cobrança de destino. É a carteira de cobrança para onde os boletos serão tombados. | 19 |
| `new_requester_profile_owner_name` | string | Nome do titular da conta de destino e do beneficiário da carteira de cobrança de destino. | 255 |
| `new_requester_profile_owner_document_number` | string | Número do documento (CPF/CNPJ) do titular da conta de destino e do beneficiário da carteira de cobrança de destino. | 255 |
| `new_requester_profile_account_number` | string | Número da conta de destino do tombamento. | 7 |
| `new_requester_profile_account_digit` | string | Dígito verificador da conta de destino do tombamento. | 1 |
| `new_requester_profile_account_branch` | string | Número da agência da conta de destino do tombamento. | 4 |
| `new_pix_key` | string | Chave pix da conta de destino do tombamento (para os casos de bolepix). | 255 |
| `total_bank_slip_count` | float | Total de boletos no lote de tombamento. | - |
| `total_amount` | float | Somatória do valor de face dos boletos no lote de tombamento. | - |
### Enumeradores bank_slip_ownership_exchange_batch_status
| Enumerador | Descrição |
|------------|--------------------------------------------------------------------------------------------------------|
| open | O lote foi criado e ainda está aberto para inclusão/exclusão de boletos. |
| closed | O lote se encontra fechado e o tombamento dos boletos contidos no lote foi concluído. |
| processing | A seleção dos boletos foi concluída e o tombamento dos boletos contidos no lote esta sendo processado. |
| pending_approval | A seleção dos boletos foi concluída e o lote de tombamento esta pendente de aprovação. A parte aprovadora, pode remover boletos do lote. |
| canceled | Lote de tombamento cancelado. |
| rejected | Lote de tomabamento rejeitado. |
---
# Cancelar lote de tombamento de boletos
URL: /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
MÉTODO PATCH
### Path parameters
| Campo | Tipo | Descrição | Caracteres |
|------------------------------------------|--------|------------------------------------------------------------------------------------------------------------------------|------------|
| `ACCOUNT-KEY` | uuidv4 | Chave única de identificação da conta de origem, onde os boletos foram originalmente registrados. | 36 |
| `REQUESTER-PROFILE-KEY` | uuidv4 | Chave única de identificação da carteira de cobrança de origem, onde os boletos foram originalmente registrados. | 36 |
| `BANK-SLIP-OWNERSHIP-EXCHANGE-BATCH-KEY` | uuidv4 |Chave única de indentificação do lote de tombamento.| 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
| Campo | Tipo | Descrição | Caracteres |
|---|------|-----------|---------------------------------------------------------------------------------------------------------------------|
| `bank_slip_ownership_exchange_batch_key` | uuidv4 | Chave única de indentificação do lote de tombamento. | 36 |
| `request_control_key` | uuidv4 | Chave única de identificação da requisição neste endpoint. Utilizada para evitar duplicidade na chamada via API. | 36 |
| `bank_slip_ownership_exchange_batch_status` | enum | Status do lote de tombamento. | [Enumeradores `bank_slip_ownership_exchange_batch_status`](#enumeradores-bank_slip_ownership_exchange_batch_status) |
| `new_requester_profile_key` | uuidv4 | Chave única de identificação da carteira de cobrança de destino. É a carteira de cobrança para onde os boletos serão tombados. Você consegue opter essa chave através do [endpoint de consulta de carteiras de cobrança de uma conta](../boletos/carteira/listar_carteiras) | 36 |
| `new_requester_profile_code` | string | Código da carteira de cobrança de destino. É a carteira de cobrança para onde os boletos serão tombados. | 19 |
| `new_requester_profile_owner_name` | string | Nome do titular da conta de destino e do beneficiário da carteira de cobrança de destino. | 255 |
| `new_requester_profile_owner_document_number` | string | Número do documento (CPF/CNPJ) do titular da conta de destino e do beneficiário da carteira de cobrança de destino. | 255 |
| `new_requester_profile_account_number` | string | Número da conta de destino do tombamento. | 7 |
| `new_requester_profile_account_digit` | string | Dígito verificador da conta de destino do tombamento. | 1 |
| `new_requester_profile_account_branch` | string | Número da agência da conta de destino do tombamento. | 4 |
| `new_pix_key` | string | Chave pix da conta de destino do tombamento (para os casos de bolepix). | 255 |
| `total_bank_slip_count` | float | Total de boletos no lote de tombamento. | - |
| `total_amount` | float | Somatória do valor de face dos boletos no lote de tombamento. | - |
### Enumeradores bank_slip_ownership_exchange_batch_status
| Enumerador | Descrição |
|------------|--------------------------------------------------------------------------------------------------------|
| open | O lote foi criado e ainda está aberto para inclusão/exclusão de boletos. |
| closed | O lote se encontra fechado e o tombamento dos boletos contidos no lote foi concluído. |
| processing | A seleção dos boletos foi concluída e o tombamento dos boletos contidos no lote esta sendo processado. |
| pending_approval | A seleção dos boletos foi concluída e o lote de tombamento esta pendente de aprovação. A parte aprovadora, pode remover boletos do lote. |
| canceled | Lote de tombamento cancelado. |
| rejected | Lote de tomabamento rejeitado. |
---
# Incluir boletos em um lote de tombamento
URL: /documentation/troca_de_titularidade/incluir_boletos
Esse endpoint é utiliza para inclusão de boletos em um lote de tombamento de boletos.
## Request
ENDPOINT /account/ ACCOUNT-KEY /requester_profile/ REQUESTER-PROFILE-KEY /bank_slip_ownership_exchange_batch/ BANK-SLIP-OWNERSHIP-EXCHANGE-BATCH-KEY /append
MÉTODO PATCH
### Path parameters
| Campo | Tipo | Descrição | Caracteres |
|------------------------------------------|--------|------------------------------------------------------------------------------------------------------------------------|------------|
| `ACCOUNT-KEY` | uuidv4 | Chave única de identificação da conta de origem, onde os boletos foram originalmente registrados. | 36 |
| `REQUESTER-PROFILE-KEY` | uuidv4 | Chave única de identificação da carteira de cobrança de origem, onde os boletos foram originalmente registrados. | 36 |
| `BANK-SLIP-OWNERSHIP-EXCHANGE-BATCH-KEY` | uuidv4 |Chave única de indentificação do lote de tombamento.| 36 |
Request Body
```json
{
"bank_slips": [
"b21c5b5a-a71f-4672-9254-022401cd15f6",
"8197e3d0-1500-439f-9f9d-d243115542fa",
"8293b817-bed9-418a-8c1e-ec8ef5a31468"
]
}
```
:::caution Atenção!
A lista de boletos informada no objeto `bank_slips` no payload, possui uma limitação de 10.000 boletos por requisição.
:::
## 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
| Campo | Tipo | Descrição | Caracteres |
|---|------|-----------|---------------------------------------------------------------------------------------------------------------------|
| `bank_slip_ownership_exchange_batch_key` | uuidv4 | Chave única de indentificação do lote de tombamento. | 36 |
| `request_control_key` | uuidv4 | Chave única de identificação da requisição neste endpoint. Utilizada para evitar duplicidade na chamada via API. | 36 |
| `bank_slip_ownership_exchange_batch_status` | enum | Status do lote de tombamento. | [Enumeradores `bank_slip_ownership_exchange_batch_status`](#enumeradores-bank_slip_ownership_exchange_batch_status) |
| `new_requester_profile_key` | uuidv4 | Chave única de identificação da carteira de cobrança de destino. É a carteira de cobrança para onde os boletos serão tombados. Você consegue opter essa chave através do [endpoint de consulta de carteiras de cobrança de uma conta](../boletos/carteira/listar_carteiras) | 36 |
| `new_requester_profile_code` | string | Código da carteira de cobrança de destino. É a carteira de cobrança para onde os boletos serão tombados. | 19 |
| `new_requester_profile_owner_name` | string | Nome do titular da conta de destino e do beneficiário da carteira de cobrança de destino. | 255 |
| `new_requester_profile_owner_document_number` | string | Número do documento (CPF/CNPJ) do titular da conta de destino e do beneficiário da carteira de cobrança de destino. | 255 |
| `new_requester_profile_account_number` | string | Número da conta de destino do tombamento. | 7 |
| `new_requester_profile_account_digit` | string | Dígito verificador da conta de destino do tombamento. | 1 |
| `new_requester_profile_account_branch` | string | Número da agência da conta de destino do tombamento. | 4 |
| `new_pix_key` | string | Chave pix da conta de destino do tombamento (para os casos de bolepix). | 255 |
| `total_bank_slip_count` | float | Total de boletos no lote de tombamento. | - |
| `total_amount` | float | Somatória do valor de face dos boletos no lote de tombamento. | - |
### Enumeradores bank_slip_ownership_exchange_batch_status
| Enumerador | Descrição |
|------------|--------------------------------------------------------------------------------------------------------|
| open | O lote foi criado e ainda está aberto para inclusão/exclusão de boletos. |
| sent | A seleção dos boletos foi concluída e o lote de tombamento esta pendente de aprovação. A parte aprovadora necessita realizar a aprovação |
| processing | A seleção dos boletos foi concluída e o tombamento dos boletos contidos no lote esta sendo processado. |
| approved | Os boletos contidos no lote já foram tombados o destinatário |
| cancelled | Lote de tombamento cancelado. |
| rejected | Lote de tomabamento rejeitado. |
---
# Introdução
URL: /documentation/troca_de_titularidade/introducao
A troca de titularidade de boletos **(tombamento)** consiste no processo de alteração da carteira de cobrança e da conta de liquidação associadas aos boletos já registrados.
Em uma troca de titularidade, sempre existirão **uma conta e uma carteira de cobrança de origem e uma conta e uma carteira de cobrança de destino.**
- A **conta e carteira de origem** são aquelas em que os boletos foram originalmente registrados.
- A **conta e carteira de destino** são aquelas para as quais os boletos serão transferidos (tombados).
**O que é alterado?**
- Carteira de cobrança
- Conta de liquidação
**O que NÃO é alterado?**
- Dados do beneficiário da cobrança
- Linha digitável para pagamento
- QR Code Pix para pagamento (nos casos de BolePix)
## Casos de Uso
### Composição de garantia
Os boletos de cobrança de uma carteira podem ser utilizados na composição de garantia de uma operação de crédito.
Nesse cenário, o titular da conta de destino tomba os boletos da sua carteira de cobrança simples para a carteira de cobrança vinculada à conta de garantia da operação.
### Cessão de direito creditório
Nos casos em que o boleto de cobrança esteja vinculado a um direito creditório antecipado, é possível — após a conclusão da antecipação — tombar os boletos para a carteira do novo credor do direito antecipado.
:::caution Atenção!
A API de troca de titularidade de boletos **não formaliza** a cessão fiduciária ou a antecipação do direito creditório.
Ela apenas reflete o que deve acontecer com o fluxo financeiro do ativo vinculado ao boleto de cobrança tombado.
:::
## Fluxo do Processo
O tombamento de boletos é o processo de transferência de titularidade dos boletos registrados de uma carteira para outra.
Esse fluxo é composto por quatro etapas principais, que devem ser executadas em sequência por meio de chamadas à API.
A seguir, descrevemos o funcionamento de cada uma delas.
**1. Abertura de lote**
O primeiro passo consiste na criação de um lote de tombamento, que agrupará todos os boletos que serão transferidos.
Assim que o lote é criado, ele é retornado com o status inicial `opened`.
Nessa etapa, devem ser informadas as chaves da conta de origem, da carteira de destino e a nova chave Pix associada.
**2. Inclusão de boletos no lote**
Com o lote aberto, é possível adicionar os boletos que serão incluídos na troca de titularidade.
Durante essa etapa, o status do lote permanece `opened`, indicando que ele ainda está em preparação e pode receber novos boletos.
**3. Envio dos boletos**
Após a inclusão de todos os boletos desejados, é necessário enviar o lote para processamento.
No momento em que o envio é realizado, o status do lote é atualizado para `sent`, e um webhook é disparado para informar a alteração de status.
Esse envio marca o início do fluxo operacional do tombamento.
**4. Aprovação do tombamento**
Por fim, a aprovação do lote deve ser realizada pela conta de destino, confirmando a transferência de titularidade dos boletos.
Após a aprovação, o status do lote muda para `processing`, indicando que o tombamento está em andamento.
Quando o processo é concluído com sucesso, o sistema envia um webhook final com o status `approved`, confirmando que a troca de titularidade foi finalizada.
Compartilhamos a seguir o link que apresenta um organograma do fluxo completo, incluindo os endpoints associados e as respectivas mudanças de status em cada etapa do processo:
---
# Listar boletos de um lote de tombamento
URL: /documentation/troca_de_titularidade/listar_boletos_lote
Utilize esse endpoint para listar todos os boletos incluídos no lote de tombamento consultado.
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip_ownership_exchange_batch/ BANK_SLIP_OWNERSHIP_EXCHANGE_BATCH_KEY /bank_slips
MÉTODO GET
### Path parameters
| Campo | Tipo | Descrição | Caracteres |
|---------------|--------|------------------------------------------------------------------------------------------------------------------------|------------|
| `account_key` | uuidv4 | Chave única de identificação da conta de origem, onde os boletos foram originalmente registrados. | 36 |
| `requester_profile_key` | uuidv4 | Chave única de identificação da carteira de cobrança de origem, onde os boletos foram originalmente registrados. | 36 |
| `bank_slip_ownership_exchange_batch_key` | uuidv4 |Chave única de indentificação do lote de tombamento.| 36 |
### Query parameters
| Campo | Descrição |
|----------------------|--------------------------------------------|
| `page_number` | Página atual que está sendo consultada |
| `page_size` | Quantidade de resultados por página |
## 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
[Objeto de Listagem de boletos](../boletos/consulta/listar_boletos#response-body-params)
---
# Listar lotes de tombamento de boletos - destino
URL: /documentation/troca_de_titularidade/listar_lotes_destino
Utilize este endpoint para listar os lotes de tombamento de boletos a partir da conta de destino — ou seja, a conta para a qual os boletos foram tombados.
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip_ownership_exchange_batches/incoming
MÉTODO GET
### Path parameters
| Campo | Tipo | Descrição | Caracteres |
|---------------|--------|-------------------------------------------------------------------------------------------------------|------------|
| `account_key` | uuidv4 | Chave única de identificação da conta de destino, para onde os boletos serão tombados. | 36 |
| `requester_profile_key` | uuidv4 | Chave única de identificação da carteira de cobrança de destino, para onde os boletos serão tombados. | 36 |
### Query parameters
| Campo | Descrição |
|----------------------|--------------------------------------------|
| `page_number` | Página atual que está sendo consultada |
| `page_size` | Quantidade de resultados por página |
## 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
| Campo | Tipo | Descrição | Caracteres |
|-----------------------------------------------|-------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|
| `bank_slip_ownership_exchange_batch_key` | uuidv4 | Chave única de indentificação do lote de tombamento. | 36 |
| `request_control_key` | uuidv4 | Chave única de identificação da requisição neste endpoint. Utilizada para evitar duplicidade na chamada via API. | 36 |
| `bank_slip_ownership_exchange_batch_status` | enum | Status do lote de tombamento. | [Enumeradores `bank_slip_ownership_exchange_batch_status`](#enumeradores-bank_slip_ownership_exchange_batch_status) |
| `old_requester_profile_key` | uuidv4 | Chave única de identificação da carteira de cobrança de destino, para onde os boletos serão tombados. Você consegue opter essa chave através do [endpoint de consulta de carteiras de cobrança de uma conta](../boletos/carteira/listar_carteiras) | 36 |
| `old_requester_profile_code` | string | Código da carteira de cobrança de destino, para onde os boletos serão tombados. | 19 |
| `old_requester_profile_owner_name` | string | Nome do titular da conta de destino e do beneficiário da carteira de cobrança de destino. | 255 |
| `old_requester_profile_owner_document_number` | string | Número do documento (CPF/CNPJ) do titular da conta de destino e do beneficiário da carteira de cobrança de destino. | 255 |
| `old_requester_profile_account_number` | string | Número da conta de destino do tombamento. | 7 |
| `old_requester_profile_account_digit` | string | Dígito verificador da conta de destino do tombamento. | 1 |
| `old_requester_profile_account_branch` | string | Número da agência da conta de destino do tombamento. | 4 |
| `old_pix_key` | string | Chave pix da conta de destino do tombamento (para os casos de bolepix). | 255 |
| `total_bank_slip_count` | float | Total de boletos no lote de tombamento. | - |
| `total_amount` | float | Somatória do valor de face dos boletos no lote de tombamento. | - |
### Enumeradores bank_slip_ownership_exchange_batch_status
| Enumerador | Descrição |
|------------|--------------------------------------------------------------------------------------------------------|
| open | O lote foi criado e ainda está aberto para inclusão/exclusão de boletos. |
| sent | A seleção dos boletos foi concluída e o lote de tombamento está pendente de aprovação. A parte aprovadora necessita realizar a aprovação. |
| processing | A seleção dos boletos foi concluída e o tombamento dos boletos contidos no lote está sendo processado. |
| approved | Os boletos contidos no lote já foram tombados o destinatário. |
| cancelled | Lote de tombamento cancelado. |
| rejected | Lote de tombamento rejeitado. |
---
# Listar lotes de tombamento de boletos - origem
URL: /documentation/troca_de_titularidade/listar_lotes_origem
Utilize este endpoint para listar os lotes de tombamento de boletos a partir da conta de origem do tombamento, ou seja, a conta na qual os boletos foram originalmente registrados.
## Request
ENDPOINT /account/ ACCOUNT_KEY /requester_profile/ REQUESTER_PROFILE_KEY /bank_slip_ownership_exchange_batches/outgoing
MÉTODO GET
### Path parameters
| Campo | Tipo | Descrição | Caracteres |
|---------------|--------|------------------------------------------------------------------------------------------------------------------------|------------|
| `ACCOUNT-KEY` | uuidv4 | Chave única de identificação da conta de origem, onde os boletos foram originalmente registrados. | 36 |
| `REQUESTER-PROFILE-KEY` | uuidv4 | Chave única de identificação da carteira de cobrança de origem, onde os boletos foram originalmente registrados. | 36 |
### Query parameters
| Campo | Descrição |
|----------------------|--------------------------------------------|
| `page_number` | Página atual que está sendo consultada |
| `page_size` | Quantidade de resultados por página |
## 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
| Campo | Tipo | Descrição | Caracteres |
|-----------------------------------------------|-------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------|
| `bank_slip_ownership_exchange_batch_key` | uuidv4 | Chave única de indentificação do lote de tombamento. | 36 |
| `request_control_key` | uuidv4 | Chave única de identificação da requisição neste endpoint. Utilizada para evitar duplicidade na chamada via API. | 36 |
| `bank_slip_ownership_exchange_batch_status` | enum | Status do lote de tombamento. | [Enumeradores `bank_slip_ownership_exchange_batch_status`](#enumeradores-bank_slip_ownership_exchange_batch_status) |
| `new_requester_profile_key` | uuidv4 | Chave única de identificação da carteira de cobrança de destino. É a carteira de cobrança para onde os boletos serão tombados. Você consegue opter essa chave através do [endpoint de consulta de carteiras de cobrança de uma conta](../boletos/carteira/listar_carteiras) | 36 |
| `new_requester_profile_code` | string | Código da carteira de cobrança de destino. É a carteira de cobrança para onde os boletos serão tombados. | 19 |
| `new_requester_profile_owner_name` | string | Nome do titular da conta de destino e do beneficiário da carteira de cobrança de destino. | 255 |
| `new_requester_profile_owner_document_number` | string | Número do documento (CPF/CNPJ) do titular da conta de destino e do beneficiário da carteira de cobrança de destino. | 255 |
| `new_requester_profile_account_number` | string | Número da conta de destino do tombamento. | 7 |
| `new_requester_profile_account_digit` | string | Dígito verificador da conta de destino do tombamento. | 1 |
| `new_requester_profile_account_branch` | string | Número da agência da conta de destino do tombamento. | 4 |
| `new_pix_key` | string | Chave pix da conta de destino do tombamento (para os casos de bolepix). | 255 |
| `total_bank_slip_count` | float | Total de boletos no lote de tombamento. | - |
| `total_amount` | float | Somatória do valor de face dos boletos no lote de tombamento. | - |
### Enumeradores bank_slip_ownership_exchange_batch_status
| Enumerador | Descrição |
|------------|--------------------------------------------------------------------------------------------------------|
| open | O lote foi criado e ainda está aberto para inclusão/exclusão de boletos. |
| sent | A seleção dos boletos foi concluída e o lote de tombamento está pendente de aprovação. A parte aprovadora necessita realizar a aprovação. |
| processing | A seleção dos boletos foi concluída e o tombamento dos boletos contidos no lote está sendo processado. |
| approved | Os boletos contidos no lote já foram tombados o destinatário. |
| cancelled | Lote de tombamento cancelado. |
| rejected | Lote de tombamento rejeitado. |
---
# Remover boletos em um lote de tombamento
URL: /documentation/troca_de_titularidade/remover_boletos
Esse endpoint é utiliza para remover boletos de um lote de tombamento de boletos com status `open`.
## Request
ENDPOINT /account/ ACCOUNT-KEY /requester_profile/ REQUESTER-PROFILE-KEY /bank_slip_ownership_exchange_batch/ BANK-SLIP-OWNERSHIP-EXCHANGE-BATCH-KEY /remove
MÉTODO PATCH
### Path parameters
| Campo | Tipo | Descrição | Caracteres |
|------------------------------------------|--------|------------------------------------------------------------------------------------------------------------------------|------------|
| `ACCOUNT-KEY` | uuidv4 | Chave única de identificação da conta de origem, onde os boletos foram originalmente registrados. | 36 |
| `REQUESTER-PROFILE-KEY` | uuidv4 | Chave única de identificação da carteira de cobrança de origem, onde os boletos foram originalmente registrados. | 36 |
| `BANK-SLIP-OWNERSHIP-EXCHANGE-BATCH-KEY` | uuidv4 |Chave única de indentificação do lote de tombamento.| 36 |
Request Body
```json
{
"bank_slips": [
"b21c5b5a-a71f-4672-9254-022401cd15f6",
"8197e3d0-1500-439f-9f9d-d243115542fa",
"8293b817-bed9-418a-8c1e-ec8ef5a31468"
]
}
```
:::caution Atenção!
A lista de boletos informada no objeto `bank_slips` no payload, possui uma limitação de 10.000 boletos por requisição.
:::
## 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
| Campo | Tipo | Descrição | Caracteres |
|---|------|-----------|---------------------------------------------------------------------------------------------------------------------|
| `bank_slip_ownership_exchange_batch_key` | uuidv4 | Chave única de indentificação do lote de tombamento. | 36 |
| `request_control_key` | uuidv4 | Chave única de identificação da requisição neste endpoint. Utilizada para evitar duplicidade na chamada via API. | 36 |
| `bank_slip_ownership_exchange_batch_status` | enum | Status do lote de tombamento. | [Enumeradores `bank_slip_ownership_exchange_batch_status`](#enumeradores-bank_slip_ownership_exchange_batch_status) |
| `new_requester_profile_key` | uuidv4 | Chave única de identificação da carteira de cobrança de destino. É a carteira de cobrança para onde os boletos serão tombados. Você consegue opter essa chave através do [endpoint de consulta de carteiras de cobrança de uma conta](../boletos/carteira/listar_carteiras) | 36 |
| `new_requester_profile_code` | string | Código da carteira de cobrança de destino. É a carteira de cobrança para onde os boletos serão tombados. | 19 |
| `new_requester_profile_owner_name` | string | Nome do titular da conta de destino e do beneficiário da carteira de cobrança de destino. | 255 |
| `new_requester_profile_owner_document_number` | string | Número do documento (CPF/CNPJ) do titular da conta de destino e do beneficiário da carteira de cobrança de destino. | 255 |
| `new_requester_profile_account_number` | string | Número da conta de destino do tombamento. | 7 |
| `new_requester_profile_account_digit` | string | Dígito verificador da conta de destino do tombamento. | 1 |
| `new_requester_profile_account_branch` | string | Número da agência da conta de destino do tombamento. | 4 |
| `new_pix_key` | string | Chave pix da conta de destino do tombamento (para os casos de bolepix). | 255 |
| `total_bank_slip_count` | float | Total de boletos no lote de tombamento. | - |
| `total_amount` | float | Somatória do valor de face dos boletos no lote de tombamento. | - |
### Enumeradores bank_slip_ownership_exchange_batch_status
| Enumerador | Descrição |
|------------|--------------------------------------------------------------------------------------------------------|
| open | O lote foi criado e ainda está aberto para inclusão/exclusão de boletos. |
| sent | A seleção dos boletos foi concluída e o lote de tombamento esta pendente de aprovação. A parte aprovadora necessita realizar a aprovação |
| processing | A seleção dos boletos foi concluída e o tombamento dos boletos contidos no lote esta sendo processado. |
| approved | Os boletos contidos no lote já foram tombados o destinatário |
| cancelled | Lote de tombamento cancelado. |
| rejected | Lote de tomabamento rejeitado. |
---
# Enviar lote de tombamento de boletos
URL: /documentation/troca_de_titularidade/validar_lote_e_enviar
Esse endpoint é utilizado para fechar o lote e iniciar o processamento da troca de titularidade. Ao fazer a requisição, o lote será validado e o status alterado para sent, onde ambas as partes envolvidas receberão um webhook relativo ao tombamento.
:::danger Atenção!
Esse endpoint só deve ser acionado caso a inserção dos boletos esteja finalizada e as devidas formalizações entre as contrapartes de origem e destino do tombamento, estejam concluídas.
:::
## Request
ENDPOINT /account/ ACCOUNT-KEY /requester_profile/ REQUESTER-PROFILE-KEY /bank_slip_ownership_exchange_batch/ BANK-SLIP-OWNERSHIP-EXCHANGE-BATCH-KEY /send
MÉTODO PATCH
### Path parameters
| Campo | Tipo | Descrição | Caracteres |
|------------------------------------------|--------|------------------------------------------------------------------------------------------------------------------|------------|
| `ACCOUNT-KEY` | uuidv4 | Chave única de identificação da conta de origem, onde os boletos foram originalmente registrados. | 36 |
| `REQUESTER-PROFILE-KEY` | uuidv4 | Chave única de identificação da carteira de cobrança de origem, onde os boletos foram originalmente registrados. | 36 |
| `BANK-SLIP-OWNERSHIP-EXCHANGE-BATCH-KEY` | uuidv4 | Chave única de indentificação do lote de tombamento. | 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
| Campo | Tipo | Descrição | Caracteres |
|---|------|-----------|---------------------------------------------------------------------------------------------------------------------|
| `bank_slip_ownership_exchange_batch_key` | uuidv4 | Chave única de indentificação do lote de tombamento. | 36 |
| `request_control_key` | uuidv4 | Chave única de identificação da requisição neste endpoint. Utilizada para evitar duplicidade na chamada via API. | 36 |
| `bank_slip_ownership_exchange_batch_status` | enum | Status do lote de tombamento. | [Enumeradores `bank_slip_ownership_exchange_batch_status`](#enumeradores-bank_slip_ownership_exchange_batch_status) |
| `new_requester_profile_key` | uuidv4 | Chave única de identificação da carteira de cobrança de destino. É a carteira de cobrança para onde os boletos serão tombados. Você consegue opter essa chave através do [endpoint de consulta de carteiras de cobrança de uma conta](../boletos/carteira/listar_carteiras) | 36 |
| `new_requester_profile_code` | string | Código da carteira de cobrança de destino. É a carteira de cobrança para onde os boletos serão tombados. | 19 |
| `new_requester_profile_owner_name` | string | Nome do titular da conta de destino e do beneficiário da carteira de cobrança de destino. | 255 |
| `new_requester_profile_owner_document_number` | string | Número do documento (CPF/CNPJ) do titular da conta de destino e do beneficiário da carteira de cobrança de destino. | 255 |
| `new_requester_profile_account_number` | string | Número da conta de destino do tombamento. | 7 |
| `new_requester_profile_account_digit` | string | Dígito verificador da conta de destino do tombamento. | 1 |
| `new_requester_profile_account_branch` | string | Número da agência da conta de destino do tombamento. | 4 |
| `new_pix_key` | string | Chave pix da conta de destino do tombamento (para os casos de bolepix). | 255 |
| `total_bank_slip_count` | float | Total de boletos no lote de tombamento. | - |
| `total_amount` | float | Somatória do valor de face dos boletos no lote de tombamento. | - |
### Enumeradores bank_slip_ownership_exchange_batch_status
| Enumerador | Descrição |
|------------|--------------------------------------------------------------------------------------------------------|
| open | O lote foi criado e ainda está aberto para inclusão/exclusão de boletos. |
| closed | O lote se encontra fechado e o tombamento dos boletos contidos no lote foi concluído. |
| processing | A seleção dos boletos foi concluída e o tombamento dos boletos contidos no lote esta sendo processado. |
| pending_approval | A seleção dos boletos foi concluída e o lote de tombamento esta pendente de aprovação. A parte aprovadora, pode remover boletos do lote. |
| canceled | Lote de tombamento cancelado. |
| rejected | Lote de tomabamento rejeitado. |