POST /v1/disputes/{dispute}
When you get a dispute, contacting your customer is always the best first step. If that doesn’t work, you can submit evidence to help us resolve the dispute in your favor. You can do this in your dashboard, but if you prefer, you can use the API to submit evidence programmatically.
Depending on your dispute type, different evidence fields will give you a better chance of winning your dispute. To figure out which evidence fields to provide, see our guide to dispute types.
Servers
- https://api.stripe.com/
Path parameters
Name | Type | Required | Description |
---|---|---|---|
dispute |
String | Yes |
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
submit |
Boolean | No |
Whether to immediately submit evidence to the bank. If |
expand[] |
Array | No |
Specifies which fields in the response should be expanded. |
metadata |
No |
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to |
|
evidence |
Object | No |
Evidence to upload, to respond to a dispute. Updating any field in the hash will submit all fields in the hash for review. The combined character count of all fields is limited to 150,000. |
evidence.service_date |
String | No | |
evidence.uncategorized_text |
String | No | |
evidence.shipping_date |
String | No | |
evidence.shipping_tracking_number |
String | No | |
evidence.duplicate_charge_id |
String | No | |
evidence.refund_policy_disclosure |
String | No | |
evidence.product_description |
String | No | |
evidence.refund_policy |
String | No | |
evidence.cancellation_policy_disclosure |
String | No | |
evidence.service_documentation |
String | No | |
evidence.customer_communication |
String | No | |
evidence.customer_purchase_ip |
String | No | |
evidence.shipping_documentation |
String | No | |
evidence.uncategorized_file |
String | No | |
evidence.billing_address |
String | No | |
evidence.shipping_address |
String | No | |
evidence.access_activity_log |
String | No | |
evidence.customer_email_address |
String | No | |
evidence.duplicate_charge_explanation |
String | No | |
evidence.refund_refusal_explanation |
String | No | |
evidence.customer_signature |
String | No | |
evidence.receipt |
String | No | |
evidence.duplicate_charge_documentation |
String | No | |
evidence.enhanced_evidence |
No | ||
evidence.customer_name |
String | No | |
evidence.cancellation_policy |
String | No | |
evidence.shipping_carrier |
String | No | |
evidence.cancellation_rebuttal |
String | No |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.