API
Verificando conta Raims

Recuperar extrato

Consulte as movimentações financeiras da conta com filtros e paginação.

GEThttps://api.raims.com/v1/statements

Consulte os lançamentos financeiros da empresa e do ambiente da sua chave. Use os filtros para selecionar um período, tipos de lançamento ou uma referência vinculada.

Uma mesma transação pode gerar vários lançamentos. A consulta mostra o histórico registrado, sem executar pagamentos ou alterar valores da conta.

Veja Extrato para interpretar os valores e continuar a consulta pelas páginas.

O mapa de tipos e identificadores explica os códigos do lançamento e os prefixos das referências que podem aparecer.

Parâmetros de consulta

Quantidade de lançamentos por página.

De 1 a 100

Cursor recebido em page.next_after para avançar. Mantenha os mesmos filtros e a mesma ordem. Use somente after ou before.

Até 128 caracteres

Cursor recebido em page.previous_before para voltar. Mantenha os mesmos filtros e a mesma ordem. Use somente after ou before.

Até 128 caracteres

Tipos de lançamento separados por vírgula: 1 recebimento; 2 tarifa; 3 tarifa de serviço; 4 saque; 5 devolução; 6 devolução parcial; 7 crédito por ajuste; 8 débito por ajuste; 9 bloqueio; 10 liberação.

Até 100 caracteres

Identificador da cobrança, contestação, saque ou ajuste relacionado ao lançamento. Use o ID completo retornado pela Raims.

Até 100 caracteres

Início inclusivo do período, em segundos Unix UTC. O filtro considera o instante do lançamento.

De 1 a 253402300799

Fim inclusivo do período, em segundos Unix UTC. O instante informado é o limite exato; frações posteriores ao segundo informado ficam fora do período.

De 1 a 253402300799

Ordem dos lançamentos pela data: desc mostra os mais recentes primeiro; asc mostra os mais antigos primeiro.

desc

Respostas

Para os erros gerais, consulte Códigos HTTP das respostas.