API Docs Início Documentação Referência de API Copiar para LLM
POST/v1/BankAccount/AutomaticSplit/Operation
Banking · Conta digital

Criar Bank Account

Cria um novo registro de Bank Account.

Visão geral

Cria um novo registro de Bank Account.

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.

Request

Parâmetros

Nenhum parâmetro de rota, query ou header.

Corpo da requisição

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

Campos

CampoTipoObrigatórioDescriçãoValoresExemplo
escrowBankAccountIdstringopcional——"3fa85f64-5717-4562-b3fc-2c963f66afa6"
borrowerBeneficiaryIdstringopcional——"3fa85f64-5717-4562-b3fc-2c963f66afa6"
creditorsarray de objetoopcional—objeto — ver detalhe abaixo[ … ]
principalAmountinteger (int64)opcional——0
installmentsCountintegeropcional——0
dueDateTypestringopcional—Fixed, Dynamic"Fixed"
installmentTypestringopcional—Fixed, Dynamic"Fixed"
firstDueDatestring (date)opcional——"2025-08-11"
guaranteePercentOverPMTnumber (decimal)opcional——1.99
interestPercentnumber (decimal)opcional——1.99
finePercentnumber (decimal)opcional——1.99
borrowerTransferAuthorizedbooleanopcional——true
borrowerTransferSameDaybooleanopcional——true
borrowerTransferDayOfMonthintegeropcional——0
acceptPartialInstallmentbooleanopcional——true
activebooleanopcional——true
planOverridearray de objetoopcional—objeto — ver detalhe abaixo[ … ]

Detalhe de creditors

CampoTipoObrigatórioDescriçãoValoresExemplo
beneficiaryIdstringopcional——"3fa85f64-5717-4562-b3fc-2c963f66afa6"
proportionnumber (decimal)opcional——1000
activebooleanopcional——true

Detalhe de planOverride

CampoTipoObrigatórioDescriçãoValoresExemplo
numberintegeropcional——0
dueDatestring (date)opcional——"2025-08-11"
amountinteger (int64)opcional——0

Exemplo de corpo

{
  "escrowBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "borrowerBeneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "creditors": [
    {
      "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "proportion": 1000,
      "active": true
    }
  ],
  "principalAmount": 0,
  "installmentsCount": 0,
  "dueDateType": "Fixed",
  "installmentType": "Fixed",
  "firstDueDate": "2025-08-11",
  "guaranteePercentOverPMT": 1.99,
  "interestPercent": 1.99,
  "finePercent": 1.99,
  "borrowerTransferAuthorized": true,
  "borrowerTransferSameDay": true,
  "borrowerTransferDayOfMonth": 0,
  "acceptPartialInstallment": true,
  "active": true,
  "planOverride": [
    {
      "number": 0,
      "dueDate": "2025-08-11",
      "amount": 0
    }
  ]
}

Response

Resposta 200.

Campos

CampoTipoObrigatórioDescriçãoValoresExemplo
idstringopcional——"texto"
codestringopcional——"texto"
statusstringopcional—Active, Closed, Inactive, Cancelled"Active"
generatedPlanarray de objetoopcional—objeto — ver detalhe abaixo[ … ]

Detalhe de generatedPlan

CampoTipoObrigatórioDescriçãoValoresExemplo
numberintegeropcional——0
dueDatestring (date)opcional——"2025-08-11"
amountnumber (decimal)opcional——1000

Exemplo de resposta

{
  "id": "texto",
  "code": "texto",
  "status": "Active",
  "generatedPlan": [
    {
      "number": 0,
      "dueDate": "2025-08-11",
      "amount": 1000
    }
  ]
}

Códigos de retorno

CódigoSignificadoDetalhe do contrato
200Requisição bem-sucedida.—
400Requisição inválida (validação de campos ou regra de negócio).—

Exemplos

curl -X POST "{{baseUrl}}/v1/BankAccount/AutomaticSplit/Operation" \
  -H "Authorization: Bearer {{token}}" \
  -H "Content-Type: application/json" \
  -d '{
  "escrowBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "borrowerBeneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "creditors": [
    {
      "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "proportion": 1000,
      "active": true
    }
  ],
  "principalAmount": 0,
  "installmentsCount": 0,
  "dueDateType": "Fixed",
  "installmentType": "Fixed",
  "firstDueDate": "2025-08-11",
  "guaranteePercentOverPMT": 1.99,
  "interestPercent": 1.99,
  "finePercent": 1.99,
  "borrowerTransferAuthorized": true,
  "borrowerTransferSameDay": true,
  "borrowerTransferDayOfMonth": 0,
  "acceptPartialInstallment": true,
  "active": true,
  "planOverride": [
    {
      "number": 0,
      "dueDate": "2025-08-11",
      "amount": 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/AutomaticSplit/Operation";

var corpo = new StringContent(
    """
    {
      "escrowBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "borrowerBeneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "creditors": [
        {
          "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "proportion": 1000,
          "active": true
        }
      ],
      "principalAmount": 0,
      "installmentsCount": 0,
      "dueDateType": "Fixed",
      "installmentType": "Fixed",
      "firstDueDate": "2025-08-11",
      "guaranteePercentOverPMT": 1.99,
      "interestPercent": 1.99,
      "finePercent": 1.99,
      "borrowerTransferAuthorized": true,
      "borrowerTransferSameDay": true,
      "borrowerTransferDayOfMonth": 0,
      "acceptPartialInstallment": true,
      "active": true,
      "planOverride": [
        {
          "number": 0,
          "dueDate": "2025-08-11",
          "amount": 0
        }
      ]
    }
    """,
    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 = {
  "escrowBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "borrowerBeneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "creditors": [
    {
      "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "proportion": 1000,
      "active": true
    }
  ],
  "principalAmount": 0,
  "installmentsCount": 0,
  "dueDateType": "Fixed",
  "installmentType": "Fixed",
  "firstDueDate": "2025-08-11",
  "guaranteePercentOverPMT": 1.99,
  "interestPercent": 1.99,
  "finePercent": 1.99,
  "borrowerTransferAuthorized": true,
  "borrowerTransferSameDay": true,
  "borrowerTransferDayOfMonth": 0,
  "acceptPartialInstallment": true,
  "active": true,
  "planOverride": [
    {
      "number": 0,
      "dueDate": "2025-08-11",
      "amount": 0
    }
  ]
};

const resp = await fetch(`${baseUrl}/v1/BankAccount/AutomaticSplit/Operation`, {
  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