Skip to main content
GET
Resumo do extrato por período
GET /wallets/owner/:ownerId/summary Faz parte do recurso Carteiras — o modelo de saldo e liberação está lá. Devolve, para cada moeda, quanto entrou e quanto saiu em cada tipo de lançamento no período. É a leitura de fechamento: responde “de onde veio e para onde foi”, sem percorrer o extrato linha a linha.
total já vem com sinal. Entradas são positivas e saídas negativas — taxa, estorno e saque aparecem com valor negativo. Somar os total de todos os tipos dá o resultado líquido do período; somar os valores absolutos não dá nada.
credits e debits separam os dois sentidos dentro do mesmo tipo, e count diz quantos lançamentos entraram na conta. Um tipo com credits e debits preenchidos teve movimento nos dois sentidos no período.
O resumo é do período, o saldo é de agora. Este endpoint não responde quanto o recebedor tem — para isso é /balance. Um período fechado com net positivo pode conviver com saldo disponível zero, se o dinheiro já foi sacado.
startDate e endDate em ISO 8601 com fuso. Sem eles, o resumo cobre todo o histórico.

Exemplo

Resposta 200
No exemplo, o net do mês em BRL é 1090000 — R$ 10.900,00 — somando os quatro total.

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Path Parameters

ownerId
string
required

ID do recebedor

Query Parameters

types
enum<string>[]

Natureza do lançamento: sale, refund, chargeback, chargeback_reversal, pending_refund, pending_refund_reversal, anticipation, fee, withdrawal, adjustment, manual ou transfer. Aceita vários valores separados por vírgula e tem precedência sobre type.

Available options:
sale,
refund,
chargeback,
chargeback_reversal,
pending_refund,
pending_refund_reversal,
anticipation,
fee,
withdrawal,
adjustment,
manual,
transfer
flow
enum<string> | null

Direção do lançamento: credit (entrada) ou debit (saída). Débitos vêm com amount negativo — o sinal e o flow contam a mesma coisa.

Available options:
credit,
debit
source
enum<string> | null

Origem do lançamento: psp_import (recebido do adquirente), platform_calc (calculado na liquidação) ou manual (ajuste lançado por um operador).

Available options:
psp_import,
platform_calc,
manual
currency
string | null

Moeda no padrão ISO 4217 (ex.: BRL). Um valor por requisição.

releaseStatus
enum<string> | null

Disponibilidade do valor: released (já disponível para saque) ou pending (ainda a liberar).

Available options:
released,
pending
startDate
string<date-time> | null

Traz lançamentos criados a partir deste instante (ISO 8601 com timezone), inclusive.

endDate
string<date-time> | null

Traz lançamentos criados até este instante (ISO 8601 com timezone), inclusive.

transactionId
string | null

Retorna os lançamentos originados desta transação (txn_). Correspondência exata — útil para reconstruir venda, taxas e estornos de um mesmo pedido.

Minimum string length: 1

Response

Resumo do extrato agrupado por moeda

recipientId
string

ID do recebedor.

data
object[]

Lista de registros retornados na página atual.