Retrieve Payment Summary
Totals up the same payments the list returns, so you can build status tabs and filter options without paging through them. Takes the same filters as List Payments.
Authorizations
An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.
Headers
Pins the request to a dated API version.
"2026-11-04-1"
Query Parameters
Which breakdowns to return, keyed by these names under groups. Repeat the parameter to ask for several; omit it for all of them.
substatus, currency Only payments charged by this account, prefixed biz_.
Only payments in any of these lifecycle states. Repeat the parameter to pass several.
open, authorized, paid, pending, uncollectible, unresolved, void Only payments whose substatus is any of these. Repeat the parameter to pass several.
succeeded, requires_capture, pending, failed, blocked, past_due, canceled, price_too_low, uncollectible, refunded, auto_refunded, partially_refunded, dispute_warning, dispute_needs_response, dispute_warning_needs_response, resolution_needs_response, dispute_under_review, dispute_warning_under_review, resolution_under_review, dispute_won, dispute_warning_closed, resolution_won, dispute_lost, dispute_closed, resolution_lost, drafted, incomplete, unresolved Only payments charged for any of these reasons. Repeat the parameter to pass several.
subscription_create, subscription_cycle, subscription_update, one_time, manual, subscription Only payments presented in any of these three-letter currencies. Repeat the parameter to pass several.
Only payments charged at least this amount: what the buyer was charged after discounts and including tax, in the currency each payment was presented in. Where tax is added on top of the price (tax_behavior is exclusive), that is the price plus the tax. A failed payment that charged nothing counts as 0. Inclusive and compared to the cent.
x >= 0995
Only payments charged at most this amount, measured like min_amount: after discounts and including tax. Inclusive and compared to the cent. Must not be less than min_amount.
x >= 0995
Only payments priced by any of these variants, each prefixed plan_. Repeat the parameter to pass several.
Only payments for any of these products, each prefixed prod_. Repeat the parameter to pass several.
Only payments paid with any of these methods. Repeat the parameter to pass several.
mastercard, visa, amex, discover, unionpay, jcb, diners, link, troy, visadankort, visabancontact, china_union_pay, rupay, jcbrupay, elo, maestro, tarjeta_naranja, cirrus, nspk_mir, verve, ebt, private_label, local_brand, uatp, wexcard, uzcard, meeza, hrg_store_card, girocard, fuel_card, dankort, carnet, atm_card, china_union_payuzcard, codensa, cabal, hipercard, jcblankapay, cmi, aura, accel, culiance, nyce, pulse, star, eftpos, alelo, edenred, sodexo, unknown, acss_debit, addi, affirm, afterpay_clearpay, alipay, alipayhk, alma, amazon_pay, apple, apple_pay, au_bank_transfer, au_becs_debit, bacs_debit, bancolombia, bancontact, bank_wire, billie, blik, boleto, bre_b, ca_bank_transfer, capchase_pay, card, card_present, card_installments_three, card_installments_six, card_installments_twelve, cashapp, claritypay, coinbase, crypto, custom, customer_balance, demo_pay, duitnow_qr, efecty, eps, eu_bank_transfer, fpx, flex_pay, gb_bank_transfer, gcash, giropay, google_pay, gopay, grabpay, id_bank_transfer, ideal, interac, international_bank_wire, kakao_pay, klarna, klarna_pay_now, konbini, kr_card, kr_market, kriya, kueski, mb_way, m_pesa, mercado_pago, mercado_pago_ar, mercado_pago_mx, mobilepay, modo, mondu, multibanco, naver_pay, nequi, netbanking, ng_bank, ng_bank_transfer, ng_card, ng_market, ng_ussd, ng_wallet, nupay, nz_bank_account, oney, oney_3x, oney_4x, opay, oxxo, p24, pago_efectivo, pse, pay_by_bank, payco, paynow, paypal, paypal_express, paypay, payto, payto_email, payto_phone, payto_bank_account, pix, platform_balance, promptpay, qris, rapipago, rechnung, revolut_pay, samsung_pay, satispay, scalapay, sencillito, sepa_debit, sequra, servipag, sezzle, shop_pay, shopeepay, sofort, south_korea_market, spei, splitit, sunbit, swish, tabby, tamara, touch_n_go, twint, upi, us_bank_account, us_bank_transfer, venmo, vipps, webpay, wechat_pay, whop_pay, yape, zip, coinflow, tap_to_pay Only payments in any of these tracking states. Requires account_id and the shipment:basic:read permission.
unknown, pre_transit, in_transit, out_for_delivery, delivered, available_for_pickup, return_to_sender, failure, cancelled, error, needs_tracking, missing_tracking Only payments created after this ISO 8601 timestamp.
Only payments created before this ISO 8601 timestamp.
Only payments refunded after this ISO 8601 timestamp.
Only payments refunded before this ISO 8601 timestamp.
Only payments with a dispute alert after this ISO 8601 timestamp.
Only payments with a dispute alert before this ISO 8601 timestamp.
Only payments with a dispute opened after this ISO 8601 timestamp.
Only payments with a dispute opened before this ISO 8601 timestamp.
Search payments by payment ID, dispute ID, user ID, membership ID, user email, name, or username.
Only for searches: with query, also search the account's subaccounts. Requires account_id and query, and is a 400 without either; it never lists subaccounts' payments on its own. Matches on payment, dispute, user or membership ID, buyer email, or a card's first 6 or 8 digits and last 4 separated by a space or dash (424242 4242). Free-text queries such as a name search only the named account. Subaccounts' payments are returned only for subaccounts you can read payments on.

