List Payout Breakup Details

Returns paginated individual balance ledger entries for a payout, with each entry’s amount pro-rated into the payout’s currency.

GET /payouts/{payout_id}/breakup/details

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 detailListResponse of client.payouts.breakup.details.list('payout_id')) {
  console.log(detailListResponse.id);
}

200

{
  "items": [
    {
      "created_at": "2023-11-07T05:31:56Z",
      "event_type": "<string>",
      "id": "<string>",
      "original_amount": 123,
      "original_currency": "<string>",
      "payout_currency_amount": 123,
      "usd_equivalent_amount": 123,
      "description": "<string>",
      "reference_object_id": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Path Parameters

payout_id · string · required

Id of the Payout to get breakup for

Query Parameters

page_size · integer<int32>

Number of items per page. Default: 10, Max: 100.

Required range: x >= 0

page_number · integer<int32>

Page number (0-indexed). Default: 0.

Required range: x >= 0

Response

200

application/json

Per-row payout breakup in payout currency

Paginated response containing individual payout breakup entries.

items · object[] · required

List of payout breakup detail entries.

Show child attributes