getDisputesDispute
Retrieve a dispute
Details
- Method:
GET - Path:
/v1/disputes/{dispute} - Operation ID:
GetDisputesDispute
Parameters
{
"dispute": {
"description": "",
"required": true,
"location": "path",
"type": "string"
},
"expand": {
"description": "Specifies which fields in the response should be expanded.",
"required": false,
"location": "query",
"type": "array"
}
}Response Schema
{
"description": "A dispute occurs when a customer questions your charge with their card issuer.\nWhen this happens, you have the opportunity to respond to the dispute with\nevidence that shows that the charge is legitimate.\n\nRelated guide: [Disputes and fraud](https://docs.stripe.com/disputes)",
"properties": {
"amount": {
"description": "Disputed amount. Usually the amount of the charge, but it can differ (usually because of currency fluctuation or because only part of the order is disputed).",
"type": "integer"
},
"balance_transactions": {
"description": "List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute.",
"items": {
"description": "Balance transactions represent funds moving through your Stripe account.\nStripe creates them for every type of transaction that enters or leaves your Stripe account balance.\n\nRelated guide: [Balance transaction types](https://docs.stripe.com/reports/balance-transaction-types)",
"properties": {
"amount": {
"description": "Gross amount of this transaction (in cents (or local equivalent)). A positive value represents funds charged to another party, and a negative value represents funds sent to another party.",
"type": "integer"
},
"available_on": {
"description": "The date that the transaction's net funds become available in the Stripe balance.",
"format": "unix-time",
"type": "integer"
},
"balance_type": {
"description": "The balance that this transaction impacts.",
"enum": [
"issuing",
"payments",
"refund_and_dispute_prefunding"
],
"type": "string",
"x-stripeBypassValidation": true
},
"created": {
"description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
"format": "unix-time",
"type": "integer"
},
"currency": {
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
"format": "currency",
"type": "string"
},
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"exchange_rate": {
"description": "If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the `amount` in currency A, multipled by the `exchange_rate`, equals the `amount` in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent's `amount` is `1000` and `currency` is `eur`. If this converts to 12.34 USD in your Stripe account, the BalanceTransaction's `amount` is `1234`, its `currency` is `usd`, and the `exchange_rate` is `1.234`.",
"nullable": true,
"type": "number"
},
"fee": {
"description": "Fees (in cents (or local equivalent)) paid for this transaction. Represented as a positive integer when assessed.",
"type": "integer"
},
"fee_details": {
"description": "Detailed breakdown of fees (in cents (or local equivalent)) paid for this transaction.",
"items": {
"description": "",
"properties": {
"amount": {
"description": "Amount of the fee, in cents.",
"type": "integer"
},
"application": {
"description": "ID of the Connect application that earned the fee.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"currency": {
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
"format": "currency",
"type": "string"
},
"description": {
"description": "An arbitrary string attached to the object. Often useful for displaying to users.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"type": {
"description": "Type of the fee, one of: `application_fee`, `payment_method_passthrough_fee`, `stripe_fee` or `tax`.",
"maxLength": 5000,
"type": "string"
}
},
"required": [
"amount",
"currency",
"type"
],
"title": "Fee",
"type": "object",
"x-expandableFields": []
},
"type": "array"
},
"id": {
"description": "Unique identifier for the object.",
"maxLength": 5000,
"type": "string"
},
"net": {
"description": "Net impact to a Stripe balance (in cents (or local equivalent)). A positive value represents incrementing a Stripe balance, and a negative value decrementing a Stripe balance. You can calculate the net impact of a transaction on a balance by `amount` - `fee`",
"type": "integer"
},
"object": {
"description": "String representing the object's type. Objects of the same type share the same value.",
"enum": [
"balance_transaction"
],
"type": "string"
},
"reporting_category": {
"description": "Learn more about how [reporting categories](https://stripe.com/docs/reports/reporting-categories) can help you understand balance transactions from an accounting perspective.",
"maxLength": 5000,
"type": "string"
},
"source": {
"anyOf": [
{
"maxLength": 5000,
"type": "string"
},
{
"$ref": "#/components/schemas/application_fee"
},
{
"$ref": "#/components/schemas/charge"
},
{
"$ref": "#/components/schemas/connect_collection_transfer"
},
{
"$ref": "#/components/schemas/customer_cash_balance_transaction"
},
{
"$ref": "#/components/schemas/dispute"
},
{
"$ref": "#/components/schemas/fee_refund"
},
{
"$ref": "#/components/schemas/issuing.authorization"
},
{
"$ref": "#/components/schemas/issuing.dispute"
},
{
"$ref": "#/components/schemas/issuing.transaction"
},
{
"$ref": "#/components/schemas/payout"
},
{
"$ref": "#/components/schemas/refund"
},
{
"$ref": "#/components/schemas/reserve_transaction"
},
{
"$ref": "#/components/schemas/tax_deducted_at_source"
},
{
"$ref": "#/components/schemas/topup"
},
{
"$ref": "#/components/schemas/transfer"
},
{
"$ref": "#/components/schemas/transfer_reversal"
}
],
"description": "This transaction relates to the Stripe object.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/application_fee"
},
{
"$ref": "#/components/schemas/charge"
},
{
"$ref": "#/components/schemas/connect_collection_transfer"
},
{
"$ref": "#/components/schemas/customer_cash_balance_transaction"
},
{
"$ref": "#/components/schemas/dispute"
},
{
"$ref": "#/components/schemas/fee_refund"
},
{
"$ref": "#/components/schemas/issuing.authorization"
},
{
"$ref": "#/components/schemas/issuing.dispute"
},
{
"$ref": "#/components/schemas/issuing.transaction"
},
{
"$ref": "#/components/schemas/payout"
},
{
"$ref": "#/components/schemas/refund"
},
{
"$ref": "#/components/schemas/reserve_transaction"
},
{
"$ref": "#/components/schemas/tax_deducted_at_source"
},
{
"$ref": "#/components/schemas/topup"
},
{
"$ref": "#/components/schemas/transfer"
},
{
"$ref": "#/components/schemas/transfer_reversal"
}
]
},
"x-stripeBypassValidation": true
},
"status": {
"description": "The transaction's net funds status in the Stripe balance, which are either `available` or `pending`.",
"maxLength": 5000,
"type": "string"
},
"type": {
"description": "Transaction type: `adjustment`, `advance`, `advance_funding`, `anticipation_repayment`, `application_fee`, `application_fee_refund`, `charge`, `climate_order_purchase`, `climate_order_refund`, `connect_collection_transfer`, `contribution`, `issuing_authorization_hold`, `issuing_authorization_release`, `issuing_dispute`, `issuing_transaction`, `obligation_outbound`, `obligation_reversal_inbound`, `payment`, `payment_failure_refund`, `payment_network_reserve_hold`, `payment_network_reserve_release`, `payment_refund`, `payment_reversal`, `payment_unreconciled`, `payout`, `payout_cancel`, `payout_failure`, `payout_minimum_balance_hold`, `payout_minimum_balance_release`, `refund`, `refund_failure`, `reserve_transaction`, `reserved_funds`, `stripe_fee`, `stripe_fx_fee`, `stripe_balance_payment_debit`, `stripe_balance_payment_debit_reversal`, `tax_fee`, `topup`, `topup_reversal`, `transfer`, `transfer_cancel`, `transfer_failure`, or `transfer_refund`. Learn more about [balance transaction types and what they represent](https://stripe.com/docs/reports/balance-transaction-types). To classify transactions for accounting purposes, consider `reporting_category` instead.",
"enum": [
"adjustment",
"advance",
"advance_funding",
"anticipation_repayment",
"application_fee",
"application_fee_refund",
"charge",
"climate_order_purchase",
"climate_order_refund",
"connect_collection_transfer",
"contribution",
"issuing_authorization_hold",
"issuing_authorization_release",
"issuing_dispute",
"issuing_transaction",
"obligation_outbound",
"obligation_reversal_inbound",
"payment",
"payment_failure_refund",
"payment_network_reserve_hold",
"payment_network_reserve_release",
"payment_refund",
"payment_reversal",
"payment_unreconciled",
"payout",
"payout_cancel",
"payout_failure",
"payout_minimum_balance_hold",
"payout_minimum_balance_release",
"refund",
"refund_failure",
"reserve_transaction",
"reserved_funds",
"stripe_balance_payment_debit",
"stripe_balance_payment_debit_reversal",
"stripe_fee",
"stripe_fx_fee",
"tax_fee",
"topup",
"topup_reversal",
"transfer",
"transfer_cancel",
"transfer_failure",
"transfer_refund"
],
"type": "string"
}
},
"required": [
"amount",
"available_on",
"created",
"currency",
"fee",
"fee_details",
"id",
"net",
"object",
"reporting_category",
"status",
"type"
],
"title": "BalanceTransaction",
"type": "object",
"x-expandableFields": [
"fee_details",
"source"
],
"x-resourceId": "balance_transaction"
},
"type": "array"
},
"charge": {
"anyOf": [
{
"maxLength": 5000,
"type": "string"
},
{
"$ref": "#/components/schemas/charge"
}
],
"description": "ID of the charge that's disputed.",
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/charge"
}
]
}
},
"created": {
"description": "Time at which the object was created. Measured in seconds since the Unix epoch.",
"format": "unix-time",
"type": "integer"
},
"currency": {
"description": "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
"format": "currency",
"type": "string"
},
"enhanced_eligibility_types": {
"description": "List of eligibility types that are included in `enhanced_evidence`.",
"items": {
"enum": [
"visa_compelling_evidence_3",
"visa_compliance"
],
"type": "string"
},
"type": "array"
},
"evidence": {
"description": "",
"properties": {
"access_activity_log": {
"description": "Any server or activity logs showing proof that the customer accessed or downloaded the purchased digital product. This information should include IP addresses, corresponding timestamps, and any detailed recorded activity.",
"maxLength": 150000,
"nullable": true,
"type": "string"
},
"billing_address": {
"description": "The billing address provided by the customer.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"cancellation_policy": {
"anyOf": [
{
"maxLength": 5000,
"type": "string"
},
{
"$ref": "#/components/schemas/file"
}
],
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
},
"cancellation_policy_disclosure": {
"description": "An explanation of how and when the customer was shown your refund policy prior to purchase.",
"maxLength": 150000,
"nullable": true,
"type": "string"
},
"cancellation_rebuttal": {
"description": "A justification for why the customer's subscription was not canceled.",
"maxLength": 150000,
"nullable": true,
"type": "string"
},
"customer_communication": {
"anyOf": [
{
"maxLength": 5000,
"type": "string"
},
{
"$ref": "#/components/schemas/file"
}
],
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any communication with the customer that you feel is relevant to your case. Examples include emails proving that the customer received the product or service, or demonstrating their use of or satisfaction with the product or service.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
},
"customer_email_address": {
"description": "The email address of the customer.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"customer_name": {
"description": "The name of the customer.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"customer_purchase_ip": {
"description": "The IP address that the customer used when making the purchase.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"customer_signature": {
"anyOf": [
{
"maxLength": 5000,
"type": "string"
},
{
"$ref": "#/components/schemas/file"
}
],
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
},
"duplicate_charge_documentation": {
"anyOf": [
{
"maxLength": 5000,
"type": "string"
},
{
"$ref": "#/components/schemas/file"
}
],
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation for the prior charge that can uniquely identify the charge, such as a receipt, shipping label, work order, etc. This document should be paired with a similar document from the disputed payment that proves the two payments are separate.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
},
"duplicate_charge_explanation": {
"description": "An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate.",
"maxLength": 150000,
"nullable": true,
"type": "string"
},
"duplicate_charge_id": {
"description": "The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"enhanced_evidence": {
"description": "",
"properties": {
"visa_compelling_evidence_3": {
"description": "",
"properties": {
"disputed_transaction": {
"anyOf": [
{
"$ref": "#/components/schemas/dispute_visa_compelling_evidence3_disputed_transaction"
}
],
"description": "Disputed transaction details for Visa Compelling Evidence 3.0 evidence submission.",
"nullable": true
},
"prior_undisputed_transactions": {
"description": "List of exactly two prior undisputed transaction objects for Visa Compelling Evidence 3.0 evidence submission.",
"items": {
"description": "",
"properties": {
"charge": {
"description": "Stripe charge ID for the Visa Compelling Evidence 3.0 eligible prior charge.",
"maxLength": 5000,
"type": "string"
},
"customer_account_id": {
"description": "User Account ID used to log into business platform. Must be recognizable by the user.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"customer_device_fingerprint": {
"description": "Unique identifier of the cardholder’s device derived from a combination of at least two hardware and software attributes. Must be at least 20 characters.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"customer_device_id": {
"description": "Unique identifier of the cardholder’s device such as a device serial number (e.g., International Mobile Equipment Identity [IMEI]). Must be at least 15 characters.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"customer_email_address": {
"description": "The email address of the customer.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"customer_purchase_ip": {
"description": "The IP address that the customer used when making the purchase.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"product_description": {
"description": "A description of the product or service that was sold.",
"maxLength": 150000,
"nullable": true,
"type": "string"
},
"shipping_address": {
"anyOf": [
{
"$ref": "#/components/schemas/dispute_transaction_shipping_address"
}
],
"description": "The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission.",
"nullable": true
}
},
"required": [
"charge"
],
"title": "DisputeVisaCompellingEvidence3PriorUndisputedTransaction",
"type": "object",
"x-expandableFields": [
"shipping_address"
]
},
"type": "array"
}
},
"required": [
"prior_undisputed_transactions"
],
"title": "DisputeEnhancedEvidenceVisaCompellingEvidence3",
"type": "object",
"x-expandableFields": [
"disputed_transaction",
"prior_undisputed_transactions"
]
},
"visa_compliance": {
"description": "",
"properties": {
"fee_acknowledged": {
"description": "A field acknowledging the fee incurred when countering a Visa compliance dispute. If this field is set to true, evidence can be submitted for the compliance dispute. Stripe collects a 500 USD (or local equivalent) amount to cover the network costs associated with resolving compliance disputes. Stripe refunds the 500 USD network fee if you win the dispute.",
"type": "boolean"
}
},
"required": [
"fee_acknowledged"
],
"title": "DisputeEnhancedEvidenceVisaCompliance",
"type": "object",
"x-expandableFields": []
}
},
"title": "DisputeEnhancedEvidence",
"type": "object",
"x-expandableFields": [
"visa_compelling_evidence_3",
"visa_compliance"
]
},
"product_description": {
"description": "A description of the product or service that was sold.",
"maxLength": 150000,
"nullable": true,
"type": "string"
},
"receipt": {
"anyOf": [
{
"maxLength": 5000,
"type": "string"
},
{
"$ref": "#/components/schemas/file"
}
],
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any receipt or message sent to the customer notifying them of the charge.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
},
"refund_policy": {
"anyOf": [
{
"maxLength": 5000,
"type": "string"
},
{
"$ref": "#/components/schemas/file"
}
],
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
},
"refund_policy_disclosure": {
"description": "Documentation demonstrating that the customer was shown your refund policy prior to purchase.",
"maxLength": 150000,
"nullable": true,
"type": "string"
},
"refund_refusal_explanation": {
"description": "A justification for why the customer is not entitled to a refund.",
"maxLength": 150000,
"nullable": true,
"type": "string"
},
"service_date": {
"description": "The date on which the customer received or began receiving the purchased service, in a clear human-readable format.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"service_documentation": {
"anyOf": [
{
"maxLength": 5000,
"type": "string"
},
{
"$ref": "#/components/schemas/file"
}
],
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a service was provided to the customer. This could include a copy of a signed contract, work order, or other form of written agreement.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
},
"shipping_address": {
"description": "The address to which a physical product was shipped. You should try to include as complete address information as possible.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"shipping_carrier": {
"description": "The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. If multiple carriers were used for this purchase, please separate them with commas.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"shipping_date": {
"description": "The date on which a physical product began its route to the shipping address, in a clear human-readable format.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"shipping_documentation": {
"anyOf": [
{
"maxLength": 5000,
"type": "string"
},
{
"$ref": "#/components/schemas/file"
}
],
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Documentation showing proof that a product was shipped to the customer at the same address the customer provided to you. This could include a copy of the shipment receipt, shipping label, etc. It should show the customer's full shipping address, if possible.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
},
"shipping_tracking_number": {
"description": "The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"uncategorized_file": {
"anyOf": [
{
"maxLength": 5000,
"type": "string"
},
{
"$ref": "#/components/schemas/file"
}
],
"description": "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/file"
}
]
}
},
"uncategorized_text": {
"description": "Any additional evidence or statements.",
"maxLength": 150000,
"nullable": true,
"type": "string"
}
},
"required": [
"enhanced_evidence"
],
"title": "DisputeEvidence",
"type": "object",
"x-expandableFields": [
"cancellation_policy",
"customer_communication",
"customer_signature",
"duplicate_charge_documentation",
"enhanced_evidence",
"receipt",
"refund_policy",
"service_documentation",
"shipping_documentation",
"uncategorized_file"
]
},
"evidence_details": {
"description": "",
"properties": {
"due_by": {
"description": "Date by which evidence must be submitted in order to successfully challenge dispute. Will be 0 if the customer's bank or credit card company doesn't allow a response for this particular dispute.",
"format": "unix-time",
"nullable": true,
"type": "integer"
},
"enhanced_eligibility": {
"description": "",
"properties": {
"visa_compelling_evidence_3": {
"description": "",
"properties": {
"required_actions": {
"description": "List of actions required to qualify dispute for Visa Compelling Evidence 3.0 evidence submission.",
"items": {
"enum": [
"missing_customer_identifiers",
"missing_disputed_transaction_description",
"missing_merchandise_or_services",
"missing_prior_undisputed_transaction_description",
"missing_prior_undisputed_transactions"
],
"type": "string"
},
"type": "array"
},
"status": {
"description": "Visa Compelling Evidence 3.0 eligibility status.",
"enum": [
"not_qualified",
"qualified",
"requires_action"
],
"type": "string"
}
},
"required": [
"required_actions",
"status"
],
"title": "DisputeEnhancedEligibilityVisaCompellingEvidence3",
"type": "object",
"x-expandableFields": []
},
"visa_compliance": {
"description": "",
"properties": {
"status": {
"description": "Visa compliance eligibility status.",
"enum": [
"fee_acknowledged",
"requires_fee_acknowledgement"
],
"type": "string"
}
},
"required": [
"status"
],
"title": "DisputeEnhancedEligibilityVisaCompliance",
"type": "object",
"x-expandableFields": []
}
},
"title": "DisputeEnhancedEligibility",
"type": "object",
"x-expandableFields": [
"visa_compelling_evidence_3",
"visa_compliance"
]
},
"has_evidence": {
"description": "Whether evidence has been staged for this dispute.",
"type": "boolean"
},
"past_due": {
"description": "Whether the last evidence submission was submitted past the due date. Defaults to `false` if no evidence submissions have occurred. If `true`, then delivery of the latest evidence is *not* guaranteed.",
"type": "boolean"
},
"submission_count": {
"description": "The number of times evidence has been submitted. Typically, you may only submit evidence once.",
"type": "integer"
}
},
"required": [
"enhanced_eligibility",
"has_evidence",
"past_due",
"submission_count"
],
"title": "DisputeEvidenceDetails",
"type": "object",
"x-expandableFields": [
"enhanced_eligibility"
]
},
"id": {
"description": "Unique identifier for the object.",
"maxLength": 5000,
"type": "string"
},
"is_charge_refundable": {
"description": "If true, it's still possible to refund the disputed payment. After the payment has been fully refunded, no further funds are withdrawn from your Stripe account as a result of this dispute.",
"type": "boolean"
},
"livemode": {
"description": "Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.",
"type": "boolean"
},
"metadata": {
"additionalProperties": {
"maxLength": 500,
"type": "string"
},
"description": "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.",
"type": "object"
},
"object": {
"description": "String representing the object's type. Objects of the same type share the same value.",
"enum": [
"dispute"
],
"type": "string"
},
"payment_intent": {
"anyOf": [
{
"maxLength": 5000,
"type": "string"
},
{
"$ref": "#/components/schemas/payment_intent"
}
],
"description": "ID of the PaymentIntent that's disputed.",
"nullable": true,
"x-expansionResources": {
"oneOf": [
{
"$ref": "#/components/schemas/payment_intent"
}
]
}
},
"payment_method_details": {
"description": "",
"properties": {
"amazon_pay": {
"description": "",
"properties": {
"dispute_type": {
"description": "The AmazonPay dispute type, chargeback or claim",
"enum": [
"chargeback",
"claim"
],
"nullable": true,
"type": "string"
}
},
"title": "DisputePaymentMethodDetailsAmazonPay",
"type": "object",
"x-expandableFields": []
},
"card": {
"description": "",
"properties": {
"brand": {
"description": "Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`.",
"maxLength": 5000,
"type": "string"
},
"case_type": {
"description": "The type of dispute opened. Different case types may have varying fees and financial impact.",
"enum": [
"block",
"chargeback",
"compliance",
"inquiry",
"resolution"
],
"type": "string"
},
"network_reason_code": {
"description": "The card network's specific dispute reason code, which maps to one of Stripe's primary dispute categories to simplify response guidance. The [Network code map](https://stripe.com/docs/disputes/categories#network-code-map) lists all available dispute reason codes by network.",
"maxLength": 5000,
"nullable": true,
"type": "string"
}
},
"required": [
"brand",
"case_type"
],
"title": "DisputePaymentMethodDetailsCard",
"type": "object",
"x-expandableFields": []
},
"klarna": {
"description": "",
"properties": {
"chargeback_loss_reason_code": {
"description": "Chargeback loss reason mapped by Stripe from Klarna's chargeback loss reason",
"maxLength": 5000,
"type": "string"
},
"reason_code": {
"description": "The reason for the dispute as defined by Klarna",
"maxLength": 5000,
"nullable": true,
"type": "string"
}
},
"title": "DisputePaymentMethodDetailsKlarna",
"type": "object",
"x-expandableFields": []
},
"paypal": {
"description": "",
"properties": {
"case_id": {
"description": "The ID of the dispute in PayPal.",
"maxLength": 5000,
"nullable": true,
"type": "string"
},
"reason_code": {
"description": "The reason for the dispute as defined by PayPal",
"maxLength": 5000,
"nullable": true,
"type": "string"
}
},
"title": "DisputePaymentMethodDetailsPaypal",
"type": "object",
"x-expandableFields": []
},
"type": {
"description": "Payment method type.",
"enum": [
"amazon_pay",
"card",
"klarna",
"paypal"
],
"type": "string"
}
},
"required": [
"type"
],
"title": "DisputePaymentMethodDetails",
"type": "object",
"x-expandableFields": [
"amazon_pay",
"card",
"klarna",
"paypal"
]
},
"reason": {
"description": "Reason given by cardholder for dispute. Possible values are `bank_cannot_process`, `check_returned`, `credit_not_processed`, `customer_initiated`, `debit_not_authorized`, `duplicate`, `fraudulent`, `general`, `incorrect_account_details`, `insufficient_funds`, `noncompliant`, `product_not_received`, `product_unacceptable`, `subscription_canceled`, or `unrecognized`. Learn more about [dispute reasons](https://docs.stripe.com/disputes/categories).",
"maxLength": 5000,
"type": "string"
},
"status": {
"description": "The current status of a dispute. Possible values include:`warning_needs_response`, `warning_under_review`, `warning_closed`, `needs_response`, `under_review`, `won`, `lost`, or `prevented`.",
"enum": [
"lost",
"needs_response",
"prevented",
"under_review",
"warning_closed",
"warning_needs_response",
"warning_under_review",
"won"
],
"type": "string",
"x-stripeBypassValidation": true
}
},
"required": [
"amount",
"balance_transactions",
"charge",
"created",
"currency",
"enhanced_eligibility_types",
"evidence",
"evidence_details",
"id",
"is_charge_refundable",
"livemode",
"metadata",
"object",
"reason",
"status"
],
"title": "Dispute",
"type": "object",
"x-expandableFields": [
"balance_transactions",
"charge",
"evidence",
"evidence_details",
"payment_intent",
"payment_method_details"
],
"x-resourceId": "dispute"
}Usage
from ocp_agent import OCPAgent
agent = OCPAgent()
await agent.register_api('stripe')
# Call this tool
result = await agent.call_tool('getDisputesDispute', {
# Add required parameters here
})