Sign in

v1

latestOpenAPI 3.1.02026-07-264793109.1 KB
6. Rewards

Get Rewards Balance Withdrawal Url

Get a temporary link to an Axle-hosted form through which users can view and withdraw rewards. Requires an organisational bearer token.

get/rewards/{site_id}/url/balance

Path parameters

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

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_authboolean

Require email verification before the user can link a bank account. Balance and transaction-history views are not gated. When omitted, falls back to the organisation's configured 2FA posture.

Require email verification before the user can link a bank account. Balance and transaction-history views are not gated. When omitted, falls back to the organisation's configured 2FA posture.

redirect_uristring required

Where to redirect after completion

Where to redirect after completion

hide_transactionsboolean

Hide transaction history from the user

Hide transaction history from the user

auto_redirect_to_setupboolean

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

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

Response

Successful Response

balance_withdrawal_urlstring required

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

url_expiry_timestampstring date-time required

Time at which the given URL will expire