Skip to main content
GET
Listar Payins
Através desta rota, você pode gerar relatórios financeiros da sua base de clientes, filtrando pagamentos específicos usando parâmetros de busca.

Autorização

A rota deve estar protegida e identificada nos Cabeçalhos.
string
required
Use o Basic Auth.

Query Parameters (Filtros)

string
Se desejar apenas uma lista de transações liquidadas, use APPROVED. Outros valores permitidos:
  • PENDING
  • FAILED
  • CANCELED
  • REFUSED
  • REFUNDED
  • CHARGEBACK
  • EXPIRED
string
Filtre pelo agrupamento: PIX, CREDIT_CARD ou BOLETO.
datetime
Traga transações com data de criação inicial a partir desta (Ex: 2026-03-01T00:00:00.000Z).
datetime
Usado em concomitante ao startDate para consolidar range. Limite as transações até aqui (Ex: 2026-03-31T23:59:59.000Z).
string
Busque pelo ID de adquirente.
string
Busque a transação pelo ID exato da sua base (aquele cadastrado no banco da sua Loja/Produto).
integer
Filtra Payins com montante (em centavos) igual ou superior ao desejado.
integer
Filtra Payins com montante igual ou inferior ao desejado.
integer
default:"1"
Página atual de controle (Paginação).
integer
default:"20"
A quantidade de registros por página devolvidos pelo JSON em .items[].

Response

A chamada emulada preencherá uma lista.