Skip to main content
GET
Retrieve Payment Summary

Authorizations

Authorization
string
header
required

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

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-10-15-1"

Query Parameters

groups
enum<string>[]

Which breakdowns to return, keyed by these names under groups. Repeat the parameter to ask for several; omit it for all of them.

Available options:
substatus,
currency
account_id
string

Only payments charged by this account, prefixed biz_.

statuses
enum<string>[]

Only payments in any of these lifecycle states. Repeat the parameter to pass several.

Available options:
open,
authorized,
paid,
pending,
uncollectible,
unresolved,
void
substatuses
enum<string>[]

Only payments whose substatus is any of these. Repeat the parameter to pass several.

Available options:
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
billing_reasons
enum<string>[]

Only payments charged for any of these reasons. Repeat the parameter to pass several.

Available options:
subscription_create,
subscription_cycle,
subscription_update,
one_time,
manual,
subscription
currencies
string[]

Only payments presented in any of these three-letter currencies. Repeat the parameter to pass several.

plan_ids
string[]

Only payments priced by any of these variants, each prefixed plan_. Repeat the parameter to pass several.

product_ids
string[]

Only payments for any of these products, each prefixed prod_. Repeat the parameter to pass several.

payment_methods
enum<string>[]

Only payments paid with any of these methods. Repeat the parameter to pass several.

Available options:
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,
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,
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
tracking_states
enum<string>[]

Only payments in any of these tracking states. Requires account_id and the shipment:basic:read permission.

Available options:
unknown,
pre_transit,
in_transit,
out_for_delivery,
delivered,
available_for_pickup,
return_to_sender,
failure,
cancelled,
error,
needs_tracking
created_after
string<date-time>

Only payments created after this ISO 8601 timestamp.

created_before
string<date-time>

Only payments created before this ISO 8601 timestamp.

query
string

Search payments by user ID, membership ID, user email, name, or username.

include_connected_accounts
boolean

Only for searches: with query, also search the account's connected accounts. Requires account_id and query, and is a 400 without either; it never lists connected accounts' payments on its own. Matches on payment, 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. Connected accounts' payments are returned only for connected accounts you can read payments on.

Response

200 - application/json

summary returned

groups
object
required

One entry per requested breakdown, keyed by the field it groups on. A field you did not ask for is absent.

total
integer
required

How many payments match the filters.

Example:

1