Incluir credor na conta bancária

Cria um novo registro de Bank Account.

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

id — —

Request

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição	Exemplo
`id`	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
`personId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`naturalPerson`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`legalPerson`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`

Exemplo de corpo

{
  "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "naturalPerson": {
    "id": "texto",
    "referenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Fulano de Tal",
    "discriminator": "texto",
    "registrationNumber": "12345678909",
    "address": {
      "addressName": "Fulano de Tal",
      "zipCode": "01310930",
      "city": "texto",
      "uf": "NaoSelecionado",
      "district": "texto",
      "number": "texto",
      "complement": "texto"
    },
    "email": "cliente@exemplo.com.br",
    "phone": "11987654321",
    "economicActivityCode": "texto",
    "pep": true,
    "birthDate": "2025-08-11T13:45:00Z",
    "civilStatus": "Married",
    "gender": "NotInformed",
    "documentType": "RG",
    "documentNumber": "texto",
    "documentIssuer": "texto",
    "documentDate": "2025-08-11T13:45:00Z",
    "netSalary": 1000,
    "otherIncome": 1000,
    "mothersName": "Fulano de Tal",
    "fathersName": "Fulano de Tal",
    "placeOfBirthCountry": "texto",
    "occupation": "texto",
    "natureOfOccupation": "PrivateEmployee",
    "spouseName": "Fulano de Tal"
  },
  "legalPerson": {
    "id": "texto",
    "referenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Fulano de Tal",
    "discriminator": "texto",
    "registrationNumber": "12345678909",
    "address": {
      "addressName": "Fulano de Tal",
      "zipCode": "01310930",
      "city": "texto",
      "uf": "NaoSelecionado",
      "district": "texto",
      "number": "texto",
      "complement": "texto"
    },
    "email": "cliente@exemplo.com.br",
    "phone": "11987654321",
    "economicActivityCode": "texto",
    "companyName": "Fulano de Tal",
    "typeOfActivity": "Industry",
    "openDate": "2025-08-11T13:45:00Z",
    "averageMonthlyRevenue": 1000,
    "initialShareCapital": 1000,
    "numberOfEmployees": 0
  }
}

Response

Resposta 200 sem corpo (—).

Códigos de retorno

Código	Significado	Detalhe do contrato
`200`	Requisição bem-sucedida.	—

Exemplos

curl -X POST "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Creditor" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "naturalPerson": {
    "id": "texto",
    "referenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Fulano de Tal",
    "discriminator": "texto",
    "registrationNumber": "12345678909",
    "address": {
      "addressName": "Fulano de Tal",
      "zipCode": "01310930",
      "city": "texto",
      "uf": "NaoSelecionado",
      "district": "texto",
      "number": "texto",
      "complement": "texto"
    },
    "email": "cliente@exemplo.com.br",
    "phone": "11987654321",
    "economicActivityCode": "texto",
    "pep": true,
    "birthDate": "2025-08-11T13:45:00Z",
    "civilStatus": "Married",
    "gender": "NotInformed",
    "documentType": "RG",
    "documentNumber": "texto",
    "documentIssuer": "texto",
    "documentDate": "2025-08-11T13:45:00Z",
    "netSalary": 1000,
    "otherIncome": 1000,
    "mothersName": "Fulano de Tal",
    "fathersName": "Fulano de Tal",
    "placeOfBirthCountry": "texto",
    "occupation": "texto",
    "natureOfOccupation": "PrivateEmployee",
    "spouseName": "Fulano de Tal"
  },
  "legalPerson": {
    "id": "texto",
    "referenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Fulano de Tal",
    "discriminator": "texto",
    "registrationNumber": "12345678909",
    "address": {
      "addressName": "Fulano de Tal",
      "zipCode": "01310930",
      "city": "texto",
      "uf": "NaoSelecionado",
      "district": "texto",
      "number": "texto",
      "complement": "texto"
    },
    "email": "cliente@exemplo.com.br",
    "phone": "11987654321",
    "economicActivityCode": "texto",
    "companyName": "Fulano de Tal",
    "typeOfActivity": "Industry",
    "openDate": "2025-08-11T13:45:00Z",
    "averageMonthlyRevenue": 1000,
    "initialShareCapital": 1000,
    "numberOfEmployees": 0
  }
}'

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/Creditor";

var corpo = new StringContent(
    """
    {
      "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "naturalPerson": {
        "id": "texto",
        "referenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "Fulano de Tal",
        "discriminator": "texto",
        "registrationNumber": "12345678909",
        "address": {
          "addressName": "Fulano de Tal",
          "zipCode": "01310930",
          "city": "texto",
          "uf": "NaoSelecionado",
          "district": "texto",
          "number": "texto",
          "complement": "texto"
        },
        "email": "cliente@exemplo.com.br",
        "phone": "11987654321",
        "economicActivityCode": "texto",
        "pep": true,
        "birthDate": "2025-08-11T13:45:00Z",
        "civilStatus": "Married",
        "gender": "NotInformed",
        "documentType": "RG",
        "documentNumber": "texto",
        "documentIssuer": "texto",
        "documentDate": "2025-08-11T13:45:00Z",
        "netSalary": 1000,
        "otherIncome": 1000,
        "mothersName": "Fulano de Tal",
        "fathersName": "Fulano de Tal",
        "placeOfBirthCountry": "texto",
        "occupation": "texto",
        "natureOfOccupation": "PrivateEmployee",
        "spouseName": "Fulano de Tal"
      },
      "legalPerson": {
        "id": "texto",
        "referenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "name": "Fulano de Tal",
        "discriminator": "texto",
        "registrationNumber": "12345678909",
        "address": {
          "addressName": "Fulano de Tal",
          "zipCode": "01310930",
          "city": "texto",
          "uf": "NaoSelecionado",
          "district": "texto",
          "number": "texto",
          "complement": "texto"
        },
        "email": "cliente@exemplo.com.br",
        "phone": "11987654321",
        "economicActivityCode": "texto",
        "companyName": "Fulano de Tal",
        "typeOfActivity": "Industry",
        "openDate": "2025-08-11T13:45:00Z",
        "averageMonthlyRevenue": 1000,
        "initialShareCapital": 1000,
        "numberOfEmployees": 0
      }
    }
    """,
    Encoding.UTF8, "application/json");

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

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

const payload = {
  "personId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "naturalPerson": {
    "id": "texto",
    "referenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Fulano de Tal",
    "discriminator": "texto",
    "registrationNumber": "12345678909",
    "address": {
      "addressName": "Fulano de Tal",
      "zipCode": "01310930",
      "city": "texto",
      "uf": "NaoSelecionado",
      "district": "texto",
      "number": "texto",
      "complement": "texto"
    },
    "email": "cliente@exemplo.com.br",
    "phone": "11987654321",
    "economicActivityCode": "texto",
    "pep": true,
    "birthDate": "2025-08-11T13:45:00Z",
    "civilStatus": "Married",
    "gender": "NotInformed",
    "documentType": "RG",
    "documentNumber": "texto",
    "documentIssuer": "texto",
    "documentDate": "2025-08-11T13:45:00Z",
    "netSalary": 1000,
    "otherIncome": 1000,
    "mothersName": "Fulano de Tal",
    "fathersName": "Fulano de Tal",
    "placeOfBirthCountry": "texto",
    "occupation": "texto",
    "natureOfOccupation": "PrivateEmployee",
    "spouseName": "Fulano de Tal"
  },
  "legalPerson": {
    "id": "texto",
    "referenceId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "Fulano de Tal",
    "discriminator": "texto",
    "registrationNumber": "12345678909",
    "address": {
      "addressName": "Fulano de Tal",
      "zipCode": "01310930",
      "city": "texto",
      "uf": "NaoSelecionado",
      "district": "texto",
      "number": "texto",
      "complement": "texto"
    },
    "email": "cliente@exemplo.com.br",
    "phone": "11987654321",
    "economicActivityCode": "texto",
    "companyName": "Fulano de Tal",
    "typeOfActivity": "Industry",
    "openDate": "2025-08-11T13:45:00Z",
    "averageMonthlyRevenue": 1000,
    "initialShareCapital": 1000,
    "numberOfEmployees": 0
  }
};

const resp = await fetch(`${baseUrl}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Creditor`, {
  method: 'POST',
  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