# Banking — Favorecidos (UY3)

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

## Favorecidos

Favorecidos para pagamentos e transferências.

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

**Obter uma lista de favorecidos por conta bancária** — Lista e filtra registros de Bank Account.

**Parâmetros**

| Nome | Em | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|---|
| `id` | path | `string` | obrigatório | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `page` | query | `integer` | opcional | — | `10` |
| `size` | query | `integer` | opcional | — | `10` |
| `searchString` | query | `string` | opcional | — | `valor` |
| `f_name` | query | `string` | opcional | — | `valor` |
| `f_registrationNumber` | query | `string` | opcional | — | `valor` |
| `f_bank` | query | `integer` | opcional | — | `10` |
| `f_bankIspb` | query | `integer (int64)` | opcional | — | `10` |
| `f_agency` | query | `integer` | opcional | — | `10` |
| `f_accountNumber` | query | `string` | opcional | — | `valor` |
| `f_accountType` | query | `objeto` | opcional | — | `valor` |
| `f_operationTypeValue` | query | `objeto` | opcional | — | `valor` |
| `f_pixKeyTypeValue` | query | `objeto` | opcional | — | `3fa85f64-5717-4562-b3fc-2c963f66afa6` |
| `f_status` | query | `objeto` | opcional | — | `valor` |
| `isDeleted` | query | `boolean` | opcional | — | `true` |
| `orderBy` | query | `string` | opcional | — | `valor` |

**Resposta 200**

Campos:

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

Detalhe de `data`:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `createdAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `createdBy` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `tenant` | `string` | opcional | — | — | `"texto"` |
| `tenantDisplay` | `string` | opcional | — | — | `"texto"` |
| `updatedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `updatedBy` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `ownerUser` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `bank` | `integer` | opcional | — | — | `0` |
| `bankIspb` | `integer (int64)` | opcional | — | — | `0` |
| `bankDisplay` | `string` | opcional | — | — | `"texto"` |
| `agency` | `integer` | opcional | — | — | `0` |
| `accountNumber` | `string` | opcional | — | — | `"texto"` |
| `tenantName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `accountType` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"NaturalCheckingAccount"` |
| `accountTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `status` | `string` | opcional | — | `Approved`, `Pending`, `Rejected`, `Timeout`, `Canceled`, `Error`, `Processing`, `Finished`, `Scheduled`, `Reversed`, `ComplianceApproval`, `CancellationRequested` | `"Approved"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `operationTypeValue` | `string` | opcional | — | `Transfer`, `Pix` | `"Transfer"` |
| `operationTypeValueDisplay` | `string` | opcional | — | — | `"texto"` |
| `pixKeyTypeValue` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"NaturalRegistrationNumber"` |
| `pixKeyTypeValueDisplay` | `string` | opcional | — | — | `"texto"` |
| `keyPix` | `string` | opcional | — | — | `"texto"` |
| `authorizedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `bankAccountId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `requester` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `approvals` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `approvals`:

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

Exemplo:

```json
{
  "data": [
    {
      "id": "texto",
      "createdAt": "2025-08-11T13:45:00Z",
      "createdBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      },
      "tenant": "texto",
      "tenantDisplay": "texto",
      "updatedAt": "2025-08-11T13:45:00Z",
      "updatedBy": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      },
      "ownerGroup": {
        "groupDisplay": "texto",
        "tenantDisplay": "texto"
      },
      "name": "Fulano de Tal",
      "registrationNumber": "12345678909",
      "bank": 0,
      "bankIspb": 0,
      "bankDisplay": "texto",
      "agency": 0,
      "accountNumber": "texto",
      "tenantName": "Fulano de Tal",
      "accountType": "NaturalCheckingAccount",
      "accountTypeDisplay": "texto",
      "status": "Approved",
      "statusDisplay": "texto",
      "operationTypeValue": "Transfer",
      "operationTypeValueDisplay": "texto",
      "pixKeyTypeValue": "NaturalRegistrationNumber",
      "pixKeyTypeValueDisplay": "texto",
      "keyPix": "texto",
      "authorizedAt": "2025-08-11T13:45:00Z",
      "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "requester": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      },
      "approvals": [
        {}
      ]
    }
  ],
  "page": 0,
  "totalPages": 0,
  "totalItems": 0
}
```

**Códigos de retorno**

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

**cURL**

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

---

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

**Solicitar a inclusão de novo favorecido** — Cria um novo registro de Bank Account.

**Parâmetros**

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

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

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `name` | `string` | obrigatório | — | — | `"Fulano de Tal"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `bank` | `integer` | opcional | — | — | `0` |
| `bankIspb` | `integer (int64)` | opcional | — | — | `0` |
| `agency` | `integer` | opcional | — | — | `0` |
| `accountNumber` | `string` | opcional | — | — | `"texto"` |
| `accountType` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"NaturalCheckingAccount"` |
| `operationTypeValue` | `string` | obrigatório | — | `Transfer`, `Pix` | `"Transfer"` |
| `pixKeyTypeValue` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"NaturalRegistrationNumber"` |
| `keyPix` | `string` | opcional | — | — | `"texto"` |

Exemplo:

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

**Resposta 201**

Campos:

| Campo | Tipo | Obrigatório | Descrição | Valores | Exemplo |
|---|---|---|---|---|---|
| `id` | `string` | opcional | — | — | `"texto"` |
| `createdAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `createdBy` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `tenant` | `string` | opcional | — | — | `"texto"` |
| `tenantDisplay` | `string` | opcional | — | — | `"texto"` |
| `updatedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `updatedBy` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `ownerUser` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `ownerGroup` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `name` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `registrationNumber` | `string` | opcional | — | — | `"12345678909"` |
| `bank` | `integer` | opcional | — | — | `0` |
| `bankIspb` | `integer (int64)` | opcional | — | — | `0` |
| `bankDisplay` | `string` | opcional | — | — | `"texto"` |
| `agency` | `integer` | opcional | — | — | `0` |
| `accountNumber` | `string` | opcional | — | — | `"texto"` |
| `tenantName` | `string` | opcional | — | — | `"Fulano de Tal"` |
| `accountType` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"NaturalCheckingAccount"` |
| `accountTypeDisplay` | `string` | opcional | — | — | `"texto"` |
| `status` | `string` | opcional | — | `Approved`, `Pending`, `Rejected`, `Timeout`, `Canceled`, `Error`, `Processing`, `Finished`, `Scheduled`, `Reversed`, `ComplianceApproval`, `CancellationRequested` | `"Approved"` |
| `statusDisplay` | `string` | opcional | — | — | `"texto"` |
| `operationTypeValue` | `string` | opcional | — | `Transfer`, `Pix` | `"Transfer"` |
| `operationTypeValueDisplay` | `string` | opcional | — | — | `"texto"` |
| `pixKeyTypeValue` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `"NaturalRegistrationNumber"` |
| `pixKeyTypeValueDisplay` | `string` | opcional | — | — | `"texto"` |
| `keyPix` | `string` | opcional | — | — | `"texto"` |
| `authorizedAt` | `string (date-time)` | opcional | — | — | `"2025-08-11T13:45:00Z"` |
| `bankAccountId` | `string` | opcional | — | — | `"3fa85f64-5717-4562-b3fc-2c963f66afa6"` |
| `requester` | `objeto` | opcional | — | varia conforme o tipo — ver exemplo | `{ … }` |
| `approvals` | `array de objeto` | opcional | — | objeto — ver detalhe abaixo | `[ … ]` |

Detalhe de `approvals`:

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

Exemplo:

```json
{
  "id": "texto",
  "createdAt": "2025-08-11T13:45:00Z",
  "createdBy": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "registrationNumber": "12345678909",
    "userIdDisplay": "texto",
    "tenantDisplay": "texto",
    "tenantName": "Fulano de Tal"
  },
  "tenant": "texto",
  "tenantDisplay": "texto",
  "updatedAt": "2025-08-11T13:45:00Z",
  "updatedBy": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "registrationNumber": "12345678909",
    "userIdDisplay": "texto",
    "tenantDisplay": "texto",
    "tenantName": "Fulano de Tal"
  },
  "ownerUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "registrationNumber": "12345678909",
    "userIdDisplay": "texto",
    "tenantDisplay": "texto",
    "tenantName": "Fulano de Tal"
  },
  "ownerGroup": {
    "groupDisplay": "texto",
    "tenantDisplay": "texto"
  },
  "name": "Fulano de Tal",
  "registrationNumber": "12345678909",
  "bank": 0,
  "bankIspb": 0,
  "bankDisplay": "texto",
  "agency": 0,
  "accountNumber": "texto",
  "tenantName": "Fulano de Tal",
  "accountType": "NaturalCheckingAccount",
  "accountTypeDisplay": "texto",
  "status": "Approved",
  "statusDisplay": "texto",
  "operationTypeValue": "Transfer",
  "operationTypeValueDisplay": "texto",
  "pixKeyTypeValue": "NaturalRegistrationNumber",
  "pixKeyTypeValueDisplay": "texto",
  "keyPix": "texto",
  "authorizedAt": "2025-08-11T13:45:00Z",
  "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "requester": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "registrationNumber": "12345678909",
    "userIdDisplay": "texto",
    "tenantDisplay": "texto",
    "tenantName": "Fulano de Tal"
  },
  "approvals": [
    {
      "level": "Viewer",
      "action": "Approve",
      "actionDisplay": "texto",
      "user": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "registrationNumber": "12345678909",
        "userIdDisplay": "texto",
        "tenantDisplay": "texto",
        "tenantName": "Fulano de Tal"
      }
    }
  ]
}
```

**Códigos de retorno**

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

**cURL**

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

---

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

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

**Parâmetros**

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

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

Campos:

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

Exemplo:

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

**Códigos de retorno**

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

**cURL**

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

---

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

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

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

Campos:

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

Detalhe de `beneficiaryBankAccounts`:

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

Exemplo:

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

**Códigos de retorno**

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

**cURL**

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

---

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

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

**Parâmetros**

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

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

Campos:

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

Detalhe de `beneficiaryBankAccounts`:

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

Exemplo:

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

**Códigos de retorno**

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

**cURL**

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

---

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

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

**Parâmetros**

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

**Códigos de retorno**

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

**cURL**

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

---

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

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

**Parâmetros**

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

**Códigos de retorno**

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

**cURL**

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

---