Skip to main content

Add user balance

Adds a balance transaction to a specific user.

Path Parameters
userId int32 REQUIRED
Request Body REQUIRED
BalanceType string

The type of balance. See the separate endpoint for available balance types. Required.

Currency string

The currency of this balance transaction. 3-letter ISO currency code.
Optional. Will default to the users default currency if not specified.

ExternalId int32

An optional external id of the transaction.

Text string

Additional optional information about the transaction.

Amount double

The amount to add to balance. Can be negative.
Required.

Responses
200

Ok.

Schema OPTIONAL
Message string OPTIONAL

A status message for the action taken.

Details string[] OPTIONAL

Any validation messages for the data on the current action.

400

Bad request.

Schema OPTIONAL
Message string OPTIONAL

A status message for the action taken.

Details string[] OPTIONAL

Any validation messages for the data on the current action.

404

Not found.

Schema OPTIONAL
Message string OPTIONAL

A status message for the action taken.

Details string[] OPTIONAL

Any validation messages for the data on the current action.