Disputes - List Disputes

Lists all the Disputes for a merchant

Authorizations

api-key

string

headerrequired

Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Query Parameters

limit

integer | null

The maximum number of Dispute Objects to include in the response

dispute_status

enum<string>

The status of dispute

Available options:

dispute_opened,

dispute_expired,

dispute_accepted,

dispute_cancelled,

dispute_challenged,

dispute_won,

dispute_lost

dispute_stage

enum<string>

The stage of dispute

Available options:

pre_dispute,

dispute,

pre_arbitration

reason

string | null

The reason for dispute

connector

string | null

The connector linked to dispute

received_time

string | null

The time at which dispute is received

received_time.lt

string | null

Time less than the dispute received time

received_time.gt

string | null

Time greater than the dispute received time

received_time.lte

string | null

Time less than or equals to the dispute received time

received_time.gte

string | null

Time greater than or equals to the dispute received time

Response

200 - application/json

dispute_id

string

required

The identifier for dispute

payment_id

string

required

The identifier for payment_intent

attempt_id

string

required

The identifier for payment_attempt

amount

string

required

The dispute amount

currency

string

required

The three-letter ISO currency code

dispute_stage

enum<string>

required

Stage of the dispute

Available options:

pre_dispute,

dispute,

pre_arbitration

dispute_status

enum<string>

required

Status of the dispute

Available options:

dispute_opened,

dispute_expired,

dispute_accepted,

dispute_cancelled,

dispute_challenged,

dispute_won,

dispute_lost

connector

string

required

connector to which dispute is associated with

connector_status

string

required

Status of the dispute sent by connector

connector_dispute_id

string

required

Dispute id sent by connector

connector_reason

string | null

Reason of dispute sent by connector

connector_reason_code

string | null

Reason code of dispute sent by connector

challenge_required_by

string | null

Evidence deadline of dispute sent by connector

connector_created_at

string | null

Dispute created time sent by connector

connector_updated_at

string | null

Dispute updated time sent by connector

created_at

string

required

Time at which dispute is received

profile_id

string | null

The profile_id associated with the dispute

merchant_connector_id

string | null

The merchant_connector_id of the connector / processor through which the dispute was processed