Get reward details

curl --request GET \
  --url https://api.paxos.com/v2/rewards/details \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paxos.com/v2/rewards/details', 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/details",
  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/details"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.paxos.com/v2/rewards/details")

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

{
  "rates": [
    {
      "id": "<string>",
      "multiplier_id": "<string>",
      "rate": "<string>",
      "networks": [
        "<string>"
      ],
      "jurisdiction": "JURISDICTION_UNSPECIFIED",
      "tier": "TIER_UNSPECIFIED",
      "effective_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next_accrual": "2023-11-07T05:31:56Z",
  "lifetime_earned": "<string>",
  "total_available_rewards": "<string>",
  "est_next_accrual_amount": "<string>",
  "asset_details": [
    {
      "asset_type": "<string>",
      "total_available_rewards": "<string>",
      "lifetime_earned": "<string>",
      "est_next_accrual_amount": "<string>"
    }
  ]
}

GET

rewards

details

Get reward details

curl --request GET \
  --url https://api.paxos.com/v2/rewards/details \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.paxos.com/v2/rewards/details', 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/details",
  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/details"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.paxos.com/v2/rewards/details")

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

{
  "rates": [
    {
      "id": "<string>",
      "multiplier_id": "<string>",
      "rate": "<string>",
      "networks": [
        "<string>"
      ],
      "jurisdiction": "JURISDICTION_UNSPECIFIED",
      "tier": "TIER_UNSPECIFIED",
      "effective_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next_accrual": "2023-11-07T05:31:56Z",
  "lifetime_earned": "<string>",
  "total_available_rewards": "<string>",
  "est_next_accrual_amount": "<string>",
  "asset_details": [
    {
      "asset_type": "<string>",
      "total_available_rewards": "<string>",
      "lifetime_earned": "<string>",
      "est_next_accrual_amount": "<string>"
    }
  ]
}

OAuth Scope

rewards:read_rewards_details

Authorizations

Authorization

string

header

required

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:read_rewards_details

Query Parameters

asset_type

string

When set, only data for this asset type (e.g. "USDG", "PYUSD") is returned.

Response

200 - application/json

A successful response.

rates

RewardRate represents a reward rate configuration · object[]

Show child attributes

next_accrual

string<date-time>

lifetime_earned

string<decimal>

total_available_rewards

string<decimal>

est_next_accrual_amount

string<decimal>

asset_details

object[]

Per-asset reward details breakdown. Supports partners with multiple asset types.

Show child attributes

API Documentation

Deposits and Withdrawals

Address Verification

Identity

Profiles

Sandbox

Orchestrations / Conversions

Taxes

Trading

Rewards Engine

Events

API Credentials

User Audit Logs

Websockets

Webhooks

Problems

Get reward details

Authorizations

Query Parameters

Response