Disputes - Uploads Dispute Evidence

curl --request POST \
  --url https://sandbox.hyperswitch.io/disputes/evidence \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "dispute_id": "<string>",
  "access_activity_log": "<string>",
  "billing_address": "<string>",
  "cancellation_policy": "<string>",
  "cancellation_policy_disclosure": "<string>",
  "cancellation_rebuttal": "<string>",
  "customer_communication": "<string>",
  "customer_email_address": "<string>",
  "customer_name": "<string>",
  "customer_purchase_ip": "<string>",
  "customer_signature": "<string>",
  "product_description": "<string>",
  "receipt": "<string>",
  "refund_policy": "<string>",
  "refund_policy_disclosure": "<string>",
  "refund_refusal_explanation": "<string>",
  "service_date": "<string>",
  "service_documentation": "<string>",
  "shipping_address": "<string>",
  "shipping_carrier": "<string>",
  "shipping_date": "<string>",
  "shipping_documentation": "<string>",
  "shipping_tracking_number": "<string>",
  "invoice_showing_distinct_transactions": "<string>",
  "recurring_transaction_agreement": "<string>",
  "uncategorized_file": "<string>",
  "uncategorized_text": "<string>"
}
'

import requests

url = "https://sandbox.hyperswitch.io/disputes/evidence"

payload = {
    "dispute_id": "<string>",
    "access_activity_log": "<string>",
    "billing_address": "<string>",
    "cancellation_policy": "<string>",
    "cancellation_policy_disclosure": "<string>",
    "cancellation_rebuttal": "<string>",
    "customer_communication": "<string>",
    "customer_email_address": "<string>",
    "customer_name": "<string>",
    "customer_purchase_ip": "<string>",
    "customer_signature": "<string>",
    "product_description": "<string>",
    "receipt": "<string>",
    "refund_policy": "<string>",
    "refund_policy_disclosure": "<string>",
    "refund_refusal_explanation": "<string>",
    "service_date": "<string>",
    "service_documentation": "<string>",
    "shipping_address": "<string>",
    "shipping_carrier": "<string>",
    "shipping_date": "<string>",
    "shipping_documentation": "<string>",
    "shipping_tracking_number": "<string>",
    "invoice_showing_distinct_transactions": "<string>",
    "recurring_transaction_agreement": "<string>",
    "uncategorized_file": "<string>",
    "uncategorized_text": "<string>"
}
headers = {
    "api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    dispute_id: '<string>',
    access_activity_log: '<string>',
    billing_address: '<string>',
    cancellation_policy: '<string>',
    cancellation_policy_disclosure: '<string>',
    cancellation_rebuttal: '<string>',
    customer_communication: '<string>',
    customer_email_address: '<string>',
    customer_name: '<string>',
    customer_purchase_ip: '<string>',
    customer_signature: '<string>',
    product_description: '<string>',
    receipt: '<string>',
    refund_policy: '<string>',
    refund_policy_disclosure: '<string>',
    refund_refusal_explanation: '<string>',
    service_date: '<string>',
    service_documentation: '<string>',
    shipping_address: '<string>',
    shipping_carrier: '<string>',
    shipping_date: '<string>',
    shipping_documentation: '<string>',
    shipping_tracking_number: '<string>',
    invoice_showing_distinct_transactions: '<string>',
    recurring_transaction_agreement: '<string>',
    uncategorized_file: '<string>',
    uncategorized_text: '<string>'
  })
};

fetch('https://sandbox.hyperswitch.io/disputes/evidence', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.hyperswitch.io/disputes/evidence",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'dispute_id' => '<string>',
    'access_activity_log' => '<string>',
    'billing_address' => '<string>',
    'cancellation_policy' => '<string>',
    'cancellation_policy_disclosure' => '<string>',
    'cancellation_rebuttal' => '<string>',
    'customer_communication' => '<string>',
    'customer_email_address' => '<string>',
    'customer_name' => '<string>',
    'customer_purchase_ip' => '<string>',
    'customer_signature' => '<string>',
    'product_description' => '<string>',
    'receipt' => '<string>',
    'refund_policy' => '<string>',
    'refund_policy_disclosure' => '<string>',
    'refund_refusal_explanation' => '<string>',
    'service_date' => '<string>',
    'service_documentation' => '<string>',
    'shipping_address' => '<string>',
    'shipping_carrier' => '<string>',
    'shipping_date' => '<string>',
    'shipping_documentation' => '<string>',
    'shipping_tracking_number' => '<string>',
    'invoice_showing_distinct_transactions' => '<string>',
    'recurring_transaction_agreement' => '<string>',
    'uncategorized_file' => '<string>',
    'uncategorized_text' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.hyperswitch.io/disputes/evidence"

	payload := strings.NewReader("{\n  \"dispute_id\": \"<string>\",\n  \"access_activity_log\": \"<string>\",\n  \"billing_address\": \"<string>\",\n  \"cancellation_policy\": \"<string>\",\n  \"cancellation_policy_disclosure\": \"<string>\",\n  \"cancellation_rebuttal\": \"<string>\",\n  \"customer_communication\": \"<string>\",\n  \"customer_email_address\": \"<string>\",\n  \"customer_name\": \"<string>\",\n  \"customer_purchase_ip\": \"<string>\",\n  \"customer_signature\": \"<string>\",\n  \"product_description\": \"<string>\",\n  \"receipt\": \"<string>\",\n  \"refund_policy\": \"<string>\",\n  \"refund_policy_disclosure\": \"<string>\",\n  \"refund_refusal_explanation\": \"<string>\",\n  \"service_date\": \"<string>\",\n  \"service_documentation\": \"<string>\",\n  \"shipping_address\": \"<string>\",\n  \"shipping_carrier\": \"<string>\",\n  \"shipping_date\": \"<string>\",\n  \"shipping_documentation\": \"<string>\",\n  \"shipping_tracking_number\": \"<string>\",\n  \"invoice_showing_distinct_transactions\": \"<string>\",\n  \"recurring_transaction_agreement\": \"<string>\",\n  \"uncategorized_file\": \"<string>\",\n  \"uncategorized_text\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox.hyperswitch.io/disputes/evidence")
  .header("api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dispute_id\": \"<string>\",\n  \"access_activity_log\": \"<string>\",\n  \"billing_address\": \"<string>\",\n  \"cancellation_policy\": \"<string>\",\n  \"cancellation_policy_disclosure\": \"<string>\",\n  \"cancellation_rebuttal\": \"<string>\",\n  \"customer_communication\": \"<string>\",\n  \"customer_email_address\": \"<string>\",\n  \"customer_name\": \"<string>\",\n  \"customer_purchase_ip\": \"<string>\",\n  \"customer_signature\": \"<string>\",\n  \"product_description\": \"<string>\",\n  \"receipt\": \"<string>\",\n  \"refund_policy\": \"<string>\",\n  \"refund_policy_disclosure\": \"<string>\",\n  \"refund_refusal_explanation\": \"<string>\",\n  \"service_date\": \"<string>\",\n  \"service_documentation\": \"<string>\",\n  \"shipping_address\": \"<string>\",\n  \"shipping_carrier\": \"<string>\",\n  \"shipping_date\": \"<string>\",\n  \"shipping_documentation\": \"<string>\",\n  \"shipping_tracking_number\": \"<string>\",\n  \"invoice_showing_distinct_transactions\": \"<string>\",\n  \"recurring_transaction_agreement\": \"<string>\",\n  \"uncategorized_file\": \"<string>\",\n  \"uncategorized_text\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.hyperswitch.io/disputes/evidence")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dispute_id\": \"<string>\",\n  \"access_activity_log\": \"<string>\",\n  \"billing_address\": \"<string>\",\n  \"cancellation_policy\": \"<string>\",\n  \"cancellation_policy_disclosure\": \"<string>\",\n  \"cancellation_rebuttal\": \"<string>\",\n  \"customer_communication\": \"<string>\",\n  \"customer_email_address\": \"<string>\",\n  \"customer_name\": \"<string>\",\n  \"customer_purchase_ip\": \"<string>\",\n  \"customer_signature\": \"<string>\",\n  \"product_description\": \"<string>\",\n  \"receipt\": \"<string>\",\n  \"refund_policy\": \"<string>\",\n  \"refund_policy_disclosure\": \"<string>\",\n  \"refund_refusal_explanation\": \"<string>\",\n  \"service_date\": \"<string>\",\n  \"service_documentation\": \"<string>\",\n  \"shipping_address\": \"<string>\",\n  \"shipping_carrier\": \"<string>\",\n  \"shipping_date\": \"<string>\",\n  \"shipping_documentation\": \"<string>\",\n  \"shipping_tracking_number\": \"<string>\",\n  \"invoice_showing_distinct_transactions\": \"<string>\",\n  \"recurring_transaction_agreement\": \"<string>\",\n  \"uncategorized_file\": \"<string>\",\n  \"uncategorized_text\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "dispute_id": "<string>",
  "payment_id": "<string>",
  "attempt_id": "<string>",
  "amount": "<string>",
  "currency": "AED",
  "dispute_stage": "pre_dispute",
  "dispute_status": "dispute_opened",
  "connector": "<string>",
  "connector_status": "<string>",
  "connector_dispute_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "is_already_refunded": true,
  "connector_reason": "<string>",
  "connector_reason_code": "<string>",
  "challenge_required_by": "2023-11-07T05:31:56Z",
  "connector_created_at": "2023-11-07T05:31:56Z",
  "connector_updated_at": "2023-11-07T05:31:56Z",
  "profile_id": "<string>",
  "merchant_connector_id": "<string>",
  "additional_details": {
    "network_details": {
      "type": "visa",
      "rapid_dispute_resolution": {
        "applied": true
      }
    }
  }
}

{
  "error_type": "invalid_request",
  "message": "Missing required param: {param}",
  "code": "IR_04"
}

POST

disputes

evidence

Disputes - Uploads Dispute Evidence

curl --request POST \
  --url https://sandbox.hyperswitch.io/disputes/evidence \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "dispute_id": "<string>",
  "access_activity_log": "<string>",
  "billing_address": "<string>",
  "cancellation_policy": "<string>",
  "cancellation_policy_disclosure": "<string>",
  "cancellation_rebuttal": "<string>",
  "customer_communication": "<string>",
  "customer_email_address": "<string>",
  "customer_name": "<string>",
  "customer_purchase_ip": "<string>",
  "customer_signature": "<string>",
  "product_description": "<string>",
  "receipt": "<string>",
  "refund_policy": "<string>",
  "refund_policy_disclosure": "<string>",
  "refund_refusal_explanation": "<string>",
  "service_date": "<string>",
  "service_documentation": "<string>",
  "shipping_address": "<string>",
  "shipping_carrier": "<string>",
  "shipping_date": "<string>",
  "shipping_documentation": "<string>",
  "shipping_tracking_number": "<string>",
  "invoice_showing_distinct_transactions": "<string>",
  "recurring_transaction_agreement": "<string>",
  "uncategorized_file": "<string>",
  "uncategorized_text": "<string>"
}
'

import requests

url = "https://sandbox.hyperswitch.io/disputes/evidence"

payload = {
    "dispute_id": "<string>",
    "access_activity_log": "<string>",
    "billing_address": "<string>",
    "cancellation_policy": "<string>",
    "cancellation_policy_disclosure": "<string>",
    "cancellation_rebuttal": "<string>",
    "customer_communication": "<string>",
    "customer_email_address": "<string>",
    "customer_name": "<string>",
    "customer_purchase_ip": "<string>",
    "customer_signature": "<string>",
    "product_description": "<string>",
    "receipt": "<string>",
    "refund_policy": "<string>",
    "refund_policy_disclosure": "<string>",
    "refund_refusal_explanation": "<string>",
    "service_date": "<string>",
    "service_documentation": "<string>",
    "shipping_address": "<string>",
    "shipping_carrier": "<string>",
    "shipping_date": "<string>",
    "shipping_documentation": "<string>",
    "shipping_tracking_number": "<string>",
    "invoice_showing_distinct_transactions": "<string>",
    "recurring_transaction_agreement": "<string>",
    "uncategorized_file": "<string>",
    "uncategorized_text": "<string>"
}
headers = {
    "api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    dispute_id: '<string>',
    access_activity_log: '<string>',
    billing_address: '<string>',
    cancellation_policy: '<string>',
    cancellation_policy_disclosure: '<string>',
    cancellation_rebuttal: '<string>',
    customer_communication: '<string>',
    customer_email_address: '<string>',
    customer_name: '<string>',
    customer_purchase_ip: '<string>',
    customer_signature: '<string>',
    product_description: '<string>',
    receipt: '<string>',
    refund_policy: '<string>',
    refund_policy_disclosure: '<string>',
    refund_refusal_explanation: '<string>',
    service_date: '<string>',
    service_documentation: '<string>',
    shipping_address: '<string>',
    shipping_carrier: '<string>',
    shipping_date: '<string>',
    shipping_documentation: '<string>',
    shipping_tracking_number: '<string>',
    invoice_showing_distinct_transactions: '<string>',
    recurring_transaction_agreement: '<string>',
    uncategorized_file: '<string>',
    uncategorized_text: '<string>'
  })
};

fetch('https://sandbox.hyperswitch.io/disputes/evidence', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.hyperswitch.io/disputes/evidence",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'dispute_id' => '<string>',
    'access_activity_log' => '<string>',
    'billing_address' => '<string>',
    'cancellation_policy' => '<string>',
    'cancellation_policy_disclosure' => '<string>',
    'cancellation_rebuttal' => '<string>',
    'customer_communication' => '<string>',
    'customer_email_address' => '<string>',
    'customer_name' => '<string>',
    'customer_purchase_ip' => '<string>',
    'customer_signature' => '<string>',
    'product_description' => '<string>',
    'receipt' => '<string>',
    'refund_policy' => '<string>',
    'refund_policy_disclosure' => '<string>',
    'refund_refusal_explanation' => '<string>',
    'service_date' => '<string>',
    'service_documentation' => '<string>',
    'shipping_address' => '<string>',
    'shipping_carrier' => '<string>',
    'shipping_date' => '<string>',
    'shipping_documentation' => '<string>',
    'shipping_tracking_number' => '<string>',
    'invoice_showing_distinct_transactions' => '<string>',
    'recurring_transaction_agreement' => '<string>',
    'uncategorized_file' => '<string>',
    'uncategorized_text' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.hyperswitch.io/disputes/evidence"

	payload := strings.NewReader("{\n  \"dispute_id\": \"<string>\",\n  \"access_activity_log\": \"<string>\",\n  \"billing_address\": \"<string>\",\n  \"cancellation_policy\": \"<string>\",\n  \"cancellation_policy_disclosure\": \"<string>\",\n  \"cancellation_rebuttal\": \"<string>\",\n  \"customer_communication\": \"<string>\",\n  \"customer_email_address\": \"<string>\",\n  \"customer_name\": \"<string>\",\n  \"customer_purchase_ip\": \"<string>\",\n  \"customer_signature\": \"<string>\",\n  \"product_description\": \"<string>\",\n  \"receipt\": \"<string>\",\n  \"refund_policy\": \"<string>\",\n  \"refund_policy_disclosure\": \"<string>\",\n  \"refund_refusal_explanation\": \"<string>\",\n  \"service_date\": \"<string>\",\n  \"service_documentation\": \"<string>\",\n  \"shipping_address\": \"<string>\",\n  \"shipping_carrier\": \"<string>\",\n  \"shipping_date\": \"<string>\",\n  \"shipping_documentation\": \"<string>\",\n  \"shipping_tracking_number\": \"<string>\",\n  \"invoice_showing_distinct_transactions\": \"<string>\",\n  \"recurring_transaction_agreement\": \"<string>\",\n  \"uncategorized_file\": \"<string>\",\n  \"uncategorized_text\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox.hyperswitch.io/disputes/evidence")
  .header("api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dispute_id\": \"<string>\",\n  \"access_activity_log\": \"<string>\",\n  \"billing_address\": \"<string>\",\n  \"cancellation_policy\": \"<string>\",\n  \"cancellation_policy_disclosure\": \"<string>\",\n  \"cancellation_rebuttal\": \"<string>\",\n  \"customer_communication\": \"<string>\",\n  \"customer_email_address\": \"<string>\",\n  \"customer_name\": \"<string>\",\n  \"customer_purchase_ip\": \"<string>\",\n  \"customer_signature\": \"<string>\",\n  \"product_description\": \"<string>\",\n  \"receipt\": \"<string>\",\n  \"refund_policy\": \"<string>\",\n  \"refund_policy_disclosure\": \"<string>\",\n  \"refund_refusal_explanation\": \"<string>\",\n  \"service_date\": \"<string>\",\n  \"service_documentation\": \"<string>\",\n  \"shipping_address\": \"<string>\",\n  \"shipping_carrier\": \"<string>\",\n  \"shipping_date\": \"<string>\",\n  \"shipping_documentation\": \"<string>\",\n  \"shipping_tracking_number\": \"<string>\",\n  \"invoice_showing_distinct_transactions\": \"<string>\",\n  \"recurring_transaction_agreement\": \"<string>\",\n  \"uncategorized_file\": \"<string>\",\n  \"uncategorized_text\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.hyperswitch.io/disputes/evidence")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dispute_id\": \"<string>\",\n  \"access_activity_log\": \"<string>\",\n  \"billing_address\": \"<string>\",\n  \"cancellation_policy\": \"<string>\",\n  \"cancellation_policy_disclosure\": \"<string>\",\n  \"cancellation_rebuttal\": \"<string>\",\n  \"customer_communication\": \"<string>\",\n  \"customer_email_address\": \"<string>\",\n  \"customer_name\": \"<string>\",\n  \"customer_purchase_ip\": \"<string>\",\n  \"customer_signature\": \"<string>\",\n  \"product_description\": \"<string>\",\n  \"receipt\": \"<string>\",\n  \"refund_policy\": \"<string>\",\n  \"refund_policy_disclosure\": \"<string>\",\n  \"refund_refusal_explanation\": \"<string>\",\n  \"service_date\": \"<string>\",\n  \"service_documentation\": \"<string>\",\n  \"shipping_address\": \"<string>\",\n  \"shipping_carrier\": \"<string>\",\n  \"shipping_date\": \"<string>\",\n  \"shipping_documentation\": \"<string>\",\n  \"shipping_tracking_number\": \"<string>\",\n  \"invoice_showing_distinct_transactions\": \"<string>\",\n  \"recurring_transaction_agreement\": \"<string>\",\n  \"uncategorized_file\": \"<string>\",\n  \"uncategorized_text\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "dispute_id": "<string>",
  "payment_id": "<string>",
  "attempt_id": "<string>",
  "amount": "<string>",
  "currency": "AED",
  "dispute_stage": "pre_dispute",
  "dispute_status": "dispute_opened",
  "connector": "<string>",
  "connector_status": "<string>",
  "connector_dispute_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "is_already_refunded": true,
  "connector_reason": "<string>",
  "connector_reason_code": "<string>",
  "challenge_required_by": "2023-11-07T05:31:56Z",
  "connector_created_at": "2023-11-07T05:31:56Z",
  "connector_updated_at": "2023-11-07T05:31:56Z",
  "profile_id": "<string>",
  "merchant_connector_id": "<string>",
  "additional_details": {
    "network_details": {
      "type": "visa",
      "rapid_dispute_resolution": {
        "applied": true
      }
    }
  }
}

{
  "error_type": "invalid_request",
  "message": "Missing required param: {param}",
  "code": "IR_04"
}

Authorizations

api-key

string

header

required

Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Headers

X-Connected-Merchant-Id

string | null

Merchant ID of the connected merchant on whose behalf the operation is performed. Required when authenticating with a platform merchant's API key. Standard and connected merchants must not send it.

Body

application/json

dispute_id

string

required

Dispute Id

access_activity_log

string | null

Logs showing the usage of service by customer

billing_address

string | null

Billing address of the customer

cancellation_policy

string | null

File Id of cancellation policy

cancellation_policy_disclosure

string | null

Details of showing cancellation policy to customer before purchase

cancellation_rebuttal

string | null

Details telling why customer's subscription was not cancelled

customer_communication

string | null

File Id of customer communication

customer_email_address

string | null

Customer email address

customer_name

string | null

Customer name

customer_purchase_ip

string | null

IP address of the customer

customer_signature

string | null

Fild Id of customer signature

product_description

string | null

Product Description

receipt

string | null

File Id of receipt

refund_policy

string | null

File Id of refund policy

refund_policy_disclosure

string | null

Details of showing refund policy to customer before purchase

refund_refusal_explanation

string | null

Details why customer is not entitled to refund

service_date

string | null

Customer service date

service_documentation

string | null

File Id service documentation

shipping_address

string | null

Shipping address of the customer

shipping_carrier

string | null

Delivery service that shipped the product

shipping_date

string | null

Shipping date

shipping_documentation

string | null

File Id shipping documentation

shipping_tracking_number

string | null

Tracking number of shipped product

invoice_showing_distinct_transactions

string | null

File Id showing two distinct transactions when customer claims a payment was charged twice

recurring_transaction_agreement

string | null

File Id of recurring transaction agreement

uncategorized_file

string | null

Any additional supporting file

uncategorized_text

string | null

Any additional evidence statements

Response

The dispute evidence submitted successfully

dispute_id

string

required

The identifier for dispute

payment_id

string

required

The identifier for payment_intent

attempt_id

string

required

The identifier for payment_attempt

amount

string

required

Connector specific types to send

currency

enum<string>

required

The three-letter ISO 4217 currency code (e.g., "USD", "EUR") for the payment amount. This field is mandatory for creating a payment.

Available options:

AED,

AFN,

ALL,

AMD,

ANG,

AOA,

ARS,

AUD,

AWG,

AZN,

BAM,

BBD,

BDT,

BGN,

BHD,

BIF,

BMD,

BND,

BOB,

BRL,

BSD,

BTN,

BWP,

BYN,

BZD,

CAD,

CDF,

CHF,

CLF,

CLP,

CNY,

COP,

CRC,

CUC,

CUP,

CVE,

CZK,

DJF,

DKK,

DOP,

DZD,

EGP,

ERN,

ETB,

EUR,

FJD,

FKP,

GBP,

GEL,

GHS,

GIP,

GMD,

GNF,

GTQ,

GYD,

HKD,

HNL,

HRK,

HTG,

HUF,

IDR,

ILS,

INR,

IQD,

IRR,

ISK,

JMD,

JOD,

JPY,

KES,

KGS,

KHR,

KMF,

KPW,

KRW,

KWD,

KYD,

KZT,

LAK,

LBP,

LKR,

LRD,

LSL,

LYD,

MAD,

MDL,

MGA,

MKD,

MMK,

MNT,

MOP,

MRU,

MUR,

MVR,

MWK,

MXN,

MYR,

MZN,

NAD,

NGN,

NIO,

NOK,

NPR,

NZD,

OMR,

PAB,

PEN,

PGK,

PHP,

PKR,

PLN,

PYG,

QAR,

RON,

RSD,

RUB,

RWF,

SAR,

SBD,

SCR,

SDG,

SEK,

SGD,

SHP,

SLE,

SLL,

SOS,

SRD,

SSP,

STD,

STN,

SVC,

SYP,

SZL,

THB,

TJS,

TMT,

TND,

TOP,

TRY,

TTD,

TWD,

TZS,

UAH,

UGX,

USD,

UYU,

UZS,

VES,

VND,

VUV,

WST,

XAF,

XCD,

XOF,

XPF,

YER,

ZAR,

ZMW,

ZWL

dispute_stage

enum<string>

required

Stage of the dispute

Available options:

pre_dispute,

dispute,

pre_arbitration,

arbitration,

dispute_reversal

dispute_status

enum<string>

required

Status of the dispute

Available options:

dispute_opened,

dispute_expired,

dispute_accepted,

dispute_cancelled,

dispute_challenged,

dispute_won,

dispute_lost

connector

string

required

connector to which dispute is associated with

connector_status

string

required

Status of the dispute sent by connector

connector_dispute_id

string

required

Dispute id sent by connector

created_at

string<date-time>

required

Time at which dispute is received

is_already_refunded

boolean

required

Shows if the disputed amount(dispute_lost statuses only) + refunded amount is greater than captured amount

connector_reason

string | null

Reason of dispute sent by connector

connector_reason_code

string | null

Reason code of dispute sent by connector

challenge_required_by

string<date-time> | null

Evidence deadline of dispute sent by connector

connector_created_at

string<date-time> | null

Dispute created time sent by connector

connector_updated_at

string<date-time> | null

Dispute updated time sent by connector

profile_id

string | null

The profile_id associated with the dispute

merchant_connector_id

string | null

The merchant_connector_id of the connector / processor through which the dispute was processed

additional_details

object | null

Additional details of a dispute, stored as jsonb

Show child attributes

Get Started

Essentials

Payments Core APIs

Deprecated APIs

Account management APIs

Other APIs

Disputes - Uploads Dispute Evidence

Authorizations

Headers

Body

Response