Skip to main content
GET
Retrieve Payment

Autorisaties

Authorization
string
header
vereist

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

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Voorbeeld:

"2026-11-17"

Padparameters

id
string
vereist

The payment, prefixed pay_.

Respons

payment retrieved

account_id
string | null
vereist

The account that received the payment, prefixed biz_.

Voorbeeld:

"biz_xxxxxxxxxxxxxx"

amount_after_fees
object | null
vereist

What the account keeps: the total less Whop's fees. Null when you read the payment as its buyer.

amount_charged
object
vereist

What the buyer is charged for this payment: the total plus any buyer fees, in the currency the buyer pays in. Refunds do not reduce it; presentment_refunded_amount states them in the same currency.

auto_capture_at
string | null
vereist

When Whop will capture this authorized card payment automatically unless it is voided first, as an ISO 8601 timestamp. Null when no automatic capture was requested.

Voorbeeld:

null

auto_refunded
boolean
vereist

True when Whop refunded the payment automatically, for example on a dispute alert.

Voorbeeld:

false

billing_address
object | null
vereist

The billing address the buyer entered, or null.

billing_reason
enum<string> | null
vereist

Why the charge was created: a first purchase, a renewal, a one-time payment, or a manual charge.

Beschikbare opties:
subscription_create,
subscription_cycle,
subscription_update,
one_time,
manual,
subscription
Voorbeeld:

"subscription_create"

capture_expires_at
string | null
vereist

When the hold on this authorized card payment expires if it is not captured first, as an ISO 8601 timestamp. Null when the payment was not created for later capture.

Voorbeeld:

null

checkout_configuration_id
string | null
vereist

The checkout configuration the buyer paid through, prefixed ch_, or null.

Voorbeeld:

null

checkout_origin
string | null
vereist

The scheme and host of the website where the buyer opened the checkout, such as https://store.example.com. Use it to tell apart payments from different websites on one account. Null when the website was not recorded, including for payments made without the buyer present.

Voorbeeld:

null

checkout_surface
enum<string> | null
vereist

The checkout experience that produced this payment, such as embedded_checkout for a checkout on the account's own website or off_session for a subscription renewal. Null when the checkout was not recorded.

Beschikbare opties:
hosted_checkout,
embedded_checkout,
custom_checkout,
modal_checkout,
in_app_checkout,
mobile_checkout,
off_session,
card_present,
null
Voorbeeld:

"custom_checkout"

client_secret
string | null
vereist

The credential a buyer's surface presents to poll this payment, set its return URL and resume it when the bank asked the customer to authenticate. Only on payments created from a confirmation token or waiting on that authentication, null when you read the payment as its buyer, and always null in list responses — retrieve the payment for it.

Voorbeeld:

"pay_xxxxxxxxxxxxxx_secret_vdefault_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

created_at
string
vereist

When the payment was created, as an ISO 8601 timestamp.

Voorbeeld:

"2026-01-01T12:00:00.000Z"

currency
enum<string>
vereist

The currency the payment settles in, lowercase ISO 4217. Every money field below is stated in it unless it says otherwise.

Beschikbare opties:
usd,
sgd,
inr,
aud,
brl,
cad,
dkk,
eur,
nok,
gbp,
sek,
chf,
hkd,
huf,
jpy,
mxn,
myr,
pln,
czk,
nzd,
aed,
eth,
ape,
cop,
ron,
thb,
bgn,
idr,
dop,
php,
try,
krw,
twd,
vnd,
pkr,
clp,
uyu,
ars,
zar,
dzd,
tnd,
mad,
kes,
kwd,
jod,
all,
xcd,
amd,
bsd,
bhd,
bob,
bam,
khr,
crc,
xof,
egp,
etb,
gmd,
ghs,
gtq,
gyd,
ils,
jmd,
mop,
mga,
mur,
mdl,
mnt,
nad,
ngn,
mkd,
omr,
pyg,
pen,
qar,
rwf,
sar,
rsd,
lkr,
tzs,
ttd,
uzs,
rub,
btc,
cny,
usdt,
kzt,
awg,
whop_usd,
xau,
hnl
Voorbeeld:

"usd"

customer_email
string | null
vereist

The buyer's email address. Null without member:email:read on the account or when the buyer has no assigned email.

Voorbeeld:

"marcus@shinetime.example"

customer_phone
string | null
vereist

The phone number the buyer gave at checkout, when one was collected.

Voorbeeld:

"+xxxxxxxxxxx"

decline_code
enum<string> | null
vereist

The normalized decline reason of the most recent failed attempt, or null.

Beschikbare opties:
insufficient_funds,
lost_card,
stolen_card,
expired_card,
suspected_fraud,
invalid_card_number,
invalid_cvc,
invalid_cvc_or_expiration,
incorrect_pin,
authentication_required,
card_not_supported,
currency_not_supported,
duplicate_transaction,
generic_decline,
invalid_account,
invalid_amount,
processing_error,
restricted_card,
card_velocity_exceeded,
contact_issuer,
card_declined_by_issuer,
bank_declined,
regulatory_blocked,
transaction_not_permitted,
transaction_stopped,
card_type_not_supported,
issuer_not_found,
closed_account,
issuer_unavailable,
invalid_zip,
invalid_expiry_month,
invalid_expiry_year,
invalid_expiry,
invalid_transaction,
cannot_authorize,
pin_required,
pin_try_exceeded,
provider_declined,
high_risk,
test_mode_decline,
merchant_blacklist,
reenter_transaction,
invalid_pin,
pin_required_as,
withdrawal_count_limit_exceeded,
invalid_country,
issuer_error,
invalid_card_holder_name,
no_accounts,
transaction_cancelled,
three_d_secure_success,
three_d_secure_canceled,
three_d_secure_invalid_card_number,
three_d_secure_generic_error,
three_d_secure_timeout,
three_d_secure_failed,
three_d_secure_card_not_enrolled,
three_d_secure_fraud,
three_d_secure_too_many_attempts,
three_d_secure_rejected_by_bank,
three_d_secure_reported_lost_or_stolen,
blocked_by_cardholder,
test_mode_test_card,
try_again_later,
transaction_not_allowed,
bank_insufficient_funds,
bank_account_not_found,
bank_account_closed,
bank_account_frozen,
bank_invalid_routing_number,
bank_non_transaction_account,
bank_authorization_revoked,
bank_payment_stopped,
bank_not_authorized,
bank_account_holder_deceased,
bank_duplicate,
bank_amount_error,
bank_regulatory_blocked,
bank_details_invalid,
bank_processing_error,
bank_generic_decline,
sepa_invalid_iban,
sepa_no_mandate,
sepa_mandate_data_invalid,
sepa_disputed,
sepa_refused_by_customer,
sepa_generic_decline
Voorbeeld:

"insufficient_funds"

dispute_alerted_at
string | null
vereist

When an issuer warned that this payment will be disputed, or null.

Voorbeeld:

null

dispute_created_at
string | null
vereist

When the most recent dispute on this payment was opened, as an ISO 8601 timestamp. Null when the payment was never disputed, or without the payment:dispute:read permission.

Voorbeeld:

null

failure_message
string | null
vereist

Why the most recent attempt failed, in plain words, or null.

Voorbeeld:

null

financing_installments_count
number | null
vereist

For installment methods, how many payments the charge splits into.

Voorbeeld:

null

holds
object[]
vereist
id
string
vereist

Payment ID, prefixed pay_.

Voorbeeld:

"pay_xxxxxxxxxxxxxx"

ip_address
string | null
vereist

The buyer's IP address at checkout: the one Whop's fraud screening identified, otherwise the one Whop captured from the buyer's browser at checkout. Null when the buyer was not present at checkout, such as a subscription renewal or a charge made without the buyer present, or when you read the payment as its buyer.

Voorbeeld:

null

last_payment_attempt_at
string | null
vereist

When the most recent charge attempt ran, or null.

Voorbeeld:

null

line_items
object[]
vereist
member_id
string | null
vereist

The buyer's member record on the account, prefixed mber_. Null without the member:basic:read permission, unless you are the buyer.

Voorbeeld:

"mber_xxxxxxxxxxxxxx"

membership_id
string | null
vereist

The membership this payment is billed against, prefixed mem_. Null for one-off purchases, or without the member:basic:read permission unless you are the buyer.

Voorbeeld:

"mem_xxxxxxxxxxxxxx"

metadata
object | null
vereist

Your own key-value data attached when the payment was created. Null when you read the payment as its buyer.

Voorbeeld:
missing_tracking
boolean | null
vereist

True for a paid payment with a shipping address, no shipment, and no full refund. Null without the shipment:basic:read permission.

Voorbeeld:

false

needs_tracking
boolean | null
vereist

True when funds are held until the order ships and no tracking number has been added yet. Null without the shipment:basic:read permission.

Voorbeeld:

false

next_payment_attempt_at
string | null
vereist

When the next automatic retry is scheduled, or null.

Voorbeeld:

null

paid_at
string | null
vereist

When the money was collected, or null while it has not been.

Voorbeeld:

"2026-01-01T12:00:00.000Z"

payment_instrument
object | null
vereist

The instrument shaped for display: a buyer-facing name, the standard icon set, and when it was a card, the card's brand, last four, issuer identification number, and the network transaction id the account uses for the card. The network transaction id is null when you read the payment as its buyer.

payment_method_id
string | null
vereist

The stored payment method that was charged, prefixed payt_. Null when the method was not saved.

Voorbeeld:

"payt_xxxxxxxxxxxxxx"

payment_method_type
enum<string> | null
vereist

The kind of instrument used, for example card, apple_pay, klarna, or us_bank_account.

Beschikbare opties:
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,
link,
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,
verve,
vipps,
webpay,
wechat_pay,
whop_pay,
yape,
zip,
coinflow,
unknown
Voorbeeld:

"acss_debit"

payment_rule_matches
object[]
vereist
payments_failed
number
vereist

How many charge attempts have failed on this payment.

Voorbeeld:

0

presentment_refunded_amount
object | null
vereist

How much has been refunded so far, in the currency presented to the buyer. Zero when nothing has been refunded.

presentment_tax_amount
object | null
vereist

The sales tax or VAT collected, in the currency presented to the buyer. Null when no tax applied.

presentment_total
object | null
vereist

The account-facing total in the currency presented to the buyer, before conversion into the settlement currency. Excludes buyer fees.

product_id
string | null
vereist

The product the variant belongs to, prefixed prod_. Null for a variant with no product.

Voorbeeld:

"prod_xxxxxxxxxxxxxx"

promo_code_id
string | null
vereist

The promo code applied at checkout, prefixed promo_, or null.

Voorbeeld:

null

quote_id
string | null
vereist

The payment quote this payment charged, prefixed pq_: its purchase, promo code and tax_amount are the quote's. Null when the payment named no quote and tax was calculated at charge time.

Voorbeeld:

null

recovery_url
string | null
vereist

Whop-hosted URL where the buyer can sign in and complete 3D Secure for an off-session charge the bank challenged — a subscription renewal or a saved-card payment. Null when recovery is unavailable, you lack member:basic:read, or in list responses. Retrieve the payment for it.

Voorbeeld:

null

refundable
boolean
vereist

True when the payment is paid, not yet fully refunded, and its processor supports refunds.

Voorbeeld:

false

refunded_amount
object | null
vereist

How much has been refunded so far, as it settled — refunds convert at the rate in force when each one was issued, not the payment's original rate.

refunded_at
string | null
vereist

When the payment was refunded, or null.

Voorbeeld:

null

response_due_at
string | null
vereist

When the earliest response is due on a dispute or Resolution Center case awaiting the account's response, as an ISO 8601 timestamp. Null when nothing awaits a response, or without the permission to read that dispute or case.

Voorbeeld:

null

retryable
boolean
vereist

True when the payment can be retried by hand with POST /payments/{id}/retry. The payment must be open and not paid through an invoice payment link. Its membership must be active, trialing, or past_due, or the payment must be a failed first payment on a drafted membership. Its one manual retry must not be used up. A retry can still be refused when the account cannot currently accept payments.

Voorbeeld:

true

risk_score
number | null
vereist

Whop's published risk index from 0 (lowest) to 100 (highest), including enforced decision floors. This is not a fraud probability. Null when no score is available or you read the payment as its buyer.

Voorbeeld:

null

risk_signals
object | null
vereist
verouderd

Deprecated. Risk score explanations are no longer provided; always null. DEPRECATED: Risk score explanations are no longer provided. Always null.

Voorbeeld:

null

settlement_time_at
string | null
vereist

When the portion not listed in holds posts to the account's available balance, at midnight UTC. The financial_activity.funds_available webhook's posted_at carries the same value when the settlement that clears it posts. Null until the payment is paid or when you read the payment as its buyer, and always null in list responses — retrieve the payment for it.

Voorbeeld:

null

shipment_id
string | null
vereist

The shipment fulfilling this payment, prefixed ship_. Null when nothing ships or without the shipment:basic:read permission.

Voorbeeld:

null

shipping_address
object | null
vereist

The shipping address for physical goods, or null.

status
enum<string>
vereist

The lifecycle state of the charge: open while collection is outstanding, paid once the money moved, pending while a settlement rail clears, void/uncollectible when it ended without collecting.

Beschikbare opties:
draft,
open,
authorized,
paid,
pending,
uncollectible,
unresolved,
void
Voorbeeld:

"draft"

substatus
enum<string>
vereist

The dashboard's finer-grained reading of the payment, folding in refunds, disputes and Resolution Center cases.

Beschikbare opties:
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,
open_dispute,
open_resolution
Voorbeeld:

"succeeded"

subtotal
object | null
vereist

The price before discounts, tax and fees.

tax_amount
object | null
vereist

The sales tax or VAT collected. Null when no tax applied.

tax_behavior
enum<string> | null
vereist

Whether tax_amount was added on top of the price (exclusive) or was already inside it (inclusive).

Beschikbare opties:
exclusive,
inclusive,
unspecified,
unable_to_collect
Voorbeeld:

"exclusive"

tax_refunded_amount
object
vereist

How much of the collected tax has been returned to the buyer so far. Zero when the payment carried no tax, or when nothing has been refunded.

three_ds_verified
boolean
vereist

True when the buyer completed 3D Secure for this payment.

Voorbeeld:

false

total
object | null
vereist

The account-facing total: the price after discounts, plus any tax added on top. Excludes buyer fees, which the buyer pays above this amount — so this is not necessarily what the buyer's statement shows; amount_charged is what the buyer is charged.

updated_at
string
vereist

When the payment last changed, as an ISO 8601 timestamp.

Voorbeeld:

"2026-01-01T12:00:00.000Z"

usd_total
object | null
vereist

The total converted to USD at the time of the charge, for reporting across currencies. Excludes the adaptive pricing FX markup, which the account does not keep. Null when you read the payment as its buyer.

user
object | null
vereist

The buyer. Null when the buyer is an account rather than a user.

user_agent
string | null
vereist

The buyer's browser user agent at checkout. Null when the buyer was not present at checkout, such as a subscription renewal, or without the member:basic:read permission.

Voorbeeld:

null

variant_id
string | null
vereist

The variant that was charged, prefixed plan_.

Voorbeeld:

"plan_xxxxxxxxxxxxxx"

verification_checks
object | null
vereist

The Address Verification Service (AVS), cardholder name, and Card Verification Value (CVV/CVC) results, or null when the processor returned none or you read the payment as its buyer.

voidable
boolean
vereist

True when the payment can be voided or canceled. The request is rejected if the payment is no longer eligible — see POST /payments/{id}/void.

Voorbeeld:

false

wuid
string | null
vereist

The Whop pixel's visitor ID for the buyer's browser at checkout, prefixed wuid_. Null when the checkout page had no Whop pixel, when the buyer was not present at checkout, or without the member:basic:read permission.

Voorbeeld:

null