Get Balance Info - axle energy

GET

rewards

{site_id}

info

Get Balance Info

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-sandbox.axle.energy/rewards/{site_id}/info', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.axle.energy/rewards/{site_id}/info",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.axle.energy/rewards/{site_id}/info"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.axle.energy/rewards/{site_id}/info")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "current_balance": {
    "amount_minor_units": 123,
    "currency": "GBP"
  },
  "total_earnings": {
    "amount_minor_units": 123,
    "currency": "GBP"
  },
  "minimum_withdrawal_threshold": {
    "amount_minor_units": 123,
    "currency": "GBP"
  },
  "current_balance_pence": 123,
  "total_earnings_pence": 123,
  "minimum_withdrawal_threshold_pence": 123,
  "withdrawal_min_wait_days": 123,
  "can_withdraw": true,
  "next_payment_date": "2023-12-25"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

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

Successful Response

Response model for site balance information.

current_balance

MoneyResponse · object

required

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

Show child attributes

total_earnings

MoneyResponse · object

required

Lifetime earnings of the site

Show child attributes

minimum_withdrawal_threshold

MoneyResponse · object

required

The minimum a user can withdraw in one transaction

Show child attributes

current_balance_pence

integer

required

deprecated

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_pence

integer

required

deprecated

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_pence

integer

required

deprecated

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_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

next_payment_date

string<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.

⌘I

Get Balance Info

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

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api-sandbox.axle.energy/rewards/{site_id}/info', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-sandbox.axle.energy/rewards/{site_id}/info",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-sandbox.axle.energy/rewards/{site_id}/info"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.axle.energy/rewards/{site_id}/info")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "current_balance": {
    "amount_minor_units": 123,
    "currency": "GBP"
  },
  "total_earnings": {
    "amount_minor_units": 123,
    "currency": "GBP"
  },
  "minimum_withdrawal_threshold": {
    "amount_minor_units": 123,
    "currency": "GBP"
  },
  "current_balance_pence": 123,
  "total_earnings_pence": 123,
  "minimum_withdrawal_threshold_pence": 123,
  "withdrawal_min_wait_days": 123,
  "can_withdraw": true,
  "next_payment_date": "2023-12-25"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}