Adjust balance for trading accounts

Adjust account balances in bulk. Supports add, subtract, and set operations for one or multiple accounts.

PATCH /api/accounts/balance/

cURL

AddBalance(Bulk)

curl --request PATCH \
  --url https://api.example.com/api/accounts/balance/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "account_ids": [
    1001,
    1002,
    1003
  ],
  "operation": "add",
  "amount": 5000
}
'

200

SuccessResponse-Add

{
  "success": true,
  "message": "Account balances adjusted.",
  "results": [
    {
      "account_id": 1001,
      "operation": "add",
      "amount": 5000,
      "previous_balance": 50000,
      "new_balance": 55000
    },
    {
      "account_id": 1002,
      "operation": "add",
      "amount": 5000,
      "previous_balance": 30000,
      "new_balance": 35000
    }
  ],
  "summary": {
    "updated": 2
  },
  "duration_ms": 62
}

Authorizations

Authorization · string · header · required

Token-based authentication with required prefix "Token"

Body

application/jsonapplication/x-www-form-urlencodedmultipart/form-data

account_ids · integer[]

operation · enum<string>

• add - Add
• subtract - Subtract
• set - Set

Available options: add, subtract, set

amount · string<decimal>

Pattern: ^-?\d{0,14}(?:\.\d{0,2})?$

Response

200 - application/json

Standard serializer for operation responses. A command or a task should return a response matching this format. Operation = a request to perform some action, e.g. sync, update, delete, create, etc.

success · boolean · required

Indicates whether the operation completed successfully.

results · any[] · required

List containing the result items produced by the operation. The structure of each item depends on the executed operation.

summary · object · required

Aggregated summary information about the operation results (e.g. counts of updated, created, failed or unchanged records).

Show child attributes

duration_ms · number<double> · required

Execution time of the operation in milliseconds.

message · string | null

Optional human-readable message describing the operation outcome.