Skip to main content
GET
Retrieve the user’s current balance

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Paywall-User
string

Optional user identifier provided by the developer. Can be used instead of the user property in the request body to associate the API call with a specific end user.

Query Parameters

user
string

The unique identifier of the user to get balance information for.

Response

200 - application/json

successful operation

balance
string

The current balance of the user, in wei

balanceFormatted
string

The current balance of the user, formatted for display.