> ## 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.

# Listar Payins

> Recupera uma lista de pagamentos (Payins) associados à sua conta corporativa com suporte a filtros e paginação.

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.

<ParamField header="Authorization" type="string" required>
  Use o Basic Auth.
</ParamField>

## Query Parameters (Filtros)

<ParamField query="status" type="string">
  Se desejar apenas uma lista de transações liquidadas, use `APPROVED`. Outros valores permitidos:

  * `PENDING`
  * `FAILED`
  * `CANCELED`
  * `REFUSED`
  * `REFUNDED`
  * `CHARGEBACK`
  * `EXPIRED`
</ParamField>

<ParamField query="paymentMethod" type="string">
  Filtre pelo agrupamento: `PIX`, `CREDIT_CARD` ou `BOLETO`.
</ParamField>

<ParamField query="startDate" type="datetime">
  Traga transações com data de criação inicial a partir desta (Ex: `2026-03-01T00:00:00.000Z`).
</ParamField>

<ParamField query="endDate" type="datetime">
  Usado em concomitante ao *startDate* para consolidar range. Limite as transações até aqui (Ex: `2026-03-31T23:59:59.000Z`).
</ParamField>

<ParamField query="externalId" type="string">
  Busque pelo ID de adquirente.
</ParamField>

<ParamField query="referenceId" type="string">
  Busque a transação pelo ID exato da **sua base** (aquele cadastrado no banco da sua Loja/Produto).
</ParamField>

<ParamField query="minAmount" type="integer">
  Filtra Payins com montante (em centavos) igual ou superior ao desejado.
</ParamField>

<ParamField query="maxAmount" type="integer">
  Filtra Payins com montante igual ou inferior ao desejado.
</ParamField>

<ParamField query="page" type="integer" default="1">
  Página atual de controle (Paginação).
</ParamField>

<ParamField query="limit" type="integer" default="20">
  A quantidade de registros por página devolvidos pelo JSON em `.items[]`.
</ParamField>

***

## Response

A chamada emulada preencherá uma lista.

```json theme={null}
{
  "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"
    }
  ]
}
```