Skip to main content
Utilisez l’API Payouts pour créer et suivre des versements, gérer les moyens de versement enregistrés et afficher les détails d’arrivée prévue des fonds qui quittent Whop.

Endpoints

Attributs

string
requis
ID du versement, préfixé par wdrl_.
string
requis
Le montant du versement en unités monétaires entières, sous forme de chaîne décimale.
boolean
requis
Indique si POST /payouts/\{id}/cancel agirait sur ce versement à cet instant : true tant qu’il est in_review, tant qu’il est processing sans que rien n’ait encore été soumis au prestataire de versement, ou tant qu’il est encore possible de demander l’annulation d’un versement soumis auprès du prestataire. false une fois l’argent arrivé ou le versement déjà terminé.
object | null
requis
La manière dont le solde a été converti dans la devise du versement avant l’envoi du versement. null lorsque le versement a été envoyé depuis un solde dans sa propre devise.

Propriétés

string
requis
Le montant prélevé sur le solde par la conversion, sous forme de chaîne décimale.
string
requis
La devise du solde sur lequel la conversion a prélevé le montant.
number
requis
Le taux de conversion, en unités de la devise du versement pour chaque unité de from_currency. Les éventuels frais de conversion sont inclus dans ce taux.
string
requis
Date de création du versement.
string
requis
Devise du versement.
string | null
requis
Le montant livré dans la devise de destination, sous forme de chaîne décimale. Attribué lors du traitement du versement ; il vaut donc null avant cela et sur les versements sans conversion enregistrée.
string | null
requis
Devise dans laquelle les fonds sont livrés, reprise du moyen de versement lors de la création du versement. Sur un versement financé par une demande de conversion, elle suit le versement de règlement créé en parallèle — la ligne de GET /payouts portant l’id de ce versement comme payout_request_id — et ne vaut null que lorsqu’aucun versement de règlement n’existe.
string | null
requis
Date estimée à laquelle les fonds deviennent disponibles sur le compte de destination.
number | null
requis
Taux de change de la devise du versement vers la devise de destination. Attribué lors du traitement du versement ; il vaut donc null avant cela et sur les versements sans taux enregistré.
object | null
requis
La raison pour laquelle le versement s’est terminé sans paiement, ou pour laquelle il a été annulé après règlement. Présent sur les versements échoués, annulés, refusés et contrepassés ; null sinon.

Propriétés

string | null
requis
Code d’échec classifié issu du catalogue d’erreurs maintenu.
string | null
requis
La date d’effet de la contrepassation qui a remis les fonds sur le solde — null s’ils ne l’ont jamais quitté ou ne sont pas encore revenus. Renseigné uniquement une fois le retour confirmé dans le grand livre ; l’écriture comptable elle-même peut intervenir quelques instants après cette date.
string | null
requis
Explication lisible de l’échec. Les appelants disposant de payout:destination:read peuvent recevoir un texte personnalisé selon la destination ; les autres appelants reçoivent le message générique du catalogue.
string
requis
Les frais facturés pour le versement, dans la devise du versement, sous forme de chaîne décimale.
string
requis
Qui a supporté les frais de versement : le compte lui-même ou sa plateforme parente.Options disponibles : self, platform
string
requis
La majoration de Whop sur les frais du prestataire, dans la devise du versement, sous forme de chaîne décimale. "0.0" lorsqu’aucune ne s’applique.
object
requis
Données clé-valeur associées lors de la création et renvoyées à chaque lecture. 50 clés au maximum, noms de clés jusqu’à 40 caractères, valeurs de chaîne jusqu’à 500 caractères.
string
requis
Le montant net prévu pour la destination, dans la devise du versement : amount moins fee_amount moins markup_fee lorsque fee_paid_by vaut self ; égal à amount lorsque la plateforme prend en charge les frais. Un versement qui se termine refusé, annulé ou échoué n’a rien livré — la plupart conservent le montant prévu et failure indique où se trouvent les fonds, mais un versement annulé financé par une demande de conversion peut à la place indiquer le résultat réglé : amount contient ce qui est resté sur le solde, les frais sont nuls car aucun n’a été facturé, et net_amount vaut 0 car rien n’a été livré.
string | null
requis
Notes libres ajoutées par le créateur du versement, ou null lorsqu’aucune n’a été fournie. 255 caractères maximum.
string
requis
string | null
requis
Nom de l’entité qui traite le versement.
object | null
requis
Le moyen de versement enregistré utilisé. Nécessite payout:destination:read ; null sans celui-ci.

Propriétés

string | null
requis
Surnom du moyen de versement enregistré.
object | null
requis
Détails d’affichage du moyen de versement pris en charge.

Propriétés

string
requis
La manière dont les fonds sont livrés au destinataire.Options disponibles : cash_pickup, bank_deposit, home_delivery, mobile_wallet, card, check, bill, cryptocurrency, unknown
string | null
requis
URL de l’icône du moyen de versement pris en charge.
string | null
requis
Nom d’affichage du moyen de versement pris en charge.
string
requis
Le type de moyen de versement utilisé par le versement. external a envoyé les fonds hors de Whop. whop_card a transféré les fonds sur la propre Whop Card du compte.Options disponibles : external, whop_card
string | null
requis
ID de la demande de versement, préfixé par cofr_, renvoyé par POST /payouts. Associez-le au versement réglé dans GET /payouts. Renvoie null pour les versements non créés par POST /payouts.
string | null
requis
La manière dont le versement a été créé. automatic désigne un versement automatique programmé. null lorsque le versement n’a pas de source enregistrée.Options disponibles : api, dashboard, automatic
string
requis
Vitesse de livraison du versement.Options disponibles : standard, instant
string | null
requis
Le libellé de paiement envoyé avec le versement, ou null si aucun libellé n’a été défini. Lorsqu’il est défini, 5 à 80 caractères ASCII imprimables.
string
requis
Statut actuel du versement.Options disponibles : requested, in_review, processing, completed, reversed, canceled, failed, denied
string
requis
La phase machine la plus fine sous status — par exemple awaiting_provider_acceptance ou in_transit sous processing, ou la phase de conversion sous requested. Vocabulaire informatif : des valeurs peuvent être ajoutées sans changement de version ; status est le contrat versionné.
string | null
requis
Référence du réseau de paiement pour ce versement, comme un numéro de trace ACH, un ID de bout en bout RTP ou FedNow, un IMAD de virement ou un UETR SWIFT. null tant que la référence n’est pas disponible, et sur les versements qui n’en ont pas.
Payout