Passer au contenu principal
GET
/
disputes
/
{dispute_id}
JavaScript
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.business_id);
{
  "amount": "<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>",
  "dispute_stage": "pre_dispute",
  "dispute_status": "dispute_opened",
  "payment_id": "<string>",
  "reason": "<string>",
  "remarks": "<string>"
}

Autorisations

Authorization
string
header
requis

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

Paramètres de chemin

dispute_id
string
requis

Dispute Id

Réponse

amount
string
requis

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

business_id
string
requis

The unique identifier of the business involved in the dispute.

created_at
string<date-time>
requis

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

currency
string
requis

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

customer
object
requis

The customer who filed the dispute

dispute_id
string
requis

The unique identifier of the dispute.

dispute_stage
enum<string>
requis

The current stage of the dispute process.

Options disponibles:
pre_dispute,
dispute,
pre_arbitration
dispute_status
enum<string>
requis

The current status of the dispute.

Options disponibles:
dispute_opened,
dispute_expired,
dispute_accepted,
dispute_cancelled,
dispute_challenged,
dispute_won,
dispute_lost
payment_id
string
requis

The unique identifier of the payment associated with the dispute.

reason
string | null

Reason for the dispute

remarks
string | null

Remarks