Skip to main content

get Method

Overview

The get method retrieves the current status of a dispute, including evidence deadlines, submitted evidence, and the final decision if resolved.

Business Use Case: You need to check which disputes need evidence submission this week and which are approaching their deadlines.

Purpose

Why use get for disputes?

ScenarioBenefit
Track deadlinesMonitor evidence submission due dates
Check statusKnow if dispute is won, lost, or pending
Review evidenceSee what evidence has been submitted
ReportingBuild dispute analytics and trends

Request Fields

FieldTypeRequiredDescription
dispute_idstringYesThe connector's dispute ID

Response Fields

FieldTypeDescription
dispute_idstringConnector's dispute ID
payment_intent_idstringRelated payment transaction ID
statusDisputeStatusCurrent status: NEEDS_RESPONSE, UNDER_REVIEW, WON, LOST
amountMoneyDisputed amount
reasonstringCustomer's dispute reason code
evidence_due_bystringISO 8601 deadline for evidence submission
evidence_submittedboolWhether evidence has been submitted
status_codeintHTTP-style status code

Example

SDK Setup

from orchestratorx_prism import DisputeClient

dispute_client = DisputeClient(
connector='stripe',
api_key='YOUR_API_KEY',
environment='SANDBOX'
)

Request

request = {
"dispute_id": "dp_xxx"
}

response = await dispute_client.get(request)

Response

{
"dispute_id": "dp_xxx",
"payment_intent_id": "pi_3Oxxx...",
"status": "NEEDS_RESPONSE",
"amount": {
"minor_amount": 1000,
"currency": "USD"
},
"reason": "fraudulent",
"evidence_due_by": "2024-02-15T23:59:59Z",
"evidence_submitted": False,
"status_code": 200
}

Dispute Status Values

StatusDescriptionAction Needed
NEEDS_RESPONSEDispute opened, awaiting merchant responseSubmit evidence or accept
UNDER_REVIEWEvidence submitted, bank reviewingWait for decision
WONDispute resolved in merchant favorNone - retain funds
LOSTDispute resolved against merchantFunds debited, consider appeal

Next Steps