Cards, prop trading & accounting

Prop Trading Save Payout Column Mapping

Validates the admin's column mapping against the file's real headers, saves it and resets parse state to DRAFT.

POSThttps://api.toku.com/hris/prop-trading-save-payout-column-mapping

Not available to API keys yet. It will need payments:write.

curl --request POST \
  --url 'https://api.toku.com/hris/prop-trading-save-payout-column-mapping' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "payoutImportID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "mapping": {
    "traderEmail": "string",
    "amount": "string",
    "currencyCode": "string",
    "externalReference": "string",
    "traderName": "string"
  }
}'
200 response
{}

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.

Body

application/json

payoutImportIDstring<uuid>required
mappingobjectrequired
Show child attributes
traderEmailstringrequired

Allowed: 1 to 255 characters

amountstringrequired

Allowed: 1 to 255 characters

currencyCodestringrequired

Allowed: 1 to 255 characters

externalReferencestring

Allowed: 1 to 255 characters

traderNamestring

Allowed: 1 to 255 characters

Response

200Successful response
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits