Sample - Stripe API
POST/v1/issuing/disputes

Create a dispute

Creates an Issuing Dispute object. Individual pieces of evidence within the evidence object are optional at this point. Stripe only validates that required evidence is present during submission. Refer to Dispute reasons and evidence for more details about evidence requirements.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.
  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

6 body fields
amountintegeroptional
The dispute amount in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). If not set, defaults to the full transaction amount.
evidenceobjectoptional
Evidence provided for the dispute.
expandarray<string>optional
Specifies which fields in the response should be expanded.
metadataobjectoptional
Set of [key-value pairs](https://docs.stripe.com/api/metadata) 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 `metadata`.
transactionstringoptional
The ID of the issuing transaction to create a dispute for. For transaction on Treasury FinancialAccounts, use `treasury.received_debit`.
treasuryobjectoptional
Params for disputes related to Treasury FinancialAccounts

2 status codes
200Successful response.
amountintegerrequired
Disputed amount in the card's currency and in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal). Usually the amount of the `transaction`, but can differ (usually because of currency fluctuation).
balance_transactionsarray<BalanceTransaction>optional
List of balance transactions associated with the dispute.
createdintegerrequired
Time at which the object was created. Measured in seconds since the Unix epoch.
currencystringrequired
The currency the `transaction` was made in.
evidenceobjectrequired
idstringrequired
Unique identifier for the object.
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
loss_reasonstringoptional
The enum that describes the dispute loss outcome. If the dispute is not lost, this field will be absent. New enum values may be added in the future, so be sure to handle unknown values.
Allowed:cardholder_authentication_issuer_liabilityeci5_token_transaction_with_tavvexcess_disputes_in_timeframehas_not_met_the_minimum_dispute_amount_requirementsinvalid_duplicate_disputeinvalid_incorrect_amount_disputeinvalid_no_authorizationinvalid_use_of_disputesmerchandise_delivered_or_shippedmerchandise_or_service_as_describednot_cancelledother
metadataobjectrequired
Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:issuing.dispute
statusstringrequired
Current status of the dispute.
Allowed:expiredlostsubmittedunsubmittedwon
transactionstringrequired
The transaction being disputed.
treasuryobjectoptional
[Treasury](https://docs.stripe.com/api/treasury) details related to this dispute if it was created on a [FinancialAccount](https://docs.stripe.com/api/treasury/financial_accounts)
defaultError response.
errorobjectrequired

Error handling

Any other status is an error: Error response.