Monitor Reward Details

The reward details endpoint gives you a real-time view of your organization’s reward position: the current earnings rate, total rewards earned, rewards available to be claimed, and the estimated amount for the next accrual.

Required scope: rewards:read_rewards_details

Get reward details

Use Get Reward Details:

Show Request

curl -X GET 'https://api.sandbox.paxos.com/v2/rewards/details?asset_type=USDG' \
  -H 'Authorization: Bearer {access_token}'

Show Response

{
  "rates": [
    {
      "rate": "0.045",
      "networks": ["ETHEREUM", "ARBITRUM_ONE"],
      "effective_at": "2024-01-01T00:00:00Z"
    }
  ],
  "next_accrual": "2024-01-16T00:00:00Z",
  "lifetime_earned": "1250.00",
  "total_available_rewards": "325.50",
  "est_next_accrual_amount": "42.75",
  "asset_details": [
    {
      "asset_type": "USDG",
      "total_available_rewards": "325.50",
      "lifetime_earned": "1250.00",
      "est_next_accrual_amount": "42.75"
    }
  ]
}

Key fields

Field	Description
`rate`	Annual Percentage Yield (APY) over the course of a year, including compound interest from reinvesting daily rewards back into the payout group.
`next_accrual`	UTC timestamp of the next balance snapshot and reward calculation.
`total_available_rewards`	Rewards accrued but not yet claimed.
`lifetime_earned`	Cumulative rewards earned across all periods.
`est_next_accrual_amount`	Projected reward for the upcoming accrual period, based on current balances.
`asset_details`	Per-asset breakdown of the top-level totals. Useful when holding multiple stablecoins.

Use the asset_type query parameter to filter results to a single stablecoin (e.g. ?asset_type=USDG).

Next step

View Claims

Track payout history and claim status

⌘I

Get Started

Identity

Travel Rule

Stablecoin Orchestration

Fiat Transfers

Rewards Engine

Address Verification

Stablecoin Payments

Crypto Brokerage

Webhooks

Additional Guides

Versioning

Get reward details

Key fields

Next step

View Claims

​Get reward details

​Key fields

​Next step

View Claims

Get reward details

Key fields

Next step