Use a API para responder a contestações

Você pode gerenciar contestações automaticamente usando a API. Com a API, você pode enviar comprovantes, responder a contestações e receber eventos de contestação usando webhooks.

Se você quiser gerenciar contestações usando o Dashboard em vez de usar a API, consulte Responder a contestações.

Recuperar uma contestação

Para obter detalhes sobre uma contestação, recupere um objeto Dispute:

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

A resposta contém informações sobre a contestação e todas as respostas ou comprovantes já fornecidos.

{
  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
  }
  ...
}

Atualizar uma contestação

Você atualiza o objeto Dispute e passa comprovantes estruturados com o parâmetro evidence.

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}}"

Para visualizar todos os campos disponíveis para o parâmetro evidence, consulte Comprovante de contestação. Há dois tipos de comprovantes que você pode fornecer, dependendo do campo que está sendo atualizado:

• Comprovantes em texto, como customer_email e service_date. Esse tipo de comprovante é uma string de texto.
• Comprovantes estabelecidos em arquivos, como service_documentation e customer_communication recebem um ID de objeto file_upload.

Para fornecer documentos ou imagens (como contratos ou capturas de tela) como comprovantes para a contestação, use a API File Upload. Primeiro, você carrega um documento com a finalidade de dispute_evidence, a qual gera um objeto File_upload que você pode usar ao enviar comprovantes. Confira as recomendações da Stripe antes de enviar arquivos como comprovantes.

Se quiser enviar um único arquivo ou uma grande quantidade de texto simples como comprovante, use uncategorized_text ou uncategorized_file. No entanto, preencha o máximo de campos possível para ter a melhor chance de reverter uma contestação.

Várias contestações em um único pagamento

Não é comum, mas um cliente pode contestar o mesmo pagamento mais de uma vez. Por exemplo, um cliente pode contestar parcialmente o pagamento de um dos itens em um pedido se ele foi danificado na entrega e, em seguida, registrar uma segunda contestação contra um item diferente no mesmo pedido porque o item não funcionou corretamente.

A Stripe distingue todas as contestações por um identificador único, independentemente de estarem relacionadas a um único pagamento. Quando você lista contestações, pode filtrar os resultados para mostrar apenas contestações de um pagamento específico, especificando a id do objeto PaymentIntent ou Charge e incluindo o filtro payment_intent ou charge.

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

Quando um pagamento tem várias contestações, use o id fornecido para cada contestação retornada na lista para assegurar que está respondendo à contestação correta ao especificar id quando você recupera ou atualiza a contestação.