Endpoints
Attributs
Indique si le litige peut être concédé au client avec
POST /disputes/\{id} /accept. Vrai uniquement pour une rétrofacturation toujours en attente de
réponse, avant evidence_due_at, dont le processeur de paiement prend en
charge l’acceptation des litiges. Les demandes de renseignements ne sont
jamais acceptables.Le client qui a déposé le litige.
Propriétés
Propriétés
L’adresse e-mail du client. Nécessite le scope
member:email:read ; null
sans celui-ci.L’ID utilisateur du client, préfixé par
user_. null pour un paiement en
tant qu’invité.Le dossier de preuves envoyé au processeur pour contester le litige.
Propriétés
Propriétés
Journal des accès du client au produit, comme l’activité de connexion ou de
téléchargement.
Le document de politique d’annulation. Par défaut, la politique d’annulation du compte, puis ses conditions d’utilisation, puis sa politique de retour, puis la politique de la plateforme Whop.
Propriétés
Propriétés
L’ID de la pièce jointe.
null pour une politique hébergée par Whop, qui
n’est pas un fichier importé.Indique s’il s’agit de la politique hébergée par Whop elle-même, utilisée à la
place car le vendeur n’en a importé aucune. La renvoyer dans un PATCH ne
modifie rien.
La manière dont la politique d’annulation a été présentée au client avant
l’achat.
Correspondance avec le client, ou preuve qu’il a utilisé le produit.
Propriétés
Propriétés
L’ID de la pièce jointe.
null pour une politique hébergée par Whop, qui
n’est pas un fichier importé.Indique s’il s’agit de la politique hébergée par Whop elle-même, utilisée à la
place car le vendeur n’en a importé aucune. La renvoyer dans un PATCH ne
modifie rien.
Documents de preuve supplémentaires, au-delà des quatre emplacements fixes — définis via
evidence.documents sur PATCH /disputes/\{id}. Chacun est inclus dans le dossier soumis sous son document_type.Propriétés
Propriétés
Placeholder BlurHash pour une image ou une vidéo. Null lorsqu’il n’est pas
disponible ou a été supprimé par la modération.
Le type MIME du fichier importé. Les importations sont limitées aux types acceptés par le processeur et rejetées en l’absence de type — jamais null.Options disponibles :
application/pdf, application/json, image/jpeg, image/png, image/webpCe que prouve ce document.
return_policy, cancellation_policy et terms_of_service sont les documents de politique du vendeur. Un document de politique remplace la copie du compte pour ce litige. return_policy, cancellation_policy et customer_communication remplacent également l’emplacement de preuve fixe correspondant. shipping_policy correspond aux conditions d’expédition du vendeur. customer_communication est la correspondance avec l’acheteur, comme un fil de support ou un historique de chat. product_image est une photo du produit ou du service reçu par l’acheteur. physical_fulfillment est la preuve qu’une commande physique a été expédiée et est arrivée. digital_fulfillment est la preuve que l’acheteur a accédé à un produit numérique. customer_order_history correspond aux commandes passées de l’acheteur auprès de ce vendeur. prior_transactions est l’historique de paiement de l’acheteur sur la plateforme, pour une défense contre la fraude. customer_session correspond aux données de paiement, comme l’adresse IP, l’empreinte de l’appareil, les résultats AVS et CVV, et le résultat 3D Secure. subscription correspond aux preuves du cycle de vie de l’adhésion, comme les renouvellements, l’annulation et les rappels envoyés. complete_evidence est la réponse complète du vendeur sous forme d’un seul PDF de 19 pages au maximum, et il doit être le seul document. Whop envoie un document complete_evidence au processeur à la place de tous les autres champs de preuve, pièces jointes et documents.Options disponibles : return_policy, shipping_policy, cancellation_policy, terms_of_service, physical_fulfillment, customer_order_history, product_image, prior_transactions, customer_session, digital_fulfillment, subscription, customer_communication, complete_evidenceDurée de l’audio ou de la vidéo en secondes. Null lorsqu’elle n’est pas
disponible ou a été supprimée par la modération.
Hauteur de l’image ou de la vidéo en pixels. Null lorsqu’elle n’est pas
disponible ou a été supprimée par la modération.
La taille en octets que doit avoir chaque partie (sauf la dernière). Présent
uniquement lors de la création, et uniquement pour les importations multipart.
L’ID de l’importation multipart, à renvoyer à
complete. Présent uniquement
lors de la création, et uniquement pour les importations multipart.L’URL présignée de chaque partie. Présent uniquement lors de la création, et uniquement pour les importations multipart.
Indique si la modération a supprimé le fichier. Lorsque
true, url sert une
image de remplacement. filename, size et content_type décrivent toujours
le fichier d’origine.L’étape où se trouve le fichier dans son cycle de vie d’importation.Options disponibles :
pending, processing, ready, failedURL présignée vers laquelle envoyer (PUT) les octets du fichier. Présent
uniquement lors de la création, et uniquement pour les importations en une
seule partie.
Une URL pour télécharger le fichier. Les fichiers publics obtiennent une URL
CDN permanente, et les fichiers privés une URL signée qui expire.
null tant
que l’importation n’est pas terminée. Lorsque la modération supprime le
fichier, une URL d’image de remplacement.Les fichiers
public sont servis depuis une URL CDN non signée. Les fichiers private sont servis depuis une URL signée qui expire.Options disponibles : public, privateURL de la forme d’onde audio. Null lorsqu’elle n’est pas disponible ou a été
supprimée par la modération.
Le document de politique de remboursement. Par défaut, la politique de retour du compte, puis ses conditions d’utilisation, puis la politique de la plateforme Whop.
Propriétés
Propriétés
L’ID de la pièce jointe.
null pour une politique hébergée par Whop, qui
n’est pas un fichier importé.Indique s’il s’agit de la politique hébergée par Whop elle-même, utilisée à la
place car le vendeur n’en a importé aucune. La renvoyer dans un PATCH ne
modifie rien.
La manière dont la politique de remboursement a été présentée au client avant
l’achat.
La raison pour laquelle un remboursement a été refusé, lorsqu’il a été demandé
et refusé.
Preuves complémentaires qui n’entrent pas dans les autres catégories.
Propriétés
Propriétés
L’ID de la pièce jointe.
null pour une politique hébergée par Whop, qui
n’est pas un fichier importé.Indique s’il s’agit de la politique hébergée par Whop elle-même, utilisée à la
place car le vendeur n’en a importé aucune. La renvoyer dans un PATCH ne
modifie rien.
La date limite de soumission des preuves, sous forme d’horodatage ISO 8601.
null lorsque le réseau a déjà résolu automatiquement le litige (Visa RDR)
sans phase de preuves, ou lorsque le processeur n’a pas communiqué de date
limite pour ce litige.La raison pour laquelle les preuves ne peuvent plus être modifiées.
null tant que evidence_editable est true.Options disponibles : submitted, response_window_closed, not_contestableDate à laquelle les preuves ont été soumises au processeur, sous forme
d’horodatage ISO 8601.
Les frais de litige facturés au compte, dans la devise dans laquelle ils ont été prélevés.
null lorsque fee_charged est false.Propriétés
Propriétés
Le montant en unités principales, sous forme de chaîne décimale exacte. Par
exemple,
"10.00" correspond à dix dollars. Il s’agit d’une chaîne afin
qu’aucun nombre à virgule flottante ne l’arrondisse pendant le transit.Nombre de décimales du montant. Il s’agit de la précision avec laquelle le
prélèvement lui-même est effectué.
Indique si Whop a facturé au compte des frais de litige pour celui-ci.
false
lorsque le paiement a été intégralement remboursé avant l’ouverture du litige,
pour une résolution Visa RDR, et pour une demande de renseignements.Indique s’il s’agit d’une demande de renseignements préalable plutôt que d’une
rétrofacturation formelle. Les demandes de renseignements suivent le même
cycle de vie mais ne déplacent aucun fonds, sauf si elles sont escaladées.
Ce que l’émetteur de la carte a indiqué lors du dépôt du litige. Renseigné uniquement lorsque l’émetteur les fournit, et listé dans l’ordre de réception.
Tout ce que le paiement contesté a facturé, dans l’ordre d’achat.
product_id et variant_id désignent le premier de ces éléments ; les éléments suivants d’un panier n’apparaissent qu’ici. Un paiement effectué avant l’enregistrement des éléments liste l’élément unique qu’implique sa variante. Vide lorsque le paiement n’est lié à aucune variante.Propriétés
Propriétés
ID de la ligne, préfixé par
li_. Null lorsque le paiement est antérieur aux
instantanés d’éléments et que l’élément est lu à partir de la variante du
paiement.Le nom de l’élément tel qu’affiché lors du paiement (le titre du produit, à
défaut le titre de la variante).
Le produit auquel appartient la variante, préfixé par
prod_. Sur un paiement
antérieur aux instantanés d’éléments, il se rabat sur le produit de la
variante, de sorte qu’il peut être défini alors que le product_id du parent
est null. Null pour une variante sans produit.L’unité de gestion de stock (SKU) de la variante, texte libre défini par le
vendeur (par ex.
TSHIRT-LARGE-BLUE). Les comptes pour lesquels les suffixes
SKU de motif de facturation sont activés la reçoivent accompagnée de la raison
du prélèvement : -S pour un premier prélèvement d’abonnement, -R pour un
renouvellement, -C pour un achat unique, -U lorsque les métadonnées du
paiement contiennent upsell: true, -F lorsque rien n’a été facturé. Les
autres motifs de facturation portent le SKU seul. null lorsque la variante
n’a pas de SKU ou a été supprimée.Le montant enregistré pour la quantité totale de cet élément, avant remises, taxes et frais, dans sa devise d’achat. Renvoie
null lorsqu’aucun montant d’élément n’a été enregistré.Propriétés
Propriétés
Le montant en unités principales, sous forme de chaîne décimale exacte. Par
exemple,
"10.00" correspond à dix dollars. Il s’agit d’une chaîne afin
qu’aucun nombre à virgule flottante ne l’arrondisse pendant le transit.Nombre de décimales du montant. Il s’agit de la précision avec laquelle le
prélèvement lui-même est effectué.
La variante achetée, préfixée par
plan_. Null lorsque la variante a depuis
été supprimée.Le paiement contesté.
Propriétés
Propriétés
Code de devise ISO à trois lettres du paiement. Peut différer de la devise du
litige lorsque le processeur règle dans une autre devise.
L’instrument avec lequel ce paiement a été effectué, mis en forme pour l’affichage : le type de moyen de paiement, un nom destiné à l’acheteur, le jeu d’icônes standard et les informations de la carte, y compris l’id de transaction réseau que le compte utilise pour la carte, lorsqu’il s’agissait d’une carte. Null lorsque le paiement ne mentionne aucun moyen de paiement.
Propriétés
Propriétés
Paiements par carte, Apple Pay et Google Pay uniquement : le réseau de la carte, les quatre derniers chiffres, le numéro d’identification de l’émetteur, la date d’expiration et l’id de transaction réseau.
Propriétés
Propriétés
L’identifiant du réseau (
visa, amex, …), correspondant aux entrées de
card.networks et aux moyens de paiement par carte enregistrés. Null lorsque
le coffre-fort n’a pas enregistré le réseau.Le mois d’expiration de la carte, de 1 à 12. Null lorsque le coffre-fort ne
l’a pas enregistré.
L’année d’expiration de la carte à quatre chiffres. Null lorsque le
coffre-fort ne l’a pas enregistrée.
Le numéro d’identification de l’émetteur, également appelé BIN : les six ou
huit premiers chiffres de la carte, qui identifient la banque émettrice. Null
lorsque le processeur ne l’a pas communiqué.
L’id de transaction réseau que ce compte utilise pour la carte. Il s’agit de l’id propre à ce compte, issu de son premier prélèvement ou de sa première vérification en présence du client sur la carte, lorsque Whop en dispose. Sinon, il s’agit d’un id de transaction réseau antérieur pour cette carte, qui peut provenir de la transaction d’un autre compte ou avoir été apporté avec la carte. Citez-le comme transaction antérieure lors d’un prélèvement ultérieur initié par le marchand sur cette carte pour ce compte. Null tant qu’il n’en existe pas. Un webhook envoyé lors du premier enregistrement d’un paiement peut contenir
null ; récupérez donc le paiement pour le lire.Nom de l’instrument destiné à l’acheteur — “Visa •••• 4242” lorsque la carte
est connue, sinon le nom propre du moyen de paiement (“Klarna”).
Le jeu d’icônes standard : formes carrée et carte, chacune en variantes claire et sombre.
Propriétés
Propriétés
La vignette aux proportions d’une carte bancaire (48x30).
Propriétés
Propriétés
La variante de couleurs pour les surfaces sombres.
La variante de couleurs pour les surfaces claires.
La vignette carrée (32x32).
Propriétés
Propriétés
La variante de couleurs pour les surfaces sombres.
La variante de couleurs pour les surfaces claires.
Moyens de paiement échelonnés uniquement : le nombre de paiements en lesquels
le prélèvement est divisé. Il s’agit d’une donnée, pas d’un texte — composez et
traduisez le libellé côté client.
La raison pour laquelle le client affirme contester, normalisée entre les processeurs et les réseaux de cartes.
other couvre un motif de processeur que Whop n’a pas encore catégorisé.Options disponibles : fraudulent, unrecognized, declined_authorization, product_not_received, product_unacceptable, subscription_canceled, credit_not_processed, duplicate, processing_error, documentation_request, bank_cannot_process, otherLe code de motif brut du réseau de cartes ou du processeur, comme
10.4. À
titre informatif uniquement — reason n’en est pas dérivé.needs_response attend des preuves (après le refus d’un dépôt par un processeur, submission_failure_reason en indique la raison) ; generating_response signifie que les preuves sont chez le processeur, mais pas encore acceptées ; under_review est en cours d’examen par le processeur ; won/lost sont les décisions ; prevented se règle comme lost. Les statuts warning_ correspondent aux niveaux des demandes de renseignements. Après evidence_due_at, un litige ouvert indique under_review.Options disponibles : needs_response, warning_needs_response, under_review, warning_under_review, generating_response, won, lost, prevented, warning_closedLa raison pour laquelle le processeur de paiement a refusé le dernier dépôt,
en langage clair, tant que le litige est revenu à
needs_response. Corrigez
ce qui est indiqué et soumettez à nouveau. Uniquement lors de la récupération :
dispute.updated signale le retour à needs_response, puis lisez ce champ
ici.Dispute

