POST
/
user
/
balance
/
deposit
Deposit credits into a user's virtual balance
curl --request POST \
  --url https://api.paywalls.ai/v1/user/balance/deposit \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "amount": "<string>",
  "user": "<string>",
  "metadata": {}
}'
{
  "balanceFormatted": "<string>"
}

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.

Body

application/json
​
amount
string

The amount to deposit into the user's balance.

​
user
string

The unique identifier of the user to deposit credits for.

​
metadata
object

Optional metadata to associate with the deposit.

Response

200 - application/json

successful operation

​
balanceFormatted
string

The user's current credits balance.