BankAccount

An individual bank account

  • accountNumber
    Type: string
    required

    6 to 10 digit, numeric bank account number

  • action
    enum
    const:  
    Link
    required

    Are we creating a new bank account or linking an existing one? At this point, only Link is supported

    values
    • Link
  • bankAccountType
    Type: string enum
    required

    Differentiates a linked cash management account from other settlement bank account types. If 'LinkedCmtCma' is selected, 'provider' cannot be null.

    values
    • LinkedCmtCma
    • BankAccount
  • bsb
    Type: string
    required

    6 Digit BSB number

  • name
    Type: string
    max length:  
    128
    required

    Bank Account Name

  • purposes
    Type: array string[] 1…enum
    required

    How will this Account be used? If this is an income direction account as well as a settlement account, include both EquitySettlement and EquityDividends in the array.

    values
    • EquitySettlement
    • EquityDividends
  • externalId
    Type: string | null

    An optional reference ID for this particular bank account used by the client

  • provider
    Type: string enum

    The Institution providing the bank account. Required when bank has a purpose of 'EquitySettlement' and a bankAccountType of 'LinkedCmtCma'. Nullable for bankAccountType 'BankAccount'. MBLA refers to Macquarie Bank. DDH refers to DDH Graham.

    values
    • MBLA
    • DDH
  • secondaryAccountId
    Type: string | null

    Provide the secondary bank account ID if you have been instructed to by Openmarkets. This helps link accounts such as the Macquarie CMA