GET
/v1/admin/payouts/summaryHow many requests wait for a decision and how much they ask, how many wait for the money and how much the traders are owed, what went out in the last thirty days, and since when the oldest request has waited. The counters above Payouts on the website. They count every request, whatever the list is filtered on.
Money is summed per currency and never across them, so each sum is a list with one entry per currency, and empty when there is nothing.
Needs a firm. Our own staff name one with the Propper-Workspace header.
Request
curl "https://api.proppertrading.com/v1/admin/payouts/summary" \
-H "Authorization: Bearer ptat_9f2c1a44_3b8e7d2f5c9a1b4e6d8f0a2c4e6b8d1f" \
-H "Propper-Workspace: acme"
Response
{
"data": {
"object": "payout_summary",
"total": 172,
"pending": 11,
"approved": 4,
"requested": [{ "value": "10479.00", "currency": "USD" }],
"owed": [{ "value": "2614.10", "currency": "USD" }],
"paid_30d": [{ "value": "13306.70", "currency": "USD" }],
"oldest_pending_at": "2026-10-03T22:01:39+00:00"
},
"meta": {
"request_id": "req_01m50pvz1ptmna0gek6tm9yfym"
}
}
| Field | Description |
|---|---|
total | Every request the firm ever had |
pending | Waiting for a decision |
approved | Approved and waiting for the money |
requested | What the pending requests ask for, per currency |
owed | What the approved requests still owe the traders, their share, per currency |
paid_30d | What the traders received in the last thirty days, per currency |
oldest_pending_at | When the request waiting longest for a decision was made. Null when none waits |
Errors
| Status | Code | Meaning |
|---|---|---|
| 400 | workspace_required | Asked by our own staff without naming a firm |
| 401 | invalid_token | Not a token, or the secret does not match |
| 401 | revoked_token | Signed out here or from another device |
| 401 | expired_token | Ninety days without use, or a set expiry passed |
| 403 | admin_access_required | This account no longer helps run the environment |
| 403 | insufficient_scope | This device does not hold admin:read |
| 403 | workspace_not_permitted | The Propper-Workspace header names an environment this account cannot act in |
| 403 | forbidden | Without view_payouts |