Approve Token Payroll Settlements

Approve token payroll settlements

curl --request POST \
  --url https://app.toku.com/api/tokuApi/v1/approveTokenPayrollSettlements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-role-type: <x-role-type>' \
  --data '
{
  "tokenPayrollID": "<string>",
  "walletReferenceIDs": [
    "<string>"
  ],
  "pendingSettlements": [
    {
      "roleInOrgID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "contributorInTokenPayrollID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "settlementOrderForContributorTokenPayrollID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "walletAddress": "<string>",
      "tokenID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tokenAmount": 123,
      "fiatAmount": 123,
      "fiatCurrency": "<string>",
      "exchangeRate": 123,
      "exchangeRateDate": "2023-11-07T05:31:56Z",
      "inprogress": true,
      "approvedAt": "2023-11-07T05:31:56Z"
    }
  ]
}
'

import requests

url = "https://app.toku.com/api/tokuApi/v1/approveTokenPayrollSettlements"

payload = {
    "tokenPayrollID": "<string>",
    "walletReferenceIDs": ["<string>"],
    "pendingSettlements": [
        {
            "roleInOrgID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "contributorInTokenPayrollID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "settlementOrderForContributorTokenPayrollID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "walletAddress": "<string>",
            "tokenID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "tokenAmount": 123,
            "fiatAmount": 123,
            "fiatCurrency": "<string>",
            "exchangeRate": 123,
            "exchangeRateDate": "2023-11-07T05:31:56Z",
            "inprogress": True,
            "approvedAt": "2023-11-07T05:31:56Z"
        }
    ]
}
headers = {
    "x-role-type": "<x-role-type>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-role-type': '<x-role-type>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    tokenPayrollID: '<string>',
    walletReferenceIDs: ['<string>'],
    pendingSettlements: [
      {
        roleInOrgID: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        contributorInTokenPayrollID: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        settlementOrderForContributorTokenPayrollID: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        walletAddress: '<string>',
        tokenID: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        tokenAmount: 123,
        fiatAmount: 123,
        fiatCurrency: '<string>',
        exchangeRate: 123,
        exchangeRateDate: '2023-11-07T05:31:56Z',
        inprogress: true,
        approvedAt: '2023-11-07T05:31:56Z'
      }
    ]
  })
};

fetch('https://app.toku.com/api/tokuApi/v1/approveTokenPayrollSettlements', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.toku.com/api/tokuApi/v1/approveTokenPayrollSettlements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'tokenPayrollID' => '<string>',
    'walletReferenceIDs' => [
        '<string>'
    ],
    'pendingSettlements' => [
        [
                'roleInOrgID' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'contributorInTokenPayrollID' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'settlementOrderForContributorTokenPayrollID' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'walletAddress' => '<string>',
                'tokenID' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'tokenAmount' => 123,
                'fiatAmount' => 123,
                'fiatCurrency' => '<string>',
                'exchangeRate' => 123,
                'exchangeRateDate' => '2023-11-07T05:31:56Z',
                'inprogress' => true,
                'approvedAt' => '2023-11-07T05:31:56Z'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-role-type: <x-role-type>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.toku.com/api/tokuApi/v1/approveTokenPayrollSettlements"

	payload := strings.NewReader("{\n  \"tokenPayrollID\": \"<string>\",\n  \"walletReferenceIDs\": [\n    \"<string>\"\n  ],\n  \"pendingSettlements\": [\n    {\n      \"roleInOrgID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"contributorInTokenPayrollID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"settlementOrderForContributorTokenPayrollID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"walletAddress\": \"<string>\",\n      \"tokenID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"tokenAmount\": 123,\n      \"fiatAmount\": 123,\n      \"fiatCurrency\": \"<string>\",\n      \"exchangeRate\": 123,\n      \"exchangeRateDate\": \"2023-11-07T05:31:56Z\",\n      \"inprogress\": true,\n      \"approvedAt\": \"2023-11-07T05:31:56Z\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-role-type", "<x-role-type>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.toku.com/api/tokuApi/v1/approveTokenPayrollSettlements")
  .header("x-role-type", "<x-role-type>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tokenPayrollID\": \"<string>\",\n  \"walletReferenceIDs\": [\n    \"<string>\"\n  ],\n  \"pendingSettlements\": [\n    {\n      \"roleInOrgID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"contributorInTokenPayrollID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"settlementOrderForContributorTokenPayrollID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"walletAddress\": \"<string>\",\n      \"tokenID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"tokenAmount\": 123,\n      \"fiatAmount\": 123,\n      \"fiatCurrency\": \"<string>\",\n      \"exchangeRate\": 123,\n      \"exchangeRateDate\": \"2023-11-07T05:31:56Z\",\n      \"inprogress\": true,\n      \"approvedAt\": \"2023-11-07T05:31:56Z\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.toku.com/api/tokuApi/v1/approveTokenPayrollSettlements")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-role-type"] = '<x-role-type>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"tokenPayrollID\": \"<string>\",\n  \"walletReferenceIDs\": [\n    \"<string>\"\n  ],\n  \"pendingSettlements\": [\n    {\n      \"roleInOrgID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"contributorInTokenPayrollID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"settlementOrderForContributorTokenPayrollID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"walletAddress\": \"<string>\",\n      \"tokenID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"tokenAmount\": 123,\n      \"fiatAmount\": 123,\n      \"fiatCurrency\": \"<string>\",\n      \"exchangeRate\": 123,\n      \"exchangeRateDate\": \"2023-11-07T05:31:56Z\",\n      \"inprogress\": true,\n      \"approvedAt\": \"2023-11-07T05:31:56Z\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "<string>",
  "approvedCount": 123
}

{
  "error": "<string>",
  "details": "<string>"
}

{
  "error": "<string>",
  "details": "<string>"
}

{
  "error": "<string>",
  "details": "<string>"
}

{
  "error": "<string>",
  "details": "<string>"
}

POST

approveTokenPayrollSettlements

Approve token payroll settlements

curl --request POST \
  --url https://app.toku.com/api/tokuApi/v1/approveTokenPayrollSettlements \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-role-type: <x-role-type>' \
  --data '
{
  "tokenPayrollID": "<string>",
  "walletReferenceIDs": [
    "<string>"
  ],
  "pendingSettlements": [
    {
      "roleInOrgID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "contributorInTokenPayrollID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "settlementOrderForContributorTokenPayrollID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "walletAddress": "<string>",
      "tokenID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "tokenAmount": 123,
      "fiatAmount": 123,
      "fiatCurrency": "<string>",
      "exchangeRate": 123,
      "exchangeRateDate": "2023-11-07T05:31:56Z",
      "inprogress": true,
      "approvedAt": "2023-11-07T05:31:56Z"
    }
  ]
}
'

import requests

url = "https://app.toku.com/api/tokuApi/v1/approveTokenPayrollSettlements"

payload = {
    "tokenPayrollID": "<string>",
    "walletReferenceIDs": ["<string>"],
    "pendingSettlements": [
        {
            "roleInOrgID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "contributorInTokenPayrollID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "settlementOrderForContributorTokenPayrollID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "walletAddress": "<string>",
            "tokenID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "tokenAmount": 123,
            "fiatAmount": 123,
            "fiatCurrency": "<string>",
            "exchangeRate": 123,
            "exchangeRateDate": "2023-11-07T05:31:56Z",
            "inprogress": True,
            "approvedAt": "2023-11-07T05:31:56Z"
        }
    ]
}
headers = {
    "x-role-type": "<x-role-type>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-role-type': '<x-role-type>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    tokenPayrollID: '<string>',
    walletReferenceIDs: ['<string>'],
    pendingSettlements: [
      {
        roleInOrgID: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        contributorInTokenPayrollID: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        settlementOrderForContributorTokenPayrollID: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        walletAddress: '<string>',
        tokenID: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
        tokenAmount: 123,
        fiatAmount: 123,
        fiatCurrency: '<string>',
        exchangeRate: 123,
        exchangeRateDate: '2023-11-07T05:31:56Z',
        inprogress: true,
        approvedAt: '2023-11-07T05:31:56Z'
      }
    ]
  })
};

fetch('https://app.toku.com/api/tokuApi/v1/approveTokenPayrollSettlements', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.toku.com/api/tokuApi/v1/approveTokenPayrollSettlements",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'tokenPayrollID' => '<string>',
    'walletReferenceIDs' => [
        '<string>'
    ],
    'pendingSettlements' => [
        [
                'roleInOrgID' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'contributorInTokenPayrollID' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'settlementOrderForContributorTokenPayrollID' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'walletAddress' => '<string>',
                'tokenID' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
                'tokenAmount' => 123,
                'fiatAmount' => 123,
                'fiatCurrency' => '<string>',
                'exchangeRate' => 123,
                'exchangeRateDate' => '2023-11-07T05:31:56Z',
                'inprogress' => true,
                'approvedAt' => '2023-11-07T05:31:56Z'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-role-type: <x-role-type>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.toku.com/api/tokuApi/v1/approveTokenPayrollSettlements"

	payload := strings.NewReader("{\n  \"tokenPayrollID\": \"<string>\",\n  \"walletReferenceIDs\": [\n    \"<string>\"\n  ],\n  \"pendingSettlements\": [\n    {\n      \"roleInOrgID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"contributorInTokenPayrollID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"settlementOrderForContributorTokenPayrollID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"walletAddress\": \"<string>\",\n      \"tokenID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"tokenAmount\": 123,\n      \"fiatAmount\": 123,\n      \"fiatCurrency\": \"<string>\",\n      \"exchangeRate\": 123,\n      \"exchangeRateDate\": \"2023-11-07T05:31:56Z\",\n      \"inprogress\": true,\n      \"approvedAt\": \"2023-11-07T05:31:56Z\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-role-type", "<x-role-type>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.toku.com/api/tokuApi/v1/approveTokenPayrollSettlements")
  .header("x-role-type", "<x-role-type>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tokenPayrollID\": \"<string>\",\n  \"walletReferenceIDs\": [\n    \"<string>\"\n  ],\n  \"pendingSettlements\": [\n    {\n      \"roleInOrgID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"contributorInTokenPayrollID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"settlementOrderForContributorTokenPayrollID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"walletAddress\": \"<string>\",\n      \"tokenID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"tokenAmount\": 123,\n      \"fiatAmount\": 123,\n      \"fiatCurrency\": \"<string>\",\n      \"exchangeRate\": 123,\n      \"exchangeRateDate\": \"2023-11-07T05:31:56Z\",\n      \"inprogress\": true,\n      \"approvedAt\": \"2023-11-07T05:31:56Z\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.toku.com/api/tokuApi/v1/approveTokenPayrollSettlements")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-role-type"] = '<x-role-type>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"tokenPayrollID\": \"<string>\",\n  \"walletReferenceIDs\": [\n    \"<string>\"\n  ],\n  \"pendingSettlements\": [\n    {\n      \"roleInOrgID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"contributorInTokenPayrollID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"settlementOrderForContributorTokenPayrollID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"walletAddress\": \"<string>\",\n      \"tokenID\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n      \"tokenAmount\": 123,\n      \"fiatAmount\": 123,\n      \"fiatCurrency\": \"<string>\",\n      \"exchangeRate\": 123,\n      \"exchangeRateDate\": \"2023-11-07T05:31:56Z\",\n      \"inprogress\": true,\n      \"approvedAt\": \"2023-11-07T05:31:56Z\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "<string>",
  "approvedCount": 123
}

{
  "error": "<string>",
  "details": "<string>"
}

{
  "error": "<string>",
  "details": "<string>"
}

{
  "error": "<string>",
  "details": "<string>"
}

{
  "error": "<string>",
  "details": "<string>"
}

Authorizations

Authorization

string

header

required

Personal API token. Create via createUserApiToken endpoint.

Headers

x-role-type

enum<string>

required

Role context for the request. Use CLIENT_ORG_ADMIN for most integrations.

Available options:

CLIENT_ORG_ADMIN,

PAYROLL_ADMIN,

FINANCE_ADMIN,

TOKU_ADMIN

Body

application/json

tokenPayrollID

string

required

Token payroll identifier

walletReferenceIDs

string[]

required

Wallet references to approve

Wallet reference identifier

pendingSettlements

object[] | null

Optional settlement records to approve

Show child attributes

Response

Successful response

success

boolean

required

Whether approval succeeded

message

string

required

Approval summary message

approvedCount

integer

required

Number of approved settlements

⌘I