Skip to main content
O extrato retorna pagamentos da conta em ordem cronologica inversa (mais recentes primeiro), com paginacao por cursor. Ele nao representa um razao financeiro completo e nao inclui saques nem transferencias.
Requer escopo payments:read.

Consultar extrato

Envie GET /v1/statement com filtros opcionais de query.
string
Periodo em dias: 7, 30 (padrao) ou 90.
string
Filtro por situacao: all (padrao), pending, paid, expired, refunded, unknown.
Busca por referencia externa ou identificador do pagamento (ate 100 caracteres).
string
UUID do cursor da pagina anterior, obtido em nextCursor.
curl

Resposta paginada

A resposta contem ate 50 itens por pagina.
array
required
Lista de pagamentos (maximo 50).
string
required
UUID do pagamento.
integer
required
Valor em centavos de BRL.
integer
required
Tarifa em centavos.
string
required
Situacao do pagamento.
string
Referencia externa ou null.
string
required
Data/hora de criacao (ISO 8601).
string
required
Nome da carteira vinculada.
string
Cursor para a proxima pagina, ou null se nao houver mais resultados.

Paginacao por cursor

Para navegar entre paginas:
  1. Na primeira requisicao, nao envie cursor.
  2. Na resposta, verifique data.nextCursor.
  3. Se nextCursor nao for null, envie-o no parametro cursor da proxima requisicao.
  4. Repita ate nextCursor ser null.
curl
O cursor deve pertencer a mesma conta. Nao misture cursores de contas diferentes.

Limitacoes

  • O extrato inclui somente pagamentos; nao representa um razao completo de saques e transferencias.
  • Para listagens sem paginacao (ate 100 registros), use GET /v1/payments.
  • Periodos aceitos: 7, 30 ou 90 dias.