Get Dispute Detail - Dodo Payments Documentation

import DodoPayments from 'dodopayments'; const client = new DodoPayments({ bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted }); const getDispute = await client.disputes.retrieve('dispute_id'); console.log(getDispute.brand_id);

{ "amount": "<string>", "brand_id": "<string>", "business_id": "<string>", "created_at": "2023-11-07T05:31:56Z", "currency": "<string>", "customer": { "customer_id": "<string>", "email": "<string>", "name": "<string>", "metadata": {}, "phone_number": "<string>" }, "dispute_id": "<string>", "payment_id": "<string>", "is_resolved_by_rdr": true, "reason": "<string>", "remarks": "<string>" }

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

dispute_id

string

required

Dispute Id

Response

amount

string

required

The amount involved in the dispute, represented as a string to accommodate precision.

brand_id

string

required

Brand id this dispute belongs to

business_id

string

required

The unique identifier of the business involved in the dispute.

created_at

string<date-time>

required

The timestamp of when the dispute was created, in UTC.

currency

string

required

The currency of the disputed amount, represented as an ISO 4217 currency code.

customer

object

required

The customer who filed the dispute

Show child attributes

dispute_id

string

required

The unique identifier of the dispute.

dispute_stage

enum<string>

required

The current stage of the dispute process.

Available options:

pre_dispute,

dispute,

pre_arbitration

dispute_status

enum<string>

required

The current status of the dispute.

Available options:

dispute_opened,

dispute_expired,

dispute_accepted,

dispute_cancelled,

dispute_challenged,

dispute_won,

dispute_lost

payment_id

string

required

The unique identifier of the payment associated with the dispute.

payment_provider

enum<string>

required

Which processor handled the underlying payment. stripe / adyen for BYOP routes (the merchant's own payment connector); dodo for everything Dodo processed itself.

Available options:

stripe,

adyen,

dodo

is_resolved_by_rdr

boolean | null

Whether the dispute was resolved by Rapid Dispute Resolution

reason

string | null

Reason for the dispute

remarks

string | null

Remarks