Perform a Cash Adjustment
API URL: PUT https://userapi-demo.s2f.projectx.com/TradingAccount/cashAdjustment
API Reference: /TradingAccount/cashAdjustment
Description
Adjusts the balance of a Trading Account. A balance adjustment may occur for many reasons, including but not limited to payouts and account reconciliations.
Parameters
| Name | Type | Description | Required | Nullable |
|---|---|---|---|---|
| tradingAccountId | integer | The Trading Account's id. | Required | false |
| amount | integer | The amount adjusted. | Required | false |
| reason | integer | The reason for the cash adjustment. Valid Values:
| Required | false |
| notes | string | Additional notes. | Required | false |
Example Usage
Example Request
- cURL
curl -X 'PUT' \
'https://userapi-demo.s2f.projectx.com/TradingAccount/cashAdjustment' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
"tradingAccountId": 7,
"amount": 100,
"reason": 1,
"notes": "EOD adjustment"
}'
Example Response
- Success
- Error
Error: response status is 401