Répondre aux litiges en utilisant l'API

Vous pouvez gérer les litiges par voie programmatique en utilisant l’API. Avec l’API, vous pouvez télécharger des preuves, répondre à des litiges et recevoir des événements de litige via des webhooks.

Si vous souhaitez gérer les litiges via le Dashboard au lieu d’utiliser l’API, consultez Répondre aux litiges.

Récupérer un litige

Pour obtenir des détails sur un litige, récupère un objet litige:

curl https://api.stripe.com/v1/disputes/
{{DISPUTE_ID}} \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:"

La réponse contient des informations à propos du litige ainsi que toute réponse ou preuve qui a déjà été fournie.

{
  object: "dispute"
  id: "{{DISPUTE_ID}}",
  charge: "ch_5Q4BjL06oPWwho",
  evidence: {
    customer_name: "Jane Austen",
    customer_purchase_ip: "127.0.0.1",
    product_description: "Widget ABC, color: red",
    shipping_tracking_number: "Z01234567890",
    uncategorized_text: "Additional notes and comments",
  },
  evidence_details: {
    due_by: 1403047735,
    submission_count: 1
  }
  ...
}

Mettre à jour un litige

Vous mettez à jour l’objet Contester et transmettez des preuves structurées à l’aide du paramètre preuve.

curl https://api.stripe.com/v1/disputes/
{{DISPUTE_ID}} \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  --data-urlencode "evidence[customer_email_address]"="email@example.com" \
  -d "evidence[shipping_date]"=2024-02-01 \
  -d "evidence[shipping_documentation]"=
"{{FILE_ID}}"

Pour consulter tous les champs disponibles pour le paramètre preuve, consultez Preuve de contestation. Vous pouvez fournir deux types de preuves, en fonction du champ mis à jour :

• Preuves textuelles, telles que customer_email et service_date. Ces preuves se composent d’une chaîne de texte.
• Preuves établies à partir de fichiers, telles que service_documentation et customer_communication. Ces preuves prennent un ID d’objet file_upload.

Vous pouvez fournir des documents ou des images (par exemple, un contrat ou une capture d’écran) comme preuve du litige en utilisant l’API de chargement de fichier. Vous devez d’abord charger un document avec le motif dispute_evidence, ce qui génère un objet File_upload que vous pouvez utiliser pour soumettre une preuve. Assurez-vous que le fichier respecte les recommandations de Stripe avant de le charger dans le cadre de la soumission d’une preuve.

Si vous souhaitez soumettre un seul fichier ou une grande quantité de texte brut comme preuve, utilisez uncategorized_text ou uncategorized_file. Cependant, remplissez le plus de champs possible pour maximiser vos chances d’infirmer le litige.

Plusieurs litiges sur un seul paiement

Bien que ce ne soit pas habituel, il est possible qu’un client conteste le même paiement plus d’une fois. Par exemple, un client peut contester le paiement de l’un des articles de sa commande s’il a été endommagé lors de la livraison, puis déposer un second litige concernant un autre article de la même commande parce qu’il ne fonctionne pas correctement.

Stripe distingue tous les litiges par un identifiant unique, qu’ils soient liés à un seul paiement ou non. Lorsque vous listez les litiges, vous pouvez filtrer les résultats pour n’afficher que les litiges pour un paiement particulier en spécifiant l’id de l’objet PaymentIntent ou Charge et en incluant le filtre payment_intent ou charge.

curl -G https://api.stripe.com/v1/disputes \
  -u "
sk_test_BQokikJOvBiI2HlWgH4olfQ2
:" \
  -d payment_intent={{PAYMENT_INTENT_ID}}

Lorsqu’un paiement fait l’objet de plusieurs litiges, utilisez l’id fourni pour chaque litige de la liste pour vous assurer que vous répondez au bon litige. pour ce faire, indiquez son id lorsque vous récupérez ou mettez à jour le litige.