GET
/
disputes
import DodoPayments from 'dodopayments';

const client = new DodoPayments({
  bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});

async function main() {
  // Automatically fetches more pages as needed.
  for await (const dispute of client.disputes.list()) {
    console.log(dispute.business_id);
  }
}

main();
{
  "items": [
    {
      "amount": "<string>",
      "business_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "currency": "<string>",
      "dispute_id": "<string>",
      "dispute_stage": "pre_dispute",
      "dispute_status": "dispute_opened",
      "payment_id": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
created_at_gte
string | null

Get events after this created time

​
created_at_lte
string | null

Get events created before this time

​
page_size
integer | null

Page size default is 10 max is 100

Required range: x >= 0
​
page_number
integer | null

Page number default is 0

Required range: x >= 0
​
dispute_status
enum<string>

Filter by dispute status

Available options:
dispute_opened,
dispute_expired,
dispute_accepted,
dispute_cancelled,
dispute_challenged,
dispute_won,
dispute_lost
​
dispute_stage
enum<string>

Filter by dispute stage

Available options:
pre_dispute,
dispute,
pre_arbitration
​
customer_id
string | null

Filter by customer_id

Response

200 - application/json
​
items
object[]
required