Aprovar/reprovar a inclusão de novo favorecido

Atualiza por completo um registro de Bank Account existente.

Visão geral

Autenticação e pré-requisitos

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

Pré-requisitos: a rota exige identificador(es) de recurso já existente(s):

beneficiaryId — —

Request

Parâmetros

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

Corpo da requisição

Envie no formato application/json. Corpo obrigatório.

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 de corpo

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

Response

Resposta 204 sem corpo (—).

Códigos de retorno

Código	Significado	Detalhe do contrato
`204`	Sucesso sem corpo de resposta.	—

Exemplos

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

var baseUrl = "{{baseUrl}}";
var token   = "{{token}}";

using var http = new HttpClient { BaseAddress = new Uri(baseUrl) };
http.DefaultRequestHeaders.Authorization =
    new AuthenticationHeaderValue("Bearer", token);

var rota = "/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/adminApproveBeneficiary";

var corpo = new StringContent(
    """
    {
      "beneficiaryBankAccounts": [
        {
          "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
        }
      ],
      "action": "Approve",
      "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "code": "texto"
    }
    """,
    Encoding.UTF8, "application/json");

var resp = await http.PutAsync(rota, corpo);
resp.EnsureSuccessStatusCode();
// Sem corpo de resposta neste endpoint.

const baseUrl = '{{baseUrl}}';
const token   = '{{token}}';

const payload = {
  "beneficiaryBankAccounts": [
    {
      "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "action": "Approve",
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
};

const resp = await fetch(`${baseUrl}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/adminApproveBeneficiary`, {
  method: 'PUT',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(payload),
});

if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
// Sem corpo de resposta neste endpoint.

Troque apenas {{baseUrl}} e {{token}}. No Postman, defina-os como variáveis de environment; o cURL importa em Import > Raw text.

Downloads

Este endpoint já vem configurado nas collections abaixo, na pasta da etapa correspondente.

Collection completaConsignado privado e FGTS, em pastas espelhando a documentação.Baixar →Environment do PostmanAs variáveis fora da collection, para versionar uma sem versionar o token.Baixar →Documentação consolidada para LLMToda a documentação em um arquivo de texto, na ordem da navegação.Baixar →Referência em MarkdownEste contrato, campo a campo, gerado do spec.Baixar →

Guia de importação: Como importar no Postman · Todos os downloads: Downloads