Ctrl+K

Get Monthly Rewards Payout

get/api/stablecoin/v1/internal/monthly-rewards-payout

Retrieves a list of monthly rewards payout transactions.

Query Parameters

  • monthstring<number>
  • yearstring<number>

200 Response

id string required
Unique identifier for the monthly rewards payout
Example: 9f9944b3-b818-461f-95d2-cf465eb8f5e7
rewardMonth string <date-time>required
The month for which rewards are being paid out
Example: 2024-01-01T00:00:00.000Z
status string required
Current status of the rewards payout
Allowed values: created tms_notified authorized reward_created reward_initiated partially_fulfilled fulfilled failed_order_creation failed
Example: created
interestDepositId
string or null
required
Identifier for the interest deposit transaction
Example: "random-deposit"
assetId string <uuid>required
Identifier of the asset being paid out
Example: 2d9e406e-c5f9-45d0-aa66-3367df231d1f
rewardPayout array[object] required
Array of reward payout details for each enterprise
enterpriseId string required
Enterprise id for the reward payout
Min length: >= 1 characters
Example: ENPM4VHHKcXnpZbcwiUQMlRf65GlplrU
auc string required
Total AUC (Average User Contribution) across all wallets
Example: 200
rewardShare string required
Total reward share (AUC / total supply) across all wallets
Example: 0.3
rewardEarned string required
Total reward earned across all wallets (6 decimal places, rounded down)
Example: 85
fees string required
Total fees across all wallets
Example: 40

400 Response

500 Response