---
title: "Get Rewards Balance Withdrawal Url"
method: GET
path: "/rewards/{site_id}/url/balance"
tags: ["6. Rewards"]
---

# Get Rewards Balance Withdrawal Url

`GET /rewards/{site_id}/url/balance`

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

## 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 — 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_uri` string, required — Where to redirect after completion
- `hide_transactions` boolean — Hide transaction history from the user
- `auto_redirect_to_setup` boolean — Skip the balance page and go straight to bank setup if no account exists

## Response `200`

Successful Response

- BalanceWithdrawalURLResponse — 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

## Other responses

- `404` — Site not found or not authorized to access
- `422` — Validation Error
- `500` — Internal server error

---

[API](https://skmtc.dev/axle/apis/axle-api-docs.md) · [All operations](https://skmtc.dev/axle/apis/axle-api-docs/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/axle/axle-api-docs/revisions/75be7f9a952f/schema)