# Referência de API — Banking (UY3)

> 139 endpoints, organizados pelo fluxo de integração. Todos os exemplos usam os placeholders `{{baseUrl}}` (URL base do ambiente) e `{{token}}` (token JWT).

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

## Chaves PIX

Cadastre e gerencie as chaves PIX da conta.

### POST /v1/BankAccount/BatchPixKeyRegistrationNumber

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

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

Exemplo:

```json
[
  "texto"
]
```

**Códigos de retorno**

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

**cURL**

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

---

### GET /v1/BankAccount/{id}/Pix/Key

**Obter todas as chaves PIX da conta** — 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 |
|---|---|---|---|---|---|
| `pixKey` | `string` | opcional | — | — | `"texto"` |
| `type` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |
| `createdAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `ownerAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `statistics` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |

Detalhe de `statistics`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerSpi` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `ownerFraudMarkers` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `ownerInfractionReports` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `ownerEntries` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `keySpi` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `keyFraudMarkers` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `keyInfractionReports` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `keyEntries` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |

Exemplo:

```json
[
  {
    "pixKey": "texto",
    "type": "NaturalRegistrationNumber",
    "typeDisplay": "texto",
    "createdAt": "2025-08-11T13:45:00Z",
    "ownerAt": "2025-08-11T13:45:00Z",
    "statistics": {
      "ownerSpi": {
        "ultimaAtualizacao": "2025-08-11T13:45:00Z",
        "d90": 0,
        "m12": 0,
        "m60": 0
      },
      "ownerFraudMarkers": {
        "ultimaAtualizacao": "2025-08-11T13:45:00Z",
        "applicationFraudsD90": 0,
        "applicationFraudsM12": 0,
        "applicationFraudsM60": 0,
        "muleAccountsD90": 0,
        "muleAccountsM12": 0,
        "muleAccountsM60": 0,
        "scammerAccountsD90": 0,
        "scammerAccountsM12": 0,
        "scammerAccountsM60": 0,
        "otherFraudsD90": 0,
        "otherFraudsM12": 0,
        "otherFraudsM60": 0,
        "unknownFraudsD90": 0,
        "unknownFraudsM12": 0,
        "unknownFraudsM60": 0,
        "totalFraudTransactionAmountD90": 0,
        "totalFraudTransactionAmountM12": 0,
        "totalFraudTransactionAmountM60": 0,
        "distinctFraudReportersD90": 0,
        "distinctFraudReportersM12": 0,
        "distinctFraudReportersM60": 0
      },
      "ownerInfractionReports": {
        "ultimaAtualizacao": "2025-08-11T13:45:00Z",
        "openReports": 0,
        "openReportsDistinctReporters": 0,
        "rejectedReportsD90": 0,
        "rejectedReportsM12": 0,
        "rejectedReportsM60": 0
      },
      "ownerEntries": {
        "ultimaAtualizacao": "2025-08-11T13:45:00Z",
        "registeredAccounts": 0
      },
      "keySpi": {
        "ultimaAtualizacao": "2025-08-11T13:45:00Z",
        "d90": 0,
        "m12": 0,
        "m60": 0
      },
      "keyFraudMarkers": {
        "ultimaAtualizacao": "2025-08-11T13:45:00Z",
        "applicationFraudsD90": 0,
        "applicationFraudsM12": 0,
        "applicationFraudsM60": 0,
        "muleAccountsD90": 0,
        "muleAccountsM12": 0,
        "muleAccountsM60": 0,
        "scammerAccountsD90": 0,
        "scammerAccountsM12": 0,
        "scammerAccountsM60": 0,
        "otherFraudsD90": 0,
        "otherFraudsM12": 0,
        "otherFraudsM60": 0,
        "unknownFraudsD90": 0,
        "unknownFraudsM12": 0,
        "unknownFraudsM60": 0,
        "totalFraudTransactionAmountD90": 0,
        "totalFraudTransactionAmountM12": 0,
        "totalFraudTransactionAmountM60": 0,
        "distinctFraudReportersD90": 0,
        "distinctFraudReportersM12": 0,
        "distinctFraudReportersM60": 0
      },
      "keyInfractionReports": {
        "ultimaAtualizacao": "2025-08-11T13:45:00Z",
        "openReports": 0,
        "openReportsDistinctReporters": 0,
        "rejectedReportsD90": 0,
        "rejectedReportsM12": 0,
        "rejectedReportsM60": 0
      },
      "keyEntries": {
        "ultimaAtualizacao": "2025-08-11T13:45:00Z",
        "distinctAccountsD90": 0,
        "distinctAccountsM12": 0,
        "distinctAccountsM60": 0
      }
    }
  }
]
```

**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/Pix/Key" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /v1/BankAccount/{id}/Pix/Key

**Incluir Chave PIX** — 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 |
|---|---|---|---|---|---|
| `type` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic` | `"NaturalRegistrationNumber"` |
| `pixKey` | `string` | opcional | — | — | `"texto"` |
| `descriptionType` | `string` | opcional | — | — | `"texto"` |
| `formattedKey` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "type": "NaturalRegistrationNumber",
  "pixKey": "texto",
  "descriptionType": "texto",
  "formattedKey": "texto"
}
```

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `type` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |
| `pixKey` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "type": "NaturalRegistrationNumber",
  "typeDisplay": "texto",
  "pixKey": "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/Pix/Key" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "NaturalRegistrationNumber",
  "pixKey": "texto",
  "descriptionType": "texto",
  "formattedKey": "texto"
}'
```

---

### GET /v1/BankAccount/Pix/Key/{pixKey}

**Obtém informações por chave PIX** — Consulta Bank Account pelo identificador informado na rota.

**Parâmetros**

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

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `keyType` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `keyTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `keyValue` | `string` | opcional | — | — | `"texto"` |
| `accountNumber` | `string` | opcional | — | — | `"texto"` |
| `accountAgency` | `string` | opcional | — | — | `"texto"` |
| `accountOpeningDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `accountType` | `string` | opcional | — | `CheckingAccount`, `SalaryAccount`, `SavingsAccount`, `Transactional` | `"CheckingAccount"` |
| `accountTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `personType` | `string` | opcional | — | `Natural`, `Legal` | `"Natural"` |
| `personTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `bankName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `ispb` | `string` | opcional | — | — | `"texto"` |
| `endToEndId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `statistics` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |

Detalhe de `statistics`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerSpi` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `ownerFraudMarkers` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `ownerInfractionReports` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `ownerEntries` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `keySpi` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `keyFraudMarkers` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `keyInfractionReports` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `keyEntries` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |

Exemplo:

```json
{
  "registrationNumber": "12345678909",
  "name": "Fulano de Tal",
  "keyType": "NaturalRegistrationNumber",
  "keyTypeDisplay": "texto",
  "keyValue": "texto",
  "accountNumber": "texto",
  "accountAgency": "texto",
  "accountOpeningDate": "2025-08-11T13:45:00Z",
  "accountType": "CheckingAccount",
  "accountTypeDisplay": "texto",
  "personType": "Natural",
  "personTypeDisplay": "texto",
  "bankName": "Fulano de Tal",
  "ispb": "texto",
  "endToEndId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "statistics": {
    "ownerSpi": {
      "ultimaAtualizacao": "2025-08-11T13:45:00Z",
      "d90": 0,
      "m12": 0,
      "m60": 0
    },
    "ownerFraudMarkers": {
      "ultimaAtualizacao": "2025-08-11T13:45:00Z",
      "applicationFraudsD90": 0,
      "applicationFraudsM12": 0,
      "applicationFraudsM60": 0,
      "muleAccountsD90": 0,
      "muleAccountsM12": 0,
      "muleAccountsM60": 0,
      "scammerAccountsD90": 0,
      "scammerAccountsM12": 0,
      "scammerAccountsM60": 0,
      "otherFraudsD90": 0,
      "otherFraudsM12": 0,
      "otherFraudsM60": 0,
      "unknownFraudsD90": 0,
      "unknownFraudsM12": 0,
      "unknownFraudsM60": 0,
      "totalFraudTransactionAmountD90": 0,
      "totalFraudTransactionAmountM12": 0,
      "totalFraudTransactionAmountM60": 0,
      "distinctFraudReportersD90": 0,
      "distinctFraudReportersM12": 0,
      "distinctFraudReportersM60": 0
    },
    "ownerInfractionReports": {
      "ultimaAtualizacao": "2025-08-11T13:45:00Z",
      "openReports": 0,
      "openReportsDistinctReporters": 0,
      "rejectedReportsD90": 0,
      "rejectedReportsM12": 0,
      "rejectedReportsM60": 0
    },
    "ownerEntries": {
      "ultimaAtualizacao": "2025-08-11T13:45:00Z",
      "registeredAccounts": 0
    },
    "keySpi": {
      "ultimaAtualizacao": "2025-08-11T13:45:00Z",
      "d90": 0,
      "m12": 0,
      "m60": 0
    },
    "keyFraudMarkers": {
      "ultimaAtualizacao": "2025-08-11T13:45:00Z",
      "applicationFraudsD90": 0,
      "applicationFraudsM12": 0,
      "applicationFraudsM60": 0,
      "muleAccountsD90": 0,
      "muleAccountsM12": 0,
      "muleAccountsM60": 0,
      "scammerAccountsD90": 0,
      "scammerAccountsM12": 0,
      "scammerAccountsM60": 0,
      "otherFraudsD90": 0,
      "otherFraudsM12": 0,
      "otherFraudsM60": 0,
      "unknownFraudsD90": 0,
      "unknownFraudsM12": 0,
      "unknownFraudsM60": 0,
      "totalFraudTransactionAmountD90": 0,
      "totalFraudTransactionAmountM12": 0,
      "totalFraudTransactionAmountM60": 0,
      "distinctFraudReportersD90": 0,
      "distinctFraudReportersM12": 0,
      "distinctFraudReportersM60": 0
    },
    "keyInfractionReports": {
      "ultimaAtualizacao": "2025-08-11T13:45:00Z",
      "openReports": 0,
      "openReportsDistinctReporters": 0,
      "rejectedReportsD90": 0,
      "rejectedReportsM12": 0,
      "rejectedReportsM60": 0
    },
    "keyEntries": {
      "ultimaAtualizacao": "2025-08-11T13:45:00Z",
      "distinctAccountsD90": 0,
      "distinctAccountsM12": 0,
      "distinctAccountsM60": 0
    }
  }
}
```

**Códigos de retorno**

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

**cURL**

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

---

### GET /v1/BankAccount/{id}/Pix/Key/{key}

**Obter informações por chave PIX** — Consulta Bank Account pelo identificador informado na rota.

**Parâmetros**

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

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `keyType` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `keyTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `keyValue` | `string` | opcional | — | — | `"texto"` |
| `accountNumber` | `string` | opcional | — | — | `"texto"` |
| `accountAgency` | `string` | opcional | — | — | `"texto"` |
| `accountOpeningDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `accountType` | `string` | opcional | — | `CheckingAccount`, `SalaryAccount`, `SavingsAccount`, `Transactional` | `"CheckingAccount"` |
| `accountTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `personType` | `string` | opcional | — | `Natural`, `Legal` | `"Natural"` |
| `personTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `bankName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `ispb` | `string` | opcional | — | — | `"texto"` |
| `endToEndId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `statistics` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |

Detalhe de `statistics`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `ownerSpi` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `ownerFraudMarkers` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `ownerInfractionReports` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `ownerEntries` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `keySpi` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `keyFraudMarkers` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `keyInfractionReports` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `keyEntries` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |

Exemplo:

```json
{
  "registrationNumber": "12345678909",
  "name": "Fulano de Tal",
  "keyType": "NaturalRegistrationNumber",
  "keyTypeDisplay": "texto",
  "keyValue": "texto",
  "accountNumber": "texto",
  "accountAgency": "texto",
  "accountOpeningDate": "2025-08-11T13:45:00Z",
  "accountType": "CheckingAccount",
  "accountTypeDisplay": "texto",
  "personType": "Natural",
  "personTypeDisplay": "texto",
  "bankName": "Fulano de Tal",
  "ispb": "texto",
  "endToEndId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "statistics": {
    "ownerSpi": {
      "ultimaAtualizacao": "2025-08-11T13:45:00Z",
      "d90": 0,
      "m12": 0,
      "m60": 0
    },
    "ownerFraudMarkers": {
      "ultimaAtualizacao": "2025-08-11T13:45:00Z",
      "applicationFraudsD90": 0,
      "applicationFraudsM12": 0,
      "applicationFraudsM60": 0,
      "muleAccountsD90": 0,
      "muleAccountsM12": 0,
      "muleAccountsM60": 0,
      "scammerAccountsD90": 0,
      "scammerAccountsM12": 0,
      "scammerAccountsM60": 0,
      "otherFraudsD90": 0,
      "otherFraudsM12": 0,
      "otherFraudsM60": 0,
      "unknownFraudsD90": 0,
      "unknownFraudsM12": 0,
      "unknownFraudsM60": 0,
      "totalFraudTransactionAmountD90": 0,
      "totalFraudTransactionAmountM12": 0,
      "totalFraudTransactionAmountM60": 0,
      "distinctFraudReportersD90": 0,
      "distinctFraudReportersM12": 0,
      "distinctFraudReportersM60": 0
    },
    "ownerInfractionReports": {
      "ultimaAtualizacao": "2025-08-11T13:45:00Z",
      "openReports": 0,
      "openReportsDistinctReporters": 0,
      "rejectedReportsD90": 0,
      "rejectedReportsM12": 0,
      "rejectedReportsM60": 0
    },
    "ownerEntries": {
      "ultimaAtualizacao": "2025-08-11T13:45:00Z",
      "registeredAccounts": 0
    },
    "keySpi": {
      "ultimaAtualizacao": "2025-08-11T13:45:00Z",
      "d90": 0,
      "m12": 0,
      "m60": 0
    },
    "keyFraudMarkers": {
      "ultimaAtualizacao": "2025-08-11T13:45:00Z",
      "applicationFraudsD90": 0,
      "applicationFraudsM12": 0,
      "applicationFraudsM60": 0,
      "muleAccountsD90": 0,
      "muleAccountsM12": 0,
      "muleAccountsM60": 0,
      "scammerAccountsD90": 0,
      "scammerAccountsM12": 0,
      "scammerAccountsM60": 0,
      "otherFraudsD90": 0,
      "otherFraudsM12": 0,
      "otherFraudsM60": 0,
      "unknownFraudsD90": 0,
      "unknownFraudsM12": 0,
      "unknownFraudsM60": 0,
      "totalFraudTransactionAmountD90": 0,
      "totalFraudTransactionAmountM12": 0,
      "totalFraudTransactionAmountM60": 0,
      "distinctFraudReportersD90": 0,
      "distinctFraudReportersM12": 0,
      "distinctFraudReportersM60": 0
    },
    "keyInfractionReports": {
      "ultimaAtualizacao": "2025-08-11T13:45:00Z",
      "openReports": 0,
      "openReportsDistinctReporters": 0,
      "rejectedReportsD90": 0,
      "rejectedReportsM12": 0,
      "rejectedReportsM60": 0
    },
    "keyEntries": {
      "ultimaAtualizacao": "2025-08-11T13:45:00Z",
      "distinctAccountsD90": 0,
      "distinctAccountsM12": 0,
      "distinctAccountsM60": 0
    }
  }
}
```

**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/Pix/Key/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"
```

---

### DELETE /v1/BankAccount/{id}/Pix/Key/{key}

**Excluir Chave PIX** — 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` |
| `key` | 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/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/Key/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v1/BankAccount/{id}/Pix/Key/Claim

**Obter todas as reivindicações da conta** — 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 |
|---|---|---|---|---|---|
| `claim` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `claimantPerson` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `donorPerson` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `donorDataAccount` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `claimantDataAccount` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `pixKey` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `deadLine` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `resolutionDeadLine` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `lastRequest` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `isDonorParticipant` | `boolean` | opcional | — | — | `true` |
| `isClaimantParticipant` | `boolean` | opcional | — | — | `true` |
| `isDonorPerson` | `boolean` | opcional | — | — | `true` |
| `isClaimantPerson` | `boolean` | opcional | — | — | `true` |

Detalhe de `claim`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `status` | `string` | opcional | — | `Open`, `Waiting_Resolution`, `Confirmed`, `Canceled`, `Finished` | `"Open"` |
| `type` | `string` | opcional | — | `Ownership`, `Portability` | `"Ownership"` |
| `cancelParticipant` | `string` | opcional | — | — | `"texto"` |
| `confirmationReason` | `string` | opcional | — | `UserRequest`, `ClosingAccount`, `Fraud`, `StandardOperation` | `"UserRequest"` |
| `cancelReason` | `string` | opcional | — | `UserRequest`, `ClosingAccount`, `Fraud`, `StandardOperation` | `"UserRequest"` |

Detalhe de `claimantPerson`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `personType` | `string` | opcional | — | — | `"texto"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `companyName` | `string` | opcional | — | — | `"Fulano de Tal"` |

Detalhe de `donorPerson`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `personType` | `string` | opcional | — | — | `"texto"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `companyName` | `string` | opcional | — | — | `"Fulano de Tal"` |

Detalhe de `donorDataAccount`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `agency` | `string` | opcional | — | — | `"texto"` |
| `accountNumber` | `string` | opcional | — | — | `"texto"` |
| `accountType` | `string` | opcional | — | `CheckingAccount`, `SalaryAccount`, `SavingsAccount`, `Transactional` | `"CheckingAccount"` |
| `openedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `ispb` | `string` | opcional | — | — | `"texto"` |
| `bankName` | `string` | opcional | — | — | `"Fulano de Tal"` |

Detalhe de `claimantDataAccount`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `agency` | `string` | opcional | — | — | `"texto"` |
| `accountNumber` | `string` | opcional | — | — | `"texto"` |
| `accountType` | `string` | opcional | — | `CheckingAccount`, `SalaryAccount`, `SavingsAccount`, `Transactional` | `"CheckingAccount"` |
| `openedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `ispb` | `string` | opcional | — | — | `"texto"` |
| `institutionName` | `string` | opcional | — | — | `"Fulano de Tal"` |

Detalhe de `pixKey`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `type` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |
| `pixKey` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
[
  {
    "claim": {
      "id": "texto",
      "status": "Open",
      "type": "Ownership",
      "cancelParticipant": "texto",
      "confirmationReason": "UserRequest",
      "cancelReason": "UserRequest"
    },
    "claimantPerson": {
      "personType": "texto",
      "registrationNumber": "12345678909",
      "name": "Fulano de Tal",
      "companyName": "Fulano de Tal"
    },
    "donorPerson": {
      "personType": "texto",
      "registrationNumber": "12345678909",
      "name": "Fulano de Tal",
      "companyName": "Fulano de Tal"
    },
    "donorDataAccount": {
      "agency": "texto",
      "accountNumber": "texto",
      "accountType": "CheckingAccount",
      "openedAt": "2025-08-11T13:45:00Z",
      "ispb": "texto",
      "bankName": "Fulano de Tal"
    },
    "claimantDataAccount": {
      "agency": "texto",
      "accountNumber": "texto",
      "accountType": "CheckingAccount",
      "openedAt": "2025-08-11T13:45:00Z",
      "ispb": "texto",
      "institutionName": "Fulano de Tal"
    },
    "pixKey": {
      "type": "NaturalRegistrationNumber",
      "typeDisplay": "texto",
      "pixKey": "texto"
    },
    "deadLine": "2025-08-11T13:45:00Z",
    "resolutionDeadLine": "2025-08-11T13:45:00Z",
    "lastRequest": "2025-08-11T13:45:00Z",
    "isDonorParticipant": true,
    "isClaimantParticipant": true,
    "isDonorPerson": true,
    "isClaimantPerson": true
  }
]
```

**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/Pix/Key/Claim" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /v1/BankAccount/{id}/Pix/Key/Claim

**Incluir reivindicação de chave PIX** — 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 |
|---|---|---|---|---|---|
| `type` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email` | `"NaturalRegistrationNumber"` |
| `pixKey` | `string` | opcional | — | — | `"texto"` |
| `descriptionType` | `string` | opcional | — | — | `"texto"` |
| `formattedKey` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "type": "NaturalRegistrationNumber",
  "pixKey": "texto",
  "descriptionType": "texto",
  "formattedKey": "texto"
}
```

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `type` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |
| `pixKey` | `string` | opcional | — | — | `"texto"` |
| `claimId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |

Exemplo:

```json
{
  "type": "NaturalRegistrationNumber",
  "typeDisplay": "texto",
  "pixKey": "texto",
  "claimId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
```

**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/Pix/Key/Claim" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "type": "NaturalRegistrationNumber",
  "pixKey": "texto",
  "descriptionType": "texto",
  "formattedKey": "texto"
}'
```

---

### PUT /v1/BankAccount/{id}/Pix/Key/Claim

**Confirmar/Cancelar ou Concluir reivindicação de chave PIX** — Atualiza por completo um registro de Bank Account existente.

**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 |
|---|---|---|---|---|---|
| `claimId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `claimAction` | `string` | opcional | — | `Confirm`, `Cancel`, `Finish` | `"Confirm"` |

Exemplo:

```json
{
  "claimId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "claimAction": "Confirm"
}
```

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `claimId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `claimStatus` | `string` | opcional | — | `Open`, `Waiting_Resolution`, `Confirmed`, `Canceled`, `Finished` | `"Open"` |

Exemplo:

```json
{
  "claimId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "claimStatus": "Open"
}
```

**Códigos de retorno**

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

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/Key/Claim" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "claimId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "claimAction": "Confirm"
}'
```

---

### GET /v1/BankAccount/{id}/Pix/Key/Claim/{claimId}

**Consultar reivindicação por Id** — Consulta Bank Account pelo identificador informado na rota.

**Parâmetros**

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

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `claim` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `claimantPerson` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `donorPerson` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `donorDataAccount` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `claimantDataAccount` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `pixKey` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `deadLine` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `resolutionDeadLine` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `lastRequest` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `isDonorParticipant` | `boolean` | opcional | — | — | `true` |
| `isClaimantParticipant` | `boolean` | opcional | — | — | `true` |
| `isDonorPerson` | `boolean` | opcional | — | — | `true` |
| `isClaimantPerson` | `boolean` | opcional | — | — | `true` |

Detalhe de `claim`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `status` | `string` | opcional | — | `Open`, `Waiting_Resolution`, `Confirmed`, `Canceled`, `Finished` | `"Open"` |
| `type` | `string` | opcional | — | `Ownership`, `Portability` | `"Ownership"` |
| `cancelParticipant` | `string` | opcional | — | — | `"texto"` |
| `confirmationReason` | `string` | opcional | — | `UserRequest`, `ClosingAccount`, `Fraud`, `StandardOperation` | `"UserRequest"` |
| `cancelReason` | `string` | opcional | — | `UserRequest`, `ClosingAccount`, `Fraud`, `StandardOperation` | `"UserRequest"` |

Detalhe de `claimantPerson`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `personType` | `string` | opcional | — | — | `"texto"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `companyName` | `string` | opcional | — | — | `"Fulano de Tal"` |

Detalhe de `donorPerson`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `personType` | `string` | opcional | — | — | `"texto"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `companyName` | `string` | opcional | — | — | `"Fulano de Tal"` |

Detalhe de `donorDataAccount`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `agency` | `string` | opcional | — | — | `"texto"` |
| `accountNumber` | `string` | opcional | — | — | `"texto"` |
| `accountType` | `string` | opcional | — | `CheckingAccount`, `SalaryAccount`, `SavingsAccount`, `Transactional` | `"CheckingAccount"` |
| `openedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `ispb` | `string` | opcional | — | — | `"texto"` |
| `bankName` | `string` | opcional | — | — | `"Fulano de Tal"` |

Detalhe de `claimantDataAccount`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `agency` | `string` | opcional | — | — | `"texto"` |
| `accountNumber` | `string` | opcional | — | — | `"texto"` |
| `accountType` | `string` | opcional | — | `CheckingAccount`, `SalaryAccount`, `SavingsAccount`, `Transactional` | `"CheckingAccount"` |
| `openedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `ispb` | `string` | opcional | — | — | `"texto"` |
| `institutionName` | `string` | opcional | — | — | `"Fulano de Tal"` |

Detalhe de `pixKey`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `type` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic`, `AgencyAndAccount` | `"NaturalRegistrationNumber"` |
| `typeDisplay` | `string` | opcional | — | — | `"texto"` |
| `pixKey` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "claim": {
    "id": "texto",
    "status": "Open",
    "type": "Ownership",
    "cancelParticipant": "texto",
    "confirmationReason": "UserRequest",
    "cancelReason": "UserRequest"
  },
  "claimantPerson": {
    "personType": "texto",
    "registrationNumber": "12345678909",
    "name": "Fulano de Tal",
    "companyName": "Fulano de Tal"
  },
  "donorPerson": {
    "personType": "texto",
    "registrationNumber": "12345678909",
    "name": "Fulano de Tal",
    "companyName": "Fulano de Tal"
  },
  "donorDataAccount": {
    "agency": "texto",
    "accountNumber": "texto",
    "accountType": "CheckingAccount",
    "openedAt": "2025-08-11T13:45:00Z",
    "ispb": "texto",
    "bankName": "Fulano de Tal"
  },
  "claimantDataAccount": {
    "agency": "texto",
    "accountNumber": "texto",
    "accountType": "CheckingAccount",
    "openedAt": "2025-08-11T13:45:00Z",
    "ispb": "texto",
    "institutionName": "Fulano de Tal"
  },
  "pixKey": {
    "type": "NaturalRegistrationNumber",
    "typeDisplay": "texto",
    "pixKey": "texto"
  },
  "deadLine": "2025-08-11T13:45:00Z",
  "resolutionDeadLine": "2025-08-11T13:45:00Z",
  "lastRequest": "2025-08-11T13:45:00Z",
  "isDonorParticipant": true,
  "isClaimantParticipant": true,
  "isDonorPerson": true,
  "isClaimantPerson": true
}
```

**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/Pix/Key/Claim/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"
```

---

## PIX

Pagamentos instantâneos: envio, QR Code e devoluções.

### GET /v1/BankAccount/{id}/Pix/QRCode

**Obter informações por QRCode PIX** — 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` |
| `qrCode` | query | `string` | opcional | — | `valor` |
| `intendedPaymentDate` | query | `string (date-time)` | opcional | — | `valor` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `pixKey` | `string` | opcional | — | — | `"texto"` |
| `pixKeyType` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"NaturalRegistrationNumber"` |
| `pixKeyTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `endToEndId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `beneficiary` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `payer` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `valueInCents` | `integer (int64)` | opcional | — | — | `0` |
| `originalValueInCents` | `integer (int64)` | opcional | — | — | `0` |
| `interestValueInCents` | `integer (int64)` | opcional | — | — | `0` |
| `assessmentValueInCents` | `integer (int64)` | opcional | — | — | `0` |
| `discountValueInCents` | `integer (int64)` | opcional | — | — | `0` |
| `rebateValueInCents` | `integer (int64)` | opcional | — | — | `0` |
| `dueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `validityAfterExpiration` | `integer` | opcional | — | — | `1` |
| `txId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `info` | `string` | opcional | — | — | `"texto"` |
| `qrCodeType` | `string` | opcional | — | — | `"texto"` |
| `pixType` | `string` | opcional | — | — | `"texto"` |
| `recurrenceData` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |

Detalhe de `beneficiary`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `agency` | `string` | opcional | — | — | `"texto"` |
| `accountNumber` | `string` | opcional | — | — | `"texto"` |
| `accountType` | `string` | opcional | — | `CheckingAccount`, `SalaryAccount`, `SavingsAccount`, `Transactional` | `"CheckingAccount"` |
| `accountTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `ispb` | `string` | opcional | — | — | `"texto"` |
| `personType` | `string` | opcional | — | `Natural`, `Legal` | `"Natural"` |
| `personTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `bankName` | `string` | opcional | — | — | `"Fulano de Tal"` |

Detalhe de `payer`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `personType` | `string` | opcional | — | `Natural`, `Legal` | `"Natural"` |
| `personTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |

Exemplo:

```json
{
  "pixKey": "texto",
  "pixKeyType": "NaturalRegistrationNumber",
  "pixKeyTypeDisplay": "texto",
  "endToEndId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "beneficiary": {
    "agency": "texto",
    "accountNumber": "texto",
    "accountType": "CheckingAccount",
    "accountTypeDisplay": "texto",
    "ispb": "texto",
    "personType": "Natural",
    "personTypeDisplay": "texto",
    "registrationNumber": "12345678909",
    "name": "Fulano de Tal",
    "bankName": "Fulano de Tal"
  },
  "payer": {
    "personType": "Natural",
    "personTypeDisplay": "texto",
    "registrationNumber": "12345678909",
    "name": "Fulano de Tal"
  },
  "valueInCents": 0,
  "originalValueInCents": 0,
  "interestValueInCents": 0,
  "assessmentValueInCents": 0,
  "discountValueInCents": 0,
  "rebateValueInCents": 0,
  "dueDate": "2025-08-11T13:45:00Z",
  "validityAfterExpiration": 1,
  "txId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "info": "texto",
  "qrCodeType": "texto",
  "pixType": "texto",
  "recurrenceData": {
    "recurrenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "journey": "JORNADA_1",
    "journeyDisplay": "texto",
    "retry": "texto",
    "amountValueInCents": 0,
    "minimumAmountValueInCents": 0,
    "receiverBankIspb": "texto",
    "receiverName": "Fulano de Tal",
    "receiverRegistrationNumber": "texto",
    "payerCpf": "12345678909",
    "payerBankRegistrationNumber": "texto",
    "payerBankName": "Fulano de Tal",
    "firstRecurrenceDate": "2025-08-11T13:45:00Z",
    "lastRecurrenceDate": "2025-08-11T13:45:00Z",
    "periodicity": "MIAN",
    "contractNumber": "texto",
    "description": "texto",
    "updates": [
      {
        "updateDateTime": "2025-08-11T13:45:00Z",
        "status": "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/Pix/QRCode" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v1/BankAccount/Pix/QRCode

**Obter informações por QRCode PIX** — Lista e filtra registros de Bank Account.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `QRCode` | query | `string` | opcional | — | `valor` |
| `IntendedPaymentDate` | query | `string (date-time)` | opcional | — | `valor` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `pixKey` | `string` | opcional | — | — | `"texto"` |
| `pixKeyType` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"NaturalRegistrationNumber"` |
| `pixKeyTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `endToEndId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `beneficiary` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `payer` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `valueInCents` | `integer (int64)` | opcional | — | — | `0` |
| `originalValueInCents` | `integer (int64)` | opcional | — | — | `0` |
| `interestValueInCents` | `integer (int64)` | opcional | — | — | `0` |
| `assessmentValueInCents` | `integer (int64)` | opcional | — | — | `0` |
| `discountValueInCents` | `integer (int64)` | opcional | — | — | `0` |
| `rebateValueInCents` | `integer (int64)` | opcional | — | — | `0` |
| `dueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `validityAfterExpiration` | `integer` | opcional | — | — | `1` |
| `txId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `info` | `string` | opcional | — | — | `"texto"` |
| `qrCodeType` | `string` | opcional | — | — | `"texto"` |
| `pixType` | `string` | opcional | — | — | `"texto"` |
| `recurrenceData` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |

Detalhe de `beneficiary`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `agency` | `string` | opcional | — | — | `"texto"` |
| `accountNumber` | `string` | opcional | — | — | `"texto"` |
| `accountType` | `string` | opcional | — | `CheckingAccount`, `SalaryAccount`, `SavingsAccount`, `Transactional` | `"CheckingAccount"` |
| `accountTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `ispb` | `string` | opcional | — | — | `"texto"` |
| `personType` | `string` | opcional | — | `Natural`, `Legal` | `"Natural"` |
| `personTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `bankName` | `string` | opcional | — | — | `"Fulano de Tal"` |

Detalhe de `payer`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `personType` | `string` | opcional | — | `Natural`, `Legal` | `"Natural"` |
| `personTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |

Exemplo:

```json
{
  "pixKey": "texto",
  "pixKeyType": "NaturalRegistrationNumber",
  "pixKeyTypeDisplay": "texto",
  "endToEndId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "beneficiary": {
    "agency": "texto",
    "accountNumber": "texto",
    "accountType": "CheckingAccount",
    "accountTypeDisplay": "texto",
    "ispb": "texto",
    "personType": "Natural",
    "personTypeDisplay": "texto",
    "registrationNumber": "12345678909",
    "name": "Fulano de Tal",
    "bankName": "Fulano de Tal"
  },
  "payer": {
    "personType": "Natural",
    "personTypeDisplay": "texto",
    "registrationNumber": "12345678909",
    "name": "Fulano de Tal"
  },
  "valueInCents": 0,
  "originalValueInCents": 0,
  "interestValueInCents": 0,
  "assessmentValueInCents": 0,
  "discountValueInCents": 0,
  "rebateValueInCents": 0,
  "dueDate": "2025-08-11T13:45:00Z",
  "validityAfterExpiration": 1,
  "txId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "info": "texto",
  "qrCodeType": "texto",
  "pixType": "texto",
  "recurrenceData": {
    "recurrenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "journey": "JORNADA_1",
    "journeyDisplay": "texto",
    "retry": "texto",
    "amountValueInCents": 0,
    "minimumAmountValueInCents": 0,
    "receiverBankIspb": "texto",
    "receiverName": "Fulano de Tal",
    "receiverRegistrationNumber": "texto",
    "payerCpf": "12345678909",
    "payerBankRegistrationNumber": "texto",
    "payerBankName": "Fulano de Tal",
    "firstRecurrenceDate": "2025-08-11T13:45:00Z",
    "lastRecurrenceDate": "2025-08-11T13:45:00Z",
    "periodicity": "MIAN",
    "contractNumber": "texto",
    "description": "texto",
    "updates": [
      {
        "updateDateTime": "2025-08-11T13:45:00Z",
        "status": "texto"
      }
    ]
  }
}
```

**Códigos de retorno**

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

**cURL**

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

---

### POST /v1/BankAccount/{id}/Pix/QRCode/Static

**Gerar PIX QRCode estático** — 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 |
|---|---|---|---|---|---|
| `txId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `beneficiary` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `valueInCents` | `integer (int64)` | opcional | — | — | `0` |
| `description` | `string` | opcional | — | — | `"texto"` |

Detalhe de `beneficiary`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `pixKey` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |

Detalhe de `pixKey`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `type` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic` | `"NaturalRegistrationNumber"` |
| `key` | `string` | opcional | — | — | `"texto"` |
| `descriptionType` | `string` | opcional | — | — | `"texto"` |
| `formattedKey` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "txId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "beneficiary": {
    "pixKey": {
      "type": "NaturalRegistrationNumber",
      "key": "texto",
      "descriptionType": "texto",
      "formattedKey": "texto"
    }
  },
  "valueInCents": 0,
  "description": "texto"
}
```

**Resposta 200**

Campos:

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

Exemplo:

```json
{
  "qrCode": "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/Pix/QRCode/Static" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "txId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "beneficiary": {
    "pixKey": {
      "type": "NaturalRegistrationNumber",
      "key": "texto",
      "descriptionType": "texto",
      "formattedKey": "texto"
    }
  },
  "valueInCents": 0,
  "description": "texto"
}'
```

---

### POST /v1/BankAccount/{id}/Pix/QRCode/ImmediateDynamic

**Gerar PIX QRCode dinâmico** — 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 |
|---|---|---|---|---|---|
| `txId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `beneficiary` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `payer` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `valueInCents` | `integer (int64)` | opcional | — | — | `0` |
| `expirationDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `beneficiary`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `pixKey` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |

Detalhe de `payer`:

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

Detalhe de `pixKey`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `type` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic` | `"NaturalRegistrationNumber"` |
| `key` | `string` | opcional | — | — | `"texto"` |
| `descriptionType` | `string` | opcional | — | — | `"texto"` |
| `formattedKey` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "txId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "beneficiary": {
    "pixKey": {
      "type": "NaturalRegistrationNumber",
      "key": "texto",
      "descriptionType": "texto",
      "formattedKey": "texto"
    }
  },
  "payer": {
    "registrationNumber": "12345678909",
    "name": "Fulano de Tal"
  },
  "valueInCents": 0,
  "expirationDate": "2025-08-11T13:45:00Z"
}
```

**Resposta 200**

Campos:

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

Exemplo:

```json
{
  "qrCode": "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/Pix/QRCode/ImmediateDynamic" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "txId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "beneficiary": {
    "pixKey": {
      "type": "NaturalRegistrationNumber",
      "key": "texto",
      "descriptionType": "texto",
      "formattedKey": "texto"
    }
  },
  "payer": {
    "registrationNumber": "12345678909",
    "name": "Fulano de Tal"
  },
  "valueInCents": 0,
  "expirationDate": "2025-08-11T13:45:00Z"
}'
```

---

### POST /v1/BankAccount/{id}/Pix/QRCode/DynamicWithDueDate

**Gerar PIX QRCode dinâmico com data de vencimento** — 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 |
|---|---|---|---|---|---|
| `txId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `beneficiary` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `payer` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `value` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `expirationDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `discountLimitDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Detalhe de `beneficiary`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `pixKey` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |

Detalhe de `payer`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `email` | `string` | opcional | — | — | `"cliente@exemplo.com.br"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `city` | `string` | opcional | — | — | `"texto"` |
| `zipCode` | `string` | opcional | — | — | `"01310930"` |
| `addressNumber` | `string` | opcional | — | — | `"texto"` |
| `uf` | `string` | opcional | — | `NaoSelecionado`, `AC`, `AL`, `AP`, `AM`, `BA`, `CE`, `DF`, `ES`, `GO`, `MA`, `MT`, `MS`, `MG`, `PA`, `PB`, `PR`, `PE`, `PI`, `RJ`, `RN`, `RS`, `RO`, `RR`, `SC`, `SP`, `SE`, `TO` | `"NaoSelecionado"` |

Detalhe de `value`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `originalValueInCents` | `integer (int64)` | opcional | — | — | `0` |
| `interestValueInCents` | `integer (int64)` | opcional | — | — | `0` |
| `assessmentValueInCents` | `integer (int64)` | opcional | — | — | `0` |
| `discountValueInCents` | `integer (int64)` | opcional | — | — | `0` |
| `rebateValueInCents` | `integer (int64)` | opcional | — | — | `0` |

Detalhe de `pixKey`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `type` | `string` | opcional | — | `NaturalRegistrationNumber`, `LegalRegistrationNumber`, `Phone`, `Email`, `Automatic` | `"NaturalRegistrationNumber"` |
| `key` | `string` | opcional | — | — | `"texto"` |
| `descriptionType` | `string` | opcional | — | — | `"texto"` |
| `formattedKey` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "txId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "beneficiary": {
    "pixKey": {
      "type": "NaturalRegistrationNumber",
      "key": "texto",
      "descriptionType": "texto",
      "formattedKey": "texto"
    }
  },
  "payer": {
    "name": "Fulano de Tal",
    "email": "cliente@exemplo.com.br",
    "registrationNumber": "12345678909",
    "city": "texto",
    "zipCode": "01310930",
    "addressNumber": "texto",
    "uf": "NaoSelecionado"
  },
  "value": {
    "originalValueInCents": 0,
    "interestValueInCents": 0,
    "assessmentValueInCents": 0,
    "discountValueInCents": 0,
    "rebateValueInCents": 0
  },
  "expirationDate": "2025-08-11T13:45:00Z",
  "discountLimitDate": "2025-08-11T13:45:00Z"
}
```

**Resposta 200**

Campos:

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

Exemplo:

```json
{
  "qrCode": "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/Pix/QRCode/DynamicWithDueDate" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "txId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "beneficiary": {
    "pixKey": {
      "type": "NaturalRegistrationNumber",
      "key": "texto",
      "descriptionType": "texto",
      "formattedKey": "texto"
    }
  },
  "payer": {
    "name": "Fulano de Tal",
    "email": "cliente@exemplo.com.br",
    "registrationNumber": "12345678909",
    "city": "texto",
    "zipCode": "01310930",
    "addressNumber": "texto",
    "uf": "NaoSelecionado"
  },
  "value": {
    "originalValueInCents": 0,
    "interestValueInCents": 0,
    "assessmentValueInCents": 0,
    "discountValueInCents": 0,
    "rebateValueInCents": 0
  },
  "expirationDate": "2025-08-11T13:45:00Z",
  "discountLimitDate": "2025-08-11T13:45:00Z"
}'
```

---

### GET /v1/BankAccount/{id}/Pix/e2e/{endToEndId}

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

**Parâmetros**

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

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `endToEndId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `status` | `string` | opcional | — | `Sent`, `Effective`, `Refused`, `Error` | `"Sent"` |

Exemplo:

```json
{
  "endToEndId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "Sent"
}
```

**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/Pix/e2e/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"
```

---

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

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

**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 |
|---|---|---|---|---|---|
| `transferId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `endToEndId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `status` | `string` | opcional | — | `Sent`, `Effective`, `Refused`, `Error` | `"Sent"` |
| `statusMessage` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "transferId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "endToEndId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "Sent",
  "statusMessage": "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/Pix/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /v1/BankAccount/{id}/Pix/Refund

**Incluir devolução de um pix recebido** — 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 |
|---|---|---|---|---|---|
| `transferId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `originalEndToEndId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `reason` | `string` | opcional | — | `BE08`, `FR01`, `MD06`, `SL02` | `"BE08"` |
| `observation` | `string` | opcional | — | — | `"texto"` |
| `valueInCents` | `integer (int64)` | opcional | — | — | `0` |
| `waitSuccess` | `integer` | opcional | — | — | `0` |

Exemplo:

```json
{
  "transferId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "originalEndToEndId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reason": "BE08",
  "observation": "texto",
  "valueInCents": 0,
  "waitSuccess": 0
}
```

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `transferId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `endToEndId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `status` | `string` | opcional | — | `Sent`, `Effective`, `Refused`, `Error` | `"Sent"` |
| `statusMessage` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "transferId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "endToEndId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "Sent",
  "statusMessage": "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/Pix/Refund" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "transferId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "originalEndToEndId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reason": "BE08",
  "observation": "texto",
  "valueInCents": 0,
  "waitSuccess": 0
}'
```

---

### GET /v1/BankAccount/{id}/Pix/InfrigmentReport

**Consultar lista de relato de infração** — 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` |
| `Status` | query | `string` | opcional | — | `valor` |

**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"` |
| `infrigmentReportId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `infrigmentReportDetails` | `string` | opcional | — | — | `"texto"` |
| `endToEndOriginal` | `string` | opcional | — | — | `"texto"` |
| `status` | `string` | opcional | — | `OPEN`, `ACKNOWLEDGED`, `CLOSED`, `CANCELLED` | `"OPEN"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `createdAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Exemplo:

```json
{
  "data": [
    {
      "id": "texto",
      "infrigmentReportId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "infrigmentReportDetails": "texto",
      "endToEndOriginal": "texto",
      "status": "OPEN",
      "statusDisplay": "texto",
      "createdAt": "2025-08-11T13:45:00Z"
    }
  ],
  "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/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/InfrigmentReport" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /v1/BankAccount/Pix/ReportXml

**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 |
|---|---|---|---|---|---|
| `startDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `endDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `ispb` | `string` | opcional | — | — | `"texto"` |
| `nameResponsible` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `emailResponsible` | `string` | opcional | — | — | `"cliente@exemplo.com.br"` |
| `foneResponsible` | `string` | opcional | — | — | `"texto"` |
| `typeSend` | `string` | opcional | — | `I`, `S` | `"I"` |
| `typeSendValue` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "startDate": "2025-08-11T13:45:00Z",
  "endDate": "2025-08-11T13:45:00Z",
  "ispb": "texto",
  "nameResponsible": "Fulano de Tal",
  "emailResponsible": "cliente@exemplo.com.br",
  "foneResponsible": "texto",
  "typeSend": "I",
  "typeSendValue": "texto"
}
```

**Códigos de retorno**

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

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/BankAccount/Pix/ReportXml" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "startDate": "2025-08-11T13:45:00Z",
  "endDate": "2025-08-11T13:45:00Z",
  "ispb": "texto",
  "nameResponsible": "Fulano de Tal",
  "emailResponsible": "cliente@exemplo.com.br",
  "foneResponsible": "texto",
  "typeSend": "I",
  "typeSendValue": "texto"
}'
```

---

### DELETE /v1/BankAccount/Pix/QRCode/DeleteQrCode

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

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `qrCode` | query | `string` | opcional | — | `valor` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `transactionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `message` | `string` | opcional | — | — | `"texto"` |
| `qrCodeId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `qrCode` | `string` | opcional | — | — | `"texto"` |
| `txId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |

Exemplo:

```json
{
  "transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "message": "texto",
  "qrCodeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "qrCode": "texto",
  "txId": "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/Pix/QRCode/DeleteQrCode" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v1/BankAccount/{id}/Pix/Automatic

**Obter todos os registros de recorrência de pix automático** — 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` |
| `status` | query | `objeto` | opcional | — | `valor` |
| `page` | query | `integer` | opcional | — | `10` |
| `size` | query | `integer` | opcional | — | `10` |
| `isDeleted` | query | `boolean` | opcional | — | `true` |
| `orderBy` | query | `string` | opcional | — | `valor` |

**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"` |
| `bankAccountId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `bankAccount` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `automaticPixItemId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `automaticPixItem` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `status` | `string` | opcional | — | `Processing`, `Confirmed`, `Rejected`, `Canceled`, `PendingPayer`, `PendingUser`, `Activated`, `CancellationRequested` | `"Processing"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `amount` | `integer (int64)` | opcional | — | — | `0` |
| `sequenceType` | `string` | opcional | — | `RCUR` | `"RCUR"` |
| `frequencyType` | `string` | opcional | — | `MIAN`, `MNTH`, `QURT`, `WEEK`, `YEAR` | `"MIAN"` |
| `frequencyTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `firstRecurrenceDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `lastRecurrenceDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `recurrenceId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `contractNumber` | `string` | opcional | — | — | `"texto"` |
| `receivingUserName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `receivingUserRegistrationNumber` | `string` | opcional | — | — | `"texto"` |
| `receivingBankISPB` | `string` | opcional | — | — | `"texto"` |
| `isDeleted` | `boolean` | opcional | — | — | `true` |

Exemplo:

```json
{
  "data": [
    {
      "id": "texto",
      "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "bankAccount": {
        "id": "texto",
        "createdAt": "2025-08-11T13:45:00Z",
        "createdBy": {},
        "tenant": "texto",
        "tenantDisplay": "texto",
        "updatedAt": "2025-08-11T13:45:00Z",
        "updatedBy": {},
        "ownerUser": {},
        "ownerGroup": {},
        "bankCode": 0,
        "bankCodeDisplay": "texto",
        "bankIspb": 0,
        "account": "texto",
        "agency": "texto",
        "type": {},
        "typeDisplay": "texto",
        "modality": {},
        "modalityDisplay": "texto",
        "quorumMinimumApproval": 0,
        "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenantName": "Fulano de Tal",
        "isDeleted": true,
        "status": {},
        "statusDisplay": "texto",
        "person": {},
        "balance": {},
        "creditors": []
      },
      "automaticPixItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "automaticPixItem": {
        "id": "texto",
        "createdAt": "2025-08-11T13:45:00Z",
        "mandanteIdentification": "texto",
        "mandanteRequestIdentification": "texto",
        "occurrencesSequenceType": "texto",
        "occurrencesFrequency": {},
        "occurrencesFirstRecurrenceDate": "2025-08-11T13:45:00Z",
        "occurrencesFinalRecurrenceDate": "2025-08-11T13:45:00Z",
        "trackingIndicator": true,
        "collectionAmount": 0,
        "creditorName": "Fulano de Tal",
        "creditorIdentification": "texto",
        "creditorAgentMemberIdentification": "texto",
        "debtoIdentification": "texto",
        "debtorAccountIdentification": "texto",
        "debtorAccountIssuer": "texto",
        "debtorAgentMemberIdentification": "texto",
        "ultimateDebtorName": "Fulano de Tal",
        "ultimateIdentification": "texto",
        "createConfirmationRequestDate": "2025-08-11T13:45:00Z",
        "referredDocumentNumber": "texto",
        "referredDocumentCreditorReference": "texto",
        "createRecurrencePeriodicPaymentDate": "2025-08-11T13:45:00Z",
        "confirmationRequestExpirationDate": "2025-08-11T13:45:00Z",
        "maxColletionAmount": 0
      },
      "status": "Processing",
      "statusDisplay": "texto",
      "amount": 0,
      "sequenceType": "RCUR",
      "frequencyType": "MIAN",
      "frequencyTypeDisplay": "texto",
      "firstRecurrenceDate": "2025-08-11T13:45:00Z",
      "lastRecurrenceDate": "2025-08-11T13:45:00Z",
      "recurrenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "contractNumber": "texto",
      "receivingUserName": "Fulano de Tal",
      "receivingUserRegistrationNumber": "texto",
      "receivingBankISPB": "texto",
      "isDeleted": true
    }
  ],
  "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/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/Automatic" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v1/BankAccount/{id}/Pix/Automatic/{automaticPixId}

**Obter registro de recorrência de um pix automático** — Consulta Bank Account pelo identificador informado na rota.

**Parâmetros**

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

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `bankAccountId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `bankAccount` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `automaticPixItemId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `automaticPixItem` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `status` | `string` | opcional | — | `Processing`, `Confirmed`, `Rejected`, `Canceled`, `PendingPayer`, `PendingUser`, `Activated`, `CancellationRequested` | `"Processing"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `amount` | `integer (int64)` | opcional | — | — | `0` |
| `sequenceType` | `string` | opcional | — | `RCUR` | `"RCUR"` |
| `frequencyType` | `string` | opcional | — | `MIAN`, `MNTH`, `QURT`, `WEEK`, `YEAR` | `"MIAN"` |
| `frequencyTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `firstRecurrenceDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `lastRecurrenceDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `recurrenceId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `contractNumber` | `string` | opcional | — | — | `"texto"` |
| `receivingUserName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `receivingUserRegistrationNumber` | `string` | opcional | — | — | `"texto"` |
| `receivingBankISPB` | `string` | opcional | — | — | `"texto"` |
| `isDeleted` | `boolean` | opcional | — | — | `true` |

Exemplo:

```json
{
  "id": "texto",
  "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "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": {
        "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"
      },
      "registrationNumber": "12345678909",
      "name": "Fulano de Tal"
    },
    "balance": {
      "currentBalance": 0,
      "blockedBalance": 0,
      "available": 0,
      "bankAccount": {
        "bankCode": 0,
        "bankIspb": 0,
        "bankCodeDisplay": "texto",
        "type": {},
        "typeDisplay": "texto",
        "modality": {},
        "modalityDisplay": "texto",
        "account": 0,
        "agency": 0,
        "personRegistrationNumber": "texto",
        "personName": "Fulano de Tal",
        "isDeleted": true,
        "status": {},
        "creditors": []
      }
    },
    "creditors": [
      {
        "id": "texto",
        "name": "Fulano de Tal",
        "tenant": "texto"
      }
    ]
  },
  "automaticPixItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "automaticPixItem": {
    "id": "texto",
    "createdAt": "2025-08-11T13:45:00Z",
    "mandanteIdentification": "texto",
    "mandanteRequestIdentification": "texto",
    "occurrencesSequenceType": "texto",
    "occurrencesFrequency": "MIAN",
    "occurrencesFirstRecurrenceDate": "2025-08-11T13:45:00Z",
    "occurrencesFinalRecurrenceDate": "2025-08-11T13:45:00Z",
    "trackingIndicator": true,
    "collectionAmount": 0,
    "creditorName": "Fulano de Tal",
    "creditorIdentification": "texto",
    "creditorAgentMemberIdentification": "texto",
    "debtoIdentification": "texto",
    "debtorAccountIdentification": "texto",
    "debtorAccountIssuer": "texto",
    "debtorAgentMemberIdentification": "texto",
    "ultimateDebtorName": "Fulano de Tal",
    "ultimateIdentification": "texto",
    "createConfirmationRequestDate": "2025-08-11T13:45:00Z",
    "referredDocumentNumber": "texto",
    "referredDocumentCreditorReference": "texto",
    "createRecurrencePeriodicPaymentDate": "2025-08-11T13:45:00Z",
    "confirmationRequestExpirationDate": "2025-08-11T13:45:00Z",
    "maxColletionAmount": 0
  },
  "status": "Processing",
  "statusDisplay": "texto",
  "amount": 0,
  "sequenceType": "RCUR",
  "frequencyType": "MIAN",
  "frequencyTypeDisplay": "texto",
  "firstRecurrenceDate": "2025-08-11T13:45:00Z",
  "lastRecurrenceDate": "2025-08-11T13:45:00Z",
  "recurrenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "contractNumber": "texto",
  "receivingUserName": "Fulano de Tal",
  "receivingUserRegistrationNumber": "texto",
  "receivingBankISPB": "texto",
  "isDeleted": true
}
```

**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/Pix/Automatic/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v1/BankAccount/{id}/Pix/Automatic/ScheduledPayments

**Obter registro de pagamentos agendados do pix automático** — 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` |
| `status` | query | `objeto` | opcional | — | `Scheduled` |
| `page` | query | `integer` | opcional | — | `10` |
| `size` | query | `integer` | opcional | — | `10` |
| `isDeleted` | query | `boolean` | opcional | — | `true` |
| `orderBy` | query | `string` | opcional | — | `valor` |

**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 |
|---|---|---|---|---|---|
| `transfer` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `automaticPix` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |

Exemplo:

```json
{
  "data": [
    {
      "transfer": {
        "id": "texto",
        "createdAt": "2025-08-11T13:45:00Z",
        "createdBy": {},
        "tenant": "texto",
        "tenantDisplay": "texto",
        "updatedAt": "2025-08-11T13:45:00Z",
        "updatedBy": {},
        "ownerUser": {},
        "ownerGroup": {},
        "nsu": "texto",
        "amount": 0,
        "transferDate": "2025-08-11T13:45:00Z",
        "paymentPurpose": {},
        "paymentPurposeDisplay": "texto",
        "status": {},
        "statusDisplay": "texto",
        "accountingEntry": "texto",
        "errorMessage": "texto",
        "reversalCodeReason": "texto",
        "reversalDescriptionReason": "texto",
        "bankAccountBeneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "bankAccountBeneficiary": {},
        "authorizedAt": "2025-08-11T13:45:00Z",
        "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "requester": {},
        "approvals": []
      },
      "automaticPix": {
        "id": "texto",
        "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "bankAccount": {},
        "automaticPixItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "automaticPixItem": {},
        "status": {},
        "statusDisplay": "texto",
        "amount": 0,
        "sequenceType": {},
        "frequencyType": {},
        "frequencyTypeDisplay": "texto",
        "firstRecurrenceDate": "2025-08-11T13:45:00Z",
        "lastRecurrenceDate": "2025-08-11T13:45:00Z",
        "recurrenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "contractNumber": "texto",
        "receivingUserName": "Fulano de Tal",
        "receivingUserRegistrationNumber": "texto",
        "receivingBankISPB": "texto",
        "isDeleted": true
      }
    }
  ],
  "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/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/Automatic/ScheduledPayments" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /v1/BankAccount/{id}/Pix/Automatic/{automaticPixId}/approve

**Ação do usuário para um recorrência de pix automático** — 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` |
| `automaticPixId` | 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"` |
| `action` | `string` | opcional | — | `Approve`, `Reject`, `Cancel` | `"Approve"` |

Exemplo:

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

**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/Pix/Automatic/3fa85f64-5717-4562-b3fc-2c963f66afa6/approve" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto",
  "action": "Approve"
}'
```

---

### POST /v1/BankAccount/{id}/Pix/Automatic/authorize

**Autorizar recorrência do pix automático via leitura de QRCode** — 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 |
|---|---|---|---|---|---|
| `sessionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `code` | `string` | opcional | — | — | `"texto"` |
| `recurrenceId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `journey` | `string` | opcional | — | `JORNADA_1`, `JORNADA_2`, `JORNADA_3`, `JORNADA_4` | `"JORNADA_1"` |
| `amountValueInCents` | `integer (int64)` | opcional | — | — | `0` |
| `maxAmountValueInCents` | `integer (int64)` | opcional | — | — | `0` |
| `receiverName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `receiverRegistrationNumber` | `string` | opcional | — | — | `"texto"` |
| `receiverBankIspb` | `string` | opcional | — | — | `"texto"` |
| `payerBankRegistrationNumber` | `string` | opcional | — | — | `"texto"` |
| `firstRecurrenceDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `lastRecurrenceDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `periodicity` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"MIAN"` |
| `contractNumber` | `string` | opcional | — | — | `"texto"` |
| `description` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto",
  "recurrenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "journey": "JORNADA_1",
  "amountValueInCents": 0,
  "maxAmountValueInCents": 0,
  "receiverName": "Fulano de Tal",
  "receiverRegistrationNumber": "texto",
  "receiverBankIspb": "texto",
  "payerBankRegistrationNumber": "texto",
  "firstRecurrenceDate": "2025-08-11T13:45:00Z",
  "lastRecurrenceDate": "2025-08-11T13:45:00Z",
  "periodicity": "MIAN",
  "contractNumber": "texto",
  "description": "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/Pix/Automatic/authorize" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto",
  "recurrenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "journey": "JORNADA_1",
  "amountValueInCents": 0,
  "maxAmountValueInCents": 0,
  "receiverName": "Fulano de Tal",
  "receiverRegistrationNumber": "texto",
  "receiverBankIspb": "texto",
  "payerBankRegistrationNumber": "texto",
  "firstRecurrenceDate": "2025-08-11T13:45:00Z",
  "lastRecurrenceDate": "2025-08-11T13:45:00Z",
  "periodicity": "MIAN",
  "contractNumber": "texto",
  "description": "texto"
}'
```

---

### POST /v1/BankAccount/{id}/Pix/Automatic/{automaticPixId}/cancel

**Solicitar cancelamento da autorização de recorrência do pix automático** — 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` |
| `automaticPixId` | 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"` |

Exemplo:

```json
{
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "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/Pix/Automatic/3fa85f64-5717-4562-b3fc-2c963f66afa6/cancel" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}'
```

---

### POST /v1/BankAccount/Pix/Poolling

**Reprocessamento de recorrências** — Cria um novo registro de Bank Account.

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `startDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Exemplo:

```json
{
  "startDate": "2025-08-11T13:45:00Z"
}
```

**Códigos de retorno**

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

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/BankAccount/Pix/Poolling" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "startDate": "2025-08-11T13:45:00Z"
}'
```

---

### GET /v1/BankAccount/{id}/Pix/Contestations/Made

**Lista contestações feitas (REPORTED)** — Lista e filtra registros de Bank Account.

Lista contestações feitas (REPORTED).

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string` | obrigatório | Id da conta. | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `registrationNumber` | query | `string` | opcional | CPF/CNPJ do cliente. | `valor` |
| `recipientName` | query | `string` | opcional | Nome do destinatário. | `valor` |
| `bankCode` | query | `string` | opcional | Código do banco. | `valor` |
| `agencyCode` | query | `string` | opcional | Agência. | `valor` |
| `accountNumber` | query | `string` | opcional | Número da conta. | `valor` |
| `transactionId` | query | `string` | opcional | ID da transação EndToEndId ou NSU. | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `status` | query | `objeto` | opcional | Filtro de status. | `valor` |
| `startDate` | query | `string (date-time)` | opcional | Data inicial. | `valor` |
| `endDate` | query | `string (date-time)` | opcional | Data final. | `valor` |
| `page` | query | `integer` | opcional | Número da página. | `10` |
| `pageSize` | query | `integer` | opcional | Itens por página. | `10` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `infractionReportId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `bankCode` | `string` | opcional | — | — | `"texto"` |
| `bankName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `operationAmount` | `number (decimal)` | opcional | — | — | `1000` |
| `recoveredAmount` | `number (decimal)` | opcional | — | — | `1000` |
| `transactionDateTime` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `contestationDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `status` | `string` | opcional | — | `UNKNOWN`, `IN_ANALYSIS`, `APPROVED`, `PARTIALLY_REFUNDED`, `FULLY_REFUNDED`, `REJECTED`, `DEADLINE_EXPIRED`, `CANCELLED` | `"UNKNOWN"` |
| `contestationType` | `string` | opcional | — | `REPORTED`, `CONTESTED` | `"REPORTED"` |
| `reason` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"UNKNOWN"` |
| `analysisDaysRemaining` | `integer` | opcional | — | — | `0` |
| `recoveryDaysRemaining` | `integer` | opcional | — | — | `0` |
| `analysisDeadline` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `recoveryDeadline` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Exemplo:

```json
[
  {
    "infractionReportId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Fulano de Tal",
    "registrationNumber": "12345678909",
    "bankCode": "texto",
    "bankName": "Fulano de Tal",
    "operationAmount": 1000,
    "recoveredAmount": 1000,
    "transactionDateTime": "2025-08-11T13:45:00Z",
    "contestationDate": "2025-08-11T13:45:00Z",
    "status": "UNKNOWN",
    "contestationType": "REPORTED",
    "reason": "UNKNOWN",
    "analysisDaysRemaining": 0,
    "recoveryDaysRemaining": 0,
    "analysisDeadline": "2025-08-11T13:45:00Z",
    "recoveryDeadline": "2025-08-11T13:45:00Z"
  }
]
```

**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. |
| `500` | Erro interno no servidor. |

**cURL**

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

---

### GET /v1/BankAccount/{id}/Pix/Contestations/Received

**Lista contestações recebidas (CONTESTED)** — Lista e filtra registros de Bank Account.

Lista contestações recebidas (CONTESTED).

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string` | obrigatório | Id da conta. | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `registrationNumber` | query | `string` | opcional | CPF/CNPJ do cliente. | `valor` |
| `recipientName` | query | `string` | opcional | Nome do destinatário (opcional). | `valor` |
| `bankCode` | query | `string` | opcional | Código do banco ISPB (opcional). | `valor` |
| `agencyCode` | query | `string` | opcional | Agência (opcional). | `valor` |
| `accountNumber` | query | `string` | opcional | Número da conta (opcional). | `valor` |
| `transactionId` | query | `string` | opcional | ID da transação EndToEndId (opcional). | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `status` | query | `objeto` | opcional | Filtro de status (opcional). | `valor` |
| `startDate` | query | `string (date-time)` | opcional | Data inicial (opcional). | `valor` |
| `endDate` | query | `string (date-time)` | opcional | Data final (opcional). | `valor` |
| `startTime` | query | `string` | opcional | Hora inicial HH:mm:ss (opcional). | `valor` |
| `endTime` | query | `string` | opcional | Hora final HH:mm:ss (opcional). | `valor` |
| `page` | query | `integer` | opcional | Número da página. | `10` |
| `pageSize` | query | `integer` | opcional | Itens por página. | `10` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `infractionReportId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `bankCode` | `string` | opcional | — | — | `"texto"` |
| `bankName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `operationAmount` | `number (decimal)` | opcional | — | — | `1000` |
| `recoveredAmount` | `number (decimal)` | opcional | — | — | `1000` |
| `transactionDateTime` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `contestationDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `status` | `string` | opcional | — | `UNKNOWN`, `IN_ANALYSIS`, `APPROVED`, `PARTIALLY_REFUNDED`, `FULLY_REFUNDED`, `REJECTED`, `DEADLINE_EXPIRED`, `CANCELLED` | `"UNKNOWN"` |
| `contestationType` | `string` | opcional | — | `REPORTED`, `CONTESTED` | `"REPORTED"` |
| `reason` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"UNKNOWN"` |
| `analysisDaysRemaining` | `integer` | opcional | — | — | `0` |
| `recoveryDaysRemaining` | `integer` | opcional | — | — | `0` |
| `analysisDeadline` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `recoveryDeadline` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Exemplo:

```json
[
  {
    "infractionReportId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Fulano de Tal",
    "registrationNumber": "12345678909",
    "bankCode": "texto",
    "bankName": "Fulano de Tal",
    "operationAmount": 1000,
    "recoveredAmount": 1000,
    "transactionDateTime": "2025-08-11T13:45:00Z",
    "contestationDate": "2025-08-11T13:45:00Z",
    "status": "UNKNOWN",
    "contestationType": "REPORTED",
    "reason": "UNKNOWN",
    "analysisDaysRemaining": 0,
    "recoveryDaysRemaining": 0,
    "analysisDeadline": "2025-08-11T13:45:00Z",
    "recoveryDeadline": "2025-08-11T13:45:00Z"
  }
]
```

**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. |
| `500` | Erro interno no servidor. |

**cURL**

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

---

### GET /v1/BankAccount/{id}/Pix/Contestations/{infractionReportId}

**Busca detalhes da contestação** — Consulta Bank Account pelo identificador informado na rota.

Busca detalhes da contestação.

**Parâmetros**

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

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `infractionReportId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `transactionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `contestationType` | `string` | opcional | — | `REPORTED`, `CONTESTED` | `"REPORTED"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `recipientName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `bankCode` | `string` | opcional | — | — | `"texto"` |
| `bankName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `agencyCode` | `string` | opcional | — | — | `"texto"` |
| `accountNumber` | `string` | opcional | — | — | `"texto"` |
| `accountType` | `string` | opcional | — | `CheckingAccount`, `SalaryAccount`, `SavingsAccount`, `Transactional` | `"CheckingAccount"` |
| `transactionDateTime` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `operationAmount` | `number (decimal)` | opcional | — | — | `1000` |
| `recoveredAmount` | `number (decimal)` | opcional | — | — | `1000` |
| `status` | `string` | opcional | — | `UNKNOWN`, `IN_ANALYSIS`, `APPROVED`, `PARTIALLY_REFUNDED`, `FULLY_REFUNDED`, `REJECTED`, `DEADLINE_EXPIRED`, `CANCELLED` | `"UNKNOWN"` |
| `medStatus` | `string` | opcional | — | `Unknown`, `OPEN`, `ACKNOWLEDGED`, `CLOSED`, `CANCELLED` | `"Unknown"` |
| `observations` | `string` | opcional | — | — | `"texto"` |
| `createdAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `lastUpdatedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `bancoRendimentoSentAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Exemplo:

```json
{
  "infractionReportId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "contestationType": "REPORTED",
  "registrationNumber": "12345678909",
  "recipientName": "Fulano de Tal",
  "bankCode": "texto",
  "bankName": "Fulano de Tal",
  "agencyCode": "texto",
  "accountNumber": "texto",
  "accountType": "CheckingAccount",
  "transactionDateTime": "2025-08-11T13:45:00Z",
  "operationAmount": 1000,
  "recoveredAmount": 1000,
  "status": "UNKNOWN",
  "medStatus": "Unknown",
  "observations": "texto",
  "createdAt": "2025-08-11T13:45:00Z",
  "lastUpdatedAt": "2025-08-11T13:45:00Z",
  "bancoRendimentoSentAt": "2025-08-11T13:45:00Z"
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `404` | Recurso não encontrado. |
| `500` | Erro interno no servidor. |

**cURL**

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

---

### POST /v1/BankAccount/{id}/Pix/Contestations

**Cria contestação PIX** — Cria um novo registro de Bank Account.

Cria contestação PIX.

**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 |
|---|---|---|---|---|---|
| `endToEndId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `reason` | `string` | opcional | — | `UNKNOWN`, `FRAUD_SCAM`, `UNAUTHORIZED_TRANSACTION`, `COERCION_CRIME`, `FRAUDULENT_ACCESS`, `OTHER` | `"UNKNOWN"` |
| `clientObservation` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "endToEndId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "reason": "UNKNOWN",
  "clientObservation": "texto"
}
```

**Resposta 200**

Campos:

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

Exemplo:

```json
{
  "infractionReportId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "message": "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). |
| `500` | Erro interno no servidor. |

**cURL**

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

---

### POST /v1/BankAccount/{id}/Pix/Contestations/{infractionReportId}/Cancel

**Cancela contestação PIX** — Cria um novo registro de Bank Account.

Cancela contestação PIX.

**Parâmetros**

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

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

Campos:

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

Exemplo:

```json
{
  "registrationNumber": "12345678909"
}
```

**Resposta 200**

Exemplo:

```json
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). |
| `404` | Recurso não encontrado. |
| `500` | Erro interno no servidor. |

**cURL**

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

---

### POST /v1/BankAccount/{id}/Pix/Contestations/Import

**Importa contestações do PIX MED que ainda não existem no banco local** — Cria um novo registro de Bank Account.

Importa contestações do PIX MED que ainda não existem no banco local.

**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 |
|---|---|---|---|---|---|
| `codAgencia` | `string` | opcional | — | — | `"texto"` |
| `nroConta` | `string` | opcional | — | — | `"texto"` |
| `cpfCnpj` | `string` | opcional | — | — | `"12345678909"` |
| `tipoConta` | `string` | opcional | — | `CheckingAccount`, `SalaryAccount`, `SavingsAccount`, `Transactional` | `"CheckingAccount"` |
| `dataInicio` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `dataFim` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `contestationType` | `string` | opcional | — | `REPORTED`, `CONTESTED` | `"REPORTED"` |

Exemplo:

```json
{
  "codAgencia": "texto",
  "nroConta": "texto",
  "cpfCnpj": "12345678909",
  "tipoConta": "CheckingAccount",
  "dataInicio": "2025-08-11T13:45:00Z",
  "dataFim": "2025-08-11T13:45:00Z",
  "contestationType": "REPORTED"
}
```

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `totalFound` | `integer` | opcional | — | — | `0` |
| `newContestations` | `integer` | opcional | — | — | `0` |
| `alreadyExists` | `integer` | opcional | — | — | `0` |
| `errors` | `integer` | opcional | — | — | `0` |

Exemplo:

```json
{
  "totalFound": 0,
  "newContestations": 0,
  "alreadyExists": 0,
  "errors": 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). |
| `500` | Erro interno no servidor. |
| `502` | Erro de gateway em serviço dependente. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/Contestations/Import" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "codAgencia": "texto",
  "nroConta": "texto",
  "cpfCnpj": "12345678909",
  "tipoConta": "CheckingAccount",
  "dataInicio": "2025-08-11T13:45:00Z",
  "dataFim": "2025-08-11T13:45:00Z",
  "contestationType": "REPORTED"
}'
```

---

### POST /v1/BankAccount/{id}/Pix/MED/Infraction

**Cria um relato de infração (MED) como Relator** — Cria um novo registro de Bank Account.

Cria um relato de infração (MED) como Relator.

**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 |
|---|---|---|---|---|---|
| `idTransacao` | `string` | opcional | — | — | `"texto"` |
| `tipoInfracao` | `string` | opcional | — | `Unknown`, `REFUND_REQUEST` | `"Unknown"` |
| `detalhes` | `string` | opcional | — | — | `"texto"` |
| `tipoSituacao` | `string` | opcional | — | `Unknown`, `FRAUDULENT_ACCESS`, `SCAM` | `"Unknown"` |
| `emailContato` | `string` | opcional | — | — | `"cliente@exemplo.com.br"` |
| `telefoneContato` | `string` | opcional | — | — | `"11987654321"` |
| `codAgenciaRelator` | `string` | opcional | — | — | `"texto"` |
| `nroContaRelator` | `string` | opcional | — | — | `"texto"` |
| `cpfCnpjRelator` | `string` | opcional | — | — | `"12345678909"` |
| `tipoContaRelator` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "idTransacao": "texto",
  "tipoInfracao": "Unknown",
  "detalhes": "texto",
  "tipoSituacao": "Unknown",
  "emailContato": "cliente@exemplo.com.br",
  "telefoneContato": "11987654321",
  "codAgenciaRelator": "texto",
  "nroContaRelator": "texto",
  "cpfCnpjRelator": "12345678909",
  "tipoContaRelator": "texto"
}
```

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `idTransacao` | `string` | opcional | — | — | `"texto"` |
| `tipoInfracao` | `string` | opcional | — | `Unknown`, `REFUND_REQUEST` | `"Unknown"` |
| `tipoSituacao` | `string` | opcional | — | `Unknown`, `FRAUDULENT_ACCESS`, `SCAM` | `"Unknown"` |
| `detalhesRelato` | `string` | opcional | — | — | `"texto"` |
| `id` | `string` | opcional | — | — | `"texto"` |
| `estado` | `string` | opcional | — | `Unknown`, `OPEN`, `ACKNOWLEDGED`, `CLOSED`, `CANCELLED` | `"Unknown"` |
| `participanteRelator` | `string` | opcional | — | — | `"texto"` |
| `participanteContraparte` | `string` | opcional | — | — | `"texto"` |
| `idMarcacaoFraude` | `string` | opcional | — | — | `"texto"` |
| `resultadoAnalise` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"Unknown"` |
| `detalhesAnalise` | `string` | opcional | — | — | `"texto"` |
| `dataCriacao` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `dataHoraRegistro` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `ultimaModificacao` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `cancelamentoSolicitado` | `boolean` | opcional | — | — | `true` |
| `usuarioDecisao` | `string` | opcional | — | — | `"texto"` |
| `usuarioCriacao` | `string` | opcional | — | — | `"texto"` |
| `tipoTransacao` | `string` | opcional | — | — | `"texto"` |
| `resultadoTransacao` | `string` | opcional | — | — | `"texto"` |
| `emailContato` | `string` | opcional | — | — | `"cliente@exemplo.com.br"` |
| `telefoneContato` | `string` | opcional | — | — | `"11987654321"` |

Exemplo:

```json
{
  "idTransacao": "texto",
  "tipoInfracao": "Unknown",
  "tipoSituacao": "Unknown",
  "detalhesRelato": "texto",
  "id": "texto",
  "estado": "Unknown",
  "participanteRelator": "texto",
  "participanteContraparte": "texto",
  "idMarcacaoFraude": "texto",
  "resultadoAnalise": "Unknown",
  "detalhesAnalise": "texto",
  "dataCriacao": "2025-08-11T13:45:00Z",
  "dataHoraRegistro": "2025-08-11T13:45:00Z",
  "ultimaModificacao": "2025-08-11T13:45:00Z",
  "cancelamentoSolicitado": true,
  "usuarioDecisao": "texto",
  "usuarioCriacao": "texto",
  "tipoTransacao": "texto",
  "resultadoTransacao": "texto",
  "emailContato": "cliente@exemplo.com.br",
  "telefoneContato": "11987654321"
}
```

**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/Pix/MED/Infraction" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "idTransacao": "texto",
  "tipoInfracao": "Unknown",
  "detalhes": "texto",
  "tipoSituacao": "Unknown",
  "emailContato": "cliente@exemplo.com.br",
  "telefoneContato": "11987654321",
  "codAgenciaRelator": "texto",
  "nroContaRelator": "texto",
  "cpfCnpjRelator": "12345678909",
  "tipoContaRelator": "texto"
}'
```

---

### POST /v1/BankAccount/{id}/Pix/MED/Infraction/Cancel

**Cancela um relato de infração (MED)** — Cria um novo registro de Bank Account.

Cancela um relato de infração (MED).

**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 |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "id": "texto"
}
```

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `idTransacao` | `string` | opcional | — | — | `"texto"` |
| `tipoInfracao` | `string` | opcional | — | `Unknown`, `REFUND_REQUEST` | `"Unknown"` |
| `tipoSituacao` | `string` | opcional | — | `Unknown`, `FRAUDULENT_ACCESS`, `SCAM` | `"Unknown"` |
| `detalhesRelato` | `string` | opcional | — | — | `"texto"` |
| `id` | `string` | opcional | — | — | `"texto"` |
| `estado` | `string` | opcional | — | `Unknown`, `OPEN`, `ACKNOWLEDGED`, `CLOSED`, `CANCELLED` | `"Unknown"` |
| `participanteRelator` | `string` | opcional | — | — | `"texto"` |
| `participanteContraparte` | `string` | opcional | — | — | `"texto"` |
| `idMarcacaoFraude` | `string` | opcional | — | — | `"texto"` |
| `resultadoAnalise` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"Unknown"` |
| `detalhesAnalise` | `string` | opcional | — | — | `"texto"` |
| `dataCriacao` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `dataHoraRegistro` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `ultimaModificacao` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `cancelamentoSolicitado` | `boolean` | opcional | — | — | `true` |
| `usuarioDecisao` | `string` | opcional | — | — | `"texto"` |
| `usuarioCriacao` | `string` | opcional | — | — | `"texto"` |
| `tipoTransacao` | `string` | opcional | — | — | `"texto"` |
| `resultadoTransacao` | `string` | opcional | — | — | `"texto"` |
| `emailContato` | `string` | opcional | — | — | `"cliente@exemplo.com.br"` |
| `telefoneContato` | `string` | opcional | — | — | `"11987654321"` |

Exemplo:

```json
{
  "idTransacao": "texto",
  "tipoInfracao": "Unknown",
  "tipoSituacao": "Unknown",
  "detalhesRelato": "texto",
  "id": "texto",
  "estado": "Unknown",
  "participanteRelator": "texto",
  "participanteContraparte": "texto",
  "idMarcacaoFraude": "texto",
  "resultadoAnalise": "Unknown",
  "detalhesAnalise": "texto",
  "dataCriacao": "2025-08-11T13:45:00Z",
  "dataHoraRegistro": "2025-08-11T13:45:00Z",
  "ultimaModificacao": "2025-08-11T13:45:00Z",
  "cancelamentoSolicitado": true,
  "usuarioDecisao": "texto",
  "usuarioCriacao": "texto",
  "tipoTransacao": "texto",
  "resultadoTransacao": "texto",
  "emailContato": "cliente@exemplo.com.br",
  "telefoneContato": "11987654321"
}
```

**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/Pix/MED/Infraction/Cancel" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "id": "texto"
}'
```

---

### GET /v1/BankAccount/{id}/Pix/MED/Contested

**Lista relatos (paginado) na visão CONTESTADO** — Lista e filtra registros de Bank Account.

Lista relatos (paginado) na visão CONTESTADO.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `codAgencia` | query | `string` | opcional | — | `valor` |
| `nroConta` | query | `string` | opcional | — | `valor` |
| `cpfCnpj` | query | `string` | opcional | — | `valor` |
| `tipoConta` | query | `string` | opcional | — | `valor` |
| `status` | query | `objeto` | opcional | — | `valor` |
| `dataInicio` | query | `string (date)` | opcional | — | `valor` |
| `dataFim` | query | `string (date)` | opcional | — | `valor` |
| `pagina` | query | `integer` | opcional | — | `10` |

**Resposta 200**

Campos:

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

Detalhe de `items`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `infractionReportId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `transactionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `reporterParticipant` | `string` | opcional | — | — | `"texto"` |
| `reporterName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `counterpartyParticipant` | `string` | opcional | — | — | `"texto"` |
| `counterpartyName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `analysisResult` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"Unknown"` |
| `infractionReportStatus` | `string` | opcional | — | `Unknown`, `OPEN`, `ACKNOWLEDGED`, `CLOSED`, `CANCELLED` | `"Unknown"` |
| `createdAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `statusDateTime` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `operationAmount` | `number (decimal)` | opcional | — | — | `1000` |

Exemplo:

```json
{
  "totalPages": 0,
  "currentPage": 0,
  "items": [
    {
      "infractionReportId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "reporterParticipant": "texto",
      "reporterName": "Fulano de Tal",
      "counterpartyParticipant": "texto",
      "counterpartyName": "Fulano de Tal",
      "analysisResult": "Unknown",
      "infractionReportStatus": "Unknown",
      "createdAt": "2025-08-11T13:45:00Z",
      "statusDateTime": "2025-08-11T13:45:00Z",
      "operationAmount": 1000
    }
  ]
}
```

**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/Pix/MED/Contested" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v1/BankAccount/{id}/Pix/MED/Contested/Report

**Detalhes de um relato (CONTESTADO)** — Lista e filtra registros de Bank Account.

Detalhes de um relato (CONTESTADO).

**Parâmetros**

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

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `idRelatoInfracao` | `string` | opcional | — | — | `"texto"` |
| `idTransacao` | `string` | opcional | — | — | `"texto"` |
| `tipoInfracao` | `string` | opcional | — | `Unknown`, `REFUND_REQUEST` | `"Unknown"` |
| `tipoSituacao` | `string` | opcional | — | `Unknown`, `FRAUDULENT_ACCESS`, `SCAM` | `"Unknown"` |
| `status` | `string` | opcional | — | `Unknown`, `OPEN`, `ACKNOWLEDGED`, `CLOSED`, `CANCELLED` | `"Unknown"` |
| `participanteRelator` | `string` | opcional | — | — | `"texto"` |
| `nomeRelator` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `participanteContraparte` | `string` | opcional | — | — | `"texto"` |
| `nomeContraparte` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `resultadoAnalise` | `string` | opcional | — | `Unknown`, `AGREED`, `DISAGREED`, `NOT_APPLICABLE` | `"Unknown"` |
| `detalhesRelato` | `string` | opcional | — | — | `"texto"` |
| `detalhesAnalise` | `string` | opcional | — | — | `"texto"` |
| `dataHoraCriacao` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `dataHoraStatus` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Exemplo:

```json
{
  "idRelatoInfracao": "texto",
  "idTransacao": "texto",
  "tipoInfracao": "Unknown",
  "tipoSituacao": "Unknown",
  "status": "Unknown",
  "participanteRelator": "texto",
  "nomeRelator": "Fulano de Tal",
  "participanteContraparte": "texto",
  "nomeContraparte": "Fulano de Tal",
  "resultadoAnalise": "Unknown",
  "detalhesRelato": "texto",
  "detalhesAnalise": "texto",
  "dataHoraCriacao": "2025-08-11T13:45:00Z",
  "dataHoraStatus": "2025-08-11T13:45:00Z"
}
```

**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/Pix/MED/Contested/Report" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v1/BankAccount/{id}/Pix/MED/Contested/Operation

**Dados operacionais (transação) de um relato (CONTESTADO)** — Lista e filtra registros de Bank Account.

Dados operacionais (transação) de um relato (CONTESTADO).

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `codAgencia` | query | `string` | opcional | — | `valor` |
| `nroConta` | query | `string` | opcional | — | `valor` |
| `cpfCnpj` | query | `string` | opcional | — | `valor` |
| `tipoConta` | query | `string` | opcional | — | `valor` |
| `idRelatoInfracao` | query | `string` | opcional | — | `valor` |
| `idTransacao` | query | `string` | opcional | — | `valor` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `idRelatoInfracao` | `string` | opcional | — | — | `"texto"` |
| `idTransacao` | `string` | opcional | — | — | `"texto"` |
| `participanteRelator` | `string` | opcional | — | — | `"texto"` |
| `codAgenciaRelator` | `string` | opcional | — | — | `"texto"` |
| `nroContaRelator` | `string` | opcional | — | — | `"texto"` |
| `tipoContaRelator` | `string` | opcional | — | `CheckingAccount`, `SalaryAccount`, `SavingsAccount`, `Transactional` | `"CheckingAccount"` |
| `cpfCnpjRelator` | `string` | opcional | — | — | `"12345678909"` |
| `nomeRelator` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `participanteContraparte` | `string` | opcional | — | — | `"texto"` |
| `codAgenciaContraparte` | `string` | opcional | — | — | `"texto"` |
| `nroContaContraparte` | `string` | opcional | — | — | `"texto"` |
| `tipoContaContraparte` | `string` | opcional | — | `CheckingAccount`, `SalaryAccount`, `SavingsAccount`, `Transactional` | `"CheckingAccount"` |
| `cpfCnpjContraparte` | `string` | opcional | — | — | `"12345678909"` |
| `nomeContraparte` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `valorOperacao` | `number (decimal)` | opcional | — | — | `1000` |
| `dataHoraOperacao` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Exemplo:

```json
{
  "idRelatoInfracao": "texto",
  "idTransacao": "texto",
  "participanteRelator": "texto",
  "codAgenciaRelator": "texto",
  "nroContaRelator": "texto",
  "tipoContaRelator": "CheckingAccount",
  "cpfCnpjRelator": "12345678909",
  "nomeRelator": "Fulano de Tal",
  "participanteContraparte": "texto",
  "codAgenciaContraparte": "texto",
  "nroContaContraparte": "texto",
  "tipoContaContraparte": "CheckingAccount",
  "cpfCnpjContraparte": "12345678909",
  "nomeContraparte": "Fulano de Tal",
  "valorOperacao": 1000,
  "dataHoraOperacao": "2025-08-11T13:45:00Z"
}
```

**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/Pix/MED/Contested/Operation" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v1/BankAccount/{id}/Pix/MED/Contested/Refunds

**Devoluções associadas à operação de um relato (CONTESTADO)** — Lista e filtra registros de Bank Account.

Devoluções associadas à operação de um relato (CONTESTADO).

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `codAgencia` | query | `string` | opcional | — | `valor` |
| `nroConta` | query | `string` | opcional | — | `valor` |
| `cpfCnpj` | query | `string` | opcional | — | `valor` |
| `tipoConta` | query | `string` | opcional | — | `valor` |
| `idRelatoInfracao` | query | `string` | opcional | — | `valor` |
| `idTransacao` | query | `string` | opcional | — | `valor` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `idTransacao` | `string` | opcional | — | — | `"texto"` |
| `valorOperacao` | `number (decimal)` | opcional | — | — | `1000` |

Exemplo:

```json
[
  {
    "idTransacao": "texto",
    "valorOperacao": 1000
  }
]
```

**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/Pix/MED/Contested/Refunds" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v1/BankAccount/{id}/Pix/MED/Reporter

**Lista relatos (paginado) na visão RELATOR** — Lista e filtra registros de Bank Account.

Lista relatos (paginado) na visão RELATOR.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `codAgencia` | query | `string` | opcional | — | `valor` |
| `nroConta` | query | `string` | opcional | — | `valor` |
| `cpfCnpj` | query | `string` | opcional | — | `valor` |
| `tipoConta` | query | `string` | opcional | — | `valor` |
| `status` | query | `objeto` | opcional | — | `valor` |
| `dataInicio` | query | `string (date)` | opcional | — | `valor` |
| `dataFim` | query | `string (date)` | opcional | — | `valor` |
| `pagina` | query | `integer` | opcional | — | `10` |

**Resposta 200**

Campos:

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

Detalhe de `items`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `infractionReportId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `transactionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `reporterParticipant` | `string` | opcional | — | — | `"texto"` |
| `reporterName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `counterpartyParticipant` | `string` | opcional | — | — | `"texto"` |
| `counterpartyName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `analysisResult` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"Unknown"` |
| `infractionReportStatus` | `string` | opcional | — | `Unknown`, `OPEN`, `ACKNOWLEDGED`, `CLOSED`, `CANCELLED` | `"Unknown"` |
| `createdAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `statusDateTime` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `operationAmount` | `number (decimal)` | opcional | — | — | `1000` |

Exemplo:

```json
{
  "totalPages": 0,
  "currentPage": 0,
  "items": [
    {
      "infractionReportId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "reporterParticipant": "texto",
      "reporterName": "Fulano de Tal",
      "counterpartyParticipant": "texto",
      "counterpartyName": "Fulano de Tal",
      "analysisResult": "Unknown",
      "infractionReportStatus": "Unknown",
      "createdAt": "2025-08-11T13:45:00Z",
      "statusDateTime": "2025-08-11T13:45:00Z",
      "operationAmount": 1000
    }
  ]
}
```

**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/Pix/MED/Reporter" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v1/BankAccount/{id}/Pix/MED/Reporter/Report

**Detalhes de um relato (RELATOR)** — Lista e filtra registros de Bank Account.

Detalhes de um relato (RELATOR).

**Parâmetros**

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

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `idRelatoInfracao` | `string` | opcional | — | — | `"texto"` |
| `idTransacao` | `string` | opcional | — | — | `"texto"` |
| `tipoInfracao` | `string` | opcional | — | `Unknown`, `REFUND_REQUEST` | `"Unknown"` |
| `tipoSituacao` | `string` | opcional | — | `Unknown`, `FRAUDULENT_ACCESS`, `SCAM` | `"Unknown"` |
| `status` | `string` | opcional | — | `Unknown`, `OPEN`, `ACKNOWLEDGED`, `CLOSED`, `CANCELLED` | `"Unknown"` |
| `participanteRelator` | `string` | opcional | — | — | `"texto"` |
| `nomeRelator` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `participanteContraparte` | `string` | opcional | — | — | `"texto"` |
| `nomeContraparte` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `resultadoAnalise` | `string` | opcional | — | `Unknown`, `AGREED`, `DISAGREED`, `NOT_APPLICABLE` | `"Unknown"` |
| `detalhesRelato` | `string` | opcional | — | — | `"texto"` |
| `detalhesAnalise` | `string` | opcional | — | — | `"texto"` |
| `dataHoraCriacao` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `dataHoraStatus` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Exemplo:

```json
{
  "idRelatoInfracao": "texto",
  "idTransacao": "texto",
  "tipoInfracao": "Unknown",
  "tipoSituacao": "Unknown",
  "status": "Unknown",
  "participanteRelator": "texto",
  "nomeRelator": "Fulano de Tal",
  "participanteContraparte": "texto",
  "nomeContraparte": "Fulano de Tal",
  "resultadoAnalise": "Unknown",
  "detalhesRelato": "texto",
  "detalhesAnalise": "texto",
  "dataHoraCriacao": "2025-08-11T13:45:00Z",
  "dataHoraStatus": "2025-08-11T13:45:00Z"
}
```

**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/Pix/MED/Reporter/Report" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v1/BankAccount/{id}/Pix/MED/Reporter/Operation

**Dados operacionais (transação) de um relato (RELATOR)** — Lista e filtra registros de Bank Account.

Dados operacionais (transação) de um relato (RELATOR).

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `codAgencia` | query | `string` | opcional | — | `valor` |
| `nroConta` | query | `string` | opcional | — | `valor` |
| `cpfCnpj` | query | `string` | opcional | — | `valor` |
| `tipoConta` | query | `string` | opcional | — | `valor` |
| `idRelatoInfracao` | query | `string` | opcional | — | `valor` |
| `idTransacao` | query | `string` | opcional | — | `valor` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `idRelatoInfracao` | `string` | opcional | — | — | `"texto"` |
| `idTransacao` | `string` | opcional | — | — | `"texto"` |
| `participanteRelator` | `string` | opcional | — | — | `"texto"` |
| `codAgenciaRelator` | `string` | opcional | — | — | `"texto"` |
| `nroContaRelator` | `string` | opcional | — | — | `"texto"` |
| `tipoContaRelator` | `string` | opcional | — | `CheckingAccount`, `SalaryAccount`, `SavingsAccount`, `Transactional` | `"CheckingAccount"` |
| `cpfCnpjRelator` | `string` | opcional | — | — | `"12345678909"` |
| `nomeRelator` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `participanteContraparte` | `string` | opcional | — | — | `"texto"` |
| `codAgenciaContraparte` | `string` | opcional | — | — | `"texto"` |
| `nroContaContraparte` | `string` | opcional | — | — | `"texto"` |
| `tipoContaContraparte` | `string` | opcional | — | `CheckingAccount`, `SalaryAccount`, `SavingsAccount`, `Transactional` | `"CheckingAccount"` |
| `cpfCnpjContraparte` | `string` | opcional | — | — | `"12345678909"` |
| `nomeContraparte` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `valorOperacao` | `number (decimal)` | opcional | — | — | `1000` |
| `dataHoraOperacao` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Exemplo:

```json
{
  "idRelatoInfracao": "texto",
  "idTransacao": "texto",
  "participanteRelator": "texto",
  "codAgenciaRelator": "texto",
  "nroContaRelator": "texto",
  "tipoContaRelator": "CheckingAccount",
  "cpfCnpjRelator": "12345678909",
  "nomeRelator": "Fulano de Tal",
  "participanteContraparte": "texto",
  "codAgenciaContraparte": "texto",
  "nroContaContraparte": "texto",
  "tipoContaContraparte": "CheckingAccount",
  "cpfCnpjContraparte": "12345678909",
  "nomeContraparte": "Fulano de Tal",
  "valorOperacao": 1000,
  "dataHoraOperacao": "2025-08-11T13:45:00Z"
}
```

**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/Pix/MED/Reporter/Operation" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v1/BankAccount/{id}/Pix/MED/Reporter/Refunds

**Devoluções associadas à operação de um relato (RELATOR)** — Lista e filtra registros de Bank Account.

Devoluções associadas à operação de um relato (RELATOR).

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `codAgencia` | query | `string` | opcional | — | `valor` |
| `nroConta` | query | `string` | opcional | — | `valor` |
| `cpfCnpj` | query | `string` | opcional | — | `valor` |
| `tipoConta` | query | `string` | opcional | — | `valor` |
| `idRelatoInfracao` | query | `string` | opcional | — | `valor` |
| `idTransacao` | query | `string` | opcional | — | `valor` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `idTransacao` | `string` | opcional | — | — | `"texto"` |
| `valorOperacao` | `number (decimal)` | opcional | — | — | `1000` |

Exemplo:

```json
[
  {
    "idTransacao": "texto",
    "valorOperacao": 1000
  }
]
```

**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/Pix/MED/Reporter/Refunds" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v1/BankAccount/{id}/Pix/Med/Recover

**Listar recuperações de valores (MED V2)** — 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` |
| `BankAccountId` | query | `string` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `ReporterAgency` | query | `string` | opcional | — | `valor` |
| `ReporterAccount` | query | `string` | opcional | — | `valor` |
| `ReporterDocNumber` | query | `string` | opcional | — | `valor` |
| `ReporterAccountType` | query | `objeto` | opcional | — | `valor` |
| `StartDate` | query | `string (date-time)` | opcional | — | `valor` |
| `EndDate` | query | `string (date-time)` | opcional | — | `valor` |
| `IncludeGraph` | query | `boolean` | opcional | — | `true` |
| `RecoveryId` | query | `string` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `OriginalEndToEndId` | query | `string` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `Status` | query | `objeto` | opcional | — | `valor` |
| `Page` | query | `integer` | opcional | — | `10` |
| `Size` | query | `integer` | opcional | — | `10` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `pagination` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `operations` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `operations`:

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

Exemplo:

```json
{
  "pagination": {
    "currentPage": 0,
    "itemsPerPage": 0,
    "totalPages": 0
  },
  "operations": [
    {
      "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "recoveryDetails": {
        "uniqueRecoveryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "bankIspb": "texto",
        "originalEndToEndId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "receiverName": "Fulano de Tal",
        "amount": 0,
        "situationType": {},
        "analysisDetails": "texto",
        "status": {},
        "createdAt": "2025-08-11T13:45:00Z",
        "updatedAt": "2025-08-11T13:45:00Z",
        "reporter": {},
        "contact": {}
      },
      "fraudGraph": {
        "involvedPeople": [],
        "involvedAccounts": [],
        "transactions": []
      }
    }
  ]
}
```

**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/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/Med/Recover" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /v1/BankAccount/{id}/Pix/Med/Recover

**Solicitar recuperação de valores (Instauração de MED 2** — Cria um novo registro de Bank Account.

Solicitar recuperação de valores (Instauração de MED 2.0)

**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 |
|---|---|---|---|---|---|
| `sessionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `code` | `string` | opcional | — | — | `"texto"` |
| `situationType` | `string` | opcional | — | `NONE`, `SCAM`, `ACCOUNT_TAKEOVER`, `COERCION`, `FRAUDULENT_ACCESS`, `OTHER`, `UNKNOWN` | `"NONE"` |
| `originalEndToEndId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `analysisDetails` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto",
  "situationType": "NONE",
  "originalEndToEndId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "analysisDetails": "texto"
}
```

**Resposta 200**

Campos:

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

Exemplo:

```json
{
  "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "recoveryDetails": {
    "uniqueRecoveryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "bankIspb": "texto",
    "originalEndToEndId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "receiverName": "Fulano de Tal",
    "amount": 0,
    "situationType": "NONE",
    "analysisDetails": "texto",
    "status": "NONE",
    "createdAt": "2025-08-11T13:45:00Z",
    "updatedAt": "2025-08-11T13:45:00Z",
    "reporter": {
      "agency": 0,
      "accountNumber": 0,
      "accountType": "PaymentAccount",
      "registrationNumber": "12345678909"
    },
    "contact": {
      "email": "cliente@exemplo.com.br",
      "phoneNumber": "11987654321"
    }
  },
  "fraudGraph": {
    "involvedPeople": [
      {
        "id": 1,
        "type": {},
        "createdAt": "2025-08-11T13:45:00Z"
      }
    ],
    "involvedAccounts": [
      {
        "id": 1,
        "personId": 1,
        "bankIspb": "texto",
        "openedAt": "2025-08-11T13:45:00Z"
      }
    ],
    "transactions": [
      {
        "id": "texto",
        "debitedAccountId": 1,
        "creditedAccountId": 1,
        "amount": 0,
        "availableAmount": 0,
        "settledAt": "2025-08-11T13:45:00Z"
      }
    ]
  }
}
```

**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 POST "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/Med/Recover" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto",
  "situationType": "NONE",
  "originalEndToEndId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "analysisDetails": "texto"
}'
```

---

### GET /v1/BankAccount/{id}/Pix/Med/Recover/{recoveryId}

**Obter detalhes de uma recuperação de valor (MED V2)** — Consulta Bank Account pelo identificador informado na rota.

**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` |
| `recoveryId` | path | `string` | obrigatório | Identificador da recuperação de valor | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `uniqueRecoveryId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `bankIspb` | `string` | opcional | — | — | `"texto"` |
| `originalEndToEndId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `receiverName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `amount` | `integer (int64)` | opcional | — | — | `0` |
| `situationType` | `string` | opcional | — | `NONE`, `SCAM`, `ACCOUNT_TAKEOVER`, `COERCION`, `FRAUDULENT_ACCESS`, `OTHER`, `UNKNOWN` | `"NONE"` |
| `analysisDetails` | `string` | opcional | — | — | `"texto"` |
| `status` | `string` | opcional | — | `NONE`, `CREATED`, `TRACKED`, `AWAITING_ANALYSIS`, `ANALYSED`, `REFUNDING`, `COMPLETED`, `CANCELLED` | `"NONE"` |
| `createdAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `updatedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `reporter` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `contact` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |

Exemplo:

```json
{
  "uniqueRecoveryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "bankIspb": "texto",
  "originalEndToEndId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "receiverName": "Fulano de Tal",
  "amount": 0,
  "situationType": "NONE",
  "analysisDetails": "texto",
  "status": "NONE",
  "createdAt": "2025-08-11T13:45:00Z",
  "updatedAt": "2025-08-11T13:45:00Z",
  "reporter": {
    "agency": 0,
    "accountNumber": 0,
    "accountType": "PaymentAccount",
    "registrationNumber": "12345678909"
  },
  "contact": {
    "email": "cliente@exemplo.com.br",
    "phoneNumber": "11987654321"
  }
}
```

**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/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/Med/Recover/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"
```

---

### PUT /v1/BankAccount/{id}/Pix/Med/Recover/{recoveryId}

**Atualizar solicitação de recuperação de valores (MED V2)** — Atualiza por completo um registro de Bank Account existente.

**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` |
| `recoveryId` | path | `string` | obrigatório | Id da recuperação (MED) | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `recoveryId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `situationType` | `string` | opcional | — | `NONE`, `SCAM`, `ACCOUNT_TAKEOVER`, `COERCION`, `FRAUDULENT_ACCESS`, `OTHER`, `UNKNOWN` | `"NONE"` |
| `analysisDetails` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "recoveryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "situationType": "NONE",
  "analysisDetails": "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). |

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/Med/Recover/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "recoveryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "situationType": "NONE",
  "analysisDetails": "texto"
}'
```

---

### GET /v1/BankAccount/{id}/Pix/Med/Recover/{recoveryId}/Graph

**Obter grafo de rastreabilidade da fraude (MED V2)** — 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 bancária | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `recoveryId` | path | `string` | obrigatório | Identificador da recuperação | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Resposta 200**

Campos:

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

Exemplo:

```json
{
  "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "graph": {
    "involvedPeople": [
      {
        "id": 1,
        "type": {},
        "createdAt": "2025-08-11T13:45:00Z"
      }
    ],
    "involvedAccounts": [
      {
        "id": 1,
        "personId": 1,
        "bankIspb": "texto",
        "openedAt": "2025-08-11T13:45:00Z"
      }
    ],
    "transactions": [
      {
        "id": "texto",
        "debitedAccountId": 1,
        "creditedAccountId": 1,
        "amount": 0,
        "availableAmount": 0,
        "settledAt": "2025-08-11T13:45:00Z"
      }
    ]
  }
}
```

**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/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/Med/Recover/3fa85f64-5717-4562-b3fc-2c963f66afa6/Graph" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v1/BankAccount/{id}/Pix/Med/Recover/{recoveryId}/RefundRequests

**Listar solicitações de devolução (Refund Requests) de um MED** — 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 bancária | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `recoveryId` | path | `string` | obrigatório | Identificador da recuperação | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `correlationId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `requests` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `requests`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `recoveryId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `transactionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `infractionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `reason` | `string` | opcional | — | `NONE`, `FRAUD`, `OPERATIONAL_FLAW`, `REFUND_CANCELLED`, `PIX_AUTOMATICO` | `"NONE"` |
| `requestedAmount` | `integer (int64)` | opcional | — | — | `0` |
| `refundedAmount` | `integer (int64)` | opcional | — | — | `0` |
| `analysisDetails` | `string` | opcional | — | — | `"texto"` |
| `status` | `string` | opcional | — | `NONE`, `OPEN`, `CLOSED`, `CANCELLED` | `"NONE"` |
| `requesterIspb` | `string` | opcional | — | — | `"texto"` |
| `contestedIspb` | `string` | opcional | — | — | `"texto"` |
| `createdAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `registeredAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `updatedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `analysisResult` | `string` | opcional | — | `NONE`, `TOTALLY_ACCEPTED`, `PARTIALLY_ACCEPTED`, `REJECTED` | `"NONE"` |
| `resultDetails` | `string` | opcional | — | — | `"texto"` |
| `rejectionReason` | `string` | opcional | — | `NONE`, `NO_BALANCE`, `ACCOUNT_CLOSURE`, `INVALID_REQUEST`, `OTHER` | `"NONE"` |
| `returnAccount` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `isMonitoredAccount` | `boolean` | opcional | — | — | `true` |

Exemplo:

```json
{
  "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "requests": [
    {
      "id": "texto",
      "recoveryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "infractionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "reason": "NONE",
      "requestedAmount": 0,
      "refundedAmount": 0,
      "analysisDetails": "texto",
      "status": "NONE",
      "requesterIspb": "texto",
      "contestedIspb": "texto",
      "createdAt": "2025-08-11T13:45:00Z",
      "registeredAt": "2025-08-11T13:45:00Z",
      "updatedAt": "2025-08-11T13:45:00Z",
      "analysisResult": "NONE",
      "resultDetails": "texto",
      "rejectionReason": "NONE",
      "returnAccount": {
        "registrationNumber": "12345678909",
        "ispb": "texto",
        "agency": 0,
        "account": 0,
        "accountType": {}
      },
      "isMonitoredAccount": 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). |
| `404` | Recurso não encontrado. |

**cURL**

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

---

### POST /v1/BankAccount/{id}/Pix/Med/Recover/{recoveryId}/Refund

**Solicitar a devolução dos valores recuperados (MED V2)** — 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` |
| `recoveryId` | path | `string` | obrigatório | Identificador da recuperação | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `404` | Recurso não encontrado. |
| `422` | Entidade não processável (validação semântica). |

**cURL**

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

---

### DELETE /v1/BankAccount/{id}/Pix/Med/Recover/Cancel

**Cancelar uma recuperação de valores (MED V2)** — Remove um 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` |
| `recoveryId` | query | `string` | opcional | Identificador da recuperação | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Códigos de retorno**

| Código | Significado |
|---|---|
| `200` | Requisição bem-sucedida. |
| `404` | Recurso não encontrado. |
| `422` | Entidade não processável (validação semântica). |

**cURL**

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

---

### GET /v1/BankAccount/{id}/Pix/Med/Recover/SelfService/List

**Listar recuperações de valores (Autoatendimento MED)** — 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 bancária (Partner Context) | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `startDate` | query | `string (date-time)` | opcional | Data inicial do filtro | `valor` |
| `endDate` | query | `string (date-time)` | opcional | Data final do filtro | `valor` |
| `status` | query | `objeto` | opcional | Status da recuperação | `valor` |
| `page` | query | `integer` | opcional | Página da listagem | `10` |
| `size` | query | `integer` | opcional | Tamanho da página | `10` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `pagination` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `items` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `items`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `recoveryId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `bankIspb` | `string` | opcional | — | — | `"texto"` |
| `originalEndToEndId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `receiverName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `originalAmount` | `integer (int64)` | opcional | — | — | `0` |
| `refundedAmount` | `integer (int64)` | opcional | — | — | `0` |
| `status` | `string` | opcional | — | `NONE`, `CREATED`, `TRACKED`, `AWAITING_ANALYSIS`, `ANALYSED`, `REFUNDING`, `COMPLETED`, `CANCELLED` | `"NONE"` |
| `createdAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `updatedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Exemplo:

```json
{
  "pagination": {
    "currentPage": 0,
    "itemsPerPage": 0,
    "totalPages": 0
  },
  "items": [
    {
      "recoveryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "bankIspb": "texto",
      "originalEndToEndId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "receiverName": "Fulano de Tal",
      "originalAmount": 0,
      "refundedAmount": 0,
      "status": "NONE",
      "createdAt": "2025-08-11T13:45:00Z",
      "updatedAt": "2025-08-11T13:45:00Z"
    }
  ]
}
```

**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/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/Med/Recover/SelfService/List" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v1/BankAccount/{id}/Pix/Med/Recover/SelfService/{recoveryId}

**Obter detalhes de recuperação por ID (Autoatendimento)** — Consulta Bank Account pelo identificador informado na rota.

**Parâmetros**

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

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `recoveryId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `bankIspb` | `string` | opcional | — | — | `"texto"` |
| `originalEndToEndId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `receiverName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `originalAmount` | `integer (int64)` | opcional | — | — | `0` |
| `refundedAmount` | `integer (int64)` | opcional | — | — | `0` |
| `status` | `string` | opcional | — | `NONE`, `CREATED`, `TRACKED`, `AWAITING_ANALYSIS`, `ANALYSED`, `REFUNDING`, `COMPLETED`, `CANCELLED` | `"NONE"` |
| `createdAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `updatedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Exemplo:

```json
{
  "recoveryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "bankIspb": "texto",
  "originalEndToEndId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "receiverName": "Fulano de Tal",
  "originalAmount": 0,
  "refundedAmount": 0,
  "status": "NONE",
  "createdAt": "2025-08-11T13:45:00Z",
  "updatedAt": "2025-08-11T13:45:00Z"
}
```

**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/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/Med/Recover/SelfService/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v1/BankAccount/{id}/Pix/Med/Recover/{recoveryId}/Infractions

**Lista de notificações de infração de uma recuperação (MED V2)** — 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 bancária | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `recoveryId` | path | `string` | obrigatório | Identificador da recuperação | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `correlationId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `infractions` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `infractions`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `recoveryId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `transactionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `fraudMarkerId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `createdAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `updatedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `reason` | `string` | opcional | — | `NONE`, `REFUND_REQUEST`, `REFUND_CANCELLED` | `"NONE"` |
| `situation` | `string` | opcional | — | `NONE`, `SCAM`, `ACCOUNT_TAKEOVER`, `COERCION`, `FRAUDULENT_ACCESS`, `OTHER`, `UNKNOWN` | `"NONE"` |
| `analysisDetails` | `string` | opcional | — | — | `"texto"` |
| `contact` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `status` | `string` | opcional | — | `NONE`, `OPEN`, `ACKNOWLEDGED`, `CLOSED`, `CANCELLED` | `"NONE"` |
| `reporterIspb` | `string` | opcional | — | — | `"texto"` |
| `contestedIspb` | `string` | opcional | — | — | `"texto"` |
| `analysisResult` | `string` | opcional | — | `NONE`, `AGREED`, `DISAGREED` | `"NONE"` |
| `resultDetails` | `string` | opcional | — | — | `"texto"` |
| `amount` | `number (decimal)` | opcional | — | — | `1000` |

Detalhe de `contact`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `email` | `string` | opcional | — | — | `"cliente@exemplo.com.br"` |
| `phoneNumber` | `string` | opcional | — | — | `"11987654321"` |

Exemplo:

```json
{
  "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "infractions": [
    {
      "id": "texto",
      "recoveryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "transactionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "fraudMarkerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdAt": "2025-08-11T13:45:00Z",
      "updatedAt": "2025-08-11T13:45:00Z",
      "reason": "NONE",
      "situation": "NONE",
      "analysisDetails": "texto",
      "contact": {
        "email": "cliente@exemplo.com.br",
        "phoneNumber": "11987654321"
      },
      "status": "NONE",
      "reporterIspb": "texto",
      "contestedIspb": "texto",
      "analysisResult": "NONE",
      "resultDetails": "texto",
      "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). |
| `404` | Recurso não encontrado. |

**cURL**

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

---

### GET /v1/BankAccount/{id}/Pix/Med/Recover/Events

**Listar notificações de eventos do MED (Mudanças de Status)** — 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 bancária | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `cursor` | query | `string` | opcional | Cursor para paginação (opcional) | `valor` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `correlationId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `hasMoreElements` | `boolean` | opcional | — | — | `true` |
| `events` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `events`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `eventType` | `string` | opcional | — | `NONE`, `RECUPERACAO_VALOR_ANALISADA`, `RECUPERACAO_VALOR_CONCLUIDA`, `RECUPERACAO_VALOR_INFORMACAO_ATUALIZADA`, `RECUPERACAO_VALOR_CANCELADA` | `"NONE"` |
| `entityType` | `string` | opcional | — | `NONE`, `RECUPERACAO_VALOR` | `"NONE"` |
| `entityId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `notificationDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |

Exemplo:

```json
{
  "correlationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "hasMoreElements": true,
  "events": [
    {
      "id": "texto",
      "eventType": "NONE",
      "entityType": "NONE",
      "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "notificationDate": "2025-08-11T13:45:00Z"
    }
  ]
}
```

**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/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pix/Med/Recover/Events" \
  -H "Authorization: Bearer {{token}}"
```

---

## Transferências

Transferências entre contas (TED e pagamentos).

### POST /v1/BankAccount/{id}/{paymentId}/PaymentReceipt

**Gerar comprovante pdf de pagamento** — 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` |
| `paymentId` | 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 POST "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/3fa85f64-5717-4562-b3fc-2c963f66afa6/PaymentReceipt" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /v1/BankAccount/{id}/{transferId}/TransferReceipt

**Gerar comprovante pdf de transferência** — 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` |
| `transferId` | 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 POST "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/3fa85f64-5717-4562-b3fc-2c963f66afa6/TransferReceipt" \
  -H "Authorization: Bearer {{token}}"
```

---

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

**Obter lista de pagamentos** — 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` |
| `searchString` | query | `string` | opcional | — | `valor` |
| `f_nsu` | query | `string` | opcional | — | `valor` |
| `f_barCode` | query | `string` | opcional | — | `valor` |
| `f_amount` | query | `integer (int64)` | opcional | — | `10` |
| `f_paymentDate` | query | `string (date-time)` | opcional | — | `valor` |
| `f_paymentPurpose` | query | `objeto` | opcional | — | `valor` |
| `f_status` | query | `objeto` | opcional | — | `valor` |
| `isDeleted` | query | `boolean` | opcional | — | `true` |
| `orderBy` | query | `string` | opcional | — | `valor` |

**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 | `{ … }` |
| `barCode` | `string` | opcional | — | — | `"texto"` |
| `nsu` | `string` | opcional | — | — | `"texto"` |
| `amount` | `integer (int64)` | opcional | — | — | `0` |
| `date` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `dueDate` | `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"` |
| `paymentTaxesType` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"TributosCodigoBarra"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `errorMessage` | `string` | opcional | — | — | `"texto"` |
| `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
{
  "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"
      },
      "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": [
        {}
      ]
    }
  ],
  "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/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pay" \
  -H "Authorization: Bearer {{token}}"
```

---

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

**Solicitar o pagamento de um boleto de cobrança através do código de barras e linha…** — Cria um novo registro de Bank Account.

Solicitar o pagamento de um boleto de cobrança através do código de barras e linha digitável

**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 |
|---|---|---|---|---|---|
| `barCodeOrDigitableLine` | `string` | obrigatório | — | — | `"texto"` |
| `identificationOperationStatement` | `string` | opcional | — | — | `"texto"` |
| `paymentValue` | `integer (int64)` | obrigatório | — | — | `0` |
| `totalValue` | `integer (int64)` | obrigatório | — | — | `0` |
| `paymentDate` | `string (date-time)` | obrigatório | — | — | `"2025-08-11T13:45:00Z"` |
| `sessionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `code` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "barCodeOrDigitableLine": "texto",
  "identificationOperationStatement": "texto",
  "paymentValue": 0,
  "totalValue": 0,
  "paymentDate": "2025-08-11T13:45:00Z",
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}
```

**Resposta 200**

Campos:

| 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 | `{ … }` |
| `bankAccountId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `barCode` | `string` | opcional | — | — | `"texto"` |
| `nsu` | `string` | opcional | — | — | `"texto"` |
| `amount` | `integer (int64)` | opcional | — | — | `0` |
| `date` | `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"` |
| `errorMessage` | `string` | opcional | — | — | `"texto"` |
| `authorizedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `requester` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `approvals` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `requester`:

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

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",
  "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"
  },
  "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "barCode": "texto",
  "nsu": "texto",
  "amount": 0,
  "date": "2025-08-11T13:45:00Z",
  "paymentPurpose": "PagamentoDeImpostosTributosETaxas",
  "paymentPurposeDisplay": "texto",
  "status": "Approved",
  "statusDisplay": "texto",
  "errorMessage": "texto",
  "authorizedAt": "2025-08-11T13:45:00Z",
  "requester": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "registrationNumber": "12345678909",
    "userIdDisplay": "texto",
    "tenantDisplay": "texto",
    "tenantName": "Fulano de Tal"
  },
  "approvals": [
    {
      "level": "Viewer",
      "action": "Approve",
      "actionDisplay": "texto",
      "user": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      }
    }
  ]
}
```

**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/Pay" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "barCodeOrDigitableLine": "texto",
  "identificationOperationStatement": "texto",
  "paymentValue": 0,
  "totalValue": 0,
  "paymentDate": "2025-08-11T13:45:00Z",
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}'
```

---

### PUT /v1/BankAccount/{id}/Pay/{paymentId}/approve

**Aprova/reprova uma solicitação de pagamento** — Atualiza por completo um registro de Bank Account existente.

**Parâmetros**

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

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

Campos:

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

Exemplo:

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

**Códigos de retorno**

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

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Pay/3fa85f64-5717-4562-b3fc-2c963f66afa6/approve" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "Approve",
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}'
```

---

### PUT /v1/BankAccount/Pay/BatchApproval

**Aprova/reprova solicitações de pagamento por lote** — Atualiza por completo um registro de Bank Account existente.

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `payBankAccounts` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `action` | `string` | opcional | — | `Approve`, `Reject`, `Cancel` | `"Approve"` |
| `sessionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `code` | `string` | opcional | — | — | `"texto"` |

Detalhe de `payBankAccounts`:

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

Exemplo:

```json
{
  "payBankAccounts": [
    {
      "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "paymentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "action": "Approve",
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}
```

**Códigos de retorno**

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

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/BankAccount/Pay/BatchApproval" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "payBankAccounts": [
    {
      "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "paymentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "action": "Approve",
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}'
```

---

### PUT /v1/BankAccount/{id}/Pay/{paymentId}/cancel

**Cancelar um solicitação de pagamento** — Atualiza por completo um registro de Bank Account existente.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string` | obrigatório | Id da conta | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `paymentId` | path | `string` | obrigatório | Id do pagamento | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `sessionId` | query | `string` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `code` | query | `string` | opcional | — | `valor` |

**Códigos de retorno**

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

**cURL**

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

---

### GET /v1/BankAccount/{id}/Pay/BankslipConsumptionBillOrTaxes

**Obter os dados de um boleto de contas de consumo e tributo informando código de…** — Lista e filtra registros de Bank Account.

Obter os dados de um boleto de contas de consumo e tributo informando código de barras, ou linha digitável.

**Parâmetros**

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

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `barCode` | `string` | opcional | — | — | `"texto"` |
| `digitableLine` | `string` | opcional | — | — | `"texto"` |
| `situationCode` | `integer` | opcional | — | — | `0` |
| `reason` | `string` | opcional | — | — | `"texto"` |
| `authorizationTypeReceiptDivergentValue` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"QualquerValor"` |
| `discount` | `integer (int64)` | opcional | — | — | `0` |
| `discountValue` | `integer (int64)` | opcional | — | — | `0` |
| `rebateValue` | `integer (int64)` | opcional | — | — | `0` |
| `fee` | `integer (int64)` | opcional | — | — | `0` |
| `trafficTicket` | `integer (int64)` | opcional | — | — | `0` |
| `maximumValue` | `integer (int64)` | opcional | — | — | `0` |
| `minimumValue` | `integer (int64)` | opcional | — | — | `0` |
| `totalValue` | `integer (int64)` | opcional | — | — | `0` |
| `nominalValue` | `integer (int64)` | opcional | — | — | `0` |
| `partialPaymentIndicator` | `string` | opcional | — | — | `"texto"` |
| `value` | `integer (int64)` | opcional | — | — | `0` |
| `dueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `paymentDeadline` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `dateTimeBillingConsult` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `statusBilling` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"PaidBilling"` |
| `beneficiary` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `payer` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `guarantor` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `issuingBank` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `notifications` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `beneficiary`:

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

Detalhe de `payer`:

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

Detalhe de `guarantor`:

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

Detalhe de `issuingBank`:

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

Detalhe de `notifications`:

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

Exemplo:

```json
{
  "barCode": "texto",
  "digitableLine": "texto",
  "situationCode": 0,
  "reason": "texto",
  "authorizationTypeReceiptDivergentValue": "QualquerValor",
  "discount": 0,
  "discountValue": 0,
  "rebateValue": 0,
  "fee": 0,
  "trafficTicket": 0,
  "maximumValue": 0,
  "minimumValue": 0,
  "totalValue": 0,
  "nominalValue": 0,
  "partialPaymentIndicator": "texto",
  "value": 0,
  "dueDate": "2025-08-11T13:45:00Z",
  "paymentDeadline": "2025-08-11T13:45:00Z",
  "dateTimeBillingConsult": "2025-08-11T13:45:00Z",
  "statusBilling": "PaidBilling",
  "beneficiary": {
    "name": "Fulano de Tal",
    "document": "12345678909"
  },
  "payer": {
    "name": "Fulano de Tal",
    "document": "12345678909"
  },
  "guarantor": {
    "name": "Fulano de Tal",
    "document": "12345678909"
  },
  "issuingBank": {
    "code": "texto",
    "name": "Fulano de Tal"
  },
  "notifications": [
    {
      "property": "texto",
      "message": "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/Pay/BankslipConsumptionBillOrTaxes" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v1/BankAccount/{id}/Pay/Bankslip

**Obter os dados de um boleto de cobrança informando código de barras** — Lista e filtra registros de Bank Account.

Obter os dados de um boleto de cobrança informando código de barras, ou linha digitável.

**Parâmetros**

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

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `barCode` | `string` | opcional | — | — | `"texto"` |
| `digitableLine` | `string` | opcional | — | — | `"texto"` |
| `situationCode` | `integer` | opcional | — | — | `0` |
| `reason` | `string` | opcional | — | — | `"texto"` |
| `authorizationTypeReceiptDivergentValue` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"QualquerValor"` |
| `discount` | `integer (int64)` | opcional | — | — | `0` |
| `discountValue` | `integer (int64)` | opcional | — | — | `0` |
| `rebateValue` | `integer (int64)` | opcional | — | — | `0` |
| `fee` | `integer (int64)` | opcional | — | — | `0` |
| `trafficTicket` | `integer (int64)` | opcional | — | — | `0` |
| `maximumValue` | `integer (int64)` | opcional | — | — | `0` |
| `minimumValue` | `integer (int64)` | opcional | — | — | `0` |
| `totalValue` | `integer (int64)` | opcional | — | — | `0` |
| `nominalValue` | `integer (int64)` | opcional | — | — | `0` |
| `partialPaymentIndicator` | `string` | opcional | — | — | `"texto"` |
| `value` | `integer (int64)` | opcional | — | — | `0` |
| `dueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `paymentDeadline` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `dateTimeBillingConsult` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `statusBilling` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"PaidBilling"` |
| `beneficiary` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `payer` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `guarantor` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `issuingBank` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `notifications` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `beneficiary`:

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

Detalhe de `payer`:

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

Detalhe de `guarantor`:

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

Detalhe de `issuingBank`:

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

Detalhe de `notifications`:

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

Exemplo:

```json
{
  "barCode": "texto",
  "digitableLine": "texto",
  "situationCode": 0,
  "reason": "texto",
  "authorizationTypeReceiptDivergentValue": "QualquerValor",
  "discount": 0,
  "discountValue": 0,
  "rebateValue": 0,
  "fee": 0,
  "trafficTicket": 0,
  "maximumValue": 0,
  "minimumValue": 0,
  "totalValue": 0,
  "nominalValue": 0,
  "partialPaymentIndicator": "texto",
  "value": 0,
  "dueDate": "2025-08-11T13:45:00Z",
  "paymentDeadline": "2025-08-11T13:45:00Z",
  "dateTimeBillingConsult": "2025-08-11T13:45:00Z",
  "statusBilling": "PaidBilling",
  "beneficiary": {
    "name": "Fulano de Tal",
    "document": "12345678909"
  },
  "payer": {
    "name": "Fulano de Tal",
    "document": "12345678909"
  },
  "guarantor": {
    "name": "Fulano de Tal",
    "document": "12345678909"
  },
  "issuingBank": {
    "code": "texto",
    "name": "Fulano de Tal"
  },
  "notifications": [
    {
      "property": "texto",
      "message": "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/Pay/Bankslip" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v1/BankAccount/Pay/Bankslip

**Obtém os dados de um boleto de cobrança informando código de barras** — Lista e filtra registros de Bank Account.

Obtém os dados de um boleto de cobrança informando código de barras, ou linha digitável.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `barCode` | query | `string` | opcional | — | `valor` |

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `barCode` | `string` | opcional | — | — | `"texto"` |
| `digitableLine` | `string` | opcional | — | — | `"texto"` |
| `situationCode` | `integer` | opcional | — | — | `0` |
| `reason` | `string` | opcional | — | — | `"texto"` |
| `authorizationTypeReceiptDivergentValue` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"QualquerValor"` |
| `discount` | `integer (int64)` | opcional | — | — | `0` |
| `discountValue` | `integer (int64)` | opcional | — | — | `0` |
| `rebateValue` | `integer (int64)` | opcional | — | — | `0` |
| `fee` | `integer (int64)` | opcional | — | — | `0` |
| `trafficTicket` | `integer (int64)` | opcional | — | — | `0` |
| `maximumValue` | `integer (int64)` | opcional | — | — | `0` |
| `minimumValue` | `integer (int64)` | opcional | — | — | `0` |
| `totalValue` | `integer (int64)` | opcional | — | — | `0` |
| `nominalValue` | `integer (int64)` | opcional | — | — | `0` |
| `partialPaymentIndicator` | `string` | opcional | — | — | `"texto"` |
| `value` | `integer (int64)` | opcional | — | — | `0` |
| `dueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `paymentDeadline` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `dateTimeBillingConsult` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `statusBilling` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"PaidBilling"` |
| `beneficiary` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `payer` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `guarantor` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `issuingBank` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `notifications` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `beneficiary`:

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

Detalhe de `payer`:

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

Detalhe de `guarantor`:

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

Detalhe de `issuingBank`:

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

Detalhe de `notifications`:

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

Exemplo:

```json
{
  "barCode": "texto",
  "digitableLine": "texto",
  "situationCode": 0,
  "reason": "texto",
  "authorizationTypeReceiptDivergentValue": "QualquerValor",
  "discount": 0,
  "discountValue": 0,
  "rebateValue": 0,
  "fee": 0,
  "trafficTicket": 0,
  "maximumValue": 0,
  "minimumValue": 0,
  "totalValue": 0,
  "nominalValue": 0,
  "partialPaymentIndicator": "texto",
  "value": 0,
  "dueDate": "2025-08-11T13:45:00Z",
  "paymentDeadline": "2025-08-11T13:45:00Z",
  "dateTimeBillingConsult": "2025-08-11T13:45:00Z",
  "statusBilling": "PaidBilling",
  "beneficiary": {
    "name": "Fulano de Tal",
    "document": "12345678909"
  },
  "payer": {
    "name": "Fulano de Tal",
    "document": "12345678909"
  },
  "guarantor": {
    "name": "Fulano de Tal",
    "document": "12345678909"
  },
  "issuingBank": {
    "code": "texto",
    "name": "Fulano de Tal"
  },
  "notifications": [
    {
      "property": "texto",
      "message": "texto"
    }
  ]
}
```

**Códigos de retorno**

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

**cURL**

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

---

### GET /v1/BankAccount/{id}/Pay/BankslipFGTS

**Obtém os dados de um boleto FGTS informando código de barras, ou linha digitável** — Lista e filtra registros de Bank Account.

Obtém os dados de um boleto FGTS informando código de barras, ou linha digitável.

**Parâmetros**

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

**Resposta 200**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `barCode` | `string` | opcional | — | — | `"texto"` |
| `digitableLine` | `string` | opcional | — | — | `"texto"` |
| `situationCode` | `integer` | opcional | — | — | `0` |
| `reason` | `string` | opcional | — | — | `"texto"` |
| `authorizationTypeReceiptDivergentValue` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"QualquerValor"` |
| `discount` | `integer (int64)` | opcional | — | — | `0` |
| `discountValue` | `integer (int64)` | opcional | — | — | `0` |
| `rebateValue` | `integer (int64)` | opcional | — | — | `0` |
| `fee` | `integer (int64)` | opcional | — | — | `0` |
| `trafficTicket` | `integer (int64)` | opcional | — | — | `0` |
| `maximumValue` | `integer (int64)` | opcional | — | — | `0` |
| `minimumValue` | `integer (int64)` | opcional | — | — | `0` |
| `totalValue` | `integer (int64)` | opcional | — | — | `0` |
| `nominalValue` | `integer (int64)` | opcional | — | — | `0` |
| `partialPaymentIndicator` | `string` | opcional | — | — | `"texto"` |
| `value` | `integer (int64)` | opcional | — | — | `0` |
| `dueDate` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `paymentDeadline` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `dateTimeBillingConsult` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `statusBilling` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"PaidBilling"` |
| `beneficiary` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `payer` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `guarantor` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `issuingBank` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `notifications` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `beneficiary`:

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

Detalhe de `payer`:

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

Detalhe de `guarantor`:

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

Detalhe de `issuingBank`:

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

Detalhe de `notifications`:

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

Exemplo:

```json
{
  "barCode": "texto",
  "digitableLine": "texto",
  "situationCode": 0,
  "reason": "texto",
  "authorizationTypeReceiptDivergentValue": "QualquerValor",
  "discount": 0,
  "discountValue": 0,
  "rebateValue": 0,
  "fee": 0,
  "trafficTicket": 0,
  "maximumValue": 0,
  "minimumValue": 0,
  "totalValue": 0,
  "nominalValue": 0,
  "partialPaymentIndicator": "texto",
  "value": 0,
  "dueDate": "2025-08-11T13:45:00Z",
  "paymentDeadline": "2025-08-11T13:45:00Z",
  "dateTimeBillingConsult": "2025-08-11T13:45:00Z",
  "statusBilling": "PaidBilling",
  "beneficiary": {
    "name": "Fulano de Tal",
    "document": "12345678909"
  },
  "payer": {
    "name": "Fulano de Tal",
    "document": "12345678909"
  },
  "guarantor": {
    "name": "Fulano de Tal",
    "document": "12345678909"
  },
  "issuingBank": {
    "code": "texto",
    "name": "Fulano de Tal"
  },
  "notifications": [
    {
      "property": "texto",
      "message": "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/Pay/BankslipFGTS" \
  -H "Authorization: Bearer {{token}}"
```

---

### GET /v1/BankAccount/{id}/Pay/BankslipDARF

**Obter os dados de um boleto DARF informando código de barras, ou linha digitável** — Lista e filtra registros de Bank Account.

Obter os dados de um boleto DARF informando código de barras, ou linha digitável.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string` | obrigatório | Id da conta | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `BarCode` | query | `string` | opcional | — | `valor` |
| `DigitableLine` | query | `string` | opcional | — | `valor` |
| `RegistrationNumber` | query | `string` | opcional | — | `valor` |
| `DueDate` | query | `string (date-time)` | opcional | — | `valor` |

**Resposta 200**

Campos:

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

Detalhe de `notifications`:

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

Exemplo:

```json
{
  "principalValue": 0,
  "dueDate": "2025-08-11T13:45:00Z",
  "convenioIntegracao": "texto",
  "notifications": [
    {
      "property": "texto",
      "message": "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/Pay/BankslipDARF" \
  -H "Authorization: Bearer {{token}}"
```

---

### POST /v1/BankAccount/{id}/Pay/ConsumptionBill

**Solicitar o pagamento de um boleto de Conta de Consumo através do código de barras…** — Cria um novo registro de Bank Account.

Solicitar o pagamento de um boleto de Conta de Consumo através do código de barras e linha digitável

**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 |
|---|---|---|---|---|---|
| `barCodeOrDigitableLine` | `string` | obrigatório | — | — | `"texto"` |
| `identificationOperationStatement` | `string` | opcional | — | — | `"texto"` |
| `paymentValue` | `integer (int64)` | obrigatório | — | — | `0` |
| `paymentDate` | `string (date-time)` | obrigatório | — | — | `"2025-08-11T13:45:00Z"` |
| `sessionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `code` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "barCodeOrDigitableLine": "texto",
  "identificationOperationStatement": "texto",
  "paymentValue": 0,
  "paymentDate": "2025-08-11T13:45:00Z",
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}
```

**Resposta 200**

Campos:

| 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 | `{ … }` |
| `bankAccountId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `barCode` | `string` | opcional | — | — | `"texto"` |
| `nsu` | `string` | opcional | — | — | `"texto"` |
| `amount` | `integer (int64)` | opcional | — | — | `0` |
| `date` | `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"` |
| `errorMessage` | `string` | opcional | — | — | `"texto"` |
| `authorizedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `requester` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `approvals` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `requester`:

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

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",
  "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"
  },
  "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "barCode": "texto",
  "nsu": "texto",
  "amount": 0,
  "date": "2025-08-11T13:45:00Z",
  "paymentPurpose": "PagamentoDeImpostosTributosETaxas",
  "paymentPurposeDisplay": "texto",
  "status": "Approved",
  "statusDisplay": "texto",
  "errorMessage": "texto",
  "authorizedAt": "2025-08-11T13:45:00Z",
  "requester": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "registrationNumber": "12345678909",
    "userIdDisplay": "texto",
    "tenantDisplay": "texto",
    "tenantName": "Fulano de Tal"
  },
  "approvals": [
    {
      "level": "Viewer",
      "action": "Approve",
      "actionDisplay": "texto",
      "user": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      }
    }
  ]
}
```

**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/Pay/ConsumptionBill" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "barCodeOrDigitableLine": "texto",
  "identificationOperationStatement": "texto",
  "paymentValue": 0,
  "paymentDate": "2025-08-11T13:45:00Z",
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}'
```

---

### POST /v1/BankAccount/{id}/Pay/TaxWithBarCode

**Solicitar o pagamento de um boleto de tributo através do código de barras e linha…** — Cria um novo registro de Bank Account.

Solicitar o pagamento de um boleto de tributo através do código de barras e linha digitável

**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 |
|---|---|---|---|---|---|
| `barCodeOrDigitableLine` | `string` | obrigatório | — | — | `"texto"` |
| `identificationOperationStatement` | `string` | opcional | — | — | `"texto"` |
| `paymentValue` | `integer (int64)` | obrigatório | — | — | `0` |
| `paymentDate` | `string (date-time)` | obrigatório | — | — | `"2025-08-11T13:45:00Z"` |
| `principalValue` | `integer (int64)` | obrigatório | — | — | `0` |
| `sessionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `code` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "barCodeOrDigitableLine": "texto",
  "identificationOperationStatement": "texto",
  "paymentValue": 0,
  "paymentDate": "2025-08-11T13:45:00Z",
  "principalValue": 0,
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}
```

**Resposta 200**

Campos:

| 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 | `{ … }` |
| `bankAccountId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `barCode` | `string` | opcional | — | — | `"texto"` |
| `nsu` | `string` | opcional | — | — | `"texto"` |
| `amount` | `integer (int64)` | opcional | — | — | `0` |
| `date` | `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"` |
| `errorMessage` | `string` | opcional | — | — | `"texto"` |
| `authorizedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `requester` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `approvals` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `requester`:

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

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",
  "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"
  },
  "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "barCode": "texto",
  "nsu": "texto",
  "amount": 0,
  "date": "2025-08-11T13:45:00Z",
  "paymentPurpose": "PagamentoDeImpostosTributosETaxas",
  "paymentPurposeDisplay": "texto",
  "status": "Approved",
  "statusDisplay": "texto",
  "errorMessage": "texto",
  "authorizedAt": "2025-08-11T13:45:00Z",
  "requester": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "registrationNumber": "12345678909",
    "userIdDisplay": "texto",
    "tenantDisplay": "texto",
    "tenantName": "Fulano de Tal"
  },
  "approvals": [
    {
      "level": "Viewer",
      "action": "Approve",
      "actionDisplay": "texto",
      "user": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      }
    }
  ]
}
```

**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/Pay/TaxWithBarCode" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "barCodeOrDigitableLine": "texto",
  "identificationOperationStatement": "texto",
  "paymentValue": 0,
  "paymentDate": "2025-08-11T13:45:00Z",
  "principalValue": 0,
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}'
```

---

### POST /v1/BankAccount/{id}/Pay/FGTSWithBarCode

**Solicitar o pagamento de um boleto de tributo FGTS através do código de barras e…** — Cria um novo registro de Bank Account.

Solicitar o pagamento de um boleto de tributo FGTS através do código de barras e linha digitável

**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 |
|---|---|---|---|---|---|
| `barCodeOrDigitableLine` | `string` | obrigatório | — | — | `"texto"` |
| `identificationOperationStatement` | `string` | opcional | — | — | `"texto"` |
| `paymentValue` | `integer (int64)` | obrigatório | — | — | `0` |
| `paymentDate` | `string (date-time)` | obrigatório | — | — | `"2025-08-11T13:45:00Z"` |
| `taxPayerIdentificationType` | `integer` | opcional | — | — | `1` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `identification` | `string` | opcional | — | — | `"texto"` |
| `seal` | `string` | opcional | — | — | `"texto"` |
| `digitSeal` | `string` | opcional | — | — | `"texto"` |
| `sessionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `code` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "barCodeOrDigitableLine": "texto",
  "identificationOperationStatement": "texto",
  "paymentValue": 0,
  "paymentDate": "2025-08-11T13:45:00Z",
  "taxPayerIdentificationType": 1,
  "registrationNumber": "12345678909",
  "identification": "texto",
  "seal": "texto",
  "digitSeal": "texto",
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}
```

**Resposta 200**

Campos:

| 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 | `{ … }` |
| `bankAccountId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `barCode` | `string` | opcional | — | — | `"texto"` |
| `nsu` | `string` | opcional | — | — | `"texto"` |
| `amount` | `integer (int64)` | opcional | — | — | `0` |
| `date` | `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"` |
| `errorMessage` | `string` | opcional | — | — | `"texto"` |
| `authorizedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `requester` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `approvals` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `requester`:

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

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",
  "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"
  },
  "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "barCode": "texto",
  "nsu": "texto",
  "amount": 0,
  "date": "2025-08-11T13:45:00Z",
  "paymentPurpose": "PagamentoDeImpostosTributosETaxas",
  "paymentPurposeDisplay": "texto",
  "status": "Approved",
  "statusDisplay": "texto",
  "errorMessage": "texto",
  "authorizedAt": "2025-08-11T13:45:00Z",
  "requester": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "registrationNumber": "12345678909",
    "userIdDisplay": "texto",
    "tenantDisplay": "texto",
    "tenantName": "Fulano de Tal"
  },
  "approvals": [
    {
      "level": "Viewer",
      "action": "Approve",
      "actionDisplay": "texto",
      "user": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      }
    }
  ]
}
```

**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/Pay/FGTSWithBarCode" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "barCodeOrDigitableLine": "texto",
  "identificationOperationStatement": "texto",
  "paymentValue": 0,
  "paymentDate": "2025-08-11T13:45:00Z",
  "taxPayerIdentificationType": 1,
  "registrationNumber": "12345678909",
  "identification": "texto",
  "seal": "texto",
  "digitSeal": "texto",
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}'
```

---

### POST /v1/BankAccount/{id}/Pay/DARFWithBarCode

**Solicitar o pagamento de um boleto de tributo DARF através do código de barras e…** — Cria um novo registro de Bank Account.

Solicitar o pagamento de um boleto de tributo DARF através do código de barras e linha digitável

**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 |
|---|---|---|---|---|---|
| `barCodeOrDigitableLine` | `string` | obrigatório | — | — | `"texto"` |
| `identificationOperationStatement` | `string` | opcional | — | — | `"texto"` |
| `paymentValue` | `integer (int64)` | obrigatório | — | — | `0` |
| `paymentDate` | `string (date-time)` | obrigatório | — | — | `"2025-08-11T13:45:00Z"` |
| `name` | `string` | obrigatório | — | — | `"Fulano de Tal"` |
| `calculationPeriod` | `string (date-time)` | obrigatório | — | — | `"2025-08-11T13:45:00Z"` |
| `registrationNumber` | `string` | obrigatório | — | — | `"12345678909"` |
| `receitaFederalCodeId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `referenceNumber` | `string` | opcional | — | — | `"texto"` |
| `dueDate` | `string (date-time)` | obrigatório | — | — | `"2025-08-11T13:45:00Z"` |
| `principalValue` | `integer (int64)` | obrigatório | — | — | `0` |
| `assessmentValue` | `integer (int64)` | obrigatório | — | — | `0` |
| `interestValue` | `integer (int64)` | obrigatório | — | — | `0` |
| `interestAndChargesValue` | `integer (int64)` | obrigatório | — | — | `0` |
| `totalValue` | `integer (int64)` | obrigatório | — | — | `0` |
| `sessionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `code` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "barCodeOrDigitableLine": "texto",
  "identificationOperationStatement": "texto",
  "paymentValue": 0,
  "paymentDate": "2025-08-11T13:45:00Z",
  "name": "Fulano de Tal",
  "calculationPeriod": "2025-08-11T13:45:00Z",
  "registrationNumber": "12345678909",
  "receitaFederalCodeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "referenceNumber": "texto",
  "dueDate": "2025-08-11T13:45:00Z",
  "principalValue": 0,
  "assessmentValue": 0,
  "interestValue": 0,
  "interestAndChargesValue": 0,
  "totalValue": 0,
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}
```

**Resposta 200**

Campos:

| 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 | `{ … }` |
| `bankAccountId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `barCode` | `string` | opcional | — | — | `"texto"` |
| `nsu` | `string` | opcional | — | — | `"texto"` |
| `amount` | `integer (int64)` | opcional | — | — | `0` |
| `date` | `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"` |
| `errorMessage` | `string` | opcional | — | — | `"texto"` |
| `authorizedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `requester` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `approvals` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `requester`:

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

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",
  "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"
  },
  "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "barCode": "texto",
  "nsu": "texto",
  "amount": 0,
  "date": "2025-08-11T13:45:00Z",
  "paymentPurpose": "PagamentoDeImpostosTributosETaxas",
  "paymentPurposeDisplay": "texto",
  "status": "Approved",
  "statusDisplay": "texto",
  "errorMessage": "texto",
  "authorizedAt": "2025-08-11T13:45:00Z",
  "requester": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "registrationNumber": "12345678909",
    "userIdDisplay": "texto",
    "tenantDisplay": "texto",
    "tenantName": "Fulano de Tal"
  },
  "approvals": [
    {
      "level": "Viewer",
      "action": "Approve",
      "actionDisplay": "texto",
      "user": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      }
    }
  ]
}
```

**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/Pay/DARFWithBarCode" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "barCodeOrDigitableLine": "texto",
  "identificationOperationStatement": "texto",
  "paymentValue": 0,
  "paymentDate": "2025-08-11T13:45:00Z",
  "name": "Fulano de Tal",
  "calculationPeriod": "2025-08-11T13:45:00Z",
  "registrationNumber": "12345678909",
  "receitaFederalCodeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "referenceNumber": "texto",
  "dueDate": "2025-08-11T13:45:00Z",
  "principalValue": 0,
  "assessmentValue": 0,
  "interestValue": 0,
  "interestAndChargesValue": 0,
  "totalValue": 0,
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}'
```

---

### POST /v1/BankAccount/{id}/Pay/DARF

**Solicitar o pagamento de um boleto de tributo DARF sem código de barras** — 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 |
|---|---|---|---|---|---|
| `identificationOperationStatement` | `string` | opcional | — | — | `"texto"` |
| `paymentValue` | `integer (int64)` | obrigatório | — | — | `0` |
| `paymentDate` | `string (date-time)` | obrigatório | — | — | `"2025-08-11T13:45:00Z"` |
| `name` | `string` | obrigatório | — | — | `"Fulano de Tal"` |
| `calculationPeriod` | `string (date-time)` | obrigatório | — | — | `"2025-08-11T13:45:00Z"` |
| `registrationNumber` | `string` | obrigatório | — | — | `"12345678909"` |
| `receitaFederalCodeId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `referenceNumber` | `string` | opcional | — | — | `"texto"` |
| `dueDate` | `string (date-time)` | obrigatório | — | — | `"2025-08-11T13:45:00Z"` |
| `principalValue` | `integer (int64)` | obrigatório | — | — | `0` |
| `assessmentValue` | `integer (int64)` | obrigatório | — | — | `0` |
| `interestValue` | `integer (int64)` | obrigatório | — | — | `0` |
| `interestAndChargesValue` | `integer (int64)` | obrigatório | — | — | `0` |
| `totalValue` | `integer (int64)` | obrigatório | — | — | `0` |
| `sessionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `code` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "identificationOperationStatement": "texto",
  "paymentValue": 0,
  "paymentDate": "2025-08-11T13:45:00Z",
  "name": "Fulano de Tal",
  "calculationPeriod": "2025-08-11T13:45:00Z",
  "registrationNumber": "12345678909",
  "receitaFederalCodeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "referenceNumber": "texto",
  "dueDate": "2025-08-11T13:45:00Z",
  "principalValue": 0,
  "assessmentValue": 0,
  "interestValue": 0,
  "interestAndChargesValue": 0,
  "totalValue": 0,
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}
```

**Resposta 200**

Campos:

| 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 | `{ … }` |
| `bankAccountId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `barCode` | `string` | opcional | — | — | `"texto"` |
| `nsu` | `string` | opcional | — | — | `"texto"` |
| `amount` | `integer (int64)` | opcional | — | — | `0` |
| `date` | `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"` |
| `errorMessage` | `string` | opcional | — | — | `"texto"` |
| `authorizedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `requester` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `approvals` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `requester`:

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

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",
  "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"
  },
  "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "barCode": "texto",
  "nsu": "texto",
  "amount": 0,
  "date": "2025-08-11T13:45:00Z",
  "paymentPurpose": "PagamentoDeImpostosTributosETaxas",
  "paymentPurposeDisplay": "texto",
  "status": "Approved",
  "statusDisplay": "texto",
  "errorMessage": "texto",
  "authorizedAt": "2025-08-11T13:45:00Z",
  "requester": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "registrationNumber": "12345678909",
    "userIdDisplay": "texto",
    "tenantDisplay": "texto",
    "tenantName": "Fulano de Tal"
  },
  "approvals": [
    {
      "level": "Viewer",
      "action": "Approve",
      "actionDisplay": "texto",
      "user": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      }
    }
  ]
}
```

**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/Pay/DARF" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "identificationOperationStatement": "texto",
  "paymentValue": 0,
  "paymentDate": "2025-08-11T13:45:00Z",
  "name": "Fulano de Tal",
  "calculationPeriod": "2025-08-11T13:45:00Z",
  "registrationNumber": "12345678909",
  "receitaFederalCodeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "referenceNumber": "texto",
  "dueDate": "2025-08-11T13:45:00Z",
  "principalValue": 0,
  "assessmentValue": 0,
  "interestValue": 0,
  "interestAndChargesValue": 0,
  "totalValue": 0,
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}'
```

---

### POST /v1/BankAccount/{id}/Pay/GAREICMS

**Solicitar o pagamento de um boleto de tributo GARE - ICMS** — 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 |
|---|---|---|---|---|---|
| `identificationOperationStatement` | `string` | opcional | — | — | `"texto"` |
| `paymentValue` | `integer (int64)` | obrigatório | — | — | `0` |
| `paymentDate` | `string (date-time)` | obrigatório | — | — | `"2025-08-11T13:45:00Z"` |
| `dueDate` | `string (date-time)` | obrigatório | — | — | `"2025-08-11T13:45:00Z"` |
| `receitaFederalCodeId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `stateRegistration` | `string` | obrigatório | — | — | `"texto"` |
| `registrationNumber` | `string` | obrigatório | — | — | `"12345678909"` |
| `activeDebitRegistration` | `string` | opcional | — | — | `"texto"` |
| `tagNumber` | `string` | opcional | — | — | `"texto"` |
| `referenceNumber` | `string (date-time)` | obrigatório | — | — | `"2025-08-11T13:45:00Z"` |
| `diNumber` | `string` | obrigatório | — | — | `"texto"` |
| `installmentNumber` | `string` | obrigatório | — | — | `"texto"` |
| `valueOfRevenue` | `integer (int64)` | obrigatório | — | — | `0` |
| `interestMoraValue` | `integer (int64)` | opcional | — | — | `0` |
| `assessmentMoraValue` | `integer (int64)` | opcional | — | — | `0` |
| `assessmentForInfractionValue` | `integer (int64)` | opcional | — | — | `0` |
| `financialAdditionValue` | `integer (int64)` | obrigatório | — | — | `0` |
| `advocativeHoursValue` | `integer (int64)` | opcional | — | — | `0` |
| `totalValue` | `integer (int64)` | obrigatório | — | — | `0` |
| `taxPayer` | `string` | obrigatório | — | — | `"texto"` |
| `address` | `string` | opcional | — | — | `"texto"` |
| `phone` | `string` | opcional | — | — | `"11987654321"` |
| `cnae` | `string` | opcional | — | — | `"texto"` |
| `observations` | `string` | opcional | — | — | `"texto"` |
| `sessionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `code` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "identificationOperationStatement": "texto",
  "paymentValue": 0,
  "paymentDate": "2025-08-11T13:45:00Z",
  "dueDate": "2025-08-11T13:45:00Z",
  "receitaFederalCodeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "stateRegistration": "texto",
  "registrationNumber": "12345678909",
  "activeDebitRegistration": "texto",
  "tagNumber": "texto",
  "referenceNumber": "2025-08-11T13:45:00Z",
  "diNumber": "texto",
  "installmentNumber": "texto",
  "valueOfRevenue": 0,
  "interestMoraValue": 0,
  "assessmentMoraValue": 0,
  "assessmentForInfractionValue": 0,
  "financialAdditionValue": 0,
  "advocativeHoursValue": 0,
  "totalValue": 0,
  "taxPayer": "texto",
  "address": "texto",
  "phone": "11987654321",
  "cnae": "texto",
  "observations": "texto",
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}
```

**Resposta 200**

Campos:

| 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 | `{ … }` |
| `bankAccountId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `barCode` | `string` | opcional | — | — | `"texto"` |
| `nsu` | `string` | opcional | — | — | `"texto"` |
| `amount` | `integer (int64)` | opcional | — | — | `0` |
| `date` | `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"` |
| `errorMessage` | `string` | opcional | — | — | `"texto"` |
| `authorizedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `requester` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `approvals` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `requester`:

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

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",
  "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"
  },
  "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "barCode": "texto",
  "nsu": "texto",
  "amount": 0,
  "date": "2025-08-11T13:45:00Z",
  "paymentPurpose": "PagamentoDeImpostosTributosETaxas",
  "paymentPurposeDisplay": "texto",
  "status": "Approved",
  "statusDisplay": "texto",
  "errorMessage": "texto",
  "authorizedAt": "2025-08-11T13:45:00Z",
  "requester": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "registrationNumber": "12345678909",
    "userIdDisplay": "texto",
    "tenantDisplay": "texto",
    "tenantName": "Fulano de Tal"
  },
  "approvals": [
    {
      "level": "Viewer",
      "action": "Approve",
      "actionDisplay": "texto",
      "user": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      }
    }
  ]
}
```

**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/Pay/GAREICMS" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "identificationOperationStatement": "texto",
  "paymentValue": 0,
  "paymentDate": "2025-08-11T13:45:00Z",
  "dueDate": "2025-08-11T13:45:00Z",
  "receitaFederalCodeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "stateRegistration": "texto",
  "registrationNumber": "12345678909",
  "activeDebitRegistration": "texto",
  "tagNumber": "texto",
  "referenceNumber": "2025-08-11T13:45:00Z",
  "diNumber": "texto",
  "installmentNumber": "texto",
  "valueOfRevenue": 0,
  "interestMoraValue": 0,
  "assessmentMoraValue": 0,
  "assessmentForInfractionValue": 0,
  "financialAdditionValue": 0,
  "advocativeHoursValue": 0,
  "totalValue": 0,
  "taxPayer": "texto",
  "address": "texto",
  "phone": "11987654321",
  "cnae": "texto",
  "observations": "texto",
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}'
```

---

### POST /v1/BankAccount/{id}/Pay/GAREIPVA

**Solicita o pagamento de um boleto de tributo GARE - IPVA** — 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 |
|---|---|---|---|---|---|
| `identificationOperationStatement` | `string` | opcional | — | — | `"texto"` |
| `paymentValue` | `integer (int64)` | obrigatório | — | — | `0` |
| `paymentDate` | `string (date-time)` | obrigatório | — | — | `"2025-08-11T13:45:00Z"` |
| `receitaFederalCodeId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `taxPayer` | `string` | obrigatório | — | — | `"texto"` |
| `address` | `string` | opcional | — | — | `"texto"` |
| `zipCode` | `string` | opcional | — | — | `"01310930"` |
| `registrationNumber` | `string` | obrigatório | — | — | `"12345678909"` |
| `cityCode` | `string` | obrigatório | — | — | `"texto"` |
| `quote` | `string` | obrigatório | — | — | `"texto"` |
| `dueDate` | `string (date-time)` | obrigatório | — | — | `"2025-08-11T13:45:00Z"` |
| `exercise` | `string` | obrigatório | — | — | `"texto"` |
| `ipvaRange` | `string` | obrigatório | — | — | `"texto"` |
| `interestMoraValue` | `integer (int64)` | opcional | — | — | `0` |
| `assessmentForInfractionValue` | `integer (int64)` | opcional | — | — | `0` |
| `aiimNumber` | `string` | opcional | — | — | `"texto"` |
| `totalValue` | `integer (int64)` | obrigatório | — | — | `0` |
| `typeSpecie` | `string` | obrigatório | — | — | `"texto"` |
| `brandModel` | `string` | opcional | — | — | `"texto"` |
| `chassis` | `string` | opcional | — | — | `"texto"` |
| `renavam` | `string` | opcional | — | — | `"texto"` |
| `origin` | `string` | opcional | — | — | `"texto"` |
| `yearManufacture` | `string` | opcional | — | — | `"texto"` |
| `previousBoard` | `string` | opcional | — | — | `"texto"` |
| `currentBoard` | `string` | obrigatório | — | — | `"texto"` |
| `fuel` | `string` | opcional | — | — | `"texto"` |
| `power` | `string` | opcional | — | — | `"texto"` |
| `length` | `string` | opcional | — | — | `"texto"` |
| `propulsion` | `string` | opcional | — | — | `"texto"` |
| `maximumTakeoffWeight` | `string` | opcional | — | — | `"texto"` |
| `valueOfRevenue` | `integer (int64)` | obrigatório | — | — | `0` |
| `sessionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `code` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "identificationOperationStatement": "texto",
  "paymentValue": 0,
  "paymentDate": "2025-08-11T13:45:00Z",
  "receitaFederalCodeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "taxPayer": "texto",
  "address": "texto",
  "zipCode": "01310930",
  "registrationNumber": "12345678909",
  "cityCode": "texto",
  "quote": "texto",
  "dueDate": "2025-08-11T13:45:00Z",
  "exercise": "texto",
  "ipvaRange": "texto",
  "interestMoraValue": 0,
  "assessmentForInfractionValue": 0,
  "aiimNumber": "texto",
  "totalValue": 0,
  "typeSpecie": "texto",
  "brandModel": "texto",
  "chassis": "texto",
  "renavam": "texto",
  "origin": "texto",
  "yearManufacture": "texto",
  "previousBoard": "texto",
  "currentBoard": "texto",
  "fuel": "texto",
  "power": "texto",
  "length": "texto",
  "propulsion": "texto",
  "maximumTakeoffWeight": "texto",
  "valueOfRevenue": 0,
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}
```

**Resposta 200**

Campos:

| 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 | `{ … }` |
| `bankAccountId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `barCode` | `string` | opcional | — | — | `"texto"` |
| `nsu` | `string` | opcional | — | — | `"texto"` |
| `amount` | `integer (int64)` | opcional | — | — | `0` |
| `date` | `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"` |
| `errorMessage` | `string` | opcional | — | — | `"texto"` |
| `authorizedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `requester` | `objeto` | opcional | — | objeto — ver detalhe abaixo | `{ … }` |
| `approvals` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `requester`:

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

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",
  "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"
  },
  "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "barCode": "texto",
  "nsu": "texto",
  "amount": 0,
  "date": "2025-08-11T13:45:00Z",
  "paymentPurpose": "PagamentoDeImpostosTributosETaxas",
  "paymentPurposeDisplay": "texto",
  "status": "Approved",
  "statusDisplay": "texto",
  "errorMessage": "texto",
  "authorizedAt": "2025-08-11T13:45:00Z",
  "requester": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "registrationNumber": "12345678909",
    "userIdDisplay": "texto",
    "tenantDisplay": "texto",
    "tenantName": "Fulano de Tal"
  },
  "approvals": [
    {
      "level": "Viewer",
      "action": "Approve",
      "actionDisplay": "texto",
      "user": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      }
    }
  ]
}
```

**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/Pay/GAREIPVA" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "identificationOperationStatement": "texto",
  "paymentValue": 0,
  "paymentDate": "2025-08-11T13:45:00Z",
  "receitaFederalCodeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "taxPayer": "texto",
  "address": "texto",
  "zipCode": "01310930",
  "registrationNumber": "12345678909",
  "cityCode": "texto",
  "quote": "texto",
  "dueDate": "2025-08-11T13:45:00Z",
  "exercise": "texto",
  "ipvaRange": "texto",
  "interestMoraValue": 0,
  "assessmentForInfractionValue": 0,
  "aiimNumber": "texto",
  "totalValue": 0,
  "typeSpecie": "texto",
  "brandModel": "texto",
  "chassis": "texto",
  "renavam": "texto",
  "origin": "texto",
  "yearManufacture": "texto",
  "previousBoard": "texto",
  "currentBoard": "texto",
  "fuel": "texto",
  "power": "texto",
  "length": "texto",
  "propulsion": "texto",
  "maximumTakeoffWeight": "texto",
  "valueOfRevenue": 0,
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}'
```

---

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

**Obter uma lista de transferências por 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` |
| `searchString` | query | `string` | opcional | — | `valor` |
| `f_nsu` | query | `string` | opcional | — | `valor` |
| `f_amount` | query | `integer (int64)` | opcional | — | `10` |
| `f_transferDate` | query | `string (date-time)` | opcional | — | `valor` |
| `f_operationType` | query | `objeto` | opcional | — | `valor` |
| `f_paymentPurpose` | query | `objeto` | opcional | — | `valor` |
| `f_beneficiaryName` | query | `string` | opcional | — | `valor` |
| `f_beneficiaryRegistrationNumber` | query | `string` | opcional | — | `valor` |
| `f_status` | query | `objeto` | opcional | — | `valor` |
| `isDeleted` | query | `boolean` | opcional | — | `true` |
| `orderBy` | query | `string` | opcional | — | `valor` |

**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 | `{ … }` |
| `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
{
  "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"
      },
      "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": {},
        "tenant": "texto",
        "tenantDisplay": "texto",
        "updatedAt": "2025-08-11T13:45:00Z",
        "updatedBy": {},
        "ownerUser": {},
        "ownerGroup": {},
        "name": "Fulano de Tal",
        "registrationNumber": "12345678909",
        "bank": 0,
        "bankIspb": 0,
        "bankDisplay": "texto",
        "agency": 0,
        "accountNumber": "texto",
        "tenantName": "Fulano de Tal",
        "accountType": {},
        "accountTypeDisplay": "texto",
        "status": {},
        "statusDisplay": "texto",
        "operationTypeValue": {},
        "operationTypeValueDisplay": "texto",
        "pixKeyTypeValue": {},
        "pixKeyTypeValueDisplay": "texto",
        "keyPix": "texto",
        "authorizedAt": "2025-08-11T13:45:00Z",
        "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "requester": {},
        "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": [
        {}
      ]
    }
  ],
  "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/3fa85f64-5717-4562-b3fc-2c963f66afa6/Transfer" \
  -H "Authorization: Bearer {{token}}"
```

---

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

**Solicitar uma transferência interna, inter-bancária via TED ou PIX** — 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` |
| `X-Registration-Number` | header | `string` | opcional | CPF do operador autenticador | `valor` |

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `amount` | `integer (int64)` | obrigatório | — | — | `0` |
| `bankAccountBeneficiaryId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `bankAccountBeneficiaryCreate` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `qrCode` | `string` | opcional | — | — | `"texto"` |
| `transferDate` | `string (date-time)` | obrigatório | — | — | `"2025-08-11T13:45:00Z"` |
| `paymentPurpose` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"PagamentoDeImpostosTributosETaxas"` |
| `endToEndId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `saveBeneficiary` | `boolean` | opcional | — | — | `true` |
| `urlSendFlowFinishNotification` | `string` | opcional | — | — | `"https://exemplo.com.br/callback"` |
| `debitAccountExternalId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `sessionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `code` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "amount": 0,
  "bankAccountBeneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "bankAccountBeneficiaryCreate": {
    "name": "Fulano de Tal",
    "registrationNumber": "12345678909",
    "bank": 0,
    "bankIspb": 0,
    "agency": 0,
    "accountNumber": "texto",
    "accountType": "NaturalCheckingAccount",
    "operationTypeValue": "Transfer",
    "pixKeyTypeValue": "NaturalRegistrationNumber",
    "keyPix": "texto"
  },
  "qrCode": "texto",
  "transferDate": "2025-08-11T13:45:00Z",
  "paymentPurpose": "PagamentoDeImpostosTributosETaxas",
  "endToEndId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "saveBeneficiary": true,
  "urlSendFlowFinishNotification": "https://exemplo.com.br/callback",
  "debitAccountExternalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}
```

**Resposta 200**

Campos:

| 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",
  "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": [
      {
        "level": {},
        "action": {},
        "actionDisplay": "texto",
        "user": {}
      }
    ]
  },
  "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": "Viewer",
      "action": "Approve",
      "actionDisplay": "texto",
      "user": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      }
    }
  ]
}
```

**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/Transfer" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": 0,
  "bankAccountBeneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "bankAccountBeneficiaryCreate": {
    "name": "Fulano de Tal",
    "registrationNumber": "12345678909",
    "bank": 0,
    "bankIspb": 0,
    "agency": 0,
    "accountNumber": "texto",
    "accountType": "NaturalCheckingAccount",
    "operationTypeValue": "Transfer",
    "pixKeyTypeValue": "NaturalRegistrationNumber",
    "keyPix": "texto"
  },
  "qrCode": "texto",
  "transferDate": "2025-08-11T13:45:00Z",
  "paymentPurpose": "PagamentoDeImpostosTributosETaxas",
  "endToEndId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "saveBeneficiary": true,
  "urlSendFlowFinishNotification": "https://exemplo.com.br/callback",
  "debitAccountExternalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}'
```

---

### PUT /v1/BankAccount/{id}/Transfer/{transferId}/approve

**Aprovar/reprovar uma solicitação de transferência** — Atualiza por completo um registro de Bank Account existente.

**Parâmetros**

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

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

Campos:

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

Exemplo:

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

**Códigos de retorno**

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

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Transfer/3fa85f64-5717-4562-b3fc-2c963f66afa6/approve" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "Approve",
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}'
```

---

### PUT /v1/BankAccount/Transfer/BatchApproval

**Aprovar/reprovar uma solicitações de transferência por lote** — Atualiza por completo um registro de Bank Account existente.

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `transferBankAccounts` | `array de objeto` | obrigatório | — | objeto — ver detalhe abaixo | `[ … ]` |
| `action` | `string` | obrigatório | — | `Approve`, `Reject`, `Cancel` | `"Approve"` |
| `sessionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `code` | `string` | opcional | — | — | `"texto"` |

Detalhe de `transferBankAccounts`:

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

Exemplo:

```json
{
  "transferBankAccounts": [
    {
      "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "transferId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "action": "Approve",
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}
```

**Códigos de retorno**

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

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/BankAccount/Transfer/BatchApproval" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "transferBankAccounts": [
    {
      "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "transferId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "action": "Approve",
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}'
```

---

### PUT /v1/BankAccount/{id}/Transfer/{transferId}/cancel

**Cancelar uma solicitação de transferência** — Atualiza por completo um registro de Bank Account existente.

**Parâmetros**

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

**Códigos de retorno**

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

**cURL**

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

---

## Limites

Consulte e ajuste limites operacionais da conta.

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

**Obter o limite efetivo da conta** — 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 |
|---|---|---|---|---|---|
| `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 | `{ … }` |
| `status` | `string` | opcional | — | `Pending`, `Rejected`, `Approved` | `"Pending"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `uploads` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `pixLimit` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `bankSlipLimit` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `transferLimit` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `tedLimit` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `updateStatusUser` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `bankAccount` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `bankAccountId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `existPendingLimitsApproval` | `boolean` | opcional | — | — | `true` |

Detalhe de `uploads`:

| 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 | `{ … }` |
| `fileName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `fileType` | `string` | opcional | — | — | `"texto"` |
| `displayName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `tempUrl` | `string` | opcional | — | — | `"https://exemplo.com.br/callback"` |
| `tempGetUrl` | `string` | opcional | — | — | `"https://exemplo.com.br/callback"` |
| `tempPutUrl` | `string` | opcional | — | — | `"https://exemplo.com.br/callback"` |

Exemplo:

```json
{
  "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"
  },
  "status": "Pending",
  "statusDisplay": "texto",
  "uploads": [
    {
      "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"
      },
      "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"
    }
  ],
  "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
    }
  },
  "updateStatusUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "registrationNumber": "12345678909",
    "userIdDisplay": "texto",
    "tenantDisplay": "texto",
    "tenantName": "Fulano de Tal"
  },
  "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": {
        "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"
      },
      "registrationNumber": "12345678909",
      "name": "Fulano de Tal"
    },
    "balance": {
      "currentBalance": 0,
      "blockedBalance": 0,
      "available": 0,
      "bankAccount": {
        "bankCode": 0,
        "bankIspb": 0,
        "bankCodeDisplay": "texto",
        "type": {},
        "typeDisplay": "texto",
        "modality": {},
        "modalityDisplay": "texto",
        "account": 0,
        "agency": 0,
        "personRegistrationNumber": "texto",
        "personName": "Fulano de Tal",
        "isDeleted": true,
        "status": {},
        "creditors": []
      }
    },
    "creditors": [
      {
        "id": "texto",
        "name": "Fulano de Tal",
        "tenant": "texto"
      }
    ]
  },
  "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "existPendingLimitsApproval": true
}
```

**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/Limits" \
  -H "Authorization: Bearer {{token}}"
```

---

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

**Solicitar novo limite na conta digital** — 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 |
|---|---|---|---|---|---|
| `description` | `string` | opcional | — | — | `"texto"` |
| `uploads` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `pixLimit` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `bankSlipLimit` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `transferLimit` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `tedLimit` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `sessionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `code` | `string` | opcional | — | — | `"texto"` |

Detalhe de `uploads`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `fileType` | `string` | obrigatório | — | `Document`, `Authorization`, `DriversLicense`, `WorkCard`, `ResidenceProofCompany`, `ResidenceProofPartners`, `Draft`, `SocialContract`, `RegistrationNumber`, `IdentificationDocumentWithPhoto`, `BankStatement`, `ManagerialBilling`, `RegistrationForm`, `Others`, `Selfie`, `SelfieWithIdentityCard`, `LastDeclaration`, `SignedContract`, `SigningStampContract`, `CreditReport`, `Assignment`, `Addition`, `FiduciaryAssignment`, `P7S`, `ZipedFiles`, `CNAB`, `Invoice`, `MinutesOfElection`, `Procuration`, `TermOfOwnership`, `Bylaws`, `IdentityCard`, `Collateral`, `Regulation`, `Balance`, `BalanceSheet`, `PLDFT`, `IncomeTax`, `DRE`, `Receipt`, `CompanyCard`, `AssignmetReport`, `NationalRegistryOfForeigners`, `NationalIdentityCard`, `RegionalRegistrationCard`, `Passaport`, `Paycheck`, `Indorsement` | `"Document"` |
| `fileName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |
| `displayName` | `string` | opcional | — | — | `"Fulano de Tal"` |

Exemplo:

```json
{
  "description": "texto",
  "uploads": [
    {
      "fileType": "Document",
      "fileName": "Fulano de Tal",
      "displayName": "Fulano de Tal"
    }
  ],
  "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
    }
  },
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}
```

**Resposta 201**

Campos:

| 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 | `{ … }` |
| `status` | `string` | opcional | — | `Pending`, `Rejected`, `Approved` | `"Pending"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `uploads` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `pixLimit` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `bankSlipLimit` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `transferLimit` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `tedLimit` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `updateStatusUser` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `bankAccount` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `bankAccountId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `existPendingLimitsApproval` | `boolean` | opcional | — | — | `true` |

Detalhe de `uploads`:

| 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 | `{ … }` |
| `fileName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `fileType` | `string` | opcional | — | — | `"texto"` |
| `displayName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `tempUrl` | `string` | opcional | — | — | `"https://exemplo.com.br/callback"` |
| `tempGetUrl` | `string` | opcional | — | — | `"https://exemplo.com.br/callback"` |
| `tempPutUrl` | `string` | opcional | — | — | `"https://exemplo.com.br/callback"` |

Exemplo:

```json
{
  "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"
  },
  "status": "Pending",
  "statusDisplay": "texto",
  "uploads": [
    {
      "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"
      },
      "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"
    }
  ],
  "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
    }
  },
  "updateStatusUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "registrationNumber": "12345678909",
    "userIdDisplay": "texto",
    "tenantDisplay": "texto",
    "tenantName": "Fulano de Tal"
  },
  "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": {
        "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"
      },
      "registrationNumber": "12345678909",
      "name": "Fulano de Tal"
    },
    "balance": {
      "currentBalance": 0,
      "blockedBalance": 0,
      "available": 0,
      "bankAccount": {
        "bankCode": 0,
        "bankIspb": 0,
        "bankCodeDisplay": "texto",
        "type": {},
        "typeDisplay": "texto",
        "modality": {},
        "modalityDisplay": "texto",
        "account": 0,
        "agency": 0,
        "personRegistrationNumber": "texto",
        "personName": "Fulano de Tal",
        "isDeleted": true,
        "status": {},
        "creditors": []
      }
    },
    "creditors": [
      {
        "id": "texto",
        "name": "Fulano de Tal",
        "tenant": "texto"
      }
    ]
  },
  "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "existPendingLimitsApproval": true
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `201` | Recurso criado com sucesso. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Limits" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "description": "texto",
  "uploads": [
    {
      "fileType": "Document",
      "fileName": "Fulano de Tal",
      "displayName": "Fulano de Tal"
    }
  ],
  "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
    }
  },
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}'
```

---

### PUT /v1/BankAccount/{id}/Limits/{limitsId}

**Aprovar/Rejeitar limite da conta** — Atualiza por completo um registro de Bank Account existente.

**Parâmetros**

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

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `status` | `string` | obrigatório | — | `Pending`, `Rejected`, `Approved` | `"Pending"` |
| `uploads` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `pixLimit` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `bankSlipLimit` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `transferLimit` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `tedLimit` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `sessionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `code` | `string` | opcional | — | — | `"texto"` |

Detalhe de `uploads`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `fileName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |
| `fileType` | `string` | opcional | — | `Document`, `Authorization`, `DriversLicense`, `WorkCard`, `ResidenceProofCompany`, `ResidenceProofPartners`, `Draft`, `SocialContract`, `RegistrationNumber`, `IdentificationDocumentWithPhoto`, `BankStatement`, `ManagerialBilling`, `RegistrationForm`, `Others`, `Selfie`, `SelfieWithIdentityCard`, `LastDeclaration`, `SignedContract`, `SigningStampContract`, `CreditReport`, `Assignment`, `Addition`, `FiduciaryAssignment`, `P7S`, `ZipedFiles`, `CNAB`, `Invoice`, `MinutesOfElection`, `Procuration`, `TermOfOwnership`, `Bylaws`, `IdentityCard`, `Collateral`, `Regulation`, `Balance`, `BalanceSheet`, `PLDFT`, `IncomeTax`, `DRE`, `Receipt`, `CompanyCard`, `AssignmetReport`, `NationalRegistryOfForeigners`, `NationalIdentityCard`, `RegionalRegistrationCard`, `Passaport`, `Paycheck`, `Indorsement` | `"Document"` |
| `displayName` | `string` | opcional | — | — | `"Fulano de Tal"` |

Exemplo:

```json
{
  "status": "Pending",
  "uploads": [
    {
      "id": "texto",
      "fileName": "Fulano de Tal",
      "fileType": "Document",
      "displayName": "Fulano de Tal"
    }
  ],
  "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
    }
  },
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}
```

**Códigos de retorno**

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

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Limits/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "Pending",
  "uploads": [
    {
      "id": "texto",
      "fileName": "Fulano de Tal",
      "fileType": "Document",
      "displayName": "Fulano de Tal"
    }
  ],
  "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
    }
  },
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}'
```

---

### PUT /v1/BankAccount/Limits/ApproveOrRejectByBatch

**Aprovar/Rejeitar limites da conta por lote** — Atualiza por completo um registro de Bank Account existente.

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `bankAccountTransactionLimitsIds` | `array de string` | obrigatório | — | — | `[ … ]` |
| `status` | `string` | obrigatório | — | `Pending`, `Rejected`, `Approved` | `"Pending"` |
| `uploads` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `pixLimit` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `bankSlipLimit` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `transferLimit` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `tedLimit` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `sessionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `code` | `string` | opcional | — | — | `"texto"` |

Detalhe de `uploads`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `fileName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |
| `fileType` | `string` | opcional | — | `Document`, `Authorization`, `DriversLicense`, `WorkCard`, `ResidenceProofCompany`, `ResidenceProofPartners`, `Draft`, `SocialContract`, `RegistrationNumber`, `IdentificationDocumentWithPhoto`, `BankStatement`, `ManagerialBilling`, `RegistrationForm`, `Others`, `Selfie`, `SelfieWithIdentityCard`, `LastDeclaration`, `SignedContract`, `SigningStampContract`, `CreditReport`, `Assignment`, `Addition`, `FiduciaryAssignment`, `P7S`, `ZipedFiles`, `CNAB`, `Invoice`, `MinutesOfElection`, `Procuration`, `TermOfOwnership`, `Bylaws`, `IdentityCard`, `Collateral`, `Regulation`, `Balance`, `BalanceSheet`, `PLDFT`, `IncomeTax`, `DRE`, `Receipt`, `CompanyCard`, `AssignmetReport`, `NationalRegistryOfForeigners`, `NationalIdentityCard`, `RegionalRegistrationCard`, `Passaport`, `Paycheck`, `Indorsement` | `"Document"` |
| `displayName` | `string` | opcional | — | — | `"Fulano de Tal"` |

Exemplo:

```json
{
  "bankAccountTransactionLimitsIds": [
    "texto"
  ],
  "status": "Pending",
  "uploads": [
    {
      "id": "texto",
      "fileName": "Fulano de Tal",
      "fileType": "Document",
      "displayName": "Fulano de Tal"
    }
  ],
  "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
    }
  },
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}
```

**Códigos de retorno**

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

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/BankAccount/Limits/ApproveOrRejectByBatch" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "bankAccountTransactionLimitsIds": [
    "texto"
  ],
  "status": "Pending",
  "uploads": [
    {
      "id": "texto",
      "fileName": "Fulano de Tal",
      "fileType": "Document",
      "displayName": "Fulano de Tal"
    }
  ],
  "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
    }
  },
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}'
```

---

## Operadores

Operadores autorizados a movimentar a conta.

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

**Obter uma lista de operadores de contas** — 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` |
| `searchString` | query | `string` | opcional | — | `valor` |
| `f_userUserId` | query | `string` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `f_level` | query | `objeto` | opcional | — | `valor` |
| `f_status` | query | `objeto` | opcional | — | `valor` |
| `isDeleted` | query | `boolean` | opcional | — | `true` |
| `orderBy` | query | `string` | opcional | — | `valor` |

**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 | `{ … }` |
| `user` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `userId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `level` | `string` | opcional | — | — | `"texto"` |
| `levelDisplay` | `string` | opcional | — | — | `"texto"` |
| `status` | `string` | opcional | — | — | `"texto"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `isDeleted` | `boolean` | opcional | — | — | `true` |
| `authorizedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `bankAccountId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `accountNumber` | `integer (int64)` | opcional | — | — | `0` |
| `ownerNameAccount` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `ownerAccountType` | `string` | opcional | — | — | `"texto"` |
| `bankAccountRequestId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `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
{
  "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"
      },
      "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": [
        {}
      ]
    }
  ],
  "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/3fa85f64-5717-4562-b3fc-2c963f66afa6/Operator" \
  -H "Authorization: Bearer {{token}}"
```

---

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

**Adicionar um operador a uma conta** — 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 |
|---|---|---|---|---|---|
| `userId` | `string` | obrigatório | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |
| `level` | `string` | obrigatório | — | `Viewer`, `JointApprover`, `MasterApprover`, `Requester` | `"Viewer"` |

Exemplo:

```json
{
  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tenantName": "Fulano de Tal",
  "level": "Viewer"
}
```

**Resposta 200**

Campos:

| 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 | `{ … }` |
| `user` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `userId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `level` | `string` | opcional | — | — | `"texto"` |
| `levelDisplay` | `string` | opcional | — | — | `"texto"` |
| `status` | `string` | opcional | — | — | `"texto"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `isDeleted` | `boolean` | opcional | — | — | `true` |
| `authorizedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `bankAccountId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `accountNumber` | `integer (int64)` | opcional | — | — | `0` |
| `ownerNameAccount` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `ownerAccountType` | `string` | opcional | — | — | `"texto"` |
| `bankAccountRequestId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `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",
  "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": "Viewer",
      "action": "Approve",
      "actionDisplay": "texto",
      "user": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      }
    }
  ]
}
```

**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/Operator" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "tenantName": "Fulano de Tal",
  "level": "Viewer"
}'
```

---

### GET /v1/BankAccount/PendingOperators

**Obter uma lista de todos os operadores das contas digitais** — Lista e filtra registros de Bank Account.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `userId` | query | `string` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `tenant` | query | `string` | opcional | — | `uy3` |
| `accountNumber` | query | `integer (int64)` | opcional | — | `10` |
| `typeAccount` | query | `string` | opcional | — | `valor` |
| `f_level` | query | `objeto` | opcional | — | `Approvers` |
| `page` | query | `integer` | opcional | — | `10` |
| `size` | query | `integer` | opcional | — | `10` |
| `isDeleted` | query | `boolean` | opcional | — | `true` |
| `orderBy` | query | `string` | opcional | — | `valor` |

**Resposta 200**

Campos:

| 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 | `{ … }` |
| `status` | `string` | opcional | — | `Pending`, `Rejected`, `Approved` | `"Pending"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `uploads` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |
| `pixLimit` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `bankSlipLimit` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `transferLimit` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `tedLimit` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `updateStatusUser` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `bankAccount` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `bankAccountId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `existPendingLimitsApproval` | `boolean` | opcional | — | — | `true` |

Detalhe de `uploads`:

| 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 | `{ … }` |
| `fileName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `fileType` | `string` | opcional | — | — | `"texto"` |
| `displayName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `tempUrl` | `string` | opcional | — | — | `"https://exemplo.com.br/callback"` |
| `tempGetUrl` | `string` | opcional | — | — | `"https://exemplo.com.br/callback"` |
| `tempPutUrl` | `string` | opcional | — | — | `"https://exemplo.com.br/callback"` |

Exemplo:

```json
{
  "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"
  },
  "status": "Pending",
  "statusDisplay": "texto",
  "uploads": [
    {
      "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"
      },
      "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"
    }
  ],
  "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
    }
  },
  "updateStatusUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "registrationNumber": "12345678909",
    "userIdDisplay": "texto",
    "tenantDisplay": "texto",
    "tenantName": "Fulano de Tal"
  },
  "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": {
        "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"
      },
      "registrationNumber": "12345678909",
      "name": "Fulano de Tal"
    },
    "balance": {
      "currentBalance": 0,
      "blockedBalance": 0,
      "available": 0,
      "bankAccount": {
        "bankCode": 0,
        "bankIspb": 0,
        "bankCodeDisplay": "texto",
        "type": {},
        "typeDisplay": "texto",
        "modality": {},
        "modalityDisplay": "texto",
        "account": 0,
        "agency": 0,
        "personRegistrationNumber": "texto",
        "personName": "Fulano de Tal",
        "isDeleted": true,
        "status": {},
        "creditors": []
      }
    },
    "creditors": [
      {
        "id": "texto",
        "name": "Fulano de Tal",
        "tenant": "texto"
      }
    ]
  },
  "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "existPendingLimitsApproval": true
}
```

**Códigos de retorno**

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

**cURL**

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

---

### POST /v1/BankAccount/BatchOperatorsToAccounts

**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 |
|---|---|---|---|---|---|
| `usersIds` | `array de string` | obrigatório | — | — | `[ … ]` |
| `accountsIds` | `array de string` | obrigatório | — | — | `[ … ]` |
| `tenantName` | `string` | obrigatório | — | — | `"Fulano de Tal"` |
| `level` | `string` | obrigatório | — | `Viewer`, `JointApprover`, `MasterApprover`, `Requester` | `"Viewer"` |

Exemplo:

```json
{
  "usersIds": [
    "texto"
  ],
  "accountsIds": [
    "texto"
  ],
  "tenantName": "Fulano de Tal",
  "level": "Viewer"
}
```

**Resposta 200**

Campos:

| 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 | `{ … }` |
| `user` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `userId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `level` | `string` | opcional | — | — | `"texto"` |
| `levelDisplay` | `string` | opcional | — | — | `"texto"` |
| `status` | `string` | opcional | — | — | `"texto"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `isDeleted` | `boolean` | opcional | — | — | `true` |
| `authorizedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `bankAccountId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `accountNumber` | `integer (int64)` | opcional | — | — | `0` |
| `ownerNameAccount` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `ownerAccountType` | `string` | opcional | — | — | `"texto"` |
| `bankAccountRequestId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `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",
    "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": "Viewer",
        "action": "Approve",
        "actionDisplay": "texto",
        "user": {
          "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "registrationNumber": "12345678909",
          "userIdDisplay": "texto",
          "tenantDisplay": "texto",
          "tenantName": "Fulano de Tal"
        }
      }
    ]
  }
]
```

**Códigos de retorno**

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

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/BankAccount/BatchOperatorsToAccounts" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "usersIds": [
    "texto"
  ],
  "accountsIds": [
    "texto"
  ],
  "tenantName": "Fulano de Tal",
  "level": "Viewer"
}'
```

---

### PUT /v1/BankAccount/{operatorId}/adminApproveOperator

**Administrador aprova operador** — Atualiza por completo um registro de Bank Account existente.

**Parâmetros**

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

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

Campos:

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

Exemplo:

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

**Códigos de retorno**

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

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/adminApproveOperator" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "Approve",
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}'
```

---

### PUT /v1/BankAccount/adminApproveOperatorsByBatch

**Administrador aprova operadores** — Atualiza por completo um registro de Bank Account existente.

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `operatorIds` | `array de string` | obrigatório | — | — | `[ … ]` |
| `action` | `string` | obrigatório | — | `Approve`, `Reject`, `Cancel` | `"Approve"` |
| `sessionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `code` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "operatorIds": [
    "texto"
  ],
  "action": "Approve",
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}
```

**Códigos de retorno**

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

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/BankAccount/adminApproveOperatorsByBatch" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "operatorIds": [
    "texto"
  ],
  "action": "Approve",
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}'
```

---

### PUT /v1/BankAccount/{id}/Operator/{operatorId}/approve

**Aprovar/reprovar a inclusão de novo Operador** — Atualiza por completo um registro de Bank Account existente.

**Parâmetros**

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

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

Campos:

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

Exemplo:

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

**Códigos de retorno**

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

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Operator/3fa85f64-5717-4562-b3fc-2c963f66afa6/approve" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "Approve",
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}'
```

---

### PUT /v1/BankAccount/Operator/BatchApproval

**Aprovar/reprovar a inclusão de novos Operadores por lote** — Atualiza por completo um registro de Bank Account existente.

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `operatorIds` | `array de string` | obrigatório | — | — | `[ … ]` |
| `action` | `string` | obrigatório | — | `Approve`, `Reject`, `Cancel` | `"Approve"` |
| `sessionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `code` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "operatorIds": [
    "texto"
  ],
  "action": "Approve",
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}
```

**Códigos de retorno**

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

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/BankAccount/Operator/BatchApproval" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "operatorIds": [
    "texto"
  ],
  "action": "Approve",
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}'
```

---

### PUT /v1/BankAccount/{id}/Operator/{operatorId}

**Atualizar o nível de autorização de um operador em uma conta** — Atualiza por completo um registro de Bank Account existente.

**Parâmetros**

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

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `level` | `string` | obrigatório | — | `Viewer`, `JointApprover`, `MasterApprover`, `Requester` | `"Viewer"` |
| `status` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"Approved"` |

Exemplo:

```json
{
  "level": "Viewer",
  "status": "Approved"
}
```

**Códigos de retorno**

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

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Operator/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "level": "Viewer",
  "status": "Approved"
}'
```

---

### DELETE /v1/BankAccount/{id}/Operator/{operatorId}

**Remover um operador de uma conta** — 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` |
| `operatorId` | 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/3fa85f64-5717-4562-b3fc-2c963f66afa6/Operator/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"
```

---

### PUT /v1/BankAccount/{id}/Operator/{operatorId}/cancel

**Cancelar a inclusão de novo Operador** — Atualiza por completo um registro de Bank Account existente.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `operatorId` | 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 PUT "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Operator/3fa85f64-5717-4562-b3fc-2c963f66afa6/cancel" \
  -H "Authorization: Bearer {{token}}"
```

---

## Favorecidos

Favorecidos para pagamentos e transferências.

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

**Obter uma lista de favorecidos por 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` |
| `searchString` | query | `string` | opcional | — | `valor` |
| `f_name` | query | `string` | opcional | — | `valor` |
| `f_registrationNumber` | query | `string` | opcional | — | `valor` |
| `f_bank` | query | `integer` | opcional | — | `10` |
| `f_bankIspb` | query | `integer (int64)` | opcional | — | `10` |
| `f_agency` | query | `integer` | opcional | — | `10` |
| `f_accountNumber` | query | `string` | opcional | — | `valor` |
| `f_accountType` | query | `objeto` | opcional | — | `valor` |
| `f_operationTypeValue` | query | `objeto` | opcional | — | `valor` |
| `f_pixKeyTypeValue` | query | `objeto` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `f_status` | query | `objeto` | opcional | — | `valor` |
| `isDeleted` | query | `boolean` | opcional | — | `true` |
| `orderBy` | query | `string` | opcional | — | `valor` |

**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 | `{ … }` |
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `bank` | `integer` | opcional | — | — | `0` |
| `bankIspb` | `integer (int64)` | opcional | — | — | `0` |
| `bankDisplay` | `string` | opcional | — | — | `"texto"` |
| `agency` | `integer` | opcional | — | — | `0` |
| `accountNumber` | `string` | opcional | — | — | `"texto"` |
| `tenantName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `accountType` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"NaturalCheckingAccount"` |
| `accountTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `status` | `string` | opcional | — | `Approved`, `Pending`, `Rejected`, `Timeout`, `Canceled`, `Error`, `Processing`, `Finished`, `Scheduled`, `Reversed`, `ComplianceApproval`, `CancellationRequested` | `"Approved"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `operationTypeValue` | `string` | opcional | — | `Transfer`, `Pix` | `"Transfer"` |
| `operationTypeValueDisplay` | `string` | opcional | — | — | `"texto"` |
| `pixKeyTypeValue` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"NaturalRegistrationNumber"` |
| `pixKeyTypeValueDisplay` | `string` | opcional | — | — | `"texto"` |
| `keyPix` | `string` | opcional | — | — | `"texto"` |
| `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
{
  "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"
      },
      "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": [
        {}
      ]
    }
  ],
  "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/3fa85f64-5717-4562-b3fc-2c963f66afa6/Beneficiary" \
  -H "Authorization: Bearer {{token}}"
```

---

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

**Solicitar a inclusão de novo favorecido** — 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 |
|---|---|---|---|---|---|
| `name` | `string` | obrigatório | — | — | `"Fulano de Tal"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `bank` | `integer` | opcional | — | — | `0` |
| `bankIspb` | `integer (int64)` | opcional | — | — | `0` |
| `agency` | `integer` | opcional | — | — | `0` |
| `accountNumber` | `string` | opcional | — | — | `"texto"` |
| `accountType` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"NaturalCheckingAccount"` |
| `operationTypeValue` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |
| `pixKeyTypeValue` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"NaturalRegistrationNumber"` |
| `keyPix` | `string` | opcional | — | — | `"texto"` |

Exemplo:

```json
{
  "name": "Fulano de Tal",
  "registrationNumber": "12345678909",
  "bank": 0,
  "bankIspb": 0,
  "agency": 0,
  "accountNumber": "texto",
  "accountType": "NaturalCheckingAccount",
  "operationTypeValue": "Transfer",
  "pixKeyTypeValue": "NaturalRegistrationNumber",
  "keyPix": "texto"
}
```

**Resposta 201**

Campos:

| 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 | `{ … }` |
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `bank` | `integer` | opcional | — | — | `0` |
| `bankIspb` | `integer (int64)` | opcional | — | — | `0` |
| `bankDisplay` | `string` | opcional | — | — | `"texto"` |
| `agency` | `integer` | opcional | — | — | `0` |
| `accountNumber` | `string` | opcional | — | — | `"texto"` |
| `tenantName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `accountType` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"NaturalCheckingAccount"` |
| `accountTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `status` | `string` | opcional | — | `Approved`, `Pending`, `Rejected`, `Timeout`, `Canceled`, `Error`, `Processing`, `Finished`, `Scheduled`, `Reversed`, `ComplianceApproval`, `CancellationRequested` | `"Approved"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `operationTypeValue` | `string` | opcional | — | `Transfer`, `Pix` | `"Transfer"` |
| `operationTypeValueDisplay` | `string` | opcional | — | — | `"texto"` |
| `pixKeyTypeValue` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"NaturalRegistrationNumber"` |
| `pixKeyTypeValueDisplay` | `string` | opcional | — | — | `"texto"` |
| `keyPix` | `string` | opcional | — | — | `"texto"` |
| `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",
  "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": "Viewer",
      "action": "Approve",
      "actionDisplay": "texto",
      "user": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      }
    }
  ]
}
```

**Códigos de retorno**

| Código | Significado |
|---|---|
| `201` | Recurso criado com sucesso. |

**cURL**

```bash
curl -X POST "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Beneficiary" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Fulano de Tal",
  "registrationNumber": "12345678909",
  "bank": 0,
  "bankIspb": 0,
  "agency": 0,
  "accountNumber": "texto",
  "accountType": "NaturalCheckingAccount",
  "operationTypeValue": "Transfer",
  "pixKeyTypeValue": "NaturalRegistrationNumber",
  "keyPix": "texto"
}'
```

---

### PUT /v1/BankAccount/{id}/Beneficiary/{beneficiaryId}/approve

**Aprovar/reprovar a inclusão de novo favorecido** — Atualiza por completo um registro de Bank Account existente.

**Parâmetros**

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

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

Campos:

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

Exemplo:

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

**Códigos de retorno**

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

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Beneficiary/3fa85f64-5717-4562-b3fc-2c963f66afa6/approve" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "Approve",
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}'
```

---

### PUT /v1/BankAccount/Beneficiary/BatchApproval

**Aprovar/reprovar a inclusão de novos favorecidos por lote** — Atualiza por completo um registro de Bank Account existente.

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `beneficiaryBankAccounts` | `array de objeto` | obrigatório | — | objeto — ver detalhe abaixo | `[ … ]` |
| `action` | `string` | obrigatório | — | `Approve`, `Reject`, `Cancel` | `"Approve"` |
| `sessionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `code` | `string` | opcional | — | — | `"texto"` |

Detalhe de `beneficiaryBankAccounts`:

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

Exemplo:

```json
{
  "beneficiaryBankAccounts": [
    {
      "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "action": "Approve",
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}
```

**Códigos de retorno**

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

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/BankAccount/Beneficiary/BatchApproval" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "beneficiaryBankAccounts": [
    {
      "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "action": "Approve",
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}'
```

---

### PUT /v1/BankAccount/{beneficiaryId}/adminApproveBeneficiary

**Aprovar/reprovar a inclusão de novo favorecido** — Atualiza por completo um registro de Bank Account existente.

**Parâmetros**

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

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `beneficiaryBankAccounts` | `array de objeto` | obrigatório | — | objeto — ver detalhe abaixo | `[ … ]` |
| `action` | `string` | obrigatório | — | `Approve`, `Reject`, `Cancel` | `"Approve"` |
| `sessionId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `code` | `string` | opcional | — | — | `"texto"` |

Detalhe de `beneficiaryBankAccounts`:

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

Exemplo:

```json
{
  "beneficiaryBankAccounts": [
    {
      "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "action": "Approve",
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}
```

**Códigos de retorno**

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

**cURL**

```bash
curl -X PUT "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/adminApproveBeneficiary" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "beneficiaryBankAccounts": [
    {
      "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "action": "Approve",
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}'
```

---

### PUT /v1/BankAccount/{id}/Beneficiary/{beneficiaryId}/cancel

**Cancelar a inclusão de novo favorecido** — Atualiza por completo um registro de Bank Account existente.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `beneficiaryId` | 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 PUT "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Beneficiary/3fa85f64-5717-4562-b3fc-2c963f66afa6/cancel" \
  -H "Authorization: Bearer {{token}}"
```

---

### DELETE /v1/BankAccount/{id}/Beneficiary/{beneficiaryId}

**Remover um favorecido** — 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` |
| `beneficiaryId` | 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/3fa85f64-5717-4562-b3fc-2c963f66afa6/Beneficiary/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"
```

---

## 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"
}'
```

---