OpenAPI
Open API Learn Tutorial Reference Docs Explorer Apps Updates Get 24 Hour Token Sign in
Other Products FIX Trading API Client Management Systems API End-of-Day File Transfers Trade Event Notification System OpenAPI for Excel

Account Funding Events

A funding event is sent when money is added or deducted from an account.

Additional Fields


NameTypeDescription

Amount

decimal

Amount (e.g. number of securities) ordered.

ConversionRate

decimal

The conversion rate used at the time of the transaction.

CurrencyCode

string

The currency of the transaction.

FundingEvent

FundingEvent

Describes the funding event. 
New: The funding position is created. 
Updated: The funding position has been updated. (This happens very rarely).

FundingType

FundingType

Describes the type of the funding. 
Deposit: Money is added to the account. 
Withdrawal: Money is deducted from the account.

PositionId

string

Identifies the position.

RegistrationTime

UtcDateTime

The time when the transaction was registered by the bank.

ValueDate

Date

The date when the final transfer of the product of the transaction takes place.


Sample Message

An example of an account funding event message:

{
  "ReferenceId": "U_939",
  "Timestamp": "2018-07-11T13:39:29.228357Z",
  "Data": [
    {
      "AccountId": "IB-AMA-Cash",
      "ActivityTime": "2018-07-09T12:04:40.949433Z",
      "ActivityType": "AccountFundings",
      "Amount": 2,
      "ClientId": "2147045884",
      "ConversionRate": 1,
      "CurrencyCode": "USD",
      "FundingEvent": "New",
      "FundingType": "Withdrawal",
      "PositionId": "150733432",
      "RegistrationTime": "2018-07-09T12:04:40.891234Z",
      "SequenceId": "35136",
      "ValueDate": "2018-07-09"
    }
  ]
}