Get Balance Info

Get info about current balance and total earnings for the site.

GET /rewards/{site_id}/info

Get Balance Info

cURL

curl --request GET \
  --url https://api-sandbox.axle.energy/rewards/{site_id}/info \
  --header 'Authorization: Bearer <token>'

200

{
  "current_balance_pence": 123,
  "total_earnings_pence": 123,
  "minimum_withdrawal_threshold_pence": 123,
  "withdrawal_min_wait_days": 123,
  "can_withdraw": true
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

site_id · string<uuid> · required

Response

200

application/json

Successful Response

Response model for site balance information.

current_balance_pence · integer · required

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

total_earnings_pence · integer · required

Lifetime earnings of the site in pence

minimum_withdrawal_threshold_pence · integer · required

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

withdrawal_min_wait_days · integer · required

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

can_withdraw · boolean · required

Whether the user can withdraw their balance