Skip to main content
GET
List payments

Authorizations

x-api-key
string
header
required

Query Parameters

id
string<uuid>

Filter by a specific payment ID

status

Filter by payment status. Supports multiple values by repeating the parameter (e.g. ?status=PENDING&status=CONFIRMED).

Available options:
PENDING,
CANCELLED,
CONFIRMED,
REFUNDED
type

Filter by payment type. Supports multiple values.

Available options:
CARD_NOT_PRESENT,
CARD_PRESENT
financingMethod

Filter by financing method. Supports multiple values.

Available options:
INSTALLMENTS,
PAY_NOW
terms

Filter by number of installment terms (e.g. 3, 6, 12). Supports multiple values.

Required range: x >= 1
issuingBank

Filter by the card's issuing bank name. Supports multiple values.

organizationId

Filter by organization ID. Only organizations under your sales partner account are accessible. Supports multiple values.

createdAtFrom
string<date>

Filter payments created on or after this date (inclusive). Uses Mexico City timezone (CST/CDT).

createdAtTo
string<date>

Filter payments created on or before this date (inclusive). Uses Mexico City timezone (CST/CDT).

Search by operation code (partial match)

q
string

Free text search. Matches against payment amount and organization name.

limit
integer
default:20

Number of results per page (default: 20, max: 100)

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

Number of results to skip for pagination (default: 0)

Required range: x >= 0

Response

Paginated list of payments

Paginated list of payments

data
object[]
required

Array of payment objects

pagination
object
required

Pagination metadata