Retry payment
Retry a failed or pending payment. This re-attempts the charge using the original payment method and plan details.
Required permissions:
payment:manageplan:basic:readaccess_pass:basic:readmember:email:readmember:basic:readmember:phone:readpromo_code:basic:readpayment:dispute:readpayment:resolution_center_case:read
Authorizations
A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************
Path Parameters
The unique identifier of the payment to retry.
"pay_xxxxxxxxxxxxxx"
Response
A successful response
A payment represents a completed or attempted charge. Payments track the amount, status, currency, and payment method used.
How much the payment is for after fees
6.9
The application fee charged on this payment.
Whether this payment was auto refunded or not
The address of the user who made the payment.
The machine-readable reason this charge was created, such as initial subscription purchase, renewal cycle, or one-time payment.
subscription_create, subscription_cycle, subscription_update, one_time, manual, subscription Card network reported by the processor (e.g., 'visa', 'mastercard', 'amex'). Present only when the payment method type is 'card'.
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, unknown The last four digits of the card used to make this payment. Null if the payment was not made with a card.
"4242"
The ID of the checkout session/configuration that produced this payment, if any. Use this to map payments back to the checkout configuration that created them.
The company for the payment.
The datetime the payment was created.
"2023-12-01T05:00:00.401Z"
The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
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 When an alert came in that this transaction will be disputed
"2023-12-01T05:00:00.401Z"
The disputes attached to this payment. Null if the actor in context does not have the payment:dispute:read permission.
If the payment failed, the reason for the failure.
The number of financing installments for the payment. Present if the payment is a financing payment (e.g. Splitit, Klarna, etc.).
42
The financing transactions attached to this payment. Present if the payment is a financing payment (e.g. Splitit, Klarna, etc.).
The unique identifier for the payment.
"pay_xxxxxxxxxxxxxx"
The time of the last payment attempt.
"2023-12-01T05:00:00.401Z"
The member attached to this payment.
The membership attached to this payment.
The custom metadata stored on this payment. This will be copied over to the checkout configuration for which this payment was made
The time of the next schedule payment retry.
"2023-12-01T05:00:00.401Z"
The time at which this payment was successfully collected. Null if the payment has not yet succeeded. As a Unix timestamp.
"2023-12-01T05:00:00.401Z"
The tokenized payment method reference used for this payment. Null if no token was used.
The type of payment instrument used for this payment (e.g., card, Cash App, iDEAL, Klarna, crypto). Null when the processor does not supply a type.
acss_debit, affirm, afterpay_clearpay, alipay, alma, amazon_pay, apple, apple_pay, au_bank_transfer, au_becs_debit, bacs_debit, bancolombia, bancontact, billie, bizum, blik, boleto, bre_b, ca_bank_transfer, capchase_pay, card, card_installments_three, card_installments_six, card_installments_twelve, cashapp, claritypay, coinbase, crypto, custom, customer_balance, demo_pay, efecty, eps, eu_bank_transfer, fpx, gb_bank_transfer, giropay, google_pay, gopay, grabpay, id_bank_transfer, ideal, interac, kakao_pay, klarna, klarna_pay_now, konbini, kr_card, kr_market, kriya, kueski, link, mb_way, m_pesa, mercado_pago, mobilepay, mondu, multibanco, naver_pay, nequi, netbanking, ng_bank, ng_bank_transfer, ng_card, ng_market, ng_ussd, ng_wallet, nz_bank_account, oxxo, p24, pago_efectivo, pse, pay_by_bank, payco, paynow, paypal, paypay, payto, pix, platform_balance, promptpay, qris, rechnung, revolut_pay, samsung_pay, satispay, scalapay, sencillito, sepa_debit, sequra, servipag, sezzle, shop_pay, shopeepay, sofort, south_korea_market, spei, splitit, sunbit, swish, tamara, twint, upi, us_bank_account, us_bank_transfer, venmo, vipps, webpay, wechat_pay, yape, zip, coinflow, unknown The number of failed payment attempts for the payment.
42
The plan attached to this payment.
The product this payment was made for
The promo code used for this payment.
True only for payments that are paid, have not been fully refunded, and were processed by a payment processor that allows refunds.
The payment refund amount(if applicable).
6.9
When the payment was refunded (if applicable).
"2023-12-01T05:00:00.401Z"
The refunds issued against this payment, newest first, including failed and canceled refund attempts. Limited to the 100 most recent.
The resolution center cases opened by the customer on this payment. Null if the actor in context does not have the payment:resolution_center_case:read permission.
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.
Whop's in-house fraud risk score for this payment, from 0 (lowest risk) to 100 (highest risk). Null when the payment has not been scored or scoring has not yet completed.
42
A curated set of factors behind the risk score, grouped by category (business transaction history, buyer, device). Each entry has a key, human-readable label, category, and value. Null when there is no risk assessment for this payment.
The total amount charged to the customer for this payment, including taxes and after any discounts. In the currency specified by the currency field.
6.9
The three-letter ISO currency code for this payment (e.g., 'usd', 'eur').
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 Deprecated. Always returns null.
6.9
The shipping address provided by the customer for physical goods. Null if no shipping address was collected.
The current lifecycle state of this payment (e.g., 'draft', 'open', 'paid', 'void').
draft, open, paid, pending, uncollectible, unresolved, void The friendly status of the payment.
succeeded, pending, failed, 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 The subtotal to show to the creator (excluding buyer fees).
6.9
The calculated amount of the sales/VAT tax (if applicable).
6.9
The type of tax inclusivity applied to the payment, for determining whether the tax is included in the final price, or paid on top.
exclusive, inclusive, unspecified, unable_to_collect The amount of tax that has been refunded (if applicable).
6.9
Whether 3D Secure authentication was completed for this payment.
The total to show to the creator (excluding buyer fees).
6.9
The datetime the payment was last updated.
"2023-12-01T05:00:00.401Z"
The total in USD to show to the creator (excluding buyer fees).
6.9
The user that made this payment.
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.

