Referência

Transações

Todas as entradas numa lista só — PIX, boleto, cartão, cripto, checkout, link, assinatura e depósitos. Método e origem são filtros.

GET/v1/transactions

Lista transações com filtros e totais por moeda

Escopo transactions.read

Parâmetros de consulta

from / to

AAAA-MM-DDPeríodo (fuso da empresa).

status

listaAPPROVED, PENDING, AUTHORIZED, PROCESSING, DECLINED, FAILED, CANCELLED, EXPIRED, REFUNDED, PARTIALLY_REFUNDED, CHARGEBACK… (separados por vírgula).

method

listaPIX, BOLETO, CREDIT_CARD, DEBIT_CARD, CRYPTO.

origin

listaAPI, DASHBOARD, CHECKOUT, LINK, SUBSCRIPTION, POS, MARKETPLACE, DEPOSIT.

minAmount / maxAmount

centavosFaixa de valor bruto.

customer, customerId, id, externalId, providerId, product, kind, q

stringBusca e filtros adicionais. q procura em ID, external ID, E2E, NSU e cliente.

sort

enumcreatedAt:desc (padrão), createdAt:asc, amount:desc, amount:asc.

page

inteiroPágina (começa em 1).

pageSize

inteiro ≤ 200Itens por página (padrão 25).

GET/v1/transactions/export

Exporta a lista filtrada em CSV (format=csv)

Escopo transactions.export

GET/v1/transactions/:id

Detalhe: identificadores, eventos, estornos, chargebacks, split, recebíveis e webhooks

Escopo transactions.read

POST/v1/transactions/:id/refund

Estorno total ou parcial (PIX e cartão)

Escopo refunds.createAceita Idempotency-Key

Corpo (JSON)

amount

string | inteiroCentavos a devolver. Vazio = saldo estornável inteiro.

reason

string ≤ 240Motivo registrado na trilha.

POST/v1/transactions/:id/cancel

Cancela cobrança ainda não paga (CREATED, PENDING ou AUTHORIZED)

Escopo charges.create

Corpo (JSON)

reason

string ≤ 240Motivo (opcional).