Stablecoin payroll & payroll admin

Get Stable Coin Payroll By ID

Name and signature indicate it gets token payroll by id

POSThttps://api.toku.com/stablecoin-payroll/get-stable-coin-payroll-by-id

Not available to API keys yet. It will need payroll:write and banking:read and compensation:read.

curl --request POST \
  --url 'https://api.toku.com/stablecoin-payroll/get-stable-coin-payroll-by-id' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "tokenPayrollID": "string",
  "payrollTypes": [
    "ON_CYCLE"
  ]
}'
200 response
{
  "tokenPayrollID": "string",
  "paymentBackend": "LEGACY",
  "name": "string",
  "payPeriodStart": "string",
  "payPeriodEnd": "string",
  "payDate": "string",
  "fiatCurrency": "string",
  "state": "string",
  "type": "ON_CYCLE",
  "isStablecoinOnlySettlement": true,
  "payrollSyncedSource": "string",
  "token": {
    "tokenTypeID": "string",
    "tokenName": "string",
    "tokenIconUrl": "string",
    "networkName": "string",
    "networkIconUrl": "string",
    "networkID": "string",
    "currencyCode": "string"
  },
  "contributorsInPayroll": [
    {
      "contributorInTokenPayrollID": "string",
      "roleInOrgID": "string",
      "externalEmployeeID": "string",
      "contributorName": "string",
      "payrollCurrencyCode": "string",
      "totalPayrollAmount": "string",
      "totalDeductionAmount": "string",
      "netPayrollAmount": "string",
      "settlements": [
        {
          "contributorInTokenPayrollID": "string",
          "roleInOrgID": "string",
          "token": {
            "tokenTypeID": "string",
            "tokenName": "string",
            "tokenIconUrl": "string",
            "networkName": "string",
            "networkIconUrl": "string",
            "networkID": "string",
            "currencyCode": "string"
          },
          "walletAddress": "string",
          "fiatAmount": "string",
          "tokenAmount": "string",
          "exchangeRate": "string",
          "exchangeRateSource": "COINMARKETCAP",
          "currencyCode": "string",
          "settlementOrderForContributorTokenPayrollID": "string",
          "dateCreated": "string",
          "exchangeRateRefetchedAt": "string",
          "settled": true,
          "transactionHash": "string",
          "transactionLink": "string",
          "dateFulfilled": "string",
          "deductionsPosted": true,
          "exportedAt": "string",
          "submitVia": "SQUADS",
          "dateProposed": "string",
          "pendingTransaction": {
            "tokenSettlementForContributorSubmittedTransactionID": "string",
            "status": "string",
            "linkToTransaction": "string",
            "type": "SQUADS",
            "aprovedOnDate": "string",
            "rejectedOnDate": "string",
            "createdAt": "string",
            "coinbasePrimeDetails": {
              "primeTransactionID": "string",
              "portfolioID": "string",
              "walletID": "string",
              "linkToBlockExplorer": "string"
            },
            "squadsDetails": {
              "transactionIndex": 0,
              "transactionProposal": "string",
              "linkToBlockExplorer": "string"
            },
            "fordefiDetails": {
              "attemptID": "string",
              "attemptNumber": 0,
              "state": "string",
              "providerTransactionID": "string",
              "providerState": "string",
              "transactionHash": "string",
              "explorerUrl": "string",
              "errorMessage": "string",
              "custodyWalletID": "string",
              "providerVaultID": "string",
              "chainID": "string"
            }
          }
        }
      ],
      "payrollAllocationErrors": [
        {
          "contributorInTokenPayrollID": "string",
          "error": "string",
          "computedSettlement": {
            "contributorInTokenPayrollID": "string",
            "roleInOrgID": "string",
            "token": {
              "tokenTypeID": "string",
              "tokenName": "string",
              "tokenIconUrl": "string",
              "networkName": "string",
              "networkIconUrl": "string",
              "networkID": "string",
              "currencyCode": "string"
            },
            "walletAddress": "string",
            "fiatAmount": "string",
            "tokenAmount": "string",
            "exchangeRate": "string",
            "exchangeRateSource": "COINMARKETCAP",
            "currencyCode": "string",
            "settlementOrderForContributorTokenPayrollID": "string",
            "dateCreated": "string",
            "exchangeRateRefetchedAt": "string",
            "settled": true,
            "transactionHash": "string",
            "transactionLink": "string",
            "dateFulfilled": "string",
            "deductionsPosted": true,
            "exportedAt": "string",
            "submitVia": "SQUADS",
            "dateProposed": "string",
            "pendingTransaction": {
              "tokenSettlementForContributorSubmittedTransactionID": "string",
              "status": "string",
              "linkToTransaction": "string",
              "type": "SQUADS",
              "aprovedOnDate": "string",
              "rejectedOnDate": "string",
              "createdAt": "string",
              "coinbasePrimeDetails": {
                "primeTransactionID": "string",
                "portfolioID": "string",
                "walletID": "string",
                "linkToBlockExplorer": "string"
              },
              "squadsDetails": {
                "transactionIndex": 0,
                "transactionProposal": "string",
                "linkToBlockExplorer": "string"
              },
              "fordefiDetails": {
                "attemptID": "string",
                "attemptNumber": 0,
                "state": "string",
                "providerTransactionID": "string",
                "providerState": "string",
                "transactionHash": "string",
                "explorerUrl": "string",
                "errorMessage": "string",
                "custodyWalletID": "string",
                "providerVaultID": "string",
                "chainID": "string"
              }
            }
          }
        }
      ],
      "tokenTypeID": "string",
      "tokenType": {
        "tokenTypeID": "string",
        "tokenName": "string",
        "tokenIconUrl": "string",
        "networkName": "string",
        "networkIconUrl": "string",
        "networkID": "string",
        "currencyCode": "string"
      },
      "availableWalletTokens": [
        {
          "tokenTypeID": "string",
          "tokenName": "string",
          "tokenIconUrl": "string",
          "networkName": "string",
          "networkIconUrl": "string",
          "networkID": "string"
        }
      ],
      "hasWalletForSelectedToken": true,
      "positionID": "string",
      "payrollGroup": "string",
      "walletVerified": true,
      "approved": true,
      "isPassedCutoffDate": true,
      "isTerminated": true
    }
  ],
  "settlementMethod": "manual",
  "fundingEmailSent": true,
  "adpDeductionsVerified": true,
  "payrollIntegrationEntityId": "string",
  "resolvedFireblocksConfig": {
    "configSource": "entity",
    "vaultAccountId": "string",
    "entityName": "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

tokenPayrollIDstringrequired
payrollTypesstring[]

Response

200Successful response
tokenPayrollIDstringrequired
paymentBackendstring | nullrequired

Available options: LEGACY, UNIFIED, null

namestringrequired
payPeriodStartstringrequired
payPeriodEndstringrequired
payDatestringrequired
fiatCurrencystringrequired
statestringrequired
typestringrequired

Available options: ON_CYCLE, OFF_CYCLE, INVOICE_PAYMENT

isStablecoinOnlySettlementbooleanrequired
payrollSyncedSourcestring
tokenobject
Show child attributes
tokenTypeIDstringrequired
tokenNamestringrequired
tokenIconUrlstringrequired
networkNamestringrequired
networkIconUrlstringrequired
networkIDstringrequired
currencyCodestringrequired
contributorsInPayrollobject[]required
Show child attributes
contributorInTokenPayrollIDstringrequired
roleInOrgIDstringrequired
externalEmployeeIDstringrequired
contributorNamestringrequired
payrollCurrencyCodestringrequired
totalPayrollAmountstringrequired
totalDeductionAmountstringrequired
netPayrollAmountstringrequired
settlementsobject[]required
Show child attributes
contributorInTokenPayrollIDstringrequired
roleInOrgIDstringrequired
tokenobjectrequired
Show child attributes
tokenTypeIDstringrequired
tokenNamestringrequired
tokenIconUrlstringrequired
networkNamestringrequired
networkIconUrlstringrequired
networkIDstringrequired
currencyCodestringrequired
walletAddressstringrequired
fiatAmountstringrequired
tokenAmountstringrequired
exchangeRatestringrequired
exchangeRateSourcestring

Available options: COINMARKETCAP, ORACLE_ERP, CUSTOM, XE, PEGGED

currencyCodestringrequired
settlementOrderForContributorTokenPayrollIDstring
dateCreatedstring
exchangeRateRefetchedAtstring
settledbooleanrequired
transactionHashstring
transactionLinkstring
dateFulfilledstring
deductionsPostedboolean
exportedAtstring
submitViastring

Available options: SQUADS, BRIDGE, COINBASE_PRIME, FIREBLOCKS, FORDEFI

dateProposedstring
pendingTransactionobject
Show child attributes
tokenSettlementForContributorSubmittedTransactionIDstringrequired
statusstringrequired
linkToTransactionstringrequired
typestringrequired

Available options: SQUADS, BRIDGE, COINBASE_PRIME, FIREBLOCKS, FORDEFI

aprovedOnDatestring | nullrequired
rejectedOnDatestring | nullrequired
createdAtstringrequired
coinbasePrimeDetailsobject
Show child attributes
primeTransactionIDstringrequired
portfolioIDstringrequired
walletIDstringrequired
linkToBlockExplorerstringrequired
squadsDetailsobject
Show child attributes
transactionIndexintegerrequired
transactionProposalstringrequired
linkToBlockExplorerstringrequired
fordefiDetailsobject
Show child attributes
attemptIDstringrequired
attemptNumberintegerrequired
statestringrequired
providerTransactionIDstring | nullrequired
providerStatestring | nullrequired
transactionHashstring | nullrequired
explorerUrlstring | nullrequired
errorMessagestring | nullrequired
custodyWalletIDstring | nullrequired
providerVaultIDstringrequired
chainIDstringrequired
payrollAllocationErrorsobject[]required
Show child attributes
contributorInTokenPayrollIDstringrequired
errorstringrequired
computedSettlementobjectrequired
Show child attributes
contributorInTokenPayrollIDstringrequired
roleInOrgIDstringrequired
tokenobjectrequired
Show child attributes
tokenTypeIDstringrequired
tokenNamestringrequired
tokenIconUrlstringrequired
networkNamestringrequired
networkIconUrlstringrequired
networkIDstringrequired
currencyCodestringrequired
walletAddressstringrequired
fiatAmountstringrequired
tokenAmountstringrequired
exchangeRatestringrequired
exchangeRateSourcestring

Available options: COINMARKETCAP, ORACLE_ERP, CUSTOM, XE, PEGGED

currencyCodestringrequired
settlementOrderForContributorTokenPayrollIDstring
dateCreatedstring
exchangeRateRefetchedAtstring
settledbooleanrequired
transactionHashstring
transactionLinkstring
dateFulfilledstring
deductionsPostedboolean
exportedAtstring
submitViastring

Available options: SQUADS, BRIDGE, COINBASE_PRIME, FIREBLOCKS, FORDEFI

dateProposedstring
pendingTransactionobject
Show child attributes
tokenSettlementForContributorSubmittedTransactionIDstringrequired
statusstringrequired
linkToTransactionstringrequired
typestringrequired

Available options: SQUADS, BRIDGE, COINBASE_PRIME, FIREBLOCKS, FORDEFI

aprovedOnDatestring | nullrequired
rejectedOnDatestring | nullrequired
createdAtstringrequired
coinbasePrimeDetailsobject
Show child attributes
primeTransactionIDstringrequired
portfolioIDstringrequired
walletIDstringrequired
linkToBlockExplorerstringrequired
squadsDetailsobject
Show child attributes
transactionIndexintegerrequired
transactionProposalstringrequired
linkToBlockExplorerstringrequired
fordefiDetailsobject
Show child attributes
attemptIDstringrequired
attemptNumberintegerrequired
statestringrequired
providerTransactionIDstring | nullrequired
providerStatestring | nullrequired
transactionHashstring | nullrequired
explorerUrlstring | nullrequired
errorMessagestring | nullrequired
custodyWalletIDstring | nullrequired
providerVaultIDstringrequired
chainIDstringrequired
tokenTypeIDstring
tokenTypeobject
Show child attributes
tokenTypeIDstringrequired
tokenNamestringrequired
tokenIconUrlstringrequired
networkNamestringrequired
networkIconUrlstringrequired
networkIDstringrequired
currencyCodestringrequired
availableWalletTokensobject[]
Show child attributes
tokenTypeIDstringrequired
tokenNamestringrequired
tokenIconUrlstringrequired
networkNamestringrequired
networkIconUrlstringrequired
networkIDstringrequired
hasWalletForSelectedTokenboolean
positionIDstring
payrollGroupstring
walletVerifiedbooleanrequired
approvedbooleanrequired
isPassedCutoffDatebooleanrequired
isTerminatedbooleanrequired
settlementMethodstringrequired

Available options: manual, propose

fundingEmailSentbooleanrequired
adpDeductionsVerifiedbooleanrequired
payrollIntegrationEntityIdstring | nullrequired
resolvedFireblocksConfigobject | nullrequired
Show child attributes
configSourcestringrequired

Available options: entity, org

vaultAccountIdstringrequired
entityNamestring | nullrequired
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits