Skip to main content
GET
Extrato do recebedor
GET /wallets/owner/{ownerId}/transactions Faz parte do recurso Carteiras — o que cada saldo significa está lá. Retorna o extrato do lançamento mais recente para o mais antigo, consolidando todas as carteiras do recebedor; cada lançamento traz a própria moeda. A página vem com limit 20 por padrão e aceita até 100 — confira pagination.totalPages antes de concluir que o extrato acabou. Todos os filtros são opcionais e podem ser combinados; as datas seguem ISO 8601 com timezone (veja Convenções).
Filtro com valor inválido responde 400, não é ignorado. ?flow=entrada recusa a requisição inteira, sem devolver resultado parcial.
Débito vem com amount negativo. O sinal acompanha o flow: credit é positivo, debit é negativo — uma taxa aparece como flow: "debit" com amount: -12500. Somar o amount de todos os lançamentos dá o efeito líquido direto; não aplique o flow por cima do sinal, ou todo débito conta em dobro.
releaseStatus separa o que já dá para sacar. released é o que está disponível; pending ainda está no prazo de liberação e o campo scheduledFor diz quando cai. O saldo sacável não é a soma do extrato inteiro.
Para reconstruir um pedido, filtre por transactionId: a venda, as taxas e eventuais estornos daquela transação vêm juntos, e é assim que se explica a diferença entre o valor da venda e o que entrou na carteira.

Exemplo

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
page
integer
default:1

Página da listagem. Padrão: 1.

Required range: x >= 1
limit
integer
default:20

Itens por página. Padrão: 20. Máximo: 100.

Required range: 1 <= x <= 100

Response

Lista paginada de lançamentos

data
object[]

Lista de registros retornados na página atual.

pagination
object

Dados de paginação do resultado.