HomešŸ”’ DocumentationAPI ReferencešŸ”’ Changelog
FIX APIAPI Status

Transaction Created

A new transaction has been created in a client account

Event Type

Description

transactions.created

A new transaction has been created in a customer account. Provides the details and type of the transaction that took place.

Transaction Created

{
  "id": "event_605c0042-ebc7-453e-9904-268b4f703f70",
  "type": "transactions.created",
  "timestamp": "2019-03-28T22:35:20.390396363Z",
  "payload": {
    "accountID": "b25f0d36-b4e4-41f8-b3d9-9249e46402cd.1403540676095",
    "accountNo": "DWZR000001",
    "userID": "b25f0d36-b4e4-41f8-b3d9-9249e46402cd",
    "transaction": {
      "accountAmount": 12,
      "accountBalance": 57529.64,
      "comment": "22",
      "finTranID": "GC.4bafaf91-c893-4684-9e59-27d514b72e7a",
      "wlpFinTranTypeID": "00cec36e-4d83-4703-a769-894198b829f2",
      "finTranTypeID": "CSR",
      "feeSec": 0,
      "feeTaf": 0,
      "feeBase": 0,
      "feeXtraShares": 0,
      "feeExchange": 0
    }
  }
}

Dividend Transactions

There are two types dividend transactions - dividend and dividend tax

{
  "id": "event_a1acdf71-17d2-4e38-81ce-871a86374b40",
  "type": "transactions.created",
  "timestamp": "2019-04-05T19:25:14.711707573Z",
  "payload": {
    "accountID": "b25f0d36-b4e4-41f8-b3d9-9249e46402cd.1491330741850",
    "accountNo": "DWEF000010",
    "userID": "b25f0d36-b4e4-41f8-b3d9-9249e46402cd",
    "transaction": {
      "accountAmount": 2.29,
      "accountBalance": 128195.27,
      "comment": "BPY dividend, $0.3043/share",
      "finTranID": "GF.861e931d-e7aa-47c8-b87a-b1e55acf3862",
      "wlpFinTranTypeID": "e8ff5103-ad40-4ed9-b2ee-fd96826bf935",
      "finTranTypeID": "DIV",
      "feeSec": 0,
      "feeTaf": 0,
      "feeBase": 0,
      "feeXtraShares": 0,
      "feeExchange": 0,
      "instrument": {
        "id": "476b40ee-3ff9-46af-85af-fec572d13d23",
        "symbol": "BPY",
        "name": "Brookfield Property Partners L.P."
      },
      "dividend": {
        "type": "CASH",
        "amountPerShare": 0.3043,
        "taxCode": "NON_TAXABLE"
      }
    }
  }
}

{
  "id": "event_a1acdf71-17d2-4e38-81ce-871a86374b40",
  "type": "transactions.created",
  "timestamp": "2019-04-05T19:25:14.711707573Z",
  "payload": {
    "accountID": "b25f0d36-b4e4-41f8-b3d9-9249e46402cd.1491330741850",
    "accountNo": "DWEF000010",
    "userID": "b25f0d36-b4e4-41f8-b3d9-9249e46402cd",
    "transaction": {
      "accountAmount": -0.06,
      "accountBalance": 26065.89,
      "comment": "GRFS tax, 19% withheld",
      "finTranID": "GL.b0043e24-117d-4429-82dd-9b23ea82ef74",
      "wlpFinTranTypeID": "e8ff5103-ad40-4ed9-b2ee-fd96826bf937",
      "finTranTypeID": "DIVTAX",
      "feeSec": 0,
      "feeTaf": 0,
      "feeBase": 0,
      "feeXtraShares": 0,
      "feeExchange": 0,
      "instrument": {
        "id": "247a3366-42ef-403a-834e-3a50d5b143e4",
        "symbol": "GRFS",
        "name": "Grifols, S.A."
      },
      "dividendTax": {
        "type": "FOREIGN_TAX",
        "rate": 0.19
      }
    }
  }
}

Merger and Acquisition - Removing Shares Transactions

{
    "id": "event_88602b5d-a189-4a0a-b4f7-941ad9a2fb4a",
    "type": "transactions.created",
    "timestamp": "2019-08-02T07:02:31.844056197Z",
    "payload": {
        "accountID": "0dd1b08f-3668-440a-be18-131443d85a47.1551208006668",
        "accountNo": "DWUV000073",
        "userID": "0dd1b08f-3668-440a-be18-131443d85a47",
        "transaction": {
            "accountAmount": 122.33,
            "accountBalance": 3616.2,
            "comment": "Removed 11.64958061 shares of TWTR (part of merger/acquisition of TWTR by FB)",
            "finTranID": "GH.b06c05f5-e1da-4989-9f4d-fbe5d8be4ac1",
            "wlpFinTranTypeID": "b9d3f58c-da1a-47de-af78-fe59401f396b",
            "finTranTypeID": "MERGER_ACQUISITION",
            "feeSec": 0,
            "feeTaf": 0,
            "feeBase": 0,
            "feeXtraShares": 0,
            "feeExchange": 0,
            "positionDelta": -11.64958061,
            "instrument": {
                "id": "bf4fc752-a5f4-4801-a416-0d75087c9779",
                "symbol": "TWTR",
                "name": "Twitter, Inc."
            },
            "mergerAcquisition": {
                "type": "REMOVE_SHARES_ADD_CASH",
                "acquirer": {
                    "id": "4312a85c-b50d-4adb-93ba-cc7973243a53",
                    "symbol": "FB",
                    "name": "Facebook, Inc."
                },
                "acquiree": {
                    "id": "bf4fc752-a5f4-4801-a416-0d75087c9779",
                    "symbol": "TWTR",
                    "name": "Twitter, Inc."
                }
            }
        }
    }
}

{
    "id": "event_88602b5d-a189-4a0a-b4f7-941ad9a2fb4a",
    "type": "transactions.created",
    "timestamp": "2019-08-02T07:02:31.844056197Z",
    "payload": {
        "accountID": "0dd1b08f-3668-440a-be18-131443d85a47.1551208006668",
        "accountNo": "DWUV000073",
        "userID": "0dd1b08f-3668-440a-be18-131443d85a47",
        "transaction": {
            "accountAmount": 0,
            "accountBalance": 3616.2,
            "comment": "Removed 11.64958061 shares of TWTR (part of merger/acquisition of TWTR by FB)",
            "finTranID": "GH.b06c05f5-e1da-4989-9f4d-fbe5d8be4ac1",
            "wlpFinTranTypeID": "b9d3f58c-da1a-47de-af78-fe59401f396b",
            "finTranTypeID": "MERGER_ACQUISITION",
            "feeSec": 0,
            "feeTaf": 0,
            "feeBase": 0,
            "feeXtraShares": 0,
            "feeExchange": 0,
            "positionDelta": -11.64958061,
            "instrument": {
                "id": "bf4fc752-a5f4-4801-a416-0d75087c9779",
                "symbol": "TWTR",
                "name": "Twitter, Inc."
            },
            "mergerAcquisition": {
                "type": "REMOVE_SHARES",
                "acquirer": {
                    "id": "4312a85c-b50d-4adb-93ba-cc7973243a53",
                    "symbol": "FB",
                    "name": "Facebook, Inc."
                },
                "acquiree": {
                    "id": "bf4fc752-a5f4-4801-a416-0d75087c9779",
                    "symbol": "TWTR",
                    "name": "Twitter, Inc."
                }
            }
        }
    }
}

{
    "id": "event_88602b5d-a189-4a0a-b4f7-941ad9a2fb4a",
    "type": "transactions.created",
    "timestamp": "2019-08-02T07:02:31.844056197Z",
    "payload": {
        "accountID": "0dd1b08f-3668-440a-be18-131443d85a47.1551208006668",
        "accountNo": "DWUV000073",
        "userID": "0dd1b08f-3668-440a-be18-131443d85a47",
        "transaction": {
            "accountAmount": -122.33,
            "accountBalance": 3616.2,
            "comment": "Removed 11.64958061 shares of TWTR (part of merger/acquisition of TWTR by FB)",
            "finTranID": "GH.b06c05f5-e1da-4989-9f4d-fbe5d8be4ac1",
            "wlpFinTranTypeID": "b9d3f58c-da1a-47de-af78-fe59401f396b",
            "finTranTypeID": "MERGER_ACQUISITION",
            "feeSec": 0,
            "feeTaf": 0,
            "feeBase": 0,
            "feeXtraShares": 0,
            "feeExchange": 0,
            "positionDelta": -11.64958061,
            "instrument": {
                "id": "bf4fc752-a5f4-4801-a416-0d75087c9779",
                "symbol": "TWTR",
                "name": "Twitter, Inc."
            },
            "mergerAcquisition": {
                "type": "REMOVE_SHARES_CASH",
                "acquirer": {
                    "id": "4312a85c-b50d-4adb-93ba-cc7973243a53",
                    "symbol": "FB",
                    "name": "Facebook, Inc."
                },
                "acquiree": {
                    "id": "bf4fc752-a5f4-4801-a416-0d75087c9779",
                    "symbol": "TWTR",
                    "name": "Twitter, Inc."
                }
            }
        }
    }
}

{
    "id": "event_21b70415-e1bf-4df6-9e2b-a420647c93fd",
    "type": "transactions.created",
    "timestamp": "2019-08-02T07:02:31.963891677Z",
    "payload": {
        "accountID": "0dd1b08f-3668-440a-be18-131443d85a47.1551208006668",
        "accountNo": "DWUV000073",
        "userID": "0dd1b08f-3668-440a-be18-131443d85a47",
        "transaction": {
            "accountAmount": 872.60,
            "accountBalance": 4488.8,
            "comment": "Exchanged 2.07761987 shares of TSLA for cash (merger/acquisition)",
            "finTranID": "GH.356c7d5e-8671-42ed-8387-762960dc032e",
            "wlpFinTranTypeID": "b9d3f58c-da1a-47de-af78-fe59401f396b",
            "finTranTypeID": "MERGER_ACQUISITION",
            "feeSec": 0,
            "feeTaf": 0,
            "feeBase": 0,
            "feeXtraShares": 0,
            "feeExchange": 0,
            "positionDelta": -2.07761987,
            "instrument": {
                "id": "5b85fabb-d57c-44e6-a7f6-a3efc760226c",
                "symbol": "TSLA",
                "name": "Tesla Motors, Inc."
            },
            "mergerAcquisition": {
                "type": "EXCHANGE_STOCK_CASH",
                "acquirer": {
                    "id": "5b85fabb-d57c-44e6-a7f6-a3efc760226c",
                    "symbol": "TSLA",
                    "name": "Tesla Motors, Inc."
                },
                "acquiree": {
                    "id": "5b85fabb-d57c-44e6-a7f6-a3efc760226c",
                    "symbol": "TSLA",
                    "name": "Tesla Motors, Inc."
                }
            }
        }
    }
}

Merger and Acquisition - Adding Shares Transactions

{
    "id": "event_ff31400a-565a-4c35-9782-279313f18521",
    "type": "transactions.created",
    "timestamp": "2019-08-02T07:02:31.858026996Z",
    "payload": {
        "accountID": "0dd1b08f-3668-440a-be18-131443d85a47.1551208006668",
        "accountNo": "DWUV000073",
        "userID": "0dd1b08f-3668-440a-be18-131443d85a47",
        "transaction": {
            "accountAmount": 0,
            "accountBalance": 3616.2,
            "comment": "Added 5.51 shares of FB (part of merger/acquisition of TWTR by FB)",
            "finTranID": "GH.081b1011-7923-49fe-9144-aa1b555f0873",
            "wlpFinTranTypeID": "b9d3f58c-da1a-47de-af78-fe59401f396b",
            "finTranTypeID": "MERGER_ACQUISITION",
            "feeSec": 0,
            "feeTaf": 0,
            "feeBase": 0,
            "feeXtraShares": 0,
            "feeExchange": 0,
            "positionDelta": 5.51,
            "instrument": {
                "id": "4312a85c-b50d-4adb-93ba-cc7973243a53",
                "symbol": "FB",
                "name": "Facebook, Inc."
            },
            "mergerAcquisition": {
                "type": "ADD_SHARES",
                "acquirer": {
                    "id": "4312a85c-b50d-4adb-93ba-cc7973243a53",
                    "symbol": "FB",
                    "name": "Facebook, Inc."
                },
                "acquiree": {
                    "id": "bf4fc752-a5f4-4801-a416-0d75087c9779",
                    "symbol": "TWTR",
                    "name": "Twitter, Inc."
                }
            }
        }
    }
}

{
    "id": "event_ff31400a-565a-4c35-9782-279313f18521",
    "type": "transactions.created",
    "timestamp": "2019-08-02T07:02:31.858026996Z",
    "payload": {
        "accountID": "0dd1b08f-3668-440a-be18-131443d85a47.1551208006668",
        "accountNo": "DWUV000073",
        "userID": "0dd1b08f-3668-440a-be18-131443d85a47",
        "transaction": {
            "accountAmount": -100,
            "accountBalance": 3516.2,
            "comment": "Added 5.51 shares of FB (part of merger/acquisition of TWTR by FB)",
            "finTranID": "GH.081b1011-7923-49fe-9144-aa1b555f0873",
            "wlpFinTranTypeID": "b9d3f58c-da1a-47de-af78-fe59401f396b",
            "finTranTypeID": "MERGER_ACQUISITION",
            "feeSec": 0,
            "feeTaf": 0,
            "feeBase": 0,
            "feeXtraShares": 0,
            "feeExchange": 0,
            "positionDelta": 5.51,
            "instrument": {
                "id": "4312a85c-b50d-4adb-93ba-cc7973243a53",
                "symbol": "FB",
                "name": "Facebook, Inc."
            },
            "mergerAcquisition": {
                "type": "ADD_SHARES_REMOVE_CASH",
                "acquirer": {
                    "id": "4312a85c-b50d-4adb-93ba-cc7973243a53",
                    "symbol": "FB",
                    "name": "Facebook, Inc."
                },
                "acquiree": {
                    "id": "bf4fc752-a5f4-4801-a416-0d75087c9779",
                    "symbol": "TWTR",
                    "name": "Twitter, Inc."
                }
            }
        }
    }
}

{
    "id": "event_ff31400a-565a-4c35-9782-279313f18521",
    "type": "transactions.created",
    "timestamp": "2019-08-02T07:02:31.858026996Z",
    "payload": {
        "accountID": "0dd1b08f-3668-440a-be18-131443d85a47.1551208006668",
        "accountNo": "DWUV000073",
        "userID": "0dd1b08f-3668-440a-be18-131443d85a47",
        "transaction": {
            "accountAmount": 100,
            "accountBalance": 3716.2,
            "comment": "Added 5.51 shares of FB (part of merger/acquisition of TWTR by FB)",
            "finTranID": "GH.081b1011-7923-49fe-9144-aa1b555f0873",
            "wlpFinTranTypeID": "b9d3f58c-da1a-47de-af78-fe59401f396b",
            "finTranTypeID": "MERGER_ACQUISITION",
            "feeSec": 0,
            "feeTaf": 0,
            "feeBase": 0,
            "feeXtraShares": 0,
            "feeExchange": 0,
            "positionDelta": 5.51,
            "instrument": {
                "id": "4312a85c-b50d-4adb-93ba-cc7973243a53",
                "symbol": "FB",
                "name": "Facebook, Inc."
            },
            "mergerAcquisition": {
                "type": "ADD_SHARES_CASH",
                "acquirer": {
                    "id": "4312a85c-b50d-4adb-93ba-cc7973243a53",
                    "symbol": "FB",
                    "name": "Facebook, Inc."
                },
                "acquiree": {
                    "id": "bf4fc752-a5f4-4801-a416-0d75087c9779",
                    "symbol": "TWTR",
                    "name": "Twitter, Inc."
                }
            }
        }
    }
}

ACATS - Incoming Transactions

{
  "id": "event_21b70415-e1bf-4df6-9e2b-a420647c93fd",
  "type": "transactions.created",
  "timestamp": "2019-09-27T11:54:48.129878323Z",
  "payload": {
    "accountID": "b2124bd2-467d-4a5e-8864-7b8b9f5809aa.1552418271646",
    "accountNo": "DWBG000076",
    "userID": "b2124bd2-467d-4a5e-8864-7b8b9f5809aa",
    "transaction": {
      "accountAmount": 0,
      "accountBalance": 0,
      "comment": "ACATS Stock Receive: 80 Shares of NVDA @ 157.00",
      "finTranID": "GH.e2eaf272-8ccf-4005-8b88-c670999ca4f9",
      "wlpFinTranTypeID": "b9d3f58c-da1a-47de-af78-fe59401f396b",
      "finTranTypeID": "ACATS_STOCK",
      "feeSec": 0,
      "feeTaf": 0,
      "feeBase": 0,
      "feeXtraShares": 0,
      "feeExchange": 0,
      "positionDelta": 80,
      "instrument": {
        "id": "5b85fabb-d57c-44e6-a7f6-a3efc760226c",
        "symbol": "NVDA",
        "name": "Nvidia"
      },
      "acats": {
        "type": "INCOMING",
        "brokerDTCNo": "524",
        "referenceNo": "ACAT21182",
        "controlNo": "20192560028977"
      }
    }
  }
}

{
  "id": "event_21b70415-e1bf-4df6-9e2b-a420647c93fd",
  "type": "transactions.created",
  "timestamp": "2019-09-27T11:54:48.289123980Z",
  "payload": {
    "accountID": "b2124bd2-467d-4a5e-8864-7b8b9f5809aa.1552418271646",
    "accountNo": "DWBG000076",
    "userID": "b2124bd2-467d-4a5e-8864-7b8b9f5809aa",
    "transaction": {
      "accountAmount": 1508.6,
      "accountBalance": 1508.6,
      "comment": "ACATS Cash Receive",
      "finTranID": "GH.356c7d5e-8671-42ed-8387-762960dc032e",
      "wlpFinTranTypeID": "9aaf6be0-3412-4fdd-9765-db3f9de2e1f8",
      "finTranTypeID": "ACATS_CASH",
      "feeSec": 0,
      "feeTaf": 0,
      "feeBase": 0,
      "feeXtraShares": 0,
      "feeExchange": 0,
      "acats": {
        "type": "INCOMING",
        "referenceNo": "ACAT21182",
        "controlNo": "20192560028977"
      }
    }
  }
}

ACATS - Outgoing Transactions

{
  "id": "event_21b70415-e1bf-4df6-9e2b-a420647c93fd",
  "type": "transactions.created",
  "timestamp": "2019-09-27T11:54:48.129878323Z",
  "payload": {
    "accountID": "b2124bd2-467d-4a5e-8864-7b8b9f5809aa.1552418271646",
    "accountNo": "DWBG000076",
    "userID": "b2124bd2-467d-4a5e-8864-7b8b9f5809aa",
    "transaction": {
      "accountAmount": 0,
      "accountBalance": 1508.6,
      "comment": "ACATS Stock Deliver: 80 Shares of NVDA",
      "finTranID": "GH.e2eaf272-8ccf-4005-8b88-c670999ca4f9",
      "wlpFinTranTypeID": "b9d3f58c-da1a-47de-af78-fe59401f396b",
      "finTranTypeID": "ACATS_STOCK",
      "feeSec": 0,
      "feeTaf": 0,
      "feeBase": 0,
      "feeXtraShares": 0,
      "feeExchange": 0,
      "positionDelta": -80,
      "instrument": {
        "id": "5b85fabb-d57c-44e6-a7f6-a3efc760226c",
        "symbol": "NVDA",
        "name": "Nvidia"
      },
      "acats": {
        "type": "OUTGOING",
        "brokerDTCNo": "524",
        "referenceNo": "ACAT21182",
        "controlNo": "20192560028977"
      }
    }
  }
}

{
  "id": "event_21b70415-e1bf-4df6-9e2b-a420647c93fd",
  "type": "transactions.created",
  "timestamp": "2019-09-27T11:54:48.289123980Z",
  "payload": {
    "accountID": "b2124bd2-467d-4a5e-8864-7b8b9f5809aa.1552418271646",
    "accountNo": "DWBG000076",
    "userID": "b2124bd2-467d-4a5e-8864-7b8b9f5809aa",
    "transaction": {
      "accountAmount": -1508.6,
      "accountBalance": 0,
      "comment": "ACATS Cash Deliver",
      "finTranID": "GH.356c7d5e-8671-42ed-8387-762960dc032e",
      "wlpFinTranTypeID": "9aaf6be0-3412-4fdd-9765-db3f9de2e1f8",
      "finTranTypeID": "ACATS_CASH",
      "feeSec": 0,
      "feeTaf": 0,
      "feeBase": 0,
      "feeXtraShares": 0,
      "feeExchange": 0,
      "acats": {
        "type": "OUTGOING",
        "referenceNo": "ACAT21182",
        "controlNo": "20192560028977"
      }
    }
  }
}

Results Explained

Attribute

Type

Description

id

string

event identifier

type

string

the type of event

timestamp

string

time when the event was created

payload

object

contains the event details

payload.accountID

string

account identifier

payload.accountNo

string

account number

payload.userID

string

user identifier

payload.transaction

object

contains the details of the transaction

payload.transaction.accountAmount

number

total dollar amount of the transaction

payload.transaction.accountBalance

number

remaining account balance after the transaction

payload.transaction.comment

string

comment field

payload.transaction.finTranID

string

financial transaction identifier

payload.transaction.finTranTypeID

string

type of financial transaction, transaction types explained here

payload.transaction.instrument.id

string

instrument identifier

payload.transactions.instrument.symbol

string

ticker symbol

payload.transactions.instrument.name

string

symbol name

payload.dividend

object

object containing details of a dividend transaction

payload.dividend.type

string

type of dividend events:
CASH
STOCK
RETURN_OF_CAPITAL
DISTRIBUTION_LONG
DISTRIBUTION_SHORT
OTHER

payload.dividend.amountPerShare

number

the amount per share the dividend is paying

payload.dividend.taxCode

string

the tax code associated with the dividend:
FULLY_TAXABLE
NON_TAXABLE
TAX_EXEMPT
null

payload.transaction.wlpFinTranTypeID

string

Custom transaction type

payload.transaction.feeSec

number

SEC fee charged to customer

payload.transaction.feeTaf

number

trading activity fee charged to customer

payload.transaction.feeBase

number

starting fee net of additional fee's

payload.transaction.positionDelta

number

the change in the number of shares due to an M&A event

payload.transaction.feeXtraShares

number

fee charged for shares purchased above minimum commission charge

payload.transaction.feeExchange

number

exchange fee

payload.mergerAcquisition

object

object containing the details of an M&A event

payload.mergerAcquisition.type

string

The type of M&A Event:

  • REMOVE_SHARES_ADD_CASH - Shares have been removed from the account, cash is later added as a transactions.created event
  • ADD_SHARES - Shares have been added to the account
  • EXCHANGE_STOCK_CASH - Shares have been removed from the account and cash has been added

payload.mergerAcquisition.aquirer

object

object containing the details of the acquiring company

payload.mergerAcquisition.acquirer.id

string

instrument identifier

payload.mergerAcquisition.acquirer.symbol

string

ticker symbol

payload.mergerAcquisition.acquirer.name

string

name of the company

payload.mergerAcquisition.acquiree

object

object containing the details of the company being acquired

payload.mergerAcquisition.acquiree.id

string

instrument identifier

payload.mergerAcquisition.acquiree.symbol

string

ticker symbol

payload.mergerAcquisition.acquiree.name

string

name of the company

payload.acats

object

object containing the details of an ACAT

payload.acats.type

string

identifies the type of ACAT:

  • INCOMING - incoming ACAT
  • OUTGOING - outgoing ACAT

payload.acats.brokerDTCNo

string

The DTC number of the third party broker

payload.acats.referenceNo

string

Reference number of a specific ACAT

payload.acats.controlNo

string

ACAT Control Number