Payments
Search Payments
Lists the account’s payments created in a window of at most 1 day, with filters and cursor pagination.
GET
Search Payments
This request lists the payments of the account sent in the
X-Account-Code header. Use it to sync payments to a data warehouse or to build an admin panel. To look up a single payment, use Retrieve Payment by ID or Retrieve Payment by Merchant Order ID instead.
Creation window
created_at_from and created_at_to are required date-times in RFC 3339 format with a timezone offset, for example 2026-11-03T00:00:00Z or 2026-11-03T00:00:00-03:00. created_at_from is inclusive and created_at_to is exclusive, so consecutive windows that share a boundary do not overlap. created_at_to must be after created_at_from, and the window between them is at most 1 day (24 hours). A wider window answers 400 DATE_RANGE_TOO_WIDE. To cover a longer period, send one request per 24-hour window, for example consecutive UTC days.
Filters
All filters are optional and combine with AND:
Send each parameter once, except
status. A parameter that is not listed on this page, or a filter with an invalid value, answers 400 INVALID_PARAMETERS.
Pagination
Rows are ordered bycreated_at ascending. limit sets the page size, from 1 to 100, and defaults to 50.
The response is an object with three fields:
To read the next page, send
cursor with the next_cursor value unchanged, and the same X-Account-Code and filters as the request that returned it. Keep paging until has_more is false. A modified cursor, or one sent with a different account or different filters, answers 400 INVALID_CURSOR. Pagination moves forward only.
Rows
Each row is a summary of the payment:id, account_id, merchant_order_id, description, country, status, sub_status, amount.value, amount.currency, payment_method.type, customer_payer.id, created_at and updated_at.
Rows carry no
transactions array. Retrieve a payment by its id to get the full payment object.Errors
Errors use thecode and messages envelope.
Authorizations
Query Parameters
Payment statuses to match. Send a comma-separated list (status=SUCCEEDED,DECLINED) or repeat the parameter (status=SUCCEEDED&status=DECLINED).
Available options:
CREATED, READY_TO_PAY, PENDING, SUCCEEDED, VERIFIED, DECLINED, REJECTED, ERROR, EXPIRED, CANCELED, REFUNDED, IN_DISPUTE, CHARGEBACK Response
200