List Payments

Retrieve all transactions in a paginated format.

Endpoint

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

Headers:

Header	Value
`Authorization`	`Bearer {accessToken}`

Query Parameters

Parameter	Type	Default	Description
`resultsPerPage`	number	10	Number of results per page
`page`	number	0	Page number (zero-indexed)

Example Request

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

Response (200)

Returns an array of payment objects. Each object has the same structure as the single payment response, including history, transactionFees, card, billing, and customer fields.

[
  {
    "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": { ... }
  }
]

Pagination

Use page and resultsPerPage to iterate through results:

# First page
GET /payments?resultsPerPage=25&page=0

# Second page
GET /payments?resultsPerPage=25&page=1

Increment page until the response returns fewer results than resultsPerPage, indicating you've reached the last page.