Skip to main content
GET
/
payin
Listar Payins
curl --request GET \
  --url https://api.example.com/payin \
  --header 'Authorization: <authorization>'

Documentation Index

Fetch the complete documentation index at: https://developers.holdinglegacy.io/llms.txt

Use this file to discover all available pages before exploring further.

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.
​
Authorization
string
required
Use o Basic Auth.

​
Query Parameters (Filtros)

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

​
Response

A chamada emulada preencherá uma lista. 
{
  "total": 542,
  "currentPage": 1,
  "totalPages": 28,
  "items": [
    {
       "id": "payin_1A2B3D",
       "status": "APPROVED",
       "paymentMethod": "PIX",
       "amount": 25000,
       "referenceId": "sua-comanda-345",
       "createdAt": "2026-03-01T14:30:20.000Z"
    }
  ]
}