Payouts
Retrieve Payout Breakup
Returns the breakdown of a payout by event type (payments, refunds, disputes, fees, etc.) in the payout’s currency.
GET
/
payouts
/
{payout_id}
/
breakup
JavaScript
import DodoPayments from 'dodopayments';
const client = new DodoPayments({
bearerToken: process.env['DODO_PAYMENTS_API_KEY'], // This is the default and can be omitted
});
const breakups = await client.payouts.breakup.retrieve('pyt_zFTrrn4sk3x3y2vjDBW3T');
console.log(breakups);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
)
breakups = client.payouts.breakup.retrieve(
"pyt_zFTrrn4sk3x3y2vjDBW3T",
)
print(breakups)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"),
)
breakups, err := client.Payouts.Breakup.Get(context.TODO(), "pyt_zFTrrn4sk3x3y2vjDBW3T")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", breakups)
}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.BreakupRetrieveParams;
import com.dodopayments.api.models.payouts.breakup.BreakupRetrieveResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();
List<BreakupRetrieveResponse> breakups = client.payouts().breakup().retrieve("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.BreakupRetrieveParams
import com.dodopayments.api.models.payouts.breakup.BreakupRetrieveResponse
fun main() {
val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()
val breakups: List<BreakupRetrieveResponse> = client.payouts().breakup().retrieve("pyt_zFTrrn4sk3x3y2vjDBW3T")
}require "dodopayments"
dodo_payments = Dodopayments::Client.new(
bearer_token: "My Bearer Token",
environment: "test_mode" # defaults to "live_mode"
)
breakups = dodo_payments.payouts.breakup.retrieve("pyt_zFTrrn4sk3x3y2vjDBW3T")
puts(breakups)<?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 {
$breakups = $client->payouts->breakup->retrieve('pyt_zFTrrn4sk3x3y2vjDBW3T');
var_dump($breakups);
} catch (APIException $e) {
echo $e->getMessage();
}using System;
using DodoPayments.Client;
using DodoPayments.Client.Models.Payouts.Breakup;
DodoPaymentsClient client = new();
BreakupRetrieveParams parameters = new()
{
PayoutID = "pyt_zFTrrn4sk3x3y2vjDBW3T"
};
var breakups = await client.Payouts.Breakup.Retrieve(parameters);
Console.WriteLine(breakups);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()
.retrieve()
.payout_id(payout_id)
.await?;
println!("{result:?}");
Ok(())
}curl --request GET \
--url https://test.dodopayments.com/payouts/{payout_id}/breakup \
--header 'Authorization: Bearer <token>'[
{
"event_type": "<string>",
"total": 123
}
]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
Response
Payout breakup by event type in payout currency
Last modified on April 1, 2026
Was this page helpful?
Previous
List Payout Breakup DetailsReturns paginated individual balance ledger entries for a payout, with each entry's amount pro-rated into the payout's currency.
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
});
const breakups = await client.payouts.breakup.retrieve('pyt_zFTrrn4sk3x3y2vjDBW3T');
console.log(breakups);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
)
breakups = client.payouts.breakup.retrieve(
"pyt_zFTrrn4sk3x3y2vjDBW3T",
)
print(breakups)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"),
)
breakups, err := client.Payouts.Breakup.Get(context.TODO(), "pyt_zFTrrn4sk3x3y2vjDBW3T")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", breakups)
}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.BreakupRetrieveParams;
import com.dodopayments.api.models.payouts.breakup.BreakupRetrieveResponse;
public final class Main {
private Main() {}
public static void main(String[] args) {
DodoPaymentsClient client = DodoPaymentsOkHttpClient.fromEnv();
List<BreakupRetrieveResponse> breakups = client.payouts().breakup().retrieve("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.BreakupRetrieveParams
import com.dodopayments.api.models.payouts.breakup.BreakupRetrieveResponse
fun main() {
val client: DodoPaymentsClient = DodoPaymentsOkHttpClient.fromEnv()
val breakups: List<BreakupRetrieveResponse> = client.payouts().breakup().retrieve("pyt_zFTrrn4sk3x3y2vjDBW3T")
}require "dodopayments"
dodo_payments = Dodopayments::Client.new(
bearer_token: "My Bearer Token",
environment: "test_mode" # defaults to "live_mode"
)
breakups = dodo_payments.payouts.breakup.retrieve("pyt_zFTrrn4sk3x3y2vjDBW3T")
puts(breakups)<?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 {
$breakups = $client->payouts->breakup->retrieve('pyt_zFTrrn4sk3x3y2vjDBW3T');
var_dump($breakups);
} catch (APIException $e) {
echo $e->getMessage();
}using System;
using DodoPayments.Client;
using DodoPayments.Client.Models.Payouts.Breakup;
DodoPaymentsClient client = new();
BreakupRetrieveParams parameters = new()
{
PayoutID = "pyt_zFTrrn4sk3x3y2vjDBW3T"
};
var breakups = await client.Payouts.Breakup.Retrieve(parameters);
Console.WriteLine(breakups);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()
.retrieve()
.payout_id(payout_id)
.await?;
println!("{result:?}");
Ok(())
}curl --request GET \
--url https://test.dodopayments.com/payouts/{payout_id}/breakup \
--header 'Authorization: Bearer <token>'[
{
"event_type": "<string>",
"total": 123
}
]