confirmation_token for den metode, køberen valgte, eller en off-session-betaling med et eksisterende medlems gemte betalingsmetode.
Brug Payments API’et til at opkræve købere, vise og hente betalinger samt refundere, annullere, capture eller forsøge dem igen. Opkrævningen kører i baggrunden, så svaret ved oprettelsen er ikke resultatet. Poll Hent status for at se, hvor langt betalingen er nået, og, mens den er requires_action, hvad køberen skal gøre som det næste: følge en omdirigering, gennemføre 3D Secure, vise overførselsinstruktioner eller tilknytte en bankkonto. Opdater betalingens return_url for at ændre, hvor de lander bagefter, indtil de vender tilbage.
Endpoints
Attributter
Det, kontoen beholder: totalen fratrukket Whops gebyrer. Null, når du læser betalingen som dens køber.
Egenskaber
Egenskaber
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er
"10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.Hvor mange decimaler beløbet har. Dette er den præcision, selve opkrævningen kører med.
Det, køberen opkræves for denne betaling: totalen plus eventuelle købergebyrer, i den valuta, køberen betaler i. Refunderinger reducerer det ikke;
presentment_refunded_amount angiver dem i samme valuta.Egenskaber
Egenskaber
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er
"10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.Hvor mange decimaler beløbet har. Dette er den præcision, selve opkrævningen kører med.
Hvornår Whop automatisk vil capture denne autoriserede kortbetaling, medmindre den annulleres først, som et ISO 8601-tidsstempel. Null, når der ikke blev anmodet om automatisk capture.
Den faktureringsadresse, køberen indtastede, eller null.
Egenskaber
Egenskaber
Hvorfor opkrævningen blev oprettet: et første køb, en fornyelse, en engangsbetaling eller en manuel opkrævning.
Hvornår reservationen på denne autoriserede kortbetaling udløber, hvis den ikke capturees først, som et ISO 8601-tidsstempel. Null, når betalingen ikke blev oprettet til senere capture.
Den checkout-konfiguration, køberen betalte via, med præfikset
ch_, eller null.Skemaet og værten for det websted, hvor køberen åbnede checkouten, såsom
https://store.example.com. Brug det til at skelne betalinger fra forskellige websteder på én konto. Null, når webstedet ikke blev registreret, herunder for betalinger foretaget uden køberens tilstedeværelse.Den checkout-oplevelse, der frembragte denne betaling, såsom
embedded_checkout for en checkout på kontoens eget websted eller off_session for en abonnementsfornyelse. Null, når checkouten ikke blev registreret.Tilgængelige muligheder: hosted_checkout, embedded_checkout, custom_checkout, modal_checkout, in_app_checkout, mobile_checkout, off_session, card_presentDen legitimation, en købers overflade fremviser for at polle denne betaling, angive dens retur-URL og genoptage den, når banken bad kunden om at godkende sig. Kun på betalinger oprettet ud fra et confirmation token eller som venter på den godkendelse, null, når du læser betalingen som dens køber, og altid null i listesvar — hent betalingen for at få den.
Den valuta, betalingen afregnes i, ISO 4217 med små bogstaver. Alle pengefelter nedenfor er angivet i den, medmindre andet er anført.Tilgængelige muligheder:
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, hnlKøberens e-mailadresse. Null uden
member:email:read på kontoen, eller når køberen ikke har en tildelt e-mail.Den normaliserede afvisningsårsag for det seneste mislykkede forsøg, eller null.
Hvornår en udsteder advarede om, at denne betaling vil blive bestridt, eller null.
Hvornår den seneste tvist om denne betaling blev åbnet, som et ISO 8601-tidsstempel. Null, når betalingen aldrig er blevet bestridt, eller uden tilladelsen payment:dispute:read.
De aktive reservationer på denne betaling. Hver reservation har sin egen frigivelsesdato, uafhængig af
settlement_time_at. Tom, når intet er reserveret, eller du læser betalingen som dens køber; frigivne reservationer udelades.Egenskaber
Egenskaber
Det aktuelt reserverede beløb i reservationens valuta.
Egenskaber
Egenskaber
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er
"10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.Hvor mange decimaler beløbet har. Dette er den præcision, selve opkrævningen kører med.
Den reserveprocent, der blev registreret, da reservationen blev oprettet, for eksempel 3.5 for 3,5 %. Null for andre reservationstyper, eller når der ikke blev registreret nogen procent.
Hvornår de reserverede midler efter planen bliver tilgængelige, som et ISO 8601-tidsstempel. Aldrig tidligere end betalingens afregningsdato. Null, når frigivelsen afhænger af en hændelse, såsom afklaring af en forsendelse, frem for en dato.
Køberens IP-adresse ved checkout: den, som Whops svindelscreening identificerede, ellers den, Whop registrerede fra køberens browser ved checkout. Null, når køberen ikke var til stede ved checkout, såsom ved en abonnementsfornyelse eller en opkrævning foretaget uden køberens tilstedeværelse, eller når du læser betalingen som dens køber.
Alt, hvad denne betaling opkrævede for, i købsrækkefølge, med antal og subtotaler i købsvalutaen. Betalinger foretaget, før varesnapshots blev registreret, returnerer den enkelte vare, der følger af deres variant. Tom, når ingen varer eller variant kan bestemmes.
Egenskaber
Egenskaber
Linjepost-ID med præfikset
li_. Null, når betalingen er ældre end varesnapshots, og varen læses fra betalingens variant.Det produkt, varianten tilhører, med præfikset
prod_. På en betaling, der er ældre end varesnapshots, falder dette tilbage til variantens produkt, så det kan være angivet, hvor overordnets egen product_id er null. Null for en variant uden produkt.Variantens lagerenhed (SKU), fritekst angivet af sælgeren (f.eks.
TSHIRT-LARGE-BLUE). Konti med SKU-suffikser for faktureringsårsag aktiveret modtager den påført årsagen til opkrævningen: -S for en første abonnementsopkrævning, -R for en fornyelse, -C for et engangskøb, -U, når betalingens egne metadata indeholder upsell: true, -F, når intet blev opkrævet. Andre faktureringsårsager har den rene SKU. null, når varianten ikke har nogen SKU eller er blevet slettet.Det registrerede beløb for hele denne vares antal før rabatter, moms og gebyrer, i dens købsvaluta. Returnerer
null, når der ikke blev registreret noget varebeløb.Egenskaber
Egenskaber
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er
"10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.Hvor mange decimaler beløbet har. Dette er den præcision, selve opkrævningen kører med.
Den købte variant med præfikset
plan_. Null, når varianten siden er blevet slettet.Køberens medlemspost på kontoen med præfikset
mber_. Null uden tilladelsen member:basic:read, medmindre du er køberen.Det medlemskab, denne betaling faktureres mod, med præfikset
mem_. Null for enkeltkøb eller uden tilladelsen member:basic:read, medmindre du er køberen.Dine egne nøgle-værdi-data, der blev tilknyttet, da betalingen blev oprettet. Null, når du læser betalingen som dens køber.
True for en betalt betaling med en leveringsadresse, ingen forsendelse og ingen fuld refundering. Null uden tilladelsen shipment:basic:read.
True, når midler er reserveret, indtil ordren afsendes, og der endnu ikke er tilføjet et sporingsnummer. Null uden tilladelsen shipment:basic:read.
Betalingsinstrumentet formet til visning: et navn rettet mod køberen, det standardiserede ikonsæt og, når det var et kort, kortets mærke, sidste fire cifre, udstederidentifikationsnummer og det netværkstransaktions-id, kontoen bruger til kortet. Netværkstransaktions-id’et er null, når du læser betalingen som dens køber.
Egenskaber
Egenskaber
Kun kort-, Apple Pay- og Google Pay-betalinger: kortets netværk, sidste fire cifre, udstederidentifikationsnummer, udløbsdato og netværkstransaktions-id.
Egenskaber
Egenskaber
Netværksidentifikatoren (
visa, amex, …), der matcher poster i card.networks og gemte kortbetalingsmetoder. Null, når vaulten ikke registrerede netværket.Udstederidentifikationsnummeret, også kaldet BIN: kortets første seks eller otte cifre, som identificerer den udstedende bank. Null, når processoren ikke rapporterede det.
Det netværkstransaktions-id, denne konto bruger til kortet. Det er denne kontos 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 et, der fulgte 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, der sendes, når en betaling først registreres, kan indeholde
null, så hent betalingen for at læse det.Instrumentnavn rettet mod køberen — “Visa •••• 4242”, når kortet blev vist, ellers metodens eget navn (“Klarna”).
Det standardiserede ikonsæt: kvadratiske og kortformede, hver i lyse og mørke farvevarianter.
Egenskaber
Egenskaber
Den flise, der har kreditkortets proportioner (48x30).
Egenskaber
Egenskaber
Den kvadratiske flise (32x32).
Egenskaber
Egenskaber
Kun afbetalingsmetoder: hvor mange betalinger opkrævningen deles op i. Data, ikke tekst — sammensæt og oversæt etiketten på klientsiden.
Den gemte betalingsmetode, der blev opkrævet, med præfikset
payt_. Null, når metoden ikke blev gemt.Den type instrument, der blev brugt, for eksempel
card, apple_pay, klarna eller us_bank_account.Kontoens egne betalingsregler, der afgjorde denne betaling, registreret da de blev kørt. Der udføres kun én handling pr. betaling, så en regel, der matchede, men blev sprunget over eller overtrumfet, er ikke angivet. Tom, når ingen afgjorde den, når kontoen ikke havde nogen regler, når Whop blokerede betalingen, før de blev kørt, eller når du læser betalingen som dens køber.
Hvor meget der er refunderet indtil videre, i den valuta, der blev præsenteret for køberen. Nul, når intet er blevet refunderet.
Egenskaber
Egenskaber
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er
"10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.Hvor mange decimaler beløbet har. Dette er den præcision, selve opkrævningen kører med.
Den opkrævede salgsafgift eller moms i den valuta, der blev præsenteret for køberen. Null, når der ikke gjaldt nogen moms.
Egenskaber
Egenskaber
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er
"10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.Hvor mange decimaler beløbet har. Dette er den præcision, selve opkrævningen kører med.
Totalen rettet mod kontoen i den valuta, der blev præsenteret for køberen, før konvertering til afregningsvalutaen. Eksklusive købergebyrer.
Egenskaber
Egenskaber
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er
"10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.Hvor mange decimaler beløbet har. Dette er den præcision, selve opkrævningen kører med.
Det produkt, varianten tilhører, med præfikset
prod_. Null for en variant uden produkt.Den rabatkode, der blev anvendt ved checkout, med præfikset
promo_, eller null.Det betalingstilbud, denne betaling opkrævede, med præfikset
pq_: dets køb, rabatkode og tax_amount er tilbuddets. Null, når betalingen ikke angav noget tilbud, og momsen blev beregnet ved opkrævningen.Whop-hostet URL, hvor køberen kan logge ind og gennemføre 3D Secure for en off-session-opkrævning, som banken udfordrede — en abonnementsfornyelse eller en betaling med gemt kort. Null, når gendannelse ikke er tilgængelig, du mangler
member:basic:read, eller i listesvar. Hent betalingen for at få den.True, når betalingen er
paid, endnu ikke fuldt refunderet, og dens processor understøtter refunderinger.Hvor meget der er refunderet indtil videre, som det blev afregnet — refunderinger konverteres til den kurs, der gjaldt, da hver enkelt blev udstedt, ikke betalingens oprindelige kurs.
Egenskaber
Egenskaber
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er
"10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.Hvor mange decimaler beløbet har. Dette er den præcision, selve opkrævningen kører med.
Hvornår det tidligste svar forfalder på en tvist eller en Resolution Center-sag, der afventer kontoens svar, som et ISO 8601-tidsstempel. Null, når intet afventer svar, eller uden tilladelse til at læse den pågældende tvist eller sag.
True, når betalingen kan forsøges igen manuelt med
POST /payments/\{id}/retry. Betalingen skal være open og ikke betalt via et betalingslink til en faktura. Dens medlemskab skal være active, trialing eller past_due, eller betalingen skal være en mislykket første betaling på et drafted medlemskab. Dens ene manuelle nye forsøg må ikke være brugt. Et nyt forsøg kan stadig blive afvist, når kontoen aktuelt ikke kan modtage betalinger.Whops offentliggjorte risikoindeks fra 0 (lavest) til 100 (højest), inklusive håndhævede beslutningsgulve. Dette er ikke en svindelsandsynlighed. Null, når der ikke er nogen score tilgængelig, eller du læser betalingen som dens køber.
Forældet. Forklaringer på risikoscore leveres ikke længere; altid null. FORÆLDET: Forklaringer på risikoscore leveres ikke længere. Altid null.
Hvornår den del, der ikke er angivet i
holds, bogføres på kontoens disponible saldo, ved midnat UTC. posted_at i webhooken financial_activity.funds_available har samme værdi, når den afregning, der frigiver den, bogføres. Null, indtil betalingen er betalt, eller når du læser betalingen som dens køber, og altid null i listesvar — hent betalingen for at få den.Den forsendelse, der opfylder denne betaling, med præfikset
ship_. Null, når intet afsendes, eller uden tilladelsen shipment:basic:read.Leveringsadressen for fysiske varer, eller null.
Egenskaber
Egenskaber
Opkrævningens livscyklustilstand:
open, mens opkrævningen udestår, paid, når pengene er flyttet, pending, mens en afregningskanal clearer, void/uncollectible, når den sluttede uden opkrævning.Tilgængelige muligheder: draft, open, authorized, paid, pending, uncollectible, unresolved, voidDashboardets mere detaljerede aflæsning af betalingen, der inddrager refunderinger, tvister og Resolution Center-sager.Tilgængelige muligheder:
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_resolutionPrisen før rabatter, moms og gebyrer.
Egenskaber
Egenskaber
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er
"10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.Hvor mange decimaler beløbet har. Dette er den præcision, selve opkrævningen kører med.
Den opkrævede salgsafgift eller moms. Null, når der ikke gjaldt nogen moms.
Egenskaber
Egenskaber
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er
"10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.Hvor mange decimaler beløbet har. Dette er den præcision, selve opkrævningen kører med.
Om
tax_amount blev lagt oven i prisen (exclusive) eller allerede var inkluderet i den (inclusive).Hvor meget af den opkrævede moms der indtil videre er returneret til køberen. Nul, når betalingen ikke havde nogen moms, eller når intet er blevet refunderet.
Egenskaber
Egenskaber
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er
"10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.Hvor mange decimaler beløbet har. Dette er den præcision, selve opkrævningen kører med.
Totalen rettet mod kontoen: prisen efter rabatter plus eventuel moms lagt oveni. Eksklusive købergebyrer, som køberen betaler ud over dette beløb — så dette er ikke nødvendigvis, hvad der står på køberens kontoudtog;
amount_charged er det, køberen opkræves.Egenskaber
Egenskaber
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er
"10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.Hvor mange decimaler beløbet har. Dette er den præcision, selve opkrævningen kører med.
Totalen konverteret til USD på tidspunktet for opkrævningen, til rapportering på tværs af valutaer. Eksklusive valutatillægget for adaptiv prissætning, som kontoen ikke beholder. Null, når du læser betalingen som dens køber.
Egenskaber
Egenskaber
Beløbet i hovedenheder som en præcis decimalstreng. For eksempel er
"10.00" ti dollars. Det er en streng, så ingen float afrunder det undervejs.Hvor mange decimaler beløbet har. Dette er den præcision, selve opkrævningen kører med.
Køberen. Null, når køberen er en konto frem for en bruger.
Egenskaber
Egenskaber
Køberens browser-user agent ved checkout. Null, når køberen ikke var til stede ved checkout, såsom ved en abonnementsfornyelse, eller uden tilladelsen member:basic:read.
Resultaterne af Address Verification Service (AVS), kortholdernavn og Card Verification Value (CVV/CVC), eller null, når processoren ikke returnerede nogen, eller du læser betalingen som dens køber.
Egenskaber
Egenskaber
Resultatet af Address Verification Service (AVS) for faktureringsadressens gade.
Acquirer Reference Number (ARN), der sporer denne opkrævning gennem kortnetværket, eller null, når processoren ikke returnerede et.
Kortudstederens autorisationskode for denne opkrævning, eller null, når processoren ikke returnerede en.
True, når betalingen kan annulleres. Anmodningen afvises, hvis betalingen ikke længere er berettiget — se
POST /payments/\{id}/void.Payment

