Listar Pagamentos

Recupere todas as transações em formato paginado.

Endpoint

GET https://{FQDN}/payments?resultsPerPage={size}&page={number}

Headers:

Header	Valor
`Authorization`	`Bearer {accessToken}`

Parâmetros de Query

Parâmetro	Tipo	Padrão	Descrição
`resultsPerPage`	number	10	Número de resultados por página
`page`	number	0	Número da página (indexado a partir de zero)

Exemplo de Requisição

curl -X GET 'https://{FQDN}/payments?resultsPerPage=10&page=0' \
  -H 'Authorization: Bearer eyJhbGciOiJSUzI1NiIs...'

Resposta (200)

Retorna um array de objetos de pagamento. Cada objeto tem a mesma estrutura da resposta de pagamento único, incluindo os campos history, transactionFees, card, billing e customer.

[
  {
    "parentPaymentId": "9a8dd6f3-...",
    "externalId": "order-12345",
    "requestedOn": "2025-01-21 17:15:14",
    "amount": 57.00,
    "currency": "USD",
    "status": "REFUNDED",
    "approved": true,
    "history": [ ... ],
    "transactionFees": [ ... ],
    "card": { ... }
  },
  {
    "parentPaymentId": "b2c3d4e5-...",
    "externalId": "order-12346",
    "requestedOn": "2025-01-22 09:30:00",
    "amount": 150.00,
    "currency": "USD",
    "status": "CAPTURED",
    "approved": true,
    "history": [ ... ],
    "card": { ... }
  }
]

Paginação

Use page e resultsPerPage para iterar pelos resultados:

# Primeira página
GET /payments?resultsPerPage=25&page=0

# Segunda página
GET /payments?resultsPerPage=25&page=1

Incremente page até que a resposta retorne menos resultados do que resultsPerPage, indicando que você chegou à última página.