Cards, prop trading & accounting

Prop Trading List Org Payments

Pages the firm's org-wide prop-trader payout history, optionally narrowed to one import, with trader identity.

GEThttps://api.toku.com/hris/prop-trading-list-org-payments

Required scope: payments:read. It also needs compensation:read.

curl --request GET \
  --url 'https://api.toku.com/hris/prop-trading-list-org-payments' \
  --header 'Authorization: Bearer <token>'
200 response
{
  "payments": [
    {
      "payoutImportRowID": "string",
      "externalReference": "string",
      "invoicePaymentID": "string",
      "invoiceNumber": "string",
      "amount": "string",
      "currencyCode": "string",
      "status": "IN_REVIEW",
      "legTypes": [
        "string"
      ],
      "tokenSymbol": "string",
      "networkName": "string",
      "fx": {
        "payoutCurrency": "string",
        "payoutAmount": "string",
        "rate": "string",
        "midRate": "string",
        "markupBps": 0,
        "ratePulledAt": "string",
        "isExecuted": true
      },
      "estimatedArrival": {
        "from": "string",
        "by": "string",
        "passed": true
      },
      "paidAt": "string",
      "createdAt": "string",
      "traderName": "string",
      "traderRoleInOrgID": "string"
    }
  ],
  "total": 0,
  "page": 0,
  "pageSize": 0,
  "totalPages": 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.

Query parameters

payoutImportIDstring<uuid>
pageinteger

Allowed: at least 1

Default: 1

pageSizeinteger

Allowed: 1 to 100

Default: 25

Response

200Successful response
paymentsobject[]required
Show child attributes
payoutImportRowIDstringrequired
externalReferencestringrequired
invoicePaymentIDstringrequired
invoiceNumberstringrequired
amountstringrequired

Allowed: matches ^-?\d+(\.\d+)?(e[+-]?\d+)?$

currencyCodestringrequired
statusstringrequired

Available options: IN_REVIEW, FAILED, CANCELLED, PAID, PARTIALLY_PAID, IN_PROGRESS, AWAITING_PAYMENT, PENDING

legTypesstring[]required
tokenSymbolstring | nullrequired
networkNamestring | nullrequired
fxobject | nullrequired
Show child attributes
payoutCurrencystringrequired
payoutAmountstringrequired

Allowed: matches ^-?\d+(\.\d+)?(e[+-]?\d+)?$

ratestringrequired

Allowed: matches ^-?\d+(\.\d+)?(e[+-]?\d+)?$

midRatestring | nullrequired

Allowed: matches ^-?\d+(\.\d+)?(e[+-]?\d+)?$

markupBpsinteger | nullrequired
ratePulledAtstring | nullrequired
isExecutedbooleanrequired
estimatedArrivalobject | nullrequired
Show child attributes
fromstringrequired
bystringrequired
passedbooleanrequired
paidAtstring | nullrequired
createdAtstringrequired
traderNamestring | nullrequired
traderRoleInOrgIDstring | nullrequired
totalintegerrequired
pageintegerrequired
pageSizeintegerrequired
totalPagesintegerrequired
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits