v1

latestOpenAPI 3.1.02026-07-264793109.1 KB
6. Rewards

Get Balance Info

Get info about current balance and total earnings for the site. Requires an organisational bearer token.

get/rewards/{site_id}/info

Path parameters

site_idstring uuid required

Response

Successful Response

current_balance_penceinteger required

Current balance of the site in pence (total earnings minus total withdrawals)

total_earnings_penceinteger required

Lifetime earnings of the site in pence

minimum_withdrawal_threshold_penceinteger required

The minimum a user can withdraw in one transaction, in pence

withdrawal_min_wait_daysinteger required

The number of days a user must wait to withdraw after their first reward

can_withdrawboolean required

Whether the user can withdraw their balance