# Cobrança — Boletos (UY3)

> 20 endpoints. Placeholders: `{{baseUrl}}` e `{{token}}`.

## Autenticação

Envie o token em toda requisição no header `Authorization: Bearer {{token}}` (JWT do AWS Cognito). Integrações servidor-a-servidor podem usar `X-Api-Key`. Todo tráfego é HTTPS; a credencial nunca vai na URL nem em query string.

## Boletos

Emita, consulte, baixe e cancele boletos bancários.

### GET /api/v1/BankSlip

**Método utilizado para listar os boletos** — Lista e filtra registros de api.

Método utilizado para listar os boletos.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `DocumentNumber` | query | `string` | opcional | — | `valor` |
| `Tenant` | query | `string` | opcional | — | `uy3` |
| `WalletCode` | query | `integer (int64)` | opcional | — | `10` |
| `BillingId` | query | `string` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `Page` | query | `integer` | opcional | — | `10` |
| `Size` | query | `integer` | opcional | — | `10` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `data` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `page` | `integer` | opcional | — | — | `0` |
| `totalPages` | `integer` | opcional | — | — | `0` |
| `totalItems` | `integer` | opcional | — | — | `0` |
| `isCountTruncated` | `boolean` | opcional | — | — | `true` |

Detalhe de `data`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `walletCode` | `integer (int64)` | opcional | — | — | `0` |
| `walletCodeOrigem` | `integer (int64)` | opcional | — | — | `0` |
| `barCode` | `string` | opcional | — | — | `"texto"` |
| `documentNumber` | `string` | opcional | — | — | `"texto"` |
| `amount` | `integer (int64)` | opcional | — | — | `0` |
| `dueDate` | `string` | opcional | — | — | `"texto"` |
| `tags` | `array de string` | opcional | — | — | `[ … ]` |
| `beneficiary` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `payer` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `statusRegisterValue` | `string` | opcional | — | — | `"texto"` |
| `statusRegisterValueDisplay` | `string` | opcional | — | — | `"texto"` |
| `statusSettlementValue` | `string` | opcional | — | — | `"texto"` |
| `statusSettlementValueDisplay` | `string` | opcional | — | — | `"texto"` |
| `statusDebtCollectionValue` | `string` | opcional | — | — | `"texto"` |
| `statusDebtCollectionValueDisplay` | `string` | opcional | — | — | `"texto"` |
| `latePaymentInterestAmountPerDay` | `string` | opcional | — | — | `"texto"` |
| `firstInstructionDebtCollection` | `string` | opcional | — | — | `"texto"` |
| `secondInstructionDebtCollection` | `integer` | opcional | — | — | `0` |
| `cancelReason` | `string` | opcional | — | — | `"texto"` |
| `billingId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `createdAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `settlementAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `settlementChannelValue` | `string` | opcional | — | — | `"texto"` |
| `settlementChannelValueDisplay` | `string` | opcional | — | — | `"texto"` |
| `bankCode` | `string` | opcional | — | — | `"texto"` |
| `walletNumber` | `integer` | opcional | — | — | `0` |
| `captureType` | `string` | opcional | — | — | `"texto"` |
| `captureTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `paymentMethod` | `string` | opcional | — | — | `"texto"` |
| `paymentMethodDisplay` | `string` | opcional | — | — | `"texto"` |
| `isTransferred` | `boolean` | opcional | — | — | `true` |

Exemplo:

```json
{
  "data": [
    {
      "id": "texto",
      "walletCode": 0,
      "walletCodeOrigem": 0,
      "barCode": "texto",
      "documentNumber": "texto",
      "amount": 0,
      "dueDate": "texto",
      "tags": [
        "texto"
      ],
      "beneficiary": {
        "businessName": "Fulano de Tal",
        "registrationNumber": "12345678909"
      },
      "payer": {
        "name": "Fulano de Tal",
        "personTypeValue": "texto",
        "personTypeValueDisplay": "texto",
        "registrationNumber": "12345678909",
        "zipCode": "01310930",
        "addressName": "Fulano de Tal",
        "addressNumber": "texto",
        "addressComplement": "texto",
        "email": "cliente@exemplo.com.br"
      },
      "statusRegisterValue": "texto",
      "statusRegisterValueDisplay": "texto",
      "statusSettlementValue": "texto",
      "statusSettlementValueDisplay": "texto",
      "statusDebtCollectionValue": "texto",
      "statusDebtCollectionValueDisplay": "texto",
      "latePaymentInterestAmountPerDay": "texto",
      "firstInstructionDebtCollection": "texto",
      "secondInstructionDebtCollection": 0,
      "cancelReason": "texto",
      "billingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdAt": "2025-08-11T13:45:00Z",
      "settlementAt": "2025-08-11T13:45:00Z",
      "settlementChannelValue": "texto",
      "settlementChannelValueDisplay": "texto",
      "bankCode": "texto",
      "walletNumber": 0,
      "captureType": "texto",
      "captureTypeDisplay": "texto",
      "paymentMethod": "texto",
      "paymentMethodDisplay": "texto",
      "isTransferred": true
    }
  ],
  "page": 0,
  "totalPages": 0,
  "totalItems": 0,
  "isCountTruncated": true
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X GET "{{baseUrl}}/api/v1/BankSlip" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /api/v1/BankSlip/ExportWalletPosition

**Metodo reponsável por exportar relatorio de posição carteira** — Lista e filtra registros de api.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `WalletCode` | query | `integer (int64)` | opcional | — | `10` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X GET "{{baseUrl}}/api/v1/BankSlip/ExportWalletPosition" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /api/v1/BankSlip/DownloadBatch

**Método utilizado para download em lote através de uma lista de boletos** — Cria um novo registro de api.

Método utilizado para download em lote através de uma lista de boletos.

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `billingIds` | `array de string` | opcional | — | — | `[ … ]` |

Exemplo:

```json
{
  "billingIds": [
    "texto"
  ]
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/api/v1/BankSlip/DownloadBatch" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "billingIds": [
    "texto"
  ]
}'
```

---

### POST /api/v1/BankSlip/DownloadLongBatch

**Método utilizado para download em lote grande através de uma lista de boletos e…** — Cria um novo registro de api.

Método utilizado para download em lote grande através de uma lista de boletos e envio por email.

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `email` | `string` | opcional | — | — | `"cliente@exemplo.com.br"` |
| `billingIds` | `array de string` | opcional | — | — | `[ … ]` |

Exemplo:

```json
{
  "email": "cliente@exemplo.com.br",
  "billingIds": [
    "texto"
  ]
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/api/v1/BankSlip/DownloadLongBatch" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "cliente@exemplo.com.br",
  "billingIds": [
    "texto"
  ]
}'
```

---

### GET /api/v1/BankSlip/{identifier}/DownloadPdf

**Método utilizado para download PDF de um boleto especifico** — Lista e filtra registros de api.

Método utilizado para download PDF de um boleto especifico.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `identifier` | path | `string` | obrigatório | codigo de barras ou id do boleto | `valor` |
| `walletCode` | query | `integer (int64)` | opcional | código do convênio | `10` |
| `bankSlipUpdate` | query | `boolean` | opcional | Indica se o PDF do boleto deve ser gerado com o valor atualizado, considerando juros, multa por atraso ou descontos aplicáveis | `true` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X GET "{{baseUrl}}/api/v1/BankSlip/3fa85f64-5717-4562-b3fc-2c963f66afa6/DownloadPdf" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /api/v1/BankSlip/{identifier}

**Método utilizado para visualizar um boleto especifico** — Consulta api pelo identificador informado na rota.

Método utilizado para visualizar um boleto especifico.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `identifier` | path | `string` | obrigatório | codigo de barras ou id do boleto | `valor` |
| `withStatusNPC` | query | `boolean` | opcional | — | `true` |
| `withStatusDebtCollection` | query | `boolean` | opcional | — | `true` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X GET "{{baseUrl}}/api/v1/BankSlip/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"
```

---

### PATCH /api/v1/BankSlip/UpdateBatch

**Método de atualização em lote dos boletos** — Atualiza parcialmente um registro de api.

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `barCodes` | `array de string` | opcional | — | — | `[ … ]` |
| `walletCode` | `integer (int64)` | opcional | — | — | `0` |
| `interestMonthPercent` | `number (decimal)` | opcional | — | — | `1.99` |
| `finePercent` | `number (decimal)` | opcional | — | — | `1.99` |
| `deduction` | `integer` | opcional | — | — | `0` |

Exemplo:

```json
{
  "barCodes": [
    "texto"
  ],
  "walletCode": 0,
  "interestMonthPercent": 1.99,
  "finePercent": 1.99,
  "deduction": 0
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X PATCH "{{baseUrl}}/api/v1/BankSlip/UpdateBatch" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "barCodes": [
    "texto"
  ],
  "walletCode": 0,
  "interestMonthPercent": 1.99,
  "finePercent": 1.99,
  "deduction": 0
}'
```

---

### POST /api/v1/BankSlip/{barCode}/UpdateDueDate

**Método utilizado para prorrogar o vencimento de um boleto especifico** — Cria um novo registro de api.

Método utilizado para prorrogar o vencimento de um boleto especifico.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `barCode` | path | `string` | obrigatório | código de barras | `valor` |
| `idempotence` | query | `string` | opcional | chave de idempotência | `valor` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `dueDate` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "dueDate": "texto"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/api/v1/BankSlip/valor/UpdateDueDate" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "dueDate": "texto"
}'
```

---

### POST /api/v1/BankSlip/{barCode}/UpdateDeduction

**Método utilizado para aplicar abatimento em um boleto especifico** — Cria um novo registro de api.

Método utilizado para aplicar abatimento em um boleto especifico.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `barCode` | path | `string` | obrigatório | código de barras | `valor` |
| `idempotence` | query | `string` | opcional | chave de idempotência | `valor` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `deduction` | `integer` | opcional | — | — | `0` |

Exemplo:

```json
{
  "deduction": 0
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/api/v1/BankSlip/valor/UpdateDeduction" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "deduction": 0
}'
```

---

### POST /api/v1/BankSlip/{barCode}/CancelDeduction

**Método utilizado para cancelar abatimento em um boleto especifico** — Cria um novo registro de api.

Método utilizado para cancelar abatimento em um boleto especifico.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `barCode` | path | `string` | obrigatório | código de barras | `valor` |
| `idempotence` | query | `string` | opcional | chave de idempotência | `valor` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/api/v1/BankSlip/valor/CancelDeduction" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /api/v1/BankSlip/{barCode}/UpdateOtherInformation

**Método utilizado para atualizar dados sem instrução** — Cria um novo registro de api.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `barCode` | path | `string` | obrigatório | código de barras | `valor` |
| `idempotence` | query | `string` | opcional | chave de idempotência | `valor` |
| `generateInstructionTransactionLine` | query | `boolean` | opcional | flag to create registry in file confirmation | `true` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `documentNumber` | `string` | opcional | — | — | `"texto"` |
| `numberPayments` | `integer` | opcional | — | — | `0` |
| `latePaymentInterestAmountPerDay` | `integer` | opcional | — | — | `0` |
| `fineTypeValue` | `string` | opcional | — | — | `"texto"` |
| `fineAmount` | `number (decimal)` | opcional | — | — | `1000` |
| `interestTypeValue` | `string` | opcional | — | — | `"texto"` |
| `interestAmount` | `number (decimal)` | opcional | — | — | `1000` |
| `interestCodeValue` | `string` | opcional | — | — | `"texto"` |
| `discount` | `integer` | opcional | — | — | `0` |
| `discountLimitDate` | `string` | opcional | — | — | `"texto"` |
| `discount2` | `integer` | opcional | — | — | `0` |
| `discountLimitDate2` | `string` | opcional | — | — | `"texto"` |
| `discount3` | `integer` | opcional | — | — | `0` |
| `discountLimitDate3` | `string` | opcional | — | — | `"texto"` |
| `payer` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `guarantor` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `firstInstructionDebtCollection` | `string` | opcional | — | — | `"texto"` |
| `secondInstructionDebtCollection` | `integer` | opcional | — | — | `0` |
| `description` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "documentNumber": "texto",
  "numberPayments": 0,
  "latePaymentInterestAmountPerDay": 0,
  "fineTypeValue": "texto",
  "fineAmount": 1000,
  "interestTypeValue": "texto",
  "interestAmount": 1000,
  "interestCodeValue": "texto",
  "discount": 0,
  "discountLimitDate": "texto",
  "discount2": 0,
  "discountLimitDate2": "texto",
  "discount3": 0,
  "discountLimitDate3": "texto",
  "payer": {
    "name": "Fulano de Tal",
    "zipCode": "01310930",
    "addressName": "Fulano de Tal",
    "addressNumber": "texto",
    "addressComplement": "texto",
    "email": "cliente@exemplo.com.br"
  },
  "guarantor": {
    "name": "Fulano de Tal",
    "registrationNumber": "12345678909"
  },
  "firstInstructionDebtCollection": "texto",
  "secondInstructionDebtCollection": 0,
  "description": "texto"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/api/v1/BankSlip/valor/UpdateOtherInformation" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "documentNumber": "texto",
  "numberPayments": 0,
  "latePaymentInterestAmountPerDay": 0,
  "fineTypeValue": "texto",
  "fineAmount": 1000,
  "interestTypeValue": "texto",
  "interestAmount": 1000,
  "interestCodeValue": "texto",
  "discount": 0,
  "discountLimitDate": "texto",
  "discount2": 0,
  "discountLimitDate2": "texto",
  "discount3": 0,
  "discountLimitDate3": "texto",
  "payer": {
    "name": "Fulano de Tal",
    "zipCode": "01310930",
    "addressName": "Fulano de Tal",
    "addressNumber": "texto",
    "addressComplement": "texto",
    "email": "cliente@exemplo.com.br"
  },
  "guarantor": {
    "name": "Fulano de Tal",
    "registrationNumber": "12345678909"
  },
  "firstInstructionDebtCollection": "texto",
  "secondInstructionDebtCollection": 0,
  "description": "texto"
}'
```

---

### POST /api/v1/BankSlip/{barCode}/UpdateAmount

**Método utilizado para atualizar valor do boleto** — Cria um novo registro de api.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `barCode` | path | `string` | obrigatório | código de barras | `valor` |
| `idempotence` | query | `string` | opcional | chave de idempotência | `valor` |
| `generateInstructionTransactionLine` | query | `boolean` | opcional | flag to create registry in file confirmation | `true` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `amount` | `integer (int64)` | opcional | — | — | `0` |

Exemplo:

```json
{
  "amount": 0
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/api/v1/BankSlip/valor/UpdateAmount" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 0
}'
```

---

### POST /api/v1/BankSlip/{barCode}/UpdateTags

**Método utilizado para atualizar as tags do boleto** — Cria um novo registro de api.

Método utilizado para atualizar as tags do boleto.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `barCode` | path | `string` | obrigatório | código de barras | `valor` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `tags` | `array de string` | opcional | — | — | `[ … ]` |

Exemplo:

```json
{
  "tags": [
    "texto"
  ]
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/api/v1/BankSlip/valor/UpdateTags" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "tags": [
    "texto"
  ]
}'
```

---

### POST /api/v1/BankSlip/{barCode}/Transfer

**Método utilizado para transferir um boleto especifico entre carteiras/convenios** — Cria um novo registro de api.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `barCode` | path | `string` | obrigatório | código de barras | `valor` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `toWalletCode` | `integer (int64)` | opcional | — | — | `0` |
| `toBillingSettingId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `toCommunicationSettingId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |

Exemplo:

```json
{
  "toWalletCode": 0,
  "toBillingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "toCommunicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
```

**Resposta 200**

Exemplo:

```json
"texto"
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/api/v1/BankSlip/valor/Transfer" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "toWalletCode": 0,
  "toBillingSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "toCommunicationSettingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}'
```

---

### POST /api/v1/BankSlip/TransferBatch

**Método utilizado para transferir um ou mais boletos entre carteiras/convenios** — Cria um novo registro de api.

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `barCodes` | `array de string` | opcional | — | — | `[ … ]` |
| `toWalletCode` | `integer (int64)` | opcional | — | — | `0` |

Exemplo:

```json
{
  "barCodes": [
    "texto"
  ],
  "toWalletCode": 0
}
```

**Resposta 200**

Exemplo:

```json
"texto"
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/api/v1/BankSlip/TransferBatch" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "barCodes": [
    "texto"
  ],
  "toWalletCode": 0
}'
```

---

### POST /api/v1/BankSlip/{barCode}/Cancel

**Método responsável pela baixa de um titulo específico** — Cria um novo registro de api.

Método responsável pela baixa de um titulo específico.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `barCode` | path | `string` | obrigatório | código de barras | `valor` |
| `idempotence` | query | `string` | opcional | chave de idempotência | `valor` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `cancelTypeValue` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "cancelTypeValue": "texto"
}
```

**Resposta 200**

Exemplo:

```json
true
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/api/v1/BankSlip/valor/Cancel" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "cancelTypeValue": "texto"
}'
```

---

### POST /api/v1/BankSlip/{barCode}/RegisterCanceled

**Método responsável por register um titulo cancelado** — Cria um novo registro de api.

Método responsável por register um titulo cancelado.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `barCode` | path | `string` | obrigatório | código de barras | `valor` |
| `InstructionTransactionType` | query | `string` | opcional | — | `valor` |
| `PersistConfirmationTransaction` | query | `boolean` | opcional | — | `true` |

**Resposta 200**

Exemplo:

```json
true
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/api/v1/BankSlip/valor/RegisterCanceled" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /api/v1/BankSlip/{barCode}/DebtCollection/Submit

**Método utilizado para enviar/protestar um boleto especifico para o cartório** — Cria um novo registro de api.

Método utilizado para enviar/protestar um boleto especifico para o cartório.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `barCode` | path | `string` | obrigatório | código de barras | `valor` |
| `idempotence` | query | `string` | opcional | chave de idempotência | `valor` |

**Resposta 200**

Exemplo:

```json
true
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/api/v1/BankSlip/valor/DebtCollection/Submit" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /api/v1/BankSlip/{barCode}/DebtCollection/Status

**Método utilizado para visualizar o status de cartório de um boleto especifico** — Lista e filtra registros de api.

Método utilizado para visualizar o status de cartório de um boleto especifico.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `barCode` | path | `string` | obrigatório | código de barras | `valor` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `status` | `string` | opcional | — | — | `"texto"` |
| `result` | `objeto` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "status": "texto",
  "result": "texto"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X GET "{{baseUrl}}/api/v1/BankSlip/valor/DebtCollection/Status" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /api/v1/BankSlip/{barCode}/DebtCollection/Cancel

**Método utilizado para sustar o protesto em cartório de um boleto especifico** — Cria um novo registro de api.

Método utilizado para sustar o protesto em cartório de um boleto especifico.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `barCode` | path | `string` | obrigatório | código de barras | `valor` |
| `idempotence` | query | `string` | opcional | chave de idempotência | `valor` |

**Corpo da requisição** (`application/json`)

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `walletCode` | `integer (int64)` | opcional | — | — | `0` |
| `instructionTransactionTypeValue` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "walletCode": 0,
  "instructionTransactionTypeValue": "texto"
}
```

**Resposta 200**

Exemplo:

```json
true
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `401` | Não autenticado — token ausente, inválido ou expirado. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/api/v1/BankSlip/valor/DebtCollection/Cancel" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "walletCode": 0,
  "instructionTransactionTypeValue": "texto"
}'
```

---