Set a paper trading account cash balance

PATCHhttps://api.agg.market/apps/{appId}/paper-trading/accounts/{accountId}/balance

Loading code example

Loading code example

Authorizations

appApiKeystringheaderrequired

API key passed in the header.

Path Parameters

appIdstringrequired

accountIdstringrequired

Body

balanceRawstring

Pattern: ^[0-9]+$

balancenumber

Required range: x >= 0

reasonstring

Length: <= 500

Response

application/json

200

accountobjectrequired

account.idstringrequired

account.appIdstringrequired

account.namestringrequired

account.externalIdstringrequired

account.currencystringrequired

account.startingBalanceRawstringrequired

account.startingBalancenumberrequired

account.cashBalanceRawstringrequired

account.cashBalancenumberrequired

account.realizedPnlRawstringrequired

account.realizedPnlnumberrequired

account.kycStatus"verified"required

Allowed values: "verified"

account.kycVerifiedtruerequired

Allowed values: true

account.status"active" | "archived"required

Allowed values: "active" | "archived"

account.createdAtstringrequired

account.updatedAtstringrequired

adjustmentobjectrequired

adjustment.idstringrequired

adjustment.accountIdstringrequired

adjustment.type"set_balance" | "reset"required

Allowed values: "set_balance" | "reset"

adjustment.amountRawstringrequired

adjustment.amountnumberrequired

adjustment.previousCashBalanceRawstringrequired

adjustment.previousCashBalancenumberrequired

adjustment.newCashBalanceRawstringrequired

adjustment.newCashBalancenumberrequired

adjustment.reasonstringrequired

adjustment.createdAtstringrequired