Skip to main content
Maak er een aan vanuit een bevestigingstoken dat de payment elements in setup-modus hebben verzameld, of vanuit een al opgeslagen betaalmethode om deze opnieuw te verifiëren. Het doorloopt dezelfde verzamelflow als een betaling, dus de koper moet mogelijk nog een stap uitvoeren: 3D Secure op een kaart, een gehoste inschrijving of het koppelen van een bankrekening. De respons bij het aanmaken is de setup intent zoals aangemaakt, niet de uitkomst. Geef de client_secret door aan handleNextAction van de elements, of poll Status ophalen om te zien hoe ver de setup is en wat er nog openstaat. Zodra de status succeeded is, verwijst payment_method_id naar de opgeslagen methode en schrijft Create Payment deze af.

Endpoints

Attributen

string
vereist
Setup intent-ID, met prefix sint_.
string | null
vereist
Het account waarvoor de betaalmethode wordt opgeslagen, met prefix biz_.
string | null
vereist
De checkoutconfiguratie waarmee deze setup is aangemaakt, met prefix ch_. Null voor een setup die via deze API is aangemaakt in plaats van via een gehoste checkout.
string | null
vereist
De credential die de interface van een koper gebruikt om deze setup te pollen en de return-URL in te stellen — geef deze door aan handleNextAction van de elements. Alleen bij setups die via deze API zijn aangemaakt, en altijd null in list-responsen — haal de setup intent op om deze te krijgen.
string
vereist
Wanneer de setup intent is aangemaakt, als ISO 8601-tijdstempel.
object | null
vereist
Waarom de setup is geëindigd waar die eindigde, of null als er niets is mislukt. Aanwezig bij canceled — een koper die is afgehaakt heeft geen code, een setup die door de provider is geweigerd wel. Verdwijnt zodra de setup slaagt.

Eigenschappen

string | null
vereist
Een machineleesbare classificatie van de fout, bijv. enrollment_declined. Ontbreekt als de koper de setup gewoon heeft afgebroken.
string | null
vereist
Een leesbare uitleg van de fout.
string | null
vereist
Het ledenrecord van de koper op het account, met prefix mber_. Null zonder de machtiging member:basic:read, tenzij de aanroeper de koper is.
object | null
vereist
Je eigen key-value-gegevens die bij het aanmaken van de setup intent zijn toegevoegd.
object | null
vereist
De methode achter deze setup, opgemaakt voor weergave: een naam voor de koper, de standaard pictogrammenset, en het merk, de laatste vier cijfers, het issuer identification number, de vervaldatum en het netwerktransactie-ID van de kaart als het een kaart was. Null totdat er een methode is verzameld.

Eigenschappen

object | null
vereist
Alleen voor betalingen met kaart, Apple Pay en Google Pay: het netwerk, de laatste vier cijfers, het issuer identification number, de vervaldatum en het netwerktransactie-ID van de kaart.

Eigenschappen

string | null
vereist
De netwerkidentificatie (visa, amex, …), overeenkomend met items in card.networks en opgeslagen kaartbetaalmethoden. Null wanneer de vault het netwerk niet heeft vastgelegd.
number | null
vereist
De vervalmaand van de kaart, 1 tot en met 12. Null wanneer de vault deze niet heeft vastgelegd.
number | null
vereist
Het viercijferige vervaljaar van de kaart. Null wanneer de vault dit niet heeft vastgelegd.
string | null
vereist
Het issuer identification number, ook wel de BIN genoemd: de eerste zes of acht cijfers van de kaart, die de uitgevende bank identificeren. Null wanneer de verwerker dit niet heeft gerapporteerd.
string | null
vereist
De laatste vier cijfers van de kaart, indien vastgelegd.
string | null
vereist
Het netwerktransactie-ID dat dit account voor de kaart gebruikt. Dit is het eigen ID van dit account, afkomstig van de eerste afschrijving of verificatie met aanwezige klant op de kaart, als Whop er een heeft. Anders is het een eerder netwerktransactie-ID voor deze kaart, dat afkomstig kan zijn van een transactie van een ander account of met de kaart is meegebracht. Vermeld het als de voorgaande transactie bij een latere door de merchant geïnitieerde afschrijving van deze kaart bij dit account. Null totdat er een is. Een webhook die wordt verzonden wanneer een betaling voor het eerst wordt vastgelegd, kan null bevatten; haal de betaling op om het te lezen.
string
vereist
Naam van het instrument voor de koper — “Visa •••• 4242” wanneer de kaart bekend is, anders de eigen naam van de methode (“Klarna”).
object
vereist
De standaard pictogrammenset: vierkante en kaartvormen, elk in lichte en donkere kleurvarianten.

Eigenschappen

object
vereist
De tegel met creditcardverhoudingen (48x30).

Eigenschappen

object
vereist
De kleurvariant voor donkere achtergronden.

Eigenschappen

string
vereist
Rasterterugval op de oorspronkelijke grootte van de vorm.
string
vereist
Rasterterugval op dubbele dichtheid.
string
vereist
Rasterterugval op viervoudige dichtheid.
string
vereist
Het vectorbestand. Gebruik dit bij voorkeur overal waar SVG wordt weergegeven.
object
vereist
De kleurvariant voor lichte achtergronden.

Eigenschappen

string
vereist
Rasterterugval op de oorspronkelijke grootte van de vorm.
string
vereist
Rasterterugval op dubbele dichtheid.
string
vereist
Rasterterugval op viervoudige dichtheid.
string
vereist
Het vectorbestand. Gebruik dit bij voorkeur overal waar SVG wordt weergegeven.
object
vereist
De vierkante tegel (32x32).

Eigenschappen

object
vereist
De kleurvariant voor donkere achtergronden.

Eigenschappen

string
vereist
Rasterterugval op de oorspronkelijke grootte van de vorm.
string
vereist
Rasterterugval op dubbele dichtheid.
string
vereist
Rasterterugval op viervoudige dichtheid.
string
vereist
Het vectorbestand. Gebruik dit bij voorkeur overal waar SVG wordt weergegeven.
object
vereist
De kleurvariant voor lichte achtergronden.

Eigenschappen

string
vereist
Rasterterugval op de oorspronkelijke grootte van de vorm.
string
vereist
Rasterterugval op dubbele dichtheid.
string
vereist
Rasterterugval op viervoudige dichtheid.
string
vereist
Het vectorbestand. Gebruik dit bij voorkeur overal waar SVG wordt weergegeven.
number | null
vereist
Alleen voor betaalmethoden in termijnen: in hoeveel betalingen de afschrijving wordt opgesplitst. Data, geen tekst — stel het label aan de clientzijde samen en vertaal het daar.
string
vereist
De identificatie van het type betaalmethode, bijv. card, klarna, apple_pay.
string | null
vereist
De opgeslagen betaalmethode, met prefix payt_, klaar om af te schrijven met Create Payment. Null totdat de setup de status succeeded heeft.
string | null
vereist
Het soort instrument dat wordt opgeslagen, bijvoorbeeld card of us_bank_account.
string | null
vereist
Waar de koper terechtkomt na het voltooien van een stap buiten de site, of null om de koper te laten waar die is.
string
vereist
Hoe ver de setup is gekomen. Een 201 of 200 betekent dat we hebben geantwoord, niet dat de methode is opgeslagen — vertak altijd op basis hiervan. requires_action — de koper moet nog een stap uitvoeren; geef client_secret door aan de elements of poll Retrieve setup status. processing — de verwerker beslist. succeeded — de methode is opgeslagen, en alleen deze status betekent opgeslagen. canceled — afgebroken of geweigerd; zie last_setup_error.Beschikbare opties: processing, succeeded, canceled, requires_action
string | null
vereist
3D Secure-gedrag voor ondersteunde kaartbetalingen tijdens de sessie. mandate_challenge vereist een 3DS-challenge vóór de verwerking van de betaling; mandate_if_required vereist een challenge alleen als de betalingsverwerker dat eist; frictionless_if_required gebruikt de gewone frictionless 3DS-flow. Betalingen van $1.000 of meer gebruiken mandate_if_required, tenzij mandate_challenge is geselecteerd. Vereisten voor risico en herstel van authenticatie kunnen de voorkeur overschrijven. De instelling die voor deze setup is aangevraagd, of null als deze niet is ingesteld.Beschikbare opties: mandate_challenge, mandate_if_required, frictionless_if_required
boolean
vereist
True als de koper 3D Secure heeft voltooid tijdens het opslaan van deze betaalmethode.
string
vereist
Wanneer de setup intent voor het laatst is bijgewerkt, als ISO 8601-tijdstempel.
object | null
vereist
De gebruiker die de betaalmethode opslaat. Null als de koper een account is in plaats van een gebruiker.

Eigenschappen

string
vereist
Gebruikers-ID, met prefix user_.
string | null
vereist
Weergavenaam.
object
vereist
Avatar-wrapper. De url is altijd aanwezig en is een gegenereerde placeholder als de gebruiker geen foto heeft ingesteld.

Eigenschappen

string
vereist
URL van de avatarafbeelding. Altijd aanwezig. Het is een gegenereerde placeholder als de gebruiker geen foto heeft ingesteld.
string
vereist
Openbare gebruikersnaam.
SetupIntent