Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    ClientKey ClientKey Body Client identifier
    StandingInstructions Instruction [] Body Standing Instructions
  • Response Parameters

    View Response Codes
    Name Type Description
    AccountId String The attain key of the account that this standing instruction applies to.
    AssetType AssetType Asset Type
    CreatedDate Date Creation Date for Standing Instruction
    ErrorCode SIErrorCode Error Code
    ErrorMessage String Error Message
    OptionType OptionType The type of option to automatically elect. Must be either SECU or CASH.
    StandingInstructionId String Standing instruction Id
    Uic Int The instrument that this standing instruction applies to.
  • Request Example

    Request URL
    POST ca/v2/standinginstructions
    Request Body
    {
      "ClientKey": "7m4I|vtYLUnEGg77o9uQhw==",
      "StandingInstructions": [
        {
          "AccountKey": "dIm75edbgnW6aBK3CIc-sw==",
          "AssetType": "Stock",
          "OptionType": "SECU",
          "Uic": 101
        }
      ]
    }
    
  • Response Example

    Response body
    {
      "__count": 2,
      "Data": [
        {
          "AccountId": "12642445",
          "AssetType": "Stock",
          "CreatedDate": "0001-01-01",
          "OptionType": "SECU",
          "StandingInstructionId": "31272",
          "Uic": 101
        },
        {
          "AccountId": "12642445",
          "AssetType": "Stock",
          "CreatedDate": "0001-01-01",
          "ErrorCode": "InvalidInstrumentDetail",
          "OptionType": "CASH",
          "StandingInstructionId": "21272",
          "Uic": 2103
        }
      ]
    }