GET/api/v1/Wallet

Cobrança · Carteiras

Método de visualização da lista de carteiras/convênios

Lista e filtra registros de api.

Visão geral

Método de visualização da lista de carteiras/convênios.

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

Nome	Em	Tipo	Obrigatório	Descrição	Exemplo
`BeneficiaryId`	query	`string`	opcional	—	`3fa85f64-5717-4562-b3fc-2c963f66afa6`
`WalletsCode`	query	`array de integer (int64)`	opcional	—	`valor`
`Name`	query	`string`	opcional	—	`valor`
`Tenant`	query	`string`	opcional	—	`uy3`
`BankAccount`	query	`string`	opcional	—	`valor`
`SearchString`	query	`string`	opcional	—	`valor`
`Alias`	query	`string`	opcional	—	`valor`
`Page`	query	`integer`	opcional	—	`10`
`Size`	query	`integer`	opcional	—	`10`

Corpo da requisição

Este endpoint não recebe corpo.

Response

Resposta 200.

Campos

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`data`	`array de objeto`	opcional	—	objeto — ver detalhe abaixo	`[ … ]`
`page`	`integer`	opcional	—	—	`0`
`totalPages`	`integer`	opcional	—	—	`0`
`totalItems`	`integer`	opcional	—	—	`0`
`isCountTruncated`	`boolean`	opcional	—	—	`true`

Detalhe de `data`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`id`	`string`	opcional	—	—	`"texto"`
`beneficiaryId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`beneficiaryName`	`string`	opcional	—	—	`"Fulano de Tal"`
`walletCode`	`integer (int64)`	opcional	—	—	`0`
`bankAgency`	`string`	opcional	—	—	`"texto"`
`bankAccount`	`string`	opcional	—	—	`"texto"`
`bankAccountDebtCosts`	`string`	opcional	—	—	`"texto"`
`bankSlipCosts`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`billingTypeValue`	`string`	opcional	—	—	`"texto"`
`billingTypeValueDisplay`	`string`	opcional	—	—	`"texto"`
`daysOverdueLimit`	`integer (int64)`	opcional	—	—	`0`
`interestCodeValue`	`string`	opcional	—	—	`"texto"`
`interestCodeValueDisplay`	`string`	opcional	—	—	`"texto"`
`notificationRecepients`	`array de string`	opcional	—	—	`[ … ]`
`createdAt`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`enabled`	`boolean`	opcional	—	—	`true`
`tenant`	`string`	opcional	—	—	`"texto"`
`tenantDisplay`	`string`	opcional	—	—	`"texto"`
`ownerUser`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`ownerGroup`	`objeto`	opcional	—	objeto — ver detalhe abaixo	`{ … }`
`pendingCost`	`integer (int64)`	opcional	—	—	`0`
`pendingBilling`	`integer (int64)`	opcional	—	—	`0`
`enableAutoSubmitToDebtCollection`	`boolean`	opcional	—	—	`true`
`alias`	`string`	opcional	—	—	`"texto"`

Detalhe de `bankSlipCosts`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`register`	`integer (int64)`	opcional	—	—	`0`
`cancellation`	`integer (int64)`	opcional	—	—	`0`
`discount`	`integer (int64)`	opcional	—	—	`0`
`changeDueDate`	`integer (int64)`	opcional	—	—	`0`
`settlement`	`integer (int64)`	opcional	—	—	`0`
`debtCollection`	`integer (int64)`	opcional	—	—	`0`
`debtCollectionCancellation`	`integer (int64)`	opcional	—	—	`0`
`debtCollectionSettlement`	`integer (int64)`	opcional	—	—	`0`
`debtCollectionSuccess`	`integer (int64)`	opcional	—	—	`0`
`transferRegister`	`integer (int64)`	opcional	—	—	`0`
`transferCancellation`	`integer (int64)`	opcional	—	—	`0`
`overDueCancellation`	`integer (int64)`	opcional	—	—	`0`
`dataprevCostDisbursement`	`integer (int64)`	opcional	—	—	`0`

Detalhe de `ownerUser`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`userId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`tenant`	`string`	opcional	—	—	`"texto"`
`tenantDisplay`	`string`	opcional	—	—	`"texto"`

Detalhe de `ownerGroup`

Campo	Tipo	Obrigatório	Descrição	Valores	Exemplo
`groupId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`groupDisplay`	`string`	opcional	—	—	`"texto"`
`tenant`	`string`	opcional	—	—	`"texto"`
`tenantDisplay`	`string`	opcional	—	—	`"texto"`

Exemplo de resposta

{
  "data": [
    {
      "id": "texto",
      "beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "beneficiaryName": "Fulano de Tal",
      "walletCode": 0,
      "bankAgency": "texto",
      "bankAccount": "texto",
      "bankAccountDebtCosts": "texto",
      "bankSlipCosts": {
        "register": 0,
        "cancellation": 0,
        "discount": 0,
        "changeDueDate": 0,
        "settlement": 0,
        "debtCollection": 0,
        "debtCollectionCancellation": 0,
        "debtCollectionSettlement": 0,
        "debtCollectionSuccess": 0,
        "transferRegister": 0,
        "transferCancellation": 0,
        "overDueCancellation": 0,
        "dataprevCostDisbursement": 0
      },
      "billingTypeValue": "texto",
      "billingTypeValueDisplay": "texto",
      "daysOverdueLimit": 0,
      "interestCodeValue": "texto",
      "interestCodeValueDisplay": "texto",
      "notificationRecepients": [
        "01310930"
      ],
      "createdAt": "2025-08-11T13:45:00Z",
      "enabled": true,
      "tenant": "texto",
      "tenantDisplay": "texto",
      "ownerUser": {
        "userId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "tenant": "texto",
        "tenantDisplay": "texto"
      },
      "ownerGroup": {
        "groupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "groupDisplay": "texto",
        "tenant": "texto",
        "tenantDisplay": "texto"
      },
      "pendingCost": 0,
      "pendingBilling": 0,
      "enableAutoSubmitToDebtCollection": true,
      "alias": "texto"
    }
  ],
  "page": 0,
  "totalPages": 0,
  "totalItems": 0,
  "isCountTruncated": true
}

Códigos de retorno

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

Exemplos

curl -X GET "{{baseUrl}}/api/v1/Wallet" \
  -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 = "/api/v1/Wallet";

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}/api/v1/Wallet`, {
  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