Stripe: Create a dispute

← Issuing operations · Get started

Operation stripe.postissuingdisputes

Provider route: POST /v1/issuing/disputes. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/stripe with npm, or alter-sdk-stripe with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { StripeIntegration } from "@alter-ai/stripe";

async function execute(input: Parameters<StripeIntegration["issuing"]["postIssuingDisputes"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new StripeIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.issuing.postIssuingDisputes(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_stripe import StripeIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = StripeIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.issuing.post_issuing_disputes(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
headers	object	Optional	Additional keys: not allowed
headers.Idempotency-Key	string	Optional	Minimum length: 1 Maximum length: 255
body	object	Optional	Additional keys: not allowed
body.amount	integer	Optional	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.
body.evidence	Model	Optional	Expand Create a dispute — request body — body evidence
body.expand	array	Optional	Specifies which fields in the response should be expanded.
body.expand[]	string	Each item	Maximum length: 5000
body.metadata	object	Optional	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`. Additional keys: see wildcard field
body.metadata.*	string	Additional keys
body.transaction	string	Optional	The ID of the issuing transaction to create a dispute for. For transaction on Treasury FinancialAccounts, use `treasury.received_debit`. Maximum length: 5000
body.treasury	object	Optional	Params for disputes related to Treasury FinancialAccounts
body.treasury.received_debit	string	Required within parent	Maximum length: 5000

Referenced models: Create a dispute — request body — body evidence

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Create a dispute — response body

Referenced models: Create a dispute — response body

Schemas

712 more schemas are linked from the tables above, on the schema pages.

Create a dispute — response body

Field	Type	Presence	Description and constraints
$	object	Root	As a [card issuer](https://docs.stripe.com/issuing), you can dispute transactions that the cardholder does not recognize, suspects to be fraudulent, or has other issues with. Related guide: [Issuing disputes](https://docs.stripe.com/issuing/purchases/disputes)
amount	JSON	Required within parent
amount (anyOf 1)	integer	Alternative	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).
amount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
balance_transactions	JSON	Optional
balance_transactions (anyOf 1)	array	Alternative	List of balance transactions associated with the dispute.
balance_transactions (anyOf 1)[]	Model	Each item	Expand Retrieve a balance transaction — balance get Balance History Id — response body
balance_transactions (anyOf 2)	null	Alternative
created	JSON	Required within parent
created (anyOf 1)	integer	Alternative	Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time
created (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
currency	string	Required within parent	The currency the `transaction` was made in. Format: currency
evidence	Model	Required within parent	Expand Create a dispute — response body — evidence
id	string	Required within parent	Unique identifier for the object. Maximum length: 5000
livemode	boolean	Required within parent	If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
loss_reason	string	Optional	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. Known values: cardholder_authentication_issuer_liability, eci5_token_transaction_with_tavv, excess_disputes_in_timeframe, has_not_met_the_minimum_dispute_amount_requirements, invalid_duplicate_dispute, invalid_incorrect_amount_dispute, invalid_no_authorization, invalid_use_of_disputes, merchandise_delivered_or_shipped, merchandise_or_service_as_described, not_cancelled, other, refund_issued, submitted_beyond_allowable_time_limit, transaction_3ds_required, transaction_approved_after_prior_fraud_dispute, transaction_authorized, transaction_electronically_read, transaction_qualifies_for_visa_easy_payment_service, transaction_unattended
metadata	object	Required within parent	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. Additional keys: see wildcard field
metadata.*	string	Additional keys	Maximum length: 500
object	string	Required within parent	String representing the object's type. Objects of the same type share the same value. Known values: issuing.dispute
status	string	Required within parent	Current status of the dispute. Known values: expired, lost, submitted, unsubmitted, won
transaction	JSON	Required within parent	The transaction being disputed.
transaction (anyOf 1)	string	Alternative	Maximum length: 5000
transaction (anyOf 2)	Model	Alternative	Expand Update a transaction — response body
treasury	JSON	Optional
treasury (anyOf 1)	JSON	Alternative	[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)
treasury (anyOf 1) (anyOf 1)	Model	Alternative	Expand Create a dispute — response body — treasury value debit reversal, received debit
treasury (anyOf 2)	null	Alternative

Referenced models: Retrieve a balance transaction — balance get Balance History Id — response body, Update a transaction — response body, Create a dispute — response body — evidence, Create a dispute — response body — treasury value debit reversal, received debit

Create a dispute — request body — body evidence

Field	Type	Presence	Description and constraints
$	object	Root	Evidence provided for the dispute.
canceled	JSON	Optional
canceled (anyOf 1)	Model	Alternative	Expand Create a dispute — request body — body / evidence / canceled / product_type: , merchandise, service, return status: , merchant rejected, successful
canceled (anyOf 2)	string	Alternative	One of:
duplicate	JSON	Optional
duplicate (anyOf 1)	Model	Alternative	Expand Create a dispute — request body — body evidence duplicate additional documentation, card statement, cash receipt, check image, explanation, original transaction
duplicate (anyOf 2)	string	Alternative	One of:
fraudulent	JSON	Optional
fraudulent (anyOf 1)	object	Alternative
fraudulent (anyOf 1).additional_documentation	JSON	Optional
fraudulent (anyOf 1).additional_documentation (anyOf 1)	string	Alternative
fraudulent (anyOf 1).additional_documentation (anyOf 2)	string	Alternative	One of:
fraudulent (anyOf 1).explanation	JSON	Optional
fraudulent (anyOf 1).explanation (anyOf 1)	string	Alternative	Maximum length: 2500
fraudulent (anyOf 1).explanation (anyOf 2)	string	Alternative	One of:
fraudulent (anyOf 2)	string	Alternative	One of:
merchandise_not_as_described	JSON	Optional
merchandise_not_as_described (anyOf 1)	Model	Alternative	Expand Create a dispute — request body — body / evidence / merchandise_not_as_described / return_status: , merchant rejected, successful
merchandise_not_as_described (anyOf 2)	string	Alternative	One of:
no_valid_authorization	JSON	Optional
no_valid_authorization (anyOf 1)	object	Alternative
no_valid_authorization (anyOf 1).additional_documentation	JSON	Optional
no_valid_authorization (anyOf 1).additional_documentation (anyOf 1)	string	Alternative
no_valid_authorization (anyOf 1).additional_documentation (anyOf 2)	string	Alternative	One of:
no_valid_authorization (anyOf 1).explanation	JSON	Optional
no_valid_authorization (anyOf 1).explanation (anyOf 1)	string	Alternative	Maximum length: 2500
no_valid_authorization (anyOf 1).explanation (anyOf 2)	string	Alternative	One of:
no_valid_authorization (anyOf 2)	string	Alternative	One of:
not_received	JSON	Optional
not_received (anyOf 1)	Model	Alternative	Expand Create a dispute — request body — body / evidence / not_received / product_type: , merchandise, service
not_received (anyOf 2)	string	Alternative	One of:
other	JSON	Optional
other (anyOf 1)	object	Alternative
other (anyOf 1).additional_documentation	JSON	Optional
other (anyOf 1).additional_documentation (anyOf 1)	string	Alternative
other (anyOf 1).additional_documentation (anyOf 2)	string	Alternative	One of:
other (anyOf 1).explanation	JSON	Optional
other (anyOf 1).explanation (anyOf 1)	string	Alternative	Maximum length: 2500
other (anyOf 1).explanation (anyOf 2)	string	Alternative	One of:
other (anyOf 1).product_description	JSON	Optional
other (anyOf 1).product_description (anyOf 1)	string	Alternative	Maximum length: 2500
other (anyOf 1).product_description (anyOf 2)	string	Alternative	One of:
other (anyOf 1).product_type	string	Optional	One of: , merchandise, service
other (anyOf 2)	string	Alternative	One of:
reason	string	Optional	One of: canceled, duplicate, fraudulent, merchandise_not_as_described, no_valid_authorization, not_received, other, service_not_as_described
service_not_as_described	JSON	Optional
service_not_as_described (anyOf 1)	Model	Alternative	Expand Create a dispute — request body — body evidence service not as described additional documentation, canceled at, cancellation reason, explanation, received at
service_not_as_described (anyOf 2)	string	Alternative	One of:

Referenced models: Create a dispute — request body — body / evidence / canceled / product_type: , merchandise, service, return status: , merchant rejected, successful, Create a dispute — request body — body evidence duplicate additional documentation, card statement, cash receipt, check image, explanation, original transaction, Create a dispute — request body — body / evidence / merchandise_not_as_described / return_status: , merchant rejected, successful, Create a dispute — request body — body / evidence / not_received / product_type: , merchandise, service, Create a dispute — request body — body evidence service not as described additional documentation, canceled at, cancellation reason, explanation, received at

Create a cardholder — response body — company value tax id provided

Field	Type	Presence	Description and constraints
$	object	Root
tax_id_provided	boolean	Required within parent	Whether the company's business ID number was provided.

Policy, approvals and errors

SDK function policy ID: stripe.postissuingdisputes. Catalog operation: PostIssuingDisputes. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Pinned headers: {"Stripe-Version": "2026-09-30.endive"}

Official provider source