Introduction
Payins
Payouts
Identity
CRM
Engagement
Courses
Developer
Payment failed
Sent when a payment is failed
Required permissions:
payment:basic:readplan:basic:readaccess_pass:basic:readmember:email:readmember:basic:readmember:phone:readpromo_code:basic:readwebhook_receive:payments
Headers
The signature of the webhook request with the webhook version prepended
"v1,BASE64ENCODEDSIGNATURE"
The timestamp in seconds since the Unix epoch that the webhook was sent at on the server
"1727606400"
Body
A unique ID for every single webhook request
"msg_xxxxxxxxxxxxxxxxxxxxxxxx"
The API version for this webhook
"v1""v1"
The timestamp in ISO 8601 format that the webhook was sent at on the server
"2025-01-01T00:00:00.000Z"
The webhook event type
"payment.failed""payment.failed"
An object representing a receipt for a membership.
Show child attributes
Show child attributes
The payment ID
"pay_xxxxxxxxxxxxxx"
The current state of the payment.
draft, open, paid, pending, uncollectible, unresolved, void The friendly status of the payment.
auto_refunded, refunded, partially_refunded, dispute_warning, open_resolution, open_dispute, failed, price_too_low, succeeded, drafted, uncollectible, unresolved, past_due, pending, incomplete, canceled True only for payments that are paid, have not been fully refunded, and were processed by a payment processor that allows refunds.
True when the payment status is open and its membership is in one of the retry-eligible states (active, trialing, completed, or past_due); otherwise false. Used to decide if Whop can attempt the charge again.
True when the payment is tied to a membership in past_due, the payment status is open, and the processor allows voiding payments; otherwise false.
The datetime the payment was created
"2023-12-01T05:00:00.401Z"
The datetime the payment was paid
"2023-12-01T05:00:00.401Z"
The time of the last payment attempt.
"2023-12-01T05:00:00.401Z"
When an alert came in that this transaction will be disputed
"2023-12-01T05:00:00.401Z"
When the payment was refunded (if applicable).
"2023-12-01T05:00:00.401Z"
The user that made this payment.
Show child attributes
Show child attributes
The internal ID of the user.
"user_xxxxxxxxxxxxx"
The name of the user from their Whop account.
"John Doe"
The username of the user from their Whop account.
"johndoe42"
The email of the user
The membership attached to this payment.
The payment method used for the payment, if available.
Show child attributes
Show child attributes
The ID of the payment method
"payt_xxxxxxxxxxxxx"
The date and time the payment method was created
"2023-12-01T05:00:00.401Z"
The payment method type of the payment method
acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, apple_pay, au_becs_debit, bacs_debit, bancontact, billie, blik, boleto, card, cashapp, crypto, eps, fpx, giropay, google_pay, grabpay, ideal, kakao_pay, klarna, konbini, kr_card, link, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, pix, promptpay, revolut_pay, samsung_pay, satispay, sepa_debit, sofort, swish, twint, us_bank_account, wechat_pay, zip, bizum, capchase_pay, kriya, mondu, ng_wallet, paypay, sequra, scalapay, vipps, custom, customer_balance, gopay, mb_way, ng_bank, ng_bank_transfer, ng_card, ng_market, ng_ussd, paypal, payto, qris, rechnung, south_korea_market, kr_market, shopeepay, upi, sunbit, netbanking, id_bank_transfer, demo_pay, shop_pay, sezzle, coinbase, splitit, platform_balance, apple, venmo, unknown The card data associated with the payment method, if its a debit or credit card.
Show child attributes
Show child attributes
Card brand (e.g., VISA, MASTERCARD).
mastercard, visa, amex, discover, unionpay, jcb, diners, link, troy, visadankort, visabancontact, china_union_pay, rupay, jcbrupay, elo, maestro, unknown Last four digits of the card.
Card expiration month, like 03 for March.
42
Card expiration year, like 27 for 2027.
42
The promo code used for this payment.
Show child attributes
Show child attributes
The ID of the promo.
"promo_xxxxxxxxxxxx"
The specific code used to apply the promo at checkout.
The amount off (% or flat amount) for the promo.
6.9
The monetary currency of the promo code.
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 The type (% or flat amount) of the promo.
percentage, flat_amount The number of months the promo is applied for.
42
The currency of the payment.
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 The total to show to the creator (excluding buyer fees).
6.9
The subtotal to show to the creator (excluding buyer fees).
6.9
The total in USD to show to the creator (excluding buyer fees).
6.9
The payment refund amount(if applicable).
6.9
Whether this payment was auto refunded or not
How much the payment is for after fees
6.9
Card network reported by the processor (for example visa, mastercard, amex). Present only when the underlying payment method type is card.
mastercard, visa, amex, discover, unionpay, jcb, diners, link, troy, visadankort, visabancontact, china_union_pay, rupay, jcbrupay, elo, maestro, unknown The last 4 digits of the card used to make the payment.
The address of the user who made the payment.
Show child attributes
Show child attributes
The name of the customer.
The line 1 of the address.
The line 2 of the address.
The city of the address.
The state of the address.
The postal code of the address.
The country of the address.
Machine-readable identifier for the payment method used on the payment. Examples include card, cashapp ..., local methods such as ideal, sofort, ... BNPL options like klarna, affirm, ..., or crypto. Returns null when the processor does not supply a type.
acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, apple_pay, au_becs_debit, bacs_debit, bancontact, billie, blik, boleto, card, cashapp, crypto, eps, fpx, giropay, google_pay, grabpay, ideal, kakao_pay, klarna, konbini, kr_card, link, mobilepay, multibanco, naver_pay, nz_bank_account, oxxo, p24, pay_by_bank, payco, paynow, pix, promptpay, revolut_pay, samsung_pay, satispay, sepa_debit, sofort, swish, twint, us_bank_account, wechat_pay, zip, bizum, capchase_pay, kriya, mondu, ng_wallet, paypay, sequra, scalapay, vipps, custom, customer_balance, gopay, mb_way, ng_bank, ng_bank_transfer, ng_card, ng_market, ng_ussd, paypal, payto, qris, rechnung, south_korea_market, kr_market, shopeepay, upi, sunbit, netbanking, id_bank_transfer, demo_pay, shop_pay, sezzle, coinbase, splitit, platform_balance, apple, venmo, unknown The reason for the charge.
subscription_create, subscription_cycle, subscription_update, one_time, manual, subscription If the payment failed, the reason for the failure.
The custom metadata stored on this payment. This will be copied the checkout configuration for which this payment was made
Response
Return a 200 status to indicate that the data was received successfully
Was this page helpful?