Skip to main content
POST
Adjust account balance

Authorizations

Authorization
string
header
required

API key created in Admin, API. Send it as Authorization: Bearer <key>. Each key has its own permissions and optional IP allow list.

Path Parameters

user
integer
required

User id.

Body

application/json
action
enum<string>
required
Available options:
add,
remove,
set
amount
number
required

Amount in the base currency.

Required range: x >= 0
reason
string
required

Shown in the ledger and the notification.

Maximum string length: 255
notify_user
boolean
default:true

Response

Success.

data
object
required
meta
object
required
message
string

Human readable confirmation.