AXaxle
6. Rewards

Get Balance Info

Changed on

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

get/rewards/{site_id}/info

Request

  • Base URL
    https://api-sandbox.axle.energy
  • URL
    https://api-sandbox.axle.energy/rewards/{site_id}/info
  • Auth
    OAuth 2
    Password
    Token URL: auth/token-form

Path parameters

site_idstring uuid required

Response

Successful Response

current_balance_penceinteger required

current_balance in minor units of its currency (pence for GBP, cents for EUR). Kept for existing integrations; new ones should read current_balance.

total_earnings_penceinteger required

total_earnings in minor units of its currency (pence for GBP, cents for EUR). Kept for existing integrations; new ones should read total_earnings.

minimum_withdrawal_threshold_penceinteger required

minimum_withdrawal_threshold in minor units of its currency (pence for GBP, cents for EUR). Kept for existing integrations; new ones should read minimum_withdrawal_threshold.

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

next_payment_datestring date

Date of the next scheduled payout Axle starts for this user. Null when the organisation has no payout schedule, so the user withdraws by hand.

Changes

  • b0b07b1dbf12Revision changes
    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      response property current_balance_pence deprecated

    • info

      response property minimum_withdrawal_threshold_pence deprecated

    • info

      response property total_earnings_pence deprecated

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status