Clickfin

Referência da API
Portal oficial
GET/bank-slips

Listar boletos emitidos

Retorna uma lista paginada dos boletos da empresa autenticada. limit=0 retorna todos os itens em uma única resposta, com totalPages: 0. Requer perfil de Administrador.

AcessoChave de API · bank_slips:read
Parâmetros4
Respostas6

Parâmetros

  • clientIdquery

    Sem descrição disponível.

  • statusquery

    Sem descrição disponível.

  • pagequery

    Sem descrição disponível.

  • limitquery

    Itens por página. `0` retorna todos os itens (`totalPages` = 0).

Respostas

200Sucesso

Lista retornada com sucesso.

400Erro

Erro de validação nos parâmetros da consulta.

401Erro

Token ausente, inválido ou sem empresa selecionada.

403Erro

Falha de autorização.

429Erro

Limite de requisições excedido (RATE_LIMIT.EXCEEDED). Por chave: 120 requisições por minuto (janela fixa de 60 s); o 429 da chave traz X-RateLimit-* da chave. Por IP, para tráfego com chave: 600 requisições em 10 minutos; esse 429 traz só Retry-After, sem X-RateLimit-* (os cabeçalhos descrevem apenas o limite da chave). Aguarde Retry-After segundos antes de tentar de novo.

503Erro

Credencial não pôde ser verificada por falha temporária do servidor (AUTH.SESSION_UNAVAILABLE). Não invalida a chave nem a sessão: repita com backoff.