--- title: "Get dispute details" method: GET path: "/disputes/{dispute_id}" tags: ["Disputes"] --- # Get dispute details `GET /disputes/{dispute_id}` ## Request - Base URL: `https://{prefix}.api.sandbox.checkout.com` - URL: `https://{prefix}.api.sandbox.checkout.com/disputes/{dispute_id}` - Auth: one of: - OAuth 2 - Client credentials - Token URL: `string` scopes: `disputes`, `disputes:view` - API key in header `Authorization` - TypeScript: (a function with typed inputs; its response is checked against the schema) Returns all the details of a dispute using the dispute identifier. ## Path parameters - `dispute_id` string, required ## Response `200` Dispute retrieved successfully - Dispute - `id` string: The dispute identifier. This is the same as the payment action ID. - `entity_id` string: The client entity linked to this dispute. - `sub_entity_id` string: The sub-entity linked to this dispute. - `reference` string: An optional reference to identify the dispute. - `category` 'fraudulent' | 'unrecognized' | 'canceled_recurring' | 'product_service_not_received' | 'not_as_described' | 'credit_not_issued' | 'duplicate' | 'incorrect_amount' | 'general': The reason for the dispute. [Find out more](https://www.checkout.com/docs/risk-management/disputes/responding-to-disputes/dispute-reasons-and-recommended-evidence) - `amount` number: The amount that is being disputed, in the processing currency. This amount can be positive or negative depending on the type of transaction the dispute is received against. - `currency` string: The processing currency. - `reason_code` string: The reason code provided by the card scheme. - `status` 'evidence_required' | 'evidence_under_review' | 'resolved' | 'won' | 'lost' | 'canceled' | 'expired' | 'accepted' | 'arb_evidence_submitted' | 'arbitration_under_review' | 'arbitration_won' | 'arbitration_lost': The current status of the dispute. - `resolved_reason` 'rapid_dispute_resolution' | 'negative_amount' | 'already_refunded': If the dispute is automatically resolved, `resolved_reason` will contain the reason why it was resolved. - `relevant_evidence` array[]: This list and the dispute categories will change over time. Your evidence logic should be informed by this field, not hard coded. - string[] - `evidence_required_by` string, date-time: The deadline by which you must respond to the dispute. This is equal to the `received_on` date + `n` calendar days, where `n` is the number of days set by the scheme or acquirer. - `received_on` string, date-time: The date and time at which the dispute was issued. - `last_update` string, date-time: The date and time at which the dispute was last updated. - `is_ce_candidate` boolean: Indicates whether the dispute is eligible for compelling evidence. - `payment` PaymentData - `id` string: The payment's unique identifier - `action_id` string: The unique identifier of the payment action - `processing_channel_id` string: The processing channel used for the payment. - `amount` number: The amount that is being disputed, in the processing currency - `currency` string: The payment currency - `reference` string: An optional reference to identify the payment. - `method` string: The payment method used - `acquirer_reference_number` string: The acquirer reference number (ARN) - `mcc` string: The merchant category code (MCC) for the payment. - `3ds` object: Specifies if the payment was authenticated with 3DS. - `version` string: The 3D Secure version used for authentication. - `enrolled` string: The issuer's 3D Secure (3DS) enrollment status: - `Y`: issuer enrolled - `N`: customer not enrolled - `U`: enrollment status unknown - `eci` string: The final Electronic Commerce Indicator (ECI) security level used to authorize the payment. The ECI indicator is applicable to 3D Secure (3DS) and network token payments. - `has_refund` boolean: Specifies whether there is a refund against the payment. - `processed_on` string, date-time: The date and time at which the payment was requested - `evidence_list` object[]: List of evidence files provided for the dispute. - `file` string: The file's unique identifier. - `text` string: A description for the evidence file. - `type` 'proof_of_delivery_or_service' | 'invoice_or_receipt' | 'invoice_showing_distinct_transactions' | 'customer_communication' | 'refund_or_cancellation_policy' | 'recurring_transaction_agreement' | 'proof_of_delivery_or_service_date' | 'additional_evidence' | 'compelling_evidence' | 'arbitration_no_review' | 'arbitration_review_required': The type of evidence the file is intended to support. - `dispute_id` string - `evidence_bundle` object[]: The bundled evidence file sent to the scheme. - `dispute_id` string: The unique identifier of the dispute associated with the bundle. - `filename` string: The name of the bundled evidence file. - `file_size` number: The file size of the bundled evidence file, in KB. - `is_file_oversized` boolean: Specifies whether the bundled file exceeded the maximum file size limit. - `created_at` string, date-time: The date and time the file was created, in UTC format. - `modified_at` string, date-time: The date and time the file was last modified, in UTC format. - `segment_id` string: The unique identifier of the business segment that the payment belongs to. - `_links` object - `self` object: The dispute retrieval endpoint. - `href` string - `evidence` object: The dispute evidence retrieval endpoint. - `href` string ## Other responses - `401`: Unauthorized - `404`: Dispute not found --- [API](https://skmtc.dev/checkout/apis/checkout-com-api-reference.md) - [All operations](https://skmtc.dev/checkout/apis/checkout-com-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/checkout/apis/checkout-com-api-reference/revisions/0f1abdb1c3e9?raw)