GET//
Retrieve a specific dispute case.
URL path parameters
| Fields | Description |
|---|---|
| token string Required | The token of the dispute case to retrieve. Allowable Values: 36 char max |
Query parameter
| Fields | Description |
|---|---|
| expand string Optional | If the regulation_type field is set to REG_E, adds the regulation_details fields inside dispute_details in the response. For more information, see The regulation_details object.Allowable Values: regulation_details |
Response body
| Fields | Description |
|---|---|
| token string Returned | The unique identifier of the dispute case. Allowable Values: 36 char max |
| type string Returned | The type of case. Allowable Values: DISPUTE |
| memo string Returned | Free-form comments about the dispute. Allowable Values: 512 char max |
| user_token string Returned | Token that identifiers the user that made the original transaction. Allowable Values: 36 char max |
| state string Returned | Indicates the current case state. Allowable Values: OPEN, OPEN_WITH_ACTION_REQUIRED, READY, CHARGEBACK_INITIATED, CLOSED |
| assignee string Returned | Indicates who is working on the case. This is updated by the case transition endpoint with reason_code 22 and ASSIGN action. Allowable Values: 255 char max |
| zendesk_ticket_id string Optional | ID for the Zendesk ticket. Allowable Values: 255 char max |
| dispute_details object Returned | The details of the dispute case. Allowable Values: See The dispute_details_response object table. |
| created_time datetime Returned | The time when the dispute case was created. Allowable Values: Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
| last_modified_time datetime Returned | The time when the dispute case was last updated. Allowable Values: Format: yyyy-MM-dd’T’HH:mm:ss.SSSZ |
Sample response body
JSON
{
"created_time": "2024-10-15T09:35:16Z",
"last_modified_time": "2025-01-03T19:02:17Z",
"token": "my_case_token",
"type": "DISPUTE",
"memo": "",
"user_token": "my_user_token",
"state": "CLOSED",
"assignee": "Ross Geller",
"zendesk_ticket_id": "1234",
"dispute_details": {
"original_transaction_token": "my_txn_token",
"original_transaction_type": "authorization.clearing 3DS",
"dispute_amount": 33.99,
"currency_code": "GBP",
"dispute_reason": "CARDHOLDER_DISPUTE",
"dispute_state": "CASE_WON",
"chargeback_token": "my_cb_token",
"network": "MASTERCARD",
"network_case_number": "my_networkCase_number",
"card_token": "my_card_token",
"cardholder_contact_date": "2024-08-19T07:16:00Z",
"provisional_credit_granted": false,
"acquirer_fee": 0.0000,
"associated_transaction_selection_required": false,
"network_case_status_details": {
"created_time": "2024-10-15T10:45:03Z",
"last_modified_time": "2025-01-03T19:02:16Z",
"case_status": "Closed",
"current_case_amount": 33.99,
"next_actor": "DISPUTE_COMPLETED",
"days_to_act": -194,
"last_action_date": "2024-10-15T00:00:00Z",
"case_opened_date": "2024-10-15T00:00:00Z",
"last_refresh_date": "2025-01-03T19:02:17Z",
"allowable_actions": []
},
"network_failure_response": ""
},
"case_tags": []
}