Skip to main content
Brug Payouts API’et til at oprette og følge udbetalinger, administrere gemte udbetalingsmetoder og vise forventede ankomstoplysninger for midler, der forlader Whop.

Endpoints

Attributter

string
påkrævet
Udbetalings-ID med præfikset wdrl_.
string
påkrævet
Udbetalingsbeløbet i hele valutaenheder som en decimalstreng.
boolean
påkrævet
Om POST /payouts/\{id}/cancel ville have effekt på denne udbetaling lige nu: true, mens den er in_review, mens den er processing, uden at noget endnu er indsendt til udbetalingsudbyderen, eller mens en indsendt udbetaling stadig kan anmodes om annullering hos udbyderen. false, når pengene er ankommet, eller udbetalingen allerede er afsluttet.
object | null
påkrævet
Hvordan saldoen blev konverteret til udbetalingsvalutaen, før udbetalingen blev sendt. null, når udbetalingen blev sendt fra en saldo i dens egen valuta.

Egenskaber

string
påkrævet
Beløbet, som konverteringen tog fra saldoen, som en decimalstreng.
string
påkrævet
Valutaen for den saldo, konverteringen tog beløbet fra.
number
påkrævet
Konverteringskursen i enheder af udbetalingsvalutaen for hver enhed af from_currency. Et eventuelt konverteringsgebyr er inkluderet i denne kurs.
string
påkrævet
Hvornår udbetalingen blev oprettet.
string
påkrævet
Udbetalingsvaluta.
string | null
påkrævet
Beløbet leveret i destinationsvalutaen som en decimalstreng. Tildeles, når udbetalingen behandles, så det er null før da og på udbetalinger uden en registreret konvertering.
string | null
påkrævet
Valutaen, midlerne leveres i, hentet fra udbetalingsmetoden, når udbetalingen oprettes. På en udbetaling finansieret af en konverteringsanmodning følger den den afregningsudbetaling, der blev oprettet sammen med den — GET /payouts-rækken, der har denne udbetalings id som payout_request_id — og er kun null, når der ikke findes nogen afregningsudbetaling.
string | null
påkrævet
Anslået tidspunkt, hvor midlerne bliver tilgængelige på destinationskontoen.
number | null
påkrævet
Vekselkurs fra udbetalingsvalutaen til destinationsvalutaen. Tildeles, når udbetalingen behandles, så den er null før da og på udbetalinger uden en registreret kurs.
object | null
påkrævet
Hvorfor udbetalingen sluttede uden at betale, eller hvorfor den blev tilbageført efter afregning. Til stede på mislykkede, annullerede, afviste og tilbageførte udbetalinger; ellers null.

Egenskaber

string | null
påkrævet
Klassificeret fejlkode fra det vedligeholdte fejlkatalog.
string | null
påkrævet
Det effektive tidspunkt for den tilbageførsel, der satte midlerne tilbage på saldoen — null, hvis de aldrig forlod den eller endnu ikke er returneret. Angives først, når returneringen er bekræftet i hovedbogen; selve bogføringen i hovedbogen kan ske kort efter dette tidspunkt.
string | null
påkrævet
Menneskelæsbar forklaring på fejlen. Kaldere med payout:destination:read kan modtage tekst, der er tilpasset destinationen; andre kaldere får den generiske katalogbesked.
string
påkrævet
Gebyret, der opkræves for udbetalingen, i udbetalingsvalutaen, som en decimalstreng.
string
påkrævet
Hvem der bar udbetalingsgebyret: kontoen selv eller dens overordnede platform.Tilgængelige muligheder: self, platform
string
påkrævet
Whops tillæg på udbyderens gebyr, i udbetalingsvalutaen, som en decimalstreng. "0.0", når der ikke gælder noget.
object
påkrævet
Nøgle-værdi-data, der tilknyttes ved oprettelsen og returneres ved hver læsning. Højst 50 nøgler, nøglenavne på op til 40 tegn, strengværdier på op til 500 tegn.
string
påkrævet
Det planlagte nettobeløb til destinationen, i udbetalingsvalutaen: amount minus fee_amount minus markup_fee, når fee_paid_by er self; lig med amount, når platformen dækker gebyrerne. En udbetaling, der ender som afvist, annulleret eller mislykket, leverede intet — de fleste beholder det planlagte tal, og failure angiver, hvor midlerne er, men en annulleret udbetaling finansieret af en konverteringsanmodning kan i stedet rapportere det afregnede resultat: amount angiver det, der blev på saldoen, gebyrerne er nul, fordi der ikke blev opkrævet nogen, og net_amount er 0, fordi intet blev leveret.
string | null
påkrævet
Fritekstnoter tilføjet af den, der oprettede udbetalingen, eller null, når der ikke blev angivet nogen. Maksimalt 255 tegn.
string
påkrævet
string | null
påkrævet
Navnet på den enhed, der behandler udbetalingen.
object | null
påkrævet
Den gemte udbetalingsmetode, der blev brugt. Kræver payout:destination:read; null uden det.

Egenskaber

string | null
påkrævet
Kaldenavn for den gemte udbetalingsmetode.
object | null
påkrævet
Visningsoplysninger for den understøttede udbetalingsmetode.

Egenskaber

string
påkrævet
Hvordan midlerne leveres til modtageren.Tilgængelige muligheder: cash_pickup, bank_deposit, home_delivery, mobile_wallet, card, check, bill, cryptocurrency, unknown
string | null
påkrævet
Ikon-URL for den understøttede udbetalingsmetode.
string | null
påkrævet
Visningsnavn for den understøttede udbetalingsmetode.
string
påkrævet
Den type udbetalingsmetode, udbetalingen brugte. external sendte midler ud af Whop. whop_card flyttede midler over på kontoens eget Whop Card.Tilgængelige muligheder: external, whop_card
string | null
påkrævet
Udbetalingsanmodnings-ID med præfikset cofr_, returneret af POST /payouts. Match det med den afregnede udbetaling i GET /payouts. Returnerer null for udbetalinger, der ikke er oprettet af POST /payouts.
string | null
påkrævet
Hvordan udbetalingen blev oprettet. automatic betyder en planlagt automatisk udbetaling. null, når udbetalingen ikke har nogen registreret kilde.Tilgængelige muligheder: api, dashboard, automatic
string
påkrævet
Leveringshastighed for udbetalingen.Tilgængelige muligheder: standard, instant
string | null
påkrævet
Betalingsbeskrivelsen, der sendes med udbetalingen, eller null, hvis der ikke blev angivet nogen beskrivelse. Når den er angivet, 5-80 udskrivbare ASCII-tegn.
string
påkrævet
Aktuel udbetalingsstatus.Tilgængelige muligheder: requested, in_review, processing, completed, reversed, canceled, failed, denied
string
påkrævet
Den mest detaljerede maskinfase under status — for eksempel awaiting_provider_acceptance vs. in_transit under processing, eller konverteringsfasen under requested. Informativt ordforråd: værdier kan tilføjes uden en versionsændring; status er den versionerede kontrakt.
string | null
påkrævet
Betalingsnetværkets reference for denne udbetaling, såsom et ACH-sporingsnummer, et RTP- eller FedNow-end-to-end-ID, en wire-IMAD eller en SWIFT UETR. null, indtil referencen er tilgængelig, og på udbetalinger, der ikke har nogen.
Payout