Stripe: Disputes schemas
18 Stripe schemas with complete fields and constraints.
← Disputes operations · All schemas
Close a dispute — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A dispute occurs when a customer questions your charge with their card issuer. When this happens, you have the opportunity to respond to the dispute with evidence that shows that the charge is legitimate. Related guide: [Disputes and fraud](https://docs.stripe.com/disputes) |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | 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). |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
balance_transactions | array | Required within parent | List of zero, one, or two balance transactions that show funds withdrawn and reinstated to your Stripe account as a result of this dispute. |
balance_transactions[] | Model | Each item | Expand Retrieve a balance transaction — balance get Balance History Id — response body |
charge | JSON | Required within parent | ID of the charge that's disputed. |
charge (anyOf 1) | string | Alternative | Maximum length: 5000 |
charge (anyOf 2) | Model | Alternative | Expand Create a charge — response body |
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 | 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 |
enhanced_eligibility_types | array | Required within parent | List of eligibility types that are included in `enhanced_evidence`. |
enhanced_eligibility_types[] | string | Each item | Known values: mastercard_compliance, visa_compelling_evidence_3, visa_compliance |
evidence | Model | Required within parent | Expand Close a dispute — response body — evidence |
evidence_details | Model | Required within parent | Expand Close a dispute — response body — evidence details |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
is_charge_refundable | boolean | Required within parent | 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. |
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`. |
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: dispute |
payment_intent | JSON | Optional | |
payment_intent (anyOf 1) | JSON | Alternative | ID of the PaymentIntent that's disputed. |
payment_intent (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
payment_intent (anyOf 1) (anyOf 2) | Model | Alternative | Expand Cancel a Payment Intent — response body |
payment_intent (anyOf 2) | null | Alternative | |
payment_method_details | Model | Optional | Expand Close a dispute — response body — payment method details |
reason | string | Required within parent | 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). Maximum length: 5000 |
status | string | Required within parent | 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`. Known values: lost, needs_response, prevented, under_review, warning_closed, warning_needs_response, warning_under_review, won |
Referenced models: Retrieve a balance transaction — balance get Balance History Id — response body, Create a charge — response body, Close a dispute — response body — evidence, Close a dispute — response body — evidence details, Close a dispute — response body — payment method details, Cancel a Payment Intent — response body
Close a dispute — response body — evidence
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
access_activity_log | JSON | Optional | |
access_activity_log (anyOf 1) | string | Alternative | 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. Maximum length: 150000 |
access_activity_log (anyOf 2) | null | Alternative | |
billing_address | JSON | Optional | |
billing_address (anyOf 1) | string | Alternative | The billing address provided by the customer. Maximum length: 5000 |
billing_address (anyOf 2) | null | Alternative | |
cancellation_policy | JSON | Optional | |
cancellation_policy (anyOf 1) | JSON | Alternative | (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your subscription cancellation policy, as shown to the customer. |
cancellation_policy (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
cancellation_policy (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a file — response body |
cancellation_policy (anyOf 2) | null | Alternative | |
cancellation_policy_disclosure | JSON | Optional | |
cancellation_policy_disclosure (anyOf 1) | string | Alternative | An explanation of how and when the customer was shown your refund policy prior to purchase. Maximum length: 150000 |
cancellation_policy_disclosure (anyOf 2) | null | Alternative | |
cancellation_rebuttal | JSON | Optional | |
cancellation_rebuttal (anyOf 1) | string | Alternative | A justification for why the customer's subscription was not canceled. Maximum length: 150000 |
cancellation_rebuttal (anyOf 2) | null | Alternative | |
customer_communication | JSON | Optional | |
customer_communication (anyOf 1) | JSON | Alternative | (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. |
customer_communication (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
customer_communication (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a file — response body |
customer_communication (anyOf 2) | null | Alternative | |
customer_email_address | JSON | Optional | |
customer_email_address (anyOf 1) | string | Alternative | The email address of the customer. Maximum length: 5000 |
customer_email_address (anyOf 2) | null | Alternative | |
customer_name | JSON | Optional | |
customer_name (anyOf 1) | string | Alternative | The name of the customer. Maximum length: 5000 |
customer_name (anyOf 2) | null | Alternative | |
customer_purchase_ip | JSON | Optional | |
customer_purchase_ip (anyOf 1) | string | Alternative | The IP address that the customer used when making the purchase. Maximum length: 5000 |
customer_purchase_ip (anyOf 2) | null | Alternative | |
customer_signature | JSON | Optional | |
customer_signature (anyOf 1) | JSON | Alternative | (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A relevant document or contract showing the customer's signature. |
customer_signature (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
customer_signature (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a file — response body |
customer_signature (anyOf 2) | null | Alternative | |
duplicate_charge_documentation | JSON | Optional | |
duplicate_charge_documentation (anyOf 1) | JSON | Alternative | (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. |
duplicate_charge_documentation (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
duplicate_charge_documentation (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a file — response body |
duplicate_charge_documentation (anyOf 2) | null | Alternative | |
duplicate_charge_explanation | JSON | Optional | |
duplicate_charge_explanation (anyOf 1) | string | Alternative | An explanation of the difference between the disputed charge versus the prior charge that appears to be a duplicate. Maximum length: 150000 |
duplicate_charge_explanation (anyOf 2) | null | Alternative | |
duplicate_charge_id | JSON | Optional | |
duplicate_charge_id (anyOf 1) | string | Alternative | The Stripe ID for the prior charge which appears to be a duplicate of the disputed charge. Maximum length: 5000 |
duplicate_charge_id (anyOf 2) | null | Alternative | |
enhanced_evidence | Model | Required within parent | Expand Close a dispute — response body — evidence enhanced evidence |
product_description | JSON | Optional | |
product_description (anyOf 1) | string | Alternative | A description of the product or service that was sold. Maximum length: 150000 |
product_description (anyOf 2) | null | Alternative | |
receipt | JSON | Optional | |
receipt (anyOf 1) | JSON | Alternative | (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. |
receipt (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
receipt (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a file — response body |
receipt (anyOf 2) | null | Alternative | |
refund_policy | JSON | Optional | |
refund_policy (anyOf 1) | JSON | Alternative | (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Your refund policy, as shown to the customer. |
refund_policy (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
refund_policy (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a file — response body |
refund_policy (anyOf 2) | null | Alternative | |
refund_policy_disclosure | JSON | Optional | |
refund_policy_disclosure (anyOf 1) | string | Alternative | Documentation demonstrating that the customer was shown your refund policy prior to purchase. Maximum length: 150000 |
refund_policy_disclosure (anyOf 2) | null | Alternative | |
refund_refusal_explanation | JSON | Optional | |
refund_refusal_explanation (anyOf 1) | string | Alternative | A justification for why the customer is not entitled to a refund. Maximum length: 150000 |
refund_refusal_explanation (anyOf 2) | null | Alternative | |
service_date | JSON | Optional | |
service_date (anyOf 1) | string | Alternative | The date on which the customer received or began receiving the purchased service, in a clear human-readable format. Maximum length: 5000 |
service_date (anyOf 2) | null | Alternative | |
service_documentation | JSON | Optional | |
service_documentation (anyOf 1) | JSON | Alternative | (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. |
service_documentation (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
service_documentation (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a file — response body |
service_documentation (anyOf 2) | null | Alternative | |
shipping_address | JSON | Optional | |
shipping_address (anyOf 1) | string | Alternative | The address to which a physical product was shipped. You should try to include as complete address information as possible. Maximum length: 5000 |
shipping_address (anyOf 2) | null | Alternative | |
shipping_carrier | JSON | Optional | |
shipping_carrier (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
shipping_carrier (anyOf 2) | null | Alternative | |
shipping_date | JSON | Optional | |
shipping_date (anyOf 1) | string | Alternative | The date on which a physical product began its route to the shipping address, in a clear human-readable format. Maximum length: 5000 |
shipping_date (anyOf 2) | null | Alternative | |
shipping_documentation | JSON | Optional | |
shipping_documentation (anyOf 1) | JSON | Alternative | (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. |
shipping_documentation (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
shipping_documentation (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a file — response body |
shipping_documentation (anyOf 2) | null | Alternative | |
shipping_tracking_number | JSON | Optional | |
shipping_tracking_number (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
shipping_tracking_number (anyOf 2) | null | Alternative | |
uncategorized_file | JSON | Optional | |
uncategorized_file (anyOf 1) | JSON | Alternative | (ID of a [file upload](https://stripe.com/docs/guides/file-upload)) Any additional evidence or statements. |
uncategorized_file (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
uncategorized_file (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a file — response body |
uncategorized_file (anyOf 2) | null | Alternative | |
uncategorized_text | JSON | Optional | |
uncategorized_text (anyOf 1) | string | Alternative | Any additional evidence or statements. Maximum length: 150000 |
uncategorized_text (anyOf 2) | null | Alternative |
Referenced models: Close a dispute — response body — evidence enhanced evidence, Create a file — response body
Close a dispute — response body — evidence details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
due_by | JSON | Optional | |
due_by (anyOf 1) | JSON | Alternative | |
due_by (anyOf 1) (anyOf 1) | integer | Alternative | 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 |
due_by (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
due_by (anyOf 2) | null | Alternative | |
enhanced_eligibility | Model | Required within parent | Expand Close a dispute — response body — evidence details enhanced eligibility |
has_evidence | boolean | Required within parent | Whether evidence has been staged for this dispute. |
past_due | boolean | Required within parent | 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. |
submission_count | JSON | Required within parent | |
submission_count (anyOf 1) | integer | Alternative | The number of times evidence has been submitted. Typically, you may only submit evidence once. |
submission_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Close a dispute — response body — evidence details enhanced eligibility
Close a dispute — response body — evidence details enhanced eligibility
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
mastercard_compliance | Model | Optional | Expand Close a dispute — response body — evidence details enhanced eligibility mastercard compliance |
visa_compelling_evidence_3 | Model | Optional | Expand Close a dispute — response body — evidence details enhanced eligibility visa compelling evidence 3 |
visa_compliance | Model | Optional | Expand Close a dispute — response body — evidence details enhanced eligibility visa compliance |
Referenced models: Close a dispute — response body — evidence details enhanced eligibility mastercard compliance, Close a dispute — response body — evidence details enhanced eligibility visa compelling evidence 3, Close a dispute — response body — evidence details enhanced eligibility visa compliance
Close a dispute — response body — evidence details enhanced eligibility mastercard compliance
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
status | string | Required within parent | Mastercard compliance eligibility status. Known values: fee_acknowledged, requires_fee_acknowledgement |
Close a dispute — response body — evidence details enhanced eligibility visa compelling evidence 3
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
required_actions | array | Required within parent | List of actions required to qualify dispute for Visa Compelling Evidence 3.0 evidence submission. |
required_actions[] | string | Each item | Known values: missing_customer_identifiers, missing_disputed_transaction_description, missing_merchandise_or_services, missing_prior_undisputed_transaction_description, missing_prior_undisputed_transactions |
status | string | Required within parent | Visa Compelling Evidence 3.0 eligibility status. Known values: not_qualified, qualified, requires_action |
Close a dispute — response body — evidence details enhanced eligibility visa compliance
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
status | string | Required within parent | Visa compliance eligibility status. Known values: fee_acknowledged, requires_fee_acknowledgement |
Close a dispute — response body — evidence enhanced evidence
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
mastercard_compliance | Model | Optional | Expand Close a dispute — response body — evidence enhanced evidence mastercard compliance |
visa_compelling_evidence_3 | Model | Optional | Expand Close a dispute — response body — evidence enhanced evidence visa compelling evidence 3 |
visa_compliance | Model | Optional | Expand Close a dispute — response body — evidence enhanced evidence visa compliance |
Referenced models: Close a dispute — response body — evidence enhanced evidence mastercard compliance, Close a dispute — response body — evidence enhanced evidence visa compelling evidence 3, Close a dispute — response body — evidence enhanced evidence visa compliance
Close a dispute — response body — evidence enhanced evidence mastercard compliance
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
fee_acknowledged | boolean | Required within parent | A field acknowledging the fee incurred when countering a Mastercard compliance dispute. If this field is set to true, evidence can be submitted for the compliance dispute. |
Close a dispute — response body — evidence enhanced evidence visa compelling evidence 3
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
disputed_transaction | JSON | Optional | |
disputed_transaction (anyOf 1) | JSON | Alternative | Disputed transaction details for Visa Compelling Evidence 3.0 evidence submission. |
disputed_transaction (anyOf 1) (anyOf 1) | Model | Alternative | Expand Close a dispute — response body — evidence enhanced evidence visa compelling evidence 3 disputed transaction value customer account id, customer device fingerprint, customer device id, customer email address, customer purchase ip, merchandise or services, product description, shipping address |
disputed_transaction (anyOf 2) | null | Alternative | |
prior_undisputed_transactions | array | Required within parent | List of exactly two prior undisputed transaction objects for Visa Compelling Evidence 3.0 evidence submission. |
prior_undisputed_transactions[] | Model | Each item | Expand Close a dispute — response body — evidence enhanced evidence visa compelling evidence 3 prior undisputed transactions item |
Referenced models: Close a dispute — response body — evidence enhanced evidence visa compelling evidence 3 disputed transaction value customer account id, customer device fingerprint, customer device id, customer email address, customer purchase ip, merchandise or services, product description, shipping address, Close a dispute — response body — evidence enhanced evidence visa compelling evidence 3 prior undisputed transactions item
Close a dispute — response body — evidence enhanced evidence visa compelling evidence 3 disputed transaction value customer account id, customer device fingerprint, customer device id, customer email address, customer purchase ip, merchandise or services, product description, shipping address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
customer_account_id | JSON | Optional | |
customer_account_id (anyOf 1) | string | Alternative | User Account ID used to log into business platform. Must be recognizable by the user. Maximum length: 5000 |
customer_account_id (anyOf 2) | null | Alternative | |
customer_device_fingerprint | JSON | Optional | |
customer_device_fingerprint (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
customer_device_fingerprint (anyOf 2) | null | Alternative | |
customer_device_id | JSON | Optional | |
customer_device_id (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
customer_device_id (anyOf 2) | null | Alternative | |
customer_email_address | JSON | Optional | |
customer_email_address (anyOf 1) | string | Alternative | The email address of the customer. Maximum length: 5000 |
customer_email_address (anyOf 2) | null | Alternative | |
customer_purchase_ip | JSON | Optional | |
customer_purchase_ip (anyOf 1) | string | Alternative | The IP address that the customer used when making the purchase. Maximum length: 5000 |
customer_purchase_ip (anyOf 2) | null | Alternative | |
merchandise_or_services | JSON | Optional | |
merchandise_or_services (anyOf 1) | string | Alternative | Categorization of disputed payment. Known values: merchandise, services |
merchandise_or_services (anyOf 2) | null | Alternative | |
product_description | JSON | Optional | |
product_description (anyOf 1) | string | Alternative | A description of the product or service that was sold. Maximum length: 150000 |
product_description (anyOf 2) | null | Alternative | |
shipping_address | JSON | Optional | |
shipping_address (anyOf 1) | JSON | Alternative | The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission. |
shipping_address (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Location — response body — address |
shipping_address (anyOf 2) | null | Alternative |
Referenced models: Create a Location — response body — address
Close a dispute — response body — evidence enhanced evidence visa compelling evidence 3 prior undisputed transactions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
charge | string | Required within parent | Stripe charge ID for the Visa Compelling Evidence 3.0 eligible prior charge. Maximum length: 5000 |
customer_account_id | JSON | Optional | |
customer_account_id (anyOf 1) | string | Alternative | User Account ID used to log into business platform. Must be recognizable by the user. Maximum length: 5000 |
customer_account_id (anyOf 2) | null | Alternative | |
customer_device_fingerprint | JSON | Optional | |
customer_device_fingerprint (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
customer_device_fingerprint (anyOf 2) | null | Alternative | |
customer_device_id | JSON | Optional | |
customer_device_id (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
customer_device_id (anyOf 2) | null | Alternative | |
customer_email_address | JSON | Optional | |
customer_email_address (anyOf 1) | string | Alternative | The email address of the customer. Maximum length: 5000 |
customer_email_address (anyOf 2) | null | Alternative | |
customer_purchase_ip | JSON | Optional | |
customer_purchase_ip (anyOf 1) | string | Alternative | The IP address that the customer used when making the purchase. Maximum length: 5000 |
customer_purchase_ip (anyOf 2) | null | Alternative | |
product_description | JSON | Optional | |
product_description (anyOf 1) | string | Alternative | A description of the product or service that was sold. Maximum length: 150000 |
product_description (anyOf 2) | null | Alternative | |
shipping_address | JSON | Optional | |
shipping_address (anyOf 1) | JSON | Alternative | The address to which a physical product was shipped. All fields are required for Visa Compelling Evidence 3.0 evidence submission. |
shipping_address (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Location — response body — address |
shipping_address (anyOf 2) | null | Alternative |
Referenced models: Create a Location — response body — address
Close a dispute — response body — evidence enhanced evidence visa compliance
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
fee_acknowledged | boolean | Required within parent | 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. |
Close a dispute — response body — payment method details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
amazon_pay | Model | Optional | Expand Close a dispute — response body — payment method details amazon pay |
card | Model | Optional | Expand Close a dispute — response body — payment method details card |
klarna | Model | Optional | Expand Close a dispute — response body — payment method details klarna |
paypal | Model | Optional | Expand Close a dispute — response body — payment method details paypal |
type | string | Required within parent | Payment method type. Known values: amazon_pay, card, klarna, paypal |
Referenced models: Close a dispute — response body — payment method details amazon pay, Close a dispute — response body — payment method details card, Close a dispute — response body — payment method details klarna, Close a dispute — response body — payment method details paypal
Close a dispute — response body — payment method details amazon pay
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
dispute_type | JSON | Optional | |
dispute_type (anyOf 1) | string | Alternative | The AmazonPay dispute type, chargeback or claim Known values: chargeback, claim |
dispute_type (anyOf 2) | null | Alternative |
Close a dispute — response body — payment method details card
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
brand | string | Required within parent | Card brand. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `jcb`, `link`, `mastercard`, `unionpay`, `visa` or `unknown`. Maximum length: 5000 |
case_type | string | Required within parent | The type of dispute opened. Different case types may have varying fees and financial impact. Known values: block, chargeback, compliance, inquiry, resolution |
network | string | Required within parent | Identifies which network this charge was processed on. Can be `amex`, `cartes_bancaires`, `diners`, `discover`, `eftpos_au`, `interac`, `jcb`, `link`, `mastercard`, `unionpay`, `visa`, or `unknown`. Maximum length: 5000 |
network_reason_code | JSON | Optional | |
network_reason_code (anyOf 1) | string | Alternative | 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. Maximum length: 5000 |
network_reason_code (anyOf 2) | null | Alternative |
Close a dispute — response body — payment method details klarna
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
chargeback_loss_reason_code | string | Optional | Chargeback loss reason mapped by Stripe from Klarna's chargeback loss reason Maximum length: 5000 |
reason_code | JSON | Optional | |
reason_code (anyOf 1) | string | Alternative | The reason for the dispute as defined by Klarna Maximum length: 5000 |
reason_code (anyOf 2) | null | Alternative |
Close a dispute — response body — payment method details paypal
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
case_id | JSON | Optional | |
case_id (anyOf 1) | string | Alternative | The ID of the dispute in PayPal. Maximum length: 5000 |
case_id (anyOf 2) | null | Alternative | |
reason_code | JSON | Optional | |
reason_code (anyOf 1) | string | Alternative | The reason for the dispute as defined by PayPal Maximum length: 5000 |
reason_code (anyOf 2) | null | Alternative |