Consultar pagamentos (PIX e boleto)

O endpoint GET /v1/payments lista os pagamentos recebidos (cobranças que foram pagas — cada payment tem um paid_at). Ele aceita filtros opcionais para recortar por data de pagamento e por método, útil para conciliar o caixa de um período ou separar PIX de boletos.

Filtros

Parâmetro	Descrição
`paid_from` / `paid_to`	Janela inclusiva sobre `paid_at`. Aceitam data (`2026-07-01`) ou timestamp ISO-8601. Uma data sem hora cobre o dia inteiro — então `paid_from=paid_to=2026-07-01` traz os pagamentos daquele dia.
`payment_method`	`pix`, `boleto` ou `boleto_hibrido`. O valor `boleto` cobre a família inteira (boleto normal e híbrido).
`account_id`	(opcional) restringe a uma conta específica.
`limit` / `cursor`	Paginação por cursor (ver abaixo).

Todos os filtros são combináveis e opcionais — sem nenhum, o endpoint devolve todos os pagamentos do merchant (comportamento anterior, inalterado).

Exemplos

# Todos os PIX pagos em julho/2026
curl -s "https://api.vmixpay.com.br/v1/payments?payment_method=pix&paid_from=2026-07-01&paid_to=2026-07-31" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

# Boletos pagos em 15/07/2026 (a família boleto: normal + híbrido + boleto+PIX)
curl -s "https://api.vmixpay.com.br/v1/payments?payment_method=boleto&paid_from=2026-07-15&paid_to=2026-07-15" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

# PIX e boletos pagos no intervalo (sem filtro de método)
curl -s "https://api.vmixpay.com.br/v1/payments?paid_from=2026-07-01&paid_to=2026-07-31" \
  -H "Authorization: Bearer $ACCESS_TOKEN"

Resposta

{
  "data": [
    {
      "id": "pay_...",
      "charge_id": "chg_...",
      "amount_cents": 15000,
      "paid_at": "2026-07-15T13:42:07.000Z"
    }
  ],
  "next_cursor": "eyJ..."
}

Paginação

Os filtros não mudam a paginação: siga o next_cursor da resposta até ele vir null. Passe-o em cursor na requisição seguinte (mantendo os mesmos filtros).

Erros

HTTP	Código	Quando
`400`	`DATE_RANGE_INVALID`	data malformada, ou `paid_from` posterior a `paid_to`.
`400`	`PAYMENT_METHOD_INVALID`	`payment_method` fora do conjunto aceito.

Veja também Erros & Idempotência e Webhooks para receber os pagamentos por push em vez de consulta (pull).