Skip to main content
Créez-en un à partir d’un jeton de confirmation collecté par les éléments de paiement en mode configuration, ou à partir d’un moyen de paiement déjà enregistré pour le vérifier à nouveau. Il suit le même processus de collecte qu’un paiement, de sorte que l’acheteur peut encore avoir une étape à accomplir : 3D Secure sur une carte, une inscription hébergée ou l’association d’un compte bancaire. La réponse de création correspond au setup intent tel que créé, et non à son résultat. Transmettez son client_secret à handleNextAction des éléments, ou interrogez Récupérer le statut pour savoir où en est la configuration et ce qui reste à faire. Une fois le statut succeeded atteint, payment_method_id désigne le moyen enregistré, et Create Payment permet de le débiter.

Endpoints

Attributs

string
requis
ID du setup intent, préfixé par sint_.
string | null
requis
Le compte pour lequel le moyen de paiement est enregistré, préfixé par biz_.
string | null
requis
La configuration de paiement via laquelle cette configuration a été créée, préfixée par ch_. Null pour une configuration créée via cette API plutôt que via un checkout hébergé.
string | null
requis
L’identifiant que l’interface de l’acheteur présente pour interroger cette configuration et définir son URL de retour — transmettez-le à handleNextAction des éléments. Présent uniquement sur les configurations créées via cette API, et toujours null dans les réponses de liste — récupérez le setup intent pour l’obtenir.
string
requis
Date de création du setup intent, sous forme d’horodatage ISO 8601.
object | null
requis
Pourquoi la configuration s’est arrêtée là où elle s’est arrêtée, ou null si rien n’a échoué. Présent avec canceled — un abandon par l’acheteur ne comporte aucun code, un refus du prestataire en comporte un. Supprimé une fois la configuration réussie.

Propriétés

string | null
requis
Une classification de l’échec lisible par machine, par ex. enrollment_declined. Absent lorsque l’acheteur a simplement abandonné la configuration.
string | null
requis
Une explication lisible de l’échec.
string | null
requis
L’enregistrement de membre de l’acheteur sur le compte, préfixé par mber_. Null sans l’autorisation member:basic:read, sauf si l’appelant est l’acheteur.
object | null
requis
Vos propres données clé-valeur associées lors de la création du setup intent.
object | null
requis
Le moyen associé à cette configuration, mis en forme pour l’affichage : un nom destiné à l’acheteur, le jeu d’icônes standard, ainsi que la marque 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 lorsqu’il s’agit d’une carte. Null tant qu’aucun moyen n’a été collecté.

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é saisis.
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 prélèvement ou de sa première vérification avec le client présent sur cette 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é fourni avec la carte. Citez-le comme transaction antérieure lors d’un prélèvement ultérieur de cette carte initié par le marchand sur ce compte. Null tant qu’il n’en existe pas. Un webhook envoyé au moment où un paiement est enregistré pour la première fois peut contenir null ; récupérez donc le paiement pour le lire.
string
requis
Nom du moyen de paiement destiné à l’acheteur — “Visa •••• 4242” lorsque la carte est connue, sinon le nom propre du moyen (“Klarna”).
object
requis
Le jeu d’icônes standard : formats carré et carte, chacun en variantes 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 couleurs pour les surfaces sombres.

Propriétés

string
requis
Image matricielle de secours à la taille native du format.
string
requis
Image matricielle de secours en double densité.
string
requis
Image matricielle de secours en quadruple densité.
string
requis
Le fichier vectoriel. À privilégier partout où le SVG s’affiche.
object
requis
La variante de couleurs pour les surfaces claires.

Propriétés

string
requis
Image matricielle de secours à la taille native du format.
string
requis
Image matricielle de secours en double densité.
string
requis
Image matricielle de secours en quadruple densité.
string
requis
Le fichier vectoriel. À privilégier partout où le SVG s’affiche.
object
requis
La vignette carrée (32x32).

Propriétés

object
requis
La variante de couleurs pour les surfaces sombres.

Propriétés

string
requis
Image matricielle de secours à la taille native du format.
string
requis
Image matricielle de secours en double densité.
string
requis
Image matricielle de secours en quadruple densité.
string
requis
Le fichier vectoriel. À privilégier partout où le SVG s’affiche.
object
requis
La variante de couleurs pour les surfaces claires.

Propriétés

string
requis
Image matricielle de secours à la taille native du format.
string
requis
Image matricielle de secours en double densité.
string
requis
Image matricielle de secours en quadruple densité.
string
requis
Le fichier vectoriel. À privilégier partout où le SVG s’affiche.
number | null
requis
Moyens de paiement échelonné uniquement : nombre de paiements en lesquels le prélèvement 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é, préfixé par payt_, prêt à être débité avec Create Payment. Null tant que la configuration n’a pas le statut succeeded.
string | null
requis
Le type de moyen de paiement en cours d’enregistrement, par exemple card ou us_bank_account.
string | null
requis
La page sur laquelle l’acheteur arrive après avoir terminé une étape hors site, ou null pour le laisser là où il se trouve.
string
requis
Où en est la configuration. Un 201 ou un 200 signifie que nous avons répondu, et non que le moyen a été enregistré — basez toujours votre logique sur ce champ. requires_action — l’acheteur a une étape en attente ; transmettez client_secret aux éléments ou interrogez Retrieve setup status. processing — le processeur est en train de statuer. succeeded — le moyen est enregistré, et seul ce statut signifie qu’il l’est. canceled — abandonné ou refusé ; consultez last_setup_error.Options disponibles : processing, succeeded, canceled, requires_action
string | null
requis
Comportement 3D Secure pour les paiements par carte en session pris en charge. mandate_challenge exige une vérification 3DS avant le traitement du paiement ; mandate_if_required impose une vérification uniquement lorsque le processeur de paiement l’exige ; frictionless_if_required utilise le flux 3DS sans friction habituel. Les paiements de 1 000 $ ou plus utilisent mandate_if_required, sauf si mandate_challenge est sélectionné. Les exigences en matière de risque et de récupération d’authentification peuvent prévaloir sur cette préférence. Le paramètre demandé pour cette configuration, ou null s’il n’est pas défini.Options disponibles : mandate_challenge, mandate_if_required, frictionless_if_required
boolean
requis
Vrai lorsque l’acheteur a effectué la vérification 3D Secure lors de l’enregistrement de ce moyen de paiement.
string
requis
Date de la dernière mise à jour du setup intent, sous forme d’horodatage ISO 8601.
object | null
requis
L’utilisateur qui enregistre le moyen de paiement. Null lorsque l’acheteur est un compte plutôt qu’un utilisateur.

Propriétés

string
requis
ID 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 à un espace réservé généré 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’un espace réservé généré lorsque l’utilisateur n’a défini aucune photo.
string
requis
Nom d’utilisateur public.
SetupIntent