Skip to main content

Create User Wallet Event

API operation: Open the endpoint in the API reference

Use POST /users/{user_id}/wallets/{wallet_id}/events to create a manual wallet movement. The current public operation is WalletEvent.register.

If available, the operation requires administrator authentication. amount is required and can be positive or negative; description is optional. The wallet must belong to the selected user, be enabled by project settings, and not be locked. A successful movement changes the wallet balance and records the authenticated author and audit fingerprint.

Wallet movements affect stored value. Validate authorization, amount, currency/value type, and business intent before use. See Wallet event model.

OpenAPI reference​

Operation: POST /users/{user_id}/wallets/{wallet_id}/events

Path parameters

NameTypeRequiredDescription
user_idintegerYes—
wallet_idintegerYes—

Header parameters

NameTypeRequiredDescription
User-AgentstringNo—
X-Forwarded-ForstringNo—
X-Internal-Product-XstringNo—

Request body fields

NameTypeRequired
amountnumberYes
descriptionanyNo

Responses

CodeDescription
200OK (Envelope)
400Bad Request (ErrorResponse)
401Unauthorized
404Not Found
429Too Many Requests (ErrorResponse)
500Internal Server Error (ErrorResponse)
503Service Unavailable (ErrorResponse)
Open this operation in the API reference