Skip to main content
GET
List Payments

Query Parameters

integer
default:"1"
Page number for pagination
integer
default:"10"
Number of payments per page
integer
Filter payments by customer ID
integer
Filter payments by order ID
string
Filter payments by status. Common values: succeeded, processing, failed
string
Filter by payment method (e.g. cash, credit_card, paypal, stripe, mercadopago_checkout)
string
Filter by payment processor (e.g. stripe, paypal, mercadopago, square, other)
number
Filter payments with amount greater than or equal to this value
number
Filter payments with amount less than or equal to this value
string
Filter payments created on or after this date (YYYY-MM-DD)
string
Filter payments created on or before this date (YYYY-MM-DD)
Search across token, notes, and receipt number
string
default:"created_at"
Field to sort results by. Valid values: id, amount, created_at, status
string
default:"DESC"
Sort direction. Valid values: ASC, DESC

Example Requests

Basic Request

Filter by Status

Filter by Order

Filter by Customer

Example Response