Extrato

Use o extrato para conferir as movimentações registradas na conta e conciliar os valores com o seu sistema. Cada item representa um lançamento financeiro; um pagamento pode gerar uma entrada e uma tarifa em itens separados.

Consultar movimentações

Use Recuperar extrato, com GET /v1/statements. Você pode consultar um período, selecionar tipos de lançamento ou filtrar pela referência vinculada. Combine os filtros conforme a consulta desejada.

As datas usam segundos Unix UTC. created_gte inclui os lançamentos a partir do instante informado e created_lte inclui os lançamentos até esse instante. A ordem padrão apresenta os mais recentes primeiro; sort_order: asc apresenta os mais antigos primeiro.

A consulta retorna o histórico registrado pela Raims. Ela não inicia pagamentos, saques, estornos ou liberações de saldo. Uma solicitação ainda em andamento pode não ter seu resultado financeiro no extrato; acompanhe também o recurso que originou a solicitação.

Consultar um lançamento

Use Recuperar um lançamento, com GET /v1/statements/{id}, para conferir um item sem percorrer novamente as páginas do extrato. Envie o identificador completo com prefixo st_ recebido na listagem.

A resposta apresenta os mesmos campos do item da lista. Um lançamento ausente ou que não pertence à empresa e ao ambiente da chave recebe a mesma resposta de recurso não encontrado.

Tipos e valores dos lançamentos

amount_cents informa o valor em centavos de real, preservando o sinal: 10000 representa R$ 100,00 e -250 representa um débito de R$ 2,50. Interprete o valor junto de statement_type. O guia de tipos de lançamento detalha todos os códigos, os sinais dos valores e os cuidados de cada caso.

Retenção e liberação registram mudanças na disponibilidade do dinheiro. Uma liberação não representa um novo recebimento. O extrato não informa o saldo da conta após cada lançamento; somar uma página ou apenas os itens filtrados não fornece o saldo atual.

Para consultar o saldo atual, use o recurso Saldo. Ele distingue o total da conta, a parcela bloqueada e o valor disponível.

Vínculos com outros recursos

id, com prefixo st_, identifica o lançamento e permite reconhecê-lo no seu sistema. reference_id identifica o recurso de origem quando há um vínculo disponível. reference_type informa a categoria dessa referência: cobrança (1), contestação (2), saque (3), ajuste (4) ou lançamento manual (5). Campos sem vínculo disponível ficam null. Consulte o mapa de identificadores e prefixos para distinguir os IDs, inclusive referências sem endpoint público próprio.

Quando a referência for um saque, copie o ID wd_ para Recuperar um saque. A consulta mostra o andamento e o destino registrado, sem solicitar outra transferência.

refund_id identifica a solicitação de estorno vinculada ao lançamento, quando disponível. dispute_id identifica a contestação correspondente, incluindo casos MED. Use esses campos para consultar o estorno ou a contestação de origem.

Esses campos ficam null quando não há vínculo confirmado. Uma tarifa ou outro lançamento da mesma cobrança não recebe automaticamente o ID do estorno ou da contestação. Preserve os IDs retornados, inclusive seus prefixos, ao consultar cada recurso.

Use os detalhes de Cobranças e Contestações para acompanhar os recursos correspondentes. O identificador do lançamento é diferente do identificador da cobrança ou da contestação. A presença de uma referência não significa que exista um endpoint público para consultar todas as categorias.

Percorrer o histórico

A resposta contém list, com os lançamentos da página, e page, com as informações de navegação. Comece sem cursor e processe os itens de list. Enquanto page.has_next for verdadeiro, copie page.next_after inteiro para after na próxima requisição.

Mantenha a mesma chave, os filtros e a ordenação durante a navegação. Para alterar a consulta, comece novamente sem cursor. Uma lista vazia indica que a página não contém lançamentos para os filtros informados.

Para voltar, use page.previous_before em before. Não envie after e before preenchidos juntos nem interprete o conteúdo dos cursores. Veja Listagem e paginação para as regras gerais.

Empresa e ambiente

As consultas exigem uma chave de API. A empresa e o ambiente vêm dessa chave: Sandbox consulta somente as movimentações de simulação; Produção consulta o histórico financeiro correspondente. O console desta documentação aceita somente chaves Sandbox.

Filtrar por uma referência não concede acesso a dados de outra empresa ou ambiente. Trate os erros pelo status HTTP e por error.code; nas validações, confira também os campos indicados em error.details.