Skip to main content
GET
/
v1
/
balances
/
{userId}
Get user balance
curl --request GET \
  --url https://api.useproxy.ai/v1/balances/{userId} \
  --header 'Api-Key: <api-key>'
{
  "userId": "<string>",
  "available": 123,
  "pending": 123,
  "deposited": 123,
  "currency": "USD"
}

Authorizations

​
Api-Key
string
header
required

API key for authentication. Get your key from the Dashboard.

Path Parameters

​
userId
string
required

The user ID

Response

User balance

​
userId
string
required
​
available
integer
required

Available balance that can be spent right now (cents)

​
pending
integer
required

Authorizations not yet settled (cents)

​
deposited
integer
required

Total funds deposited (cents)

​
currency
string
required

Currency code

Example:

"USD"