Inclui um lançamento em conta

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 — Conta débito

Request

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição	Exemplo
`id`	path	`string`	obrigatório	Conta débito	`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
`contraParte`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`accountEntryType`	`string`	opcional	—	`PixSent`, `PixReservalSent`, `PixRefundSent`, `PixReceived`, `PixRefundReceived`, `PixReversalRefundReceived`, `BlockBalance`, `EntryDebit`, `EntryCredit`, `DepositByBankSlip`, `BillingFee`, `PaymentBankSlip`, `TransferDebit`, `AdministrativeExpenses` +2	`"PixSent"`
`valueInCents`	`integer (int64)`	opcional	—	—	`0`
`complement`	`string`	opcional	—	—	`"texto"`
`commentsDoc`	`string`	opcional	—	—	`"texto"`
`isReceived`	`boolean`	opcional	—	—	`true`
`metadata`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`sessionId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`code`	`string`	opcional	—	—	`"texto"`

Exemplo de corpo

{
  "contraParte": {
    "accountNumber": "texto",
    "registrationNumber": "12345678909",
    "name": "Fulano de Tal",
    "bankCode": "texto",
    "agencyNumber": 0
  },
  "accountEntryType": "PixSent",
  "valueInCents": 0,
  "complement": "texto",
  "commentsDoc": "texto",
  "isReceived": true,
  "metadata": {
    "metadata": {}
  },
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
}

Response

Resposta 200.

Sem campos estruturados no contrato (tipo primitivo ou livre).

Exemplo de resposta

"texto"

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/Entry" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "contraParte": {
    "accountNumber": "texto",
    "registrationNumber": "12345678909",
    "name": "Fulano de Tal",
    "bankCode": "texto",
    "agencyNumber": 0
  },
  "accountEntryType": "PixSent",
  "valueInCents": 0,
  "complement": "texto",
  "commentsDoc": "texto",
  "isReceived": true,
  "metadata": {
    "metadata": {}
  },
  "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/Entry";

var corpo = new StringContent(
    """
    {
      "contraParte": {
        "accountNumber": "texto",
        "registrationNumber": "12345678909",
        "name": "Fulano de Tal",
        "bankCode": "texto",
        "agencyNumber": 0
      },
      "accountEntryType": "PixSent",
      "valueInCents": 0,
      "complement": "texto",
      "commentsDoc": "texto",
      "isReceived": true,
      "metadata": {
        "metadata": {}
      },
      "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "code": "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 = {
  "contraParte": {
    "accountNumber": "texto",
    "registrationNumber": "12345678909",
    "name": "Fulano de Tal",
    "bankCode": "texto",
    "agencyNumber": 0
  },
  "accountEntryType": "PixSent",
  "valueInCents": 0,
  "complement": "texto",
  "commentsDoc": "texto",
  "isReceived": true,
  "metadata": {
    "metadata": {}
  },
  "sessionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "code": "texto"
};

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

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