Obter as tarifas pendentes por número de conta

Lista e filtra registros de Bank Account.

Visão geral

Obter as tarifas pendentes por número de conta.

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

bankAccountId — —

Request

Parâmetros

Nome	Em	Tipo	Obrigatório	Descrição	Exemplo
`bankAccountId`	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
`pendingFees`	`array de objeto`	opcional	—	objeto — ver detalhe abaixo	`[ … ]`
`hasItems`	`boolean`	opcional	—	—	`true`

Detalhe de `pendingFees`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`count`	`integer`	opcional	—	—	`0`
`serviceCode`	`integer`	opcional	—	—	`0`
`serviceName`	`string`	opcional	—	—	`"Fulano de Tal"`
`amountToCharge`	`integer (int64)`	opcional	—	—	`0`
`totalAmountToCharge`	`integer (int64)`	opcional	—	—	`0`

Exemplo de resposta

{
  "pendingFees": [
    {
      "count": 0,
      "serviceCode": 0,
      "serviceName": "Fulano de Tal",
      "amountToCharge": 0,
      "totalAmountToCharge": 0
    }
  ],
  "hasItems": true
}

Códigos de retorno

Código	Significado	Detalhe do contrato
`200`	Requisição bem-sucedida.	Lista de tarifas pendentes por serviço/canal.
`400`	Requisição inválida (validação de campos ou regra de negócio).	—
`403`	Autenticado, mas sem permissão para o recurso.	—

Exemplos

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

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/PendingFees`, {
  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