Payouts
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
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(
'pyt_zFTrrn4sk3x3y2vjDBW3T',
)) {
console.log(detailListResponse.id);
}import os
from dodopayments import DodoPayments
client = DodoPayments(
bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"), # This is the default and can be omitted
)
page = client.payouts.breakup.details.list(
payout_id="pyt_zFTrrn4sk3x3y2vjDBW3T",
)
page = page.items[0]
print(page.id)package main
import (
"context"
"fmt"
"github.com/dodopayments/dodopayments-go"
"github.com/dodopayments/dodopayments-go/option"
)
func main() {
client := dodopayments.NewClient(
option.WithBearerToken("My Bearer Token"),
)
page, err := client.Payouts.Breakup.Details.List(
context.TODO(),
"pyt_zFTrrn4sk3x3y2vjDBW3T",
dodopayments.PayoutBreakupDetailListParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
}package com.dodopayments.api.example;
import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.payouts.breakup.details.DetailListPage;
import com.dodopayments.api.models.payouts.breakup.details.DetailListParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();
DetailListPage page = client.payouts().breakup().details().list("pyt_zFTrrn4sk3x3y2vjDBW3T");
}
}package com.dodopayments.api.example
import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.payouts.breakup.details.DetailListPage
import com.dodopayments.api.models.payouts.breakup.details.DetailListParams
fun main() {
val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()
val page: DetailListPage = client.payouts().breakup().details().list("pyt_zFTrrn4sk3x3y2vjDBW3T")
}require "dodopayments"
dodo_payments = Dodopayments::Client.new(
bearer_token: "My Bearer Token",
environment: "test_mode" # defaults to "live_mode"
)
page = dodo_payments.payouts.breakup.details.list("pyt_zFTrrn4sk3x3y2vjDBW3T")
puts(page)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Dodopayments\Client;
use Dodopayments\Core\Exceptions\APIException;
$client = new Client(
bearerToken: getenv('DODO_PAYMENTS_API_KEY') ?: 'My Bearer Token',
environment: 'test_mode',
);
try {
$page = $client->payouts->breakup->details->list(
'pyt_zFTrrn4sk3x3y2vjDBW3T', pageNumber: 0, pageSize: 0
);
var_dump($page);
} catch (APIException $e) {
echo $e->getMessage();
}using System;
using DodoPayments.Client;
using DodoPayments.Client.Models.Payouts.Breakup.Details;
DodoPaymentsClient client = new();
DetailListParams parameters = new() { PayoutID = "pyt_zFTrrn4sk3x3y2vjDBW3T" };
var page = await client.Payouts.Breakup.Details.List(parameters);
await foreach (var item in page.Paginate())
{
Console.WriteLine(item);
}use dodopayments::Client;
#[tokio::main]
async fn main() -> dodopayments::Result<()> {
let client = Client::from_env()?;
let payout_id = "payout_id";
let result = client
.payouts()
.breakup()
.details()
.list()
.payout_id(payout_id)
.query(serde_json::json!({}))
.await?;
println!("{result:?}");
Ok(())
}curl --request GET \
--url https://test.dodopayments.com/payouts/{payout_id}/breakup/details \
--header 'Authorization: Bearer <token>'{
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Id of the Payout to get breakup for
Query Parameters
Number of items per page. Default: 10, Max: 100.
Required range:
x >= 0Page number (0-indexed). Default: 0.
Required range:
x >= 0Response
Per-row payout breakup in payout currency
Paginated response containing individual payout breakup entries.
List of payout breakup detail entries.
Show child attributes
Show child attributes
Last modified on April 1, 2026
Was this page helpful?
Previous
Download Payout Breakup CSVDownloads the complete payout breakup as a CSV file with columns for ledger ID, event type, amounts, and more.
Next
⌘I
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(
'pyt_zFTrrn4sk3x3y2vjDBW3T',
)) {
console.log(detailListResponse.id);
}import os
from dodopayments import DodoPayments
client = DodoPayments(
bearer_token=os.environ.get("DODO_PAYMENTS_API_KEY"), # This is the default and can be omitted
)
page = client.payouts.breakup.details.list(
payout_id="pyt_zFTrrn4sk3x3y2vjDBW3T",
)
page = page.items[0]
print(page.id)package main
import (
"context"
"fmt"
"github.com/dodopayments/dodopayments-go"
"github.com/dodopayments/dodopayments-go/option"
)
func main() {
client := dodopayments.NewClient(
option.WithBearerToken("My Bearer Token"),
)
page, err := client.Payouts.Breakup.Details.List(
context.TODO(),
"pyt_zFTrrn4sk3x3y2vjDBW3T",
dodopayments.PayoutBreakupDetailListParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
}package com.dodopayments.api.example;
import com.dodopayments.api.client.DodoPaymentsClient;
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient;
import com.dodopayments.api.models.payouts.breakup.details.DetailListPage;
import com.dodopayments.api.models.payouts.breakup.details.DetailListParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();
DetailListPage page = client.payouts().breakup().details().list("pyt_zFTrrn4sk3x3y2vjDBW3T");
}
}package com.dodopayments.api.example
import com.dodopayments.api.client.DodoPaymentsClient
import com.dodopayments.api.client.okhttp.DodoPaymentsOkHttpClient
import com.dodopayments.api.models.payouts.breakup.details.DetailListPage
import com.dodopayments.api.models.payouts.breakup.details.DetailListParams
fun main() {
val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()
val page: DetailListPage = client.payouts().breakup().details().list("pyt_zFTrrn4sk3x3y2vjDBW3T")
}require "dodopayments"
dodo_payments = Dodopayments::Client.new(
bearer_token: "My Bearer Token",
environment: "test_mode" # defaults to "live_mode"
)
page = dodo_payments.payouts.breakup.details.list("pyt_zFTrrn4sk3x3y2vjDBW3T")
puts(page)<?php
require_once dirname(__DIR__) . '/vendor/autoload.php';
use Dodopayments\Client;
use Dodopayments\Core\Exceptions\APIException;
$client = new Client(
bearerToken: getenv('DODO_PAYMENTS_API_KEY') ?: 'My Bearer Token',
environment: 'test_mode',
);
try {
$page = $client->payouts->breakup->details->list(
'pyt_zFTrrn4sk3x3y2vjDBW3T', pageNumber: 0, pageSize: 0
);
var_dump($page);
} catch (APIException $e) {
echo $e->getMessage();
}using System;
using DodoPayments.Client;
using DodoPayments.Client.Models.Payouts.Breakup.Details;
DodoPaymentsClient client = new();
DetailListParams parameters = new() { PayoutID = "pyt_zFTrrn4sk3x3y2vjDBW3T" };
var page = await client.Payouts.Breakup.Details.List(parameters);
await foreach (var item in page.Paginate())
{
Console.WriteLine(item);
}use dodopayments::Client;
#[tokio::main]
async fn main() -> dodopayments::Result<()> {
let client = Client::from_env()?;
let payout_id = "payout_id";
let result = client
.payouts()
.breakup()
.details()
.list()
.payout_id(payout_id)
.query(serde_json::json!({}))
.await?;
println!("{result:?}");
Ok(())
}curl --request GET \
--url https://test.dodopayments.com/payouts/{payout_id}/breakup/details \
--header 'Authorization: Bearer <token>'{
"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>"
}
]
}