Skip to main content
Opret en ud fra et bekræftelsestoken, som betalingselementerne indsamlede i setup-tilstand, eller ud fra en allerede gemt betalingsmetode for at genverificere den. Den kører det samme indsamlingsflow som en betaling, så køberen kan stadig mangle et trin: 3D Secure på et kort, en hostet tilmelding eller tilknytning af en bankkonto. Oprettelsessvaret er setup intent’en, som den blev oprettet, ikke dens resultat. Giv dens client_secret til elementernes handleNextAction, eller poll Hent status for at se, hvor langt opsætningen er nået, og hvad der mangler. Når den når succeeded, angiver payment_method_id den gemte metode, og Create Payment opkræver den.

Endpoints

Attributter

string
påkrævet
Setup intent-id med præfikset sint_.
string | null
påkrævet
Den konto, betalingsmetoden gemmes for, med præfikset biz_.
string | null
påkrævet
Den checkout-konfiguration, denne opsætning blev oprettet via, med præfikset ch_. Null for en opsætning oprettet via dette API i stedet for en hostet checkout.
string | null
påkrævet
Den legitimation, som en købers overflade præsenterer for at polle denne opsætning og angive dens retur-URL — giv den til elementernes handleNextAction. Kun på opsætninger oprettet via dette API, og altid null i listesvar — hent setup intent’en for at få den.
string
påkrævet
Hvornår setup intent’en blev oprettet, som et ISO 8601-tidsstempel.
object | null
påkrævet
Hvorfor opsætningen endte, hvor den gjorde, eller null, når intet er mislykkedes. Til stede ved canceled — en køber, der opgav, har ingen kode, en afvist af udbyderen har. Fjernes, når opsætningen lykkes.

Egenskaber

string | null
påkrævet
En maskinlæsbar klassificering af fejlen, f.eks. enrollment_declined. Fraværende, når køberen blot opgav opsætningen.
string | null
påkrævet
En menneskelæsbar forklaring på fejlen.
string | null
påkrævet
Køberens medlemspost på kontoen med præfikset mber_. Null uden tilladelsen member:basic:read, medmindre kalderen er køberen.
object | null
påkrævet
Dine egne nøgle-værdi-data, vedhæftet da setup intent’en blev oprettet.
object | null
påkrævet
Metoden bag denne opsætning, formet til visning: et navn til køberen, standardikonsættet samt kortets mærke, sidste fire cifre, udstederidentifikationsnummer, udløb og netværkstransaktions-id, når det var et kort. Null, indtil en metode er indsamlet.

Egenskaber

object | null
påkrævet
Kun kort-, Apple Pay- og Google Pay-betalinger: kortets netværk, sidste fire cifre, udstederidentifikationsnummer, udløb og netværkstransaktions-id.

Egenskaber

string | null
påkrævet
Netværksidentifikatoren (visa, amex, …), der svarer til card.networks-poster og gemte kortbetalingsmetoder. Null, når vaulten ikke registrerede netværket.
number | null
påkrævet
Kortets udløbsmåned, 1 til 12. Null, når vaulten ikke registrerede den.
number | null
påkrævet
Kortets firecifrede udløbsår. Null, når vaulten ikke registrerede det.
string | null
påkrævet
Udstederidentifikationsnummeret, også kaldet BIN: kortets første seks eller otte cifre, som identificerer den udstedende bank. Null, når processoren ikke rapporterede det.
string | null
påkrævet
Kortets sidste fire cifre, når de er registreret.
string | null
påkrævet
Det netværkstransaktions-id, denne konto bruger for kortet. Det er kontoens eget id fra dens første opkrævning eller verifikation med kunden til stede på kortet, når Whop har et. Ellers er det et tidligere netværkstransaktions-id for dette kort, som kan stamme fra en anden kontos transaktion eller være medbragt med kortet. Angiv det som den forudgående transaktion ved en senere forhandlerinitieret opkrævning af dette kort hos denne konto. Null, indtil der findes et. En webhook sendt, når en betaling første gang registreres, kan indeholde null, så hent betalingen for at læse det.
string
påkrævet
Instrumentnavn til køberen — “Visa •••• 4242”, når kortet blev vist, ellers metodens eget navn (“Klarna”).
object
påkrævet
Standardikonsættet: kvadratiske og kortformede ikoner, hver i lyse og mørke farvevarianter.

Egenskaber

object
påkrævet
Flisen med kreditkortproportioner (48x30).

Egenskaber

object
påkrævet
Farvevarianten til mørke flader.

Egenskaber

string
påkrævet
Rasterfallback i formens oprindelige størrelse.
string
påkrævet
Rasterfallback ved dobbelt tæthed.
string
påkrævet
Rasterfallback ved firedobbelt tæthed.
string
påkrævet
Vektorfilen. Foretræk denne overalt, hvor SVG kan gengives.
object
påkrævet
Farvevarianten til lyse flader.

Egenskaber

string
påkrævet
Rasterfallback i formens oprindelige størrelse.
string
påkrævet
Rasterfallback ved dobbelt tæthed.
string
påkrævet
Rasterfallback ved firedobbelt tæthed.
string
påkrævet
Vektorfilen. Foretræk denne overalt, hvor SVG kan gengives.
object
påkrævet
Den kvadratiske flise (32x32).

Egenskaber

object
påkrævet
Farvevarianten til mørke flader.

Egenskaber

string
påkrævet
Rasterfallback i formens oprindelige størrelse.
string
påkrævet
Rasterfallback ved dobbelt tæthed.
string
påkrævet
Rasterfallback ved firedobbelt tæthed.
string
påkrævet
Vektorfilen. Foretræk denne overalt, hvor SVG kan gengives.
object
påkrævet
Farvevarianten til lyse flader.

Egenskaber

string
påkrævet
Rasterfallback i formens oprindelige størrelse.
string
påkrævet
Rasterfallback ved dobbelt tæthed.
string
påkrævet
Rasterfallback ved firedobbelt tæthed.
string
påkrævet
Vektorfilen. Foretræk denne overalt, hvor SVG kan gengives.
number | null
påkrævet
Kun afdragsmetoder: hvor mange betalinger opkrævningen deles op i. Data, ikke tekst — sammensæt og oversæt etiketten på klientsiden.
string
påkrævet
Identifikatoren for betalingsmetodetypen, f.eks. card, klarna, apple_pay.
string | null
påkrævet
Den gemte betalingsmetode med præfikset payt_, klar til at blive opkrævet med Create Payment. Null, indtil opsætningen har succeeded.
string | null
påkrævet
Den type instrument, der gemmes, for eksempel card eller us_bank_account.
string | null
påkrævet
Hvor køberen lander efter at have gennemført et eksternt trin, eller null for at lade dem blive, hvor de er.
string
påkrævet
Hvor langt opsætningen er nået. En 201 eller 200 betyder, at vi svarede, ikke at metoden blev gemt — forgren altid på dette. requires_action — køberen har et udestående trin; giv client_secret til elementerne, eller poll Retrieve setup status. processing — processoren træffer afgørelse. succeeded — metoden er gemt, og kun denne betyder gemt. canceled — opgivet eller afvist; se last_setup_error.Tilgængelige muligheder: processing, succeeded, canceled, requires_action
string | null
påkrævet
3D Secure-adfærd for understøttede on-session-kortbetalinger. mandate_challenge kræver en 3DS-challenge før betalingsbehandling; mandate_if_required kræver kun en challenge, når betalingsprocessoren kræver det; frictionless_if_required bruger det almindelige friktionsfri 3DS-flow. Betalinger på $1.000 eller mere bruger mandate_if_required, medmindre mandate_challenge er valgt. Krav til risiko og godkendelsesgendannelse kan tilsidesætte præferencen. Den indstilling, der er anmodet om for denne opsætning, eller null, når den ikke er angivet.Tilgængelige muligheder: mandate_challenge, mandate_if_required, frictionless_if_required
boolean
påkrævet
True, når køberen gennemførte 3D Secure under lagringen af denne betalingsmetode.
string
påkrævet
Hvornår setup intent’en sidst blev opdateret, som et ISO 8601-tidsstempel.
object | null
påkrævet
Den bruger, der gemmer betalingsmetoden. Null, når køberen er en konto frem for en bruger.

Egenskaber

string
påkrævet
Bruger-id med præfikset user_.
string | null
påkrævet
Visningsnavn.
object
påkrævet
Avatar-wrapper. Dens url er altid til stede og er en genereret pladsholder, når brugeren ikke har angivet et billede.

Egenskaber

string
påkrævet
URL til avatarbillede. Altid til stede. Det er en genereret pladsholder, når brugeren ikke har angivet et billede.
string
påkrævet
Offentligt brugernavn.
SetupIntent