Token payroll

Send Wallet Setup Reminder

Emails wallet setup reminders to listed employees flagged as lacking a valid wallet.

POSThttps://api.toku.com/stablecoin-payroll/send-wallet-setup-reminder

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

curl --request POST \
  --url 'https://api.toku.com/stablecoin-payroll/send-wallet-setup-reminder' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "payrollId": "string",
  "employeeData": [
    {
      "id": "string",
      "employeeId": "string",
      "employeeName": "string",
      "totalCompensation": 0,
      "totalDeduction": 0,
      "currency": "string",
      "stableCoinPercentage": 0,
      "hasTGAProfile": true,
      "hasValidWallet": true,
      "hasPayrollError": true,
      "minimumWage": 0,
      "netPayFiat": 0,
      "netPayStableCoin": 0,
      "hasMinimumWageError": true
    }
  ]
}'
200 response
{
  "success": true,
  "message": "string"
}

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

payrollIdstringrequired

Allowed: 1 to 200 characters

employeeDataobject[]required

Allowed: at most 10000 items

Show child attributes
idstringrequired

Allowed: 1 to 200 characters

employeeIdstringrequired

Allowed: 1 to 200 characters

employeeNamestringrequired

Allowed: at most 200 characters

totalCompensationnumberrequired
totalDeductionnumberrequired
currencystringrequired

Allowed: 1 to 20 characters

stableCoinPercentagenumber

Allowed: 0 to 100

hasTGAProfileboolean
hasValidWalletboolean
hasPayrollErrorboolean
minimumWagenumber
netPayFiatnumber
netPayStableCoinnumber
hasMinimumWageErrorboolean

Response

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