Skip to main content
Cette ressource a un successeur dans l’API Whop. Cette page reste entièrement prise en charge.
number
requis
Le montant du paiement après déduction des fraisExemple : 6.9
object | null
requis
Les frais d’application prélevés sur ce paiement.
boolean
requis
Indique si ce paiement a été remboursé automatiquement ou non
object | null
requis
L’adresse de l’utilisateur qui a effectué le paiement.
BillingReasons | null
requis
La raison, lisible par une machine, pour laquelle ce débit a été créé, comme un achat d’abonnement initial, un cycle de renouvellement ou un paiement unique.Options disponibles : subscription_create, subscription_cycle, subscription_update, one_time, manual, subscription
CardBrands | null
requis
Réseau de carte indiqué par le processeur (par ex. ‘visa’, ‘mastercard’, ‘amex’). Présent uniquement lorsque le type de moyen de paiement est ‘card’.Options disponibles : 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
integer | null
requis
Le mois d’expiration (1-12) de la carte utilisée pour ce paiement. Se rabat sur la carte refusée pour les paiements échoués sans carte enregistrée. Null lorsque le paiement n’a pas été effectué par carte ou que la date d’expiration n’est pas disponible.Exemple : 6
integer | null
requis
L’année d’expiration à quatre chiffres de la carte utilisée pour ce paiement. Se rabat sur la carte refusée pour les paiements échoués sans carte enregistrée. Null lorsque le paiement n’a pas été effectué par carte ou que la date d’expiration n’est pas disponible.Exemple : 2027
string | null
requis
Les quatre derniers chiffres de la carte utilisée pour effectuer ce paiement. Null si le paiement n’a pas été effectué par carte.Exemple : 4242
string | null
requis
L’ID de la session/configuration de checkout qui a produit ce paiement, le cas échéant. Utilisez-le pour rattacher les paiements à la configuration de checkout qui les a créés.Exemple : ch_xxxxxxxxxxxxxxx
object | null
requis
L’entreprise associée au paiement.
string<date-time>
requis
La date et l’heure de création du paiement.Exemple : 2023-12-01T05:00:00.401Z
Currencies
requis
Le code de devise ISO à trois lettres de ce paiement (par ex. ‘usd’, ‘eur’).Options disponibles : 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
string | null
requis
Numéro de téléphone fourni par le client lors du checkout, ou son numéro de téléphone vérifié lorsque votre checkout exige une vérification du téléphone. null lorsqu’aucun numéro de téléphone n’a été collecté.
PaymentDeclineCodes | null
requis
La raison pour laquelle le paiement a été refusé. Null si le paiement n’a pas échoué.Options disponibles : 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
string<date-time> | null
requis
Moment où une alerte a signalé que cette transaction allait faire l’objet d’un litigeExemple : 2023-12-01T05:00:00.401Z
array<object> | null
requis
Les litiges rattachés à ce paiement. Null si l’acteur dans le contexte ne dispose pas de la permission payment:dispute:read.
string | null
requis
Si le paiement a échoué, la raison de l’échec.
array<object>
requis
Les frais associés à ce paiement spécifique.
integer | null
requis
Le nombre d’échéances de financement du paiement. Présent si le paiement est un paiement financé (par ex. Splitit, Klarna, etc.).Exemple : 42
array<object>
requis
Les transactions de financement rattachées à ce paiement. Présent si le paiement est un paiement financé (par ex. Splitit, Klarna, etc.).
string
requis
L’identifiant unique du paiement.Exemple : pay_xxxxxxxxxxxxxx
string<date-time> | null
requis
L’heure de la dernière tentative de paiement.Exemple : 2023-12-01T05:00:00.401Z
object | null
requis
Le membre rattaché à ce paiement.
object | null
requis
L’abonnement rattaché à ce paiement.
object | null
requis
Les métadonnées personnalisées stockées sur ce paiement. Elles seront copiées dans la configuration de checkout pour laquelle ce paiement a été effectué
boolean | null
requis
Indique si ce paiement retient les fonds jusqu’à l’expédition de la commande et n’a pas encore de numéro de suivi.
string<date-time> | null
requis
L’heure de la prochaine nouvelle tentative de paiement planifiée.Exemple : 2023-12-01T05:00:00.401Z
string<date-time> | null
requis
Le moment où ce paiement a été encaissé avec succès. Null si le paiement n’a pas encore abouti. Sous forme de timestamp Unix.Exemple : 2023-12-01T05:00:00.401Z
object | null
requis
L’instrument avec lequel ce paiement a été effectué, mis en forme pour l’affichage : le type de moyen de paiement, un nom destiné à l’acheteur, le jeu d’icônes standard et les informations de la carte lorsqu’il s’agissait d’une carte. Null lorsque le reçu ne mentionne aucun moyen de paiement.
object | null
requis
La référence tokenisée du moyen de paiement utilisée pour ce paiement. Null si aucun token n’a été utilisé.
PaymentMethodTypes | null
requis
Le type d’instrument de paiement utilisé pour ce paiement (par ex. carte, Cash App, iDEAL, Klarna, crypto). Null lorsque le processeur ne fournit pas de type.Options disponibles : 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
integer | null
requis
Le nombre de tentatives de paiement échouées pour le paiement.Exemple : 42
object | null
requis
Le plan rattaché à ce paiement.
object | null
requis
Le produit pour lequel ce paiement a été effectué
object | null
requis
Le code promo utilisé pour ce paiement.
string | null
requis
URL hébergée par Whop où l’acheteur peut se connecter et effectuer l’authentification 3D Secure pour un débit hors session contesté par la banque — un renouvellement d’abonnement ou un paiement par carte enregistrée. null lorsque la récupération n’est pas disponible ou que vous n’avez pas member:basic:read.
boolean
requis
True uniquement pour les paiements qui sont paid, n’ont pas été entièrement remboursés et ont été traités par un processeur de paiement qui autorise les remboursements.
number | null
requis
Le montant remboursé du paiement (le cas échéant).Exemple : 6.9
string<date-time> | null
requis
Le moment où le paiement a été remboursé (le cas échéant).Exemple : 2023-12-01T05:00:00.401Z
array<object>
requis
Les remboursements émis sur ce paiement, du plus récent au plus ancien, y compris les tentatives de remboursement échouées et annulées. Limité aux 100 plus récents.
array<object> | null
requis
Les dossiers du centre de résolution ouverts par le client sur ce paiement. Null si l’acteur dans le contexte ne dispose pas de la permission payment:resolution_center_case:read.
boolean
requis
True lorsque le paiement est open, que son processeur peut être débité à nouveau, que son abonnement est active, trialing ou past_due (ou qu’il s’agit d’un paiement initial échoué sur un abonnement drafted), qu’il n’est pas payé via un lien de facture et que son unique nouvelle tentative manuelle n’a pas été utilisée. Sert à déterminer si le paiement peut être retenté manuellement. Une nouvelle tentative peut tout de même être refusée lorsque l’entreprise ne peut pas accepter de paiements.
integer | null
requis
Le score de risque de fraude interne de Whop pour ce paiement, de 0 (risque le plus faible) à 100 (risque le plus élevé). Null lorsque le paiement n’a pas été évalué ou que l’évaluation n’est pas encore terminée.Exemple : 42
object | null
requis
Obsolète. Toujours null.
number
requis
Le montant total débité au client pour ce paiement, taxes comprises et après application des remises. Dans la devise spécifiée par le champ currency.Exemple : 6.9
Currencies
requis
Le code de devise ISO à trois lettres de ce paiement (par ex. ‘usd’, ‘eur’).Options disponibles : 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
number | null
requis
Obsolète. Renvoie toujours null.Exemple : 6.9
string<date-time> | null
requis
Moment où les fonds de ce paiement sont crédités sur le solde disponible de l’entreprise, à minuit UTC. Connu au moment du paiement et ne change jamais. Le champ posted_at du webhook financial_activity.funds_available porte la même valeur lorsque le règlement qui les libère est comptabilisé — faites-les correspondre pour savoir que ces fonds peuvent désormais être retirés.Exemple : 2023-12-01T05:00:00.401Z
object | null
requis
L’expédition rattachée à ce paiement.
object | null
requis
L’adresse de livraison fournie par le client pour les biens physiques. Null si aucune adresse de livraison n’a été collectée.
string | null
requis
Le SKU (unité de gestion de stock) de la variante facturée par ce paiement (le premier article, dans le cas d’un panier), tel que défini par le vendeur. Les comptes pour lesquels les suffixes de SKU selon le motif de facturation sont activés le reçoivent suffixé selon la raison du débit : -S pour un premier débit d’abonnement, -R pour un renouvellement, -C pour un achat unique, -U lorsque les métadonnées du paiement lui-même contiennent upsell: true, -F lorsque rien n’a été débité. Les autres motifs de facturation portent le SKU brut. Null lorsque la variante n’a pas de SKU.
ReceiptStatus | null
requis
L’état actuel du cycle de vie de ce paiement (par ex. ‘draft’, ‘open’, ‘paid’, ‘void’).Options disponibles : draft, open, authorized, paid, pending, uncollectible, unresolved, void
FriendlyReceiptStatus
requis
Le statut lisible du paiement.Options disponibles : 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
number | null
requis
Le sous-total à afficher au créateur (hors frais acheteur).Exemple : 6.9
number | null
requis
Le montant calculé de la taxe de vente/TVA (le cas échéant).Exemple : 6.9
ReceiptTaxBehaviors | null
requis
Le type d’inclusion de taxe appliqué au paiement, permettant de déterminer si la taxe est incluse dans le prix final ou payée en sus.Options disponibles : exclusive, inclusive, unspecified, unable_to_collect
number | null
requis
Le montant de taxe qui a été remboursé (le cas échéant).Exemple : 6.9
boolean
requis
Indique si l’authentification 3D Secure a été effectuée pour ce paiement.
number | null
requis
Le total à afficher au créateur (hors frais acheteur).Exemple : 6.9
string<date-time>
requis
La date et l’heure de la dernière mise à jour du paiement.Exemple : 2023-12-01T05:00:00.401Z
number | null
requis
Le total en USD à afficher au créateur (hors frais acheteur).Exemple : 6.9
object | null
requis
L’utilisateur qui a effectué ce paiement.
object | null
requis
Les résultats des vérifications de l’adresse et du code de sécurité de la carte par l’émetteur pour ce paiement. Null lorsque le processeur n’en a renvoyé aucun.
boolean
requis
True lorsque le paiement peut être annulé. La requête est rejetée si le paiement n’est plus éligible.