Skip to main content
GET
List payments

Authorizations

Authorization
string
header
required

Bearer token authentication. Pass your API key as Authorization: Bearer sk_.... See Authentication for keys, scopes, and sandbox vs production.

Query Parameters

limit
integer
default:50

Page size. Defaults to 50. Maximum is 100.

Required range: 1 <= x <= 100
offset
integer
default:0

Number of records to skip before returning results.

Required range: x >= 0
status_filter
enum<string>

Optional exact status filter for charge records.

Available options:
created,
processing,
succeeded,
accepted,
failed,
expired,
cancelled,
refunded,
partially_refunded,
auto_refunded,
underpaid,
overpaid

Response

Success - Payments list retrieved

A paginated list of payments.

items
object[]
required

Payments for the current page.

pagination
object
required

Pagination details for a payments list.