Skip to main content
Créez un paiement en session avec un confirmation_token pour le moyen de paiement choisi par l’acheteur, ou un paiement hors session avec le moyen de paiement enregistré d’un membre existant. Utilisez l’API Payments pour débiter des acheteurs, lister et récupérer des paiements, et les rembourser, les annuler, les capturer ou les retenter. L’encaissement s’exécute en arrière-plan, la réponse de création ne constitue donc pas le résultat. Interrogez régulièrement Récupérer le statut pour savoir où en est le paiement et, tant qu’il est requires_action, ce que l’acheteur doit faire ensuite : suivre une redirection, effectuer l’authentification 3D Secure, afficher les instructions de virement ou lier un compte bancaire. Mettez à jour le return_url du paiement pour modifier la page sur laquelle il arrive ensuite, jusqu’à son retour.

Endpoints

Attributs

string
requis
ID du paiement, préfixé par pay_.
string | null
requis
Le compte qui a reçu le paiement, préfixé par biz_.
object | null
requis
Ce que conserve le compte : le total moins les frais de Whop. Null lorsque vous lisez le paiement en tant qu’acheteur.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse en transit.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales que comporte le montant. Il s’agit de la précision avec laquelle le paiement lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est facturé en centavos mais écrit en pesos entiers, donc les valeurs sont 2 et 0. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.
object
requis
Ce qui est facturé à l’acheteur pour ce paiement : le total plus les éventuels frais à la charge de l’acheteur, dans la devise dans laquelle l’acheteur paie. Les remboursements ne le réduisent pas ; presentment_refunded_amount les indique dans la même devise.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse en transit.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales que comporte le montant. Il s’agit de la précision avec laquelle le paiement lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est facturé en centavos mais écrit en pesos entiers, donc les valeurs sont 2 et 0. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.
string | null
requis
Date à laquelle Whop capturera automatiquement ce paiement par carte autorisé, sauf s’il est annulé avant, sous forme d’horodatage ISO 8601. Null lorsqu’aucune capture automatique n’a été demandée.
boolean
requis
True lorsque Whop a remboursé le paiement automatiquement, par exemple suite à une alerte de litige.
object | null
requis
L’adresse de facturation saisie par l’acheteur, ou null.

Propriétés

string | null
requis
La ville.
string | null
requis
Le code pays ISO 3166-1 alpha-2.
string | null
requis
La première ligne de l’adresse postale.
string | null
requis
La deuxième ligne de l’adresse postale.
string | null
requis
Le nom figurant sur l’adresse.
string | null
requis
Le code postal.
string | null
requis
L’État, la province ou la région.
string | null
requis
La raison de la création du débit : un premier achat, un renouvellement, un paiement unique ou un débit manuel.
string | null
requis
Date d’expiration de la préautorisation de ce paiement par carte autorisé s’il n’est pas capturé avant, sous forme d’horodatage ISO 8601. Null lorsque le paiement n’a pas été créé pour une capture ultérieure.
string | null
requis
La configuration de checkout via laquelle l’acheteur a payé, préfixée par ch_, ou null.
string | null
requis
Le schéma et l’hôte du site web sur lequel l’acheteur a ouvert le checkout, par exemple https://store.example.com. Utilisez-le pour distinguer les paiements provenant de différents sites web d’un même compte. Null lorsque le site web n’a pas été enregistré, y compris pour les paiements effectués en l’absence de l’acheteur.
string | null
requis
L’expérience de checkout à l’origine de ce paiement, comme embedded_checkout pour un checkout sur le propre site web du compte ou off_session pour un renouvellement d’abonnement. Null lorsque le checkout n’a pas été enregistré.Options disponibles : hosted_checkout, embedded_checkout, custom_checkout, modal_checkout, in_app_checkout, mobile_checkout, off_session, card_present
string | null
requis
L’identifiant que présente l’interface de l’acheteur pour interroger ce paiement, définir son URL de retour et le reprendre lorsque la banque a demandé au client de s’authentifier. Uniquement sur les paiements créés à partir d’un jeton de confirmation ou en attente de cette authentification, null lorsque vous lisez le paiement en tant qu’acheteur, et toujours null dans les réponses de liste — récupérez le paiement pour l’obtenir.
string
requis
Date de création du paiement, sous forme d’horodatage ISO 8601.
string
requis
La devise dans laquelle le paiement est réglé, en code ISO 4217 minuscule. Chaque champ monétaire ci-dessous est exprimé dans cette devise, sauf indication contraire.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
L’adresse e-mail de l’acheteur. Null sans member:email:read sur le compte ou lorsqu’aucune adresse e-mail n’est attribuée à l’acheteur.
string | null
requis
Le numéro de téléphone fourni par l’acheteur lors du checkout, lorsqu’il a été collecté.
string | null
requis
Le motif de refus normalisé de la tentative échouée la plus récente, ou null.
string | null
requis
Date à laquelle un émetteur a averti que ce paiement allait être contesté, ou null.
string | null
requis
Date d’ouverture du litige le plus récent sur ce paiement, sous forme d’horodatage ISO 8601. Null lorsque le paiement n’a jamais été contesté, ou sans la permission payment:dispute:read.
string | null
requis
La raison de l’échec de la tentative la plus récente, en termes simples, ou null.
number | null
requis
Pour les moyens de paiement échelonné, le nombre de paiements en lesquels le débit est divisé.
object[]
requis
Les retenues actives sur ce paiement. Chaque retenue a sa propre date de libération, indépendante de settlement_time_at. Vide lorsque rien n’est retenu ou lorsque vous lisez le paiement en tant qu’acheteur ; les retenues libérées sont omises.

Propriétés

object
requis
Le montant actuellement retenu, dans la devise de la retenue.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse en transit.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales que comporte le montant. Il s’agit de la précision avec laquelle le paiement lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est facturé en centavos mais écrit en pesos entiers, donc les valeurs sont 2 et 0. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.
number | null
requis
Le pourcentage de réserve enregistré lors de la création de la retenue, par exemple 3.5 pour 3,5 %. Null pour les autres types de retenue ou lorsqu’aucun pourcentage n’a été enregistré.
string | null
requis
Date à laquelle les fonds retenus doivent devenir disponibles, sous forme d’horodatage ISO 8601. Jamais antérieure à la date de règlement du paiement. Null lorsque la libération dépend d’un événement, comme la résolution d’une expédition, plutôt que d’une date.
string
requis
La raison pour laquelle les fonds sont retenus : reserve, bnpl, sequra, fraud_hold ou preshipment_hold.Options disponibles : reserve, bnpl, sequra, fraud_hold, preshipment_hold
string | null
requis
L’adresse IP de l’acheteur lors du checkout : celle identifiée par le filtrage anti-fraude de Whop, sinon celle que Whop a capturée depuis le navigateur de l’acheteur lors du checkout. Null lorsque l’acheteur n’était pas présent lors du checkout, comme pour un renouvellement d’abonnement ou un débit effectué en l’absence de l’acheteur, ou lorsque vous lisez le paiement en tant qu’acheteur.
string | null
requis
Date de la tentative de débit la plus récente, ou null.
object[]
requis
Tout ce que ce paiement a facturé, dans l’ordre d’achat, avec les quantités et sous-totaux dans la devise d’achat. Les paiements effectués avant l’enregistrement des instantanés d’articles renvoient l’article unique déduit de leur variante. Vide lorsqu’aucun article ni aucune variante ne peut être déterminé.

Propriétés

string | null
requis
ID de la ligne d’article, préfixé par li_. Null lorsque le paiement est antérieur aux instantanés d’articles et que l’article est lu à partir de la variante du paiement.
string | null
requis
Le nom de l’article tel qu’affiché lors du checkout (le titre du produit, sinon le titre de la variante).
string | null
requis
Le produit auquel appartient la variante, préfixé par prod_. Sur un paiement antérieur aux instantanés d’articles, la valeur se rabat sur le produit de la variante ; elle peut donc être renseignée alors que le product_id du parent est null. Null pour une variante sans produit.
string | null
requis
Le titre actuel du produit, ou null lorsque l’article n’a pas de produit.
number
requis
Nombre d’unités achetées.
string | null
requis
La référence de stock (SKU) de la variante, texte libre défini par le vendeur (par ex. TSHIRT-LARGE-BLUE). Les comptes ayant activé les suffixes de SKU selon le motif de facturation la reçoivent marquée de 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 contiennent upsell: true, -F lorsque rien n’a été facturé. Les autres motifs de facturation portent le SKU brut. null lorsque la variante n’a pas de SKU ou a été supprimée.
object | null
requis
Le montant enregistré pour la quantité totale de cet article, avant remises, taxes et frais, dans sa devise d’achat. Renvoie null lorsqu’aucun montant d’article n’a été enregistré.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse en transit.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales que comporte le montant. Il s’agit de la précision avec laquelle le paiement lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est facturé en centavos mais écrit en pesos entiers, donc les valeurs sont 2 et 0. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.
string | null
requis
La variante achetée, préfixée par plan_. Null lorsque la variante a depuis été supprimée.
string | null
requis
Le titre actuel de la variante, ou null lorsque la variante a été supprimée ou n’a pas de titre.
string | null
requis
La fiche membre de l’acheteur sur le compte, préfixée par mber_. Null sans la permission member:basic:read, sauf si vous êtes l’acheteur.
string | null
requis
L’abonnement sur lequel ce paiement est facturé, préfixé par mem_. Null pour les achats ponctuels, ou sans la permission member:basic:read sauf si vous êtes l’acheteur.
object | null
requis
Vos propres données clé-valeur associées lors de la création du paiement. Null lorsque vous lisez le paiement en tant qu’acheteur.
boolean | null
requis
True pour un paiement réglé avec une adresse de livraison, sans expédition et sans remboursement intégral. Null sans la permission shipment:basic:read.
boolean | null
requis
True lorsque les fonds sont retenus jusqu’à l’expédition de la commande et qu’aucun numéro de suivi n’a encore été ajouté. Null sans la permission shipment:basic:read.
string | null
requis
Date de la prochaine nouvelle tentative automatique programmée, ou null.
string | null
requis
Date d’encaissement de l’argent, ou null tant qu’il n’a pas été encaissé.
object | null
requis
L’instrument de paiement mis en forme pour l’affichage : un nom destiné à l’acheteur, le jeu d’icônes standard et, s’il s’agissait d’une carte, la marque de la carte, ses quatre derniers chiffres, son numéro d’identification de l’émetteur et l’id de transaction réseau que le compte utilise pour la carte. L’id de transaction réseau est null lorsque vous lisez le paiement en tant qu’acheteur.

Propriétés

object | null
requis
Paiements par carte, Apple Pay et Google Pay uniquement : le réseau de la carte, ses quatre derniers chiffres, son numéro d’identification de l’émetteur, sa date d’expiration et l’id de transaction réseau.

Propriétés

string | null
requis
L’identifiant du réseau (visa, amex, …), correspondant aux entrées de card.networks et aux moyens de paiement par carte enregistrés. Null lorsque le coffre-fort n’a pas enregistré le réseau.
number | null
requis
Le mois d’expiration de la carte, de 1 à 12. Null lorsque le coffre-fort ne l’a pas enregistré.
number | null
requis
L’année d’expiration de la carte, sur quatre chiffres. Null lorsque le coffre-fort ne l’a pas enregistrée.
string | null
requis
Le numéro d’identification de l’émetteur, également appelé BIN : les six ou huit premiers chiffres de la carte, qui identifient la banque émettrice. Null lorsque le processeur ne l’a pas communiqué.
string | null
requis
Les quatre derniers chiffres de la carte, lorsqu’ils ont été capturés.
string | null
requis
L’id de transaction réseau que ce compte utilise pour la carte. Il s’agit de l’id propre à ce compte, issu de son premier débit ou de sa première vérification en présence du client sur la carte, lorsque Whop en dispose. Sinon, il s’agit d’un id de transaction réseau antérieur pour cette carte, qui peut provenir de la transaction d’un autre compte ou avoir été apporté avec la carte. Citez-le comme transaction antérieure lors d’un débit ultérieur initié par le marchand sur cette carte pour ce compte. Null tant qu’il n’y en a pas. Un webhook envoyé lors du premier enregistrement d’un paiement peut contenir null ; récupérez donc le paiement pour le lire.
string
requis
Nom de l’instrument destiné à l’acheteur — “Visa •••• 4242” lorsque la carte est connue, sinon le nom propre du moyen de paiement (“Klarna”).
object
requis
Le jeu d’icônes standard : formes carrée et carte, chacune en variantes de couleur claire et sombre.

Propriétés

object
requis
La vignette aux proportions d’une carte bancaire (48x30).

Propriétés

object
requis
La variante de couleur pour les surfaces sombres.

Propriétés

string
requis
Image matricielle de secours à la taille native de la forme.
string
requis
Image matricielle de secours en double densité.
string
requis
Image matricielle de secours en quadruple densité.
string
requis
Le fichier vectoriel. Privilégiez-le partout où le SVG est pris en charge.
object
requis
La variante de couleur pour les surfaces claires.

Propriétés

string
requis
Image matricielle de secours à la taille native de la forme.
string
requis
Image matricielle de secours en double densité.
string
requis
Image matricielle de secours en quadruple densité.
string
requis
Le fichier vectoriel. Privilégiez-le partout où le SVG est pris en charge.
object
requis
La vignette carrée (32x32).

Propriétés

object
requis
La variante de couleur pour les surfaces sombres.

Propriétés

string
requis
Image matricielle de secours à la taille native de la forme.
string
requis
Image matricielle de secours en double densité.
string
requis
Image matricielle de secours en quadruple densité.
string
requis
Le fichier vectoriel. Privilégiez-le partout où le SVG est pris en charge.
object
requis
La variante de couleur pour les surfaces claires.

Propriétés

string
requis
Image matricielle de secours à la taille native de la forme.
string
requis
Image matricielle de secours en double densité.
string
requis
Image matricielle de secours en quadruple densité.
string
requis
Le fichier vectoriel. Privilégiez-le partout où le SVG est pris en charge.
number | null
requis
Moyens de paiement échelonné uniquement : le nombre de paiements en lesquels le débit est divisé. Il s’agit d’une donnée, pas d’un texte — composez et traduisez le libellé côté client.
string
requis
L’identifiant du type de moyen de paiement, par ex. card, klarna, apple_pay.
string | null
requis
Le moyen de paiement enregistré qui a été débité, préfixé par payt_. Null lorsque le moyen de paiement n’a pas été enregistré.
string | null
requis
Le type d’instrument utilisé, par exemple card, apple_pay, klarna ou us_bank_account.
object[]
requis
Les règles de paiement propres au compte qui ont tranché ce paiement, enregistrées lors de leur exécution. Une seule action est appliquée par paiement ; une règle qui correspondait mais a été ignorée ou supplantée n’est donc pas listée. Vide lorsqu’aucune ne l’a tranché, lorsque le compte n’avait aucune règle, lorsque Whop a bloqué le paiement avant leur exécution, ou lorsque vous lisez le paiement en tant qu’acheteur.

Propriétés

string
requis
ID de la règle de paiement, préfixé par prule_.
string
requis
Ce que la règle a demandé.Options disponibles : allow, block, review, enforce_3ds
string | null
requis
Le nom de la règle au moment où elle a correspondu. Renommer la règle par la suite ne modifie pas cette valeur.
number
requis
Nombre de tentatives de débit ayant échoué sur ce paiement.
object | null
requis
Le montant remboursé jusqu’à présent, dans la devise présentée à l’acheteur. Zéro lorsque rien n’a été remboursé.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse en transit.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales que comporte le montant. Il s’agit de la précision avec laquelle le paiement lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est facturé en centavos mais écrit en pesos entiers, donc les valeurs sont 2 et 0. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.
object | null
requis
La taxe sur les ventes ou la TVA collectée, dans la devise présentée à l’acheteur. Null lorsqu’aucune taxe ne s’appliquait.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse en transit.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales que comporte le montant. Il s’agit de la précision avec laquelle le paiement lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est facturé en centavos mais écrit en pesos entiers, donc les valeurs sont 2 et 0. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.
object | null
requis
Le total côté compte dans la devise présentée à l’acheteur, avant conversion dans la devise de règlement. Exclut les frais à la charge de l’acheteur.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse en transit.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales que comporte le montant. Il s’agit de la précision avec laquelle le paiement lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est facturé en centavos mais écrit en pesos entiers, donc les valeurs sont 2 et 0. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.
string | null
requis
Le produit auquel appartient la variante, préfixé par prod_. Null pour une variante sans produit.
string | null
requis
Le code promo appliqué lors du checkout, préfixé par promo_, ou null.
string | null
requis
Le devis de paiement facturé par ce paiement, préfixé par pq_ : son achat, son code promo et son tax_amount sont ceux du devis. Null lorsque le paiement ne mentionnait aucun devis et que la taxe a été calculée au moment du débit.
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 pour lequel la banque a demandé une authentification — un renouvellement d’abonnement ou un paiement par carte enregistrée. Null lorsque la récupération n’est pas disponible, que vous ne disposez pas de member:basic:read, ou dans les réponses de liste. Récupérez le paiement pour l’obtenir.
boolean
requis
True lorsque le paiement est paid, pas encore intégralement remboursé, et que son processeur prend en charge les remboursements.
object | null
requis
Le montant remboursé jusqu’à présent, tel qu’il a été réglé — les remboursements sont convertis au taux en vigueur au moment de l’émission de chacun, et non au taux d’origine du paiement.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse en transit.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales que comporte le montant. Il s’agit de la précision avec laquelle le paiement lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est facturé en centavos mais écrit en pesos entiers, donc les valeurs sont 2 et 0. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.
string | null
requis
Date du remboursement du paiement, ou null.
string | null
requis
Date limite de la réponse la plus proche pour un litige ou un dossier du Resolution Center attendant la réponse du compte, sous forme d’horodatage ISO 8601. Null lorsque rien n’attend de réponse, ou sans la permission de lire ce litige ou ce dossier.
boolean
requis
True lorsque le paiement peut être retenté manuellement avec POST /payments/\{id} /retry. Le paiement doit être open et ne pas avoir été payé via un lien de paiement de facture. Son abonnement doit être active, trialing ou past_due, ou le paiement doit être un premier paiement échoué sur un abonnement drafted. Son unique nouvelle tentative manuelle ne doit pas avoir été utilisée. Une nouvelle tentative peut tout de même être refusée lorsque le compte ne peut pas accepter de paiements actuellement.
number | null
requis
L’indice de risque publié par Whop, de 0 (le plus bas) à 100 (le plus élevé), seuils de décision appliqués inclus. Il ne s’agit pas d’une probabilité de fraude. Null lorsqu’aucun score n’est disponible ou lorsque vous lisez le paiement en tant qu’acheteur.
object | null
requis
Obsolète. Les explications du score de risque ne sont plus fournies ; toujours null. OBSOLÈTE : les explications du score de risque ne sont plus fournies. Toujours null.
string | null
requis
Date à laquelle la part non listée dans holds est créditée sur le solde disponible du compte, à minuit UTC. Le posted_at du webhook financial_activity.funds_available contient la même valeur lorsque le règlement qui la libère est comptabilisé. Null tant que le paiement n’est pas réglé ou lorsque vous lisez le paiement en tant qu’acheteur, et toujours null dans les réponses de liste — récupérez le paiement pour l’obtenir.
string | null
requis
L’expédition qui honore ce paiement, préfixée par ship_. Null lorsque rien n’est expédié ou sans la permission shipment:basic:read.
object | null
requis
L’adresse de livraison pour les biens physiques, ou null.

Propriétés

string | null
requis
La ville.
string | null
requis
Le code pays ISO 3166-1 alpha-2.
string | null
requis
La première ligne de l’adresse postale.
string | null
requis
La deuxième ligne de l’adresse postale.
string | null
requis
Le nom figurant sur l’adresse.
string | null
requis
Le code postal.
string | null
requis
L’État, la province ou la région.
string
requis
L’état du cycle de vie du débit : open tant que l’encaissement est en attente, paid une fois l’argent transféré, pending pendant la compensation sur un rail de règlement, void/uncollectible lorsqu’il s’est terminé sans encaissement.Options disponibles : draft, open, authorized, paid, pending, uncollectible, unresolved, void
string
requis
La lecture plus détaillée du paiement par le tableau de bord, intégrant les remboursements, les litiges et les dossiers du Resolution Center.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
object | null
requis
Le prix avant remises, taxes et frais.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse en transit.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales que comporte le montant. Il s’agit de la précision avec laquelle le paiement lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est facturé en centavos mais écrit en pesos entiers, donc les valeurs sont 2 et 0. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.
object | null
requis
La taxe sur les ventes ou la TVA collectée. Null lorsqu’aucune taxe ne s’appliquait.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse en transit.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales que comporte le montant. Il s’agit de la précision avec laquelle le paiement lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est facturé en centavos mais écrit en pesos entiers, donc les valeurs sont 2 et 0. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.
string | null
requis
Indique si tax_amount a été ajouté au prix (exclusive) ou y était déjà inclus (inclusive).
object
requis
La part de la taxe collectée restituée à l’acheteur jusqu’à présent. Zéro lorsque le paiement ne comportait pas de taxe, ou lorsque rien n’a été remboursé.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse en transit.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales que comporte le montant. Il s’agit de la précision avec laquelle le paiement lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est facturé en centavos mais écrit en pesos entiers, donc les valeurs sont 2 et 0. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.
boolean
requis
True lorsque l’acheteur a effectué l’authentification 3D Secure pour ce paiement.
object | null
requis
Le total côté compte : le prix après remises, plus toute taxe ajoutée au prix. Exclut les frais à la charge de l’acheteur, que celui-ci paie en plus de ce montant — ce n’est donc pas nécessairement ce qui figure sur le relevé de l’acheteur ; amount_charged correspond à ce qui est facturé à l’acheteur.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse en transit.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales que comporte le montant. Il s’agit de la précision avec laquelle le paiement lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est facturé en centavos mais écrit en pesos entiers, donc les valeurs sont 2 et 0. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.
string
requis
Date de dernière modification du paiement, sous forme d’horodatage ISO 8601.
object | null
requis
Le total converti en USD au moment du débit, pour les rapports multidevises. Exclut la majoration de change de la tarification adaptative, que le compte ne conserve pas. Null lorsque vous lisez le paiement en tant qu’acheteur.

Propriétés

string
requis
Le montant en unités principales, sous forme de chaîne décimale exacte. Par exemple, "10.00" correspond à dix dollars. Il s’agit d’une chaîne afin qu’aucun nombre à virgule flottante ne l’arrondisse en transit.
string
requis
Code de devise ISO 4217 à trois lettres, en minuscules.
integer
requis
Nombre de décimales que comporte le montant. Il s’agit de la précision avec laquelle le paiement lui-même est effectué.
integer
requis
Nombre de décimales à AFFICHER. Généralement égal à decimals, mais délibérément pas toujours : le COP est facturé en centavos mais écrit en pesos entiers, donc les valeurs sont 2 et 0. Utilisez cette valeur pour formater le nombre selon vos propres paramètres régionaux.
object | null
requis
L’acheteur. Null lorsque l’acheteur est un compte plutôt qu’un utilisateur.

Propriétés

string
requis
ID de l’utilisateur, préfixé par user_.
string | null
requis
Nom d’affichage.
object
requis
Conteneur de l’avatar. Son url est toujours présent, et correspond à une image générée par défaut lorsque l’utilisateur n’a défini aucune photo.

Propriétés

string
requis
URL de l’image de l’avatar. Toujours présente. Il s’agit d’une image générée par défaut lorsque l’utilisateur n’a défini aucune photo.
string
requis
Nom d’utilisateur public.
string | null
requis
L’agent utilisateur du navigateur de l’acheteur lors du checkout. Null lorsque l’acheteur n’était pas présent lors du checkout, comme pour un renouvellement d’abonnement, ou sans la permission member:basic:read.
string | null
requis
La variante qui a été facturée, préfixée par plan_.
object | null
requis
Les résultats de l’Address Verification Service (AVS), du nom du titulaire de la carte et du Card Verification Value (CVV/CVC), ou null lorsque le processeur n’en a renvoyé aucun ou lorsque vous lisez le paiement en tant qu’acheteur.

Propriétés

string | null
requis
Le résultat de l’Address Verification Service (AVS) pour l’adresse postale de facturation.
string | null
requis
L’Acquirer Reference Number (ARN) qui permet de suivre ce débit à travers le réseau de cartes, ou null lorsque le processeur n’en a pas renvoyé.
string | null
requis
Le code d’autorisation de l’émetteur de la carte pour ce débit, ou null lorsque le processeur n’en a pas renvoyé.
string | null
requis
Indique si le nom du titulaire de la carte correspondait aux données de l’émetteur.
string | null
requis
Le résultat du Card Verification Value (CVV/CVC).
string | null
requis
Le résultat de l’Address Verification Service (AVS) pour le code postal de facturation.
boolean
requis
True lorsque le paiement peut être annulé. La requête est rejetée si le paiement n’est plus éligible — voir POST /payments/\{id}/void.
string | null
requis
L’ID de visiteur du pixel Whop pour le navigateur de l’acheteur lors du checkout, préfixé par wuid_. Null lorsque la page de checkout n’avait pas de pixel Whop, lorsque l’acheteur n’était pas présent lors du checkout, ou sans la permission member:basic:read.
Payment