Cards, prop trading & accounting

Prop Trading Get Org Payout Summary

Aggregates org-wide prop-trader payment counts by unified status for the payouts page summary cards.

GEThttps://api.toku.com/hris/prop-trading-get-org-payout-summary

Required scope: payments:read

curl --request GET \
  --url 'https://api.toku.com/hris/prop-trading-get-org-payout-summary' \
  --header 'Authorization: Bearer <token>'
200 response
{
  "total": 0,
  "statusCounts": {
    "IN_REVIEW": 0,
    "FAILED": 0,
    "CANCELLED": 0,
    "PAID": 0,
    "PARTIALLY_PAID": 0,
    "IN_PROGRESS": 0,
    "AWAITING_PAYMENT": 0,
    "PENDING": 0
  }
}

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is an access token from a Toku sign-in. See Authentication in the API reference.

Response

200Successful response
totalintegerrequired
statusCountsobjectrequired
Show child attributes
IN_REVIEWintegerrequired
FAILEDintegerrequired
CANCELLEDintegerrequired
PAIDintegerrequired
PARTIALLY_PAIDintegerrequired
IN_PROGRESSintegerrequired
AWAITING_PAYMENTintegerrequired
PENDINGintegerrequired
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits