Skip to content

Get Payout Summary

GET
/api/Payouts/summary
curl --request GET \
--url https://example.com/api/Payouts/summary \
--header 'Authorization: Bearer <token>'

Returns aggregate totals (settled, processing, pending, fees) used to populate the payout summary cards on the merchant dashboard. Defaults to the last 30 days.

MerchantId
string format: uuid
From
string format: date-time
To
string format: date-time

Aggregate payout totals.

Media type application/json
object
totalSettled
number format: double
totalProcessing
number format: double
totalPending
number format: double
totalFees
number format: double
settledCount
integer format: int32
currency
string
nullable
Example generated
{
"totalSettled": 1,
"totalProcessing": 1,
"totalPending": 1,
"totalFees": 1,
"settledCount": 1,
"currency": "example"
}