Obter o limite efetivo da conta

Lista e filtra registros 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

Este endpoint não recebe corpo.

Response

Resposta 200.

Campos

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	`{ … }`
`status`	`string`	opcional	—	`Pending`, `Rejected`, `Approved`	`"Pending"`
`statusDisplay`	`string`	opcional	—	—	`"texto"`
`uploads`	`array de objeto`	opcional	—	objeto — ver detalhe abaixo	`[ … ]`
`pixLimit`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`bankSlipLimit`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`transferLimit`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`tedLimit`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`updateStatusUser`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`bankAccount`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`bankAccountId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`existPendingLimitsApproval`	`boolean`	opcional	—	—	`true`

Detalhe de `uploads`

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	`{ … }`
`fileName`	`string`	opcional	—	—	`"Fulano de Tal"`
`fileType`	`string`	opcional	—	—	`"texto"`
`displayName`	`string`	opcional	—	—	`"Fulano de Tal"`
`tempUrl`	`string`	opcional	—	—	`"https://exemplo.com.br/callback"`
`tempGetUrl`	`string`	opcional	—	—	`"https://exemplo.com.br/callback"`
`tempPutUrl`	`string`	opcional	—	—	`"https://exemplo.com.br/callback"`

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"
  },
  "status": "Pending",
  "statusDisplay": "texto",
  "uploads": [
    {
      "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"
      },
      "fileName": "Fulano de Tal",
      "fileType": "texto",
      "displayName": "Fulano de Tal",
      "tempUrl": "https://exemplo.com.br/callback",
      "tempGetUrl": "https://exemplo.com.br/callback",
      "tempPutUrl": "https://exemplo.com.br/callback"
    }
  ],
  "pixLimit": {
    "businessHours": {
      "valueInCentsOwnOwnership": 0,
      "valueInCentsNaturalPerson": 0,
      "valueInCentsLegalPerson": 0
    },
    "nonBusinessHours": {
      "valueInCentsOwnOwnership": 0,
      "valueInCentsNaturalPerson": 0,
      "valueInCentsLegalPerson": 0
    }
  },
  "bankSlipLimit": {
    "businessHours": {
      "valueInCentsOwnOwnership": 0,
      "valueInCentsNaturalPerson": 0,
      "valueInCentsLegalPerson": 0
    },
    "nonBusinessHours": {
      "valueInCentsOwnOwnership": 0,
      "valueInCentsNaturalPerson": 0,
      "valueInCentsLegalPerson": 0
    }
  },
  "transferLimit": {
    "businessHours": {
      "valueInCentsOwnOwnership": 0,
      "valueInCentsNaturalPerson": 0,
      "valueInCentsLegalPerson": 0
    },
    "nonBusinessHours": {
      "valueInCentsOwnOwnership": 0,
      "valueInCentsNaturalPerson": 0,
      "valueInCentsLegalPerson": 0
    }
  },
  "tedLimit": {
    "businessHours": {
      "valueInCentsOwnOwnership": 0,
      "valueInCentsNaturalPerson": 0,
      "valueInCentsLegalPerson": 0
    },
    "nonBusinessHours": {
      "valueInCentsOwnOwnership": 0,
      "valueInCentsNaturalPerson": 0,
      "valueInCentsLegalPerson": 0
    }
  },
  "updateStatusUser": {
    "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "registrationNumber": "12345678909",
    "userIdDisplay": "texto",
    "tenantDisplay": "texto",
    "tenantName": "Fulano de Tal"
  },
  "bankAccount": {
    "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"
    },
    "bankCode": 0,
    "bankCodeDisplay": "texto",
    "bankIspb": 0,
    "account": "texto",
    "agency": "texto",
    "type": "PaymentAccount",
    "typeDisplay": "texto",
    "modality": "NaturalCheckingAccount",
    "modalityDisplay": "texto",
    "quorumMinimumApproval": 0,
    "externalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "tenantName": "Fulano de Tal",
    "isDeleted": true,
    "status": "Active",
    "statusDisplay": "texto",
    "person": {
      "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"
      },
      "registrationNumber": "12345678909",
      "name": "Fulano de Tal"
    },
    "balance": {
      "currentBalance": 0,
      "blockedBalance": 0,
      "available": 0,
      "bankAccount": {
        "bankCode": 0,
        "bankIspb": 0,
        "bankCodeDisplay": "texto",
        "type": {},
        "typeDisplay": "texto",
        "modality": {},
        "modalityDisplay": "texto",
        "account": 0,
        "agency": 0,
        "personRegistrationNumber": "texto",
        "personName": "Fulano de Tal",
        "isDeleted": true,
        "status": {},
        "creditors": []
      }
    },
    "creditors": [
      {
        "id": "texto",
        "name": "Fulano de Tal",
        "tenant": "texto"
      }
    ]
  },
  "bankAccountId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "existPendingLimitsApproval": true
}

Códigos de retorno

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

Exemplos

curl -X GET "{{baseUrl}}/v1/BankAccount/3fa85f64-5717-4562-b3fc-2c963f66afa6/Limits" \
  -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/3fa85f64-5717-4562-b3fc-2c963f66afa6/Limits";

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/3fa85f64-5717-4562-b3fc-2c963f66afa6/Limits`, {
  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