Update Payout Group
curl --request PUT \
--url https://api.paxos.com/v2/rewards/payout-groups/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"jurisdiction": "<string>"
}
'import requests
url = "https://api.paxos.com/v2/rewards/payout-groups/{id}"
payload = {
"name": "<string>",
"jurisdiction": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', jurisdiction: '<string>'})
};
fetch('https://api.paxos.com/v2/rewards/payout-groups/{id}', 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://api.paxos.com/v2/rewards/payout-groups/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'jurisdiction' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.paxos.com/v2/rewards/payout-groups/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"jurisdiction\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
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.put("https://api.paxos.com/v2/rewards/payout-groups/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"jurisdiction\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paxos.com/v2/rewards/payout-groups/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"jurisdiction\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"group": {
"id": "<string>",
"ledger": "<string>",
"asset_type": "<string>",
"rate_id": "<string>",
"jurisdiction": "<string>",
"claimer_address": "<string>",
"onchain_status": "UNREGISTERED",
"balance": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"manager_address": "<string>",
"destination_address": "<string>",
"onchain_group_id": "<string>",
"balance_at": "2023-11-07T05:31:56Z",
"last_claim_all_at": "2023-11-07T05:31:56Z"
}
}Payout Groups
Update Payout Group
Updates a payout group. Any changes to a payout group which has an on-chain component will cause the unclaimed rewards for that group to be implicitly claimed. No details of the implicit claiming are returned in this API response.
PUT
/
rewards
/
payout-groups
/
{id}
Update Payout Group
curl --request PUT \
--url https://api.paxos.com/v2/rewards/payout-groups/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"jurisdiction": "<string>"
}
'import requests
url = "https://api.paxos.com/v2/rewards/payout-groups/{id}"
payload = {
"name": "<string>",
"jurisdiction": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: '<string>', jurisdiction: '<string>'})
};
fetch('https://api.paxos.com/v2/rewards/payout-groups/{id}', 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://api.paxos.com/v2/rewards/payout-groups/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'jurisdiction' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://api.paxos.com/v2/rewards/payout-groups/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"jurisdiction\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
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.put("https://api.paxos.com/v2/rewards/payout-groups/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"jurisdiction\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paxos.com/v2/rewards/payout-groups/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"jurisdiction\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"group": {
"id": "<string>",
"ledger": "<string>",
"asset_type": "<string>",
"rate_id": "<string>",
"jurisdiction": "<string>",
"claimer_address": "<string>",
"onchain_status": "UNREGISTERED",
"balance": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"manager_address": "<string>",
"destination_address": "<string>",
"onchain_group_id": "<string>",
"balance_at": "2023-11-07T05:31:56Z",
"last_claim_all_at": "2023-11-07T05:31:56Z"
}
}OAuth Scope
rewards:update_payout_groups
Authorizations
OAuth2OAuth2
Paxos APIs use OAuth 2 with the client credentials grant flow.
Token URLs:
- Production: https://oauth.paxos.com/oauth2/token
- Sandbox: https://oauth.sandbox.paxos.com/oauth2/token
Learn more in the API credentials guide →
FlowClient Credentials
- Token URL
- https://oauth.paxos.com/oauth2/token
Scopes1
rewards:update_payout_groups
Path Parameters
UUID direct reference to the existing payout group
Response
200 - application/json
A successful response.
Show child attributes
Show child attributes
Was this page helpful?