GET/v1/admin/payouts/{payout}

One payout request: what is asked, by whom, from which account, where it stands, and what the team pinned about it. The head of the inspector on the website's Payouts screen, which stays the same whichever tab is open below it.

tabs says which tabs of the website this person may open, and can what they may do, both worked out on the server, so a client never rebuilds the permission rules. Deciding is review and paid.

Needs a firm. Our own staff name one with the Propper-Workspace header.

Request

curl "https://api.proppertrading.com/v1/admin/payouts/po_99fc6kngcrdz7axf" \
  -H "Authorization: Bearer ptat_9f2c1a44_3b8e7d2f5c9a1b4e6d8f0a2c4e6b8d1f" \
  -H "Propper-Workspace: acme"

Response

{
    "data": {
        "object": "payout",
        "id": "po_99fc6kngcrdz7axf",
        "number": "#DZ7AXF",
        "status": "pending",
        "amount": { "value": "762.00", "currency": "USD" },
        "trader_share": { "value": "609.60", "currency": "USD" },
        "propfirm_share": { "value": "152.40", "currency": "USD" },
        "split": 80,
        "method": "crypto",
        "created_at": "2026-10-04T03:59:48+00:00",
        "reviewed_at": null,
        "paid_at": null,
        "paid_reference": null,
        "review_note": null,
        "rejected_reason": null,
        "reviewer": null,
        "trader": {
            "id": "usr_33hajhd7u9q5mjqr",
            "name": "Kai Popescu",
            "email": "[email protected]",
            "avatar_url": null,
            "is_active": true,
            "deleted": false,
            "on_team": false
        },
        "account": {
            "id": "acct_gsvrm4k43wtsvjj3",
            "number": "PA6F9BFA2E",
            "status": "funded",
            "balance": { "value": "50761.58", "currency": "USD" },
            "starting_balance": { "value": "50000.00", "currency": "USD" },
            "profit": { "value": "761.58", "currency": "USD" },
            "challenge": "50K Challange",
            "phase": "Funded"
        },
        "ticket": null,
        "tags": [
            { "id": "ptag_yk5b6gy5wq9cp4k3", "name": "Second look", "color": "violet" },
            { "id": "ptag_tgy5zudxy8gg8ej6", "name": "Waiting on KYC", "color": "amber" }
        ],
        "counts": {
            "notes": 0,
            "open_positions": 0,
            "trades": 0,
            "flags": 0
        },
        "earlier": {
            "count": 0,
            "amount": { "value": "0.00", "currency": "USD" }
        },
        "payouts_held": false,
        "pinned": [],
        "tabs": [
            "request",
            "account",
            "trades",
            "fraud",
            "ticket",
            "activity"
        ],
        "can": {
            "manage": true,
            "traders": true,
            "accounts": true,
            "fraud": true,
            "manage_fraud": true,
            "tickets": true,
            "link_ticket": true,
            "open_ticket": true,
            "activity": true
        },
        "action_url": "/admin/payouts/po_99fc6kngcrdz7axf"
    },
    "meta": {
        "request_id": "req_01m50q0spmb4tad2jrfr6vy677"
    }
}

The fields of the list, and:

Field	Description
`propfirm_share`	What the firm keeps: `amount` minus `trader_share`
`split`	The trader's percentage of `amount`. Null for a request of nothing
`paid_reference`	What the person who sent the money typed when marking it paid. The team's alone
`review_note`	The team's note with the decision. The trader never sees it
`rejected_reason`	What the trader was told when it was rejected
`reviewer`	The name of whoever approved or rejected it
`trader.is_active`	False for a trader who cannot sign in
`trader.on_team`	The trader is also on the team
`account`	The account as it is now: `balance`, `starting_balance`, `profit` above it, the challenge and its phase. Null when it was removed
`ticket`	The linked ticket, with `subject`, `status` and `open`
`counts`	Notes, open positions and closed trades on the account, and open fraud flags (null without `view_fraud`)
`earlier`	What was paid before from the same account: how many, and what the trader received
`payouts_held`	Fraud detection holds this trader's payouts now. Null without `view_fraud`
`pinned`	Up to three pinned team notes, each with `body`, `author`, `created_at`, `edited`, `can_edit` and `can_delete`
`tabs`	`request`, `account` and `trades`, and `fraud` (`view_fraud`), `ticket` (`view_tickets` or `manage_tickets`) and `activity` (`view_activity_logs`)
`can.manage`	May approve, reject, mark paid, tag and write notes (`manage_payouts`)
`can.link_ticket`	May link a ticket; `can.open_ticket` may open one with the trader

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`
404	`resource_not_found`	No payout with that id in this firm

A payout

Request

Response

Errors