API Release 1.17

API Release 1.17

Order Cancellation Details

A new field statusMessage.reason has been added to the order status and orders.completed event APIs to indicate an order had been cancelled due to a corporate action. Following is an example of the new property that can be found within the response body:

"statusMessage": {
        "errorCode": "O124",
        "message": "Corporate action cancellation. Stock Spinoff, Dividends",
        "reason": ["STOCK_SPINOFF", "DIVIDEND_CASH"]
    },

Additional Timestamp for Pending Orders

For Stop and Market-if-Touched orders a new field of triggeredWhen has been added to the following endpoints and reports:

• Ticket Audit Report
• Order Status Endpoint
• Account Summary - Orders
• Order Transactions Report
• Orders.updated/completed Events

The new field provides a timestamp of when the specific pending order had been triggered and converted to a market order.

Obsolete Auth Endpoint Fields Non-Mandatory

Authentication can now be made to the DriveWealth API's without being required to send in unused and obsolete fields. Following is an example request body that would result in a successful auth response:

{
    "username": "{{bo-username}}",
    "password": "{{bo-password}}",
    "appTypeID": 4
}

Maximum Buying Power for Instant ACH Deposits

In addition to existing deposit limits that are placed on Instant ACH deposits, Partners can now have a pre-defined maximum daily amount for increase in buying power. For example, if a $100,000 deposit is made, the maximum that will be made available in cashAvailableForTrade before the deposit is settled can be set to $10,000.

This also means that if in one day 3 deposits of $30,000 each are made and the maximum limit is set to $40,000, only $40,000 will be made available immediately and the remaining $50,000 made available after the deposit has settled. Where settled is indicative of DriveWealth receiving the deposit at our Partner Bank.

From a UI perspective, Partners are advised to include the payments.buyingPower.pendingDepositAmountsNotAvailable within the Account Summary (Money) endpoint in order to give customers transparency into why their buying did not increase by the total deposit amount.