# Banking — Conta digital (UY3)

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

## Conta digital

Abertura, saldo, extrato e gestão da conta digital.

### GET /v1/ConfidentialityBreachReport/{bankAccountId}/GenerateBankAccountDisclosureFile

**Gera relatório quebra de sigilio - layout contas** — Lista e filtra registros de Confidentiality Breach Report.

Gera relatório quebra de sigilio - layout contas ID da conta bancária Tipo de movimentação da conta Data inicial do período (opcional, default: 30 dias atrás) Data final do período (opcional, default: hoje)

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `bankAccountId` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `accountMovement` | query | `objeto` | opcional | — | `valor` |
| `start` | query | `string (date-time)` | opcional | — | `valor` |
| `end` | query | `string (date-time)` | opcional | — | `valor` |

**Resposta 200**

Exemplo:

```json
true
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

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

---

### GET /v1/ConfidentialityBreachReport/{bankAccountId}/GenerateAccountHolderDisclosureFile

**Gera relatório quebra de sigilio - layout titulares** — Lista e filtra registros de Confidentiality Breach Report.

Gera relatório quebra de sigilio - layout titulares ID da conta bancária Tipo titular da conta Tipo pessoa investigada Tipo de cambio

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `bankAccountId` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `investigatedPerson` | query | `string` | opcional | — | `valor` |
| `holderType` | query | `objeto` | opcional | — | `valor` |
| `exchangeContract` | query | `objeto` | opcional | — | `valor` |

**Resposta 200**

Exemplo:

```json
true
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

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

---

### GET /v1/ConfidentialityBreachReport/{bankAccountId}/GenerateBankAccountStatementDisclosureFile

**Gera relatório quebra de sigilo - layout extrato de conta (Bacen)** — Lista e filtra registros de Confidentiality Breach Report.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `bankAccountId` | path | `string` | obrigatório | ID da conta bancária | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `start` | query | `string (date-time)` | opcional | Data inicial do período (opcional, default: 30 dias atrás) | `valor` |
| `end` | query | `string (date-time)` | opcional | Data final do período (opcional, default: hoje) | `valor` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `400` | Requisição inválida (validação de campos ou regra de negócio). |

**cURL**

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

---

### GET /v1/ConfidentialityBreachReport/{bankAccountId}/GenerateBankAgencyDisclosureFile

**Gera relatório quebra de sigilio - layout agencias** — Lista e filtra registros de Confidentiality Breach Report.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `bankAccountId` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `400` | Requisição inválida (validação de campos ou regra de negócio). |

**cURL**

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

---

### GET /v1/ConfidentialityBreachReport/{bankAccountId}/GenerateOrigemDestinoDisclosureFile

**Listar Confidentiality Breach Report** — Lista e filtra registros de Confidentiality Breach Report.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `bankAccountId` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `start` | query | `string (date-time)` | opcional | — | `valor` |
| `end` | query | `string (date-time)` | opcional | — | `valor` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `400` | Requisição inválida (validação de campos ou regra de negócio). |

**cURL**

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

---

### GET /v1/BankAccount

**Obter uma lista de contas bancárias** — Lista e filtra registros de Bank Account.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `F_isMasterViewer` | query | `boolean` | opcional | — | `true` |
| `searchString` | query | `string` | opcional | — | `valor` |
| `F_personName` | query | `string` | opcional | — | `valor` |
| `F_personRegistrationNumber` | query | `string` | opcional | — | `valor` |
| `F_bankCode` | query | `integer` | opcional | — | `10` |
| `F_bankIspb` | query | `integer (int64)` | opcional | — | `10` |
| `F_account` | query | `integer (int64)` | opcional | — | `10` |
| `F_agency` | query | `integer` | opcional | — | `10` |
| `F_type` | query | `objeto` | opcional | — | `valor` |
| `F_modality` | query | `objeto` | opcional | — | `valor` |
| `F_operatorPermissionLevel` | query | `objeto` | opcional | — | `valor` |
| `OrderBy` | query | `string` | opcional | — | `valor` |
| `IsDeleted` | query | `boolean` | opcional | — | `true` |
| `WithBalance` | query | `boolean` | opcional | — | `true` |
| `IsMobile` | query | `boolean` | opcional | — | `true` |
| `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` |

Detalhe de `data`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `createdAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `createdBy` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `tenant` | `string` | opcional | — | — | `"texto"` |
| `tenantDisplay` | `string` | opcional | — | — | `"texto"` |
| `updatedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `updatedBy` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `ownerUser` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `bankCode` | `integer` | opcional | — | — | `0` |
| `bankCodeDisplay` | `string` | opcional | — | — | `"texto"` |
| `bankIspb` | `integer (int64)` | opcional | — | — | `0` |
| `account` | `string` | opcional | — | — | `"texto"` |
| `agency` | `string` | opcional | — | — | `"texto"` |
| `type` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"PaymentAccount"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |
| `modality` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"NaturalCheckingAccount"` |
| `modalityDisplay` | `string` | opcional | — | — | `"texto"` |
| `quorumMinimumApproval` | `integer` | opcional | — | — | `0` |
| `externalId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `isDeleted` | `boolean` | opcional | — | — | `true` |
| `status` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"Active"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `person` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `balance` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `creditors` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `creditors`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `tenant` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "data": [
    {
      "id": "texto",
      "createdAt": "2025-08-11T13:45:00Z",
      "createdBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      },
      "tenant": "texto",
      "tenantDisplay": "texto",
      "updatedAt": "2025-08-11T13:45:00Z",
      "updatedBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupDisplay": "texto",
        "tenantDisplay": "texto"
      },
      "bankCode": 0,
      "bankCodeDisplay": "texto",
      "bankIspb": 0,
      "account": "texto",
      "agency": "texto",
      "type": "PaymentAccount",
      "typeDisplay": "texto",
      "modality": "NaturalCheckingAccount",
      "modalityDisplay": "texto",
      "quorumMinimumApproval": 0,
      "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal",
      "isDeleted": true,
      "status": "Active",
      "statusDisplay": "texto",
      "person": {
        "id": "texto",
        "createdAt": "2025-08-11T13:45:00Z",
        "createdBy": {},
        "tenant": "texto",
        "tenantDisplay": "texto",
        "updatedAt": "2025-08-11T13:45:00Z",
        "updatedBy": {},
        "ownerUser": {},
        "ownerGroup": {},
        "registrationNumber": "12345678909",
        "name": "Fulano de Tal"
      },
      "balance": {
        "currentBalance": 0,
        "blockedBalance": 0,
        "available": 0,
        "bankAccount": {}
      },
      "creditors": [
        {}
      ]
    }
  ],
  "page": 0,
  "totalPages": 0,
  "totalItems": 0
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

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

---

### GET /v1/BankAccount/{id}/Balance

**Obter saldo da conta bancária** — Lista e filtra registros de Bank Account.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `currentBalance` | `integer (int64)` | opcional | — | — | `0` |
| `blockedBalance` | `integer (int64)` | opcional | — | — | `0` |
| `available` | `integer (int64)` | opcional | — | — | `0` |
| `bankAccount` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |

Exemplo:

```json
{
  "currentBalance": 0,
  "blockedBalance": 0,
  "available": 0,
  "bankAccount": {
    "bankCode": 0,
    "bankIspb": 0,
    "bankCodeDisplay": "texto",
    "type": "PaymentAccount",
    "typeDisplay": "texto",
    "modality": "NaturalCheckingAccount",
    "modalityDisplay": "texto",
    "account": 0,
    "agency": 0,
    "personRegistrationNumber": "texto",
    "personName": "Fulano de Tal",
    "isDeleted": true,
    "status": "Active",
    "creditors": [
      {
        "id": "texto",
        "name": "Fulano de Tal",
        "tenant": "texto"
      }
    ]
  }
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

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

---

### GET /v1/BankAccount/{id}/Statement

**Obter informações de extrato da conta** — Lista e filtra registros de Bank Account.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string` | obrigatório | ID da Conta Digital. Formato: GUID | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `initialDate` | query | `string (date-time)` | opcional | [DEPRECADO] Usar from | `valor` |
| `finalDate` | query | `string (date-time)` | opcional | [DEPRECADO] Usar to | `valor` |
| `from` | query | `string (date)` | opcional | Data inicial | `valor` |
| `to` | query | `string (date)` | opcional | Data final | `valor` |
| `size` | query | `integer` | opcional | Quantidade de lançamentos que devem ser retornados. Máximo: 500. Padrão: 10 | `10` |
| `page` | query | `integer` | opcional | Página atual que deve ser retornada. Padrão: 0 | `10` |
| `statementDateType` | query | `objeto` | opcional | Tipo de data que deve ser usada. | `OccurrenceDate` |
| `orderBy` | query | `string` | opcional | — | `valor` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `issueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `balances` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `balances`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `issueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `availableValue` | `integer (int64)` | opcional | — | — | `0` |
| `initialValue` | `integer (int64)` | opcional | — | — | `0` |
| `transactions` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `transactions`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `issueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `accountingDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `description` | `string` | opcional | — | — | `"texto"` |
| `id` | `integer (int64)` | opcional | — | — | `1` |
| `movement` | `string` | opcional | — | `DEBITO`, `CREDITO` | `"DEBITO"` |
| `movementDisplay` | `string` | opcional | — | — | `"texto"` |
| `document` | `string` | opcional | — | — | `"12345678909"` |
| `information` | `string` | opcional | — | — | `"texto"` |
| `amount` | `integer (int64)` | opcional | — | — | `0` |
| `reversed` | `boolean` | opcional | — | — | `true` |
| `counterpart` | `string` | opcional | — | — | `"texto"` |
| `balancerAfter` | `integer (int64)` | opcional | — | — | `0` |

Exemplo:

```json
{
  "issueDate": "2025-08-11T13:45:00Z",
  "balances": [
    {
      "issueDate": "2025-08-11T13:45:00Z",
      "availableValue": 0,
      "initialValue": 0,
      "transactions": [
        {}
      ]
    }
  ]
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

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

---

### POST /v1/BankAccount/{id}/Statement

**Gerar extrato em pdf** — Cria um novo registro de Bank Account.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `initialDate` | query | `string (date-time)` | opcional | — | `valor` |
| `finalDate` | query | `string (date-time)` | opcional | — | `valor` |
| `from` | query | `string (date)` | opcional | — | `valor` |
| `to` | query | `string (date)` | opcional | — | `valor` |
| `statementDateType` | query | `objeto` | opcional | — | `OccurrenceDate` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

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

---

### POST /v1/BankAccount/{id}/StatementOfx

**Gerar extrato em ofx** — Cria um novo registro de Bank Account.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `initialDate` | query | `string (date)` | opcional | — | `valor` |
| `finalDate` | query | `string (date)` | opcional | — | `valor` |
| `statementDateType` | query | `objeto` | opcional | — | `OccurrenceDate` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

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

---

### POST /v1/BankAccount/{id}/StatementSpreadsheet

**Gerar planilha de extrato arquivo csv** — Cria um novo registro de Bank Account.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `initialDate` | query | `string (date-time)` | opcional | — | `valor` |
| `finalDate` | query | `string (date-time)` | opcional | — | `valor` |
| `from` | query | `string (date)` | opcional | — | `valor` |
| `to` | query | `string (date)` | opcional | — | `valor` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

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

---

### GET /v1/BankAccount/{id}/IncomeTax

**Obter a declaração de imposto de renda do ano anterior** — Lista e filtra registros de Bank Account.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

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

---

### POST /v1/BankAccount/{id}/Terminate

**Encerrar conta bancária** — Cria um novo registro de Bank Account.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string` | obrigatório | Id da conta bancária | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

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

Campos:

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

Exemplo:

```json
{
  "reason": "texto"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `204` | Sucesso sem corpo de resposta. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Terminate" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "texto"
}'
```

---

### POST /v1/BankAccount/{id}/Assign

**Atribui conta bancária a um outro correspondente ou grupo** — Cria um novo registro de Bank Account.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string` | obrigatório | Id da conta | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `userId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `groupName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `tenant` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "groupName": "Fulano de Tal",
  "tenant": "texto"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `400` | Requisição inválida (validação de campos ou regra de negócio). |
| `401` | Não autenticado — token ausente, inválido ou expirado. |
| `403` | Autenticado, mas sem permissão para o recurso. |
| `404` | Recurso não encontrado. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Assign" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "groupName": "Fulano de Tal",
  "tenant": "texto"
}'
```

---

### GET /v1/BankAccount/{bankAccountId}/PendingFees

**Obter as tarifas pendentes por número de conta** — Lista e filtra registros de Bank Account.

Obter as tarifas pendentes por número de conta.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `bankAccountId` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `pendingFees` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `hasItems` | `boolean` | opcional | — | — | `true` |

Detalhe de `pendingFees`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `count` | `integer` | opcional | — | — | `0` |
| `serviceCode` | `integer` | opcional | — | — | `0` |
| `serviceName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `amountToCharge` | `integer (int64)` | opcional | — | — | `0` |
| `totalAmountToCharge` | `integer (int64)` | opcional | — | — | `0` |

Exemplo:

```json
{
  "pendingFees": [
    {
      "count": 0,
      "serviceCode": 0,
      "serviceName": "Fulano de Tal",
      "amountToCharge": 0,
      "totalAmountToCharge": 0
    }
  ],
  "hasItems": true
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `400` | Requisição inválida (validação de campos ou regra de negócio). |
| `403` | Autenticado, mas sem permissão para o recurso. |

**cURL**

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

---

### GET /v1/BankAccount/Account/Banks

**Lista bancos com paginação, busca por vários campos e ordenação** — Lista e filtra registros de Bank Account.

Lista bancos com paginação, busca por vários campos e ordenação.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `page` | query | `integer` | opcional | Página 0-based | `10` |
| `size` | query | `integer` | opcional | Tamanho da página | `10` |
| `searchString` | query | `string` | opcional | Busca aplicada em Ispb, Code e Name. Opcional. | `valor` |
| `orderBy` | query | `string` | opcional | Ex.: "Name asc", "Code desc", "Ispb asc". Opcional. | `valor` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `page` | `integer` | opcional | — | — | `0` |
| `size` | `integer` | opcional | — | — | `0` |
| `total` | `integer` | opcional | — | — | `0` |
| `items` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `items`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ispb` | `integer (int64)` | opcional | — | — | `0` |
| `code` | `integer` | opcional | — | — | `0` |
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |

Exemplo:

```json
{
  "page": 0,
  "size": 0,
  "total": 0,
  "items": [
    {
      "ispb": 0,
      "code": 0,
      "name": "Fulano de Tal"
    }
  ]
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X GET "{{baseUrl}}/v1/BankAccount/Account/Banks" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /v1/BankAccount/{id}/ReverseAccountingEntry/{sequenceEntry}

**Realizar estorno de lançamento contábil pelo SequenceEntry** — Executa a operação Reverse Accounting Entry sobre Bank Account.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string` | obrigatório | Id da conta bancária | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `sequenceEntry` | path | `integer (int64)` | obrigatório | SequenceEntry do lançamento a ser estornado | `10` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `idempotencyId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `accountEntryId` | `integer (int64)` | opcional | — | — | `1` |
| `sitRequestId` | `integer` | opcional | — | — | `1` |

Exemplo:

```json
{
  "idempotencyId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "accountEntryId": 1,
  "sitRequestId": 1
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/ReverseAccountingEntry/valor" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /v1/BankAccount/{id}/Reactivate

**Reativar conta bancária somente UYZY** — Cria um novo registro de Bank Account.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `204` | Sucesso sem corpo de resposta. |

**cURL**

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

---

### GET /v1/BankAccount/{id}/Approvals

**Obter uma solicitação de aprovação** — Lista e filtra registros de Bank Account.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string` | obrigatório | ID da solicitação | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `approvalType` | query | `string` | opcional | Tipo de aprovação | `valor` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `bankAccountPayment` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `bankAccountPaymentId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `bankAccountBeneficiary` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `bankAccountBeneficiaryId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `bankAccountTransfer` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `bankAccountTransferId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `bankAccountUser` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `bankAccountUserId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `bankAccountTransactionLimits` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `bankAccountTransactionEffectiveLimits` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |

Exemplo:

```json
{
  "bankAccountPayment": {
    "id": "texto",
    "createdAt": "2025-08-11T13:45:00Z",
    "createdBy": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenantName": "Fulano de Tal"
    },
    "tenant": "texto",
    "tenantDisplay": "texto",
    "updatedAt": "2025-08-11T13:45:00Z",
    "updatedBy": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenantName": "Fulano de Tal"
    },
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupDisplay": "texto",
      "tenantDisplay": "texto"
    },
    "barCode": "texto",
    "nsu": "texto",
    "amount": 0,
    "date": "2025-08-11T13:45:00Z",
    "dueDate": "2025-08-11T13:45:00Z",
    "paymentPurpose": "PagamentoDeImpostosTributosETaxas",
    "paymentPurposeDisplay": "texto",
    "status": "Approved",
    "paymentTaxesType": "TributosCodigoBarra",
    "statusDisplay": "texto",
    "errorMessage": "texto",
    "authorizedAt": "2025-08-11T13:45:00Z",
    "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "requester": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenantName": "Fulano de Tal"
    },
    "approvals": [
      {
        "level": {},
        "action": {},
        "actionDisplay": "texto",
        "user": {}
      }
    ]
  },
  "bankAccountPaymentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "bankAccountBeneficiary": {
    "id": "texto",
    "createdAt": "2025-08-11T13:45:00Z",
    "createdBy": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenantName": "Fulano de Tal"
    },
    "tenant": "texto",
    "tenantDisplay": "texto",
    "updatedAt": "2025-08-11T13:45:00Z",
    "updatedBy": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenantName": "Fulano de Tal"
    },
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupDisplay": "texto",
      "tenantDisplay": "texto"
    },
    "name": "Fulano de Tal",
    "registrationNumber": "12345678909",
    "bank": 0,
    "bankIspb": 0,
    "bankDisplay": "texto",
    "agency": 0,
    "accountNumber": "texto",
    "tenantName": "Fulano de Tal",
    "accountType": "NaturalCheckingAccount",
    "accountTypeDisplay": "texto",
    "status": "Approved",
    "statusDisplay": "texto",
    "operationTypeValue": "Transfer",
    "operationTypeValueDisplay": "texto",
    "pixKeyTypeValue": "NaturalRegistrationNumber",
    "pixKeyTypeValueDisplay": "texto",
    "keyPix": "texto",
    "authorizedAt": "2025-08-11T13:45:00Z",
    "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "requester": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenantName": "Fulano de Tal"
    },
    "approvals": [
      {
        "level": {},
        "action": {},
        "actionDisplay": "texto",
        "user": {}
      }
    ]
  },
  "bankAccountBeneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "bankAccountTransfer": {
    "id": "texto",
    "createdAt": "2025-08-11T13:45:00Z",
    "createdBy": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenantName": "Fulano de Tal"
    },
    "tenant": "texto",
    "tenantDisplay": "texto",
    "updatedAt": "2025-08-11T13:45:00Z",
    "updatedBy": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenantName": "Fulano de Tal"
    },
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupDisplay": "texto",
      "tenantDisplay": "texto"
    },
    "nsu": "texto",
    "amount": 0,
    "transferDate": "2025-08-11T13:45:00Z",
    "paymentPurpose": "PagamentoDeImpostosTributosETaxas",
    "paymentPurposeDisplay": "texto",
    "status": "Approved",
    "statusDisplay": "texto",
    "accountingEntry": "texto",
    "errorMessage": "texto",
    "reversalCodeReason": "texto",
    "reversalDescriptionReason": "texto",
    "bankAccountBeneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bankAccountBeneficiary": {
      "id": "texto",
      "createdAt": "2025-08-11T13:45:00Z",
      "createdBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      },
      "tenant": "texto",
      "tenantDisplay": "texto",
      "updatedAt": "2025-08-11T13:45:00Z",
      "updatedBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupDisplay": "texto",
        "tenantDisplay": "texto"
      },
      "name": "Fulano de Tal",
      "registrationNumber": "12345678909",
      "bank": 0,
      "bankIspb": 0,
      "bankDisplay": "texto",
      "agency": 0,
      "accountNumber": "texto",
      "tenantName": "Fulano de Tal",
      "accountType": "NaturalCheckingAccount",
      "accountTypeDisplay": "texto",
      "status": "Approved",
      "statusDisplay": "texto",
      "operationTypeValue": "Transfer",
      "operationTypeValueDisplay": "texto",
      "pixKeyTypeValue": "NaturalRegistrationNumber",
      "pixKeyTypeValueDisplay": "texto",
      "keyPix": "texto",
      "authorizedAt": "2025-08-11T13:45:00Z",
      "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "requester": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      },
      "approvals": [
        {}
      ]
    },
    "authorizedAt": "2025-08-11T13:45:00Z",
    "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "requester": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenantName": "Fulano de Tal"
    },
    "approvals": [
      {
        "level": {},
        "action": {},
        "actionDisplay": "texto",
        "user": {}
      }
    ]
  },
  "bankAccountTransferId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "bankAccountUser": {
    "id": "texto",
    "createdAt": "2025-08-11T13:45:00Z",
    "createdBy": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenantName": "Fulano de Tal"
    },
    "tenant": "texto",
    "tenantDisplay": "texto",
    "updatedAt": "2025-08-11T13:45:00Z",
    "updatedBy": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenantName": "Fulano de Tal"
    },
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupDisplay": "texto",
      "tenantDisplay": "texto"
    },
    "user": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenantName": "Fulano de Tal"
    },
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "level": "texto",
    "levelDisplay": "texto",
    "status": "texto",
    "statusDisplay": "texto",
    "isDeleted": true,
    "authorizedAt": "2025-08-11T13:45:00Z",
    "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "accountNumber": 0,
    "ownerNameAccount": "Fulano de Tal",
    "ownerAccountType": "texto",
    "bankAccountRequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "registrationNumber": "12345678909",
    "approvals": [
      {
        "level": {},
        "action": {},
        "actionDisplay": "texto",
        "user": {}
      }
    ]
  },
  "bankAccountUserId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "bankAccountTransactionLimits": {
    "id": "texto",
    "createdAt": "2025-08-11T13:45:00Z",
    "createdBy": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenantName": "Fulano de Tal"
    },
    "tenant": "texto",
    "tenantDisplay": "texto",
    "updatedAt": "2025-08-11T13:45:00Z",
    "updatedBy": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenantName": "Fulano de Tal"
    },
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupDisplay": "texto",
      "tenantDisplay": "texto"
    },
    "bankAccount": {
      "id": "texto",
      "createdAt": "2025-08-11T13:45:00Z",
      "createdBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      },
      "tenant": "texto",
      "tenantDisplay": "texto",
      "updatedAt": "2025-08-11T13:45:00Z",
      "updatedBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupDisplay": "texto",
        "tenantDisplay": "texto"
      },
      "bankCode": 0,
      "bankCodeDisplay": "texto",
      "bankIspb": 0,
      "account": "texto",
      "agency": "texto",
      "type": "PaymentAccount",
      "typeDisplay": "texto",
      "modality": "NaturalCheckingAccount",
      "modalityDisplay": "texto",
      "quorumMinimumApproval": 0,
      "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal",
      "isDeleted": true,
      "status": "Active",
      "statusDisplay": "texto",
      "person": {
        "id": "texto",
        "createdAt": "2025-08-11T13:45:00Z",
        "createdBy": {},
        "tenant": "texto",
        "tenantDisplay": "texto",
        "updatedAt": "2025-08-11T13:45:00Z",
        "updatedBy": {},
        "ownerUser": {},
        "ownerGroup": {},
        "registrationNumber": "12345678909",
        "name": "Fulano de Tal"
      },
      "balance": {
        "currentBalance": 0,
        "blockedBalance": 0,
        "available": 0,
        "bankAccount": {}
      },
      "creditors": [
        {}
      ]
    },
    "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "pixLimit": {
      "businessHours": {
        "valueInCentsOwnOwnership": 0,
        "valueInCentsNaturalPerson": 0,
        "valueInCentsLegalPerson": 0
      },
      "nonBusinessHours": {
        "valueInCentsOwnOwnership": 0,
        "valueInCentsNaturalPerson": 0,
        "valueInCentsLegalPerson": 0
      }
    },
    "bankSlipLimit": {
      "businessHours": {
        "valueInCentsOwnOwnership": 0,
        "valueInCentsNaturalPerson": 0,
        "valueInCentsLegalPerson": 0
      },
      "nonBusinessHours": {
        "valueInCentsOwnOwnership": 0,
        "valueInCentsNaturalPerson": 0,
        "valueInCentsLegalPerson": 0
      }
    },
    "transferLimit": {
      "businessHours": {
        "valueInCentsOwnOwnership": 0,
        "valueInCentsNaturalPerson": 0,
        "valueInCentsLegalPerson": 0
      },
      "nonBusinessHours": {
        "valueInCentsOwnOwnership": 0,
        "valueInCentsNaturalPerson": 0,
        "valueInCentsLegalPerson": 0
      }
    },
    "tedLimit": {
      "businessHours": {
        "valueInCentsOwnOwnership": 0,
        "valueInCentsNaturalPerson": 0,
        "valueInCentsLegalPerson": 0
      },
      "nonBusinessHours": {
        "valueInCentsOwnOwnership": 0,
        "valueInCentsNaturalPerson": 0,
        "valueInCentsLegalPerson": 0
      }
    },
    "uploads": [
      {
        "id": "texto",
        "createdAt": "2025-08-11T13:45:00Z",
        "createdBy": {},
        "tenant": "texto",
        "tenantDisplay": "texto",
        "updatedAt": "2025-08-11T13:45:00Z",
        "updatedBy": {},
        "ownerUser": {},
        "ownerGroup": {},
        "fileName": "Fulano de Tal",
        "fileType": "texto",
        "displayName": "Fulano de Tal",
        "tempUrl": "https://exemplo.com.br/callback",
        "tempGetUrl": "https://exemplo.com.br/callback",
        "tempPutUrl": "https://exemplo.com.br/callback"
      }
    ]
  },
  "bankAccountTransactionEffectiveLimits": {
    "id": "texto",
    "createdAt": "2025-08-11T13:45:00Z",
    "createdBy": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenantName": "Fulano de Tal"
    },
    "tenant": "texto",
    "tenantDisplay": "texto",
    "updatedAt": "2025-08-11T13:45:00Z",
    "updatedBy": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenantName": "Fulano de Tal"
    },
    "ownerUser": {
      "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "registrationNumber": "12345678909",
      "userIdDisplay": "texto",
      "tenantDisplay": "texto",
      "tenantName": "Fulano de Tal"
    },
    "ownerGroup": {
      "groupDisplay": "texto",
      "tenantDisplay": "texto"
    },
    "bankAccount": {
      "id": "texto",
      "createdAt": "2025-08-11T13:45:00Z",
      "createdBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      },
      "tenant": "texto",
      "tenantDisplay": "texto",
      "updatedAt": "2025-08-11T13:45:00Z",
      "updatedBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupDisplay": "texto",
        "tenantDisplay": "texto"
      },
      "bankCode": 0,
      "bankCodeDisplay": "texto",
      "bankIspb": 0,
      "account": "texto",
      "agency": "texto",
      "type": "PaymentAccount",
      "typeDisplay": "texto",
      "modality": "NaturalCheckingAccount",
      "modalityDisplay": "texto",
      "quorumMinimumApproval": 0,
      "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "tenantName": "Fulano de Tal",
      "isDeleted": true,
      "status": "Active",
      "statusDisplay": "texto",
      "person": {
        "id": "texto",
        "createdAt": "2025-08-11T13:45:00Z",
        "createdBy": {},
        "tenant": "texto",
        "tenantDisplay": "texto",
        "updatedAt": "2025-08-11T13:45:00Z",
        "updatedBy": {},
        "ownerUser": {},
        "ownerGroup": {},
        "registrationNumber": "12345678909",
        "name": "Fulano de Tal"
      },
      "balance": {
        "currentBalance": 0,
        "blockedBalance": 0,
        "available": 0,
        "bankAccount": {}
      },
      "creditors": [
        {}
      ]
    },
    "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "pixLimit": {
      "businessHours": {
        "valueInCentsOwnOwnership": 0,
        "valueInCentsNaturalPerson": 0,
        "valueInCentsLegalPerson": 0
      },
      "nonBusinessHours": {
        "valueInCentsOwnOwnership": 0,
        "valueInCentsNaturalPerson": 0,
        "valueInCentsLegalPerson": 0
      }
    },
    "bankSlipLimit": {
      "businessHours": {
        "valueInCentsOwnOwnership": 0,
        "valueInCentsNaturalPerson": 0,
        "valueInCentsLegalPerson": 0
      },
      "nonBusinessHours": {
        "valueInCentsOwnOwnership": 0,
        "valueInCentsNaturalPerson": 0,
        "valueInCentsLegalPerson": 0
      }
    },
    "transferLimit": {
      "businessHours": {
        "valueInCentsOwnOwnership": 0,
        "valueInCentsNaturalPerson": 0,
        "valueInCentsLegalPerson": 0
      },
      "nonBusinessHours": {
        "valueInCentsOwnOwnership": 0,
        "valueInCentsNaturalPerson": 0,
        "valueInCentsLegalPerson": 0
      }
    },
    "tedLimit": {
      "businessHours": {
        "valueInCentsOwnOwnership": 0,
        "valueInCentsNaturalPerson": 0,
        "valueInCentsLegalPerson": 0
      },
      "nonBusinessHours": {
        "valueInCentsOwnOwnership": 0,
        "valueInCentsNaturalPerson": 0,
        "valueInCentsLegalPerson": 0
      }
    },
    "uploads": [
      {
        "id": "texto",
        "createdAt": "2025-08-11T13:45:00Z",
        "createdBy": {},
        "tenant": "texto",
        "tenantDisplay": "texto",
        "updatedAt": "2025-08-11T13:45:00Z",
        "updatedBy": {},
        "ownerUser": {},
        "ownerGroup": {},
        "fileName": "Fulano de Tal",
        "fileType": "texto",
        "displayName": "Fulano de Tal",
        "tempUrl": "https://exemplo.com.br/callback",
        "tempGetUrl": "https://exemplo.com.br/callback",
        "tempPutUrl": "https://exemplo.com.br/callback"
      }
    ]
  }
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

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

---

### POST /v1/BankAccount/AutomaticSplit/Operation

**Criar Bank Account** — Cria um novo registro de Bank Account.

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `escrowBankAccountId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `borrowerBeneficiaryId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `creditors` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `principalAmount` | `integer (int64)` | opcional | — | — | `0` |
| `installmentsCount` | `integer` | opcional | — | — | `0` |
| `dueDateType` | `string` | opcional | — | `Fixed`, `Dynamic` | `"Fixed"` |
| `installmentType` | `string` | opcional | — | `Fixed`, `Dynamic` | `"Fixed"` |
| `firstDueDate` | `string (date)` | opcional | — | — | `"2025-08-11"` |
| `guaranteePercentOverPMT` | `number (decimal)` | opcional | — | — | `1.99` |
| `interestPercent` | `number (decimal)` | opcional | — | — | `1.99` |
| `finePercent` | `number (decimal)` | opcional | — | — | `1.99` |
| `borrowerTransferAuthorized` | `boolean` | opcional | — | — | `true` |
| `borrowerTransferSameDay` | `boolean` | opcional | — | — | `true` |
| `borrowerTransferDayOfMonth` | `integer` | opcional | — | — | `0` |
| `acceptPartialInstallment` | `boolean` | opcional | — | — | `true` |
| `active` | `boolean` | opcional | — | — | `true` |
| `planOverride` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `creditors`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `beneficiaryId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `proportion` | `number (decimal)` | opcional | — | — | `1000` |
| `active` | `boolean` | opcional | — | — | `true` |

Detalhe de `planOverride`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `number` | `integer` | opcional | — | — | `0` |
| `dueDate` | `string (date)` | opcional | — | — | `"2025-08-11"` |
| `amount` | `integer (int64)` | opcional | — | — | `0` |

Exemplo:

```json
{
  "escrowBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "borrowerBeneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "creditors": [
    {
      "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "proportion": 1000,
      "active": true
    }
  ],
  "principalAmount": 0,
  "installmentsCount": 0,
  "dueDateType": "Fixed",
  "installmentType": "Fixed",
  "firstDueDate": "2025-08-11",
  "guaranteePercentOverPMT": 1.99,
  "interestPercent": 1.99,
  "finePercent": 1.99,
  "borrowerTransferAuthorized": true,
  "borrowerTransferSameDay": true,
  "borrowerTransferDayOfMonth": 0,
  "acceptPartialInstallment": true,
  "active": true,
  "planOverride": [
    {
      "number": 0,
      "dueDate": "2025-08-11",
      "amount": 0
    }
  ]
}
```

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `code` | `string` | opcional | — | — | `"texto"` |
| `status` | `string` | opcional | — | `Active`, `Closed`, `Inactive`, `Cancelled` | `"Active"` |
| `generatedPlan` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `generatedPlan`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `number` | `integer` | opcional | — | — | `0` |
| `dueDate` | `string (date)` | opcional | — | — | `"2025-08-11"` |
| `amount` | `number (decimal)` | opcional | — | — | `1000` |

Exemplo:

```json
{
  "id": "texto",
  "code": "texto",
  "status": "Active",
  "generatedPlan": [
    {
      "number": 0,
      "dueDate": "2025-08-11",
      "amount": 1000
    }
  ]
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `400` | Requisição inválida (validação de campos ou regra de negócio). |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/BankAccount/AutomaticSplit/Operation" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "escrowBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "borrowerBeneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "creditors": [
    {
      "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "proportion": 1000,
      "active": true
    }
  ],
  "principalAmount": 0,
  "installmentsCount": 0,
  "dueDateType": "Fixed",
  "installmentType": "Fixed",
  "firstDueDate": "2025-08-11",
  "guaranteePercentOverPMT": 1.99,
  "interestPercent": 1.99,
  "finePercent": 1.99,
  "borrowerTransferAuthorized": true,
  "borrowerTransferSameDay": true,
  "borrowerTransferDayOfMonth": 0,
  "acceptPartialInstallment": true,
  "active": true,
  "planOverride": [
    {
      "number": 0,
      "dueDate": "2025-08-11",
      "amount": 0
    }
  ]
}'
```

---

### GET /v1/BankAccount/AutomaticSplit/Operation/{operationId}

**Consultar Bank Account** — Consulta Bank Account pelo identificador informado na rota.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `operationId` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `code` | `string` | opcional | — | — | `"texto"` |
| `escrowBankAccountId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `borrowerBeneficiaryId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `principalAmount` | `integer (int64)` | opcional | — | — | `0` |
| `installmentsCount` | `integer` | opcional | — | — | `0` |
| `dueDateType` | `integer` | opcional | — | — | `0` |
| `installmentType` | `integer` | opcional | — | — | `0` |
| `firstDueDate` | `string (date)` | opcional | — | — | `"2025-08-11"` |
| `guaranteePercentOverPMT` | `number (decimal)` | opcional | — | — | `1.99` |
| `interestPercent` | `number (decimal)` | opcional | — | — | `1.99` |
| `finePercent` | `number (decimal)` | opcional | — | — | `1.99` |
| `acceptPartialInstallment` | `boolean` | opcional | — | — | `true` |
| `borrowerTransferAuthorized` | `boolean` | opcional | — | — | `true` |
| `borrowerTransferSameDay` | `boolean` | opcional | — | — | `true` |
| `borrowerTransferDayOfMonth` | `integer` | opcional | — | — | `0` |
| `timezone` | `string` | opcional | — | — | `"texto"` |
| `status` | `integer` | opcional | — | — | `0` |
| `createdAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `borrower` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `creditors` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `installments` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `escrow` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |

Detalhe de `borrower`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `taxId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `ispb` | `integer (int64)` | opcional | — | — | `0` |
| `agency` | `string` | opcional | — | — | `"texto"` |
| `account` | `string` | opcional | — | — | `"texto"` |
| `pixKey` | `string` | opcional | — | — | `"texto"` |
| `pixKeyTypeValueDisplay` | `string` | opcional | — | — | `"texto"` |
| `transferAuthorized` | `boolean` | opcional | — | — | `true` |
| `payoutRail` | `string` | opcional | — | `PIX`, `TED` | `"PIX"` |
| `bankName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `bankCode` | `integer` | opcional | — | — | `0` |
| `beneficiaryIdPIX` | `string` | opcional | — | — | `"texto"` |
| `beneficiaryIdTED` | `string` | opcional | — | — | `"texto"` |

Detalhe de `creditors`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `taxId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `proportion` | `number (decimal)` | opcional | — | — | `1000` |
| `order` | `integer` | opcional | — | — | `0` |
| `active` | `boolean` | opcional | — | — | `true` |
| `ispb` | `integer (int64)` | opcional | — | — | `0` |
| `agency` | `string` | opcional | — | — | `"texto"` |
| `account` | `string` | opcional | — | — | `"texto"` |
| `pixKey` | `string` | opcional | — | — | `"texto"` |
| `pixKeyTypeValueDisplay` | `string` | opcional | — | — | `"texto"` |
| `payoutRail` | `string` | opcional | — | `PIX`, `TED` | `"PIX"` |
| `bankCode` | `integer` | opcional | — | — | `0` |
| `bankName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `beneficiaryIdPIX` | `string` | opcional | — | — | `"texto"` |
| `beneficiaryIdTED` | `string` | opcional | — | — | `"texto"` |

Detalhe de `installments`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `number` | `integer` | opcional | — | — | `0` |
| `dueDate` | `string (date)` | opcional | — | — | `"2025-08-11"` |
| `amount` | `integer (int64)` | opcional | — | — | `0` |
| `paidAmount` | `integer (int64)` | opcional | — | — | `1` |
| `status` | `integer` | opcional | — | — | `0` |
| `interestAccrued` | `integer (int64)` | opcional | — | — | `0` |
| `fineAccrued` | `integer (int64)` | opcional | — | — | `0` |
| `paymentDate` | `string (date)` | opcional | — | — | `"2025-08-11"` |
| `bankAccountTransfers` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `bankAccountTransfers`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `createdAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `createdBy` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `tenant` | `string` | opcional | — | — | `"texto"` |
| `tenantDisplay` | `string` | opcional | — | — | `"texto"` |
| `updatedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `updatedBy` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `ownerUser` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `nsu` | `string` | opcional | — | — | `"texto"` |
| `amount` | `integer (int64)` | opcional | — | — | `0` |
| `transferDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `paymentPurpose` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"PagamentoDeImpostosTributosETaxas"` |
| `paymentPurposeDisplay` | `string` | opcional | — | — | `"texto"` |
| `status` | `string` | opcional | — | `Approved`, `Pending`, `Rejected`, `Timeout`, `Canceled`, `Error`, `Processing`, `Finished`, `Scheduled`, `Reversed`, `ComplianceApproval`, `CancellationRequested` | `"Approved"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `accountingEntry` | `string` | opcional | — | — | `"texto"` |
| `errorMessage` | `string` | opcional | — | — | `"texto"` |
| `reversalCodeReason` | `string` | opcional | — | — | `"texto"` |
| `reversalDescriptionReason` | `string` | opcional | — | — | `"texto"` |
| `bankAccountBeneficiaryId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `bankAccountBeneficiary` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `authorizedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `bankAccountId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `requester` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `approvals` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `approvals`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `level` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"Viewer"` |
| `action` | `string` | opcional | — | `Approve`, `Reject`, `Cancel` | `"Approve"` |
| `actionDisplay` | `string` | opcional | — | — | `"texto"` |
| `user` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |

Exemplo:

```json
{
  "id": "texto",
  "code": "texto",
  "escrowBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "borrowerBeneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "principalAmount": 0,
  "installmentsCount": 0,
  "dueDateType": 0,
  "installmentType": 0,
  "firstDueDate": "2025-08-11",
  "guaranteePercentOverPMT": 1.99,
  "interestPercent": 1.99,
  "finePercent": 1.99,
  "acceptPartialInstallment": true,
  "borrowerTransferAuthorized": true,
  "borrowerTransferSameDay": true,
  "borrowerTransferDayOfMonth": 0,
  "timezone": "texto",
  "status": 0,
  "createdAt": "2025-08-11T13:45:00Z",
  "borrower": {
    "name": "Fulano de Tal",
    "taxId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "ispb": 0,
    "agency": "texto",
    "account": "texto",
    "pixKey": "texto",
    "pixKeyTypeValueDisplay": "texto",
    "transferAuthorized": true,
    "payoutRail": "PIX",
    "bankName": "Fulano de Tal",
    "bankCode": 0,
    "beneficiaryIdPIX": "texto",
    "beneficiaryIdTED": "texto"
  },
  "creditors": [
    {
      "id": "texto",
      "name": "Fulano de Tal",
      "taxId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "proportion": 1000,
      "order": 0,
      "active": true,
      "ispb": 0,
      "agency": "texto",
      "account": "texto",
      "pixKey": "texto",
      "pixKeyTypeValueDisplay": "texto",
      "payoutRail": "PIX",
      "bankCode": 0,
      "bankName": "Fulano de Tal",
      "beneficiaryIdPIX": "texto",
      "beneficiaryIdTED": "texto"
    }
  ],
  "installments": [
    {
      "id": "texto",
      "number": 0,
      "dueDate": "2025-08-11",
      "amount": 0,
      "paidAmount": 1,
      "status": 0,
      "interestAccrued": 0,
      "fineAccrued": 0,
      "paymentDate": "2025-08-11",
      "bankAccountTransfers": [
        {}
      ]
    }
  ],
  "escrow": {
    "bankCode": 0,
    "agency": 0,
    "accountNumber": 0,
    "bankName": "Fulano de Tal",
    "ispb": 0
  }
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `404` | Recurso não encontrado. |

**cURL**

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

---

### PUT /v1/BankAccount/AutomaticSplit/Operation/{operationId}

**Atualiza uma operação de AutomaticSplit por substituição completa dos dados** — Atualiza por completo um registro de Bank Account existente.

Atualiza uma operação de AutomaticSplit por substituição completa dos dados. Id da operação somente na rota. Body = mesmo DTO do Create.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `operationId` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `escrowBankAccountId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `borrowerBeneficiaryId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `creditors` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `principalAmount` | `integer (int64)` | opcional | — | — | `0` |
| `installmentsCount` | `integer` | opcional | — | — | `0` |
| `dueDateType` | `string` | opcional | — | `Fixed`, `Dynamic` | `"Fixed"` |
| `installmentType` | `string` | opcional | — | `Fixed`, `Dynamic` | `"Fixed"` |
| `firstDueDate` | `string (date)` | opcional | — | — | `"2025-08-11"` |
| `guaranteePercentOverPMT` | `number (decimal)` | opcional | — | — | `1.99` |
| `interestPercent` | `number (decimal)` | opcional | — | — | `1.99` |
| `finePercent` | `number (decimal)` | opcional | — | — | `1.99` |
| `borrowerTransferAuthorized` | `boolean` | opcional | — | — | `true` |
| `borrowerTransferSameDay` | `boolean` | opcional | — | — | `true` |
| `borrowerTransferDayOfMonth` | `integer` | opcional | — | — | `0` |
| `acceptPartialInstallment` | `boolean` | opcional | — | — | `true` |
| `active` | `boolean` | opcional | — | — | `true` |
| `planOverride` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `creditors`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `beneficiaryId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `proportion` | `number (decimal)` | opcional | — | — | `1000` |
| `active` | `boolean` | opcional | — | — | `true` |

Detalhe de `planOverride`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `number` | `integer` | opcional | — | — | `0` |
| `dueDate` | `string (date)` | opcional | — | — | `"2025-08-11"` |
| `amount` | `integer (int64)` | opcional | — | — | `0` |

Exemplo:

```json
{
  "escrowBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "borrowerBeneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "creditors": [
    {
      "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "proportion": 1000,
      "active": true
    }
  ],
  "principalAmount": 0,
  "installmentsCount": 0,
  "dueDateType": "Fixed",
  "installmentType": "Fixed",
  "firstDueDate": "2025-08-11",
  "guaranteePercentOverPMT": 1.99,
  "interestPercent": 1.99,
  "finePercent": 1.99,
  "borrowerTransferAuthorized": true,
  "borrowerTransferSameDay": true,
  "borrowerTransferDayOfMonth": 0,
  "acceptPartialInstallment": true,
  "active": true,
  "planOverride": [
    {
      "number": 0,
      "dueDate": "2025-08-11",
      "amount": 0
    }
  ]
}
```

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `code` | `string` | opcional | — | — | `"texto"` |
| `escrowBankAccountId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `borrowerBeneficiaryId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `principalAmount` | `integer (int64)` | opcional | — | — | `0` |
| `installmentsCount` | `integer` | opcional | — | — | `0` |
| `dueDateType` | `integer` | opcional | — | — | `0` |
| `installmentType` | `integer` | opcional | — | — | `0` |
| `firstDueDate` | `string (date)` | opcional | — | — | `"2025-08-11"` |
| `guaranteePercentOverPMT` | `number (decimal)` | opcional | — | — | `1.99` |
| `interestPercent` | `number (decimal)` | opcional | — | — | `1.99` |
| `finePercent` | `number (decimal)` | opcional | — | — | `1.99` |
| `acceptPartialInstallment` | `boolean` | opcional | — | — | `true` |
| `borrowerTransferAuthorized` | `boolean` | opcional | — | — | `true` |
| `borrowerTransferSameDay` | `boolean` | opcional | — | — | `true` |
| `borrowerTransferDayOfMonth` | `integer` | opcional | — | — | `0` |
| `timezone` | `string` | opcional | — | — | `"texto"` |
| `status` | `integer` | opcional | — | — | `0` |
| `createdAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `borrower` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `creditors` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `installments` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `escrow` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |

Detalhe de `borrower`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `taxId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `ispb` | `integer (int64)` | opcional | — | — | `0` |
| `agency` | `string` | opcional | — | — | `"texto"` |
| `account` | `string` | opcional | — | — | `"texto"` |
| `pixKey` | `string` | opcional | — | — | `"texto"` |
| `pixKeyTypeValueDisplay` | `string` | opcional | — | — | `"texto"` |
| `transferAuthorized` | `boolean` | opcional | — | — | `true` |
| `payoutRail` | `string` | opcional | — | `PIX`, `TED` | `"PIX"` |
| `bankName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `bankCode` | `integer` | opcional | — | — | `0` |
| `beneficiaryIdPIX` | `string` | opcional | — | — | `"texto"` |
| `beneficiaryIdTED` | `string` | opcional | — | — | `"texto"` |

Detalhe de `creditors`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `taxId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `proportion` | `number (decimal)` | opcional | — | — | `1000` |
| `order` | `integer` | opcional | — | — | `0` |
| `active` | `boolean` | opcional | — | — | `true` |
| `ispb` | `integer (int64)` | opcional | — | — | `0` |
| `agency` | `string` | opcional | — | — | `"texto"` |
| `account` | `string` | opcional | — | — | `"texto"` |
| `pixKey` | `string` | opcional | — | — | `"texto"` |
| `pixKeyTypeValueDisplay` | `string` | opcional | — | — | `"texto"` |
| `payoutRail` | `string` | opcional | — | `PIX`, `TED` | `"PIX"` |
| `bankCode` | `integer` | opcional | — | — | `0` |
| `bankName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `beneficiaryIdPIX` | `string` | opcional | — | — | `"texto"` |
| `beneficiaryIdTED` | `string` | opcional | — | — | `"texto"` |

Detalhe de `installments`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `number` | `integer` | opcional | — | — | `0` |
| `dueDate` | `string (date)` | opcional | — | — | `"2025-08-11"` |
| `amount` | `integer (int64)` | opcional | — | — | `0` |
| `paidAmount` | `integer (int64)` | opcional | — | — | `1` |
| `status` | `integer` | opcional | — | — | `0` |
| `interestAccrued` | `integer (int64)` | opcional | — | — | `0` |
| `fineAccrued` | `integer (int64)` | opcional | — | — | `0` |
| `paymentDate` | `string (date)` | opcional | — | — | `"2025-08-11"` |
| `bankAccountTransfers` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `bankAccountTransfers`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `createdAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `createdBy` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `tenant` | `string` | opcional | — | — | `"texto"` |
| `tenantDisplay` | `string` | opcional | — | — | `"texto"` |
| `updatedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `updatedBy` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `ownerUser` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `nsu` | `string` | opcional | — | — | `"texto"` |
| `amount` | `integer (int64)` | opcional | — | — | `0` |
| `transferDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `paymentPurpose` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"PagamentoDeImpostosTributosETaxas"` |
| `paymentPurposeDisplay` | `string` | opcional | — | — | `"texto"` |
| `status` | `string` | opcional | — | `Approved`, `Pending`, `Rejected`, `Timeout`, `Canceled`, `Error`, `Processing`, `Finished`, `Scheduled`, `Reversed`, `ComplianceApproval`, `CancellationRequested` | `"Approved"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `accountingEntry` | `string` | opcional | — | — | `"texto"` |
| `errorMessage` | `string` | opcional | — | — | `"texto"` |
| `reversalCodeReason` | `string` | opcional | — | — | `"texto"` |
| `reversalDescriptionReason` | `string` | opcional | — | — | `"texto"` |
| `bankAccountBeneficiaryId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `bankAccountBeneficiary` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `authorizedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `bankAccountId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `requester` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `approvals` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `approvals`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `level` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"Viewer"` |
| `action` | `string` | opcional | — | `Approve`, `Reject`, `Cancel` | `"Approve"` |
| `actionDisplay` | `string` | opcional | — | — | `"texto"` |
| `user` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |

Exemplo:

```json
{
  "id": "texto",
  "code": "texto",
  "escrowBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "borrowerBeneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "principalAmount": 0,
  "installmentsCount": 0,
  "dueDateType": 0,
  "installmentType": 0,
  "firstDueDate": "2025-08-11",
  "guaranteePercentOverPMT": 1.99,
  "interestPercent": 1.99,
  "finePercent": 1.99,
  "acceptPartialInstallment": true,
  "borrowerTransferAuthorized": true,
  "borrowerTransferSameDay": true,
  "borrowerTransferDayOfMonth": 0,
  "timezone": "texto",
  "status": 0,
  "createdAt": "2025-08-11T13:45:00Z",
  "borrower": {
    "name": "Fulano de Tal",
    "taxId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "ispb": 0,
    "agency": "texto",
    "account": "texto",
    "pixKey": "texto",
    "pixKeyTypeValueDisplay": "texto",
    "transferAuthorized": true,
    "payoutRail": "PIX",
    "bankName": "Fulano de Tal",
    "bankCode": 0,
    "beneficiaryIdPIX": "texto",
    "beneficiaryIdTED": "texto"
  },
  "creditors": [
    {
      "id": "texto",
      "name": "Fulano de Tal",
      "taxId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "proportion": 1000,
      "order": 0,
      "active": true,
      "ispb": 0,
      "agency": "texto",
      "account": "texto",
      "pixKey": "texto",
      "pixKeyTypeValueDisplay": "texto",
      "payoutRail": "PIX",
      "bankCode": 0,
      "bankName": "Fulano de Tal",
      "beneficiaryIdPIX": "texto",
      "beneficiaryIdTED": "texto"
    }
  ],
  "installments": [
    {
      "id": "texto",
      "number": 0,
      "dueDate": "2025-08-11",
      "amount": 0,
      "paidAmount": 1,
      "status": 0,
      "interestAccrued": 0,
      "fineAccrued": 0,
      "paymentDate": "2025-08-11",
      "bankAccountTransfers": [
        {}
      ]
    }
  ],
  "escrow": {
    "bankCode": 0,
    "agency": 0,
    "accountNumber": 0,
    "bankName": "Fulano de Tal",
    "ispb": 0
  }
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `400` | Requisição inválida (validação de campos ou regra de negócio). |

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/BankAccount/AutomaticSplit/Operation/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "escrowBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "borrowerBeneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "creditors": [
    {
      "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "proportion": 1000,
      "active": true
    }
  ],
  "principalAmount": 0,
  "installmentsCount": 0,
  "dueDateType": "Fixed",
  "installmentType": "Fixed",
  "firstDueDate": "2025-08-11",
  "guaranteePercentOverPMT": 1.99,
  "interestPercent": 1.99,
  "finePercent": 1.99,
  "borrowerTransferAuthorized": true,
  "borrowerTransferSameDay": true,
  "borrowerTransferDayOfMonth": 0,
  "acceptPartialInstallment": true,
  "active": true,
  "planOverride": [
    {
      "number": 0,
      "dueDate": "2025-08-11",
      "amount": 0
    }
  ]
}'
```

---

### DELETE /v1/BankAccount/AutomaticSplit/Operation/{operationId}

**Remover Bank Account** — Remove um registro de Bank Account.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `operationId` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `204` | Sucesso sem corpo de resposta. |

**cURL**

```bash
curl -X DELETE "{{baseUrl}}/v1/BankAccount/AutomaticSplit/Operation/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /v1/BankAccount/AutomaticSplit/Operation/Simulate

**Criar Bank Account** — Cria um novo registro de Bank Account.

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `escrowBankAccountId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `borrowerBeneficiaryId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `creditors` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `principalAmount` | `integer (int64)` | opcional | — | — | `0` |
| `installmentsCount` | `integer` | opcional | — | — | `0` |
| `dueDateType` | `string` | opcional | — | `Fixed`, `Dynamic` | `"Fixed"` |
| `installmentType` | `string` | opcional | — | `Fixed`, `Dynamic` | `"Fixed"` |
| `firstDueDate` | `string (date)` | opcional | — | — | `"2025-08-11"` |
| `guaranteePercentOverPMT` | `number (decimal)` | opcional | — | — | `1.99` |
| `interestPercent` | `number (decimal)` | opcional | — | — | `1.99` |
| `finePercent` | `number (decimal)` | opcional | — | — | `1.99` |
| `borrowerTransferAuthorized` | `boolean` | opcional | — | — | `true` |
| `borrowerTransferSameDay` | `boolean` | opcional | — | — | `true` |
| `borrowerTransferDayOfMonth` | `integer` | opcional | — | — | `0` |
| `acceptPartialInstallment` | `boolean` | opcional | — | — | `true` |
| `active` | `boolean` | opcional | — | — | `true` |
| `planOverride` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `creditors`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `beneficiaryId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `proportion` | `number (decimal)` | opcional | — | — | `1000` |
| `active` | `boolean` | opcional | — | — | `true` |

Detalhe de `planOverride`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `number` | `integer` | opcional | — | — | `0` |
| `dueDate` | `string (date)` | opcional | — | — | `"2025-08-11"` |
| `amount` | `integer (int64)` | opcional | — | — | `0` |

Exemplo:

```json
{
  "escrowBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "borrowerBeneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "creditors": [
    {
      "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "proportion": 1000,
      "active": true
    }
  ],
  "principalAmount": 0,
  "installmentsCount": 0,
  "dueDateType": "Fixed",
  "installmentType": "Fixed",
  "firstDueDate": "2025-08-11",
  "guaranteePercentOverPMT": 1.99,
  "interestPercent": 1.99,
  "finePercent": 1.99,
  "borrowerTransferAuthorized": true,
  "borrowerTransferSameDay": true,
  "borrowerTransferDayOfMonth": 0,
  "acceptPartialInstallment": true,
  "active": true,
  "planOverride": [
    {
      "number": 0,
      "dueDate": "2025-08-11",
      "amount": 0
    }
  ]
}
```

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `plan` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `plan`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `number` | `integer` | opcional | — | — | `0` |
| `dueDate` | `string (date)` | opcional | — | — | `"2025-08-11"` |
| `amount` | `number (decimal)` | opcional | — | — | `1000` |

Exemplo:

```json
{
  "plan": [
    {
      "number": 0,
      "dueDate": "2025-08-11",
      "amount": 1000
    }
  ]
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `400` | Requisição inválida (validação de campos ou regra de negócio). |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/BankAccount/AutomaticSplit/Operation/Simulate" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "escrowBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "borrowerBeneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "creditors": [
    {
      "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "proportion": 1000,
      "active": true
    }
  ],
  "principalAmount": 0,
  "installmentsCount": 0,
  "dueDateType": "Fixed",
  "installmentType": "Fixed",
  "firstDueDate": "2025-08-11",
  "guaranteePercentOverPMT": 1.99,
  "interestPercent": 1.99,
  "finePercent": 1.99,
  "borrowerTransferAuthorized": true,
  "borrowerTransferSameDay": true,
  "borrowerTransferDayOfMonth": 0,
  "acceptPartialInstallment": true,
  "active": true,
  "planOverride": [
    {
      "number": 0,
      "dueDate": "2025-08-11",
      "amount": 0
    }
  ]
}'
```

---

### POST /v1/BankAccount/AutomaticSplit/Operation/{operationId}/Close

**Criar Bank Account** — Cria um novo registro de Bank Account.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `operationId` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `sessionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `code` | `string` | opcional | — | — | `"texto"` |
| `reason` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto",
  "reason": "texto"
}
```

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `status` | `integer` | opcional | — | — | `0` |
| `planVersion` | `integer` | opcional | — | — | `0` |

Exemplo:

```json
{
  "id": "texto",
  "status": 0,
  "planVersion": 0
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/BankAccount/AutomaticSplit/Operation/3fa85f64-5717-4562-b3fc-2c963f66afa6/Close" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto",
  "reason": "texto"
}'
```

---

### POST /v1/BankAccount/AutomaticSplit/Operation/{operationId}/Principal

**Criar Bank Account** — Cria um novo registro de Bank Account.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `operationId` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

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

Campos:

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

Exemplo:

```json
{
  "newPrincipalAmount": 0
}
```

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `principalAmount` | `number (decimal)` | opcional | — | — | `1000` |
| `planVersion` | `integer` | opcional | — | — | `0` |
| `updated` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `updated`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `number` | `integer` | opcional | — | — | `0` |
| `dueDate` | `string (date)` | opcional | — | — | `"2025-08-11"` |
| `amount` | `number (decimal)` | opcional | — | — | `1000` |

Exemplo:

```json
{
  "id": "texto",
  "principalAmount": 1000,
  "planVersion": 0,
  "updated": [
    {
      "number": 0,
      "dueDate": "2025-08-11",
      "amount": 1000
    }
  ]
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `400` | Requisição inválida (validação de campos ou regra de negócio). |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/BankAccount/AutomaticSplit/Operation/3fa85f64-5717-4562-b3fc-2c963f66afa6/Principal" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "newPrincipalAmount": 0
}'
```

---

### POST /v1/BankAccount/AutomaticSplit/Operation/{operationId}/InstallmentsCount

**Criar Bank Account** — Cria um novo registro de Bank Account.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `operationId` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

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

Campos:

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

Exemplo:

```json
{
  "newInstallmentsCount": 0
}
```

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `installmentsCount` | `integer` | opcional | — | — | `0` |
| `planVersion` | `integer` | opcional | — | — | `0` |
| `updated` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `updated`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `number` | `integer` | opcional | — | — | `0` |
| `dueDate` | `string (date)` | opcional | — | — | `"2025-08-11"` |
| `amount` | `number (decimal)` | opcional | — | — | `1000` |

Exemplo:

```json
{
  "id": "texto",
  "installmentsCount": 0,
  "planVersion": 0,
  "updated": [
    {
      "number": 0,
      "dueDate": "2025-08-11",
      "amount": 1000
    }
  ]
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `400` | Requisição inválida (validação de campos ou regra de negócio). |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/BankAccount/AutomaticSplit/Operation/3fa85f64-5717-4562-b3fc-2c963f66afa6/InstallmentsCount" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "newInstallmentsCount": 0
}'
```

---

### POST /v1/BankAccount/AutomaticSplit/Installment/{installmentId}/InstallmentStatus

**Criar Bank Account** — Cria um novo registro de Bank Account.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `installmentId` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `newStatus` | `string` | opcional | — | `Scheduled`, `PartiallyPaid`, `Paid`, `Overdue`, `Cancelled`, `PartialError`, `PaymentError` | `"Scheduled"` |

Exemplo:

```json
{
  "newStatus": "Scheduled"
}
```

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `status` | `string` | opcional | — | `Scheduled`, `PartiallyPaid`, `Paid`, `Overdue`, `Cancelled`, `PartialError`, `PaymentError` | `"Scheduled"` |

Exemplo:

```json
{
  "id": "texto",
  "status": "Scheduled"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `400` | Requisição inválida (validação de campos ou regra de negócio). |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/BankAccount/AutomaticSplit/Installment/3fa85f64-5717-4562-b3fc-2c963f66afa6/InstallmentStatus" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "newStatus": "Scheduled"
}'
```

---

### POST /v1/BankAccount/AutomaticSplit/Operation/{operationId}/DueDateType

**Criar Bank Account** — Cria um novo registro de Bank Account.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `operationId` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `newDueDateType` | `string` | opcional | — | `Fixed`, `Dynamic` | `"Fixed"` |
| `firstDueDate` | `string (date)` | opcional | — | — | `"2025-08-11"` |

Exemplo:

```json
{
  "newDueDateType": "Fixed",
  "firstDueDate": "2025-08-11"
}
```

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `dueDateType` | `integer` | opcional | — | — | `0` |
| `firstDueDate` | `string (date)` | opcional | — | — | `"2025-08-11"` |
| `planVersion` | `integer` | opcional | — | — | `0` |

Exemplo:

```json
{
  "id": "texto",
  "dueDateType": 0,
  "firstDueDate": "2025-08-11",
  "planVersion": 0
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `400` | Requisição inválida (validação de campos ou regra de negócio). |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/BankAccount/AutomaticSplit/Operation/3fa85f64-5717-4562-b3fc-2c963f66afa6/DueDateType" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "newDueDateType": "Fixed",
  "firstDueDate": "2025-08-11"
}'
```

---

### POST /v1/BankAccount/AutomaticSplit/Operation/{operationId}/InstallmentType

**Criar Bank Account** — Cria um novo registro de Bank Account.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `operationId` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `newInstallmentType` | `string` | opcional | — | `Fixed`, `Dynamic` | `"Fixed"` |
| `planOverride` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `planOverride`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `number` | `integer` | opcional | — | — | `0` |
| `dueDate` | `string (date)` | opcional | — | — | `"2025-08-11"` |
| `amount` | `number (decimal)` | opcional | — | — | `1000` |

Exemplo:

```json
{
  "newInstallmentType": "Fixed",
  "planOverride": [
    {
      "number": 0,
      "dueDate": "2025-08-11",
      "amount": 1000
    }
  ]
}
```

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `installmentType` | `integer` | opcional | — | — | `0` |
| `planVersion` | `integer` | opcional | — | — | `0` |

Exemplo:

```json
{
  "id": "texto",
  "installmentType": 0,
  "planVersion": 0
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `400` | Requisição inválida (validação de campos ou regra de negócio). |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/BankAccount/AutomaticSplit/Operation/3fa85f64-5717-4562-b3fc-2c963f66afa6/InstallmentType" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "newInstallmentType": "Fixed",
  "planOverride": [
    {
      "number": 0,
      "dueDate": "2025-08-11",
      "amount": 1000
    }
  ]
}'
```

---

### POST /v1/BankAccount/AutomaticSplit/Operation/{operationId}/Cancel

**Criar Bank Account** — Cria um novo registro de Bank Account.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `operationId` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `sessionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `code` | `string` | opcional | — | — | `"texto"` |
| `reason` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto",
  "reason": "texto"
}
```

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `status` | `integer` | opcional | — | — | `0` |
| `planVersion` | `integer` | opcional | — | — | `0` |

Exemplo:

```json
{
  "id": "texto",
  "status": 0,
  "planVersion": 0
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/BankAccount/AutomaticSplit/Operation/3fa85f64-5717-4562-b3fc-2c963f66afa6/Cancel" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto",
  "reason": "texto"
}'
```

---

### GET /v1/BankAccount/AutomaticSplit/Operations

**Lista operações (padrão de filtros igual ao módulo de contas)** — Lista e filtra registros de Bank Account.

Lista operações (padrão de filtros igual ao módulo de contas).

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `F_isMasterViewer` | query | `boolean` | opcional | — | `true` |
| `searchString` | query | `string` | opcional | — | `valor` |
| `EscrowBankAccountId` | query | `string` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `F_account` | query | `integer (int64)` | opcional | — | `10` |
| `F_borrowerName` | query | `string` | opcional | — | `valor` |
| `F_creditorName` | query | `string` | opcional | — | `valor` |
| `F_status` | query | `objeto` | opcional | — | `valor` |
| `OrderBy` | query | `string` | opcional | — | `valor` |
| `Page` | query | `integer` | opcional | — | `10` |
| `Size` | query | `integer` | opcional | — | `10` |
| `WithEscrowBalance` | query | `boolean` | opcional | — | `true` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `items` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `total` | `integer` | opcional | — | — | `0` |
| `page` | `integer` | opcional | — | — | `0` |
| `pageSize` | `integer` | opcional | — | — | `0` |

Detalhe de `items`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `creditors` | `array de string` | opcional | — | — | `[ … ]` |
| `borrowerName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `principalAmount` | `integer (int64)` | opcional | — | — | `0` |
| `outstandingBalance` | `integer (int64)` | opcional | — | — | `0` |
| `escrowBalance` | `integer (int64)` | opcional | — | — | `0` |
| `installmentsCount` | `integer` | opcional | — | — | `0` |
| `openInstallments` | `integer` | opcional | — | — | `0` |
| `guaranteePercentOverPMT` | `number (decimal)` | opcional | — | — | `1.99` |
| `status` | `integer` | opcional | — | — | `0` |
| `statusDescription` | `string` | opcional | — | — | `"texto"` |
| `createdAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Exemplo:

```json
{
  "items": [
    {
      "id": "texto",
      "creditors": [
        "texto"
      ],
      "borrowerName": "Fulano de Tal",
      "principalAmount": 0,
      "outstandingBalance": 0,
      "escrowBalance": 0,
      "installmentsCount": 0,
      "openInstallments": 0,
      "guaranteePercentOverPMT": 1.99,
      "status": 0,
      "statusDescription": "texto",
      "createdAt": "2025-08-11T13:45:00Z"
    }
  ],
  "total": 0,
  "page": 0,
  "pageSize": 0
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X GET "{{baseUrl}}/v1/BankAccount/AutomaticSplit/Operations" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v1/BankAccount/AutomaticSplit/Escrow/Beneficiaries

**Busca conta pelo trio (bankIspb, agency, accountNumber) e retorna beneficiários** — Lista e filtra registros de Bank Account.

Busca conta pelo trio (bankIspb, agency, accountNumber) e retorna beneficiários ativos com status Approved. Bloqueia contas do tipo PaymentAccount.

**Parâmetros**

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

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `bankAccountId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `bankCode` | `integer` | opcional | — | — | `0` |
| `agency` | `integer` | opcional | — | — | `0` |
| `accountNumber` | `integer (int64)` | opcional | — | — | `0` |
| `accountType` | `string` | opcional | — | `PaymentAccount`, `EscrowAccount`, `EscrowPlusAccount`, `EscrowMulticreditorsAccount` | `"PaymentAccount"` |
| `accountTypeDescription` | `string` | opcional | — | — | `"texto"` |
| `beneficiaries` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `beneficiaries`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `bankDisplay` | `string` | opcional | — | — | `"texto"` |
| `bank` | `integer` | opcional | — | — | `0` |
| `agency` | `integer` | opcional | — | — | `0` |
| `accountNumber` | `string` | opcional | — | — | `"texto"` |
| `pixKeyTypeValue` | `string` | opcional | — | — | `"texto"` |
| `pixKeyTypeValueDisplay` | `string` | opcional | — | — | `"texto"` |
| `keyPix` | `string` | opcional | — | — | `"texto"` |
| `beneficiaryIdPIX` | `string` | opcional | — | — | `"texto"` |
| `beneficiaryIdTED` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "bankCode": 0,
  "agency": 0,
  "accountNumber": 0,
  "accountType": "PaymentAccount",
  "accountTypeDescription": "texto",
  "beneficiaries": [
    {
      "name": "Fulano de Tal",
      "registrationNumber": "12345678909",
      "bankDisplay": "texto",
      "bank": 0,
      "agency": 0,
      "accountNumber": "texto",
      "pixKeyTypeValue": "texto",
      "pixKeyTypeValueDisplay": "texto",
      "keyPix": "texto",
      "beneficiaryIdPIX": "texto",
      "beneficiaryIdTED": "texto"
    }
  ]
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `400` | Requisição inválida (validação de campos ou regra de negócio). |
| `404` | Recurso não encontrado. |

**cURL**

```bash
curl -X GET "{{baseUrl}}/v1/BankAccount/AutomaticSplit/Escrow/Beneficiaries" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v1/BankAccount/{Id}/Creditor

**Obter todos os credores da conta bancária** — Lista e filtra registros de Bank Account.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `page` | query | `integer` | opcional | — | `10` |
| `size` | query | `integer` | opcional | — | `10` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

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

---

### POST /v1/BankAccount/{Id}/Creditor

**Incluir credor na conta bancária** — Cria um novo registro de Bank Account.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `personId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `naturalPerson` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `legalPerson` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |

Exemplo:

```json
{
  "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "naturalPerson": {
    "id": "texto",
    "referenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Fulano de Tal",
    "discriminator": "texto",
    "registrationNumber": "12345678909",
    "address": {
      "addressName": "Fulano de Tal",
      "zipCode": "01310930",
      "city": "texto",
      "uf": "NaoSelecionado",
      "district": "texto",
      "number": "texto",
      "complement": "texto"
    },
    "email": "cliente@exemplo.com.br",
    "phone": "11987654321",
    "economicActivityCode": "texto",
    "pep": true,
    "birthDate": "2025-08-11T13:45:00Z",
    "civilStatus": "Married",
    "gender": "NotInformed",
    "documentType": "RG",
    "documentNumber": "texto",
    "documentIssuer": "texto",
    "documentDate": "2025-08-11T13:45:00Z",
    "netSalary": 1000,
    "otherIncome": 1000,
    "mothersName": "Fulano de Tal",
    "fathersName": "Fulano de Tal",
    "placeOfBirthCountry": "texto",
    "occupation": "texto",
    "natureOfOccupation": "PrivateEmployee",
    "spouseName": "Fulano de Tal"
  },
  "legalPerson": {
    "id": "texto",
    "referenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Fulano de Tal",
    "discriminator": "texto",
    "registrationNumber": "12345678909",
    "address": {
      "addressName": "Fulano de Tal",
      "zipCode": "01310930",
      "city": "texto",
      "uf": "NaoSelecionado",
      "district": "texto",
      "number": "texto",
      "complement": "texto"
    },
    "email": "cliente@exemplo.com.br",
    "phone": "11987654321",
    "economicActivityCode": "texto",
    "companyName": "Fulano de Tal",
    "typeOfActivity": "Industry",
    "openDate": "2025-08-11T13:45:00Z",
    "averageMonthlyRevenue": 1000,
    "initialShareCapital": 1000,
    "numberOfEmployees": 0
  }
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Creditor" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "naturalPerson": {
    "id": "texto",
    "referenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Fulano de Tal",
    "discriminator": "texto",
    "registrationNumber": "12345678909",
    "address": {
      "addressName": "Fulano de Tal",
      "zipCode": "01310930",
      "city": "texto",
      "uf": "NaoSelecionado",
      "district": "texto",
      "number": "texto",
      "complement": "texto"
    },
    "email": "cliente@exemplo.com.br",
    "phone": "11987654321",
    "economicActivityCode": "texto",
    "pep": true,
    "birthDate": "2025-08-11T13:45:00Z",
    "civilStatus": "Married",
    "gender": "NotInformed",
    "documentType": "RG",
    "documentNumber": "texto",
    "documentIssuer": "texto",
    "documentDate": "2025-08-11T13:45:00Z",
    "netSalary": 1000,
    "otherIncome": 1000,
    "mothersName": "Fulano de Tal",
    "fathersName": "Fulano de Tal",
    "placeOfBirthCountry": "texto",
    "occupation": "texto",
    "natureOfOccupation": "PrivateEmployee",
    "spouseName": "Fulano de Tal"
  },
  "legalPerson": {
    "id": "texto",
    "referenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Fulano de Tal",
    "discriminator": "texto",
    "registrationNumber": "12345678909",
    "address": {
      "addressName": "Fulano de Tal",
      "zipCode": "01310930",
      "city": "texto",
      "uf": "NaoSelecionado",
      "district": "texto",
      "number": "texto",
      "complement": "texto"
    },
    "email": "cliente@exemplo.com.br",
    "phone": "11987654321",
    "economicActivityCode": "texto",
    "companyName": "Fulano de Tal",
    "typeOfActivity": "Industry",
    "openDate": "2025-08-11T13:45:00Z",
    "averageMonthlyRevenue": 1000,
    "initialShareCapital": 1000,
    "numberOfEmployees": 0
  }
}'
```

---

### DELETE /v1/BankAccount/{id}/Creditor

**Excluir credor da conta bancária** — Remove um registro de Bank Account.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `personId` | query | `string` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

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

---

### POST /v1/BankAccount/{id}/Entry

**Inclui um lançamento em conta** — Cria um novo registro de Bank Account.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string` | obrigatório | Conta débito | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `contraParte` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `accountEntryType` | `string` | opcional | — | `PixSent`, `PixReservalSent`, `PixRefundSent`, `PixReceived`, `PixRefundReceived`, `PixReversalRefundReceived`, `BlockBalance`, `EntryDebit`, `EntryCredit`, `DepositByBankSlip`, `BillingFee`, `PaymentBankSlip`, `TransferDebit`, `AdministrativeExpenses`, `PixFare`, `DebtCollectionCosts` | `"PixSent"` |
| `valueInCents` | `integer (int64)` | opcional | — | — | `0` |
| `complement` | `string` | opcional | — | — | `"texto"` |
| `commentsDoc` | `string` | opcional | — | — | `"texto"` |
| `isReceived` | `boolean` | opcional | — | — | `true` |
| `metadata` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `sessionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `code` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "contraParte": {
    "accountNumber": "texto",
    "registrationNumber": "12345678909",
    "name": "Fulano de Tal",
    "bankCode": "texto",
    "agencyNumber": 0
  },
  "accountEntryType": "PixSent",
  "valueInCents": 0,
  "complement": "texto",
  "commentsDoc": "texto",
  "isReceived": true,
  "metadata": {
    "metadata": {}
  },
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}
```

**Resposta 200**

Exemplo:

```json
"texto"
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Entry" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "contraParte": {
    "accountNumber": "texto",
    "registrationNumber": "12345678909",
    "name": "Fulano de Tal",
    "bankCode": "texto",
    "agencyNumber": 0
  },
  "accountEntryType": "PixSent",
  "valueInCents": 0,
  "complement": "texto",
  "commentsDoc": "texto",
  "isReceived": true,
  "metadata": {
    "metadata": {}
  },
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}'
```

---