Jump to Content

Listar Payins

Retorna uma lista paginada de todas as cobranças associadas à sua conta. Utilize os filtros para construir relatórios, reconciliações financeiras ou dashboards operacionais.

GET https://api.legacyecombr.com.br/payin

Parâmetros de consulta

Parâmetro	Tipo	Descrição
`search`	`string`	Busca textual por ID, `referenceId`, `externalId`, nome do cliente ou título de item
`status`	`string`	Filtra por status: `PENDING`, `APPROVED`, `FAILED`, `CANCELED`, `REFUSED`, `REFUNDED`, `CHARGEBACK`, `MED` ou `EXPIRED`
`paymentMethod`	`string`	Filtra por método: `PIX`, `CREDIT_CARD` ou `BOLETO`
`startDate`	`string (ISO 8601)`	Data/hora de início do período (ex.: `2026-03-01T00:00:00.000Z`)
`endDate`	`string (ISO 8601)`	Data/hora de fim do período
`referenceId`	`string`	ID exato da transação no seu sistema
`externalId`	`string`	ID exato gerado pela adquirente
`minAmount`	`number`	Valor mínimo em centavos
`maxAmount`	`number`	Valor máximo em centavos
`page`	`integer`	Página a ser retornada (padrão: `1`)
`limit`	`integer`	Itens por página (padrão: `20`)

Exemplo de requisição com filtros

GET /payin?status=APPROVED&paymentMethod=PIX&startDate=2026-03-01T00:00:00.000Z&endDate=2026-03-31T23:59:59.000Z&page=1&limit=20
Host: api.holdinglegacy.io
Authorization: Basic base64(pk_live_xxxx:sk_live_yyyy)

Resposta `200 OK`

{
  "data": [
    {
      "id": "payin_1A2B3C",
      "externalId": "tx_998877",
      "referenceId": "pedido-001",
      "status": "APPROVED",
      "amount": 10000,
      "currency": "BRL",
      "paymentMethod": "PIX",
      "installments": 1,
      "netAmount": 9700,
      "reservedAmount": 300,
      "createdAt": "2026-03-02T12:00:00.000Z",
      "updatedAt": "2026-03-02T12:05:00.000Z"
    },
    {
      "id": "payin_1A2B3D",
      "externalId": "tx_998878",
      "referenceId": "pedido-002",
      "status": "PENDING",
      "amount": 25000,
      "currency": "BRL",
      "paymentMethod": "BOLETO",
      "installments": 1,
      "netAmount": null,
      "reservedAmount": null,
      "createdAt": "2026-03-02T13:00:00.000Z",
      "updatedAt": "2026-03-02T13:00:00.000Z"
    }
  ],
  "meta": {
    "total": 154,
    "page": 1,
    "limit": 20,
    "totalPages": 8
  }
}

Campos da resposta

Campo	Tipo	Descrição
`data`	`array`	Lista de cobranças do período
`meta.total`	`integer`	Total de registros encontrados
`meta.page`	`integer`	Página atual
`meta.limit`	`integer`	Itens por página
`meta.totalPages`	`integer`	Total de páginas disponíveis
`netAmount`	`integer \| null`	Valor líquido após dedução de taxas (em centavos)
`reservedAmount`	`integer \| null`	Valor retido como reserva (em centavos)

📘
netAmount e reservedAmount
Esses campos são calculados com base no perfil de taxas da sua conta e ficam disponíveis assim que a cobrança é processada. Para transações PENDING, ambos retornam null.

Updated 39 minutes ago