Skip to main content
GET
List payments

Authorizations

Authorization
string
header
required

Your account's secret key: Authorization: Bearer sk_test_… or sk_live_…. Server-side only.

Query Parameters

status
enum<string>

Filter by payment status.

Available options:
pending,
confirmed,
failed,
refunded,
charged_back
provider
string

Filter by the processor the charge ran through, as shown in the payment's provider field (for example, sandbox).

method
enum<string>

Filter by payment method.

Available options:
pix,
boleto,
card,
crypto
limit
integer
offset
integer

Response

List of payments.

payments
object[]