confirmation_token for the method the buyer selected, or an off-session payment with an existing member’s stored payment method.
Use the Payments API to charge buyers, list and retrieve payments, and refund, void, capture, or retry them. Collection runs in the background, so the create response is not the outcome. Poll Retrieve status for how far the payment has gone and, while it is requires_action, what the buyer must do next: follow a redirect, complete 3D Secure, display transfer instructions, or link a bank account. Update the payment’s return_url to change where they land afterwards, up until they come back.
Endpoints
Attributes
What the account keeps: the total less Whop’s fees. Null when you read the payment as its buyer.
Properties
Properties
The amount in major units, as an exact decimal string. For example,
"10.00"
is ten dollars. It is a string so that no float rounds it in transit.How many decimal places the amount carries. This is the precision the charge
itself runs at.
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.Properties
Properties
The amount in major units, as an exact decimal string. For example,
"10.00"
is ten dollars. It is a string so that no float rounds it in transit.How many decimal places the amount carries. This is the precision the charge
itself runs at.
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.
The billing address the buyer entered, or null.
Properties
Properties
Why the charge was created: a first purchase, a renewal, a one-time payment,
or a manual charge.
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.
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.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.Available options: hosted_checkout, embedded_checkout, custom_checkout, modal_checkout, in_app_checkout, mobile_checkout, off_session, card_presentThe 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.
The currency the payment settles in, lowercase ISO 4217. Every money field below is stated in it unless it says otherwise.Available options:
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, hnlThe buyer’s email address. Null without
member:email:read on the account or
when the buyer has no assigned email.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.
The active holds on this payment. Each hold has its own release date, independent of
settlement_time_at. Empty when nothing is held or you read the payment as its buyer; released holds are omitted.Properties
Properties
The amount currently held, in the hold’s currency.
Properties
Properties
The amount in major units, as an exact decimal string. For example,
"10.00"
is ten dollars. It is a string so that no float rounds it in transit.How many decimal places the amount carries. This is the precision the charge
itself runs at.
The reserve percentage recorded when the hold was created, for example 3.5 for
3.5%. Null for other hold types or when no percentage was recorded.
When the held funds are scheduled to become available, as an ISO 8601
timestamp. Never earlier than the payment’s settlement date. Null when release
depends on an event, such as shipment resolution, rather than a date.
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.
Everything this payment charged for, in purchase order, with quantities and subtotals in the purchase currency. Payments made before item snapshots were recorded return the single item implied by their variant. Empty when no items or variant can be resolved.
Properties
Properties
Line item ID, prefixed
li_. Null when the payment predates item snapshots
and the item is read from the payment’s variant.The item’s name as shown at checkout (the product title, else the variant
title).
The product the variant belongs to, prefixed
prod_. On a payment that
predates item snapshots this falls back to the variant’s product, so it can be
set where the parent’s own product_id is null. Null for a variant with no
product.The variant’s stock keeping unit, free text set by the seller (e.g.
TSHIRT-LARGE-BLUE). Accounts with billing-reason SKU suffixes enabled
receive it stamped with why the charge happened: -S for a first subscription
charge, -R for a renewal, -C for a one-time purchase, -U when the
payment’s own metadata carries upsell: true, -F when nothing was charged.
Other billing reasons carry the bare SKU. null when the variant has no SKU
or has been deleted.The recorded amount for this item’s full quantity, before discounts, tax, and fees, in its purchase currency. Returns
null when no item amount was recorded.Properties
Properties
The amount in major units, as an exact decimal string. For example,
"10.00"
is ten dollars. It is a string so that no float rounds it in transit.How many decimal places the amount carries. This is the precision the charge
itself runs at.
The variant bought, prefixed
plan_. Null when the variant has since been
deleted.The buyer’s member record on the account, prefixed
mber_. Null without the
member:basic:read permission, unless you are the buyer.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.Your own key-value data attached when the payment was created. Null when you
read the payment as its buyer.
True for a paid payment with a shipping address, no shipment, and no full
refund. Null without the shipment:basic:read permission.
True when funds are held until the order ships and no tracking number has been
added yet. Null without the shipment:basic:read permission.
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.
Properties
Properties
Card payments only: the card’s network, last four, issuer identification number, expiry, and network transaction id.
Properties
Properties
The network identifier (
visa, amex, …), matching card.networks entries
and saved card payment methods. Null when the vault did not record the
network.The issuer identification number, also called the BIN: the card’s leading six
or eight digits, which identify the issuing bank. Null when the processor did
not report it.
The network transaction id this account uses for the card. It’s this account’s own id, from its first customer-present charge or verification on the card, when Whop has one. Otherwise it’s an earlier network transaction id for this card, which can come from another account’s transaction or be one brought with the card. Cite it as the prior transaction on a later merchant-initiated charge of this card at this account. Null until there is one. A webhook sent as a payment is first recorded can carry
null, so retrieve the payment to read it.Buyer-facing instrument name — “Visa •••• 4242” when the card surfaced, else
the method’s own name (“Klarna”).
The standard icon set: square and card shapes, each in light and dark colorways.
Properties
Properties
The credit-card-proportioned tile (48x30).
Properties
Properties
The square tile (32x32).
Properties
Properties
Installment methods only: how many payments the charge splits into. Data, not
copy — compose and translate the label client-side.
The stored payment method that was charged, prefixed
payt_. Null when the
method was not saved.The kind of instrument used, for example
card, apple_pay, klarna, or
us_bank_account.The account’s own payment rules that decided this payment, recorded when they ran. Only one action is taken per payment, so a rule that matched but was skipped or outranked is not listed. Empty when none decided it, when the account had no rules, when Whop blocked the payment before they ran, or when you read the payment as its buyer.
How much has been refunded so far, in the currency presented to the buyer. Zero when nothing has been refunded.
Properties
Properties
The amount in major units, as an exact decimal string. For example,
"10.00"
is ten dollars. It is a string so that no float rounds it in transit.How many decimal places the amount carries. This is the precision the charge
itself runs at.
The sales tax or VAT collected, in the currency presented to the buyer. Null when no tax applied.
Properties
Properties
The amount in major units, as an exact decimal string. For example,
"10.00"
is ten dollars. It is a string so that no float rounds it in transit.How many decimal places the amount carries. This is the precision the charge
itself runs at.
The account-facing total in the currency presented to the buyer, before conversion into the settlement currency. Excludes buyer fees.
Properties
Properties
The amount in major units, as an exact decimal string. For example,
"10.00"
is ten dollars. It is a string so that no float rounds it in transit.How many decimal places the amount carries. This is the precision the charge
itself runs at.
The product the variant belongs to, prefixed
prod_. Null for a variant with
no product.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.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.True when the payment is
paid, not yet fully refunded, and its processor
supports refunds.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.
Properties
Properties
The amount in major units, as an exact decimal string. For example,
"10.00"
is ten dollars. It is a string so that no float rounds it in transit.How many decimal places the amount carries. This is the precision the charge
itself runs at.
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.
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.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.
Deprecated. Risk score explanations are no longer provided; always null.
DEPRECATED: Risk score explanations are no longer provided. Always null.
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.The shipment fulfilling this payment, prefixed
ship_. Null when nothing
ships or without the shipment:basic:read permission.The shipping address for physical goods, or null.
Properties
Properties
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.Available options: draft, open, authorized, paid, pending, uncollectible, unresolved, voidThe dashboard’s finer-grained reading of the payment, folding in refunds, disputes and Resolution Center cases.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, open_dispute, open_resolutionThe price before discounts, tax and fees.
Properties
Properties
The amount in major units, as an exact decimal string. For example,
"10.00"
is ten dollars. It is a string so that no float rounds it in transit.How many decimal places the amount carries. This is the precision the charge
itself runs at.
The sales tax or VAT collected. Null when no tax applied.
Properties
Properties
The amount in major units, as an exact decimal string. For example,
"10.00"
is ten dollars. It is a string so that no float rounds it in transit.How many decimal places the amount carries. This is the precision the charge
itself runs at.
Whether
tax_amount was added on top of the price (exclusive) or was
already inside it (inclusive).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.
Properties
Properties
The amount in major units, as an exact decimal string. For example,
"10.00"
is ten dollars. It is a string so that no float rounds it in transit.How many decimal places the amount carries. This is the precision the charge
itself runs at.
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.Properties
Properties
The amount in major units, as an exact decimal string. For example,
"10.00"
is ten dollars. It is a string so that no float rounds it in transit.How many decimal places the amount carries. This is the precision the charge
itself runs at.
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.
Properties
Properties
The amount in major units, as an exact decimal string. For example,
"10.00"
is ten dollars. It is a string so that no float rounds it in transit.How many decimal places the amount carries. This is the precision the charge
itself runs at.
The buyer. Null when the buyer is an account rather than a user.
Properties
Properties
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.
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.
Properties
Properties
The Acquirer Reference Number (ARN) that traces this charge through the card
network, or null when the processor did not return one.
The card issuer’s authorization code for this charge, or null when the
processor did not return one.
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.Payment

