GET
/
payouts
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 payoutListResponse of client.payouts.list()) {
    console.log(payoutListResponse.business_id);
  }
}

main();
{
  "items": [
    {
      "amount": 123,
      "business_id": "<string>",
      "chargebacks": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "currency": "AED",
      "fee": 123,
      "name": "<string>",
      "payment_method": "<string>",
      "payout_document_url": "<string>",
      "payout_id": "<string>",
      "refunds": 123,
      "remarks": "<string>",
      "status": "not_initiated",
      "tax": 123,
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Query Parameters

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

Response

200 - application/json
Payouts List
items
object[]
required