Self-serve contractor payments

Self Serve List Org Wallets

Builds an org-wide wallet report for employees and contractors with verification and latest test-tx state.

GEThttps://api.toku.com/hris/self-serve-list-org-wallets

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

curl --request GET \
  --url 'https://api.toku.com/hris/self-serve-list-org-wallets' \
  --header 'Authorization: Bearer <token>'
200 response
{
  "wallets": [
    {
      "walletID": "string",
      "roleInOrgID": "string",
      "source": "string",
      "ownerName": "string",
      "ownerFirstName": "string",
      "ownerLastName": "string",
      "ownerEmail": "string",
      "walletAddress": "string",
      "network": "string",
      "networkIcon": "string",
      "token": "string",
      "tokenIcon": "string",
      "status": "string",
      "walletVerified": true,
      "walletVerificationRequestID": "string",
      "verificationRequestLink": "string",
      "testTransaction": {
        "testTxID": "string",
        "status": "string",
        "amount": "string",
        "transactionHash": "string",
        "transactionLink": "string",
        "updatedAt": "string",
        "transferVisibility": "string"
      },
      "createdAt": "string"
    }
  ],
  "total": 0,
  "page": 0,
  "pageSize": 0,
  "totalPages": 0,
  "counts": {
    "all": 0,
    "verified": 0,
    "pending": 0,
    "other": 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

statusstring

Naming status, page or pageSize returns one page with its total, totalPages and counts. Naming none returns the whole report. pending is PENDING, PENDING_TXN_APPROVAL and PENDING_ADMIN_LINK_TXN; other is REJECTED, CANCELLED and ARCHIVED.

Available options: all, verified, pending, other

pageinteger

A page past the last returns the last page, so stop at totalPages. With no matching rows, page and totalPages are 1 and wallets is empty. Defaults to 1.

Allowed: at least 1

pageSizeinteger

Rows per page. Defaults to 50.

Allowed: 1 to 200

Response

200Successful response
walletsobject[]required
Show child attributes
walletIDstringrequired
roleInOrgIDstringrequired
sourcestringrequired
ownerNamestringrequired
ownerFirstNamestringrequired
ownerLastNamestringrequired
ownerEmailstring | nullrequired
walletAddressstring | nullrequired
networkstring | nullrequired
networkIconstring | nullrequired
tokenstring | nullrequired
tokenIconstring | nullrequired
statusstringrequired
walletVerifiedbooleanrequired
walletVerificationRequestIDstring | nullrequired
verificationRequestLinkstring | nullrequired
testTransactionobject | nullrequired
Show child attributes
testTxIDstringrequired
statusstringrequired
amountstring<decimal> | stringrequired
transactionHashstring | nullrequired
transactionLinkstring | nullrequired
updatedAtstringrequired
transferVisibilitystring | nullrequired
createdAtstringrequired
totalinteger
pageinteger
pageSizeinteger
totalPagesinteger
countsobject
Show child attributes
allintegerrequired
verifiedintegerrequired
pendingintegerrequired
otherintegerrequired
400Bad request
401Unauthorized
403Forbidden
404Not found
409Conflict
429Response 429
Was this page helpful? Suggest edits