List charges
Look up charges in your account with filters and cursor pagination.
Looks up charges in the company and environment of your API key. You can filter by charge identifier, external reference, customer, email registered on the charge, status, payment method or creation, due date and payment periods. The filter uses the charge's current payment method; simply selecting an option in checkout does not change this value. Changes to status or external reference may take a few seconds to appear in filtered results.
Start without a cursor, process list and, while page.has_next is true,
copy page.next_after to after, keeping the filters and sorting.
Copy the entire cursor without interpreting or calculating its contents.
See Listing and pagination to go back with before.
See how filters and sorting work in
List charges.
The meaning of external_reference is explained in
Reference in your system.
Query Params
Number of charges per page. Positive integers above the maximum use the maximum. An omitted, empty, zero, negative, or invalid value uses 10.
From 1 to 100
Copy page.next_after from the previous response to move forward. Keep the same filters and sorting; do not send before together with it. Leave empty to start listing.
Up to 128 characters
Copy page.previous_before from the previous response to move back. Keep the same filters and sorting; do not send after together with it. Leave empty if you do not want to move back.
Up to 128 characters
Filters by the complete charge ID. If there is no match, list is empty.
Up to 100 characters
Filters by the customer's complete public ID, returned when creating or retrieving the customer. The association remains the same if the name or email changes. Can be combined with other filters; keep the same customer_id when changing pages. A valid ID with no charges in the key's company and environment returns an empty list. An empty or omitted value does not apply the filter.
Up to 100 characters
Filters by the charge's current reference in your system, matching the complete value, including letter case and accents. An empty or omitted value does not apply the filter. Can be combined with other filters; keep the value when navigating by cursor. After creating or editing a charge, the search can take a few seconds to reflect the reference.
Up to 120 characters
Filters by the complete email recorded on the charge. Changing the customer's details does not change this email.
Up to 254 characters
Filters by one or more comma-separated codes, such as 0,1. 0 created, 1 awaiting payment, 2 authorized, 3 processing, 4 paid, 5 partially refunded, 6 refunded, 7 canceled, 8 expired, 9 failed, 10 chargeback, 11 chargeback under review, 12 chargeback lost, and 13 chargeback won. Can take a few seconds to reflect changes.
Up to 64 characters
Filters by the charge's payment method: 1 for Pix and 2 for boleto. To combine them, send 1,2. A charge with an undefined method can switch to Pix or boleto when the Pix code or boleto is generated in the checkout. Selecting a method on screen alone does not change the filter.
Up to 32 characters
Filters charges created at or after this instant, inclusive, in Unix seconds UTC. If you provide created_lte, this value must be less than or equal to it.
From 0 to 253402300799
Filters charges created at or before this instant, inclusive, in Unix seconds UTC.
From 0 to 253402300799
Filters charges due at or after this instant, inclusive, in Unix seconds UTC. Can be combined with due_lte and other filters; keep the value when changing pages.
From 0 to 253402300799
Filters charges due at or before this instant, inclusive, in Unix seconds UTC. If you provide due_gte, this value must be greater than or equal to it. Can be used alone or with other filters.
From 0 to 253402300799
Filters charges paid at or after this instant, inclusive, in Unix seconds UTC. Uses the confirmed payment date, even when a refund occurs later. Charges without confirmed payment are excluded. Keep the value when changing pages.
From 0 to 253402300799
Filters charges paid at or before this instant, inclusive, in Unix seconds UTC. If you provide paid_gte, this value must be greater than or equal to it. Can be combined with other filters.
From 0 to 253402300799
Sorts by amount in cents or creation date. If omitted, uses registration order; with a creation filter, uses created_at. Keep the same sorting when changing pages.
Sets the sorting direction. With desc, the default order shows the most recent charges first.
Responses
For common errors, see HTTP response codes.