--- title: "Get disputes" method: GET path: "/disputes" tags: ["Disputes"] --- # Get disputes `GET /disputes` ## Request - Base URL: `https://{prefix}.api.sandbox.checkout.com` - URL: `https://{prefix}.api.sandbox.checkout.com/disputes` - 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 a list of all disputes against your business. The results will be returned in reverse chronological order, showing the last modified dispute (for example, where you've recently added a piece of evidence) first. You can use the optional parameters below to skip or limit results. ## Query parameters - `limit` integer - `skip` integer - `from` string, date-time - `to` string, date-time - `id` string - `entity_ids` string - `sub_entity_ids` string - `processing_channel_ids` string - `segment_ids` string - `statuses` string - `payment_id` string - `payment_reference` string - `payment_arn` string - `payment_mcc` string - `this_channel_only` boolean ## Response `200` Disputes retrieved successfully - DisputePaged - `limit` integer: The numbers of items to return. - `skip` integer: The number of results to skip. - `from` string, date-time: The date and time from which to filter disputes, based on the dispute's `last_update` field. - `to` string, date-time: The date and time until which to filter disputes, based on the dispute's `last_update` field. - `id` string: The unique identifier of the dispute. - `entity_ids` string: One or more comma-separated client entities. This works like a logical *OR* operator. - `sub_entity_ids` string: One or more comma-separated sub-entities. This works like a logical *OR* operator. - `processing_channel_ids` string: One or more comma-separated processing channels. This works like a logical *OR* operator. - `segment_ids` string: One or more comma-separated segments. This works like a logical *OR* operator. - `statuses` string: One or more comma-separated statuses. This works like a logical *OR* operator. - `payment_id` string: The unique identifier of the payment. - `payment_reference` string: An optional reference (such as an order ID) that you can use later to identify the payment. Previously known as `TrackId`. - `payment_arn` string: The acquirer reference number (ARN) that you can use to query the issuing bank. - `payment_mcc` string: The merchant category code (MCC) of the payment (ISO 18245). - `this_channel_only` boolean: If `true`, only returns disputes of the specific channel that the secret key is associated with. Otherwise, returns all disputes for that business. - `total_count` integer: The total number of disputes retrieved (without taking into consideration skip and limit parameters). - `data` DisputeSummary[]: The list of disputes. - `id` string: The dispute identifier. This is the same as the action ID in the reconciliation API or the charge ID in the Hub. - `entity_id` string: The client entity linked to this dispute - `sub_entity_id` string: The sub-entity linked to this dispute - `processing_channel` string: The processing channel linked to the dispute. - `segment_id` string - `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) - `status` 'evidence_required' | 'evidence_under_review' | 'resolved' | 'won' | 'lost' | 'canceled' | 'expired' | 'accepted' | 'arbitration_under_review' | 'arbitration_won' | 'arbitration_lost': The current status of the dispute - `amount` number: The amount that is being disputed, in the processing currency - `currency` string: The currency the payment was made in - `reason_code` string: The reason code provided by the card scheme - `payment_id` string: The unique payment identifier - `payment_action_id` string: The unique identifier of the payment action - `payment_reference` string: An optional reference (such as an order ID) a merchant can use to later identify the charge. Previously known as TrackId - `payment_arn` string: The acquirer reference number that can be used to query the issuing bank - `payment_mcc` string: The merchant category code (MCC) of the payment (ISO 18245) - `payment_method` string: The payment method/card scheme - `evidence_required_by` string, date-time: The deadline by which to respond to the dispute. This corresponds to `received_on` + `n`, where `n` is a number of calendar days set by the scheme/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 - `resolved_reason` 'rapid_dispute_resolution' | 'negative_amount' | 'already_refunded': If the dispute is automatically resolved, `resolved_reason` will contain the reason it was resolved - `is_ce_candidate` boolean: Specifies whether the dispute is eligible for Visa Compelling Evidence. - `_links` object - `self` object: The dispute retrieval endpoint - `href` string ## Other responses - `401`: Unauthorized - `422`: Unprocessable paging --- [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)