Get Dispute

Get a dispute by ID.

Scopes: disputes:read

GET /v1/disputes/{id}

Get Dispute

cURL

curl --request GET \
  --url https://api.spairehq.com/v1/disputes/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "resolved": true,
  "closed": true,
  "amount": 123,
  "tax_amount": 123,
  "currency": "<string>",
  "order_id": "<string>",
  "payment_id": "<string>"
}

Authorizations

patoat

Authorization · string · header · required

You can generate a Personal Access Token from your settings.

Path Parameters

id · string<uuid4> · required

The dispute ID.

Response

200

application/json

Successful Response

Schema representing a dispute.

A dispute is a challenge raised by a customer or their bank regarding a payment.

created_at · string<date-time> · required

Creation timestamp of the object.

modified_at · string<date-time> | null · required

Last modification timestamp of the object.

id · string<uuid4> · required

The ID of the object.

status · enum<string> · required

Status of the dispute. prevented means we issued a refund before the dispute was escalated, avoiding any fees.

Available options: prevented, early_warning, needs_response, under_review, lost, won

Examples:

"needs_response"

"prevented"

resolved · boolean · required

Whether the dispute has been resolved (won or lost).

Example:

false

closed · boolean · required

Whether the dispute is closed (prevented, won, or lost).

Example:

false

amount · integer · required

Amount in cents disputed.

Example:

1000

tax_amount · integer · required

Tax amount in cents disputed.

Example:

200

currency · string · required

Currency code of the dispute.

Example:

"usd"

order_id · string<uuid4> · required

The ID of the order associated with the dispute.

Example:

"57107b74-8400-4d80-a2fc-54c2b4239cb3"

payment_id · string<uuid4> · required

The ID of the payment associated with the dispute.

Example:

"42b94870-36b9-4573-96b6-b90b1c99a353"