Skip to main content
GET
/
rewards
/
{site_id}
/
url
/
balance
Get Balance Withdrawal Url
curl --request GET \
  --url https://api-sandbox.axle.energy/rewards/{site_id}/url/balance \
  --header 'Authorization: Bearer <token>'
{
  "balance_withdrawal_url": "<string>",
  "url_expiry_timestamp": "2023-11-07T05:31:56Z"
}
Important: Anyone with access to this link will be able to withdraw funds from the corresponding site. The URL expires at midnight (UK time) on the day it was generated. The ability to withdraw funds via API-generated links is disabled by default. Contact us to enable it for your organisation.

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

The ID on Axle's system for this user. The site_id can be easily retrieved from the get-by-external-id endpoint.

Query Parameters

​
enforce_two_factor_auth
boolean
required

Require email verification before access

​
redirect_uri
string
required

Where to redirect after completion

​
hide_transactions
boolean
default:false

Hide transaction history from the user

​
auto_redirect_to_setup
boolean
default:false

Skip the balance page and go straight to bank setup if no account exists

Response

Successful Response

Response model for balance withdrawal URL.

​
balance_withdrawal_url
string
required

Temporary standalone URL via which an end-user may enter their bank details to withdraw their balance

​
url_expiry_timestamp
string<date-time>
required

Time at which the given URL will expire