List Payouts

Get a list of all payouts associated with your account.

GET /payouts

JavaScript

JavaScript

import DodoPayments from 'dodopayments';

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

// Automatically fetches more pages as needed.
for await (const payoutListResponse of client.payouts.list()) {
  console.log(payoutListResponse.business_id);
}

200

{
  "items": [
    {
      "amount": 123,
      "business_id": "<string>",
      "chargebacks": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "fee": 123,
      "payment_method": "<string>",
      "payout_id": "<string>",
      "refunds": 123,
      "tax": 123,
      "updated_at": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "payout_document_url": "<string>",
      "remarks": "<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<date-time>

Get payouts created after this time (inclusive)

created_at_lte · string<date-time>

Get payouts created before this time (inclusive)

page_size · integer<int32>

Page size default is 10 max is 100

Required range: x >= 0

page_number · integer<int32>

Page number default is 0

Required range: x >= 0

Response

200

application/json

Payouts List

items · object[] · required

Show child attributes