GET/v1/BankAccount/AutomaticSplit/Operation/{operationId}

Banking · Conta digital

Consultar Bank Account

Consulta Bank Account pelo identificador informado na rota.

Visão geral

Consulta Bank Account pelo identificador informado na rota.

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

operationId — —

Request

Parâmetros

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

Corpo da requisição

Este endpoint não recebe corpo.

Response

Resposta 200.

Campos

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`id`	`string`	opcional	—	—	`"texto"`
`code`	`string`	opcional	—	—	`"texto"`
`escrowBankAccountId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`borrowerBeneficiaryId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`principalAmount`	`integer (int64)`	opcional	—	—	`0`
`installmentsCount`	`integer`	opcional	—	—	`0`
`dueDateType`	`integer`	opcional	—	—	`0`
`installmentType`	`integer`	opcional	—	—	`0`
`firstDueDate`	`string (date)`	opcional	—	—	`"2025-08-11"`
`guaranteePercentOverPMT`	`number (decimal)`	opcional	—	—	`1.99`
`interestPercent`	`number (decimal)`	opcional	—	—	`1.99`
`finePercent`	`number (decimal)`	opcional	—	—	`1.99`
`acceptPartialInstallment`	`boolean`	opcional	—	—	`true`
`borrowerTransferAuthorized`	`boolean`	opcional	—	—	`true`
`borrowerTransferSameDay`	`boolean`	opcional	—	—	`true`
`borrowerTransferDayOfMonth`	`integer`	opcional	—	—	`0`
`timezone`	`string`	opcional	—	—	`"texto"`
`status`	`integer`	opcional	—	—	`0`
`createdAt`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`borrower`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`creditors`	`array de objeto`	opcional	—	objeto — ver detalhe abaixo	`[ … ]`
`installments`	`array de objeto`	opcional	—	objeto — ver detalhe abaixo	`[ … ]`
`escrow`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`

Detalhe de `borrower`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`name`	`string`	opcional	—	—	`"Fulano de Tal"`
`taxId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`ispb`	`integer (int64)`	opcional	—	—	`0`
`agency`	`string`	opcional	—	—	`"texto"`
`account`	`string`	opcional	—	—	`"texto"`
`pixKey`	`string`	opcional	—	—	`"texto"`
`pixKeyTypeValueDisplay`	`string`	opcional	—	—	`"texto"`
`transferAuthorized`	`boolean`	opcional	—	—	`true`
`payoutRail`	`string`	opcional	—	`PIX`, `TED`	`"PIX"`
`bankName`	`string`	opcional	—	—	`"Fulano de Tal"`
`bankCode`	`integer`	opcional	—	—	`0`
`beneficiaryIdPIX`	`string`	opcional	—	—	`"texto"`
`beneficiaryIdTED`	`string`	opcional	—	—	`"texto"`

Detalhe de `creditors`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`id`	`string`	opcional	—	—	`"texto"`
`name`	`string`	opcional	—	—	`"Fulano de Tal"`
`taxId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`proportion`	`number (decimal)`	opcional	—	—	`1000`
`order`	`integer`	opcional	—	—	`0`
`active`	`boolean`	opcional	—	—	`true`
`ispb`	`integer (int64)`	opcional	—	—	`0`
`agency`	`string`	opcional	—	—	`"texto"`
`account`	`string`	opcional	—	—	`"texto"`
`pixKey`	`string`	opcional	—	—	`"texto"`
`pixKeyTypeValueDisplay`	`string`	opcional	—	—	`"texto"`
`payoutRail`	`string`	opcional	—	`PIX`, `TED`	`"PIX"`
`bankCode`	`integer`	opcional	—	—	`0`
`bankName`	`string`	opcional	—	—	`"Fulano de Tal"`
`beneficiaryIdPIX`	`string`	opcional	—	—	`"texto"`
`beneficiaryIdTED`	`string`	opcional	—	—	`"texto"`

Detalhe de `installments`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`id`	`string`	opcional	—	—	`"texto"`
`number`	`integer`	opcional	—	—	`0`
`dueDate`	`string (date)`	opcional	—	—	`"2025-08-11"`
`amount`	`integer (int64)`	opcional	—	—	`0`
`paidAmount`	`integer (int64)`	opcional	—	—	`1`
`status`	`integer`	opcional	—	—	`0`
`interestAccrued`	`integer (int64)`	opcional	—	—	`0`
`fineAccrued`	`integer (int64)`	opcional	—	—	`0`
`paymentDate`	`string (date)`	opcional	—	—	`"2025-08-11"`
`bankAccountTransfers`	`array de objeto`	opcional	—	objeto — ver detalhe abaixo	`[ … ]`

Detalhe de `bankAccountTransfers`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`id`	`string`	opcional	—	—	`"texto"`
`createdAt`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`createdBy`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`tenant`	`string`	opcional	—	—	`"texto"`
`tenantDisplay`	`string`	opcional	—	—	`"texto"`
`updatedAt`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`updatedBy`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`ownerUser`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`ownerGroup`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`nsu`	`string`	opcional	—	—	`"texto"`
`amount`	`integer (int64)`	opcional	—	—	`0`
`transferDate`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`paymentPurpose`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`"PagamentoDeImpostosTributosETaxas"`
`paymentPurposeDisplay`	`string`	opcional	—	—	`"texto"`
`status`	`string`	opcional	—	`Approved`, `Pending`, `Rejected`, `Timeout`, `Canceled`, `Error`, `Processing`, `Finished`, `Scheduled`, `Reversed`, `ComplianceApproval`, `CancellationRequested`	`"Approved"`
`statusDisplay`	`string`	opcional	—	—	`"texto"`
`accountingEntry`	`string`	opcional	—	—	`"texto"`
`errorMessage`	`string`	opcional	—	—	`"texto"`
`reversalCodeReason`	`string`	opcional	—	—	`"texto"`
`reversalDescriptionReason`	`string`	opcional	—	—	`"texto"`
`bankAccountBeneficiaryId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`bankAccountBeneficiary`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`authorizedAt`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`bankAccountId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`requester`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`approvals`	`array de objeto`	opcional	—	objeto — ver detalhe abaixo	`[ … ]`

Detalhe de `approvals`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`level`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`"Viewer"`
`action`	`string`	opcional	—	`Approve`, `Reject`, `Cancel`	`"Approve"`
`actionDisplay`	`string`	opcional	—	—	`"texto"`
`user`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`

Exemplo de resposta

{
  "id": "texto",
  "code": "texto",
  "escrowBankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "borrowerBeneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "principalAmount": 0,
  "installmentsCount": 0,
  "dueDateType": 0,
  "installmentType": 0,
  "firstDueDate": "2025-08-11",
  "guaranteePercentOverPMT": 1.99,
  "interestPercent": 1.99,
  "finePercent": 1.99,
  "acceptPartialInstallment": true,
  "borrowerTransferAuthorized": true,
  "borrowerTransferSameDay": true,
  "borrowerTransferDayOfMonth": 0,
  "timezone": "texto",
  "status": 0,
  "createdAt": "2025-08-11T13:45:00Z",
  "borrower": {
    "name": "Fulano de Tal",
    "taxId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "ispb": 0,
    "agency": "texto",
    "account": "texto",
    "pixKey": "texto",
    "pixKeyTypeValueDisplay": "texto",
    "transferAuthorized": true,
    "payoutRail": "PIX",
    "bankName": "Fulano de Tal",
    "bankCode": 0,
    "beneficiaryIdPIX": "texto",
    "beneficiaryIdTED": "texto"
  },
  "creditors": [
    {
      "id": "texto",
      "name": "Fulano de Tal",
      "taxId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "proportion": 1000,
      "order": 0,
      "active": true,
      "ispb": 0,
      "agency": "texto",
      "account": "texto",
      "pixKey": "texto",
      "pixKeyTypeValueDisplay": "texto",
      "payoutRail": "PIX",
      "bankCode": 0,
      "bankName": "Fulano de Tal",
      "beneficiaryIdPIX": "texto",
      "beneficiaryIdTED": "texto"
    }
  ],
  "installments": [
    {
      "id": "texto",
      "number": 0,
      "dueDate": "2025-08-11",
      "amount": 0,
      "paidAmount": 1,
      "status": 0,
      "interestAccrued": 0,
      "fineAccrued": 0,
      "paymentDate": "2025-08-11",
      "bankAccountTransfers": [
        {}
      ]
    }
  ],
  "escrow": {
    "bankCode": 0,
    "agency": 0,
    "accountNumber": 0,
    "bankName": "Fulano de Tal",
    "ispb": 0
  }
}

Códigos de retorno

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

Exemplos

curl -X GET "{{baseUrl}}/v1/BankAccount/AutomaticSplit/Operation/3fa85f64-5717-4562-b3fc-2c963f66afa6" \
  -H "Authorization: Bearer {{token}}"

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/3fa85f64-5717-4562-b3fc-2c963f66afa6";

var resp = await http.GetAsync(rota);
resp.EnsureSuccessStatusCode();
var json = await resp.Content.ReadAsStringAsync();

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

const resp = await fetch(`${baseUrl}/v1/BankAccount/AutomaticSplit/Operation/3fa85f64-5717-4562-b3fc-2c963f66afa6`, {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

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