Attributes
- idstring
Unique identifier for the object.
- amountinteger
Disputed amount in the card’s currency and in the smallest currency unit. Usually the amount of the
transaction
, but can differ (usually because of currency fluctuation). - balance_
transactionsnullable array of objectsExpandable List of balance transactions associated with the dispute.
- currencyenum
The currency the
transaction
was made in. - evidenceobject
Evidence for the dispute. Evidence contains exactly two non-null fields: the
reason
for the dispute and the associated evidence field for the selectedreason
. - metadataobject
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.
- statusenum
Current status of the dispute.
Possible enum valuesexpired
The dispute has expired.
lost
The dispute is lost.
submitted
The dispute has been submitted to Stripe.
unsubmitted
The dispute is pending submission to Stripe.
won
The dispute is won.
- transactionstringExpandable
The transaction being disputed.
More attributes
- objectstring
- createdtimestamp
- livemodeboolean
- loss_
reasonnullable enum
{ "id": "idp_1MykdxFtDWhhyHE1BFAV3osZ", "object": "issuing.dispute", "amount": 100, "created": 1681947753, "currency": "usd", "evidence": { "fraudulent": { "additional_documentation": null, "dispute_explanation": null, "explanation": "This transaction is fraudulent.", "uncategorized_file": null }, "reason": "fraudulent" }, "livemode": false, "metadata": {}, "status": "unsubmitted", "transaction": "ipi_1MykXhFtDWhhyHE1UjsZZ3xQ"}
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.
Parameters
- evidenceobject
Evidence provided for the dispute.
- metadataobject
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
metadata
. - transactionstring
The ID of the issuing transaction to create a dispute for. For transaction on Treasury FinancialAccounts, use
treasury.
.received_ debit
More parameters
- amountinteger
Returns
Returns an Issuing Dispute
object in unsubmitted
status if creation succeeds.
{ "id": "idp_1MykdxFtDWhhyHE1BFAV3osZ", "object": "issuing.dispute", "amount": 100, "created": 1681947753, "currency": "usd", "evidence": { "fraudulent": { "additional_documentation": null, "dispute_explanation": null, "explanation": "This transaction is fraudulent.", "uncategorized_file": null }, "reason": "fraudulent" }, "livemode": false, "metadata": {}, "status": "unsubmitted", "transaction": "ipi_1MykXhFtDWhhyHE1UjsZZ3xQ"}
Updates the specified Issuing Dispute
object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. Properties on the evidence
object can be unset by passing in an empty string.
Parameters
- evidenceobject
Evidence provided for the dispute.
- metadataobject
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
metadata
.
More parameters
- amountinteger
Returns
Returns an updated Issuing Dispute
object if a valid identifier was provided.
{ "id": "idp_1MykdxFtDWhhyHE1BFAV3osZ", "object": "issuing.dispute", "amount": 100, "created": 1681947753, "currency": "usd", "evidence": { "reason": "not_received", "not_received": { "expected_at": 1590000000, "explanation": "", "product_description": "Baseball cap", "product_type": "merchandise" } }, "livemode": false, "metadata": {}, "status": "unsubmitted", "transaction": "ipi_1MykXhFtDWhhyHE1UjsZZ3xQ"}
Retrieves an Issuing Dispute
object.
Parameters
No parameters.
Returns
Returns an Issuing Dispute
object if a valid identifier was provided.
{ "id": "idp_1MykdxFtDWhhyHE1BFAV3osZ", "object": "issuing.dispute", "amount": 100, "created": 1681947753, "currency": "usd", "evidence": { "fraudulent": { "additional_documentation": null, "dispute_explanation": null, "explanation": "This transaction is fraudulent.", "uncategorized_file": null }, "reason": "fraudulent" }, "livemode": false, "metadata": {}, "status": "unsubmitted", "transaction": "ipi_1MykXhFtDWhhyHE1UjsZZ3xQ"}
Returns a list of Issuing Dispute
objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.
Parameters
- transactionstring
Select the Issuing dispute for the given transaction.
More parameters
- createdobject
- ending_
beforestring - limitinteger
- starting_
afterstring - statusenum
Returns
A dictionary with a data
property that contains an array of up to limit
disputes, starting after dispute starting_
. Each entry in the array is a separate Issuing Dispute
object. If no more disputes are available, the resulting array will be empty.
{ "object": "list", "url": "/v1/issuing/disputes", "has_more": false, "data": [ { "id": "idp_1MykdxFtDWhhyHE1BFAV3osZ", "object": "issuing.dispute", "amount": 100, "created": 1681947753, "currency": "usd", "evidence": { "fraudulent": { "additional_documentation": null, "dispute_explanation": null, "explanation": "This transaction is fraudulent.", "uncategorized_file": null }, "reason": "fraudulent" }, "livemode": false, "metadata": {}, "status": "unsubmitted", "transaction": "ipi_1MykXhFtDWhhyHE1UjsZZ3xQ" } {...} {...} ],}