GetAccountDepositTransactions

Category: User Permissions: Trading, AccountReadOnly Call Type: Synchronous

Obtains a list of deposits for the account.

Users with Trading and AccountReadOnly permission can return deposit transactions only from an account with which they are associated.

The owner of the trading venue determines how long to retain transaction history before archiving.

Note: Depth in this call is a count of how many deposit transactions to report. It is not "depth of market."

Request

{
    "OMSId": 1,
    "AccountId": 1,
    "Depth": 200
}
KeyValue

OMSId

integer. The ID of the Order Management System on which the account transactions took place.

AccountId

integer. The ID of the account whose transactions will be returned.

Depth

integer. The count of deposit transactions to be returned. Defaults to 200.

Response

[
  {
    "transactionId": 0,
    "omsId": 0,
    "accountId": 0,
    "cr": 0.0,
    "dr": 0.0,
    "counterparty": 0,
    "transactionType": 0,
    "referenceId": 0,
    "referenceType": 0,
    "productId": 0,
    "balance": 0.0,
    "timeStamp": 0
    },
]

The response returns an array of transaction objects.

KeyValue

transactionId

Integer. The ID of the transaction.

omsId

Integer. The ID of the Order Management System under which the requested transactions took place.

accountId

Integer. The single account under which the transactions took place.

cr

real. Credit entry for the account on the order book. Funds entering an account.

dr

real. Debit entry for the account on the order book. Funds leaving an account.

counterparty

long integer. The corresponding party in a trade.

transactionType

integer. A number representing the type of transaction: 1 Fee 2 Trade 3 Other 4 Reverse 5 Hold 6 Rebate 7 MarginAcquisition 8 MarginRelinquish

referenceId

long integer. The ID of the action or event that triggered this transaction.

referenceType

integer. A number representing the type of action or event that triggered this transaction. One of: 1 Trade 2 Deposit 3 Withdraw 4 Transfer 5 OrderHold 6 WithdrawHold 7 DepositHold 8 MarginHold 9 ManualHold 10 ManualEntry 11 MarginAcquisition 12 MarginRelinquish 13 MarginQuoteHold

productId

integer. The ID of the product in which the deposit was made. Use GetProduct to return information about a product based on its ID.

balance

real. The balance in the account after the transaction.

timeStamp

long integer. Time at which the transaction took place, in POSIX format.

Last updated

Logo