Skip to main content
GET
List Payments

인증

Authorization
string
header
필수

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.

Scopes

payment:basic:read

헤더

Api-Version-Date
string

Pins the request to a dated API version.

예시:

"2026-11-17"

쿼리 매개변수

mode
enum<string>
기본값:account_sales

Which sales to list. account_sales returns sales for the accounts the caller can read, and with user_id=me the user's own purchases too. user_sales returns only sales the signed-in user received personally, outside any account; it requires the user's own Whop login session and cannot be combined with account_id.

사용 가능한 옵션:
account_sales,
user_sales
account_id
string

Only payments charged by this account, prefixed biz_. With user_id=me, an account whose payments you cannot read lists only your own purchases from it.

status
enum<string>

Only payments in this lifecycle state.

사용 가능한 옵션:
open,
authorized,
paid,
pending,
uncollectible,
unresolved,
void
tracking_status
enum<string>

Only payments whose most recently attached kept shipment is in this tracking state. missing_tracking selects paid payments with a captured shipping address and no kept shipment, excluding fully refunded payments. needs_tracking selects payments with an open pre-shipment funds hold and no kept shipment. Shipment states do not imply a payment or refund state. Requires shipment:basic:read as well as payment:basic:read; user-wide lists include only accounts readable under both scopes, and none of the user's purchases. Only supported with mode=account_sales.

사용 가능한 옵션:
unknown,
pre_transit,
in_transit,
out_for_delivery,
delivered,
available_for_pickup,
return_to_sender,
failure,
cancelled,
error,
needs_tracking,
missing_tracking
billing_reason
enum<string>

Only payments charged for this reason. subscription_cycle also matches renewals recorded as subscription_update.

사용 가능한 옵션:
subscription_create,
subscription_cycle,
subscription_update,
one_time,
manual,
subscription
currency
string

Only payments presented in this three-letter currency, such as usd.

user_id
string

Only payments made by this buyer, prefixed user_. me is the signed-in user and needs a user credential: a whop.com session, an OAuth token or a user-scoped token. It lists the user's own payments: their purchases from any account, and their payments on accounts they read as the seller.

query
string

Search payments by payment ID, dispute ID, user ID, membership ID, user email, name, or username. Email filtering requires the member:email:read permission.

include_subaccounts
boolean

Also cover the account's subaccounts. Requires account_id, and is a 400 without it. Without query, lists the payments of the account and every subaccount, newest first by created_at only; another order is a 400. The listing is cut off after 10 seconds, which a rare filter on an account with little recent activity can reach; add a query to narrow it. With query, 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.

member_id
string

Only payments made by this member, prefixed mber_.

membership_id
string

Only payments billed under this membership, prefixed mem_.

product_id
string

Only payments for this product, prefixed prod_.

variant_id
string

Only payments priced by this variant, prefixed plan_.

created_before
string<date-time>

Only payments created before this ISO 8601 timestamp.

created_after
string<date-time>

Only payments created after this ISO 8601 timestamp.

statuses
enum<string>[]

Only payments in any of these lifecycle states, with the same meanings as status. Repeat the parameter to pass several. Combined with status when both are sent.

사용 가능한 옵션:
open,
authorized,
paid,
pending,
uncollectible,
unresolved,
void
substatuses
enum<string>[]

Only payments whose substatus is any of these. Repeat the parameter to pass several. incomplete also matches payments that report incomplete because no finer status was recorded. A purchase Whop's risk checks blocked reports failed, so failed matches it and blocked does not.

사용 가능한 옵션:
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, with the same meanings as billing_reason. Repeat the parameter to pass several. Combined with billing_reason when both are sent.

사용 가능한 옵션:
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. Combined with currency when both are sent.

min_amount
number

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, the same amount order=amount sorts by. Where tax is added on top of the price (tax_behavior is exclusive), that is the price plus the tax, so a 995 price with tax added does not match 995: match a range instead. A failed payment that charged nothing matches 0, not its price. Inclusive and compared to the cent. Pair it with currencies when the account sells in several. Send the same value as max_amount to match one exact amount.

필수 범위: x >= 0
예시:

995

max_amount
number

Only payments charged at most this amount, measured like min_amount: after discounts and including tax, in the currency each payment was presented in. Inclusive and compared to the cent. Must not be less than min_amount.

필수 범위: x >= 0
예시:

995

variant_ids
string[]

Only payments priced by any of these variants, each prefixed plan_. Repeat the parameter to pass several. Combined with variant_id when both are sent.

product_ids
string[]

Only payments for any of these products, each prefixed prod_. Repeat the parameter to pass several. Combined with product_id when both are sent.

payment_methods
enum<string>[]

Only payments paid with any of these methods: a card brand such as amex, a wallet such as apple_pay, or a payment method type such as paypal. 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,
crypto_subscription,
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,
pix_automatico,
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 whose shipment is in any of these tracking states, or that still need a tracking number (needs_tracking). Repeat the parameter to pass several. 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
refunded_after
string<date-time>

Only payments refunded after this ISO 8601 timestamp.

refunded_before
string<date-time>

Only payments refunded before this ISO 8601 timestamp.

dispute_alerted_after
string<date-time>

Only payments with a dispute alert after this ISO 8601 timestamp.

dispute_alerted_before
string<date-time>

Only payments with a dispute alert before this ISO 8601 timestamp.

dispute_created_after
string<date-time>

Only payments with a dispute opened after this ISO 8601 timestamp.

dispute_created_before
string<date-time>

Only payments with a dispute opened before this ISO 8601 timestamp.

order
enum<string>

The field to sort by. amount sorts by the amount charged, in the currency it was charged in.

사용 가능한 옵션:
created_at,
paid_at,
amount
direction
enum<string>

The sort direction.

사용 가능한 옵션:
asc,
desc
first
integer
기본값:20

Number of results to return from the start of the range.

필수 범위: x <= 100
after
string

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

last
integer

Number of results to return from the end of the range.

필수 범위: x <= 100
before
string

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

include_total_count
boolean

Set to true to return the number of matching results in page_info.total_count. Send first=0 as well to return the count without any results.

응답

payments listed

data
object[]
필수
page_info
object
필수