API Docs Início Documentação Referência de API Copiar para LLM
POST/v1/BankAccount/{id}/Beneficiary
Banking · Favorecidos

Solicitar a inclusão de novo favorecido

Cria um novo registro de Bank Account.

Visão geral

Solicitar a inclusão de novo favorecido

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):

Request

Parâmetros

NomeEmTipoObrigatórioDescriçãoExemplo
idpathstringobrigatório3fa85f64-5717-4562-b3fc-2c963f66afa6

Corpo da requisição

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

Campos

CampoTipoObrigatórioDescriçãoValoresExemplo
namestringobrigatório"Fulano de Tal"
registrationNumberstringopcional"12345678909"
bankintegeropcional0
bankIspbinteger (int64)opcional0
agencyintegeropcional0
accountNumberstringopcional"texto"
accountTypeobjetoopcionalvaria conforme o tipo — ver exemplo"NaturalCheckingAccount"
operationTypeValuestringobrigatórioTransfer, Pix"Transfer"
pixKeyTypeValueobjetoopcionalvaria conforme o tipo — ver exemplo"NaturalRegistrationNumber"
keyPixstringopcional"texto"

Exemplo de corpo

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

Response

Resposta 201.

Campos

CampoTipoObrigatórioDescriçãoValoresExemplo
idstringopcional"texto"
createdAtstring (date-time)opcional"2025-08-11T13:45:00Z"
createdByobjetoopcionalvaria conforme o tipo — ver exemplo{ … }
tenantstringopcional"texto"
tenantDisplaystringopcional"texto"
updatedAtstring (date-time)opcional"2025-08-11T13:45:00Z"
updatedByobjetoopcionalvaria conforme o tipo — ver exemplo{ … }
ownerUserobjetoopcionalvaria conforme o tipo — ver exemplo{ … }
ownerGroupobjetoopcionalvaria conforme o tipo — ver exemplo{ … }
namestringopcional"Fulano de Tal"
registrationNumberstringopcional"12345678909"
bankintegeropcional0
bankIspbinteger (int64)opcional0
bankDisplaystringopcional"texto"
agencyintegeropcional0
accountNumberstringopcional"texto"
tenantNamestringopcional"Fulano de Tal"
accountTypeobjetoopcionalvaria conforme o tipo — ver exemplo"NaturalCheckingAccount"
accountTypeDisplaystringopcional"texto"
statusstringopcionalApproved, Pending, Rejected, Timeout, Canceled, Error, Processing, Finished, Scheduled, Reversed, ComplianceApproval, CancellationRequested"Approved"
statusDisplaystringopcional"texto"
operationTypeValuestringopcionalTransfer, Pix"Transfer"
operationTypeValueDisplaystringopcional"texto"
pixKeyTypeValueobjetoopcionalvaria conforme o tipo — ver exemplo"NaturalRegistrationNumber"
pixKeyTypeValueDisplaystringopcional"texto"
keyPixstringopcional"texto"
authorizedAtstring (date-time)opcional"2025-08-11T13:45:00Z"
bankAccountIdstringopcional"3fa85f64-5717-4562-b3fc-2c963f66afa6"
requesterobjetoopcionalvaria conforme o tipo — ver exemplo{ … }
approvalsarray de objetoopcionalobjeto — ver detalhe abaixo[ … ]

Detalhe de approvals

CampoTipoObrigatórioDescriçãoValoresExemplo
levelobjetoopcionalvaria conforme o tipo — ver exemplo"Viewer"
actionstringopcionalApprove, Reject, Cancel"Approve"
actionDisplaystringopcional"texto"
userobjetoopcionalvaria conforme o tipo — ver exemplo{ … }

Exemplo de resposta

{
  "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ódigoSignificadoDetalhe do contrato
201Recurso criado com sucesso.

Exemplos

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"
}'
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/Beneficiary";

var corpo = new StringContent(
    """
    {
      "name": "Fulano de Tal",
      "registrationNumber": "12345678909",
      "bank": 0,
      "bankIspb": 0,
      "agency": 0,
      "accountNumber": "texto",
      "accountType": "NaturalCheckingAccount",
      "operationTypeValue": "Transfer",
      "pixKeyTypeValue": "NaturalRegistrationNumber",
      "keyPix": "texto"
    }
    """,
    Encoding.UTF8, "application/json");

var resp = await http.PostAsync(rota, corpo);
resp.EnsureSuccessStatusCode();
var json = await resp.Content.ReadAsStringAsync();
const baseUrl = '{{baseUrl}}';
const token   = '{{token}}';

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

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

if (!resp.ok) throw new Error(`HTTP ${resp.status}`);
const data = await resp.json();

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.

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