BonusOut¶
Creates a negative bonus transaction or updates an existing OP_BONUS_OUT transaction. Requires access_backoffice and manager permission set_bonuses.
Parameters¶
| Field | Type | Required | Description |
|---|---|---|---|
login |
integer | Yes | Account login. |
amount |
number | Yes | New negative transaction amount. |
comment |
string | Yes | Comment, up to 256 characters. |
order |
integer | No | Existing bonus order to update. Omit to create. |
open_time |
integer | No | Replacement open timestamp. |
close_time |
integer | No | Replacement close timestamp. |
gw_uuid |
string | No | External correlation identifier. |
Create¶
{"command":"BonusOut","data":{"login":2000066,"amount":-100,"comment":"Bonus correction"},"extID":"bonus-revoke-1"}
Update¶
{"command":"BonusOut","data":{"login":2000066,"order":1246910,"amount":-50,"comment":"Adjusted correction"},"extID":"bonus-revoke-update-1"}
For an update, safety checks are applied to the delta between the new amount and the amount already applied by the stored order. The operation is rejected if it would make bonus negative, violate projected margin safety, or conflict with the group policy for open positions.
The stored transaction must belong to the same login and must be OP_BONUS_OUT. Client-side prev is ignored. A nonexistent supplied order returns RET_NOT_FOUND.
Response data¶
{"accepted":true,"order":1246910,"state":11,"login":2000066,"cmd":15,"amount":-50.0}