List Payout Groups
curl --request GET \
--url https://api.paxos.com/v2/rewards/payout-groups \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.paxos.com/v2/rewards/payout-groups"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.paxos.com/v2/rewards/payout-groups', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.paxos.com/v2/rewards/payout-groups"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.paxos.com/v2/rewards/payout-groups")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paxos.com/v2/rewards/payout-groups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"items": [
{
"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"
}
],
"next_page_cursor": "<string>",
"count": 123
}Payout Groups
List Payout Groups
Retrieves a list of payout groups.
GET
/
rewards
/
payout-groups
List Payout Groups
curl --request GET \
--url https://api.paxos.com/v2/rewards/payout-groups \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.paxos.com/v2/rewards/payout-groups"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.paxos.com/v2/rewards/payout-groups', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.paxos.com/v2/rewards/payout-groups"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.paxos.com/v2/rewards/payout-groups")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.paxos.com/v2/rewards/payout-groups")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"items": [
{
"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"
}
],
"next_page_cursor": "<string>",
"count": 123
}OAuth Scope
rewards:read_payout_groups
Authorizations
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 →
Query Parameters
When set, only payout groups for this asset type (e.g. "USDG", "PYUSD") are returned.
When set, only payout groups whose name starts with this prefix are returned (case-insensitive).
When set, only payout groups with this claimer address are returned.
When set, only payout groups for this ledger (network) are returned.
When set, only payout groups for this jurisdiction are returned.
When set, only payout groups with one of these onchain statuses are returned.
Available options:
UNREGISTERED, PENDING_REGISTRATION, NEEDS_REREGISTRATION, ACTIVE, FAILED_REGISTRATION, PENDING_DELETION, FAILED_DELETION, PENDING_MULTIPLIER_UPDATE, MULTIPLIER_UPDATE_FAILED, UNREGISTERED_INSUFFICIENT_BALANCE When set, only payout groups with a balance >= this value are returned (in business units, e.g. "1000.50").
Was this page helpful?