Listar todas as tarifas pontuais emitidas

Esse endpoint exibe todas as tarifas pontuais criadas.

Requisição(Request)

Requisição HTTP

GET https://sandbox.hiperbanco.com.br/dashboard/tariffs

--request GET 'https://sandbox.hiperbanco.com.br/dashboard/tariffs' \
--header 'version: cutting-edge' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{token}}'

Cabeçalhos (Headers)

Nome	Propriedade	Descrição
`version`	`cutting-edge`	Essa propriedade garante que o response da API seja retornado no formato JSON
`Authorization`	`Bearer token`	Obrigatório. Token de autorização do tipo Bearer.

Parâmetros da rota (Path / Query)

Nome	Tipo	Descrição
`startDate`	`query`	Data inicial da busca. ISO Date Format (YYYY-MM-DD).
`endDate`	`query`	Data final da busca. ISO Date Format (YYYY-MM-DD).
`page`	`query`	Página do resultado da busca
`perPage`	`query`	Itens por página
`search`	`query`	Query de pesquisa - É possível pesquisar pelo `accountNumber`
`orderColumn`	`query`	Coluna para ordenação - Valores possíveis: `createdAt`
`orderDirection`	`query`	Sentido da ordenação, pode ser `ASC` (ascendente) ou `DESC` (descendente). Funciona apenas se orderColumn tiver sido especificado

Corpo da requisição (Body)

Não é necessário enviar parâmetros no body desta requisição.

Resposta (Response)

O status code 200 indicará que a requisição foi feita com sucesso e trará um objeto contendo as informações das tarifas pontuais criadas

Sendo bem-sucedido, o retorno irá trazer os seguintes campos em formato JSON:

Campo	Tipo	Descrição
`data[]`	`array`	Lista de registros de pagamentos/faturas
`data[].id`	`string`	Identificador do registro
`data[].amount`	`number`	Valor do pagamento
`data[].description`	`string`	Descrição do pagamento
`data[].paid`	`boolean`	Indica se foi pago
`data[].duedate`	`string`	Data de vencimento
`data[].paidAt`	`string`	Data/hora do pagamento
`data[].createdAt`	`string`	Data/hora de criação do registro
`data[].userAccount`	`object`	Dados da conta associada
`data[].userAccount.number`	`string`	Número da conta
`data[].userAccount.onboarding`	`object`	Dados do onboarding da conta
`data[].userAccount.onboarding.registerName`	`string`	Nome cadastrado no onboarding
`data[].situation`	`string`	Situação da tarifa pontual.
`total`	`number`	Total de registros
`totalPages`	`number`	Total de páginas

Situação da tarifa pontual

Status	Descrição
`Pago`	A tarifa pontual foi debitada com sucesso da conta do cliente.
`Vencido`	A tarifa pontual não foi cobrada dentro do prazo definido em `dueDate`.
`A vencer`	A tarifa pontual está agendada para cobrança futura, conforme `dueDate`.

{
    "data": [
        {
            "id": "841b49a5-8451-4186-9950-6bab4280d82f",
            "amount": 1,
            "description": "Teste agendado",
            "paid": false,
            "duedate": "25/09/2025",
            "paidAt": null,
            "createdAt": "2025-09-24T17:15:54.639Z",
            "userAccount": {
                "number": "297453",
                "onboarding": {
                    "registerName": "Cassiano"
                }
            },
            "situation": "A vencer"
        },
        {
            "id": "cc82a094-5261-4e61-8c6f-664d97057abc",
            "amount": 12,
            "description": "Teste da tarefa 3044 Part 1",
            "paid": true,
            "duedate": "24/09/2025",
            "paidAt": "2025-09-24T13:59:17.000Z",
            "createdAt": "2025-09-24T13:59:16.547Z",
            "userAccount": {
                "number": "297453",
                "onboarding": {
                    "registerName": "Cassiano"
                }
            },
            "situation": "Pago"
        }
    ],
    "total": 2,
    "totalPages": 1
}

Erros

Este endpoint não retorna erros específicos. Porém, ele poderá retornar alguns erros comuns entre todos os endpoints.

Eventos

Este endpoint não possui eventos relacionados a ele.

Updated 12 days ago