Create a dispute

POST /v1/issuing/disputes

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.

curl https://api.stripe.com/v1/issuing/disputes \
-u "sk_test_VePHdqK...NInc7u56JBrQsk_test_VePHdqKTYQjKNInc7u56JBrQ:" \
-d transaction= \
-d "evidence[reason]=fraudulent" \
-d "evidence[fraudulent][explanation]=This transaction is fraudulent."
Response
{
"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",
}

Update a dispute

POST /v1/issuing/disputes/:id

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.

curl https://api.stripe.com/v1/issuing/disputes/ \
-u "sk_test_VePHdqK...NInc7u56JBrQsk_test_VePHdqKTYQjKNInc7u56JBrQ:" \
-d "evidence[reason]=not_received" \
-d "evidence[not_received][expected_at]=1590000000" \
-d "evidence[not_received][explanation]=" \
-d "evidence[not_received][product_description]=Baseball cap" \
-d "evidence[not_received][product_type]=merchandise"
Response
{
"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",
}

Retrieve a dispute

GET /v1/issuing/disputes/:id

Retrieves an Issuing Dispute object.

Parameters

No parameters.

Returns

Returns an Issuing Dispute object if a valid identifier was provided.

curl https://api.stripe.com/v1/issuing/disputes/ \
-u "sk_test_VePHdqK...NInc7u56JBrQsk_test_VePHdqKTYQjKNInc7u56JBrQ:"
Response
{
"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",
}