Skip to main content
GET
List payments

Authorizations

x-api-key
string
header
required

Query Parameters

limit
integer
default:20

Rows per page. Values above 100 are rejected.

Required range: 1 <= x <= 100
cursor
string

Opaque cursor from a previous response's pagination.nextCursor. Omit for the first page.

status

Filter by status. Repeat for several.

Available options:
CONFIRMED,
CANCELLED,
REFUNDED,
HELD,
HOLD_RELEASED,
HOLD_EXPIRED
type
enum<string>

Filter by capture type.

Available options:
CARD_PRESENT,
CARD_NOT_PRESENT
operationCode
integer

Exact operation code.

Only payments taken through this link.

subscriptionId
string<uuid>

Only payments billed by this subscription.

oneTimePaymentId
string<uuid>

Only payments for this one-time payment.

paymentMethodId
string<uuid>

Only payments charged to this saved card.

createdAtFrom
string<date-time>

Inclusive lower bound.

createdAtTo
string<date-time>

Inclusive upper bound.

Response

Success.

data
object[]
required
pagination
object
required