Skip to main content
Maak een on-session betaling aan met een confirmation_token voor de methode die de koper heeft gekozen, of een off-session betaling met de opgeslagen betaalmethode van een bestaande member. Gebruik de Payments API om kopers te belasten, betalingen op te vragen en op te halen, en ze terug te betalen, te voiden, te capturen of opnieuw te proberen. De inning gebeurt op de achtergrond, dus het antwoord bij het aanmaken is niet de uitkomst. Poll Status ophalen om te zien hoe ver de betaling is en, zolang deze requires_action is, wat de koper als volgende moet doen: een redirect volgen, 3D Secure voltooien, overboekingsinstructies tonen of een bankrekening koppelen. Werk de return_url van de betaling bij om te wijzigen waar de koper daarna terechtkomt, tot het moment dat die terugkeert.

Endpoints

Attributen

string
vereist
Payment-ID, met prefix pay_.
string | null
vereist
Het account dat de betaling heeft ontvangen, met prefix biz_.
object | null
vereist
Wat het account overhoudt: het totaal min de kosten van Whop. Null wanneer je de betaling leest als de koper ervan.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
object
vereist
Wat de koper voor deze betaling betaalt: het totaal plus eventuele kosten voor de koper, in de valuta waarin de koper betaalt. Terugbetalingen verlagen dit niet; presentment_refunded_amount vermeldt ze in dezelfde valuta.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
string | null
vereist
Wanneer Whop deze geautoriseerde kaartbetaling automatisch zal capturen, tenzij deze eerst wordt gevoid, als ISO 8601-tijdstempel. Null wanneer er geen automatische capture is aangevraagd.
boolean
vereist
True wanneer Whop de betaling automatisch heeft terugbetaald, bijvoorbeeld bij een dispute alert.
object | null
vereist
Het factuuradres dat de koper heeft ingevoerd, of null.

Eigenschappen

string | null
vereist
De plaats.
string | null
vereist
De ISO 3166-1 alpha-2-landcode.
string | null
vereist
De eerste adresregel.
string | null
vereist
De tweede adresregel.
string | null
vereist
De naam op het adres.
string | null
vereist
De postcode.
string | null
vereist
De staat, provincie of regio.
string | null
vereist
Waarom de afschrijving is aangemaakt: een eerste aankoop, een verlenging, een eenmalige betaling of een handmatige afschrijving.
string | null
vereist
Wanneer de reservering op deze geautoriseerde kaartbetaling verloopt als deze niet eerder wordt gecapturet, als ISO 8601-tijdstempel. Null wanneer de betaling niet is aangemaakt voor latere capture.
string | null
vereist
De checkoutconfiguratie waarmee de koper heeft betaald, met prefix ch_, of null.
string | null
vereist
Het schema en de host van de website waarop de koper de checkout opende, zoals https://store.example.com. Gebruik dit om betalingen van verschillende websites op één account van elkaar te onderscheiden. Null wanneer de website niet is vastgelegd, ook bij betalingen die zonder aanwezigheid van de koper zijn gedaan.
string | null
vereist
De checkoutervaring die deze betaling heeft opgeleverd, zoals embedded_checkout voor een checkout op de eigen website van het account of off_session voor een abonnementsverlenging. Null wanneer de checkout niet is vastgelegd.Beschikbare opties: hosted_checkout, embedded_checkout, custom_checkout, modal_checkout, in_app_checkout, mobile_checkout, off_session, card_present
string | null
vereist
De credential die de omgeving van een koper gebruikt om deze betaling te pollen, de return-URL in te stellen en de betaling te hervatten wanneer de bank de klant om authenticatie vroeg. Alleen bij betalingen die zijn aangemaakt vanuit een confirmation token of die op die authenticatie wachten, null wanneer je de betaling leest als de koper ervan, en altijd null in list-antwoorden — haal de betaling op om deze te krijgen.
string
vereist
Wanneer de betaling is aangemaakt, als ISO 8601-tijdstempel.
string
vereist
De valuta waarin de betaling wordt afgewikkeld, ISO 4217 in kleine letters. Elk geldveld hieronder wordt hierin uitgedrukt, tenzij anders vermeld.Beschikbare opties: 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
vereist
Het e-mailadres van de koper. Null zonder member:email:read op het account of wanneer de koper geen toegewezen e-mailadres heeft.
string | null
vereist
Het telefoonnummer dat de koper bij de checkout heeft opgegeven, wanneer er een is verzameld.
string | null
vereist
De genormaliseerde weigeringsreden van de meest recente mislukte poging, of null.
string | null
vereist
Wanneer een uitgever waarschuwde dat deze betaling zal worden betwist, of null.
string | null
vereist
Wanneer de meest recente dispute op deze betaling is geopend, als ISO 8601-tijdstempel. Null wanneer de betaling nooit is betwist, of zonder de permissie payment:dispute:read.
string | null
vereist
Waarom de meest recente poging is mislukt, in gewone woorden, of null.
number | null
vereist
Voor termijnbetaalmethoden: in hoeveel betalingen de afschrijving wordt opgesplitst.
object[]
vereist
De actieve reserveringen op deze betaling. Elke reservering heeft een eigen vrijgavedatum, onafhankelijk van settlement_time_at. Leeg wanneer er niets wordt vastgehouden of wanneer je de betaling leest als de koper ervan; vrijgegeven reserveringen worden weggelaten.

Eigenschappen

object
vereist
Het bedrag dat momenteel wordt vastgehouden, in de valuta van de reservering.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
number | null
vereist
Het reservepercentage dat is vastgelegd toen de reservering werd aangemaakt, bijvoorbeeld 3.5 voor 3,5%. Null voor andere soorten reserveringen of wanneer er geen percentage is vastgelegd.
string | null
vereist
Wanneer het vastgehouden geld volgens planning beschikbaar komt, als ISO 8601-tijdstempel. Nooit eerder dan de settlementdatum van de betaling. Null wanneer de vrijgave afhangt van een gebeurtenis, zoals de afhandeling van een verzending, in plaats van een datum.
string
vereist
De reden waarom geld wordt vastgehouden: reserve, bnpl, sequra, fraud_hold of preshipment_hold.Beschikbare opties: reserve, bnpl, sequra, fraud_hold, preshipment_hold
string | null
vereist
Het IP-adres van de koper bij de checkout: het adres dat de fraudescreening van Whop heeft vastgesteld, anders het adres dat Whop bij de checkout uit de browser van de koper heeft vastgelegd. Null wanneer de koper niet aanwezig was bij de checkout, zoals bij een abonnementsverlenging of een afschrijving zonder aanwezigheid van de koper, of wanneer je de betaling leest als de koper ervan.
string | null
vereist
Wanneer de meest recente afschrijvingspoging plaatsvond, of null.
object[]
vereist
Alles waarvoor deze betaling heeft afgeschreven, in aankoopvolgorde, met aantallen en subtotalen in de aankoopvaluta. Betalingen die zijn gedaan voordat snapshots van items werden vastgelegd, retourneren het enkele item dat uit hun variant volgt. Leeg wanneer er geen items of variant kunnen worden bepaald.

Eigenschappen

string | null
vereist
Line item-ID, met prefix li_. Null wanneer de betaling van vóór de item-snapshots is en het item uit de variant van de betaling wordt gelezen.
string | null
vereist
De naam van het item zoals getoond bij de checkout (de producttitel, anders de varianttitel).
string | null
vereist
Het product waartoe de variant behoort, met prefix prod_. Bij een betaling van vóór de item-snapshots valt dit terug op het product van de variant, dus het kan zijn ingesteld waar de eigen product_id van de bovenliggende betaling null is. Null voor een variant zonder product.
string | null
vereist
De huidige titel van het product, of null wanneer het item geen product heeft.
number
vereist
Hoeveel eenheden er zijn gekocht.
string | null
vereist
De stock keeping unit van de variant, vrije tekst die door de verkoper is ingesteld (bijv. TSHIRT-LARGE-BLUE). Accounts waarvoor SKU-achtervoegsels op basis van de factureringsreden zijn ingeschakeld, ontvangen deze voorzien van de reden van de afschrijving: -S voor een eerste abonnementsafschrijving, -R voor een verlenging, -C voor een eenmalige aankoop, -U wanneer de eigen metadata van de betaling upsell: true bevat, -F wanneer er niets is afgeschreven. Andere factureringsredenen krijgen de kale SKU. null wanneer de variant geen SKU heeft of is verwijderd.
object | null
vereist
Het vastgelegde bedrag voor de volledige hoeveelheid van dit item, vóór kortingen, belasting en kosten, in de aankoopvaluta. Retourneert null wanneer er geen itembedrag is vastgelegd.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
string | null
vereist
De gekochte variant, met prefix plan_. Null wanneer de variant inmiddels is verwijderd.
string | null
vereist
De huidige titel van de variant, of null wanneer de variant is verwijderd of geen titel heeft.
string | null
vereist
Het memberrecord van de koper bij het account, met prefix mber_. Null zonder de permissie member:basic:read, tenzij jij de koper bent.
string | null
vereist
De membership waarop deze betaling wordt gefactureerd, met prefix mem_. Null voor eenmalige aankopen, of zonder de permissie member:basic:read, tenzij jij de koper bent.
object | null
vereist
Je eigen sleutel-waardegegevens die bij het aanmaken van de betaling zijn toegevoegd. Null wanneer je de betaling leest als de koper ervan.
boolean | null
vereist
True voor een betaalde betaling met een verzendadres, zonder verzending en zonder volledige terugbetaling. Null zonder de permissie shipment:basic:read.
boolean | null
vereist
True wanneer geld wordt vastgehouden totdat de bestelling is verzonden en er nog geen trackingnummer is toegevoegd. Null zonder de permissie shipment:basic:read.
string | null
vereist
Wanneer de volgende automatische nieuwe poging is gepland, of null.
string | null
vereist
Wanneer het geld is geïnd, of null zolang dat nog niet is gebeurd.
object | null
vereist
Het betaalinstrument in een vorm voor weergave: een naam voor de koper, de standaard pictogrammenset en, wanneer het een kaart was, het merk van de kaart, de laatste vier cijfers, het issuer identification number en de network transaction id die het account voor de kaart gebruikt. De network transaction id is null wanneer je de betaling leest als de koper ervan.

Eigenschappen

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

Eigenschappen

string | null
vereist
De netwerkidentificatie (visa, amex, …), overeenkomend met de 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 BIN genoemd: de eerste zes of acht cijfers van de kaart, die de uitgevende bank identificeren. Null wanneer de processor dit niet heeft gerapporteerd.
string | null
vereist
De laatste vier cijfers van de kaart, wanneer vastgelegd.
string | null
vereist
De network transaction id die dit account voor de kaart gebruikt. Het is de eigen id van dit account, afkomstig van de eerste afschrijving met aanwezige klant of verificatie op de kaart, wanneer Whop die heeft. Anders is het een eerdere network transaction id voor deze kaart, die afkomstig kan zijn van een transactie van een ander account of met de kaart kan zijn meegebracht. Vermeld deze als de voorafgaande 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 verstuurd wanneer een betaling voor het eerst wordt vastgelegd, kan null bevatten, dus haal de betaling op om deze te lezen.
string
vereist
Naam van het instrument voor de koper — “Visa •••• 4242” wanneer de kaart zichtbaar is, anders de eigen naam van de methode (“Klarna”).
object
vereist
De standaard pictogrammenset: vierkante vormen en kaartvormen, elk in een lichte en donkere kleurvariant.

Eigenschappen

object
vereist
De tegel in creditcardverhouding (48x30).

Eigenschappen

object
vereist
De kleurvariant voor donkere achtergronden.

Eigenschappen

string
vereist
Raster-fallback op de oorspronkelijke grootte van de vorm.
string
vereist
Raster-fallback op dubbele dichtheid.
string
vereist
Raster-fallback 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
Raster-fallback op de oorspronkelijke grootte van de vorm.
string
vereist
Raster-fallback op dubbele dichtheid.
string
vereist
Raster-fallback 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
Raster-fallback op de oorspronkelijke grootte van de vorm.
string
vereist
Raster-fallback op dubbele dichtheid.
string
vereist
Raster-fallback 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
Raster-fallback op de oorspronkelijke grootte van de vorm.
string
vereist
Raster-fallback op dubbele dichtheid.
string
vereist
Raster-fallback op viervoudige dichtheid.
string
vereist
Het vectorbestand. Gebruik dit bij voorkeur overal waar SVG wordt weergegeven.
number | null
vereist
Alleen voor termijnbetaalmethoden: in hoeveel betalingen de afschrijving wordt opgesplitst. Gegevens, geen tekst — stel het label client-side samen en vertaal het daar.
string
vereist
De identificatie van het type betaalmethode, bijv. card, klarna, apple_pay.
string | null
vereist
De opgeslagen betaalmethode waarvan is afgeschreven, met prefix payt_. Null wanneer de methode niet is opgeslagen.
string | null
vereist
Het soort instrument dat is gebruikt, bijvoorbeeld card, apple_pay, klarna of us_bank_account.
object[]
vereist
De eigen payment rules van het account die over deze betaling hebben beslist, vastgelegd op het moment dat ze werden uitgevoerd. Per betaling wordt slechts één actie uitgevoerd, dus een regel die matchte maar werd overgeslagen of overtroffen, wordt niet vermeld. Leeg wanneer geen enkele regel erover besliste, wanneer het account geen regels had, wanneer Whop de betaling blokkeerde voordat de regels werden uitgevoerd, of wanneer je de betaling leest als de koper ervan.

Eigenschappen

string
vereist
Payment rule-ID, met prefix prule_.
string
vereist
Waar de regel om vroeg.Beschikbare opties: allow, block, review, enforce_3ds
string | null
vereist
De naam van de regel op het moment dat deze matchte. Het later hernoemen van de regel herschrijft dit niet.
number
vereist
Hoeveel afschrijvingspogingen voor deze betaling zijn mislukt.
object | null
vereist
Hoeveel er tot nu toe is terugbetaald, in de valuta die aan de koper is getoond. Nul wanneer er niets is terugbetaald.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
object | null
vereist
De geïnde omzetbelasting of btw, in de valuta die aan de koper is getoond. Null wanneer er geen belasting van toepassing was.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
object | null
vereist
Het totaal voor het account in de valuta die aan de koper is getoond, vóór omrekening naar de settlementvaluta. Exclusief kosten voor de koper.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
string | null
vereist
Het product waartoe de variant behoort, met prefix prod_. Null voor een variant zonder product.
string | null
vereist
De promotiecode die bij de checkout is toegepast, met prefix promo_, of null.
string | null
vereist
De payment quote die deze betaling in rekening heeft gebracht, met prefix pq_: de aankoop, promotiecode en tax_amount zijn die van de quote. Null wanneer de betaling geen quote noemde en de belasting op het moment van afrekenen is berekend.
string | null
vereist
Door Whop gehoste URL waar de koper kan inloggen en 3D Secure kan voltooien voor een off-session afschrijving waarvoor de bank een challenge gaf — een abonnementsverlenging of een betaling met een opgeslagen kaart. Null wanneer herstel niet beschikbaar is, je member:basic:read mist, of in list-antwoorden. Haal de betaling op om deze te krijgen.
boolean
vereist
True wanneer de betaling paid is, nog niet volledig is terugbetaald en de processor terugbetalingen ondersteunt.
object | null
vereist
Hoeveel er tot nu toe is terugbetaald, zoals afgewikkeld — terugbetalingen worden omgerekend tegen de koers die gold toen elke terugbetaling werd uitgevoerd, niet tegen de oorspronkelijke koers van de betaling.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
string | null
vereist
Wanneer de betaling is terugbetaald, of null.
string | null
vereist
Wanneer de vroegste reactie verschuldigd is op een dispute of Resolution Center-zaak die op een reactie van het account wacht, als ISO 8601-tijdstempel. Null wanneer er niets op een reactie wacht, of zonder de permissie om die dispute of zaak te lezen.
boolean
vereist
True wanneer de betaling handmatig opnieuw kan worden geprobeerd met POST /payments/\{id} /retry. De betaling moet open zijn en niet via een betaallink van een factuur zijn betaald. De membership moet active, trialing of past_due zijn, of de betaling moet een mislukte eerste betaling op een drafted membership zijn. De ene handmatige nieuwe poging mag niet zijn opgebruikt. Een nieuwe poging kan nog steeds worden geweigerd wanneer het account momenteel geen betalingen kan accepteren.
number | null
vereist
De gepubliceerde risico-index van Whop van 0 (laagst) tot 100 (hoogst), inclusief afgedwongen beslissingsondergrenzen. Dit is geen fraudekans. Null wanneer er geen score beschikbaar is of wanneer je de betaling leest als de koper ervan.
object | null
vereist
Verouderd. Uitleg bij de risicoscore wordt niet meer gegeven; altijd null. VEROUDERD: uitleg bij de risicoscore wordt niet meer gegeven. Altijd null.
string | null
vereist
Wanneer het deel dat niet in holds staat op het beschikbare saldo van het account wordt geboekt, om middernacht UTC. De posted_at van de webhook financial_activity.funds_available bevat dezelfde waarde wanneer de settlement die het vrijgeeft wordt geboekt. Null totdat de betaling is betaald of wanneer je de betaling leest als de koper ervan, en altijd null in list-antwoorden — haal de betaling op om deze te krijgen.
string | null
vereist
De verzending die deze betaling uitvoert, met prefix ship_. Null wanneer er niets wordt verzonden of zonder de permissie shipment:basic:read.
object | null
vereist
Het verzendadres voor fysieke goederen, of null.

Eigenschappen

string | null
vereist
De plaats.
string | null
vereist
De ISO 3166-1 alpha-2-landcode.
string | null
vereist
De eerste adresregel.
string | null
vereist
De tweede adresregel.
string | null
vereist
De naam op het adres.
string | null
vereist
De postcode.
string | null
vereist
De staat, provincie of regio.
string
vereist
De levenscyclusstatus van de afschrijving: open zolang de inning nog openstaat, paid zodra het geld is verplaatst, pending terwijl een settlementkanaal de betaling verwerkt, void/uncollectible wanneer deze eindigde zonder inning.Beschikbare opties: draft, open, authorized, paid, pending, uncollectible, unresolved, void
string
vereist
De gedetailleerdere weergave van de betaling in het dashboard, waarin terugbetalingen, disputes en Resolution Center-zaken zijn verwerkt.Beschikbare opties: 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
vereist
De prijs vóór kortingen, belasting en kosten.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
object | null
vereist
De geïnde omzetbelasting of btw. Null wanneer er geen belasting van toepassing was.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
string | null
vereist
Of tax_amount bovenop de prijs is gekomen (exclusive) of er al in zat (inclusive).
object
vereist
Hoeveel van de geïnde belasting tot nu toe aan de koper is teruggegeven. Nul wanneer de betaling geen belasting bevatte, of wanneer er niets is terugbetaald.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
boolean
vereist
True wanneer de koper 3D Secure voor deze betaling heeft voltooid.
object | null
vereist
Het totaal voor het account: de prijs na kortingen, plus eventuele belasting die erbovenop komt. Exclusief kosten voor de koper, die de koper bovenop dit bedrag betaalt — dit is dus niet noodzakelijk wat op het afschrift van de koper staat; amount_charged is wat de koper betaalt.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
string
vereist
Wanneer de betaling voor het laatst is gewijzigd, als ISO 8601-tijdstempel.
object | null
vereist
Het totaal omgerekend naar USD op het moment van de afschrijving, voor rapportage over valuta’s heen. Exclusief de FX-opslag van adaptive pricing, die het account niet behoudt. Null wanneer je de betaling leest als de koper ervan.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
object | null
vereist
De koper. Null wanneer de koper een account is in plaats van een gebruiker.

Eigenschappen

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

Eigenschappen

string
vereist
URL van de avatarafbeelding. Altijd aanwezig. Het is een gegenereerde placeholder wanneer de gebruiker geen foto heeft ingesteld.
string
vereist
Openbare gebruikersnaam.
string | null
vereist
De user agent van de browser van de koper bij de checkout. Null wanneer de koper niet aanwezig was bij de checkout, zoals bij een abonnementsverlenging, of zonder de permissie member:basic:read.
string | null
vereist
De variant waarvoor is afgeschreven, met prefix plan_.
object | null
vereist
De resultaten van de Address Verification Service (AVS), de naam van de kaarthouder en de Card Verification Value (CVV/CVC), of null wanneer de processor er geen retourneerde of wanneer je de betaling leest als de koper ervan.

Eigenschappen

string | null
vereist
Het resultaat van de Address Verification Service (AVS) voor het straatadres van de facturering.
string | null
vereist
Het Acquirer Reference Number (ARN) waarmee deze afschrijving door het kaartnetwerk kan worden getraceerd, of null wanneer de processor er geen retourneerde.
string | null
vereist
De autorisatiecode van de kaartuitgever voor deze afschrijving, of null wanneer de processor er geen retourneerde.
string | null
vereist
Of de naam van de kaarthouder overeenkwam met de gegevens van de uitgever.
string | null
vereist
Het resultaat van de Card Verification Value (CVV/CVC).
string | null
vereist
Het resultaat van de Address Verification Service (AVS) voor de postcode van de facturering.
boolean
vereist
True wanneer de betaling kan worden gevoid of geannuleerd. Het verzoek wordt afgewezen als de betaling niet meer in aanmerking komt — zie POST /payments/\{id}/void.
string | null
vereist
De bezoekers-ID van de Whop-pixel voor de browser van de koper bij de checkout, met prefix wuid_. Null wanneer de checkoutpagina geen Whop-pixel had, wanneer de koper niet aanwezig was bij de checkout, of zonder de permissie member:basic:read.
Payment