Skip to main content
Gebruik de Payouts API om uitbetalingen aan te maken en te volgen, opgeslagen uitbetalingsmethoden te beheren en de verwachte aankomstgegevens te tonen voor geld dat Whop verlaat.

Endpoints

Attributen

string
vereist
Payout-ID, met prefix wdrl_.
string
vereist
Het uitbetalingsbedrag in hele valuta-eenheden, als decimale string.
boolean
vereist
Of POST /payouts/\{id}/cancel op dit moment effect zou hebben op deze uitbetaling: true zolang deze in_review is, zolang deze processing is en er nog niets bij de uitbetalingsprovider is ingediend, of zolang een ingediende uitbetaling nog bij de provider kan worden geannuleerd. false zodra het geld is aangekomen of de uitbetaling al is beëindigd.
object | null
vereist
Hoe het saldo naar de uitbetalingsvaluta is omgerekend voordat de uitbetaling werd verstuurd. null wanneer de uitbetaling is verstuurd vanuit een saldo in de eigen valuta.

Eigenschappen

string
vereist
Het bedrag dat de omrekening van het saldo heeft afgeschreven, als decimale string.
string
vereist
De valuta van het saldo waarvan de omrekening het bedrag heeft afgeschreven.
number
vereist
De omrekeningskoers, in eenheden van de uitbetalingsvaluta per eenheid from_currency. Eventuele omrekeningskosten zijn in deze koers inbegrepen.
string
vereist
Wanneer de uitbetaling is aangemaakt.
string
vereist
Uitbetalingsvaluta.
string | null
vereist
Het bedrag dat in de bestemmingsvaluta is geleverd, als decimale string. Wordt toegewezen wanneer de uitbetaling wordt verwerkt, dus het is daarvoor null, en ook bij uitbetalingen zonder vastgelegde omrekening.
string | null
vereist
Valuta waarin het geld wordt geleverd, overgenomen van de uitbetalingsmethode wanneer de uitbetaling wordt aangemaakt. Bij een uitbetaling die door een omrekeningsverzoek wordt gefinancierd, volgt deze de settlement-uitbetaling die ernaast wordt aangemaakt — de GET /payouts-rij met de id van deze uitbetaling als payout_request_id — en is alleen null wanneer er geen settlement-uitbetaling bestaat.
string | null
vereist
Geschat tijdstip waarop het geld beschikbaar komt op de bestemmingsrekening.
number | null
vereist
Wisselkoers van de uitbetalingsvaluta naar de bestemmingsvaluta. Wordt toegewezen wanneer de uitbetaling wordt verwerkt, dus het is daarvoor null, en ook bij uitbetalingen zonder vastgelegde koers.
object | null
vereist
Waarom de uitbetaling eindigde zonder te betalen, of waarom deze na settlement is teruggedraaid. Aanwezig bij mislukte, geannuleerde, geweigerde en teruggedraaide uitbetalingen; anders null.

Eigenschappen

string | null
vereist
Geclassificeerde foutcode uit de bijgehouden foutcatalogus.
string | null
vereist
Het effectieve tijdstip van de terugboeking die het geld terug op het saldo zette — null als het saldo nooit is verlaten of het geld nog niet is teruggekeerd. Wordt pas ingesteld zodra de terugkeer in het grootboek is bevestigd; de grootboekboeking zelf kan kort na dit tijdstip plaatsvinden.
string | null
vereist
Voor mensen leesbare uitleg van de fout. Aanroepers met payout:destination:read kunnen tekst ontvangen die op de bestemming is afgestemd; andere aanroepers krijgen het generieke catalogusbericht.
string
vereist
De kosten die voor de uitbetaling in rekening zijn gebracht, in de uitbetalingsvaluta, als decimale string.
string
vereist
Wie de uitbetalingskosten droeg: het account zelf, of het bovenliggende platform.Beschikbare opties: self, platform
string
vereist
De opslag van Whop op de providerkosten, in de uitbetalingsvaluta, als decimale string. "0.0" wanneer er geen van toepassing is.
object
vereist
Sleutel-waardegegevens die bij het aanmaken zijn toegevoegd en bij elke leesbewerking worden teruggegeven. Maximaal 50 sleutels, sleutelnamen tot 40 tekens, stringwaarden tot 500 tekens.
string
vereist
Het geplande netto bedrag voor de bestemming, in de uitbetalingsvaluta: amount min fee_amount min markup_fee wanneer fee_paid_by self is; gelijk aan amount wanneer het platform de kosten dekt. Een uitbetaling die eindigt als geweigerd, geannuleerd of mislukt heeft niets geleverd — de meeste behouden het geplande bedrag en failure geeft aan waar het geld is, maar een geannuleerde uitbetaling die door een omrekeningsverzoek is gefinancierd kan in plaats daarvan de afgewikkelde uitkomst rapporteren: amount bevat wat op het saldo is gebleven, de kosten zijn nul omdat er geen in rekening zijn gebracht, en net_amount is 0 omdat er niets is geleverd.
string | null
vereist
Vrije notities die door de maker van de uitbetaling zijn toegevoegd, of null wanneer er geen zijn opgegeven. Maximaal 255 tekens.
string
vereist
string | null
vereist
Naam van de partij die de uitbetaling verwerkt.
object | null
vereist
De gebruikte opgeslagen uitbetalingsmethode. Vereist payout:destination:read; null zonder.

Eigenschappen

string | null
vereist
Bijnaam van de opgeslagen uitbetalingsmethode.
object | null
vereist
Weergavegegevens van de ondersteunde uitbetalingsmethode.

Eigenschappen

string
vereist
Hoe het geld aan de ontvanger wordt geleverd.Beschikbare opties: cash_pickup, bank_deposit, home_delivery, mobile_wallet, card, check, bill, cryptocurrency, unknown
string | null
vereist
URL van het pictogram van de ondersteunde uitbetalingsmethode.
string | null
vereist
Weergavenaam van de ondersteunde uitbetalingsmethode.
string
vereist
Het soort uitbetalingsmethode dat de uitbetaling gebruikte. external stuurde geld buiten Whop. whop_card zette geld over naar de eigen Whop Card van het account.Beschikbare opties: external, whop_card
string | null
vereist
Payout request-ID, met prefix cofr_, geretourneerd door POST /payouts. Koppel het aan de afgewikkelde uitbetaling in GET /payouts. Geeft null terug voor uitbetalingen die niet door POST /payouts zijn aangemaakt.
string | null
vereist
Hoe de uitbetaling is aangemaakt. automatic betekent een geplande automatische uitbetaling. null wanneer de uitbetaling geen vastgelegde bron heeft.Beschikbare opties: api, dashboard, automatic
string
vereist
Leveringssnelheid van de uitbetaling.Beschikbare opties: standard, instant
string | null
vereist
De betalingsomschrijving die met de uitbetaling wordt meegestuurd, of null als er geen omschrijving is ingesteld. Indien ingesteld, 5-80 afdrukbare ASCII-tekens.
string
vereist
Huidige status van de uitbetaling.Beschikbare opties: requested, in_review, processing, completed, reversed, canceled, failed, denied
string
vereist
De meest gedetailleerde machinefase onder status — bijvoorbeeld awaiting_provider_acceptance versus in_transit onder processing, of de omrekeningsfase onder requested. Informatief vocabulaire: er kunnen waarden worden toegevoegd zonder versieverhoging; status is het geversioneerde contract.
string | null
vereist
Referentie van het betaalnetwerk voor deze uitbetaling, zoals een ACH-tracenummer, een RTP- of FedNow-end-to-end-ID, een wire-IMAD of een SWIFT UETR. null totdat de referentie beschikbaar is, en bij uitbetalingen die er geen hebben.
Payout