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
- evidence object Evidence provided for the dispute.
- metadata map 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. - transaction string The ID of the issuing transaction to create a dispute for. For transaction on Treasury FinancialAccounts, use
treasury.received_debit.
More parameters
- amount integer
Returns
Returns an Issuing Dispute object in unsubmitted status if creation succeeds.
Response
{ "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"}
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
- evidence object Evidence provided for the dispute.
- metadata map 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
- amount integer
Returns
Returns an updated Issuing Dispute object if a valid identifier was provided.
Response
{ "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"}
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.
Response
{ "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"}