Método utilizado para listar os boletos

Lista e filtra registros de api.

Visão geral

Método utilizado para listar os boletos.

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
`DocumentNumber`	query	`string`	opcional	—	`valor`
`Tenant`	query	`string`	opcional	—	`uy3`
`WalletCode`	query	`integer (int64)`	opcional	—	`10`
`BillingId`	query	`string`	opcional	—	`3fa85f64-5717-4562-b3fc-2c963f66afa6`
`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"`
`walletCode`	`integer (int64)`	opcional	—	—	`0`
`walletCodeOrigem`	`integer (int64)`	opcional	—	—	`0`
`barCode`	`string`	opcional	—	—	`"texto"`
`documentNumber`	`string`	opcional	—	—	`"texto"`
`amount`	`integer (int64)`	opcional	—	—	`0`
`dueDate`	`string`	opcional	—	—	`"texto"`
`tags`	`array de string`	opcional	—	—	`[ … ]`
`beneficiary`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`payer`	`objeto`	opcional	—	varia conforme o tipo — ver exemplo	`{ … }`
`statusRegisterValue`	`string`	opcional	—	—	`"texto"`
`statusRegisterValueDisplay`	`string`	opcional	—	—	`"texto"`
`statusSettlementValue`	`string`	opcional	—	—	`"texto"`
`statusSettlementValueDisplay`	`string`	opcional	—	—	`"texto"`
`statusDebtCollectionValue`	`string`	opcional	—	—	`"texto"`
`statusDebtCollectionValueDisplay`	`string`	opcional	—	—	`"texto"`
`latePaymentInterestAmountPerDay`	`string`	opcional	—	—	`"texto"`
`firstInstructionDebtCollection`	`string`	opcional	—	—	`"texto"`
`secondInstructionDebtCollection`	`integer`	opcional	—	—	`0`
`cancelReason`	`string`	opcional	—	—	`"texto"`
`billingId`	`string`	opcional	—	—	`"3fa85f64-5717-4562-b3fc-2c963f66afa6"`
`createdAt`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`settlementAt`	`string (date-time)`	opcional	—	—	`"2025-08-11T13:45:00Z"`
`settlementChannelValue`	`string`	opcional	—	—	`"texto"`
`settlementChannelValueDisplay`	`string`	opcional	—	—	`"texto"`
`bankCode`	`string`	opcional	—	—	`"texto"`
`walletNumber`	`integer`	opcional	—	—	`0`
`captureType`	`string`	opcional	—	—	`"texto"`
`captureTypeDisplay`	`string`	opcional	—	—	`"texto"`
`paymentMethod`	`string`	opcional	—	—	`"texto"`
`paymentMethodDisplay`	`string`	opcional	—	—	`"texto"`
`isTransferred`	`boolean`	opcional	—	—	`true`

Exemplo de resposta

{
  "data": [
    {
      "id": "texto",
      "walletCode": 0,
      "walletCodeOrigem": 0,
      "barCode": "texto",
      "documentNumber": "texto",
      "amount": 0,
      "dueDate": "texto",
      "tags": [
        "texto"
      ],
      "beneficiary": {
        "businessName": "Fulano de Tal",
        "registrationNumber": "12345678909"
      },
      "payer": {
        "name": "Fulano de Tal",
        "personTypeValue": "texto",
        "personTypeValueDisplay": "texto",
        "registrationNumber": "12345678909",
        "zipCode": "01310930",
        "addressName": "Fulano de Tal",
        "addressNumber": "texto",
        "addressComplement": "texto",
        "email": "cliente@exemplo.com.br"
      },
      "statusRegisterValue": "texto",
      "statusRegisterValueDisplay": "texto",
      "statusSettlementValue": "texto",
      "statusSettlementValueDisplay": "texto",
      "statusDebtCollectionValue": "texto",
      "statusDebtCollectionValueDisplay": "texto",
      "latePaymentInterestAmountPerDay": "texto",
      "firstInstructionDebtCollection": "texto",
      "secondInstructionDebtCollection": 0,
      "cancelReason": "texto",
      "billingId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "createdAt": "2025-08-11T13:45:00Z",
      "settlementAt": "2025-08-11T13:45:00Z",
      "settlementChannelValue": "texto",
      "settlementChannelValueDisplay": "texto",
      "bankCode": "texto",
      "walletNumber": 0,
      "captureType": "texto",
      "captureTypeDisplay": "texto",
      "paymentMethod": "texto",
      "paymentMethodDisplay": "texto",
      "isTransferred": true
    }
  ],
  "page": 0,
  "totalPages": 0,
  "totalItems": 0,
  "isCountTruncated": true
}

Códigos de retorno

Código	Significado	Detalhe do contrato
`200`	Requisição bem-sucedida.	—
`401`	Não autenticado — token ausente, inválido ou expirado.	—

Exemplos

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

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