Self-serve contractor payments

Self Serve Validate Bulk Contractor Wallet Resend Test Tx

Dry-run eligibility check for bulk resend: per-wallet status, Safe balance versus required, blocking reasons.

POSThttps://api.toku.com/hris/self-serve-validate-bulk-contractor-wallet-resend-test-tx

Required scope: wallets:read. It also needs banking:read.

curl --request POST \
  --url 'https://api.toku.com/hris/self-serve-validate-bulk-contractor-wallet-resend-test-tx' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "walletIDs": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}'
200 response
{
  "safeBalance": {
    "available": "string",
    "required": "string",
    "token": "string",
    "sufficient": true
  },
  "wallets": [
    {
      "walletID": "string",
      "contractorName": "string",
      "walletAddress": "string",
      "status": "eligible",
      "reason": "string",
      "severity": "none"
    }
  ],
  "summary": {
    "eligible": 0,
    "warnings": 0,
    "blocked": 0
  },
  "canProceed": true,
  "blockingReasons": [
    "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

walletIDsstring<uuid>[]required

Allowed: 1 to 50 items

Response

200Successful response
safeBalanceobjectrequired
Show child attributes
availablestringrequired
requiredstringrequired
tokenstringrequired
sufficientbooleanrequired
walletsobject[]required
Show child attributes
walletIDstringrequired
contractorNamestringrequired
walletAddressstringrequired
statusstringrequired

Available options: eligible, warning, blocked

reasonstring
severitystringrequired

Available options: none, warning, error

summaryobjectrequired
Show child attributes
eligibleintegerrequired
warningsintegerrequired
blockedintegerrequired
canProceedbooleanrequired
blockingReasonsstring[]required
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits