# Banking — PIX (UY3)

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

## Autenticação

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

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

---