openapi: 3.2.0
info:
  title: index.html
  version: 1.0.0
servers:
  - url: https://api.notbank.exchange
    description: production server
    x-gitbook-description-html: <p>production server</p>
security:
  - defaultApiKey: []
paths:
  /AP/GetAccountTransactions:
    post:
      tags:
        - Account
      operationId: GetAccountTransactions
      description: >-
        **Permissions:** NotbankTrading, NotbankReadOnly<br />

        **Call Type:** Synchronous

        Gets a list of transactions for an account.


        Results can be filtered using different search parameters such as
        **TransactionType** and **ProductId**.


        <aside class="notice"><strong>Note:</strong> In this API method, “Depth”
        refers not to the depth of the order book, but to the count of trades to
        report.</aside>.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountTransactionsResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAccountTransactionsRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading, NotbankReadOnly
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous Gets a list of transactions for an account.'
                    marks: []
                key: DeWPTinQmAuA
            key: xrPZOAMLULBk
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Results can be filtered using different search parameters
                      such as 
                    marks: []
                  - object: leaf
                    text: TransactionType
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' and '
                    marks: []
                  - object: leaf
                    text: ProductId
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: .
                    marks: []
                key: d8yqeSsZ7ky1
            key: kR4GTs7x5qAQ
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Note:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' In this API method, “Depth” refers not to the depth of the order book, but to the count of trades to report..'
                    marks: []
                key: fvIxroN0beEq
            key: oB5OmXKtOoqI
        key: JZrbdd642Z9I
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading,
        NotbankReadOnly<br><strong>Call Type:</strong> Synchronous Gets a list
        of transactions for an account.</p><p>Results can be filtered using
        different search parameters such as <strong>TransactionType</strong> and
        <strong>ProductId</strong>.</p><p><strong>Note:</strong> In this API
        method, “Depth” refers not to the depth of the order book, but to the
        count of trades to report..</p>
  /AP/GetAccountPositions:
    post:
      tags:
        - Account
      operationId: GetAccountPositions
      description: |-
        **Permissions:** NotbankTrading, NotbankReadOnly<br />
        **Call Type:** Synchronous

        Gets a list of Positions (Balances) on a specific account.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountPositionsResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAccountPositionsRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading, NotbankReadOnly
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: ZQBh2KFtZbD3
            key: HarE4NobJ3lH
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Gets a list of Positions (Balances) on a specific account.
                    marks: []
                key: nowW2LXwvHWd
            key: m52UBXpLTrVl
        key: 94JwOCXLVllt
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading,
        NotbankReadOnly<br><strong>Call Type:</strong> Synchronous</p><p>Gets a
        list of Positions (Balances) on a specific account.</p>
  /AP/GetAccountInstrumentStatistics:
    post:
      tags:
        - Account
      operationId: GetAccountInstrumentStatistics
      description: |-
        **Permissions:** NotbankTrading, NotbankReadOnly<br />
        **Call Type:** Synchronous

        Gets a list of Instrument Statistics of a specific account.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountInstrumentStatisticsResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAccountInstrumentStatisticsRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading, NotbankReadOnly
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: eYkjZrvqseis
            key: 6JdJR6YSOmf7
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets a list of Instrument Statistics of a specific
                      account.
                    marks: []
                key: Hrx5biB9enVU
            key: 2gD4T36inrlF
        key: Op1N0Egr6MO5
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading,
        NotbankReadOnly<br><strong>Call Type:</strong> Synchronous</p><p>Gets a
        list of Instrument Statistics of a specific account.</p>
  /AP/GetAccountInfo:
    post:
      tags:
        - Account
      operationId: GetAccountInfo
      description: >-
        **Permissions:** NotbankTrading, NotbankReadOnly<br />

        **Call Type:** Synchronous


        Returns detailed information about one specific account existing on a
        specific OMS. 


        If the parameter AccountId is not defined, the details of the default
        account of the authenticated user will be retrieved.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountInfoResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAccountInfoRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading, NotbankReadOnly
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: sNwNzR1OBIF1
            key: gXJ2bq86SSYV
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Returns detailed information about one specific account
                      existing on a specific OMS.
                    marks: []
                key: fAr5BZgx2ZO9
            key: dp2KDP0WG7YJ
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      If the parameter AccountId is not defined, the details of
                      the default account of the authenticated user will be
                      retrieved.
                    marks: []
                key: wbmP65gBJY4T
            key: p8kIe0w7HLZ5
        key: 9waMtSE88ZLd
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading,
        NotbankReadOnly<br><strong>Call Type:</strong> Synchronous</p><p>Returns
        detailed information about one specific account existing on a specific
        OMS.</p><p>If the parameter AccountId is not defined, the details of the
        default account of the authenticated user will be retrieved.</p>
  /AP/AuthenticateUser:
    get:
      tags:
        - Authentication
      operationId: AuthenticateUser
      description: |-
        **Permissions:** Public<br />
        **CallType:** Synchronous

        Gets user authentication data.

        To receive the session token (aptoken) used for authentication in the authenticated methods, the following headers must be passed. 
        - APIKey. This is a Notbank-generated key used in user-identification.
        - Signature. A long, alphanumeric string generated by Notbank by using the APIKey and Nonce. To generate your own signature with a different nonce, you can use  HMAC-Sha256 to encode your nonce, user ID, and API key, in the format NonceUserIdAPIKey using the secret as your key.
        - UserId. The ID of the user, stated as a string.
        - Nonce. Any arbitrary number or random string used with the APIKey to generate a signature.
      parameters:
        - in: header
          name: APIKey
          schema:
            type: string
        - in: header
          name: Signature
          schema:
            type: string
        - in: header
          name: UserId
          schema:
            type: string
        - in: header
          name: Nonce
          schema:
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthenticateUserResponse'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       Public
                    marks: []
                  - object: leaf
                    text: 'CallType:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: qL9g3KQeiw6A
            key: MgpZHovESBIb
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Authenticates a user.
                    marks: []
                key: lGM0lSCaMqv4
            key: YHubV5uYqAeR
        key: YCwHK5AeCC5I
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> Public<br><strong>CallType:</strong>
        Synchronous</p><p>Authenticates a user.</p>
  /AP/Logout:
    post:
      tags:
        - Authentication
      operationId: LogOut
      description: |-
        **Permissions:** Public<br />
        **Call Type:** Synchronous

        Logs a user out.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LogOutResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LogOutRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       Public
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: 4tfLmn7GoQpX
            key: PFX1KxYU0Rpp
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Logs a user out.
                    marks: []
                key: UWxhSNFv5pMx
            key: 2mYTW4QrLuPL
        key: kLpTmAJ6M48F
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> Public<br><strong>Call Type:</strong>
        Synchronous</p><p>Logs a user out.</p>
  /AP/GetWithdrawFee:
    post:
      tags:
        - Fee
      operationId: GetWithdrawFee
      description: |-
        **Permissions:** NotbankTrading, NotbankWithdraw<br />
        **Call Type:** Synchronous

        Get a fee estimate for a withdrawal.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWithdrawFeeResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetWithdrawFeeRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading, NotbankWithdraw
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: 4ARE5l8JaSr4
            key: i7cXsqkNx6wh
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Get a fee estimate for a withdrawal.
                    marks: []
                key: w4Ow4m55Qvai
            key: RmjwICgr7PVV
        key: 9oB52QasRitd
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading,
        NotbankWithdraw<br><strong>Call Type:</strong> Synchronous</p><p>Get a
        fee estimate for a withdrawal.</p>
  /AP/GetDepositFee:
    post:
      tags:
        - Fee
      operationId: GetDepositFee
      description: |-
        **Permissions:** NotbankTrading, NotbankDeposit<br />
        **Call Type:** Synchronous

        Get a fee estimate for a deposit.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDepositFeeResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetDepositFeeRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading, NotbankDeposit
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: Wsad1T1p1UQa
            key: Au9aFHycBhNA
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Get a fee estimate for a deposit.
                    marks: []
                key: 637ubgzx9C3e
            key: dWZEuBu3OwXT
        key: UrBTdebIucPc
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading,
        NotbankDeposit<br><strong>Call Type:</strong> Synchronous</p><p>Get a
        fee estimate for a deposit.</p>
  /AP/GetOMSWithdrawFees:
    post:
      tags:
        - Fee
      operationId: GetOMSWithdrawFees
      description: >-
        **Permissions:** NotbankWithdraw<br />

        **Call Type:** Synchronous


        Gets a list of withdraw fees for products in a specific OMS. Can be
        filtered per product and account provider.


        It is possible that a withdraw fee exists specifically for a product and
        an account provider.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOMSWithdrawFeesResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetOMSWithdrawFeesRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankWithdraw
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: m0lgSStiZJt9
            key: DliY4j7ZoNAC
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets a list of withdraw fees for products in a specific
                      OMS. Can be filtered per product and account provider.
                    marks: []
                key: iM6OAtsdrB42
            key: MMw23ofTxGYM
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      It is possible that a withdraw fee exists specifically for
                      a product and an account provider.
                    marks: []
                key: lm2P5MESt0yO
            key: bJm3GSW6zZSG
        key: 879vf289auCF
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankWithdraw<br><strong>Call
        Type:</strong> Synchronous</p><p>Gets a list of withdraw fees for
        products in a specific OMS. Can be filtered per product and account
        provider.</p><p>It is possible that a withdraw fee exists specifically
        for a product and an account provider.</p>
  /AP/GetOMSDepositFees:
    post:
      tags:
        - Fee
      operationId: GetOMSDepositFees
      description: >-
        **Permissions:** NotbankDeposit<br />

        **Call Type:** Synchronous


        Gets a list of deposit fees for products in a specific OMS. Can be
        filtered per product and account provider.


        It is possible to that a deposit fee exists specifically for a product
        and an account provider.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOMSDepositFeesResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetOMSDepositFeesRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankDeposit
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: mXrVL1eYLe5Q
            key: WFTFqUFwt4Wo
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets a list of deposit fees for products in a specific
                      OMS. Can be filtered per product and account provider.
                    marks: []
                key: MHxf46TNiBfj
            key: c4v0dEufqJX1
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      It is possible to that a deposit fee exists specifically
                      for a product and an account provider.
                    marks: []
                key: 1TY53oVop2g4
            key: onMmW4PewVIR
        key: LtQt35hKAZXl
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankDeposit<br><strong>Call
        Type:</strong> Synchronous</p><p>Gets a list of deposit fees for
        products in a specific OMS. Can be filtered per product and account
        provider.</p><p>It is possible to that a deposit fee exists specifically
        for a product and an account provider.</p>
  /AP/GetAccountFees:
    post:
      tags:
        - Fee
      operationId: GetAccountFees
      description: >-
        **Permissions:** NotbankTrading, NotbankReadOnly<br />

        **Call Type:** Synchronous


        Gets a list of trading fees that are set for a specific account. This
        method will respond a list of trading fees that are defined with the
        same fee tier as the fee tier of the account.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountFeesResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAccountFeesRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading, NotbankReadOnly
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: wDwF9ZBY9i9o
            key: 85HmBGFoeenJ
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets a list of trading fees that are set for a specific
                      account. This method will respond a list of trading fees
                      that are defined with the same fee tier as the fee tier of
                      the account.
                    marks: []
                key: 5FE4FiUuCWWf
            key: rhGOz6BT2qdU
        key: XlgpVm2eXpg7
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading,
        NotbankReadOnly<br><strong>Call Type:</strong> Synchronous</p><p>Gets a
        list of trading fees that are set for a specific account. This method
        will respond a list of trading fees that are defined with the same fee
        tier as the fee tier of the account.</p>
  /AP/GetOrderFee:
    post:
      tags:
        - Fee
      operationId: GetOrderFee
      description: >-
        **Permissions:** NotbankTrading<br />

        **Call Type:** Synchronous


        Gets an estimate of the transaction/trading fee for a specific order
        side, instrument, and order type.


        The exchange generally deducts fees from the "receiving" side of the
        trade. There are two products in every trade (and in every instrument);
        for example, the instrument BTCUSD comprises a Bitcoin product and a US
        dollar product. Placing a buy order on the book causes fees to be
        deducted from Product 1, in this case, Bitcoin; placing a sell order
        causes fees to be deducted from Product 2, in this case, US dollar.


        A user with NotbankTrading permission can get fee estimates for any
        account that the user is associated with and for any instrument or
        product that the account can trade.


        If loyalty token is enabled and there is no market for the loyalty
        token, the system automatically uses 3rd party rates for the loyalty
        token market.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrderFeeResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetOrderFeeRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: gz3pulxf2NZ5
            key: H0mIhV6XGV6f
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets an estimate of the transaction/trading fee for a
                      specific order side, instrument, and order type.
                    marks: []
                key: G5YzMyqAWTtm
            key: z4otTOJ54Ds7
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      The exchange generally deducts fees from the "receiving"
                      side of the trade. There are two products in every trade
                      (and in every instrument); for example, the instrument
                      BTCUSD comprises a Bitcoin product and a US dollar
                      product. Placing a buy order on the book causes fees to be
                      deducted from Product 1, in this case, Bitcoin; placing a
                      sell order causes fees to be deducted from Product 2, in
                      this case, US dollar.
                    marks: []
                key: 6GMGgiWhmVMf
            key: JZy6JW2hhic9
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      A user with NotbankTrading permission can get fee
                      estimates for any account that the user is associated with
                      and for any instrument or product that the account can
                      trade.
                    marks: []
                key: eM5TtyBNqhgm
            key: 4270LevPDYRs
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      If loyalty token is enabled and there is no market for the
                      loyalty token, the system automatically uses 3rd party
                      rates for the loyalty token market.
                    marks: []
                key: sVhoKXdfoP4y
            key: 4Ohmp8jySpBx
        key: WCo601RLJtxT
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Gets an estimate of the
        transaction/trading fee for a specific order side, instrument, and order
        type.</p><p>The exchange generally deducts fees from the "receiving"
        side of the trade. There are two products in every trade (and in every
        instrument); for example, the instrument BTCUSD comprises a Bitcoin
        product and a US dollar product. Placing a buy order on the book causes
        fees to be deducted from Product 1, in this case, Bitcoin; placing a
        sell order causes fees to be deducted from Product 2, in this case, US
        dollar.</p><p>A user with NotbankTrading permission can get fee
        estimates for any account that the user is associated with and for any
        instrument or product that the account can trade.</p><p>If loyalty token
        is enabled and there is no market for the loyalty token, the system
        automatically uses 3rd party rates for the loyalty token market.</p>
  /AP/GetInstrument:
    post:
      tags:
        - Instrument (Pair)
      operationId: GetInstrument
      description: >-
        **Permissions:** Public<br />

        **Call Type:** Synchronous


        Gets the details of a specific instrument (pair) from the OMS of the
        trading venue. An instrument is something that can be traded in the
        exchange.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetInstrumentResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetInstrumentRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       Public
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: EkbJ53RxJBFq
            key: 1bJpISnpGBMa
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets the details of a specific instrument (pair) from the
                      OMS of the trading venue. An instrument is something that
                      can be traded in the exchange.
                    marks: []
                key: 7k69YzsxzEZ1
            key: baP8hEmDOE7X
        key: dbyLC7ZbsW0Z
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> Public<br><strong>Call Type:</strong>
        Synchronous</p><p>Gets the details of a specific instrument (pair) from
        the OMS of the trading venue. An instrument is something that can be
        traded in the exchange.</p>
  /AP/GetInstruments:
    post:
      tags:
        - Instrument (Pair)
      operationId: GetInstruments
      description: >-
        **Permissions:** Public<br />

        **Call Type:** Synchronous


        Gets a list of instruments available on the exchange. An instrument is
        something that can be traded in the exchange.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetInstrumentsResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetInstrumentsRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       Public
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: LjMiMy3uxexH
            key: 3ZpRBQPnekoz
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets a list of instruments available on the exchange. An
                      instrument is something that can be traded in the
                      exchange.
                    marks: []
                key: 5YdVLGK7oioS
            key: 2ViciwWADOZA
        key: dAPgmo7FlMzb
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> Public<br><strong>Call Type:</strong>
        Synchronous</p><p>Gets a list of instruments available on the exchange.
        An instrument is something that can be traded in the exchange.</p>
  /AP/GetInstrumentVerificationLevelConfig:
    post:
      tags:
        - Instrument (Pair)
      operationId: GetInstrumentVerificationLevelConfig
      description: >-
        **Permissions:** NotbankTrading, NotbankDeposit, NotbankWithdraw<br />

        **Call Type:** Synchronous


        Gets an Instrument Verification Level Configurations for the requested
        account.


        In NotBank, a verification level determines the limits of an account in
        terms of deposits, withdrawals, transfers and trading. The verification
        level config response of this method only applies to instruments. 


        Each instrument will have separate and possibly unique limits, different
        than other instruments.


        A limit value of -1 means infinite or no limit.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/GetInstrumentVerificationLevelConfigResponse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetInstrumentVerificationLevelConfigRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading, NotbankDeposit, NotbankWithdraw
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: gwxZn36gKazF
            key: 9qesE4TZjSGg
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets an Instrument Verification Level Configurations for
                      the requested account.
                    marks: []
                key: xW0kmrR0OqJC
            key: qtYhmyEFak72
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      In NotBank, a verification level determines the limits of
                      an account in terms of deposits, withdrawals, transfers
                      and trading. The verification level config response of
                      this method only applies to instruments.
                    marks: []
                key: JwIfvPqzFGi5
            key: xd9IvRW5kKEx
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Each instrument will have separate and possibly unique
                      limits, different than other instruments.
                    marks: []
                key: oFOg5Nd3yUGY
            key: cj8bfkFbatke
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: A limit value of -1 means infinite or no limit.
                    marks: []
                key: Nnot5ztNC7Tc
            key: QF8RhDjFU3ir
        key: XOAObdGfZgpS
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading, NotbankDeposit,
        NotbankWithdraw<br><strong>Call Type:</strong> Synchronous</p><p>Gets an
        Instrument Verification Level Configurations for the requested
        account.</p><p>In NotBank, a verification level determines the limits of
        an account in terms of deposits, withdrawals, transfers and trading. The
        verification level config response of this method only applies to
        instruments.</p><p>Each instrument will have separate and possibly
        unique limits, different than other instruments.</p><p>A limit value of
        -1 means infinite or no limit.</p>
  /AP/GetProduct:
    post:
      tags:
        - Product (Currency)
      operationId: GetProduct
      description: >-
        **Permissions:** Public<br />

        **Call Type:** Synchronous


        Gets the details about a specific product (currency) on the exchange. A
        product is an asset that can be deposited and withdrawn but cannot be
        traded.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetProductResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetProductRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       Public
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: 8vzYFMc7vwmI
            key: DF5PRIZGjSby
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets the details about a specific product (currency) on
                      the exchange. A product is an asset that can be deposited
                      and withdrawn but cannot be traded.
                    marks: []
                key: herLxSOCScT4
            key: DQIV6w4DU1ZF
        key: BQu0rr6keyFr
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> Public<br><strong>Call Type:</strong>
        Synchronous</p><p>Gets the details about a specific product (currency)
        on the exchange. A product is an asset that can be deposited and
        withdrawn but cannot be traded.</p>
  /AP/GetProducts:
    post:
      tags:
        - Product (Currency)
      operationId: GetProducts
      description: >-
        **Permissions:** Public<br />

        **Call Type:** Synchronous


        Gets a list of products available on the exchange. A product is an asset
        that can be deposited and withdrawn but cannot be traded.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetProductsResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetProductsRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       Public
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: y6Cu2LolgkHz
            key: gk5950S1ldgy
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets a list of products available on the exchange. A
                      product is an asset that can be deposited and withdrawn
                      but cannot be traded.
                    marks: []
                key: ofXWiJ9CA8NR
            key: WwEgYT3ib65P
        key: rUkFVBo8U6Oz
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> Public<br><strong>Call Type:</strong>
        Synchronous</p><p>Gets a list of products available on the exchange. A
        product is an asset that can be deposited and withdrawn but cannot be
        traded.</p>
  /AP/GetVerificationLevelConfig:
    post:
      tags:
        - Product (Currency)
      operationId: GetVerificationLevelConfig
      description: >-
        **Permissions:** NotbankTrading, NotbankDeposit, NotbankWithdraw<br />

        **Call Type:** Synchronous


        Gets the verification level configuration of the requested account.


        In NotBank, a verification level determines the limits of an account in
        terms of deposits, withdrawals, transfers and trading. This verification
        level config response of this method only applies to deposits,
        withdrawals and transfers and is only about a product or asset. 


        Each product or asset will have separate and possibly unique limits,
        different than other products.


        A limit value of -1 means infinite or no limit.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVerificationLevelConfigResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetVerificationLevelConfigRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading, NotbankDeposit, NotbankWithdraw
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: t1UExUbbd9p0
            key: TwyGTZdxc19n
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets the verification level configuration of the requested
                      account.
                    marks: []
                key: euypEaYWi4e1
            key: nQB4vesgbnLB
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      In NotBank, a verification level determines the limits of
                      an account in terms of deposits, withdrawals, transfers
                      and trading. This verification level config response of
                      this method only applies to deposits, withdrawals and
                      transfers and is only about a product or asset.
                    marks: []
                key: tMnUGJy29257
            key: GpaSWK3cBcNr
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Each product or asset will have separate and possibly
                      unique limits, different than other products.
                    marks: []
                key: 7yB5T2Tx99yy
            key: 3w4YXC0BCLzW
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: A limit value of -1 means infinite or no limit.
                    marks: []
                key: jG7sAsccurkH
            key: cBeDHBepqOd2
        key: e6e9FAV7tbRq
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading, NotbankDeposit,
        NotbankWithdraw<br><strong>Call Type:</strong> Synchronous</p><p>Gets
        the verification level configuration of the requested account.</p><p>In
        NotBank, a verification level determines the limits of an account in
        terms of deposits, withdrawals, transfers and trading. This verification
        level config response of this method only applies to deposits,
        withdrawals and transfers and is only about a product or
        asset.</p><p>Each product or asset will have separate and possibly
        unique limits, different than other products.</p><p>A limit value of -1
        means infinite or no limit.</p>
  /AP/GenerateTradeActivityReport:
    post:
      tags:
        - Report
      operationId: GenerateTradeActivityReport
      description: >-
        **Permissions:** NotbankTrading<br />

        **Call Type:** Synchronous


        Creates an immediate report on historical trade activity on a specific
        OMS for a list of accounts, during a specified time interval.


        A user with NotbankTrading permission can only generate trade reports
        for accounts with which he/she is associated to.


        The actual Trade Activity Report will be generated as a comma-separated
        (CSV) file. It can be downloaded using the API method
        [**DownloadDocument**](#operation/DownloadDocument).
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateTradeActivityReportResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateTradeActivityReportRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: VSwwyFpEtHeg
            key: 4IswklsHwCH1
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Creates an immediate report on historical trade activity
                      on a specific OMS for a list of accounts, during a
                      specified time interval.
                    marks: []
                key: kX9n4pByspZA
            key: TJTZYBCAapDB
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      A user with NotbankTrading permission can only generate
                      trade reports for accounts with which he/she is associated
                      to.
                    marks: []
                key: ojrSslDWfFjr
            key: H8qnc8bjnHGR
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      The actual Trade Activity Report will be generated as a
                      comma-separated (CSV) file. It can be downloaded using the
                      API method 
                    marks: []
                  - object: leaf
                    text: DownloadDocument
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: .
                    marks: []
                key: 49GS3R83fhs9
            key: RCSOzrD46RGb
        key: hKyRSaEhDKWS
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Creates an immediate report on
        historical trade activity on a specific OMS for a list of accounts,
        during a specified time interval.</p><p>A user with NotbankTrading
        permission can only generate trade reports for accounts with which
        he/she is associated to.</p><p>The actual Trade Activity Report will be
        generated as a comma-separated (CSV) file. It can be downloaded using
        the API method <strong>DownloadDocument</strong>.</p>
  /AP/GenerateTransactionActivityReport:
    post:
      tags:
        - Report
      operationId: GenerateTransactionActivityReport
      description: >-
        **Permissions:** NotbankTrading<br />

        **Call Type:** Synchronous


        Creates an immediate report on historical transaction activity on a
        specific OMS for a list of accounts during a specified time interval.


        A user with NotbankTrading permission can only generate transaction
        reports for accounts with which he/she is associated to.


        The actual Transaction Activity Report will be generated as a
        comma-separated (CSV) file. It can be downloaded using the API method
        [**DownloadDocument**](#operation/DownloadDocument).
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GenerateTransactionActivityReportResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateTransactionActivityReportRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: 3TuhYPuPe9zF
            key: JpOL6nozaZEK
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Creates an immediate report on historical transaction
                      activity on a specific OMS for a list of accounts during a
                      specified time interval.
                    marks: []
                key: Nhh8YKwNsPGc
            key: XDeAauN3Ot8k
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      A user with NotbankTrading permission can only generate
                      transaction reports for accounts with which he/she is
                      associated to.
                    marks: []
                key: ZOrcO4cDUs3x
            key: 6CRCnB9m8OmO
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      The actual Transaction Activity Report will be generated
                      as a comma-separated (CSV) file. It can be downloaded
                      using the API method 
                    marks: []
                  - object: leaf
                    text: DownloadDocument
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: .
                    marks: []
                key: mIwOikkzZ1Pt
            key: FIpm3F6nUhmt
        key: YEfjoh2E8ZMS
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Creates an immediate report on
        historical transaction activity on a specific OMS for a list of accounts
        during a specified time interval.</p><p>A user with NotbankTrading
        permission can only generate transaction reports for accounts with which
        he/she is associated to.</p><p>The actual Transaction Activity Report
        will be generated as a comma-separated (CSV) file. It can be downloaded
        using the API method <strong>DownloadDocument</strong>.</p>
  /AP/GenerateProductDeltaActivityReport:
    post:
      tags:
        - Report
      operationId: GenerateProductDeltaActivityReport
      description: >-
        **Permissions:** NotbankTrading<br />

        **Call Type:** Synchronous


        Initiates the generation of a Product Delta Activity Report for the
        specified accounts over a specified time interval.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/GenerateProductDeltaActivityReportResponse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GenerateProductDeltaActivityReportRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: InLUy5RyvblK
            key: awmeQ0k5q4lG
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Initiates the generation of a Product Delta Activity
                      Report for the specified accounts over a specified time
                      interval.
                    marks: []
                key: Y4jKwTQ6Txao
            key: ETSvSyOaHVSL
        key: LLZTFCK8pZnm
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Initiates the generation of a Product
        Delta Activity Report for the specified accounts over a specified time
        interval.</p>
  /AP/GeneratePnLActivityReport:
    post:
      tags:
        - Report
      operationId: GeneratePnLActivityReport
      description: >-
        **Permissions:** NotbankTrading<br />

        **Call Type:** Synchronous


        Initiates the generation of a Profit and Loss Activity Report for the
        specified accounts over a specified time interval.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GeneratePnLActivityReportResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GeneratePnLActivityReportRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: qtVxTHfuoMHC
            key: db4QtoB3jfxJ
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Initiates the generation of a Profit and Loss Activity
                      Report for the specified accounts over a specified time
                      interval.
                    marks: []
                key: wMh9O5DNcsK2
            key: ng9EGxC5ZzI8
        key: PCK9hUH6xjPO
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Initiates the generation of a Profit
        and Loss Activity Report for the specified accounts over a specified
        time interval.</p>
  /AP/ScheduleTradeActivityReport:
    post:
      tags:
        - Report
      operationId: ScheduleTradeActivityReport
      description: >-
        **Permissions:** NotbankTrading<br />

        **Call Type:** Synchronous


        Initiates the generation of a series of Trade Activity Reports for the
        specified accounts, over a regular periodic time interval.


        A user with NotbankTrading permission can only schedule generation of
        trade reports for accounts with which he/she is associated to.


        A trade report will be generated every period unless cancelled using the
        API method [**CancelReport**](#cancelreport).


        The actual Trade Activity Report will be generated as a comma-separated
        (CSV) file. It can be downloaded using the API method
        [**DownloadDocument**](#operation/DownloadDocument).
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleTradeActivityReportResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleTradeActivityReportRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: H5CX1VGzE6cc
            key: Gha7EK7HKcGb
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Initiates the generation of a series of Trade Activity
                      Reports for the specified accounts, over a regular
                      periodic time interval.
                    marks: []
                key: 8Gb64bYxjX4s
            key: fNx4hlX99wS6
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      A user with NotbankTrading permission can only schedule
                      generation of trade reports for accounts with which he/she
                      is associated to.
                    marks: []
                key: gAM53UuW213Z
            key: IiyVnJ8rKKix
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      A trade report will be generated every period unless
                      cancelled using the API method 
                    marks: []
                  - object: leaf
                    text: CancelReport
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: .
                    marks: []
                key: weNBhF7PW2C4
            key: oDFWueXhexTR
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      The actual Trade Activity Report will be generated as a
                      comma-separated (CSV) file. It can be downloaded using the
                      API method 
                    marks: []
                  - object: leaf
                    text: DownloadDocument
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: .
                    marks: []
                key: 29OmYEgNPpgK
            key: a16U0mUiQgbx
        key: 1S9QrcOk276w
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Initiates the generation of a series of
        Trade Activity Reports for the specified accounts, over a regular
        periodic time interval.</p><p>A user with NotbankTrading permission can
        only schedule generation of trade reports for accounts with which he/she
        is associated to.</p><p>A trade report will be generated every period
        unless cancelled using the API method
        <strong>CancelReport</strong>.</p><p>The actual Trade Activity Report
        will be generated as a comma-separated (CSV) file. It can be downloaded
        using the API method <strong>DownloadDocument</strong>.</p>
  /AP/ScheduleTransactionActivityReport:
    post:
      tags:
        - Report
      operationId: ScheduleTransactionActivityReport
      description: >-
        **Permissions:** NotbankTrading<br />

        **Call Type:** Synchronous


        Initiates the generation of an series of Transaction Activity Reports
        for the specified accounts over a regular periodic time interval.


        A user with NotbankTrading permission can only schedule generation of
        transaction reports for accounts with which he/she is associated to.


        A transaction report will be generated every period unless cancelled
        using the API method [**CancelReport**](#cancelreport).


        The actual Transaction Activity Report will be generated as a
        comma-separated (CSV) file. It can be downloaded using the API call
        [**DownloadDocument**](#operation/DownloadDocument).
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ScheduleTransactionActivityReportResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleTransactionActivityReportRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: s9OOtZAoisnW
            key: ks45aGqU9sma
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Initiates the generation of an series of Transaction
                      Activity Reports for the specified accounts over a regular
                      periodic time interval.
                    marks: []
                key: mLB4p6ssdTc6
            key: 1CklhKknKVMZ
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      A user with NotbankTrading permission can only schedule
                      generation of transaction reports for accounts with which
                      he/she is associated to.
                    marks: []
                key: 8y78OZ0QcTgS
            key: Qfk1Pl83yLig
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      A transaction report will be generated every period unless
                      cancelled using the API method 
                    marks: []
                  - object: leaf
                    text: CancelReport
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: .
                    marks: []
                key: VaG6KkPrwB7f
            key: YBjbcLexA76w
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      The actual Transaction Activity Report will be generated
                      as a comma-separated (CSV) file. It can be downloaded
                      using the API call 
                    marks: []
                  - object: leaf
                    text: DownloadDocument
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: .
                    marks: []
                key: x8VCmbjC5YYc
            key: K0Szn5HEUITt
        key: 2AKPOtvtUoWr
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Initiates the generation of an series
        of Transaction Activity Reports for the specified accounts over a
        regular periodic time interval.</p><p>A user with NotbankTrading
        permission can only schedule generation of transaction reports for
        accounts with which he/she is associated to.</p><p>A transaction report
        will be generated every period unless cancelled using the API method
        <strong>CancelReport</strong>.</p><p>The actual Transaction Activity
        Report will be generated as a comma-separated (CSV) file. It can be
        downloaded using the API call <strong>DownloadDocument</strong>.</p>
  /AP/ScheduleProductDeltaActivityReport:
    post:
      tags:
        - Report
      operationId: ScheduleProductDeltaActivityReport
      description: >-
        **Permissions:** NotbankTrading<br />

        **Call Type:** Synchronous


        Initiates the generation of a series of Product Delta Activity reports
        for the specified accounts over a regular periodic time interval.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ScheduleProductDeltaActivityReportResponse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleProductDeltaActivityReportRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: 9229gdRFMgqW
            key: EycdFMZAmUK3
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Initiates the generation of a series of Product Delta
                      Activity reports for the specified accounts over a regular
                      periodic time interval.
                    marks: []
                key: Fqj2ovbPmsaF
            key: EP6NcDDjakhI
        key: obhFmTLs4CMY
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Initiates the generation of a series of
        Product Delta Activity reports for the specified accounts over a regular
        periodic time interval.</p>
  /AP/ScheduleProfitAndLossActivityReport:
    post:
      tags:
        - Report
      operationId: ScheduleProfitAndLossActivityReport
      description: >-
        **Permissions:** NotbankTrading<br />

        **Call Type:** Synchronous


        Initiates the generation of a series of Profit and Loss Activity reports
        for the specified accounts over a regular periodic time interval.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ScheduleProfitAndLossActivityReportResponse
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ScheduleProfitAndLossActivityReportRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: kMzICBjqeEpo
            key: 6BxrSJ27I2yt
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Initiates the generation of a series of Profit and Loss
                      Activity reports for the specified accounts over a regular
                      periodic time interval.
                    marks: []
                key: oWqvwLYWu3VD
            key: 2UTiM2KmAiFZ
        key: XKYAxxI7I6fS
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Initiates the generation of a series of
        Profit and Loss Activity reports for the specified accounts over a
        regular periodic time interval.</p>
  /AP/CancelUserReport:
    post:
      tags:
        - Report
      operationId: CancelUserReport
      description: >-
        **Permissions:** NotbankTrading<br />

        **Call Type:** Synchronous


        Cancels a User Report. If successful, changes the state of a
        UserReportTicket to **UserCancelled**. 


        To get list of user reports that can be possibly cancelled, you can use
        the API method
        [**GetUserReportTickets**](#operation/GetUserReportTickets).
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelUserReportResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelUserReportRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: cFfPhfq64xwl
            key: yuKHLgG0jNB7
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Cancels a User Report. If successful, changes the state of
                      a UserReportTicket to 
                    marks: []
                  - object: leaf
                    text: UserCancelled
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: .
                    marks: []
                key: a3DMkYoOg6tl
            key: DFVaqwzpsU1I
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      To get list of user reports that can be possibly
                      cancelled, you can use the API method 
                    marks: []
                  - object: leaf
                    text: GetUserReportTickets
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: .
                    marks: []
                key: hcW7NIAavQor
            key: oyziOQuvCxzf
        key: vHqHQBIa3mKL
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Cancels a User Report. If successful,
        changes the state of a UserReportTicket to
        <strong>UserCancelled</strong>.</p><p>To get list of user reports that
        can be possibly cancelled, you can use the API method
        <strong>GetUserReportTickets</strong>.</p>
  /AP/GetUserReportWriterResultRecords:
    post:
      tags:
        - Report
      operationId: GetUserReportWriterResultRecords
      description: "**Permissions:** NotbankTrading<br />\n**Call Type:** Synchronous\n\nGets the execution records of reports requested by the User.\n\nUsers with NotbankTrading permission can request user report writer result records only for their own.\n\n<aside class=\"notice\"><strong>Note:\_</strong>\"Depth\" in this API method is the count of records to be returned, not market depth.</aside>."
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUserReportWriterResultRecordsResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetUserReportWriterResultRecordsRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: RaZVGr0KsGmt
            key: 5T1FYk1oKlQL
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets the execution records of reports requested by the
                      User.
                    marks: []
                key: Gixa1u2mtRmC
            key: DCrD6NJFeSwv
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Users with NotbankTrading permission can request user
                      report writer result records only for their own.
                    marks: []
                key: wMzQfF6qeLBl
            key: GQp47liABCD2
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Note: '
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: >-
                      "Depth" in this API method is the count of records to be
                      returned, not market depth..
                    marks: []
                key: GjkmgswD65rT
            key: PpFYYrvHxcVn
        key: pJnDR2rrUFvl
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Gets the execution records of reports
        requested by the User.</p><p>Users with NotbankTrading permission can
        request user report writer result records only for their
        own.</p><p><strong>Note:</strong> "Depth" in this API method is the
        count of records to be returned, not market depth..</p>
  /AP/GetUserReportTickets:
    post:
      tags:
        - Report
      operationId: GetUserReportTickets
      description: >-
        **Permissions:** NotbankTrading<br />

        **Call Type:** Synchronous


        Gets a list of user report tickets for a specific user ID. A user report
        ticket identifies a report requested or scheduled by a user. Reports can
        run once or periodically.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUserReportTicketsResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetUserReportTicketsRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: MoE98K1U2lWJ
            key: ss5ly1ESXeJF
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets a list of user report tickets for a specific user ID.
                      A user report ticket identifies a report requested or
                      scheduled by a user. Reports can run once or periodically.
                    marks: []
                key: EGOzzQBWM1ru
            key: nnxGt3MLMD5F
        key: mWGQKvlHqq5Z
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Gets a list of user report tickets for
        a specific user ID. A user report ticket identifies a report requested
        or scheduled by a user. Reports can run once or periodically.</p>
  /AP/RemoveUserReportTicket:
    post:
      tags:
        - Report
      operationId: RemoveUserReportTicket
      description: |-
        **Permissions:** NotbankTrading<br />
        **Call Type:** Synchronous

        Removes the specified user report ticket from processing.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RemoveUserReportTicketResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RemoveUserReportTicketRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: 9fbl4ZUBX5B4
            key: mFt3HmBCXtmS
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Removes the specified user report ticket from processing.
                    marks: []
                key: 1SbDiSDkIZ6d
            key: gSu7e8CLQ6IW
        key: ORBnuOhg5Ogg
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Removes the specified user report
        ticket from processing.</p>
  /AP/GetUserReportTicketsByStatus:
    post:
      tags:
        - Report
      operationId: GetUserReportTicketsByStatus
      description: |-
        **Permissions:** NotbankTrading<br />
        **Call Type:** Synchronous

        Gets a list of user report tickets included in the list of statuses.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUserReportTicketsByStatusResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetUserReportTicketsByStatusRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: Qj0d0qw0gVyG
            key: GkY3yPBrJn9x
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets a list of user report tickets included in the list of
                      statuses.
                    marks: []
                key: I7AayqtYJvc5
            key: q9quyEHjK38S
        key: ZcrcRgFARiR6
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Gets a list of user report tickets
        included in the list of statuses.</p>
  /AP/DownloadDocument:
    post:
      tags:
        - Report
      operationId: DownloadDocument
      description: |-
        **Permissions:** NotbankTrading<br />
        **Call Type:** Synchronous

        Download Document.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DownloadDocumentResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DownloadDocumentRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: ewEjbFsdIwLl
            key: KBqY4kwuNJ7M
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Download Document.
                    marks: []
                key: wfmvqly5ggKC
            key: aianV1AoMQvq
        key: feYixNxz6J5Q
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Download Document.</p>
  /AP/DownloadDocumentSlice:
    post:
      tags:
        - Report
      operationId: DownloadDocumentSlice
      description: |-
        **Permissions:** NotbankTrading<br />
        **Call Type:** Synchronous

        Download Document Slice.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DownloadDocumentSliceResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DownloadDocumentSliceRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: YW8y1iWYmjmm
            key: oMDmoSQLGJDk
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Download Document Slice.
                    marks: []
                key: P7wK9HDrPDIg
            key: Arm6OK5g4MiA
        key: d2YLmZwmwUMl
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Download Document Slice.</p>
  /AP/Ping:
    post:
      tags:
        - System
      operationId: Ping
      description: |-
        **Permissions:** Public<br />
        **Call Type:** Synchronous

        Keepalive, can be used to avoid getting session timeout.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PingResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PingRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       Public
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: YCqu4BodRnKU
            key: yM1TU0pFX36n
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Keepalive, can be used to avoid getting session timeout.
                    marks: []
                key: RDMrEkKN8w2U
            key: VIET6Z6cnzQ4
        key: zwmFyznA8y7m
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> Public<br><strong>Call Type:</strong>
        Synchronous</p><p>Keepalive, can be used to avoid getting session
        timeout.</p>
  /AP/HealthCheck:
    post:
      tags:
        - System
      operationId: HealthCheck
      description: |-
        **Permissions:** Public<br />
        **Call Type:** Synchronous

        Gets Exchange's services overall health.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthCheckResponse'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       Public
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: x4ycYQssee00
            key: 2kYtFjuRqoh1
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Gets Exchange's services overall health.
                    marks: []
                key: VTjkehgXQg3W
            key: W1i7nrEwliav
        key: gufNNrRQ9pet
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> Public<br><strong>Call Type:</strong>
        Synchronous</p><p>Gets Exchange's services overall health.</p>
  /AP/SendOrderList:
    post:
      tags:
        - Trading
      operationId: SendOrderList
      description: >-
        **Permissions:** NotbankTrading<br />

        **Call Type:** Synchronous


        Creates a list of orders. This method takes a list where each element
        represents a single order with the same format used in the API method
        [**SendOrder**](#operation/SendOrder). 


        The orders can be assorted, means that it can be for different
        instruments and different accounts.


        Anyone submitting an order should also subscribe to the various market
        data and event feeds, or call
        [**GetOpenOrders**](#operation/GetOpenOrders) or
        [**GetOrderStatus**](#operation/GetOrderStatus) to monitor the status of
        the order. If the order is not in a state to be executed,
        **GetOpenOrders** will not return it.


        A user with NotbankTrading permission can only create an order for
        accounts with which he/she is associated to.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendOrderListResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendOrderListRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: oe2HLfpXQ7bg
            key: flpPYSk2yVQj
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Creates a list of orders. This method takes a list where
                      each element represents a single order with the same
                      format used in the API method 
                    marks: []
                  - object: leaf
                    text: SendOrder
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: .
                    marks: []
                key: 3NImwV4NHg3E
            key: vMgw8gYYblPq
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      The orders can be assorted, means that it can be for
                      different instruments and different accounts.
                    marks: []
                key: 2phh0U9FmLFP
            key: pOJUvqVKRHBo
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Anyone submitting an order should also subscribe to the
                      various market data and event feeds, or call 
                    marks: []
                  - object: leaf
                    text: GetOpenOrders
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' or '
                    marks: []
                  - object: leaf
                    text: GetOrderStatus
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' to monitor the status of the order. If the order is not in a state to be executed, '
                    marks: []
                  - object: leaf
                    text: GetOpenOrders
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' will not return it.'
                    marks: []
                key: wUeXvUGgVjAN
            key: 70psu316gH8V
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      A user with NotbankTrading permission can only create an
                      order for accounts with which he/she is associated to.
                    marks: []
                key: iRkonobQrjpv
            key: i1GT7OUPw6QD
        key: WCBpBIbbAHw3
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Creates a list of orders. This method
        takes a list where each element represents a single order with the same
        format used in the API method <strong>SendOrder</strong>.</p><p>The
        orders can be assorted, means that it can be for different instruments
        and different accounts.</p><p>Anyone submitting an order should also
        subscribe to the various market data and event feeds, or call
        <strong>GetOpenOrders</strong> or <strong>GetOrderStatus</strong> to
        monitor the status of the order. If the order is not in a state to be
        executed, <strong>GetOpenOrders</strong> will not return it.</p><p>A
        user with NotbankTrading permission can only create an order for
        accounts with which he/she is associated to.</p>
  /AP/SendCancelList:
    post:
      tags:
        - Trading
      operationId: SendCancelList
      description: >-
        **Permissions:** NotbankTrading<br />

        **Call Type:** Synchronous


        Cancels a list of orders. This method takes a list of element each
        representing an order to be canceled.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendCancelListResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendCancelListRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: Y2IvPOOKpUVr
            key: XDwjQCjRlMvd
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Cancels a list of orders. This method takes a list of
                      element each representing an order to be canceled.
                    marks: []
                key: x4BDL74vf4Hw
            key: uz3GpF9nGnqA
        key: YccR9pmVsXOa
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Cancels a list of orders. This method
        takes a list of element each representing an order to be canceled.</p>
  /AP/SendCancelReplaceList:
    post:
      tags:
        - Trading
      operationId: SendCancelReplaceList
      description: |-
        **Permissions:** NotbankTrading<br />
        **Call Type:** Synchronous

        Cancels or Replaces orders. Only working orders can be replaced.

        This method will reset order book priority of the order.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendCancelReplaceListResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendCancelReplaceListRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: y4kgtpEKK5g6
            key: 8wmB61U3C5kc
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Cancels or Replaces orders. Only working orders can be
                      replaced.
                    marks: []
                key: uvjc6paKp0fd
            key: kg1TnnUny7qT
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: This method will reset order book priority of the order.
                    marks: []
                key: WjwGt9bhCa7c
            key: tvY8cEELh6CQ
        key: 0xIpLpF5xreL
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Cancels or Replaces orders. Only
        working orders can be replaced.</p><p>This method will reset order book
        priority of the order.</p>
  /AP/ModifyOrder:
    post:
      tags:
        - Trading
      operationId: ModifyOrder
      description: >-
        **Permissions:** NotbankTrading<br />

        **Call Type:** Synchronous


        Modifies an order's quantity. With this method, an order’s quantity can
        only be reduced.


        Reduces an order’s quantity without losing priority in the order book.
        The other API method that can modify an order is
        [**CancelReplaceOrder**](#operation/CancelReplaceOrder), it resets order
        book priority, but you can use it to increase an order quantity and also
        change the limitprice.


        <aside class="notice"><strong>Note:</strong>
        <strong>ModifyOrder</strong> does not surrender or reset order book
        priority.</aside>.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModifyOrderResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ModifyOrderRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: rvo8AXTuHbbE
            key: eGWowAvRrvZ1
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Modifies an order's quantity. With this method, an order’s
                      quantity can only be reduced.
                    marks: []
                key: Rsk5qBTSUOc6
            key: hVHNTHDFD75X
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Reduces an order’s quantity without losing priority in the
                      order book. The other API method that can modify an order
                      is 
                    marks: []
                  - object: leaf
                    text: CancelReplaceOrder
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: >-
                      , it resets order book priority, but you can use it to
                      increase an order quantity and also change the limitprice.
                    marks: []
                key: kgQ692ANwACr
            key: JH9SpR71j9ZH
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Note:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' '
                    marks: []
                  - object: leaf
                    text: ModifyOrder
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' does not surrender or reset order book priority..'
                    marks: []
                key: oIZlWrwKsdDX
            key: dynAtsuqMGDx
        key: j3FYDPjzbGqh
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Modifies an order's quantity. With this
        method, an order’s quantity can only be reduced.</p><p>Reduces an
        order’s quantity without losing priority in the order book. The other
        API method that can modify an order is
        <strong>CancelReplaceOrder</strong>, it resets order book priority, but
        you can use it to increase an order quantity and also change the
        limitprice.</p><p><strong>Note:</strong> <strong>ModifyOrder</strong>
        does not surrender or reset order book priority..</p>
  /AP/CancelAllOrders:
    post:
      tags:
        - Trading
      operationId: CancelAllOrders
      description: >-
        **Permissions:** NotbankTrading<br />

        **Call Type:** Synchronous


        Cancels all open matching orders for the specified account on an OMS.


        A user with NotbankTrading permission can only cancel orders for
        accounts with which he/she is associated to.


        <aside class="notice"><strong>Note:</strong> Multiple users may have
        access to the same account.</aside>.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelAllOrdersResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelAllOrdersRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: vYlnvCySs7F0
            key: o8PQJlSeFmn8
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Cancels all open matching orders for the specified account
                      on an OMS.
                    marks: []
                key: sLyuuyqYLeFK
            key: zFn5R3HWewOu
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      A user with NotbankTrading permission can only cancel
                      orders for accounts with which he/she is associated to.
                    marks: []
                key: Vpnw6EZp2Rgk
            key: UKYhEQYzDUQD
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Note:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Multiple users may have access to the same account..'
                    marks: []
                key: 0bcXOu3Sy1lg
            key: ZTMoGZsI3utK
        key: UsNCBvxvV9XI
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Cancels all open matching orders for
        the specified account on an OMS.</p><p>A user with NotbankTrading
        permission can only cancel orders for accounts with which he/she is
        associated to.</p><p><strong>Note:</strong> Multiple users may have
        access to the same account..</p>
  /AP/GetOrderStatus:
    post:
      tags:
        - Trading
      operationId: GetOrderStatus
      description: >-
        **Permissions:** NotbankTrading<br />

        **Call Type:** Synchronous


        Gets the status information for a single order.


        A user with NotbankTrading permission can only retrieve status
        information of orders for accounts with which he/she is associated to.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrderStatusResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetOrderStatusRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: BLJjsVX6VRCP
            key: x7jmscIGZnxB
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Gets the status information for a single order.
                    marks: []
                key: easKzVU8buUl
            key: EIsdmvyuK34i
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      A user with NotbankTrading permission can only retrieve
                      status information of orders for accounts with which
                      he/she is associated to.
                    marks: []
                key: fXWJwNwruhVb
            key: ZeA7vHujW4ti
        key: Mz9S4Cb2kag7
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Gets the status information for a
        single order.</p><p>A user with NotbankTrading permission can only
        retrieve status information of orders for accounts with which he/she is
        associated to.</p>
  /AP/GetOrdersHistory:
    post:
      tags:
        - Trading
      operationId: GetOrdersHistory
      description: >-
        **Permissions:** NotbankTrading<br />

        **Call Type:** Synchronous


        Gets a list of orders for the specified search parameters.


        For example, if _depth_ = 200 and _startIndex_ = 0, the history returns
        200 unique orders into the past starting with the most recent (0) order.
        If _depth_ = 200 and _startIndex_ = 100, the history returns 200 unique
        orders into the past starting at 101st order in the past.


        The owner of the trading venue determines how long to retain order
        history before archiving.


        A user with NotbankTrading permission can only retrieve orders history
        for accounts with which he/she is associated to.


        <aside class="notice"><strong>Note:</strong> In this call, "Depth"
        refers to the maximum number/count of orders that can be
        retrieved.</aside>.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrdersHistoryResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetOrdersHistoryRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: no8i7Kk03mR1
            key: P2GUZNFaGYze
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Gets a list of orders for the specified search parameters.
                    marks: []
                key: 2NogABZQDcBx
            key: HoVPyNwstZR5
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'For example, if '
                    marks: []
                  - object: leaf
                    text: depth
                    marks:
                      - object: mark
                        type: italic
                        data: {}
                  - object: leaf
                    text: ' = 200 and '
                    marks: []
                  - object: leaf
                    text: startIndex
                    marks:
                      - object: mark
                        type: italic
                        data: {}
                  - object: leaf
                    text: ' = 0, the history returns 200 unique orders into the past starting with the most recent (0) order. If '
                    marks: []
                  - object: leaf
                    text: depth
                    marks:
                      - object: mark
                        type: italic
                        data: {}
                  - object: leaf
                    text: ' = 200 and '
                    marks: []
                  - object: leaf
                    text: startIndex
                    marks:
                      - object: mark
                        type: italic
                        data: {}
                  - object: leaf
                    text: ' = 100, the history returns 200 unique orders into the past starting at 101st order in the past.'
                    marks: []
                key: QoTv2RA0ti0d
            key: QCSLg0eMTvqR
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      The owner of the trading venue determines how long to
                      retain order history before archiving.
                    marks: []
                key: HRTDi5FToMCD
            key: vDAktWK7AgsI
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      A user with NotbankTrading permission can only retrieve
                      orders history for accounts with which he/she is
                      associated to.
                    marks: []
                key: tVH8uOHZ2Zz7
            key: AhHUTp74W6XF
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Note:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' In this call, "Depth" refers to the maximum number/count of orders that can be retrieved..'
                    marks: []
                key: qEDvnp1rw9UF
            key: 3cJGmc7xSFO0
        key: 6ry0GjWf7X49
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Gets a list of orders for the specified
        search parameters.</p><p>For example, if <em>depth</em> = 200 and
        <em>startIndex</em> = 0, the history returns 200 unique orders into the
        past starting with the most recent (0) order. If <em>depth</em> = 200
        and <em>startIndex</em> = 100, the history returns 200 unique orders
        into the past starting at 101st order in the past.</p><p>The owner of
        the trading venue determines how long to retain order history before
        archiving.</p><p>A user with NotbankTrading permission can only retrieve
        orders history for accounts with which he/she is associated
        to.</p><p><strong>Note:</strong> In this call, "Depth" refers to the
        maximum number/count of orders that can be retrieved..</p>
  /AP/GetTradesHistory:
    post:
      tags:
        - Trading
      operationId: GetTradesHistory
      description: >-
        **Permissions:** NotbankTrading<br />

        **Call Type:** Synchronous


        Gets a list of trades for a specified account, order ID, user,
        instrument, or starting and ending time stamp. The returned list begins
        at start index _i_, where _i_ is an integer identifying a specific trade
        in reverse order; that is, the most recent trade has an index of 0.
        “Depth” is the count of trades to report backwards from _StartIndex_.


        Users with NotbankTrading permission can only retrieve trade history for
        accounts with which he/she is associated to.


        <aside class="warning"><strong>Caution</strong>: You must coordinate
        *StartIndex*, *Depth*, *StartTimeStamp*, and *EndTimeStamp* to retrieve
        the historical information you need.</aside>


        <aside class="notice"><strong>Note</strong>: In this API method, “Depth”
        refers not to the depth of the order book, but to the count of trades to
        report. The owner of the trading venue determines how long to retain
        order history before archiving.</aside>.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTradesHistoryResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetTradesHistoryRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: 0JtxlUzRqALl
            key: wzJ9DWWOmWal
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets a list of trades for a specified account, order ID,
                      user, instrument, or starting and ending time stamp. The
                      returned list begins at start index 
                    marks: []
                  - object: leaf
                    text: i
                    marks:
                      - object: mark
                        type: italic
                        data: {}
                  - object: leaf
                    text: ', where '
                    marks: []
                  - object: leaf
                    text: i
                    marks:
                      - object: mark
                        type: italic
                        data: {}
                  - object: leaf
                    text: ' is an integer identifying a specific trade in reverse order; that is, the most recent trade has an index of 0. “Depth” is the count of trades to report backwards from '
                    marks: []
                  - object: leaf
                    text: StartIndex
                    marks:
                      - object: mark
                        type: italic
                        data: {}
                  - object: leaf
                    text: .
                    marks: []
                key: yHaHZLpnrpb9
            key: oXx3er4plN9R
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Users with NotbankTrading permission can only retrieve
                      trade history for accounts with which he/she is associated
                      to.
                    marks: []
                key: ByqI7b29bJ94
            key: Oeh1OITzbDUy
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Caution
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: >-
                      : You must coordinate *StartIndex*, *Depth*,
                      *StartTimeStamp*, and *EndTimeStamp* to retrieve the
                      historical information you need.
                    marks: []
                  - object: leaf
                    text: Note
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: >-
                      : In this API method, “Depth” refers not to the depth of
                      the order book, but to the count of trades to report. The
                      owner of the trading venue determines how long to retain
                      order history before archiving..
                    marks: []
                key: oJ3z1ZLC18WQ
            key: RwwkG2NWCM1H
        key: AVkNQlaMijg0
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Gets a list of trades for a specified
        account, order ID, user, instrument, or starting and ending time stamp.
        The returned list begins at start index <em>i</em>, where <em>i</em> is
        an integer identifying a specific trade in reverse order; that is, the
        most recent trade has an index of 0. “Depth” is the count of trades to
        report backwards from <em>StartIndex</em>.</p><p>Users with
        NotbankTrading permission can only retrieve trade history for accounts
        with which he/she is associated to.</p><p><strong>Caution</strong>: You
        must coordinate *StartIndex*, *Depth*, *StartTimeStamp*, and
        *EndTimeStamp* to retrieve the historical information you
        need.<strong>Note</strong>: In this API method, “Depth” refers not to
        the depth of the order book, but to the count of trades to report. The
        owner of the trading venue determines how long to retain order history
        before archiving..</p>
  /AP/GetOrderHistoryByOrderId:
    post:
      tags:
        - Trading
      operationId: GetOrderHistoryByOrderId
      description: >-
        **Permissions:** NotbankTrading<br />

        **Call Type:** Synchronous


        Gets a list of orders, being the history of a single order, from being
        added to the book up to the full execution or rejection, or
        cancellation. ReceiveTime in POSIX format X 1000 (milliseconds since 1
        January 1970)


        A user with NotbankTrading permission can only retrieve an order history
        for accounts with which he/she is associated to.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrderHistoryByOrderIdResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetOrderHistoryByOrderIdRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: bGRd1WlKNgXP
            key: tAG7eITf44kr
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets a list of orders, being the history of a single
                      order, from being added to the book up to the full
                      execution or rejection, or cancellation. ReceiveTime in
                      POSIX format X 1000 (milliseconds since 1 January 1970)
                    marks: []
                key: 72CqpV4007yp
            key: URVXaCjSwtfV
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      A user with NotbankTrading permission can only retrieve an
                      order history for accounts with which he/she is associated
                      to.
                    marks: []
                key: AL1FjZYnEVI2
            key: hXXG84IjGMYb
        key: w9D0yokFyECh
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Gets a list of orders, being the
        history of a single order, from being added to the book up to the full
        execution or rejection, or cancellation. ReceiveTime in POSIX format X
        1000 (milliseconds since 1 January 1970)</p><p>A user with
        NotbankTrading permission can only retrieve an order history for
        accounts with which he/she is associated to.</p>
  /AP/GetTickerHistory:
    post:
      tags:
        - Trading
      operationId: GetTickerHistory
      description: >-
        **Permissions:** Public<br />

        **Call Type:** Synchronous


        Gets a list of tickers, being the ticker history (high, low, open,
        close, volume, bid, ask, ID) of a specific instrument from the given
        **FromDate** up to the **ToDate** in the request payload. You will need
        to format the returned data per your requirements.


        Because permission is Public, any user can retrieve the ticker history
        for any instrument on the OMS.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTickerHistoryResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetTickerHistoryRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       Public
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: OUInVc1F9l2G
            key: x2X8Zo3LWHQH
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets a list of tickers, being the ticker history (high,
                      low, open, close, volume, bid, ask, ID) of a specific
                      instrument from the given 
                    marks: []
                  - object: leaf
                    text: FromDate
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' up to the '
                    marks: []
                  - object: leaf
                    text: ToDate
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' in the request payload. You will need to format the returned data per your requirements.'
                    marks: []
                key: TBl4MCMBngga
            key: qiX2QxB3tILW
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Because permission is Public, any user can retrieve the
                      ticker history for any instrument on the OMS.
                    marks: []
                key: GAT38SEqk3zj
            key: TgXv9IRHwsHs
        key: jCzaq0L1Zx40
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> Public<br><strong>Call Type:</strong>
        Synchronous</p><p>Gets a list of tickers, being the ticker history
        (high, low, open, close, volume, bid, ask, ID) of a specific instrument
        from the given <strong>FromDate</strong> up to the
        <strong>ToDate</strong> in the request payload. You will need to format
        the returned data per your requirements.</p><p>Because permission is
        Public, any user can retrieve the ticker history for any instrument on
        the OMS.</p>
  /AP/GetLastTrades:
    post:
      tags:
        - Trading
      operationId: GetLastTrades
      description: |-
        **Permissions:** Public, NotbankTrading<br />
        **Call Type:** Synchronous

        Gets the list of last trades that happened for a specific instrument.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLastTradesResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetLastTradesRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       Public, NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: d4nJYtSpvCOd
            key: HyuzInJoCWMU
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets the list of last trades that happened for a specific
                      instrument.
                    marks: []
                key: u78FruUdygQW
            key: 06RnCJdnyXfs
        key: haUR65WVaWTs
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> Public, NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Gets the list of last trades that
        happened for a specific instrument.</p>
  /AP/GetLevel1Summary:
    post:
      tags:
        - Trading
      operationId: GetLevel1Summary
      description: >-
        **Permissions:** NotbankTrading, Public<br />

        **Call Type:** Synchronous


        Gets the current Level 1 snapshot (best bid, best offer and other data
        such lasttradedprice) of all instruments trading on an OMS.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLevel1SummaryResponse'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading, Public
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: NE7xXrypckTS
            key: iXoiwUIr19og
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets the current Level 1 snapshot (best bid, best offer
                      and other data such lasttradedprice) of all instruments
                      trading on an OMS.
                    marks: []
                key: dTE1jULnbcKr
            key: 2ETfLd3m3gUw
        key: V37j3pi6WaTm
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading, Public<br><strong>Call
        Type:</strong> Synchronous</p><p>Gets the current Level 1 snapshot (best
        bid, best offer and other data such lasttradedprice) of all instruments
        trading on an OMS.</p>
  /AP/GetLevel1SummaryMin:
    post:
      tags:
        - Trading
      operationId: GetLevel1SummaryMin
      description: >-
        **Permissions:** NotbankTrading, Public<br />

        **Call Type:** Synchronous


        Gets the latest Level 1 Snapshot of all markets/instruments. Snapshot
        includes **LastTradedPx**, **Rolling24HrPxChange**,
        **Rolling24HrPxChangePercent**, **Rolling24HrVolume**. Can also be
        filtered according to instrument ids.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLevel1SummaryMinResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetLevel1SummaryMinRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading, Public
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: fw8CnQoSAbST
            key: sax5BZFw3Vag
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets the latest Level 1 Snapshot of all
                      markets/instruments. Snapshot includes 
                    marks: []
                  - object: leaf
                    text: LastTradedPx
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ', '
                    marks: []
                  - object: leaf
                    text: Rolling24HrPxChange
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ', '
                    marks: []
                  - object: leaf
                    text: Rolling24HrPxChangePercent
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ', '
                    marks: []
                  - object: leaf
                    text: Rolling24HrVolume
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: . Can also be filtered according to instrument ids.
                    marks: []
                key: AiD1ueJGEmgs
            key: msr5Gb86xi8F
        key: FY2bXU7Cr740
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading, Public<br><strong>Call
        Type:</strong> Synchronous</p><p>Gets the latest Level 1 Snapshot of all
        markets/instruments. Snapshot includes <strong>LastTradedPx</strong>,
        <strong>Rolling24HrPxChange</strong>,
        <strong>Rolling24HrPxChangePercent</strong>,
        <strong>Rolling24HrVolume</strong>. Can also be filtered according to
        instrument ids.</p>
  /AP/GetOpenTradeReports:
    post:
      tags:
        - Trading
      operationId: GetOpenTradeReports
      description: >-
        **Permissions:** NotbankTrading, NotbankReadOnly<br />

        **Call Type:** Synchronous


        Gets the list of Open Trade Reports (block trades), for the given
        accountId. ReceiveTime is in POSIX format X 1000 (milliseconds since 1
        January 1970).
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOpenTradeReportsResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetOpenTradeReportsRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading, NotbankReadOnly
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: WxgPWHfF2Fnd
            key: O0K9dDkekgvS
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets the list of Open Trade Reports (block trades), for
                      the given accountId. ReceiveTime is in POSIX format X 1000
                      (milliseconds since 1 January 1970).
                    marks: []
                key: nP8EOjhuBB3B
            key: uije8gur5OEj
        key: LnPQSyGfmYrP
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading,
        NotbankReadOnly<br><strong>Call Type:</strong> Synchronous</p><p>Gets
        the list of Open Trade Reports (block trades), for the given accountId.
        ReceiveTime is in POSIX format X 1000 (milliseconds since 1 January
        1970).</p>
  /AP/GetOrders:
    post:
      tags:
        - Trading
      operationId: GetOrders
      description: >-
        **Permissions:** NotbankTrading<br />

        **Call Type:** Synchronous


        Gets the list of the latest states of orders for an account. ReceiveTime
        is in POSIX format X 1000 (milliseconds since 1 January 1970).


        Results can also be filtered according to different search parameters
        such as OrderState, InstrumentId, OrderId etc. This API method functions
        just like [**GetOrdersHistory**](#operation/GetOrdersHistory)


        A user with NotbankTrading permission can only retrieve orders for
        accounts with which he/she is associated to.


        <aside class="notice"><strong>Note:</strong> In this method, "Depth"
        refers to the count of trades to report, not the depth of the order
        book.</aside>.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrdersResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetOrdersRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: bA4wT8tAqBvn
            key: XgFBEU4ZcCDk
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets the list of the latest states of orders for an
                      account. ReceiveTime is in POSIX format X 1000
                      (milliseconds since 1 January 1970).
                    marks: []
                key: GygJ03qj59ZF
            key: B701m4aQLDKi
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Results can also be filtered according to different search
                      parameters such as OrderState, InstrumentId, OrderId etc.
                      This API method functions just like 
                    marks: []
                  - object: leaf
                    text: GetOrdersHistory
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                key: kqeG22OqXNbV
            key: szmFXiwOSTId
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      A user with NotbankTrading permission can only retrieve
                      orders for accounts with which he/she is associated to.
                    marks: []
                key: KymCaGaFYmcX
            key: a3LNPJBcL2Rj
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Note:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' In this method, "Depth" refers to the count of trades to report, not the depth of the order book..'
                    marks: []
                key: MHFitykVmGeA
            key: cunIRWyySJTk
        key: DDGsCwfQ1NEn
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Gets the list of the latest states of
        orders for an account. ReceiveTime is in POSIX format X 1000
        (milliseconds since 1 January 1970).</p><p>Results can also be filtered
        according to different search parameters such as OrderState,
        InstrumentId, OrderId etc. This API method functions just like
        <strong>GetOrdersHistory</strong></p><p>A user with NotbankTrading
        permission can only retrieve orders for accounts with which he/she is
        associated to.</p><p><strong>Note:</strong> In this method, "Depth"
        refers to the count of trades to report, not the depth of the order
        book..</p>
  /AP/GetOrderHistory:
    post:
      tags:
        - Trading
      operationId: GetOrderHistory
      description: >-
        **Permissions:** NotbankTrading<br />

        **Call Type:** Synchronous


        Gets a list of orders, being the history of orders for the specified
        search parameters.


        For example, if _depth_ = 200 and _startIndex_ = 0, the history returns
        200 unique orders into the past starting with the most recent (0) order.
        If _depth_ = 200 and _startIndex_ = 100, the history returns 200 unique
        orders into the past starting at 101st order in the past.


        The owner of the trading venue determines how long to retain order
        history before archiving.


        A user with NotbankTrading permission can only retrieve orders history
        for accounts with which he/she is associated to.


        <aside class="notice"><strong>Note:</strong> In this method, "Depth"
        refers to the maximum number/count of orders that can be
        retrieved.</aside>.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOrderHistoryResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetOrderHistoryRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: 2tb1ZHEvzFL9
            key: BIcEAbadLlsn
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets a list of orders, being the history of orders for the
                      specified search parameters.
                    marks: []
                key: G04CkogmzMC6
            key: GwwH7we7fIi5
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'For example, if '
                    marks: []
                  - object: leaf
                    text: depth
                    marks:
                      - object: mark
                        type: italic
                        data: {}
                  - object: leaf
                    text: ' = 200 and '
                    marks: []
                  - object: leaf
                    text: startIndex
                    marks:
                      - object: mark
                        type: italic
                        data: {}
                  - object: leaf
                    text: ' = 0, the history returns 200 unique orders into the past starting with the most recent (0) order. If '
                    marks: []
                  - object: leaf
                    text: depth
                    marks:
                      - object: mark
                        type: italic
                        data: {}
                  - object: leaf
                    text: ' = 200 and '
                    marks: []
                  - object: leaf
                    text: startIndex
                    marks:
                      - object: mark
                        type: italic
                        data: {}
                  - object: leaf
                    text: ' = 100, the history returns 200 unique orders into the past starting at 101st order in the past.'
                    marks: []
                key: 0iPICgL2xON1
            key: leF0tuMBDJy2
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      The owner of the trading venue determines how long to
                      retain order history before archiving.
                    marks: []
                key: P1bVMKysEBSE
            key: 0BT6digpzWW2
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      A user with NotbankTrading permission can only retrieve
                      orders history for accounts with which he/she is
                      associated to.
                    marks: []
                key: I9sOA9ulON3h
            key: whit47kRl5dY
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Note:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' In this method, "Depth" refers to the maximum number/count of orders that can be retrieved..'
                    marks: []
                key: uBVUPdkQcmZ3
            key: 4I3hLrWAuSRa
        key: zdoEu9ll8aW2
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Gets a list of orders, being the
        history of orders for the specified search parameters.</p><p>For
        example, if <em>depth</em> = 200 and <em>startIndex</em> = 0, the
        history returns 200 unique orders into the past starting with the most
        recent (0) order. If <em>depth</em> = 200 and <em>startIndex</em> = 100,
        the history returns 200 unique orders into the past starting at 101st
        order in the past.</p><p>The owner of the trading venue determines how
        long to retain order history before archiving.</p><p>A user with
        NotbankTrading permission can only retrieve orders history for accounts
        with which he/she is associated to.</p><p><strong>Note:</strong> In this
        method, "Depth" refers to the maximum number/count of orders that can be
        retrieved..</p>
  /AP/SendOrder:
    post:
      tags:
        - Trading
      operationId: SendOrder
      description: >-
        **Permissions:** NotbankTrading<br />

        **Call Type:** Asynchronous


        Creates an order.


        Anyone submitting an order should also subscribe to the various market
        data and event feeds, or call
        [**GetOpenOrders**](#operation/GetOpenOrders) or
        [**GetOrderStatus**](#operation/GetOrderStatus) to monitor the status of
        the order. If the order is not in a state to be executed,
        **GetOpenOrders** will not return it.


        A user with NotbankTrading permission can only create an order for
        accounts with which he/she is associated to.


        <aside class="notice"><strong>Note:</strong> Call Type is
        asynchronous.</aside>.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SendOrderResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SendOrderRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Asynchronous'
                    marks: []
                key: DfklMynxYjRo
            key: 58PrfhyAbTWz
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Creates an order.
                    marks: []
                key: 1J13x7kk29tx
            key: nvWihRgcfMQE
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Anyone submitting an order should also subscribe to the
                      various market data and event feeds, or call 
                    marks: []
                  - object: leaf
                    text: GetOpenOrders
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' or '
                    marks: []
                  - object: leaf
                    text: GetOrderStatus
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' to monitor the status of the order. If the order is not in a state to be executed, '
                    marks: []
                  - object: leaf
                    text: GetOpenOrders
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' will not return it.'
                    marks: []
                key: qbDphaezA9hY
            key: lfne5e2tHpUT
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      A user with NotbankTrading permission can only create an
                      order for accounts with which he/she is associated to.
                    marks: []
                key: lJskPbQ5L7Vm
            key: 93ifgJgwy88b
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Note:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Call Type is asynchronous..'
                    marks: []
                key: NtAQdyCVgOhL
            key: FnpKJMvcqHbS
        key: cAQ2yyXVnkvS
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Asynchronous</p><p>Creates an order.</p><p>Anyone
        submitting an order should also subscribe to the various market data and
        event feeds, or call <strong>GetOpenOrders</strong> or
        <strong>GetOrderStatus</strong> to monitor the status of the order. If
        the order is not in a state to be executed,
        <strong>GetOpenOrders</strong> will not return it.</p><p>A user with
        NotbankTrading permission can only create an order for accounts with
        which he/she is associated to.</p><p><strong>Note:</strong> Call Type is
        asynchronous..</p>
  /AP/CancelReplaceOrder:
    post:
      tags:
        - Trading
      operationId: CancelReplaceOrder
      description: >-
        **Permissions:** NotbankTrading<br />

        **Call Type:** Asynchronous


        CancelReplaceOrder is a single API method that both cancels an existing
        order and replaces it with a new order. Canceling one order and
        replacing it with another also cancels the order’s priority in the order
        book. You can use [**ModifyOrder**](#operation/ModifyOrder) to preserve
        priority in the book but it only allows a reduction in order quantity.


        <aside class="warning"><strong>Warning:</strong>
        <strong>CancelReplaceOrder</strong> sacrifices the order's priority in
        the order book.</aside>.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelReplaceOrderResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelReplaceOrderRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Asynchronous'
                    marks: []
                key: dTa8cRLQBtcN
            key: ae614gmi8swt
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      CancelReplaceOrder is a single API method that both
                      cancels an existing order and replaces it with a new
                      order. Canceling one order and replacing it with another
                      also cancels the order’s priority in the order book. You
                      can use 
                    marks: []
                  - object: leaf
                    text: ModifyOrder
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' to preserve priority in the book but it only allows a reduction in order quantity.'
                    marks: []
                key: MvROvm8AJkE7
            key: GziKgO8W5oee
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Warning:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' '
                    marks: []
                  - object: leaf
                    text: CancelReplaceOrder
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' sacrifices the order''s priority in the order book..'
                    marks: []
                key: Dpx1GdL6QnD4
            key: kjwc1FLWCr5E
        key: gl2l3tWwK4gj
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Asynchronous</p><p>CancelReplaceOrder is a single API
        method that both cancels an existing order and replaces it with a new
        order. Canceling one order and replacing it with another also cancels
        the order’s priority in the order book. You can use
        <strong>ModifyOrder</strong> to preserve priority in the book but it
        only allows a reduction in order
        quantity.</p><p><strong>Warning:</strong>
        <strong>CancelReplaceOrder</strong> sacrifices the order's priority in
        the order book..</p>
  /AP/CancelOrder:
    post:
      tags:
        - Trading
      operationId: CancelOrder
      description: >-
        **Permissions:** NotbankTrading<br />

        **Call Type:** Synchronous


        Cancels a specific open order that has been placed but has not yet been
        fully executed.


        A user with NotbankTrading permission can only cancel an order for
        accounts with which he/she is associated to.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CancelOrderResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CancelOrderRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: GegpMlGAIkIp
            key: CTzvHZUD65O9
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Cancels a specific open order that has been placed but has
                      not yet been fully executed.
                    marks: []
                key: z2SaIpLs4lnx
            key: kYZQ9jv34JE4
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      A user with NotbankTrading permission can only cancel an
                      order for accounts with which he/she is associated to.
                    marks: []
                key: 9VKnZHZsavI7
            key: xKdsY4wyq4jw
        key: My8qfBKa8NAr
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Cancels a specific open order that has
        been placed but has not yet been fully executed.</p><p>A user with
        NotbankTrading permission can only cancel an order for accounts with
        which he/she is associated to.</p>
  /AP/GetOpenOrders:
    post:
      tags:
        - Trading
      operationId: GetOpenOrders
      description: >-
        **Permissions:** NotbankTrading, NotbankReadOnly<br />

        **Call Type:** Synchronous


        Gets the list of Open Orders of an account, excluding Block Trades and
        Quotes.


        A user with NotbankTrading or NotbankReadOnly permission can only get
        open orders for accounts with which he/she is associated to.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOpenOrdersResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetOpenOrdersRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading, NotbankReadOnly
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: P8ZbHrBjmp3T
            key: 1uwoL0aKB8BX
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets the list of Open Orders of an account, excluding
                      Block Trades and Quotes.
                    marks: []
                key: WfUSLlQnpu1s
            key: nTxllpaFogBL
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      A user with NotbankTrading or NotbankReadOnly permission
                      can only get open orders for accounts with which he/she is
                      associated to.
                    marks: []
                key: TAMBxvQNYLBB
            key: HySglnYoLgn7
        key: 9RZ9kiQ4ZpCO
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading,
        NotbankReadOnly<br><strong>Call Type:</strong> Synchronous</p><p>Gets
        the list of Open Orders of an account, excluding Block Trades and
        Quotes.</p><p>A user with NotbankTrading or NotbankReadOnly permission
        can only get open orders for accounts with which he/she is associated
        to.</p>
  /AP/GetAccountTrades:
    post:
      tags:
        - Trading
      operationId: GetAccountTrades
      description: >-
        **Permissions:** NotbankTrading, NotbankReadOnly<br />

        **Call Type:** Synchronous


        Gets a list of details of up to 200 past trade executions for a single
        specific account and OMS, starting at index _i_, where _i_ is an integer
        identifying a specific execution, and advancing in reverse order; that
        is, the most recent execution has an index of 0, and increments by one
        as trade executions recede into the past.


        A user with NotbankTrading or NotbankReadOnly permission can only access
        trade information for accounts with which he/she is associated to.


        The operator of the trading venue determines how long to retain an
        accessible trading history before archiving.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAccountTradesResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAccountTradesRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading, NotbankReadOnly
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: im5IwrICtfHP
            key: AK40DXotmJzj
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets a list of details of up to 200 past trade executions
                      for a single specific account and OMS, starting at index 
                    marks: []
                  - object: leaf
                    text: i
                    marks:
                      - object: mark
                        type: italic
                        data: {}
                  - object: leaf
                    text: ', where '
                    marks: []
                  - object: leaf
                    text: i
                    marks:
                      - object: mark
                        type: italic
                        data: {}
                  - object: leaf
                    text: ' is an integer identifying a specific execution, and advancing in reverse order; that is, the most recent execution has an index of 0, and increments by one as trade executions recede into the past.'
                    marks: []
                key: jUTjucdruNxl
            key: ZbcLxwaUWILn
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      A user with NotbankTrading or NotbankReadOnly permission
                      can only access trade information for accounts with which
                      he/she is associated to.
                    marks: []
                key: laNZ5LK9L6DT
            key: 1cZUJbf86pVO
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      The operator of the trading venue determines how long to
                      retain an accessible trading history before archiving.
                    marks: []
                key: KVnwnoy1Apj9
            key: 1YDRqvsBbTpn
        key: nliI9WzC1DzX
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading,
        NotbankReadOnly<br><strong>Call Type:</strong> Synchronous</p><p>Gets a
        list of details of up to 200 past trade executions for a single specific
        account and OMS, starting at index <em>i</em>, where <em>i</em> is an
        integer identifying a specific execution, and advancing in reverse
        order; that is, the most recent execution has an index of 0, and
        increments by one as trade executions recede into the past.</p><p>A user
        with NotbankTrading or NotbankReadOnly permission can only access trade
        information for accounts with which he/she is associated to.</p><p>The
        operator of the trading venue determines how long to retain an
        accessible trading history before archiving.</p>
  /AP/Summary:
    post:
      tags:
        - Trading
      operationId: Summary
      description: >-
        **Permissions:** Public<br />

        **Call Type:** Synchronous


        Gets a list of summaries, one for each instrument present in the
        exchange.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SummaryResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SummaryRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       Public
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: sUgiiFQdDTZh
            key: BY5ebcqULOKq
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets a list of summaries, one for each instrument present
                      in the exchange.
                    marks: []
                key: YqqpoPf60our
            key: vmeGNuC5PEWd
        key: BpP4E4IeEXLJ
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> Public<br><strong>Call Type:</strong>
        Synchronous</p><p>Gets a list of summaries, one for each instrument
        present in the exchange.</p>
  /AP/Ticker:
    post:
      tags:
        - Trading
      operationId: Ticker
      description: >-
        **Permissions:** Public<br />

        **Call Type:** Synchronous


        Gets a 24-hour pricing and volume summary for each market pair and each
        market type (spot, perpetuals, physical futures, options) available on
        Notbank for CMC integration.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TickerResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TickerRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       Public
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: JqUNgU2lUQld
            key: NUs5gI0ctey2
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets a 24-hour pricing and volume summary for each market
                      pair and each market type (spot, perpetuals, physical
                      futures, options) available on Notbank for CMC
                      integration.
                    marks: []
                key: BnritktSLg0I
            key: JPuywX8MR83h
        key: XsKoe6wfst9y
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> Public<br><strong>Call Type:</strong>
        Synchronous</p><p>Gets a 24-hour pricing and volume summary for each
        market pair and each market type (spot, perpetuals, physical futures,
        options) available on Notbank for CMC integration.</p>
  /AP/OrderBook:
    post:
      tags:
        - Trading
      operationId: OrderBook
      description: >-
        **Permissions:** Public<br />

        **Call Type:** Synchronous


        Gets the orderbook for the given market pair.


        A level 1 orderbook returns only the best bid and the best ask for a
        market pair (only one level).


        A level 2 orderbook returns as many market levels as defined in the
        **Depth** parameter (bounded by the size of the market).
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OrderBookResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/OrderBookRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       Public
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: hpQ0bZbW4hdm
            key: NPbvQdOcUG32
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Gets the orderbook for the given market pair.
                    marks: []
                key: XG9zfyWF8xiZ
            key: qH34upqJRL2B
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      A level 1 orderbook returns only the best bid and the best
                      ask for a market pair (only one level).
                    marks: []
                key: cL5IJ8pkgrln
            key: GLC4BPJbCSnL
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      A level 2 orderbook returns as many market levels as
                      defined in the 
                    marks: []
                  - object: leaf
                    text: Depth
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' parameter (bounded by the size of the market).'
                    marks: []
                key: Afd739ZkyBnY
            key: ywTVnW4AXFeq
        key: cR9vqM0Sc1f1
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> Public<br><strong>Call Type:</strong>
        Synchronous</p><p>Gets the orderbook for the given market pair.</p><p>A
        level 1 orderbook returns only the best bid and the best ask for a
        market pair (only one level).</p><p>A level 2 orderbook returns as many
        market levels as defined in the <strong>Depth</strong> parameter
        (bounded by the size of the market).</p>
  /AP/Trades:
    post:
      tags:
        - Trading
      operationId: Trades
      description: >-
        **Permissions:** Public<br />

        **Call Type:** Synchronous


        Gets trades for a specific market pair or instrument. Only returns the
        100 most recent trades.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TradesResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TradesRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       Public
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: oa1ZgnfFh7Lr
            key: 6GGJdFdy0dsp
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets trades for a specific market pair or instrument. Only
                      returns the 100 most recent trades.
                    marks: []
                key: np0UN8SKQr5B
            key: 3teZZH3yBruL
        key: eJjeh0gPCVW5
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> Public<br><strong>Call Type:</strong>
        Synchronous</p><p>Gets trades for a specific market pair or instrument.
        Only returns the 100 most recent trades.</p>
  /AP/GetL2Snapshot:
    post:
      tags:
        - Trading
      operationId: GetL2Snapshot
      description: >-
        **Permissions:** Public<br />

        **Call Type:** Synchronous


        Gets the current Level 2 snapshot of a specific instrument. 


        A level 2 snapshot returns as many market levels as defined in the
        **Depth** parameter (bounded by the size of the market).
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetL2SnapshotResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetL2SnapshotRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       Public
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: IlACbVgI4xPQ
            key: AEGoofx8oo80
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets the current Level 2 snapshot of a specific
                      instrument.
                    marks: []
                key: yOjEpHnOlwSv
            key: kR0QUymJwhQ4
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      A level 2 snapshot returns as many market levels as
                      defined in the 
                    marks: []
                  - object: leaf
                    text: Depth
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' parameter (bounded by the size of the market).'
                    marks: []
                key: ZPn7hIZLZatF
            key: AKD5RWWlmJZ9
        key: eHSfEogIPdnW
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> Public<br><strong>Call Type:</strong>
        Synchronous</p><p>Gets the current Level 2 snapshot of a specific
        instrument.</p><p>A level 2 snapshot returns as many market levels as
        defined in the <strong>Depth</strong> parameter (bounded by the size of
        the market).</p>
  /AP/GetLevel1:
    post:
      tags:
        - Trading
      operationId: GetLevel1
      description: >-
        **Permissions:** NotbankTrading, Public<br />

        **Call Type:** Synchronous


        Gets the current Level 1 snapshot (best bid, best offer and other data
        such last traded price) of a specific instrument.


        The Level 1 snapshot is always of market depth 1.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetLevel1Response'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetLevel1Request'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading, Public
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: 2oF54ExxI3DY
            key: 2nffa9kdUKLj
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets the current Level 1 snapshot (best bid, best offer
                      and other data such last traded price) of a specific
                      instrument.
                    marks: []
                key: 2Z57frPFijio
            key: L1Ijfqaa3Yim
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: The Level 1 snapshot is always of market depth 1.
                    marks: []
                key: zxzJI3WN5nrv
            key: lusggg4XP5B1
        key: Ig8wlkJdL4J8
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading, Public<br><strong>Call
        Type:</strong> Synchronous</p><p>Gets the current Level 1 snapshot (best
        bid, best offer and other data such last traded price) of a specific
        instrument.</p><p>The Level 1 snapshot is always of market depth 1.</p>
  /AP/GetEnums:
    post:
      tags:
        - Trading
      operationId: GetEnums
      description: >-
        **Permissions:** Public<br />

        **Call Type:** Synchronous


        Gets a list of enumeration definitions of the fields of orders (such as
        OrderState or TimeInForce).
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEnumsResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetEnumsRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       Public
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: VwfT5SLI0sRn
            key: J1sKEMlko7Q4
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets a list of enumeration definitions of the fields of
                      orders (such as OrderState or TimeInForce).
                    marks: []
                key: UqLhCf9eBHlg
            key: kr8t4IXYbZIS
        key: 623AXESsn1zk
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> Public<br><strong>Call Type:</strong>
        Synchronous</p><p>Gets a list of enumeration definitions of the fields
        of orders (such as OrderState or TimeInForce).</p>
  /AP/GetUserAccounts:
    post:
      tags:
        - User
      operationId: GetUserAccounts
      description: >-
        **Permissions:** NotbankTrading, NotbankReadOnly<br />

        **Call Type:** Synchronous


        Gets the list of account Ids associated with a given user. More than one
        user may be associated with a given account.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUserAccountsResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetUserAccountsRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading, NotbankReadOnly
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: BHpjR3rJE3YZ
            key: sP0In0UK2nXG
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets the list of account Ids associated with a given user.
                      More than one user may be associated with a given account.
                    marks: []
                key: QUrWRjVsYjOw
            key: 24FrbTA7GQIc
        key: kYAzTsCkPGw5
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading,
        NotbankReadOnly<br><strong>Call Type:</strong> Synchronous</p><p>Gets
        the list of account Ids associated with a given user. More than one user
        may be associated with a given account.</p>
  /AP/GetUserDevices:
    post:
      tags:
        - User
      operationId: GetUserDevices
      description: |-
        **Permissions:** NotbankTrading<br />
        **Call Type:** Synchronous

        Get the list of Registered Devices of a specific user.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetUserDevicesResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetUserDevicesRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: kAUQlTOA7MA3
            key: qFlOXaYQNqLk
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Get the list of Registered Devices of a specific user.
                    marks: []
                key: WmsVe1L4UOON
            key: 7X7dqSv7jVBy
        key: T8Sp4FOiqaLQ
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Get the list of Registered Devices of a
        specific user.</p>
  /api/nb/banks:
    get:
      tags:
        - Wallet
      operationId: GetBanks
      description: |-
        **Permissions:** NotbankDeposit, NotbankWithdraw, NotbankReadOnly<br />
        **Call Type:** Synchronous

        Gets the list of banks supported on the platform.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetBanksResponse'
      parameters:
        - name: country
          description: Country code in ISO 3166-1 alpha-2 format.
          required: true
          schema:
            type: string
          in: query
          x-gitbook-description-html: <p>Country code in ISO 3166-1 alpha-2 format.</p>
        - name: page
          description: Page number. Default is _1_.
          required: false
          schema:
            type: string
            default: 1
          in: query
          x-gitbook-description-html: <p>Page number. Default is <em>1</em>.</p>
        - name: page_size
          description: Number of elements per page. Default is _10_.
          required: false
          schema:
            type: string
            default: 10
          in: query
          x-gitbook-description-html: <p>Number of elements per page. Default is <em>10</em>.</p>
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankDeposit, NotbankWithdraw, NotbankReadOnly
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: Z7PiTLKMYyKw
            key: pcyz8Ga0YDjq
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Gets the list of banks supported on the platform.
                    marks: []
                key: Y52Gl6IqiX1h
            key: 5MOfb9eBWl8d
        key: 3epZUFNPzu2v
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankDeposit, NotbankWithdraw,
        NotbankReadOnly<br><strong>Call Type:</strong> Synchronous</p><p>Gets
        the list of banks supported on the platform.</p>
  /api/nb/provinces:
    get:
      tags:
        - Wallet
      operationId: GetProvinces
      description: |-
        **Permissions:** NotbankReadOnly<br />
        **Call Type:** Synchronous

        Gets the list of provinces supported on the platform.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetProvincesResponse'
      parameters:
        - name: country
          description: Country code in ISO 3166-1 alpha-2 format.
          required: true
          schema:
            type: string
          in: query
          x-gitbook-description-html: <p>Country code in ISO 3166-1 alpha-2 format.</p>
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankReadOnly
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: 4bCe2zx92Lut
            key: D1NWFBZbmRs6
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Gets the list of provinces supported on the platform.
                    marks: []
                key: aht6p1HjvbJe
            key: HlQs5VNEo58G
        key: jqoABhVYYgNu
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankReadOnly<br><strong>Call
        Type:</strong> Synchronous</p><p>Gets the list of provinces supported on
        the platform.</p>
  /api/nb/bank-accounts:
    post:
      tags:
        - Wallet
      operationId: AddClientBankAccount
      description: >-
        **Permissions:** NotbankDeposit, NotbankWithdraw<br />

        **Call Type:** Synchronous


        Adds an existing bank account. 


        Once added, a bank account can be used as the source of deposits and the
        target of withdrawals to and from Notbank.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddClientBankAccountResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddClientBankAccountRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankDeposit, NotbankWithdraw
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: PEpS4Vl3CuCY
            key: uaybWSVgrkgm
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Adds an existing bank account.
                    marks: []
                key: rnWnA9edXneq
            key: r6PGhx4j92ed
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Once added, a bank account can be used as the source of
                      deposits and the target of withdrawals to and from
                      Notbank.
                    marks: []
                key: 6RCXnpE7tbie
            key: vUA1ZirFujUv
        key: 3IDqP7OlkRPd
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankDeposit,
        NotbankWithdraw<br><strong>Call Type:</strong> Synchronous</p><p>Adds an
        existing bank account.</p><p>Once added, a bank account can be used as
        the source of deposits and the target of withdrawals to and from
        Notbank.</p>
    get:
      tags:
        - Wallet
      operationId: GetClientBankAccounts
      description: >-
        **Permissions:** NotbankDeposit, NotbankWithdraw, NotbankReadOnly<br />

        **Call Type:** Synchronous


        Gets the list of bank accounts of the user.


        A bank account can be used as the source of deposits and the target of
        withdrawals to and from Notbank.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetClientBankAccountsResponse'
      parameters:
        - name: page
          description: Page number. Default is _1_.
          required: false
          schema:
            type: string
            default: 1
          in: query
          x-gitbook-description-html: <p>Page number. Default is <em>1</em>.</p>
        - name: page_size
          description: Number of elements per page. Default is _10_.
          required: false
          schema:
            type: string
            default: 10
          in: query
          x-gitbook-description-html: <p>Number of elements per page. Default is <em>10</em>.</p>
        - name: user_id
          description: >-
            If the process is being made for a managed user, then this is the
            user id of the managed user.
          required: false
          schema:
            type: string
          in: query
          x-gitbook-description-html: >-
            <p>If the process is being made for a managed user, then this is the
            user id of the managed user.</p>
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankDeposit, NotbankWithdraw, NotbankReadOnly
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: xBAsfb30DfxM
            key: Gx3pXjzrBFBi
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Gets the list of bank accounts of the user.
                    marks: []
                key: pgyDQvNnJNGl
            key: Bqkm5lZcB2o2
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      A bank account can be used as the source of deposits and
                      the target of withdrawals to and from Notbank.
                    marks: []
                key: IDW8lIT126Cq
            key: LtCjlFXtfJcc
        key: nbwlXyEnLfNQ
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankDeposit, NotbankWithdraw,
        NotbankReadOnly<br><strong>Call Type:</strong> Synchronous</p><p>Gets
        the list of bank accounts of the user.</p><p>A bank account can be used
        as the source of deposits and the target of withdrawals to and from
        Notbank.</p>
  /api/nb/bank-accounts/{id}:
    parameters:
      - name: id
        in: path
        required: true
        description: The bank account identifier.
        x-gitbook-description-html: <p>The bank account identifier.</p>
    get:
      tags:
        - Wallet
      operationId: GetClientBankAccount
      description: >-
        **Permissions:** NotbankDeposit, NotbankWithdraw, NotbankReadOnly<br />

        **Call Type:** Synchronous


        Gets bank account details for the specified bank. 


        A bank account can be used as the source of deposits and the target of
        withdrawals to and from Notbank.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetClientBankAccountResponse'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankDeposit, NotbankWithdraw, NotbankReadOnly
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: x399l9U7Ldfl
            key: gzn5JQ9I1izL
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Gets bank account details for the specified bank.
                    marks: []
                key: aNoLnd2qSwEA
            key: GKznfhhNXibR
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      A bank account can be used as the source of deposits and
                      the target of withdrawals to and from Notbank.
                    marks: []
                key: 8tM3hyD1Eah5
            key: 7xLzGSTsTLDt
        key: Eg0HzYS1OQZv
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankDeposit, NotbankWithdraw,
        NotbankReadOnly<br><strong>Call Type:</strong> Synchronous</p><p>Gets
        bank account details for the specified bank.</p><p>A bank account can be
        used as the source of deposits and the target of withdrawals to and from
        Notbank.</p>
    delete:
      tags:
        - Wallet
      operationId: DeleteClientBankAccount
      description: |-
        **Permissions:** NotbankDeposit, NotbankWithdraw<br />
        **Call Type:** Synchronous

        Deletes a bank account.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteClientBankAccountResponse'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankDeposit, NotbankWithdraw
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: lMxeAYdzkdga
            key: 65KfpYkyVryx
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Deletes a bank account.
                    marks: []
                key: UONs7FNFc1FY
            key: gpCFljS2mPip
        key: VTVsg6ziZb9i
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankDeposit,
        NotbankWithdraw<br><strong>Call Type:</strong> Synchronous</p><p>Deletes
        a bank account.</p>
  /api/nb/wallet/crypto/withdrawal/templates:
    get:
      tags:
        - Wallet
      operationId: GetNetworksTemplates
      description: >-
        **Permissions:** NotbankDeposit, NotbankWithdraw, NotbankReadOnly<br />

        **Call Type:** Synchronous


        Gets a list of cryptocurrency-supported networks and the parameters
        required to notify withdrawals.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetNetworksTemplatesResponse'
      parameters:
        - name: currency
          description: Currency (Product) identifier.
          required: true
          schema:
            type: string
          in: query
          x-gitbook-description-html: <p>Currency (Product) identifier.</p>
        - name: network
          description: Currency (Product) network identifier.
          required: false
          schema:
            type: string
          in: query
          x-gitbook-description-html: <p>Currency (Product) network identifier.</p>
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankDeposit, NotbankWithdraw, NotbankReadOnly
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: WkFkb0sAOSVx
            key: zDX38mLrgBUj
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets a list of cryptocurrency-supported networks and the
                      parameters required to notify withdrawals.
                    marks: []
                key: k0byS4hYyfhA
            key: y00URQIqtIOh
        key: TFsh9v3GDK9C
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankDeposit, NotbankWithdraw,
        NotbankReadOnly<br><strong>Call Type:</strong> Synchronous</p><p>Gets a
        list of cryptocurrency-supported networks and the parameters required to
        notify withdrawals.</p>
  /api/nb/wallet/crypto:
    get:
      tags:
        - Wallet
      operationId: GetDepositAddresses
      description: |-
        **Permissions:** NotbankDeposit, NotbankReadOnly<br />
        **Call Type:** Synchronous

        Gets a list of deposit addresses for a currency.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetDepositAddressesResponse'
      parameters:
        - name: account_id
          description: The account identifier.
          required: true
          schema:
            type: integer
          in: query
          x-gitbook-description-html: <p>The account identifier.</p>
        - name: currency
          description: Currency (Product) identifier.
          required: true
          schema:
            type: string
          in: query
          x-gitbook-description-html: <p>Currency (Product) identifier.</p>
        - name: network
          description: Currency (Product) network identifier.
          required: true
          schema:
            type: string
          in: query
          x-gitbook-description-html: <p>Currency (Product) network identifier.</p>
        - name: user_id
          description: >-
            If the process is being made for a managed user, then this is the
            user id of the managed user.
          required: false
          schema:
            type: string
          in: query
          x-gitbook-description-html: >-
            <p>If the process is being made for a managed user, then this is the
            user id of the managed user.</p>
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankDeposit, NotbankReadOnly
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: 90fbrBR3ktxU
            key: Zl1a4GmyMyXL
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Gets a list of deposit addresses for a currency.
                    marks: []
                key: 4azJMIGu7tnV
            key: RcdVzMGZyHqg
        key: 5JoGYXYIzepP
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankDeposit,
        NotbankReadOnly<br><strong>Call Type:</strong> Synchronous</p><p>Gets a
        list of deposit addresses for a currency.</p>
    post:
      tags:
        - Wallet
      operationId: CreateDepositAddress
      description: |-
        **Permissions:** NotbankDeposit<br />
        **Call Type:** Synchronous

        Creates a deposit address.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDepositAddressResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDepositAddressRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankDeposit
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: PNakLRPBnLQn
            key: TO3GajJbHbyw
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Creates a deposit address.
                    marks: []
                key: xg2olkwjjzwf
            key: TWHecOtiPvh9
        key: iguXpGLHQ7Sb
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankDeposit<br><strong>Call
        Type:</strong> Synchronous</p><p>Creates a deposit address.</p>
  /api/nb/wallet/crypto/whitelist-addresses:
    get:
      tags:
        - Wallet
      operationId: GetWhitelistedAddresses
      description: |-
        **Permissions:** NotbankWithdraw<br />
        **Call Type:** Synchronous

        Gets the list of addresses in the whitelist.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetWhitelistedAddressesResponse'
      parameters:
        - name: account_id
          description: The ID of the account for which whitelisted addresses were created.
          required: true
          schema:
            type: integer
          in: query
          x-gitbook-description-html: >-
            <p>The ID of the account for which whitelisted addresses were
            created.</p>
        - name: search
          description: >-
            Filters the addresses by label, currency, or whitelisted address
            identifier.
          required: false
          schema:
            type: string
          in: query
          x-gitbook-description-html: >-
            <p>Filters the addresses by label, currency, or whitelisted address
            identifier.</p>
        - name: user_id
          description: >-
            If the process is being made for a managed user, then this is the
            user id of the managed user.
          required: false
          schema:
            type: string
          in: query
          x-gitbook-description-html: >-
            <p>If the process is being made for a managed user, then this is the
            user id of the managed user.</p>
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankWithdraw
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: wFHcWRJew909
            key: YY2d5H9YSY0y
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Gets the list of addresses in the whitelist.
                    marks: []
                key: FY4WjAyDoT3p
            key: 3TSj2uCimpN1
        key: m6NYjxV0NLXP
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankWithdraw<br><strong>Call
        Type:</strong> Synchronous</p><p>Gets the list of addresses in the
        whitelist.</p>
    post:
      tags:
        - Wallet
      operationId: AddWhitelistedAddress
      description: >-
        **Permissions:** NotbankWithdraw<br />

        **Call Type:** Synchronous


        Adds an address to the whitelist. Withdrawals can only be made to
        addresses that are whitelisted. A code will be sent by email to verify
        the address. To verify the address use the API method
        [**ConfirmWhitelistedAddress**](#operation/ConfirmWhitelistedAddress).
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AddWhitelistedAddressResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AddWhitelistedAddressRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankWithdraw
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: B0ES5f3KlPDO
            key: vopWGvfBkGoM
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Adds an address to the whitelist. Withdrawals can only be
                      made to addresses that are whitelisted. A code will be
                      sent by email to verify the address. To verify the address
                      use the API method 
                    marks: []
                  - object: leaf
                    text: ConfirmWhitelistedAddress
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: .
                    marks: []
                key: Q2Ao02hTbuKq
            key: nq2oODme1UfU
        key: jUH0nC7Zqi3b
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankWithdraw<br><strong>Call
        Type:</strong> Synchronous</p><p>Adds an address to the whitelist.
        Withdrawals can only be made to addresses that are whitelisted. A code
        will be sent by email to verify the address. To verify the address use
        the API method <strong>ConfirmWhitelistedAddress</strong>.</p>
  /api/nb/wallet/crypto/whitelist-addresses/{id}/verification:
    parameters:
      - name: id
        in: path
        required: true
        description: The whitelisted address identifier.
        x-gitbook-description-html: <p>The whitelisted address identifier.</p>
    post:
      tags:
        - Wallet
      operationId: ConfirmWhitelistedAddress
      description: >-
        **Permissions:** NotbankWithdraw<br />

        **Call Type:** Synchronous


        Confirm the whitelisted address. Required to be able to make withdrawals
        to that address.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfirmWhitelistedAddressResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfirmWhitelistedAddressRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankWithdraw
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: sA80Pi66jjAd
            key: jy1qdRhI35e5
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Confirm the whitelisted address. Required to be able to
                      make withdrawals to that address.
                    marks: []
                key: SAex56faGMGD
            key: GmXuH59AMewP
        key: Y4YT6lnpVW51
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankWithdraw<br><strong>Call
        Type:</strong> Synchronous</p><p>Confirm the whitelisted address.
        Required to be able to make withdrawals to that address.</p>
    get:
      tags:
        - Wallet
      operationId: ResendVerificationCodeWhitelistedAddress
      description: |-
        **Permissions:** NotbankWithdraw<br />
        **Call Type:** Synchronous

        Resends the code to validate the whitelisted address via SMS.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ResendVerificationCodeWhitelistedAddressResponse
      parameters:
        - name: account_id
          description: The account identifier.
          required: true
          schema:
            type: integer
          in: query
          x-gitbook-description-html: <p>The account identifier.</p>
        - name: user_id
          description: >-
            If the process is being made for a managed user, then this is the
            user id of the managed user.
          required: false
          schema:
            type: string
          in: query
          x-gitbook-description-html: >-
            <p>If the process is being made for a managed user, then this is the
            user id of the managed user.</p>
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankWithdraw
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: Fsv1eAja8G9z
            key: 5s8fv0bej2Zu
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Resends the code to validate the whitelisted address via
                      SMS.
                    marks: []
                key: it0CHXA0ULGS
            key: J5oHZIWM4CmL
        key: 6bVTluXMggXn
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankWithdraw<br><strong>Call
        Type:</strong> Synchronous</p><p>Resends the code to validate the
        whitelisted address via SMS.</p>
  /api/nb/wallet/crypto/whitelist-addresses/{id}:
    parameters:
      - name: id
        in: path
        required: true
        description: The whitelisted address identifier.
        x-gitbook-description-html: <p>The whitelisted address identifier.</p>
    delete:
      tags:
        - Wallet
      operationId: DeleteWhitelistedAddress
      description: |-
        **Permissions:** NotbankWithdraw<br />
        **Call Type:** Synchronous

        Removes an address from the whitelist.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteWhitelistedAddressResponse'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankWithdraw
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: DoyJIhS5VV6v
            key: 3lhKhD9duIIm
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Removes an address from the whitelist.
                    marks: []
                key: gpqZPaDlBzfO
            key: ct08SRT0WccB
        key: ZBXgM4lqqRz9
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankWithdraw<br><strong>Call
        Type:</strong> Synchronous</p><p>Removes an address from the
        whitelist.</p>
  /api/nb/wallet/crypto/whitelist-addresses/one-step/status:
    post:
      tags:
        - Wallet
      operationId: UpdateOneStepWithdraw
      description: >-
        **Permissions:** NotbankWithdraw<br />

        **Call Type:** Synchronous


        Updates your settings to **enable** or **disable** two-step
        authentication for cryptocurrency withdrawals. If **disabled**, two-step
        authentication will always be required. If **enabled**, two-step
        authentication will not be required if the amount does not exceed $1.000
        USD. This setting is **disabled** by default.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateOneStepWithdrawResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateOneStepWithdrawRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankWithdraw
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: mP4e7XCGzpRf
            key: 1SYs8pvrKBJd
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Updates your settings to '
                    marks: []
                  - object: leaf
                    text: enable
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' or '
                    marks: []
                  - object: leaf
                    text: disable
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' two-step authentication for cryptocurrency withdrawals. If '
                    marks: []
                  - object: leaf
                    text: disabled
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ', two-step authentication will always be required. If '
                    marks: []
                  - object: leaf
                    text: enabled
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: >-
                      , two-step authentication will not be required if the
                      amount does not exceed $1.000 USD. This setting is 
                    marks: []
                  - object: leaf
                    text: disabled
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' by default.'
                    marks: []
                key: x6dkeTaP222c
            key: aS7alhADwXHE
        key: uO8ltHxGeL8Y
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankWithdraw<br><strong>Call
        Type:</strong> Synchronous</p><p>Updates your settings to
        <strong>enable</strong> or <strong>disable</strong> two-step
        authentication for cryptocurrency withdrawals. If
        <strong>disabled</strong>, two-step authentication will always be
        required. If <strong>enabled</strong>, two-step authentication will not
        be required if the amount does not exceed $1.000 USD. This setting is
        <strong>disabled</strong> by default.</p>
  /api/nb/wallet/crypto/withdrawal:
    post:
      tags:
        - Wallet
      operationId: CreateCryptoWithdraw
      description: >-
        **Permissions:** NotbankWithdraw<br />

        **Call Type:** Synchronous


        Creates a cryptocurrency withdrawal request. Withdrawals are only
        allowed to whitelisted addresses.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCryptoWithdrawResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCryptoWithdrawRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankWithdraw
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: 6TLEKczHxFGV
            key: 31MYgkQaidfn
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Creates a cryptocurrency withdrawal request. Withdrawals
                      are only allowed to whitelisted addresses.
                    marks: []
                key: 9PCJuzuc7WyY
            key: r0RpORGjtAgQ
        key: 0gr8fzE4gM5d
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankWithdraw<br><strong>Call
        Type:</strong> Synchronous</p><p>Creates a cryptocurrency withdrawal
        request. Withdrawals are only allowed to whitelisted addresses.</p>
  /api/nb/wallet/fiat/deposit:
    post:
      tags:
        - Wallet
      operationId: CreateFiatDeposit
      description: |-
        **Permissions:** NotbankDeposit<br />
        **Call Type:** Synchronous

        Creates a deposit request of fiat currency.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateFiatDepositResponse'
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CreateFiatDepositRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankDeposit
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: R2HHlFQ3PGxC
            key: erP4ZgVri6MV
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Creates a deposit request of fiat currency.
                    marks: []
                key: JNyZ3vsUNU1h
            key: eeCd63FCLixj
        key: 2xmbwQdVDG30
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankDeposit<br><strong>Call
        Type:</strong> Synchronous</p><p>Creates a deposit request of fiat
        currency.</p>
  /api/nb/wallet/fiat/withdrawal/owners:
    get:
      tags:
        - Wallet
      operationId: GetOwnersFiatWithdraw
      description: |-
        **Permissions:** NotbankWithdraw<br />
        **Call Type:** Synchronous

        Gets the list of owners of a CBU account.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetOwnersFiatWithdrawResponse'
      parameters:
        - name: cbu
          description: CBU account number to obtain the account owners.
          required: true
          schema:
            type: string
          in: query
          x-gitbook-description-html: <p>CBU account number to obtain the account owners.</p>
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankWithdraw
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: mZl3eS6nKaOu
            key: Qz8yIfIftuPM
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Gets the list of owners of a CBU account.
                    marks: []
                key: YUJQ72iOEYd9
            key: ePDpnDAdVm6O
        key: 8Vmnh6ejtLpH
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankWithdraw<br><strong>Call
        Type:</strong> Synchronous</p><p>Gets the list of owners of a CBU
        account.</p>
  /api/nb/wallet/fiat/withdrawal:
    post:
      tags:
        - Wallet
      operationId: CreateFiatWithdraw
      description: >-
        **Permissions:** NotbankWithdraw<br />

        **Call Type:** Synchronous


        Creates a withdraw of fiat currency. If the payment method is **1**
        (Bank Transfer) and the currency is **ARS**, before notifying the
        withdrawal, the recipient's data must be obtained with
        [**GetOwnersFiatWithdraw**](#operation/GetOwnersFiatWithdraw) and after
        notifying, the withdrawal must be confirmed with
        [**ConfirmFiatWithdraw**](#operation/ConfirmFiatWithdraw).
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateFiatWithdrawResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFiatWithdrawRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankWithdraw
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: EsFX9QTgnTb5
            key: WmRCOoVz1nLO
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Creates a withdraw of fiat currency. If the payment method
                      is 
                    marks: []
                  - object: leaf
                    text: '1'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' (Bank Transfer) and the currency is '
                    marks: []
                  - object: leaf
                    text: ARS
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: >-
                      , before notifying the withdrawal, the recipient's data
                      must be obtained with 
                    marks: []
                  - object: leaf
                    text: GetOwnersFiatWithdraw
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' and after notifying, the withdrawal must be confirmed with '
                    marks: []
                  - object: leaf
                    text: ConfirmFiatWithdraw
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: .
                    marks: []
                key: D1agq9DrZDcj
            key: amHFmSvyjxxt
        key: 5Nm5WIZ3iyLp
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankWithdraw<br><strong>Call
        Type:</strong> Synchronous</p><p>Creates a withdraw of fiat currency. If
        the payment method is <strong>1</strong> (Bank Transfer) and the
        currency is <strong>ARS</strong>, before notifying the withdrawal, the
        recipient's data must be obtained with
        <strong>GetOwnersFiatWithdraw</strong> and after notifying, the
        withdrawal must be confirmed with
        <strong>ConfirmFiatWithdraw</strong>.</p>
  /api/nb/wallet/fiat/withdrawal/{id}:
    parameters:
      - name: id
        in: path
        required: true
        description: The fiat withdraw identifier.
        x-gitbook-description-html: <p>The fiat withdraw identifier.</p>
    post:
      tags:
        - Wallet
      operationId: ConfirmFiatWithdraw
      description: >-
        **Permissions:** NotbankWithdraw<br />

        **Call Type:** Synchronous


        Confirms a fiat withdraw. Only required if the payment method is **bank
        transfer** and the currency (Product) is **ARS**.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConfirmFiatWithdrawResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ConfirmFiatWithdrawRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankWithdraw
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: vdhD7q3OmQwc
            key: Du9f59m0towd
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Confirms a fiat withdraw. Only required if the payment
                      method is 
                    marks: []
                  - object: leaf
                    text: bank transfer
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' and the currency (Product) is '
                    marks: []
                  - object: leaf
                    text: ARS
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: .
                    marks: []
                key: QG4Pa7lkMaPk
            key: z4i7mKChNHaD
        key: l6i8ZOCCRdlh
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankWithdraw<br><strong>Call
        Type:</strong> Synchronous</p><p>Confirms a fiat withdraw. Only required
        if the payment method is <strong>bank transfer</strong> and the currency
        (Product) is <strong>ARS</strong>.</p>
  /api/nb/wallet/transfer-funds:
    post:
      tags:
        - Wallet
      operationId: TransferFunds
      description: |-
        **Permissions:** NotbankWithdraw<br />
        **Call Type:** Synchronous

        Transfers funds (balances, positions) from one account to another.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TransferFundsResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TransferFundsRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankWithdraw
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: xgxymu07ayJq
            key: Dr0wIOAZUPp8
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Transfers funds (balances, positions) from one account to
                      another.
                    marks: []
                key: HP1heZuWzlMx
            key: r7JsiBopvxHp
        key: bQUSakYzAXLE
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankWithdraw<br><strong>Call
        Type:</strong> Synchronous</p><p>Transfers funds (balances, positions)
        from one account to another.</p>
  /api/nb/wallet/transactions:
    get:
      tags:
        - Wallet
      operationId: GetTransactions
      description: >-
        **Permissions:** NotbankReadOnly, NotbankDeposit, NotbankWithdraw,
        NotbankTrading<br />

        **Call Type:** Synchronous


        Gets the list of historical transactions of the user.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTransactionsResponse'
      parameters:
        - name: from_date
          description: >-
            The oldest date from which the transaction history will begin. The
            supported format is DD/MM/YYYY.
          required: false
          schema:
            type: string
          in: query
          x-gitbook-description-html: >-
            <p>The oldest date from which the transaction history will begin.
            The supported format is DD/MM/YYYY.</p>
        - name: to_date
          description: >-
            The most recent date on which the transaction history will end. The
            supported format is DD/MM/YYYY.
          required: false
          schema:
            type: string
          in: query
          x-gitbook-description-html: >-
            <p>The most recent date on which the transaction history will end.
            The supported format is DD/MM/YYYY.</p>
        - name: sort
          description: 'History sorting. One of: **ASC**, **DESC**. Default is **DESC**.'
          required: false
          schema:
            type: string
            enum:
              - ASC
              - DESC
            default: DESC
          in: query
          x-gitbook-description-html: >-
            <p>History sorting. One of: <strong>ASC</strong>,
            <strong>DESC</strong>. Default is <strong>DESC</strong>.</p>
        - name: currency
          description: Transaction history currency.
          required: false
          schema:
            type: string
          in: query
          x-gitbook-description-html: <p>Transaction history currency.</p>
        - name: page
          description: Page numbre of the transaction history. Default is _1_.
          required: false
          schema:
            type: integer
            default: 1
          in: query
          x-gitbook-description-html: >-
            <p>Page numbre of the transaction history. Default is
            <em>1</em>.</p>
        - name: page_size
          description: Number of transactions per page. Default is _10_.
          required: false
          schema:
            type: integer
            default: 10
          in: query
          x-gitbook-description-html: <p>Number of transactions per page. Default is <em>10</em>.</p>
        - name: user_id
          description: >-
            If the process is being made for a managed user, then this is the
            user id of the managed user.
          required: false
          schema:
            type: string
          in: query
          x-gitbook-description-html: >-
            <p>If the process is being made for a managed user, then this is the
            user id of the managed user.</p>
        - name: account_id
          description: >-
            Can be used to filter results. If set, only transactions for the
            specific account id will be returned, else, all transactions
            regardless of the account (of the user) will be returned.
          required: false
          schema:
            type: string
          in: query
          x-gitbook-description-html: >-
            <p>Can be used to filter results. If set, only transactions for the
            specific account id will be returned, else, all transactions
            regardless of the account (of the user) will be returned.</p>
        - name: type
          description: >-
            Can be used to filter results. If set, only transactions with the
            specific type specified will be returned, else, all transactions
            regardless of the type will be returned. One of: **0** OTHER, **1**
            DEPOSIT, **2** WITHDRAW, **3** TRANSFER, **4** TRADE, **5** PAYMENT,
            **6** RECTIFICATION, **7** FEE, **8** REVERSE, **9** HOLD, **10**
            MARGIN, **11** AIRDROP, **12** DISTRIBUTION.
          required: false
          schema:
            type: integer
            enum:
              - 0
              - 1
              - 2
              - 3
              - 4
              - 5
              - 6
              - 7
              - 8
              - 9
              - 10
              - 11
              - 12
          in: query
          x-gitbook-description-html: >-
            <p>Can be used to filter results. If set, only transactions with the
            specific type specified will be returned, else, all transactions
            regardless of the type will be returned. One of: <strong>0</strong>
            OTHER, <strong>1</strong> DEPOSIT, <strong>2</strong> WITHDRAW,
            <strong>3</strong> TRANSFER, <strong>4</strong> TRADE,
            <strong>5</strong> PAYMENT, <strong>6</strong> RECTIFICATION,
            <strong>7</strong> FEE, <strong>8</strong> REVERSE,
            <strong>9</strong> HOLD, <strong>10</strong> MARGIN,
            <strong>11</strong> AIRDROP, <strong>12</strong> DISTRIBUTION.</p>
        - name: sub_type
          description: >-
            Can be used to filter results. If set, only transactions with the
            specific sub type specified will be returned, else, all transactions
            regardless of the sub type will be returned. One of: **0** OTHER,
            **1** PAYOUT, **2** PAYIN, **3** DEPOSIT, **4** WITHDRAW, **5**
            BANK_TO_EXCHANGE, **6** EXCHANGE_TO_BANK, **7** TRADE, **8**
            PAYMENT, **9** SIMPLE, **10** RECTIFICATION, **11** TRANSFER, **12**
            HOLD, **13** MARGIN, **14** AIRDROP, **15** ORDER, **16**
            DISTRIBUTION_ENTRY.
          required: false
          schema:
            type: integer
            enum:
              - 0
              - 1
              - 2
              - 3
              - 4
              - 5
              - 6
              - 7
              - 8
              - 9
              - 10
              - 11
              - 12
              - 13
              - 14
              - 15
              - 16
          in: query
          x-gitbook-description-html: >-
            <p>Can be used to filter results. If set, only transactions with the
            specific sub type specified will be returned, else, all transactions
            regardless of the sub type will be returned. One of:
            <strong>0</strong> OTHER, <strong>1</strong> PAYOUT,
            <strong>2</strong> PAYIN, <strong>3</strong> DEPOSIT,
            <strong>4</strong> WITHDRAW, <strong>5</strong> BANK_TO_EXCHANGE,
            <strong>6</strong> EXCHANGE_TO_BANK, <strong>7</strong> TRADE,
            <strong>8</strong> PAYMENT, <strong>9</strong> SIMPLE,
            <strong>10</strong> RECTIFICATION, <strong>11</strong> TRANSFER,
            <strong>12</strong> HOLD, <strong>13</strong> MARGIN,
            <strong>14</strong> AIRDROP, <strong>15</strong> ORDER,
            <strong>16</strong> DISTRIBUTION_ENTRY.</p>
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankReadOnly, NotbankDeposit, NotbankWithdraw, NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: NveodMqYJO7Y
            key: 5U3h49Ezfp2X
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Gets the list of historical transactions of the user.
                    marks: []
                key: kjXKZzTjfLGz
            key: hfzpClggzY01
        key: 2lnS7XxswtNi
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankReadOnly, NotbankDeposit,
        NotbankWithdraw, NotbankTrading<br><strong>Call Type:</strong>
        Synchronous</p><p>Gets the list of historical transactions of the
        user.</p>
  /api/nb/quotes:
    get:
      tags:
        - Quote
      operationId: GetQuotes
      description: >-
        **Permissions:** NotbankTrading, NotbankReadOnly<br />

        **Call Type:** Synchronous


        Gets a list of simple purchase, sale or conversion operations, inverse
        or direct.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetQuotesResponse'
      parameters:
        - name: mode
          description: 'Simple operation mode. One of: **direct**, **inverse**.'
          required: false
          schema:
            type: string
            enum:
              - direct
              - inverse
          in: query
          x-gitbook-description-html: >-
            <p>Simple operation mode. One of: <strong>direct</strong>,
            <strong>inverse</strong>.</p>
        - name: user_id
          description: >-
            If the process is being made for a managed user, then this is the
            user id of the managed user.
          required: false
          schema:
            type: string
          in: query
          x-gitbook-description-html: >-
            <p>If the process is being made for a managed user, then this is the
            user id of the managed user.</p>
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading, NotbankReadOnly
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: dYtqydPex31g
            key: MeA4ES1NgiuW
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets a list of simple purchase, sale or conversion
                      operations, inverse or direct.
                    marks: []
                key: W8tSC3yyFfxz
            key: iRbM7eAbc1Fh
        key: zg9MMVWGLbek
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading,
        NotbankReadOnly<br><strong>Call Type:</strong> Synchronous</p><p>Gets a
        list of simple purchase, sale or conversion operations, inverse or
        direct.</p>
  /api/nb/quotes/direct:
    post:
      tags:
        - Quote
      operationId: CreateDirectQuote
      description: |-
        **Permissions:** NotbankTrading<br />
        **Call Type:** Synchronous

        Requests the creation of a direct Simple operation.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateDirectQuoteResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateDirectQuoteRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: o1Bh29y9X6gU
            key: hcoc9SHS1mYj
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Requests the creation of a direct Simple operation.
                    marks: []
                key: l5FGyQP3zVA7
            key: 6JQSSCZr00VR
        key: f0fZDlq0fBE7
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Requests the creation of a direct
        Simple operation.</p>
  /api/nb/quotes/inverse:
    post:
      tags:
        - Quote
      operationId: CreateInverseQuote
      description: |-
        **Permissions:** NotbankTrading<br />
        **Call Type:** Synchronous

        Requests the creation of a inverse Simple operation.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateInverseQuoteResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateInverseQuoteRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: 21rqIqIa09eT
            key: 61j247Z0IfVl
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Requests the creation of a inverse Simple operation.
                    marks: []
                key: 4DIZnqBDfBMI
            key: mmDDkvPaTuDJ
        key: YhDDwYZj2jdj
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Synchronous</p><p>Requests the creation of a inverse
        Simple operation.</p>
  /api/nb/quotes/{id}:
    parameters:
      - name: id
        in: path
        required: true
        description: The Simple operation identifier.
        x-gitbook-description-html: <p>The Simple operation identifier.</p>
    get:
      tags:
        - Quote
      operationId: GetQuote
      description: |-
        **Permissions:** NotbankTrading, NotbankReadOnly<br />
        **Call Type:** Synchronous

        Gets the details of a Simple operation.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetQuoteResponse'
      parameters:
        - name: quote_id
          description: The Simple operation identifier.
          required: true
          schema:
            type: string
          in: query
          x-gitbook-description-html: <p>The Simple operation identifier.</p>
        - name: user_id
          description: >-
            If the process is being made for a managed user, then this is the
            user id of the managed user.
          required: false
          schema:
            type: string
          in: query
          x-gitbook-description-html: >-
            <p>If the process is being made for a managed user, then this is the
            user id of the managed user.</p>
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading, NotbankReadOnly
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: WlTvj2HlleMb
            key: XWtZ2IF1btew
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Gets the details of a Simple operation.
                    marks: []
                key: TGpuZ7jRcV19
            key: 7IAhmDpNyAMN
        key: p5p8UaG2AVvR
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading,
        NotbankReadOnly<br><strong>Call Type:</strong> Synchronous</p><p>Gets
        the details of a Simple operation.</p>
    post:
      tags:
        - Quote
      operationId: ExecuteQuote
      description: >-
        **Permissions:** NotbankTrading<br />

        **Call Type:** Asynchronous


        Executes a Simple operation. Execution is asynchronous, so the
        [**GetQuote**](#operation/GetQuote) endpoint must be used to determine
        the final status of the operation.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExecuteQuoteResponse'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Asynchronous'
                    marks: []
                key: h5vPFGlsfuxM
            key: JWVQSZPtxjVl
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Executes a Simple operation. Execution is asynchronous, so
                      the 
                    marks: []
                  - object: leaf
                    text: GetQuote
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' endpoint must be used to determine the final status of the operation.'
                    marks: []
                key: 4Yt0M3e72e9R
            key: ID27JiMtis7C
        key: FE1KrFmfopN1
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankTrading<br><strong>Call
        Type:</strong> Asynchronous</p><p>Executes a Simple operation. Execution
        is asynchronous, so the <strong>GetQuote</strong> endpoint must be used
        to determine the final status of the operation.</p>
  /api/nb/account/verification/basic:
    post:
      tags:
        - Verification
      operationId: VerifyBasic
      description: |-
        **Permissions:** NotbankDeposit, NotbankWithdraw, NotbankTrading<br />
        **Call Type:** Synchronous

        Verifies the user to basic level.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerifyBasicResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VerifyBasicRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankDeposit, NotbankWithdraw, NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: LzShbYwRjm3a
            key: 16AqSdobsuUw
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Verifies the user to basic level.
                    marks: []
                key: oxDrCF2u3BeW
            key: Xqz7dXNdcGnk
        key: 6QsTN2vTtMbR
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankDeposit, NotbankWithdraw,
        NotbankTrading<br><strong>Call Type:</strong> Synchronous</p><p>Verifies
        the user to basic level.</p>
  /api/nb/account/verification/trader:
    post:
      tags:
        - Verification
      operationId: VerifyTrader
      description: >-
        **Permissions:** NotbankDeposit, NotbankWithdraw, NotbankTrading<br />

        **Call Type:** Asynchronous


        Verifies the user to trader level.


        <aside class="notice"><strong>Note: </strong>Request must be sent as
        "multipart/form-data".</aside>.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerifyTraderResponse'
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/VerifyTraderRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankDeposit, NotbankWithdraw, NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Asynchronous'
                    marks: []
                key: rdd70cWQFwwx
            key: f38fHaoe4ZBV
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Verifies the user to trader level.
                    marks: []
                key: LsxoN1pyn3XT
            key: pc8WbbKmB0VI
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Note: '
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: Request must be sent as "multipart/form-data"..
                    marks: []
                key: 4po0W9XYKx9E
            key: dXxQgj6G9LB8
        key: 63bHU3ZHDpHw
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankDeposit, NotbankWithdraw,
        NotbankTrading<br><strong>Call Type:</strong>
        Asynchronous</p><p>Verifies the user to trader
        level.</p><p><strong>Note:</strong> Request must be sent as
        "multipart/form-data"..</p>
  /api/nb/account/verification/trader-plus/schemas&country=AR:
    get:
      tags:
        - Verification
      operationId: GetTraderPlusVerificationSchemas
      description: >-
        **Permissions:** NotbankDeposit, NotbankWithdraw, NotbankTrading<br />

        **Call Type:** Synchronous


        Gets the information schemas required to be filled by the user to be
        verified up to trader plus.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTraderPlusVerificationSchemasResponse'
      parameters:
        - name: country
          description: Country of residence, given by the ISO 3166-1 alpha-2 standard.
          required: true
          schema:
            type: string
          in: query
          x-gitbook-description-html: >-
            <p>Country of residence, given by the ISO 3166-1 alpha-2
            standard.</p>
        - name: user_id
          description: >-
            If the process is being made for a managed user, then this is the
            user id of the managed user.
          required: false
          schema:
            type: string
          in: query
          x-gitbook-description-html: >-
            <p>If the process is being made for a managed user, then this is the
            user id of the managed user.</p>
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankDeposit, NotbankWithdraw, NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: hE6id2Kfn07r
            key: OlqtKiv1tNoZ
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets the information schemas required to be filled by the
                      user to be verified up to trader plus.
                    marks: []
                key: gPcMzAGuvvCJ
            key: OdsQR2SLtoz2
        key: IuOSp6ROM0IZ
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankDeposit, NotbankWithdraw,
        NotbankTrading<br><strong>Call Type:</strong> Synchronous</p><p>Gets the
        information schemas required to be filled by the user to be verified up
        to trader plus.</p>
  /api/nb/account/verification/trader-plus:
    post:
      tags:
        - Verification
      operationId: VerifyTraderPlus
      description: >-
        **Permissions:** NotbankDeposit, NotbankWithdraw, NotbankTrading<br />

        **Call Type:** Asynchronous


        Verifies the user to trader plus level.


        <aside class="notice"><strong>Note: </strong>Request must be sent as
        "multipart/form-data".</aside>


        `declaration_template_id` and `declaration_id` are present at the top
        level on the schema object (with the former as `template_id`).


        Only one object from the list of questions is required to be answered
        and sent. And the corresponding data to be sent in the form is on the
        fields inside the object
        `schema["data"]["questions"][idx]["properties"]`. The field names needed
        to be used are the corresponding values at
        `schema["data"]["questions"][idx]["properties"][*]["inputName"|"fileName"]`,
        where `idx` is an index on the array, and `*` represents a key for each
        entry of the `properties` object, and either `inputName` or `fileName`,
        depending if the field is a file or not.


        Schemas for this method are given by the endpoint
        [**GetTraderPlusVerificationSchema**](#GetTraderPlusVerificationSchema).
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerifyTraderPlusResponse'
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/VerifyTraderPlusRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankDeposit, NotbankWithdraw, NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Asynchronous'
                    marks: []
                key: kl5m4yICUiZi
            key: JDREkgusQRyv
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Verifies the user to trader plus level.
                    marks: []
                key: bvZxroen792v
            key: 2RhsYNWHZsCe
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Note: '
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: Request must be sent as "multipart/form-data".
                    marks: []
                key: j6BjFdwWd4vk
            key: bXMUG8uCMgHx
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: declaration_template_id
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: ' and '
                    marks: []
                  - object: leaf
                    text: declaration_id
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: ' are present at the top level on the schema object (with the former as '
                    marks: []
                  - object: leaf
                    text: template_id
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: ).
                    marks: []
                key: MdRLvu4QYUAO
            key: O7HgHMNSmS0w
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Only one object from the list of questions is required to
                      be answered and sent. And the corresponding data to be
                      sent in the form is on the fields inside the object 
                    marks: []
                  - object: leaf
                    text: schema["data"]["questions"][idx]["properties"]
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: >-
                      . The field names needed to be used are the corresponding
                      values at 
                    marks: []
                  - object: leaf
                    text: >-
                      schema["data"]["questions"][idx]["properties"][*]["inputName"|"fileName"]
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: ', where '
                    marks: []
                  - object: leaf
                    text: idx
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: ' is an index on the array, and '
                    marks: []
                  - object: leaf
                    text: '*'
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: ' represents a key for each entry of the '
                    marks: []
                  - object: leaf
                    text: properties
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: ' object, and either '
                    marks: []
                  - object: leaf
                    text: inputName
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: ' or '
                    marks: []
                  - object: leaf
                    text: fileName
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: ', depending if the field is a file or not.'
                    marks: []
                key: TnOp3qT7Q3Mi
            key: SCfvc9LGDTKi
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Schemas for this method are given by the endpoint '
                    marks: []
                  - object: leaf
                    text: GetTraderPlusVerificationSchema
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: .
                    marks: []
                key: SAe4lWEm4w4g
            key: 8kdXx1En2eag
        key: pogyTx9hSyoo
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankDeposit, NotbankWithdraw,
        NotbankTrading<br><strong>Call Type:</strong>
        Asynchronous</p><p>Verifies the user to trader plus
        level.</p><p><strong>Note:</strong> Request must be sent as
        "multipart/form-data".</p><p><code>declaration_template_id</code> and
        <code>declaration_id</code> are present at the top level on the schema
        object (with the former as <code>template_id</code>).</p><p>Only one
        object from the list of questions is required to be answered and sent.
        And the corresponding data to be sent in the form is on the fields
        inside the object
        <code>schema["data"]["questions"][idx]["properties"]</code>. The field
        names needed to be used are the corresponding values at
        <code>schema["data"]["questions"][idx]["properties"][*]["inputName"|"fileName"]</code>,
        where <code>idx</code> is an index on the array, and <code>*</code>
        represents a key for each entry of the <code>properties</code> object,
        and either <code>inputName</code> or <code>fileName</code>, depending if
        the field is a file or not.</p><p>Schemas for this method are given by
        the endpoint <strong>GetTraderPlusVerificationSchema</strong>.</p>
  /api/nb/account/verification/institutional/company/schemes:
    get:
      tags:
        - Verification
      operationId: GetInstitutionalCompanySchemas
      description: >-
        **Permissions:** NotbankDeposit, NotbankWithdraw, NotbankTrading<br />

        **Call Type:** Synchronous


        Gets the information schemas required to be filled by the
        institution/company to be verified.


        To get this information, the user must have a verification level of
        basic.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetInstitutionalCompanySchemasResponse'
      parameters:
        - name: country
          description: >-
            Country of the company to be verified as a 2 character
            representation, given by the ISO 3166-1 alpha-2 standard. Examples:
            AR, BR, CL, CO, PE.
          required: true
          schema:
            type: string
          in: query
          x-gitbook-description-html: >-
            <p>Country of the company to be verified as a 2 character
            representation, given by the ISO 3166-1 alpha-2 standard. Examples:
            AR, BR, CL, CO, PE.</p>
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankDeposit, NotbankWithdraw, NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: 8INnVs3bbBJu
            key: 7Y0jDKhndUz1
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets the information schemas required to be filled by the
                      institution/company to be verified.
                    marks: []
                key: rtY5m3IdFL2A
            key: Hp0grTkJaUja
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      To get this information, the user must have a verification
                      level of basic.
                    marks: []
                key: 7daAoGWXpekg
            key: NJSydvYzf1GA
        key: GNHQjmcTEMyW
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankDeposit, NotbankWithdraw,
        NotbankTrading<br><strong>Call Type:</strong> Synchronous</p><p>Gets the
        information schemas required to be filled by the institution/company to
        be verified.</p><p>To get this information, the user must have a
        verification level of basic.</p>
  /api/nb/account/verification/institutional/company:
    post:
      tags:
        - Verification
      operationId: VerifyInstitutionalCompany
      description: >-
        **Permissions:** NotbankDeposit, NotbankWithdraw, NotbankTrading<br />

        **Call Type:** Synchronous


        Verifies an institution/company


        <aside class="notice"><strong>Note: </strong>Request must be sent as
        "multipart/form-data".</aside>


        `declaration_template_id` is present at the top level on the schema
        object as `template_id`.


        `declaration_id` is present at the at the next level as `id`.


        Only one object from the list of questions is required to be answered
        and sent. And the corresponding data to be sent in the form is on the
        fields inside the object
        `schema["data"]["questions"][idx]["properties"]`. The field names needed
        to be used are the corresponding values at
        `schema["data"]["questions"][idx]["properties"][*]["inputName"]`, where
        `idx` is an index on the array, and `*` represents a key for each entry
        of the `properties` object.


        Schemas for this method are given by the endpoint
        [**GetInstitutionalCompanySchemas**](#operation/GetInstitutionalCompanySchemas).
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerifyInstitutionalCompanyResponse'
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/VerifyInstitutionalCompanyRequest'
      parameters:
        - name: declaration_template_id
          description: The id of the schema.
          required: true
          schema:
            type: integer
          in: query
          x-gitbook-description-html: <p>The id of the schema.</p>
        - name: declaration_id
          description: The id of the declaration.
          required: false
          schema:
            type: integer
          in: query
          x-gitbook-description-html: <p>The id of the declaration.</p>
        - name: country
          description: Country of the company, given by the ISO 3166-1 alpha-2 standard.
          required: true
          schema:
            type: string
          in: query
          x-gitbook-description-html: >-
            <p>Country of the company, given by the ISO 3166-1 alpha-2
            standard.</p>
        - name: user_id
          description: >-
            User that will be verifying the company. If not provided, then the
            authenticated user making the method call will be considered.
          required: false
          schema:
            type: string
          in: query
          x-gitbook-description-html: >-
            <p>User that will be verifying the company. If not provided, then
            the authenticated user making the method call will be
            considered.</p>
        - name: '{filed_name}'
          description: >-
            A value required by the schema, its key (*field_key*) is defined in
            the corresponding schema. This endpoint may required many field like
            this. depending on the schema.
          required: true
          schema:
            oneOf:
              - type: integer
              - type: string
              - type: boolean
          in: query
          x-gitbook-description-html: >-
            <p>A value required by the schema, its key (<em>field_key</em>) is
            defined in the corresponding schema. This endpoint may required many
            field like this. depending on the schema.</p>
        - name: '{file_name}'
          description: >-
            A File, the field key (*file_name*) is defined in the corresponding
            schema. This endpoint may require many fields like this, depending
            on the schema.
          required: true
          schema:
            type: string
            format: binary
          in: query
          x-gitbook-description-html: >-
            <p>A File, the field key (<em>file_name</em>) is defined in the
            corresponding schema. This endpoint may require many fields like
            this, depending on the schema.</p>
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankDeposit, NotbankWithdraw, NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: 0N5dvPUOVbpc
            key: ciCRVz3PsiVv
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Verifies an institution/company
                    marks: []
                key: QIBGp6G9Tuu9
            key: oWMs8ulvh2yf
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Note: '
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: Request must be sent as "multipart/form-data".
                    marks: []
                key: rVVyIVdojtFB
            key: oeh3b0Cl26mB
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: declaration_template_id
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: ' is present at the top level on the schema object as '
                    marks: []
                  - object: leaf
                    text: template_id
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: .
                    marks: []
                key: ddKcabOlix3b
            key: 1Wtz2ovKENLj
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: declaration_id
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: ' is present at the at the next level as '
                    marks: []
                  - object: leaf
                    text: id
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: .
                    marks: []
                key: w1A54oEValXq
            key: aCCWawAorAzm
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Only one object from the list of questions is required to
                      be answered and sent. And the corresponding data to be
                      sent in the form is on the fields inside the object 
                    marks: []
                  - object: leaf
                    text: schema["data"]["questions"][idx]["properties"]
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: >-
                      . The field names needed to be used are the corresponding
                      values at 
                    marks: []
                  - object: leaf
                    text: >-
                      schema["data"]["questions"][idx]["properties"][*]["inputName"]
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: ', where '
                    marks: []
                  - object: leaf
                    text: idx
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: ' is an index on the array, and '
                    marks: []
                  - object: leaf
                    text: '*'
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: ' represents a key for each entry of the '
                    marks: []
                  - object: leaf
                    text: properties
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: ' object.'
                    marks: []
                key: uODYw9DufOiZ
            key: 2U2UaiC80UlT
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Schemas for this method are given by the endpoint '
                    marks: []
                  - object: leaf
                    text: GetInstitutionalCompanySchemas
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: .
                    marks: []
                key: 6iqfiqdzLLdR
            key: 9J45T63lz0CJ
        key: qW7Ty2RZw2Mb
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankDeposit, NotbankWithdraw,
        NotbankTrading<br><strong>Call Type:</strong> Synchronous</p><p>Verifies
        an institution/company</p><p><strong>Note:</strong> Request must be sent
        as "multipart/form-data".</p><p><code>declaration_template_id</code> is
        present at the top level on the schema object as
        <code>template_id</code>.</p><p><code>declaration_id</code> is present
        at the at the next level as <code>id</code>.</p><p>Only one object from
        the list of questions is required to be answered and sent. And the
        corresponding data to be sent in the form is on the fields inside the
        object <code>schema["data"]["questions"][idx]["properties"]</code>. The
        field names needed to be used are the corresponding values at
        <code>schema["data"]["questions"][idx]["properties"][*]["inputName"]</code>,
        where <code>idx</code> is an index on the array, and <code>*</code>
        represents a key for each entry of the <code>properties</code>
        object.</p><p>Schemas for this method are given by the endpoint
        <strong>GetInstitutionalCompanySchemas</strong>.</p>
    get:
      tags:
        - Verification
      operationId: GetInstitutionalCompanyVerificationStatus
      description: |-
        **Permissions:** NotbankDeposit, NotbankWithdraw, NotbankTrading<br />
        **Call Type:** Synchronous

        Gets the verification status of an institutional company.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/GetInstitutionalCompanyVerificationStatusResponse
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankDeposit, NotbankWithdraw, NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: MovuI2ba7uoH
            key: yff9KDBTmQ9O
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Gets the verification status of an institutional company.
                    marks: []
                key: isu4ploHPLa4
            key: RHGw7Ddd6OAI
        key: X6wkv8CfTLnW
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankDeposit, NotbankWithdraw,
        NotbankTrading<br><strong>Call Type:</strong> Synchronous</p><p>Gets the
        verification status of an institutional company.</p>
  /api/nb/account/verification/institutional/members/types:
    get:
      tags:
        - Verification
      operationId: GetInstitutionalMemberTypes
      description: |-
        **Permissions:** NotbankDeposit, NotbankWithdraw, NotbankTrading<br />
        **Call Type:** Synchronous

        Gets the institutional member type list, its id and their role.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetInstitutionalMemberTypesResponse'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankDeposit, NotbankWithdraw, NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: BTWiL6VV539b
            key: HvX0ZohF6RPB
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets the institutional member type list, its id and their
                      role.
                    marks: []
                key: VoMZBLeodNfs
            key: ZZhaQQoRtg3q
        key: kzaLPEVusuf4
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankDeposit, NotbankWithdraw,
        NotbankTrading<br><strong>Call Type:</strong> Synchronous</p><p>Gets the
        institutional member type list, its id and their role.</p>
  /api/nb/account/verification/institutional/members/schemas:
    get:
      tags:
        - Verification
      operationId: GetInstitutionalMemberSchemas
      description: >-
        **Permissions:** NotbankDeposit, NotbankWithdraw, NotbankTrading<br />

        **Call Type:** Synchronous


        Gets the schema required to be filled for an member of an institution.
        Schema descriptions will be in the user defined language at the moment
        of register.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetInstitutionalMemberSchemasResponse'
      parameters:
        - name: country
          description: >-
            Country of the company to be verified, given by the ISO 3166-1
            alpha-2 standard.
          required: true
          schema:
            type: string
          in: query
          x-gitbook-description-html: >-
            <p>Country of the company to be verified, given by the ISO 3166-1
            alpha-2 standard.</p>
        - name: member_type
          description: >-
            Member type. One of: **1** Directory, **2** Beneficial owner, **3**
            Legal representative.
          required: true
          schema:
            type: integer
            enum:
              - 1
              - 2
              - 3
          in: query
          x-gitbook-description-html: >-
            <p>Member type. One of: <strong>1</strong> Directory,
            <strong>2</strong> Beneficial owner, <strong>3</strong> Legal
            representative.</p>
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankDeposit, NotbankWithdraw, NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: Eio8tzIfuyUa
            key: HHxsepV8Q8qR
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets the schema required to be filled for an member of an
                      institution. Schema descriptions will be in the user
                      defined language at the moment of register.
                    marks: []
                key: zAUlIekwxJ5e
            key: mzp2j3nBzORV
        key: owAcTDmnl7EC
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankDeposit, NotbankWithdraw,
        NotbankTrading<br><strong>Call Type:</strong> Synchronous</p><p>Gets the
        schema required to be filled for an member of an institution. Schema
        descriptions will be in the user defined language at the moment of
        register.</p>
  /api/nb/account/verification/institutional/members:
    post:
      tags:
        - Verification
      operationId: VerifyInstitutionalMember
      description: >-
        **Permissions:** NotbankDeposit, NotbankWithdraw, NotbankTrading<br />

        **Call Type:** Asynchronous


        Verifies an institutional member.


        <aside class="notice"><strong>Note: </strong>Request must be sent as
        "multipart/form-data".</aside>



        `member_template_id` is present at
        `schema["data"]["member_declaration_templates"][idx]["id"]` where `idx`
        is an index on the array.


        Field names for the schema are the corresponding json keys in the
        properties of the schema.

        Only one object from the list of questions is required to be answered
        and sent. And the corresponding data to be sent in the form is on the
        fields inside the object
        `schema["data"]["member_declaration_templates"][idx_1]["questions"][idx_2]["ui_schema"]["properties"]`
        where `idx_1` and `idx_2` are index of an array. The field names needed
        to be used are the corresponding keys of the object.


        Schemas for this method are given by the endpoint
        [**GetInstitutionalMemberSchemas**](#operation/GetInstitutionalMemberSchemas).
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerifyInstitutionalMemberResponse'
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/VerifyInstitutionalMemberRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankDeposit, NotbankWithdraw, NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Asynchronous'
                    marks: []
                key: 178v6xpyYoGy
            key: mXnIvnBJ7dhn
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Verifies an institutional member.
                    marks: []
                key: MVnmmB2pU0jF
            key: czjyYtwtQDLQ
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Note: '
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: Request must be sent as "multipart/form-data".
                    marks: []
                key: EcdRCRhkYCBm
            key: STW4wMzi3KGK
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: member_template_id
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: ' is present at '
                    marks: []
                  - object: leaf
                    text: schema["data"]["member_declaration_templates"][idx]["id"]
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: ' where '
                    marks: []
                  - object: leaf
                    text: idx
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: ' is an index on the array.'
                    marks: []
                key: vZ7oBRXHYkzf
            key: QAC7PmoKo5QC
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Field names for the schema are the corresponding json keys
                      in the properties of the schema. Only one object from the
                      list of questions is required to be answered and sent. And
                      the corresponding data to be sent in the form is on the
                      fields inside the object 
                    marks: []
                  - object: leaf
                    text: >-
                      schema["data"]["member_declaration_templates"][idx_1]["questions"][idx_2]["ui_schema"]["properties"]
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: ' where '
                    marks: []
                  - object: leaf
                    text: idx_1
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: ' and '
                    marks: []
                  - object: leaf
                    text: idx_2
                    marks:
                      - object: mark
                        type: code
                        data: {}
                  - object: leaf
                    text: ' are index of an array. The field names needed to be used are the corresponding keys of the object.'
                    marks: []
                key: pRunCkQnDDvn
            key: 1HGyFKZ97wLs
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Schemas for this method are given by the endpoint '
                    marks: []
                  - object: leaf
                    text: GetInstitutionalMemberSchemas
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: .
                    marks: []
                key: dCM2etkNusTd
            key: YXMzcHc3Lk4R
        key: XEPD5NzYufas
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankDeposit, NotbankWithdraw,
        NotbankTrading<br><strong>Call Type:</strong>
        Asynchronous</p><p>Verifies an institutional
        member.</p><p><strong>Note:</strong> Request must be sent as
        "multipart/form-data".</p><p><code>member_template_id</code> is present
        at
        <code>schema["data"]["member_declaration_templates"][idx]["id"]</code>
        where <code>idx</code> is an index on the array.</p><p>Field names for
        the schema are the corresponding json keys in the properties of the
        schema. Only one object from the list of questions is required to be
        answered and sent. And the corresponding data to be sent in the form is
        on the fields inside the object
        <code>schema["data"]["member_declaration_templates"][idx_1]["questions"][idx_2]["ui_schema"]["properties"]</code>
        where <code>idx_1</code> and <code>idx_2</code> are index of an array.
        The field names needed to be used are the corresponding keys of the
        object.</p><p>Schemas for this method are given by the endpoint
        <strong>GetInstitutionalMemberSchemas</strong>.</p>
    get:
      tags:
        - Verification
      operationId: GetInstitutionalMemberVerificationStatus
      description: |-
        **Permissions:** NotbankDeposit, NotbankWithdraw, NotbankTrading<br />
        **Call Type:** Synchronous

        Gets the verification status of the institutional member.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/GetInstitutionalMemberVerificationStatusResponse
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankDeposit, NotbankWithdraw, NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: OZy3aXkzyIYQ
            key: RUftPSkXu8wh
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Gets the verification status of the institutional member.
                    marks: []
                key: UA98R5YbyYD0
            key: PmTQCBtER9wa
        key: Md3EoOu17zPS
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankDeposit, NotbankWithdraw,
        NotbankTrading<br><strong>Call Type:</strong> Synchronous</p><p>Gets the
        verification status of the institutional member.</p>
  /api/nb/account/verification/institutional/documents/types:
    get:
      tags:
        - Verification
      operationId: GetInstitutionalDocumentTypes
      description: |-
        **Permissions:** NotbankDeposit, NotbankWithdraw, NotbankTrading<br />
        **Call Type:** Synchronous

        Gets institutional document types.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetInstitutionalDocumentTypesResponse'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankDeposit, NotbankWithdraw, NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: 058pYkj08j2u
            key: Jr4t5SZ8lMSm
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Gets institutional document types.
                    marks: []
                key: 6pf9LJsdbBI0
            key: 91aeYWkI4NN6
        key: rg2OXKpWOPAm
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankDeposit, NotbankWithdraw,
        NotbankTrading<br><strong>Call Type:</strong> Synchronous</p><p>Gets
        institutional document types.</p>
  /api/nb/account/verification/institutional/documents:
    post:
      tags:
        - Verification
      operationId: VerifyInstitutionalDocument
      description: >-
        **Permissions:** NotbankDeposit, NotbankWithdraw, NotbankTrading<br />

        **Call Type:** Synchronous


        Verifies an institutional document.


        <aside class="notice"><strong>Note: </strong>Request must be sent as
        "multipart/form-data".</aside>.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerifyInstitutionalDocumentResponse'
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/VerifyInstitutionalDocumentRequest'
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankDeposit, NotbankWithdraw, NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: eMdl30koKSq9
            key: zLbeEfqnHbgK
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: Verifies an institutional document.
                    marks: []
                key: D0dNJQl0yzJH
            key: dAKNCcuI0KB2
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Note: '
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: Request must be sent as "multipart/form-data"..
                    marks: []
                key: 0cUQvEd8KVfN
            key: lfQvk6rIonRy
        key: LzH7pB2fQhMk
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankDeposit, NotbankWithdraw,
        NotbankTrading<br><strong>Call Type:</strong> Synchronous</p><p>Verifies
        an institutional document.</p><p><strong>Note:</strong> Request must be
        sent as "multipart/form-data"..</p>
    get:
      tags:
        - Verification
      operationId: GetInstitutionalDocumentVerificationStatus
      description: |-
        **Permissions:** NotbankDeposit, NotbankWithdraw, NotbankTrading<br />
        **Call Type:** Synchronous

        Gets the verification status of the institutional document.
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/GetInstitutionalDocumentVerificationStatusResponse
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankDeposit, NotbankWithdraw, NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: c4ac5UXztg53
            key: AKLH9i7g9RZo
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets the verification status of the institutional
                      document.
                    marks: []
                key: P8BeJK7JraI6
            key: ASsODsj8iOai
        key: qWjuQGxSQYam
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankDeposit, NotbankWithdraw,
        NotbankTrading<br><strong>Call Type:</strong> Synchronous</p><p>Gets the
        verification status of the institutional document.</p>
  /api/nb/account/verification/status:
    get:
      tags:
        - Verification
      operationId: GetVerificationStatus
      description: |-
        **Permissions:** NotbankDeposit, NotbankWithdraw, NotbankTrading<br />
        **Call Type:** Synchronous

        Gets the current verification status of the user (or managed user).
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetVerificationStatusResponse'
      parameters:
        - name: user_id
          description: >-
            The ID of the user to get the verification status from. If not
            defined, the verification status is for the authenticated user
            making the call.
          required: false
          schema:
            type: string
          in: query
          x-gitbook-description-html: >-
            <p>The ID of the user to get the verification status from. If not
            defined, the verification status is for the authenticated user
            making the call.</p>
      x-gitbook-description-document:
        object: document
        data:
          schemaVersion: 9
        nodes:
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: 'Permissions:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: |2
                       NotbankDeposit, NotbankWithdraw, NotbankTrading
                    marks: []
                  - object: leaf
                    text: 'Call Type:'
                    marks:
                      - object: mark
                        type: bold
                        data: {}
                  - object: leaf
                    text: ' Synchronous'
                    marks: []
                key: GxR0mr2Yvzft
            key: JJHGcek0xk71
          - object: block
            type: paragraph
            isVoid: false
            data: {}
            nodes:
              - object: text
                leaves:
                  - object: leaf
                    text: >-
                      Gets the current verification status of the user (or
                      managed user).
                    marks: []
                key: lYTp6fjoYXkT
            key: mvAYTRRVTVQL
        key: 7rmEll8JvT9u
      x-gitbook-description-html: >-
        <p><strong>Permissions:</strong> NotbankDeposit, NotbankWithdraw,
        NotbankTrading<br><strong>Call Type:</strong> Synchronous</p><p>Gets the
        current verification status of the user (or managed user).</p>
components:
  securitySchemes:
    defaultApiKey:
      description: API key provided on the authorization method
      type: apiKey
      name: aptoken
      in: header
      x-gitbook-description-html: <p>API key provided on the authorization method</p>
  schemas:
    GetAccountTransactionsRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: >-
            The ID of the OMS on which the account transactions will be
            returned.
          x-gitbook-description-html: >-
            <p>The ID of the OMS on which the account transactions will be
            returned.</p>
        AccountId:
          type: integer
          description: The ID of the account for which transactions will be returned.
          x-gitbook-description-html: >-
            <p>The ID of the account for which transactions will be
            returned.</p>
        Depth:
          type: integer
          description: >-
            The number of transactions that will be returned, starting with the
            most recent transaction. If not defined, all transactions of the
            account will be returned (assuming not other search parameters are
            defined).
          x-gitbook-description-html: >-
            <p>The number of transactions that will be returned, starting with
            the most recent transaction. If not defined, all transactions of the
            account will be returned (assuming not other search parameters are
            defined).</p>
        ProductId:
          type: integer
          description: >-
            Can be used to filter results. If set, only transactions for the
            specific product id specified will be returned, else, all
            transactions regardless of the product will be returned (assuming
            not other search parameters are defined).
          x-gitbook-description-html: >-
            <p>Can be used to filter results. If set, only transactions for the
            specific product id specified will be returned, else, all
            transactions regardless of the product will be returned (assuming
            not other search parameters are defined).</p>
        TransactionId:
          type: integer
          description: >-
            Can be used to filter results. If set, only transaction with the
            specific id specified will be returned, else, all transactions
            regardless of the transaction id will be returned (assuming not
            other search parameters are defined).
          x-gitbook-description-html: >-
            <p>Can be used to filter results. If set, only transaction with the
            specific id specified will be returned, else, all transactions
            regardless of the transaction id will be returned (assuming not
            other search parameters are defined).</p>
        ReferenceId:
          type: integer
          description: >-
            Can be used to filter results. If set, only transaction with the
            specific id specified will be returned, else, all transactions
            regardless of the reference id will be returned (assuming not other
            search parameters are defined).
          x-gitbook-description-html: >-
            <p>Can be used to filter results. If set, only transaction with the
            specific id specified will be returned, else, all transactions
            regardless of the reference id will be returned (assuming not other
            search parameters are defined).</p>
        TransactionTypes:
          type: array
          items:
            type: integer
            enum:
              - 1
              - 2
              - 3
              - 4
              - 5
              - 6
              - 7
              - 8
              - 9
              - 10
              - 11
              - 12
              - 13
              - 14
              - 15
              - 16
              - 21
              - 22
              - 23
              - 24
              - 25
          description: >-
            Can be used to filter results according to transaction type/s (can
            filter with either just 1 or more). If not set, transactions with
            any transaction type will be returned. A list of: **1** Fee, **2**
            Trade, **3** Other, **4** Reverse, **5** Hold, **6** Rebate, **7**
            MarginAcquisition, **8** MarginRelinquishByTrade, **9**
            MarginInterestTransfer, **10**
            MarginOperatorTransferToMarginAccount, **11**
            MarginOperatorTransferToAssetAccount, **12** MarginUserTransfer,
            **13** MarginRelinquishByTransfer, **14**
            MarginRelinquishByReverseTrade, **15** Distribution, **16** Payment,
            **21** OperatorLend, **22** OperatorReceived, **23** Rebalance,
            **24** Commission, **25** AirDrop.
          x-gitbook-description-html: >-
            <p>Can be used to filter results according to transaction type/s
            (can filter with either just 1 or more). If not set, transactions
            with any transaction type will be returned. A list of:
            <strong>1</strong> Fee, <strong>2</strong> Trade, <strong>3</strong>
            Other, <strong>4</strong> Reverse, <strong>5</strong> Hold,
            <strong>6</strong> Rebate, <strong>7</strong> MarginAcquisition,
            <strong>8</strong> MarginRelinquishByTrade, <strong>9</strong>
            MarginInterestTransfer, <strong>10</strong>
            MarginOperatorTransferToMarginAccount, <strong>11</strong>
            MarginOperatorTransferToAssetAccount, <strong>12</strong>
            MarginUserTransfer, <strong>13</strong> MarginRelinquishByTransfer,
            <strong>14</strong> MarginRelinquishByReverseTrade,
            <strong>15</strong> Distribution, <strong>16</strong> Payment,
            <strong>21</strong> OperatorLend, <strong>22</strong>
            OperatorReceived, <strong>23</strong> Rebalance, <strong>24</strong>
            Commission, <strong>25</strong> AirDrop.</p>
        TransactionReferenceTypes:
          type: array
          items:
            type: integer
            enum:
              - 1
              - 2
              - 3
              - 4
              - 5
              - 6
              - 7
              - 8
              - 9
              - 10
              - 11
              - 12
              - 13
              - 14
              - 15
              - 16
              - 17
              - 18
              - 19
              - 20
              - 21
          description: >-
            Can be used to filter results according to transaction reference
            type/s (can filter with either just 1 or more). If not set,
            transactions with any transaction reference type will be returned. A
            list of: **1** Trade, **2** Deposit, **3** Withdraw, **4** Transfer,
            **5** OrderHold, **6** WithdrawHold, **7** DepositHold, **8**
            MarginHold, **9** ManualHold, **10** ManualEntry, **11**
            MarginAcquisition, **12** MarginRelinquish, **13**
            MarginInterestNetting, **14** MarginOperatorTransferToMarginAccount,
            **15** MarginOperatorTransferToAssetAccount, **16**
            MarginUserTransfer, **17** MarginPositionReverseTrade, **18**
            AffiliateRebate, **19** DistributionEntry, **20** TransferHold,
            **21** AirDrop.
          x-gitbook-description-html: >-
            <p>Can be used to filter results according to transaction reference
            type/s (can filter with either just 1 or more). If not set,
            transactions with any transaction reference type will be returned. A
            list of: <strong>1</strong> Trade, <strong>2</strong> Deposit,
            <strong>3</strong> Withdraw, <strong>4</strong> Transfer,
            <strong>5</strong> OrderHold, <strong>6</strong> WithdrawHold,
            <strong>7</strong> DepositHold, <strong>8</strong> MarginHold,
            <strong>9</strong> ManualHold, <strong>10</strong> ManualEntry,
            <strong>11</strong> MarginAcquisition, <strong>12</strong>
            MarginRelinquish, <strong>13</strong> MarginInterestNetting,
            <strong>14</strong> MarginOperatorTransferToMarginAccount,
            <strong>15</strong> MarginOperatorTransferToAssetAccount,
            <strong>16</strong> MarginUserTransfer, <strong>17</strong>
            MarginPositionReverseTrade, <strong>18</strong> AffiliateRebate,
            <strong>19</strong> DistributionEntry, <strong>20</strong>
            TransferHold, <strong>21</strong> AirDrop.</p>
        StartTimestamp:
          type: integer
          format: int64
          description: >-
            Can be used to filter results based on timestamp the transaction has
            happened. This filter will return transactions that happened on or
            after (earliest possible time) the specified timestamp value, if not
            set, transactions that happened any time will be returned.
          x-gitbook-description-html: >-
            <p>Can be used to filter results based on timestamp the transaction
            has happened. This filter will return transactions that happened on
            or after (earliest possible time) the specified timestamp value, if
            not set, transactions that happened any time will be returned.</p>
        EndTimeStamp:
          type: integer
          format: int64
          description: >-
            Can be used to filter results based on timestamp the transaction has
            happened. This filter will return transactions that happened on or
            before (latest possible time) the specified timestamp value, if not
            set, transactions that happened any time will be returned.
          x-gitbook-description-html: >-
            <p>Can be used to filter results based on timestamp the transaction
            has happened. This filter will return transactions that happened on
            or before (latest possible time) the specified timestamp value, if
            not set, transactions that happened any time will be returned.</p>
      required:
        - OMSId
        - AccountId
    GetAccountTransactionsResponse:
      type: array
      items:
        type: object
        properties:
          TransactionId:
            type: integer
            description: The ID of the transaction.
            x-gitbook-description-html: <p>The ID of the transaction.</p>
          OMSId:
            type: integer
            description: The ID of the OMS on which the requested transactions took place.
            x-gitbook-description-html: >-
              <p>The ID of the OMS on which the requested transactions took
              place.</p>
          AccountId:
            type: integer
            description: The ID of the account which made the transactions.
            x-gitbook-description-html: <p>The ID of the account which made the transactions.</p>
          CR:
            type: number
            format: decimal
            description: >-
              Credit entry for the account on the order book. Funds entering an
              account.
            x-gitbook-description-html: >-
              <p>Credit entry for the account on the order book. Funds entering
              an account.</p>
          DR:
            type: number
            format: decimal
            description: >-
              Debit entry for the account on the order book. Funds leaving an
              account.
            x-gitbook-description-html: >-
              <p>Debit entry for the account on the order book. Funds leaving an
              account.</p>
          Counterparty:
            type: integer
            format: int64
            description: The corresponding counter party in the trade.
            x-gitbook-description-html: <p>The corresponding counter party in the trade.</p>
          TransactionType:
            type: string
            enum:
              - Fee
              - Trade
              - Other
              - Reverse
              - Hold
              - Rebate
              - MarginAcquisition
              - MarginRelinquishByTrade
              - MarginInterestTransfer
              - MarginOperatorTransferToMarginAccount
              - MarginOperatorTransferToAssetAccount
              - MarginUserTransfer
              - MarginRelinquishByTransfer
              - MarginRelinquishByReverseTrade
              - Distribution
              - Payment
              - OperatorLend
              - OperatorReceived
              - Rebalance
              - Commission
              - AirDrop
            description: >-
              The type of transaction. One of: **1** Fee, **2** Trade, **3**
              Other, **4** Reverse, **5** Hold, **6** Rebate, **7**
              MarginAcquisition, **8** MarginRelinquishByTrade, **9**
              MarginInterestTransfer, **10**
              MarginOperatorTransferToMarginAccount, **11**
              MarginOperatorTransferToAssetAccount, **12** MarginUserTransfer,
              **13** MarginRelinquishByTransfer, **14**
              MarginRelinquishByReverseTrade, **15** Distribution, **16**
              Payment, **21** OperatorLend, **22** OperatorReceived, **23**
              Rebalance, **24** Commission, **25** AirDrop.
            x-gitbook-description-html: >-
              <p>The type of transaction. One of: <strong>1</strong> Fee,
              <strong>2</strong> Trade, <strong>3</strong> Other,
              <strong>4</strong> Reverse, <strong>5</strong> Hold,
              <strong>6</strong> Rebate, <strong>7</strong> MarginAcquisition,
              <strong>8</strong> MarginRelinquishByTrade, <strong>9</strong>
              MarginInterestTransfer, <strong>10</strong>
              MarginOperatorTransferToMarginAccount, <strong>11</strong>
              MarginOperatorTransferToAssetAccount, <strong>12</strong>
              MarginUserTransfer, <strong>13</strong>
              MarginRelinquishByTransfer, <strong>14</strong>
              MarginRelinquishByReverseTrade, <strong>15</strong> Distribution,
              <strong>16</strong> Payment, <strong>21</strong> OperatorLend,
              <strong>22</strong> OperatorReceived, <strong>23</strong>
              Rebalance, <strong>24</strong> Commission, <strong>25</strong>
              AirDrop.</p>
          ReferenceId:
            type: integer
            format: int64
            description: The ID of the action or event that triggered this transaction.
            x-gitbook-description-html: >-
              <p>The ID of the action or event that triggered this
              transaction.</p>
          ReferenceType:
            type: integer
            enum:
              - 1
              - 2
              - 3
              - 4
              - 5
              - 6
              - 7
              - 8
              - 9
              - 10
              - 11
              - 12
              - 13
              - 14
              - 15
              - 16
              - 17
              - 18
              - 19
              - 20
              - 21
            description: >-
              The type of action or event that triggered this transaction. One
              of:- **1** Trade, **2** Deposit, **3** Withdraw, **4** Transfer,
              **5** OrderHold, **6** WithdrawHold, **7** DepositHold, **8**
              MarginHold, **9** ManualHold, **10** ManualEntry, **11**
              MarginAcquisition, **12** MarginRelinquish, **13**
              MarginInterestNetting, **14**
              MarginOperatorTransferToMarginAccount, **15**
              MarginOperatorTransferToAssetAccount, **16** MarginUserTransfer,
              **17** MarginPositionReverseTrade, **18** AffiliateRebate, **19**
              DistributionEntry, **20** TransferHold, **21** AirDrop.
            x-gitbook-description-html: >-
              <p>The type of action or event that triggered this transaction.
              One of:- <strong>1</strong> Trade, <strong>2</strong> Deposit,
              <strong>3</strong> Withdraw, <strong>4</strong> Transfer,
              <strong>5</strong> OrderHold, <strong>6</strong> WithdrawHold,
              <strong>7</strong> DepositHold, <strong>8</strong> MarginHold,
              <strong>9</strong> ManualHold, <strong>10</strong> ManualEntry,
              <strong>11</strong> MarginAcquisition, <strong>12</strong>
              MarginRelinquish, <strong>13</strong> MarginInterestNetting,
              <strong>14</strong> MarginOperatorTransferToMarginAccount,
              <strong>15</strong> MarginOperatorTransferToAssetAccount,
              <strong>16</strong> MarginUserTransfer, <strong>17</strong>
              MarginPositionReverseTrade, <strong>18</strong> AffiliateRebate,
              <strong>19</strong> DistributionEntry, <strong>20</strong>
              TransferHold, <strong>21</strong> AirDrop.</p>
          ProductId:
            type: integer
            description: >-
              The ID of the product on this account’s side of the transaction.
              For example, in a dollars-for-Bitcoin transaction, one side will
              have the product Dollar and the other side will have the product
              Bitcoin. Use **GetProduct** to return information about a product
              based on its ID.
            x-gitbook-description-html: >-
              <p>The ID of the product on this account’s side of the
              transaction. For example, in a dollars-for-Bitcoin transaction,
              one side will have the product Dollar and the other side will have
              the product Bitcoin. Use <strong>GetProduct</strong> to return
              information about a product based on its ID.</p>
          Balance:
            type: number
            format: decimal
            description: The balance in the account after the transaction.
            x-gitbook-description-html: <p>The balance in the account after the transaction.</p>
          TimeStamp:
            type: integer
            format: int64
            description: Time at which the transaction took place, in POSIX format.
            x-gitbook-description-html: <p>Time at which the transaction took place, in POSIX format.</p>
        required:
          - TransactionId
          - OMSId
          - AccountId
          - CR
          - DR
          - Counterparty
          - TransactionType
          - ReferenceId
          - ReferenceType
          - ProductId
          - Balance
          - TimeStamp
    GetAccountPositionsRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS.
          x-gitbook-description-html: <p>The ID of the OMS.</p>
        AccountId:
          type: integer
          description: >-
            The ID of the account on the OMS for which positions will be
            returned for.
          x-gitbook-description-html: >-
            <p>The ID of the account on the OMS for which positions will be
            returned for.</p>
        IncludePending:
          type: boolean
          default: false
          description: >-
            If true, pending deposit and withdraw amounts will be included in
            the response, else they will not be included. Default is false.
          x-gitbook-description-html: >-
            <p>If true, pending deposit and withdraw amounts will be included in
            the response, else they will not be included. Default is false.</p>
      required:
        - OMSId
        - AccountId
    GetAccountPositionsResponse:
      type: array
      items:
        type: object
        properties:
          OMSId:
            type: integer
            description: The ID of the OMS to which the account is assigned.
            x-gitbook-description-html: <p>The ID of the OMS to which the account is assigned.</p>
          AccountId:
            type: integer
            description: The ID of the account whose positions/balances were retrieved.
            x-gitbook-description-html: >-
              <p>The ID of the account whose positions/balances were
              retrieved.</p>
          ProductSymbol:
            type: string
            description: The symbol of a specific product.
            x-gitbook-description-html: <p>The symbol of a specific product.</p>
          ProductId:
            type: integer
            description: The ID of a specific product.
            x-gitbook-description-html: <p>The ID of a specific product.</p>
          Amount:
            type: number
            format: decimal
            description: The current actual balance of the account for a specific product.
            x-gitbook-description-html: >-
              <p>The current actual balance of the account for a specific
              product.</p>
          Hold:
            type: number
            format: decimal
            description: >-
              The current actual hold amount against the current balance of the
              account for a specific product. A hold amount is part of the total
              balance or the **Amount** field value but is not available to be
              used for other transactions. A trade on working status of 100
              units at $1 each will produce a $100 hold.
            x-gitbook-description-html: >-
              <p>The current actual hold amount against the current balance of
              the account for a specific product. A hold amount is part of the
              total balance or the <strong>Amount</strong> field value but is
              not available to be used for other transactions. A trade on
              working status of 100 units at $1 each will produce a $100
              hold.</p>
          PendingDeposits:
            type: number
            format: decimal
            description: >-
              Deposit amount for a specific product that is not yet credited to
              the account.
            x-gitbook-description-html: >-
              <p>Deposit amount for a specific product that is not yet credited
              to the account.</p>
          PendingWithdraws:
            type: number
            format: decimal
            description: >-
              Withdraw amount for a specific product that is not yet debited
              from the account.
            x-gitbook-description-html: >-
              <p>Withdraw amount for a specific product that is not yet debited
              from the account.</p>
          TotalDayDeposits:
            type: number
            format: decimal
            description: >-
              Total amount deposited by the account for a specific product in
              the current day; UTC Midnight and UTC Midnight.
            x-gitbook-description-html: >-
              <p>Total amount deposited by the account for a specific product in
              the current day; UTC Midnight and UTC Midnight.</p>
          TotalMonthDeposits:
            type: number
            format: decimal
            description: >-
              Total amount deposited by the account for a specific product in
              the current month.
            x-gitbook-description-html: >-
              <p>Total amount deposited by the account for a specific product in
              the current month.</p>
          TotalYearDeposits:
            type: number
            format: decimal
            description: >-
              Total amount deposited by the account for a specific product in
              the current year.
            x-gitbook-description-html: >-
              <p>Total amount deposited by the account for a specific product in
              the current year.</p>
          TotalDayDepositNotional:
            type: number
            format: decimal
            description: >-
              Total amount in notional value deposited by the account for a
              specific product in the current day.
            x-gitbook-description-html: >-
              <p>Total amount in notional value deposited by the account for a
              specific product in the current day.</p>
          TotalMonthDepositNotional:
            type: number
            format: decimal
            description: >-
              Total amount in notional value deposited by the account for a
              specific product in the current month.
            x-gitbook-description-html: >-
              <p>Total amount in notional value deposited by the account for a
              specific product in the current month.</p>
          TotalYearDepositNotional:
            type: number
            format: decimal
            description: >-
              Total amount in notional value deposited by the account for a
              specific product in the current year.
            x-gitbook-description-html: >-
              <p>Total amount in notional value deposited by the account for a
              specific product in the current year.</p>
          TotalDayWithdraws:
            type: number
            format: decimal
            description: >-
              Total amount withdrawn by the account for a specific product in
              the current day; UTC Midnight and UTC Midnight.
            x-gitbook-description-html: >-
              <p>Total amount withdrawn by the account for a specific product in
              the current day; UTC Midnight and UTC Midnight.</p>
          TotalMonthWithdraws:
            type: number
            format: decimal
            description: >-
              Total amount withdrawn by the account for a specific product in
              the current month.
            x-gitbook-description-html: >-
              <p>Total amount withdrawn by the account for a specific product in
              the current month.</p>
          TotalYearWithdraws:
            type: number
            format: decimal
            description: >-
              Total amount withdrawn by the account for a specific product in
              the current year.
            x-gitbook-description-html: >-
              <p>Total amount withdrawn by the account for a specific product in
              the current year.</p>
          TotalDayWithdrawNotional:
            type: number
            format: decimal
            description: >-
              Total amount in notional value withdrawn by the account for a
              specific product in the current day.
            x-gitbook-description-html: >-
              <p>Total amount in notional value withdrawn by the account for a
              specific product in the current day.</p>
          TotalMonthWithdrawNotional:
            type: number
            format: decimal
            description: >-
              Total amount in notional value withdrawn by the account for a
              specific product in the current month.
            x-gitbook-description-html: >-
              <p>Total amount in notional value withdrawn by the account for a
              specific product in the current month.</p>
          TotalYearWithdrawNotional:
            type: number
            format: decimal
            description: >-
              Total amount in notional value withdrawn by the account for a
              specific product in the current year.
            x-gitbook-description-html: >-
              <p>Total amount in notional value withdrawn by the account for a
              specific product in the current year.</p>
          NotionalProductId:
            type: integer
            description: The ID of the product set as the BaseNotionalProduct on the OMS.
            x-gitbook-description-html: >-
              <p>The ID of the product set as the BaseNotionalProduct on the
              OMS.</p>
          NotionalProductSymbol:
            type: string
            description: >-
              The symbol of the product set as the BaseNotionalProduct on the
              OMS.
            x-gitbook-description-html: >-
              <p>The symbol of the product set as the BaseNotionalProduct on the
              OMS.</p>
          NotionalValue:
            type: number
            format: decimal
            description: >-
              The current actual balance in notional value of the account for a
              specific product.
            x-gitbook-description-html: >-
              <p>The current actual balance in notional value of the account for
              a specific product.</p>
          NotionalHoldAmount:
            type: number
            format: decimal
            description: >-
              The current actual hold amount in notional value against the
              current balance of the account for a specific product.
            x-gitbook-description-html: >-
              <p>The current actual hold amount in notional value against the
              current balance of the account for a specific product.</p>
          NotionalRate:
            type: number
            format: decimal
            description: >-
              The current rate of a specific product against the notional
              product.
            x-gitbook-description-html: >-
              <p>The current rate of a specific product against the notional
              product.</p>
          TotalDayTransferNotional:
            type: number
            format: decimal
            description: >-
              Total amount in notional value transfered by the account for a
              specific product in the current day.
            x-gitbook-description-html: >-
              <p>Total amount in notional value transfered by the account for a
              specific product in the current day.</p>
        required:
          - OMSId
          - AccountId
          - ProductSymbol
          - ProductId
          - Amount
          - Hold
          - PendingDeposits
          - PendingWithdraws
          - TotalDayDeposits
          - TotalMonthDeposits
          - TotalYearDeposits
          - TotalDayDepositNotional
          - TotalMonthDepositNotional
          - TotalYearDepositNotional
          - TotalDayWithdraws
          - TotalMonthWithdraws
          - TotalYearWithdraws
          - TotalDayWithdrawNotional
          - TotalMonthWithdrawNotional
          - TotalYearWithdrawNotional
          - NotionalProductId
          - NotionalProductSymbol
          - NotionalValue
          - NotionalHoldAmount
          - NotionalRate
          - TotalDayTransferNotional
    GetAccountInstrumentStatisticsRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS.
          x-gitbook-description-html: <p>The ID of the OMS.</p>
        AccountId:
          type: integer
          description: >-
            The ID of the account on the OMS for which instrument statistics
            will be returned for.
          x-gitbook-description-html: >-
            <p>The ID of the account on the OMS for which instrument statistics
            will be returned for.</p>
      required:
        - OMSId
        - AccountId
    GetAccountInstrumentStatisticsResponse:
      type: array
      items:
        type: object
        properties:
          OMSId:
            type: integer
            description: The ID of the OMS.
            x-gitbook-description-html: <p>The ID of the OMS.</p>
          AccountId:
            type: integer
            description: The ID of the account for which the instrument statistics is for.
            x-gitbook-description-html: >-
              <p>The ID of the account for which the instrument statistics is
              for.</p>
          InstrumentId:
            type: integer
            description: The ID of the account for which the instrument statistics is for.
            x-gitbook-description-html: >-
              <p>The ID of the account for which the instrument statistics is
              for.</p>
          InstrumentSymbol:
            type: string
            description: The symbol of a specific instrument.
            x-gitbook-description-html: <p>The symbol of a specific instrument.</p>
          QuantityBought:
            type: number
            format: decimal
            description: >-
              Quantity of the instrument bought by the account at the current
              trading day.
            x-gitbook-description-html: >-
              <p>Quantity of the instrument bought by the account at the current
              trading day.</p>
          QuantitySold:
            type: integer
            description: >-
              Quantity of the instrument sold by the account at the current
              trading day.
            x-gitbook-description-html: >-
              <p>Quantity of the instrument sold by the account at the current
              trading day.</p>
          NotionalBought:
            type: integer
            description: >-
              Notional value of the instrument bought by the account at the
              current trading day.
            x-gitbook-description-html: >-
              <p>Notional value of the instrument bought by the account at the
              current trading day.</p>
          NotionalSold:
            type: integer
            description: >-
              Notional value of the instrument sold by the account at the
              current trading day.
            x-gitbook-description-html: >-
              <p>Notional value of the instrument sold by the account at the
              current trading day.</p>
          MonthlyQuantityBought:
            type: integer
            description: >-
              Quantity of the instrument bought by the account for the current
              month.
            x-gitbook-description-html: >-
              <p>Quantity of the instrument bought by the account for the
              current month.</p>
          MonthlyQuantitySold:
            type: integer
            description: >-
              Quantity of the instrument sold by the account for the current
              month.
            x-gitbook-description-html: >-
              <p>Quantity of the instrument sold by the account for the current
              month.</p>
          MonthlyNotionalBought:
            type: integer
            description: >-
              Notional value of the instrument bought by the account at the
              current month.
            x-gitbook-description-html: >-
              <p>Notional value of the instrument bought by the account at the
              current month.</p>
          MonthlyNotionalSold:
            type: integer
            description: >-
              Notional value of the instrument sold by the account at the
              current month.
            x-gitbook-description-html: >-
              <p>Notional value of the instrument sold by the account at the
              current month.</p>
          TradeVolume:
            type: integer
            description: >-
              Total quantity of the instrument either sold or bought by the
              account at the current trading day.
            x-gitbook-description-html: >-
              <p>Total quantity of the instrument either sold or bought by the
              account at the current trading day.</p>
          MonthlyTradeVolume:
            type: integer
            description: >-
              Total quantity of the instrument either sold or bought by the
              account at the current month.
            x-gitbook-description-html: >-
              <p>Total quantity of the instrument either sold or bought by the
              account at the current month.</p>
          TotalDayBuys:
            type: integer
            description: >-
              Total number of times the account bought the instrument at the
              current trading day.
            x-gitbook-description-html: >-
              <p>Total number of times the account bought the instrument at the
              current trading day.</p>
          TotalDaySells:
            type: integer
            description: >-
              Total number of times the account sold the instrument at the
              current trading day.
            x-gitbook-description-html: >-
              <p>Total number of times the account sold the instrument at the
              current trading day.</p>
          TotalMonthBuys:
            type: integer
            description: >-
              Total number of times the account bought the instrument at the
              current month.
            x-gitbook-description-html: >-
              <p>Total number of times the account bought the instrument at the
              current month.</p>
          TotalMonthSells:
            type: integer
            description: >-
              Total number of times the account sold the instrument at the
              current month.
            x-gitbook-description-html: >-
              <p>Total number of times the account sold the instrument at the
              current month.</p>
          NotionalConversionRate:
            type: integer
            description: The notional conversion rate.
            x-gitbook-description-html: <p>The notional conversion rate.</p>
          NotionalConversionSymbol:
            type: string
            description: The notional conversion symbol.
            x-gitbook-description-html: <p>The notional conversion symbol.</p>
          RollingMonthlyStartDate:
            type: integer
            description: The rolling monthly start date.
            x-gitbook-description-html: <p>The rolling monthly start date.</p>
          LastTradeId:
            type: integer
            description: >-
              The ID of the most recent trade the account has for the
              instrument.
            x-gitbook-description-html: >-
              <p>The ID of the most recent trade the account has for the
              instrument.</p>
          DailyNotionalTradeVolume:
            type: integer
            description: >-
              The notional trade volume of the account for the specific
              instrument at the current trading day.
            x-gitbook-description-html: >-
              <p>The notional trade volume of the account for the specific
              instrument at the current trading day.</p>
          MonthlyNotionalTradeVolume:
            type: integer
            description: >-
              The notional trade volume of the account for the specific
              instrument at the current month.
            x-gitbook-description-html: >-
              <p>The notional trade volume of the account for the specific
              instrument at the current month.</p>
          YearlyNotionalTradeVolume:
            type: integer
            description: >-
              The notional trade volume of the account for the specific
              instrument at the current year.
            x-gitbook-description-html: >-
              <p>The notional trade volume of the account for the specific
              instrument at the current year.</p>
        required:
          - OMSId
          - AccountId
          - InstrumentId
          - InstrumentSymbol
          - QuantityBought
          - QuantitySold
          - NotionalBought
          - NotionalSold
          - MonthlyQuantityBought
          - MonthlyQuantitySold
          - MonthlyNotionalBought
          - MonthlyNotionalSold
          - TradeVolume
          - MonthlyTradeVolume
          - TotalDayBuys
          - TotalDaySells
          - TotalMonthBuys
          - TotalMonthSells
          - NotionalConversionRate
          - NotionalConversionSymbol
          - RollingMonthlyStartDate
          - LastTradeId
          - DailyNotionalTradeVolume
          - MonthlyNotionalTradeVolume
          - YearlyNotionalTradeVolume
    GetAccountInfoRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS on which the account exists.
          x-gitbook-description-html: <p>The ID of the OMS on which the account exists.</p>
        AccountId:
          type: integer
          description: >-
            The ID of the account on the OMS for which information will be
            returned. If not defined, the default account of the authenticated
            user will be retrieved.
          x-gitbook-description-html: >-
            <p>The ID of the account on the OMS for which information will be
            returned. If not defined, the default account of the authenticated
            user will be retrieved.</p>
      required:
        - OMSId
    GetAccountInfoResponse:
      type: object
      properties:
        OMSID:
          type: integer
          description: The ID of the OMS on which the account resides.
          x-gitbook-description-html: <p>The ID of the OMS on which the account resides.</p>
        AccountId:
          type: integer
          description: The ID of the account for which information was requested.
          x-gitbook-description-html: <p>The ID of the account for which information was requested.</p>
        AccountName:
          type: string
          description: A non-unique name for the account assigned by the user.
          x-gitbook-description-html: <p>A non-unique name for the account assigned by the user.</p>
        AccountHandle:
          type: string
          description: >-
            A unique user-assigned name that is checked at create time by the
            OMS to assure its uniqueness.
          x-gitbook-description-html: >-
            <p>A unique user-assigned name that is checked at create time by the
            OMS to assure its uniqueness.</p>
        FirmId:
          type: string
          description: >-
            An arbitrary identifier assigned by a trading venue operator to a
            trading firm as part of the initial company, user, and account set
            up process. For example, Smith Financial Partners might have the ID
            SMFP.
          x-gitbook-description-html: >-
            <p>An arbitrary identifier assigned by a trading venue operator to a
            trading firm as part of the initial company, user, and account set
            up process. For example, Smith Financial Partners might have the ID
            SMFP.</p>
        FirmName:
          type: string
          description: >-
            A longer, non-unique version of the trading firm’s name; for
            example, Smith Financial Partners.
          x-gitbook-description-html: >-
            <p>A longer, non-unique version of the trading firm’s name; for
            example, Smith Financial Partners.</p>
        AccountType:
          type: integer
          enum:
            - 0
            - 1
          default: 0
          description: >-
            The account type the specific account is currently set to. One of: 0
            Asset, 1 Liability. Default is 0.
          x-gitbook-description-html: >-
            <p>The account type the specific account is currently set to. One
            of: 0 Asset, 1 Liability. Default is 0.</p>
        FeeGroupId:
          type: integer
          description: >-
            Defines account attributes relating to how fees are calculated and
            assessed. Set by trading venue operator.
          x-gitbook-description-html: >-
            <p>Defines account attributes relating to how fees are calculated
            and assessed. Set by trading venue operator.</p>
        ParentID:
          type: integer
          description: Reserved for future development.
          x-gitbook-description-html: <p>Reserved for future development.</p>
        RiskType:
          type: integer
          enum:
            - 0
            - 1
            - 2
            - 3
            - 4
          description: >-
            One of: 0 Unkown (an error condition), 1 Normal, 2 NoRiskCheck, 3
            NoTrading, 4 Credit. Returns **Normal** for virtually all market
            participants. Other types indicate account configurations assignable
            by the trading venue operator.
          x-gitbook-description-html: >-
            <p>One of: 0 Unkown (an error condition), 1 Normal, 2 NoRiskCheck, 3
            NoTrading, 4 Credit. Returns <strong>Normal</strong> for virtually
            all market participants. Other types indicate account configurations
            assignable by the trading venue operator.</p>
        VerificationLevel:
          type: integer
          description: >-
            The verification level the account is currently at. Verification
            level limits the amounts of deposits and withdrawals. It is defined
            by and set by the trading venue operator for each account and is
            part of the KYC ("Know Your Customer") process, which may be
            automated or manual. An account can earn a higher Verification Level
            over time.
          x-gitbook-description-html: >-
            <p>The verification level the account is currently at. Verification
            level limits the amounts of deposits and withdrawals. It is defined
            by and set by the trading venue operator for each account and is
            part of the KYC ("Know Your Customer") process, which may be
            automated or manual. An account can earn a higher Verification Level
            over time.</p>
        VerificationLevelName:
          type: string
          description: Name of the verification level.
          x-gitbook-description-html: <p>Name of the verification level.</p>
        CreditTier:
          type: integer
          default: 0
          description: >-
            The credit tier the account is currently at. Default is 0.
            applicable to accounts with _RiskType_ **Credit**.
          x-gitbook-description-html: >-
            <p>The credit tier the account is currently at. Default is 0.
            applicable to accounts with <em>RiskType</em>
            <strong>Credit</strong>.</p>
        FeeProductType:
          type: string
          enum:
            - BaseProduct
            - SingleProduct
          description: >-
            One of: BaseProduct, SingleProduct. Trading fees may be charged by a
            trading venue operator (Withdrawal fees may also be charged, but
            that is a separate setting dependent on product and instrument).
            This value shows whether fees for this account’s trades are charged
            in the product being traded (BaseProduct, for example Bitcoin) or
            whether the account has a preferred fee-paying product
            (SingleProduct, for example USD) to use in all cases and regardless
            of product being traded.
          x-gitbook-description-html: >-
            <p>One of: BaseProduct, SingleProduct. Trading fees may be charged
            by a trading venue operator (Withdrawal fees may also be charged,
            but that is a separate setting dependent on product and instrument).
            This value shows whether fees for this account’s trades are charged
            in the product being traded (BaseProduct, for example Bitcoin) or
            whether the account has a preferred fee-paying product
            (SingleProduct, for example USD) to use in all cases and regardless
            of product being traded.</p>
        FeeProduct:
          type: integer
          default: 0
          description: The ID of the preferred fee product, if any. Default is 0.
          x-gitbook-description-html: <p>The ID of the preferred fee product, if any. Default is 0.</p>
        RefererId:
          type: integer
          description: >-
            Captures the ID of the entity who referred this account to the
            trading venue, usually captured for marketing purposes.
          x-gitbook-description-html: >-
            <p>Captures the ID of the entity who referred this account to the
            trading venue, usually captured for marketing purposes.</p>
        LoyaltyProductId:
          type: integer
          description: >-
            The Loyalty Token is a parallel fee structure that replaces the
            general set of transaction fees. An exchange can promote activity on
            a specific cryptocurrency token by offering discounted transaction
            fees denominated in that token to customers who choose that fee
            structure. This key is the ID of the loyalty product chosen by the
            Exchange. There can be one Loyalty Token per OMS.
          x-gitbook-description-html: >-
            <p>The Loyalty Token is a parallel fee structure that replaces the
            general set of transaction fees. An exchange can promote activity on
            a specific cryptocurrency token by offering discounted transaction
            fees denominated in that token to customers who choose that fee
            structure. This key is the ID of the loyalty product chosen by the
            Exchange. There can be one Loyalty Token per OMS.</p>
        LoyaltyEnabled:
          type: boolean
          default: false
          description: >-
            If _true_, this account has accepted the Loyalty Token fee
            structure. If _false_, the account has not accepted it. Default is
            _false_.
          x-gitbook-description-html: >-
            <p>If <em>true</em>, this account has accepted the Loyalty Token fee
            structure. If <em>false</em>, the account has not accepted it.
            Default is <em>false</em>.</p>
        PriceTier:
          type: integer
          default: 0
          description: The price tier where the account is currently at. Default is 0.
          x-gitbook-description-html: >-
            <p>The price tier where the account is currently at. Default is
            0.</p>
        Frozen:
          type: boolean
          default: false
          description: >-
            If _true_, account is Frozen and will not be able to perform assets
            outgoing transactions such as a withdrawal. If _false_, account is
            not frozen and can perform any transaction. Default is _false_.
          x-gitbook-description-html: >-
            <p>If <em>true</em>, account is Frozen and will not be able to
            perform assets outgoing transactions such as a withdrawal. If
            <em>false</em>, account is not frozen and can perform any
            transaction. Default is <em>false</em>.</p>
      required:
        - OMSID
        - AccountId
        - AccountName
        - AccountHandle
        - FirmId
        - FirmName
        - AccountType
        - FeeGroupId
        - ParentID
        - RiskType
        - VerificationLevel
        - VerificationLevelName
        - CreditTier
        - FeeProductType
        - FeeProduct
        - RefererId
        - LoyaltyProductId
        - LoyaltyEnabled
        - PriceTier
        - Frozen
    AuthenticateUserResponse:
      type: object
      properties:
        Authenticated:
          type: boolean
          description: _True_ if the user is authenticated; _false_ otherwise.
          x-gitbook-description-html: >-
            <p><em>True</em> if the user is authenticated; <em>false</em>
            otherwise.</p>
        SessionToken: 
          type: string
          description: The token used for authentication in requests.
          x-gitbook-description-html: <p>The token used for authentication in requests.</p>
        User:
          type: object
          description: User data
          properties:
            UserId:
              type: integer
              description: The ID of the user being authenticated on the exchange.
              x-gitbook-description-html: <p>The ID of the user being authenticated on the exchange.</p>
            UserName:
              type: string
              description: The name of the user.
              x-gitbook-description-html: <p>The name of the user.</p>
            Email:
              type: string
              description: The email address of the user.
              x-gitbook-description-html: <p>The email address of the user.</p>
            EmailVerified:
              type: boolean
              description: >-
                Whether the email address has been verified by the registration
                process or directly by an Admin.
              x-gitbook-description-html: >-
                <p>Whether the email address has been verified by the
                registration process or directly by an Admin.</p>
            AccountId:
              type: integer
              description: >-
                The ID of the account with which the user is associated (each
                user has a default account).
              x-gitbook-description-html: >-
                <p>The ID of the account with which the user is associated (each
                user has a default account).</p>
            OMSId:
              type: integer
              description: The ID of the OMS on which the user and account are associated.
              x-gitbook-description-html: >-
                <p>The ID of the OMS on which the user and account are
                associated.</p>
            Use2FA:
              type: boolean
              description: _True_ if the user must use 2FA to log in; _false_ otherwise.
              x-gitbook-description-html: >-
                <p><em>True</em> if the user must use 2FA to log in;
                <em>false</em> otherwise.</p>
          required:
            - UserId
            - UserName
            - Email
            - EmailVerified
            - AccountId
            - OMSId
            - Use2FA
          x-gitbook-description-html: <p>User data</p>
        Locked:
          type: boolean
          description: >-
            _True_ if the user is currently locked; _false_ otherwise. A user
            may be locked by trying to log in too many times in rapid
            succession. He must be _unlocked_ by an admin.
          x-gitbook-description-html: >-
            <p><em>True</em> if the user is currently locked; <em>false</em>
            otherwise. A user may be locked by trying to log in too many times
            in rapid succession. He must be <em>unlocked</em> by an admin.</p>
        Requires2FA:
          type: boolean
          description: >-
            _True_ if the user must use two-factor authentication; _false_
            otherwise.
          x-gitbook-description-html: >-
            <p><em>True</em> if the user must use two-factor authentication;
            <em>false</em> otherwise.</p>
        TwoFAType:
          type: string
          description: The type of 2FA this user requires. For example, **Google**.
          x-gitbook-description-html: >-
            <p>The type of 2FA this user requires. For example,
            <strong>Google</strong>.</p>
        TwoFAToken:
          type: string
          default: 'null'
          description: Default is null.
          x-gitbook-description-html: <p>Default is null.</p>
        errormsg:
          type: string
          description: A successful receipt of the call returns _null_.
          x-gitbook-description-html: <p>A successful receipt of the call returns <em>null</em>.</p>
      required:
        - Authenticated
        - SessionToken
        - User
        - Locked
        - Requires2FA
        - TwoFAType
        - TwoFAToken
        - errormsg
    LogOutRequest:
      type: object
      properties:
        result:
          type: boolean
          description: >-
            A successful logout request returns _true_; and unsuccessful (an
            error condition) returns _false_.
          x-gitbook-description-html: >-
            <p>A successful logout request returns <em>true</em>; and
            unsuccessful (an error condition) returns <em>false</em>.</p>
        errormsg:
          type: string
          description: >-
            A successful logout request returns _null_; the _errormsg_ parameter
            for an unsuccessful request returns one of the following messages:.
            Not Authorized (errorcode 20). Invalid Request (errorcode 100).
            Operation Failed (errorcode 101). Server Error (errorcode 102).
            Resource Not Found (errorcode 104).
          x-gitbook-description-html: >-
            <p>A successful logout request returns <em>null</em>; the
            <em>errormsg</em> parameter for an unsuccessful request returns one
            of the following messages:. Not Authorized (errorcode 20). Invalid
            Request (errorcode 100). Operation Failed (errorcode 101). Server
            Error (errorcode 102). Resource Not Found (errorcode 104).</p>
        errorcode:
          type: integer
          description: >-
            A successful request returns 0. An unsuccessful request returns one
            of the _errorcodes_ shown in the _errormsg_ list.
          x-gitbook-description-html: >-
            <p>A successful request returns 0. An unsuccessful request returns
            one of the <em>errorcodes</em> shown in the <em>errormsg</em>
            list.</p>
        detail:
          type: string
          description: Message text that the system may send. Usually _null_.
          x-gitbook-description-html: <p>Message text that the system may send. Usually <em>null</em>.</p>
      required:
        - result
        - errormsg
        - errorcode
        - detail
    LogOutResponse:
      type: object
      properties:
        result:
          type: boolean
          description: >-
            A successful logout request returns _true_; and unsuccessful (an
            error condition) returns _false_.
          x-gitbook-description-html: >-
            <p>A successful logout request returns <em>true</em>; and
            unsuccessful (an error condition) returns <em>false</em>.</p>
        errormsg:
          type: string
          description: >-
            A successful logout request returns _null_; the _errormsg_ parameter
            for an unsuccessful request returns one of the following messages:.
            Not Authorized (errorcode 20). Invalid Request (errorcode 100).
            Operation Failed (errorcode 101). Server Error (errorcode 102).
            Resource Not Found (errorcode 104).
          x-gitbook-description-html: >-
            <p>A successful logout request returns <em>null</em>; the
            <em>errormsg</em> parameter for an unsuccessful request returns one
            of the following messages:. Not Authorized (errorcode 20). Invalid
            Request (errorcode 100). Operation Failed (errorcode 101). Server
            Error (errorcode 102). Resource Not Found (errorcode 104).</p>
        errorcode:
          type: integer
          description: >-
            A successful request returns 0. An unsuccessful request returns one
            of the _errorcodes_ shown in the _errormsg_ list.
          x-gitbook-description-html: >-
            <p>A successful request returns 0. An unsuccessful request returns
            one of the <em>errorcodes</em> shown in the <em>errormsg</em>
            list.</p>
        detail:
          type: string
          description: Message text that the system may send. Usually _null_.
          x-gitbook-description-html: <p>Message text that the system may send. Usually <em>null</em>.</p>
      required:
        - result
        - errormsg
        - errorcode
        - detail
    GetWithdrawFeeRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS on which the product is trade.
          x-gitbook-description-html: <p>The ID of the OMS on which the product is trade.</p>
        AccountId:
          type: integer
          description: >-
            The ID of the account making the withdrawal. Not explicitly required
            but needs to be defined to get the accurate estimate of withdraw fee
            especially if there are fee overrides.
          x-gitbook-description-html: >-
            <p>The ID of the account making the withdrawal. Not explicitly
            required but needs to be defined to get the accurate estimate of
            withdraw fee especially if there are fee overrides.</p>
        ProductId:
          type: integer
          description: >-
            The ID of the product intended to be withdrawn. Fees may vary with
            product. Not explicitly required but needs to be defined to get the
            accurate estimate of withdraw fee.
          x-gitbook-description-html: >-
            <p>The ID of the product intended to be withdrawn. Fees may vary
            with product. Not explicitly required but needs to be defined to get
            the accurate estimate of withdraw fee.</p>
        Amount:
          type: number
          format: decimal
          description: >-
            The amount of product intended to be withdrawn, not explicitly
            required but needs to be defined to get the accurate estimate of
            withdraw fee.
          x-gitbook-description-html: >-
            <p>The amount of product intended to be withdrawn, not explicitly
            required but needs to be defined to get the accurate estimate of
            withdraw fee.</p>
        AccountProviderId:
          type: integer
          default: 0
          description: >-
            Defining an ID here makes sure the fee is accurate according to the
            account provider used to withdraw. Default is 0.
          x-gitbook-description-html: >-
            <p>Defining an ID here makes sure the fee is accurate according to
            the account provider used to withdraw. Default is 0.</p>
      required:
        - OMSId
        - AccountId
        - ProductId
        - Amount
    GetWithdrawFeeResponse:
      type: object
      properties:
        FeeAmount:
          type: number
          format: decimal
          description: The estimated amount of the fee for the indicated withdrawal.
          x-gitbook-description-html: <p>The estimated amount of the fee for the indicated withdrawal.</p>
        TicketAmount:
          type: number
          format: decimal
          description: The amount of product intended to be withdrawn.
          x-gitbook-description-html: <p>The amount of product intended to be withdrawn.</p>
      required:
        - FeeAmount
        - TicketAmount
    GetDepositFeeRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS.
          x-gitbook-description-html: <p>The ID of the OMS.</p>
        AccountId:
          type: integer
          description: >-
            The ID of the account making the deposit. Not explicitly required
            but needs to be defined to get the accurate estimate of deposit fee
            especially if there is/are fee override/s.
          x-gitbook-description-html: >-
            <p>The ID of the account making the deposit. Not explicitly required
            but needs to be defined to get the accurate estimate of deposit fee
            especially if there is/are fee override/s.</p>
        ProductId:
          type: integer
          description: >-
            The ID of the product intended to be deposited. Fees may vary with
            product. Not explicitly required but needs to be defined to get the
            accurate estimate of deposit fee.
          x-gitbook-description-html: >-
            <p>The ID of the product intended to be deposited. Fees may vary
            with product. Not explicitly required but needs to be defined to get
            the accurate estimate of deposit fee.</p>
        Amount:
          type: number
          format: decimal
          description: >-
            The amount of product intended to be deposited. Not explicitly
            required but needs to be defined to get the accurate estimate of
            deposit fee.
          x-gitbook-description-html: >-
            <p>The amount of product intended to be deposited. Not explicitly
            required but needs to be defined to get the accurate estimate of
            deposit fee.</p>
        AccountProviderId:
          type: integer
          default: 0
          description: >-
            Defining an ID here makes sure the fee is accurate according to the
            account provider used to deposit. Default is 0.
          x-gitbook-description-html: >-
            <p>Defining an ID here makes sure the fee is accurate according to
            the account provider used to deposit. Default is 0.</p>
      required:
        - OMSId
        - AccountId
        - ProductId
        - Amount
    GetDepositFeeResponse:
      type: object
      properties:
        FeeAmount:
          type: number
          format: decimal
          description: The estimated amount of the fee for the indicated deposit.
          x-gitbook-description-html: <p>The estimated amount of the fee for the indicated deposit.</p>
        TicketAmount:
          type: number
          format: decimal
          description: The amount of product intended to be deposited.
          x-gitbook-description-html: <p>The amount of product intended to be deposited.</p>
      required:
        - FeeAmount
        - TicketAmount
    GetOMSWithdrawFeesRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS.
          x-gitbook-description-html: <p>The ID of the OMS.</p>
        ProductId:
          type: integer
          description: >-
            The ID of the product in the OMS you wish to retrieve withdraw fees
            of. If not defined, withdraw fees for all products will be returned.
          x-gitbook-description-html: >-
            <p>The ID of the product in the OMS you wish to retrieve withdraw
            fees of. If not defined, withdraw fees for all products will be
            returned.</p>
        AccountProviderId:
          type: integer
          description: >-
            The ID of account provider in the OMS you wish to retrieve withdraw
            fees of. If not defined, withdraw fees for all account providers
            will be returned.
          x-gitbook-description-html: >-
            <p>The ID of account provider in the OMS you wish to retrieve
            withdraw fees of. If not defined, withdraw fees for all account
            providers will be returned.</p>
      required:
        - OMSId
    GetOMSWithdrawFeesResponse:
      type: array
      items:
        type: object
        properties:
          OMSId:
            type: integer
            description: The ID of the OMS.
            x-gitbook-description-html: <p>The ID of the OMS.</p>
          AccountId:
            type: integer
            description: >-
              The ID of the account to which the fee will apply. If its value is
              0, fee will apply to any account doing a withdraw of the the
              specific product defined in the withdraw fee.
            x-gitbook-description-html: >-
              <p>The ID of the account to which the fee will apply. If its value
              is 0, fee will apply to any account doing a withdraw of the the
              specific product defined in the withdraw fee.</p>
          AccountProviderId:
            type: integer
            description: >-
              The ID of the account provider to which the fee will apply. If its
              value 0, fee will apply regardless of the account provider used
              for the withdraw transaction.
            x-gitbook-description-html: >-
              <p>The ID of the account provider to which the fee will apply. If
              its value 0, fee will apply regardless of the account provider
              used for the withdraw transaction.</p>
          FeeId:
            type: integer
            description: The ID of the specific withdraw fee.
            x-gitbook-description-html: <p>The ID of the specific withdraw fee.</p>
          FeeAmt:
            type: number
            format: decimal
            description: The standard withdraw fee amount.
            x-gitbook-description-html: <p>The standard withdraw fee amount.</p>
          FeeCalcType:
            type: string
            enum:
              - Percentage
              - Flat
            description: >-
              The way to calculate the standard fee amount. One of:
              **Percentage**, **Flat**.
            x-gitbook-description-html: >-
              <p>The way to calculate the standard fee amount. One of:
              <strong>Percentage</strong>, <strong>Flat</strong>.</p>
          IsActive:
            type: boolean
            description: If true, fee will apply, else it will not.
            x-gitbook-description-html: <p>If true, fee will apply, else it will not.</p>
          ProductId:
            type: integer
            description: >-
              The ID of the product for which the specific withdraw fee will
              apply.
            x-gitbook-description-html: >-
              <p>The ID of the product for which the specific withdraw fee will
              apply.</p>
          MinimalFeeAmt:
            type: number
            format: decimal
            description: The minimum withdraw fee amount.
            x-gitbook-description-html: <p>The minimum withdraw fee amount.</p>
          MinimalFeeCalcType:
            type: string
            enum:
              - Percentage
              - Flat
            description: >-
              The way to calculate the minimum withdraw fee. One of:
              **Percentage**, **Flat**.
            x-gitbook-description-html: >-
              <p>The way to calculate the minimum withdraw fee. One of:
              <strong>Percentage</strong>, <strong>Flat</strong>.</p>
        required:
          - OMSId
          - AccountId
          - AccountProviderId
          - FeeId
          - FeeAmt
          - FeeCalcType
          - IsActive
          - ProductId
          - MinimalFeeAmt
          - MinimalFeeCalcType
    GetOMSDepositFeesRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS.
          x-gitbook-description-html: <p>The ID of the OMS.</p>
        ProductId:
          type: integer
          description: >-
            The ID of the product in the OMS you wish to retrieve deposit fees
            of. If not defined, deposit fees for all products will be returned.
          x-gitbook-description-html: >-
            <p>The ID of the product in the OMS you wish to retrieve deposit
            fees of. If not defined, deposit fees for all products will be
            returned.</p>
        AccountProviderId:
          type: integer
          description: >-
            The ID of account provider in the OMS you wish to retrieve deposit
            fees of. If not defined, deposit fees for all account providers will
            be returned.
          x-gitbook-description-html: >-
            <p>The ID of account provider in the OMS you wish to retrieve
            deposit fees of. If not defined, deposit fees for all account
            providers will be returned.</p>
      required:
        - OMSId
    GetOMSDepositFeesResponse:
      type: array
      items:
        type: object
        properties:
          OMSId:
            type: integer
            description: The ID of the OMS.
            x-gitbook-description-html: <p>The ID of the OMS.</p>
          AccountId:
            type: integer
            description: >-
              The ID of the account to which the fee will apply, if set to 0,
              fee will apply to any account doing a deposit of the the specific
              product defined in the deposit fee.
            x-gitbook-description-html: >-
              <p>The ID of the account to which the fee will apply, if set to 0,
              fee will apply to any account doing a deposit of the the specific
              product defined in the deposit fee.</p>
          AccountProviderId:
            type: integer
            description: >-
              The ID of the account provider to which the fee will apply, if set
              to 0, fee will apply regardless of the account provider used for
              the deposit transaction.
            x-gitbook-description-html: >-
              <p>The ID of the account provider to which the fee will apply, if
              set to 0, fee will apply regardless of the account provider used
              for the deposit transaction.</p>
          FeeId:
            type: integer
            description: The ID of the specific deposit fee.
            x-gitbook-description-html: <p>The ID of the specific deposit fee.</p>
          FeeAmt:
            type: number
            format: decimal
            description: The standard deposit fee amount.
            x-gitbook-description-html: <p>The standard deposit fee amount.</p>
          FeeCalcType:
            type: string
            enum:
              - Percentage
              - Flat
            description: >-
              The way to calculate the standard fee amount. One of:
              **Percentage**, **Flat**.
            x-gitbook-description-html: >-
              <p>The way to calculate the standard fee amount. One of:
              <strong>Percentage</strong>, <strong>Flat</strong>.</p>
          IsActive:
            type: boolean
            description: If true, fee will apply, else it will not.
            x-gitbook-description-html: <p>If true, fee will apply, else it will not.</p>
          ProductId:
            type: integer
            description: >-
              The ID of the product for which the specific deposit fee will
              apply.
            x-gitbook-description-html: >-
              <p>The ID of the product for which the specific deposit fee will
              apply.</p>
          MinimalFeeAmt:
            type: number
            format: decimal
            description: >-
              Not yet supported in the current latest NotBank version; for
              future provision. The minimum deposit fee amount. This will be the
              lowest amount of fee charged for each deposit.
            x-gitbook-description-html: >-
              <p>Not yet supported in the current latest NotBank version; for
              future provision. The minimum deposit fee amount. This will be the
              lowest amount of fee charged for each deposit.</p>
          MinimalFeeCalcType:
            type: string
            enum:
              - Percentage
              - Flat
            description: >-
              Not yet supported in the current latest NotBank version; for
              future provision. he way to calculate the minimum withdraw fee.
              One of: **Percentage**, **Flat**.
            x-gitbook-description-html: >-
              <p>Not yet supported in the current latest NotBank version; for
              future provision. he way to calculate the minimum withdraw fee.
              One of: <strong>Percentage</strong>, <strong>Flat</strong>.</p>
        required:
          - OMSId
          - AccountId
          - AccountProviderId
          - FeeId
          - FeeAmt
          - FeeCalcType
          - IsActive
          - ProductId
          - MinimalFeeAmt
          - MinimalFeeCalcType
    GetAccountFeesRequest:
      type: object
      properties:
        AccountId:
          type: integer
          description: The ID of the account whose fees will be retrieved.
          x-gitbook-description-html: <p>The ID of the account whose fees will be retrieved.</p>
        OMSId:
          type: integer
          description: The ID of the OMS.
          x-gitbook-description-html: <p>The ID of the OMS.</p>
      required:
        - AccountId
        - OMSId
    GetAccountFeesResponse:
      type: array
      items:
        type: object
        properties:
          FeeId:
            type: integer
            description: The ID of the fee.
            x-gitbook-description-html: <p>The ID of the fee.</p>
          OMSId:
            type: integer
            description: The ID the OMS.
            x-gitbook-description-html: <p>The ID the OMS.</p>
          FeeTier:
            type: integer
            description: The tier of the fee, the same with the fee tier of the account.
            x-gitbook-description-html: >-
              <p>The tier of the fee, the same with the fee tier of the
              account.</p>
          AccountId:
            type: integer
            description: >-
              The ID of the account to which the fee will apply, 0 means it will
              apply to all accounts with the same fee tier.
            x-gitbook-description-html: >-
              <p>The ID of the account to which the fee will apply, 0 means it
              will apply to all accounts with the same fee tier.</p>
          FeeAmt:
            type: number
            format: decimal
            description: >-
              The actual fee amount if **FeeCalcType** is Flat. Otherwise if
              **Percentage**, this represents the percentage of the trade value.
            x-gitbook-description-html: >-
              <p>The actual fee amount if <strong>FeeCalcType</strong> is Flat.
              Otherwise if <strong>Percentage</strong>, this represents the
              percentage of the trade value.</p>
          FeeCalcType:
            type: string
            enum:
              - Flat
              - Percentage
            description: 'One of: **Flat**, **Percentage**.'
            x-gitbook-description-html: '<p>One of: <strong>Flat</strong>, <strong>Percentage</strong>.</p>'
          FeeType:
            type: string
            enum:
              - Flat
              - MakerFee
              - TakerFee
              - PeggedProductFee
              - AffiliateFee
            description: >-
              One of: **Flat**, **MakerFee**, **TakerFee**,
              **PeggedProductFee**, **AffiliateFee**.
            x-gitbook-description-html: >-
              <p>One of: <strong>Flat</strong>, <strong>MakerFee</strong>,
              <strong>TakerFee</strong>, <strong>PeggedProductFee</strong>,
              <strong>AffiliateFee</strong>.</p>
          LadderThreshold:
            type: number
            format: decimal
            description: The ladder threshold of the fee.
            x-gitbook-description-html: <p>The ladder threshold of the fee.</p>
          LadderSeconds:
            type: integer
            description: .
            x-gitbook-description-html: <p>.</p>
          IsActive:
            type: boolean
            description: >-
              If true, means can apply to a trade, else it will not even if
              criteria are met.
            x-gitbook-description-html: >-
              <p>If true, means can apply to a trade, else it will not even if
              criteria are met.</p>
          InstrumentId:
            type: integer
            description: The ID of the instrument to which the fee will apply.
            x-gitbook-description-html: <p>The ID of the instrument to which the fee will apply.</p>
          OrderType:
            type: string
            enum:
              - Market
              - Limit
              - StopMarket
              - StopLimit
              - TrailingStopMarket
              - TrailingStopLimit
              - BlockTrade
              - Unknown
            description: >-
              The type of order where fee will only apply. One of: **Market**,
              **Limit**, **StopMarket**, **StopLimit**,**TrailingStopMarket**,
              **TrailingStopLimit**, **BlockTrade**, **Unknown**. Unknown means
              all order types.
            x-gitbook-description-html: >-
              <p>The type of order where fee will only apply. One of:
              <strong>Market</strong>, <strong>Limit</strong>,
              <strong>StopMarket</strong>,
              <strong>StopLimit</strong>,<strong>TrailingStopMarket</strong>,
              <strong>TrailingStopLimit</strong>, <strong>BlockTrade</strong>,
              <strong>Unknown</strong>. Unknown means all order types.</p>
          PeggedProductId:
            type: integer
            description: >-
              The ID of the pegged product if the FeeType is
              **PeggedProductFee**.
            x-gitbook-description-html: >-
              <p>The ID of the pegged product if the FeeType is
              <strong>PeggedProductFee</strong>.</p>
        required:
          - FeeId
          - OMSId
          - FeeTier
          - AccountId
          - FeeAmt
          - FeeCalcType
          - FeeType
          - LadderThreshold
          - LadderSeconds
          - IsActive
          - InstrumentId
          - OrderType
          - PeggedProductId
    GetOrderFeeRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS on which the trade would take place.
          x-gitbook-description-html: <p>The ID of the OMS on which the trade would take place.</p>
        AccountId:
          type: integer
          description: The ID of the account requesting the fee estimate.
          x-gitbook-description-html: <p>The ID of the account requesting the fee estimate.</p>
        InstrumentId:
          type: integer
          description: The ID of the instrument being or to be traded.
          x-gitbook-description-html: <p>The ID of the instrument being or to be traded.</p>
        Quantity:
          type: number
          format: decimal
          description: >-
            The quantity or amount of the proposed trade for which the OMS would
            charge a fee.
          x-gitbook-description-html: >-
            <p>The quantity or amount of the proposed trade for which the OMS
            would charge a fee.</p>
        Price:
          type: number
          format: decimal
          description: >-
            The price at which the proposed trade would take place. Supply your
            price for a limit order; the exact price is difficult to know before
            execution.
          x-gitbook-description-html: >-
            <p>The price at which the proposed trade would take place. Supply
            your price for a limit order; the exact price is difficult to know
            before execution.</p>
        OrderType:
          type: integer
          enum:
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
          description: >-
            The type of the proposed order. One of: 0 Unknown, 1 Market, 2
            Limit, 3 StopMarket, 4 StopLimit, 5 TrailingStopMarket, 6
            TrailingStopLimit, 7 BlockTrade.
          x-gitbook-description-html: >-
            <p>The type of the proposed order. One of: 0 Unknown, 1 Market, 2
            Limit, 3 StopMarket, 4 StopLimit, 5 TrailingStopMarket, 6
            TrailingStopLimit, 7 BlockTrade.</p>
        MakerTaker:
          type: integer
          description: >-
            Depending on the venue, there may be different fees for a maker (one
            who places the order on the books, either buy or sell) or taker (one
            who accepts the order, either buy or sell). If the user places a
            large order that is only partially filled, he is a partial maker.
            One of:. -0 Unknown. -1 Maker. -2 Taker.
          x-gitbook-description-html: >-
            <p>Depending on the venue, there may be different fees for a maker
            (one who places the order on the books, either buy or sell) or taker
            (one who accepts the order, either buy or sell). If the user places
            a large order that is only partially filled, he is a partial maker.
            One of:. -0 Unknown. -1 Maker. -2 Taker.</p>
        Side:
          type: integer
          enum:
            - 0
            - 1
            - 2
            - 3
          description: >-
            Side of the trade. It will decide at which product will the fee be
            donominated. In NotBank, the fee is charged in the incoming product
            by default. One of: 0 Buy, 1 Sell, 2 Short, 3 Unknown.
          x-gitbook-description-html: >-
            <p>Side of the trade. It will decide at which product will the fee
            be donominated. In NotBank, the fee is charged in the incoming
            product by default. One of: 0 Buy, 1 Sell, 2 Short, 3 Unknown.</p>
      required:
        - OMSId
        - AccountId
        - InstrumentId
        - Quantity
        - Price
        - OrderType
        - MakerTaker
        - Side
    GetOrderFeeResponse:
      type: object
      properties:
        OrderFee:
          type: number
          format: decimal
          description: The estimated fee for the trade as described.
          x-gitbook-description-html: <p>The estimated fee for the trade as described.</p>
        ProductId:
          type: integer
          description: The ID of the product (currency) in which the fee is denominated.
          x-gitbook-description-html: >-
            <p>The ID of the product (currency) in which the fee is
            denominated.</p>
      required:
        - OrderFee
        - ProductId
    GetInstrumentRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS.
          x-gitbook-description-html: <p>The ID of the OMS.</p>
        InstrumentId:
          type: integer
          description: The ID of the instrument.
          x-gitbook-description-html: <p>The ID of the instrument.</p>
      required:
        - OMSId
        - InstrumentId
    GetInstrumentResponse:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS on which the instrument is traded.
          x-gitbook-description-html: <p>The ID of the OMS on which the instrument is traded.</p>
        InstrumentId:
          type: integer
          description: The ID of the instrument.
          x-gitbook-description-html: <p>The ID of the instrument.</p>
        Symbol:
          type: string
          description: Trading symbol of the instrument, for example BTCUSD.
          x-gitbook-description-html: <p>Trading symbol of the instrument, for example BTCUSD.</p>
        Product1:
          type: integer
          description: >-
            The ID of the first product comprising the instrument or the ID of
            the base product/currency of the instrument.
          x-gitbook-description-html: >-
            <p>The ID of the first product comprising the instrument or the ID
            of the base product/currency of the instrument.</p>
        Product1Symbol:
          type: string
          description: >-
            The symbol of the first product comprising the instrument or the
            symbol of the base product/currency of the instrument.
          x-gitbook-description-html: >-
            <p>The symbol of the first product comprising the instrument or the
            symbol of the base product/currency of the instrument.</p>
        Product2:
          type: integer
          description: >-
            The ID of the second product comprising the instrument or the ID of
            the quote product/currency of the instrument.
          x-gitbook-description-html: >-
            <p>The ID of the second product comprising the instrument or the ID
            of the quote product/currency of the instrument.</p>
        Product2Symbol:
          type: string
          description: >-
            The symbol of the second product comprising the instrument or the
            symbol of the quote product/currency of the instrument.
          x-gitbook-description-html: >-
            <p>The symbol of the second product comprising the instrument or the
            symbol of the quote product/currency of the instrument.</p>
        InstrumentType:
          type: string
          description: >-
            A number representing the type of the instrument. All instrument
            types currently are _standard_, an exchange of one product for
            another (or _unknown_, an error condition), but this may expand to
            new types in the future., 0 Unknown (an error condition), 1
            Standard.
          x-gitbook-description-html: >-
            <p>A number representing the type of the instrument. All instrument
            types currently are <em>standard</em>, an exchange of one product
            for another (or <em>unknown</em>, an error condition), but this may
            expand to new types in the future., 0 Unknown (an error condition),
            1 Standard.</p>
        VenueInstrumentId:
          type: integer
          description: >-
            A venue instrument is created at the exchange level as an instrument
            "template" for adding new instruments to the exchange. This is the
            ID of the venue instrument behind the instrument being requested.
          x-gitbook-description-html: >-
            <p>A venue instrument is created at the exchange level as an
            instrument "template" for adding new instruments to the exchange.
            This is the ID of the venue instrument behind the instrument being
            requested.</p>
        VenueId:
          type: integer
          description: The ID of the trading venue on which the instrument trades.
          x-gitbook-description-html: <p>The ID of the trading venue on which the instrument trades.</p>
        SortIndex:
          type: integer
          description: >-
            The numerical position in which to sort the returned list of
            instruments on a visual display. Since this call returns information
            about a single instrument, _SortIndex_ should return 0.
          x-gitbook-description-html: >-
            <p>The numerical position in which to sort the returned list of
            instruments on a visual display. Since this call returns information
            about a single instrument, <em>SortIndex</em> should return 0.</p>
        SessionStatus:
          type: string
          enum:
            - Unknown
            - Running
            - Paused
            - Stopped
            - Starting
            - RunningPostOnly
          description: >-
            The current session status of the instrument. One of: 0 Unknown, 1
            Running, 2 Paused, 3 Stopped, 4 Starting, 5 RunningPostOnly.
          x-gitbook-description-html: >-
            <p>The current session status of the instrument. One of: 0 Unknown,
            1 Running, 2 Paused, 3 Stopped, 4 Starting, 5 RunningPostOnly.</p>
        PreviousSessionStatus:
          type: string
          enum:
            - Unknown
            - Running
            - Paused
            - Stopped
            - Starting
            - RunningPostOnly
          description: >-
            The previous session status of the instrument. One of: 0 Unknown, 1
            Running, 2 Paused, 3 Stopped, 4 Starting, 5 RunningPostOnly.
          x-gitbook-description-html: >-
            <p>The previous session status of the instrument. One of: 0 Unknown,
            1 Running, 2 Paused, 3 Stopped, 4 Starting, 5 RunningPostOnly.</p>
        SessionStatusDateTime:
          type: string
          description: >-
            The time and date at which the session status was reported, in
            Microsoft Ticks format.
          x-gitbook-description-html: >-
            <p>The time and date at which the session status was reported, in
            Microsoft Ticks format.</p>
        SelfTradePrevention:
          type: boolean
          default: false
          description: >-
            An account that is trading with itself still incurs fees. If this
            instrument prevents an account from trading the instrument with
            itself, the value returns _true_. Default is _false_.
          x-gitbook-description-html: >-
            <p>An account that is trading with itself still incurs fees. If this
            instrument prevents an account from trading the instrument with
            itself, the value returns <em>true</em>. Default is
            <em>false</em>.</p>
        QuantityIncrement:
          type: number
          format: decimal
          description: >-
            The smallest tradeable increment of the instrument. For example, for
            BTCUSD, the quantity increment might be 0.0005, but for ETHUSD, the
            quantity increment might be 50.
          x-gitbook-description-html: >-
            <p>The smallest tradeable increment of the instrument. For example,
            for BTCUSD, the quantity increment might be 0.0005, but for ETHUSD,
            the quantity increment might be 50.</p>
        PriceIncrement:
          type: number
          format: decimal
          description: >-
            The smallest amount by which the instrument can rise or fall in the
            market.
          x-gitbook-description-html: >-
            <p>The smallest amount by which the instrument can rise or fall in
            the market.</p>
        MinimumQuantity:
          type: number
          format: decimal
          description: The smallest quantity at which the instrument can be traded.
          x-gitbook-description-html: <p>The smallest quantity at which the instrument can be traded.</p>
        MinimumPrice:
          type: number
          format: decimal
          description: The lowest price that the instrument can have.
          x-gitbook-description-html: <p>The lowest price that the instrument can have.</p>
        VenueSymbol:
          type: string
          description: The symbol of the instrument in the trading venue or exchange.
          x-gitbook-description-html: >-
            <p>The symbol of the instrument in the trading venue or
            exchange.</p>
        IsDisable:
          type: boolean
          description: >-
            Identifies if the instrument is available to be traded or not, if
            true, instrument cannot be traded, else it can be traded but would
            still depend on the **SessionStatus**.
          x-gitbook-description-html: >-
            <p>Identifies if the instrument is available to be traded or not, if
            true, instrument cannot be traded, else it can be traded but would
            still depend on the <strong>SessionStatus</strong>.</p>
        PriceFloorLimit:
          type: number
          format: decimal
          description: >-
            The lowest price that the instrument can be traded in a specific
            session; for instance, daily price floor limit of an instrument can
            change, it really depends on regulator requirements most of the
            time.
          x-gitbook-description-html: >-
            <p>The lowest price that the instrument can be traded in a specific
            session; for instance, daily price floor limit of an instrument can
            change, it really depends on regulator requirements most of the
            time.</p>
        PriceFloorLimitEnabled:
          type: boolean
          description: If enabled price floor limit will apply.
          x-gitbook-description-html: <p>If enabled price floor limit will apply.</p>
        PriceCeilingLimit:
          type: number
          format: decimal
          description: >-
            The highest price that the instrument can be traded in a specific
            session; for instance, daily price ceiling limit of an instrument
            can change, it really depends on regulator requirements most of the
            time.
          x-gitbook-description-html: >-
            <p>The highest price that the instrument can be traded in a specific
            session; for instance, daily price ceiling limit of an instrument
            can change, it really depends on regulator requirements most of the
            time.</p>
        PriceCeilingLimitEnabled:
          type: boolean
          description: If enabled price ceiling limit will apply.
          x-gitbook-description-html: <p>If enabled price ceiling limit will apply.</p>
        PriceTier:
          type: integer
          description: The price tier the instrument.
          x-gitbook-description-html: <p>The price tier the instrument.</p>
      required:
        - OMSId
        - InstrumentId
        - Symbol
        - Product1
        - Product1Symbol
        - Product2
        - Product2Symbol
        - InstrumentType
        - VenueInstrumentId
        - VenueId
        - SortIndex
        - SessionStatus
        - PreviousSessionStatus
        - SessionStatusDateTime
        - SelfTradePrevention
        - QuantityIncrement
        - PriceIncrement
        - MinimumQuantity
        - MinimumPrice
        - VenueSymbol
        - IsDisable
        - PriceFloorLimit
        - PriceFloorLimitEnabled
        - PriceCeilingLimit
        - PriceCeilingLimitEnabled
        - PriceTier
    GetInstrumentsRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS on which the instruments are available.
          x-gitbook-description-html: <p>The ID of the OMS on which the instruments are available.</p>
        InstrumentState:
          type: string
          enum:
            - Both
            - Inactive
          description: >-
            Filters the results, you can include disabled instruments in the
            results, or you can just get disabled instruments if you want. One
            of: **Both**, **Inactive**. If set to **Both**, response will
            include all the instruments even the disabled instruments, if set to
            **Inactive**, response will only include all the **disabled**
            instruments, if not set, response will only return **enabled or
            active** instruments.
          x-gitbook-description-html: >-
            <p>Filters the results, you can include disabled instruments in the
            results, or you can just get disabled instruments if you want. One
            of: <strong>Both</strong>, <strong>Inactive</strong>. If set to
            <strong>Both</strong>, response will include all the instruments
            even the disabled instruments, if set to <strong>Inactive</strong>,
            response will only include all the <strong>disabled</strong>
            instruments, if not set, response will only return <strong>enabled
            or active</strong> instruments.</p>
      required:
        - OMSId
    GetInstrumentsResponse:
      type: array
      items:
        type: object
        properties:
          OMSId:
            type: integer
            description: The ID of the OMS on which the instrument is traded.
            x-gitbook-description-html: <p>The ID of the OMS on which the instrument is traded.</p>
          InstrumentId:
            type: integer
            description: The ID of the instrument.
            x-gitbook-description-html: <p>The ID of the instrument.</p>
          Symbol:
            type: string
            description: Trading symbol of the instrument, for example BTCUSD.
            x-gitbook-description-html: <p>Trading symbol of the instrument, for example BTCUSD.</p>
          Product1:
            type: integer
            description: >-
              The ID of the first product comprising the instrument or the ID of
              the base product/currency of the instrument.
            x-gitbook-description-html: >-
              <p>The ID of the first product comprising the instrument or the ID
              of the base product/currency of the instrument.</p>
          Product1Symbol:
            type: string
            description: >-
              The symbol of the first product comprising the instrument or the
              symbol of the base product/currency of the instrument.
            x-gitbook-description-html: >-
              <p>The symbol of the first product comprising the instrument or
              the symbol of the base product/currency of the instrument.</p>
          Product2:
            type: integer
            description: >-
              The ID of the second product comprising the instrument or the ID
              of the quote product/currency of the instrument.
            x-gitbook-description-html: >-
              <p>The ID of the second product comprising the instrument or the
              ID of the quote product/currency of the instrument.</p>
          Product2Symbol:
            type: string
            description: >-
              The symbol of the second product comprising the instrument or the
              symbol of the quote product/currency of the instrument.
            x-gitbook-description-html: >-
              <p>The symbol of the second product comprising the instrument or
              the symbol of the quote product/currency of the instrument.</p>
          InstrumentType:
            type: string
            description: >-
              A number representing the type of the instrument. All instrument
              types currently are _standard_, an exchange of one product for
              another (or _unknown_, an error condition), but this may expand to
              new types in the future., 0 Unknown (an error condition), 1
              Standard.
            x-gitbook-description-html: >-
              <p>A number representing the type of the instrument. All
              instrument types currently are <em>standard</em>, an exchange of
              one product for another (or <em>unknown</em>, an error condition),
              but this may expand to new types in the future., 0 Unknown (an
              error condition), 1 Standard.</p>
          VenueInstrumentId:
            type: integer
            description: >-
              A venue instrument is created at the exchange level as an
              instrument "template" for adding new instruments to the exchange.
              This is the ID of the venue instrument behind the instrument being
              requested.
            x-gitbook-description-html: >-
              <p>A venue instrument is created at the exchange level as an
              instrument "template" for adding new instruments to the exchange.
              This is the ID of the venue instrument behind the instrument being
              requested.</p>
          VenueId:
            type: integer
            description: The ID of the trading venue on which the instrument trades.
            x-gitbook-description-html: <p>The ID of the trading venue on which the instrument trades.</p>
          SortIndex:
            type: integer
            description: >-
              The numerical position in which to sort the returned list of
              instruments on a visual display. Since this call returns
              information about a single instrument, _SortIndex_ should return
              0.
            x-gitbook-description-html: >-
              <p>The numerical position in which to sort the returned list of
              instruments on a visual display. Since this call returns
              information about a single instrument, <em>SortIndex</em> should
              return 0.</p>
          SessionStatus:
            type: string
            enum:
              - Unknown
              - Running
              - Paused
              - Stopped
              - Starting
              - RunningPostOnly
            description: >-
              The current session status of the instrument. One of: 0 Unknown, 1
              Running, 2 Paused, 3 Stopped, 4 Starting, 5 RunningPostOnly.
            x-gitbook-description-html: >-
              <p>The current session status of the instrument. One of: 0
              Unknown, 1 Running, 2 Paused, 3 Stopped, 4 Starting, 5
              RunningPostOnly.</p>
          PreviousSessionStatus:
            type: string
            enum:
              - Unknown
              - Running
              - Paused
              - Stopped
              - Starting
              - RunningPostOnly
            description: >-
              The previous session status of the instrument. One of: 0 Unknown,
              1 Running, 2 Paused, 3 Stopped, 4 Starting, 5 RunningPostOnly.
            x-gitbook-description-html: >-
              <p>The previous session status of the instrument. One of: 0
              Unknown, 1 Running, 2 Paused, 3 Stopped, 4 Starting, 5
              RunningPostOnly.</p>
          SessionStatusDateTime:
            type: string
            description: >-
              The time and date at which the session status was reported, in
              Microsoft Ticks format.
            x-gitbook-description-html: >-
              <p>The time and date at which the session status was reported, in
              Microsoft Ticks format.</p>
          SelfTradePrevention:
            type: boolean
            default: false
            description: >-
              An account that is trading with itself still incurs fees. If this
              instrument prevents an account from trading the instrument with
              itself, the value returns _true_. Default is _false_.
            x-gitbook-description-html: >-
              <p>An account that is trading with itself still incurs fees. If
              this instrument prevents an account from trading the instrument
              with itself, the value returns <em>true</em>. Default is
              <em>false</em>.</p>
          QuantityIncrement:
            type: number
            format: decimal
            description: >-
              The smallest tradeable increment of the instrument. For example,
              for BTCUSD, the quantity increment might be 0.0005, but for
              ETHUSD, the quantity increment might be 50.
            x-gitbook-description-html: >-
              <p>The smallest tradeable increment of the instrument. For
              example, for BTCUSD, the quantity increment might be 0.0005, but
              for ETHUSD, the quantity increment might be 50.</p>
          PriceIncrement:
            type: number
            format: decimal
            description: >-
              The smallest amount by which the instrument can rise or fall in
              the market.
            x-gitbook-description-html: >-
              <p>The smallest amount by which the instrument can rise or fall in
              the market.</p>
          MinimumQuantity:
            type: number
            format: decimal
            description: The smallest quantity at which the instrument can be traded.
            x-gitbook-description-html: >-
              <p>The smallest quantity at which the instrument can be
              traded.</p>
          MinimumPrice:
            type: number
            format: decimal
            description: The lowest price that the instrument can have.
            x-gitbook-description-html: <p>The lowest price that the instrument can have.</p>
          VenueSymbol:
            type: string
            description: The symbol of the instrument in the trading venue or exchange.
            x-gitbook-description-html: >-
              <p>The symbol of the instrument in the trading venue or
              exchange.</p>
          IsDisable:
            type: boolean
            description: >-
              Identifies if the instrument is available to be traded or not, if
              true, instrument cannot be traded, else it can be traded but would
              still depend on the **SessionStatus**.
            x-gitbook-description-html: >-
              <p>Identifies if the instrument is available to be traded or not,
              if true, instrument cannot be traded, else it can be traded but
              would still depend on the <strong>SessionStatus</strong>.</p>
          PriceFloorLimit:
            type: number
            format: decimal
            description: >-
              The lowest price that the instrument can be traded in a specific
              session; for instance, daily price floor limit of an instrument
              can change.
            x-gitbook-description-html: >-
              <p>The lowest price that the instrument can be traded in a
              specific session; for instance, daily price floor limit of an
              instrument can change.</p>
          PriceFloorLimitEnabled:
            type: boolean
            description: If enabled price floor limit will apply.
            x-gitbook-description-html: <p>If enabled price floor limit will apply.</p>
          PriceCeilingLimit:
            type: number
            format: decimal
            description: >-
              The highest price that the instrument can be traded in a specific
              session; for instance, daily price ceiling limit of an instrument
              can change.
            x-gitbook-description-html: >-
              <p>The highest price that the instrument can be traded in a
              specific session; for instance, daily price ceiling limit of an
              instrument can change.</p>
          PriceCeilingLimitEnabled:
            type: boolean
            description: If enabled price ceiling limit will apply.
            x-gitbook-description-html: <p>If enabled price ceiling limit will apply.</p>
          PriceTier:
            type: integer
            description: The price tier the instrument.
            x-gitbook-description-html: <p>The price tier the instrument.</p>
        required:
          - OMSId
          - InstrumentId
          - Symbol
          - Product1
          - Product1Symbol
          - Product2
          - Product2Symbol
          - InstrumentType
          - VenueInstrumentId
          - VenueId
          - SortIndex
          - SessionStatus
          - PreviousSessionStatus
          - SessionStatusDateTime
          - SelfTradePrevention
          - QuantityIncrement
          - PriceIncrement
          - MinimumQuantity
          - MinimumPrice
          - VenueSymbol
          - IsDisable
          - PriceFloorLimit
          - PriceFloorLimitEnabled
          - PriceCeilingLimit
          - PriceCeilingLimitEnabled
          - PriceTier
    GetInstrumentVerificationLevelConfigRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS on which the account resides.
          x-gitbook-description-html: <p>The ID of the OMS on which the account resides.</p>
        AccountId:
          type: integer
          description: >-
            The ID of the account for which you wish to get instrument
            verification level config for.
          x-gitbook-description-html: >-
            <p>The ID of the account for which you wish to get instrument
            verification level config for.</p>
      required:
        - OMSId
        - AccountId
    GetInstrumentVerificationLevelConfigResponse:
      type: object
      properties:
        Level:
          type: integer
          description: The verification level the account specified is currently on.
          x-gitbook-description-html: <p>The verification level the account specified is currently on.</p>
        LevelName:
          type: string
          description: The of the verification level the account specified is currently on.
          x-gitbook-description-html: >-
            <p>The of the verification level the account specified is currently
            on.</p>
        OMSId:
          type: integer
          description: The ID of the OMS on which the account resides.
          x-gitbook-description-html: <p>The ID of the OMS on which the account resides.</p>
        Instruments:
          type: array
          description: >-
            An array of objects, each object will contain the limits of a
            specific instrument.
          items:
            type: object
            properties:
              InstrumentId:
                type: integer
                description: The ID of the of the instrument for which the limits apply to.
                x-gitbook-description-html: >-
                  <p>The ID of the of the instrument for which the limits apply
                  to.</p>
              InstrumentName:
                type: string
                description: The name of the instrument for which the limits apply to.
                x-gitbook-description-html: >-
                  <p>The name of the instrument for which the limits apply
                  to.</p>
              DailyBuyLimit:
                type: number
                format: decimal
                description: >-
                  The maximum amount of the specific instrument that the
                  specified account can buy within a day.
                x-gitbook-description-html: >-
                  <p>The maximum amount of the specific instrument that the
                  specified account can buy within a day.</p>
              DailySellLimit:
                type: number
                format: decimal
                description: >-
                  The maximum amount of the specific instrument that the
                  specified account can sell within a day.
                x-gitbook-description-html: >-
                  <p>The maximum amount of the specific instrument that the
                  specified account can sell within a day.</p>
              MonthlyBuyLimit:
                type: number
                format: decimal
                description: >-
                  The maximum amount of the specific instrument that the
                  specified account can buy within a month.
                x-gitbook-description-html: >-
                  <p>The maximum amount of the specific instrument that the
                  specified account can buy within a month.</p>
              MonthlySellLimit:
                type: number
                format: decimal
                description: >-
                  The maximum amount of the specific instrument that the
                  specified account can sell within a month.
                x-gitbook-description-html: >-
                  <p>The maximum amount of the specific instrument that the
                  specified account can sell within a month.</p>
              NotionalProductId:
                type: integer
                description: The Id of the notional product for the instrument.
                x-gitbook-description-html: <p>The Id of the notional product for the instrument.</p>
              DailyNotionalLimit:
                type: number
                format: decimal
                description: >-
                  The maximum notional amount of the specific instrument that
                  the specified account can buy and sell within a day. Buy and
                  Sell trade amount are combined.
                x-gitbook-description-html: >-
                  <p>The maximum notional amount of the specific instrument that
                  the specified account can buy and sell within a day. Buy and
                  Sell trade amount are combined.</p>
              MonthlyNotionalLimit:
                type: number
                format: decimal
                description: >-
                  The maximum notional amount of the specific instrument that
                  the specified account can buy and sell within a month. Buy and
                  Sell trade amount are combined.
                x-gitbook-description-html: >-
                  <p>The maximum notional amount of the specific instrument that
                  the specified account can buy and sell within a month. Buy and
                  Sell trade amount are combined.</p>
              YearlyNotionalLimit:
                type: number
                format: decimal
                description: >-
                  The maximum notional amount of the specific instrument that
                  the specified account can buy and sell within a year. Buy and
                  Sell trade amount are combined.
                x-gitbook-description-html: >-
                  <p>The maximum notional amount of the specific instrument that
                  the specified account can buy and sell within a year. Buy and
                  Sell trade amount are combined.</p>
            required:
              - InstrumentId
              - InstrumentName
              - DailyBuyLimit
              - DailySellLimit
              - MonthlyBuyLimit
              - MonthlySellLimit
              - NotionalProductId
              - DailyNotionalLimit
              - MonthlyNotionalLimit
              - YearlyNotionalLimit
          x-gitbook-description-html: >-
            <p>An array of objects, each object will contain the limits of a
            specific instrument.</p>
      required:
        - Level
        - LevelName
        - OMSId
        - Instruments
    GetProductRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS.
          x-gitbook-description-html: <p>The ID of the OMS.</p>
        ProductId:
          type: integer
          description: The ID of the product on the specified OMS.
          x-gitbook-description-html: <p>The ID of the product on the specified OMS.</p>
      required:
        - OMSId
        - ProductId
    GetProductResponse:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS on which the product resides.
          x-gitbook-description-html: <p>The ID of the OMS on which the product resides.</p>
        ProductId:
          type: integer
          description: The ID of the product.
          x-gitbook-description-html: <p>The ID of the product.</p>
        Product:
          type: string
          description: The symbol of the product.
          x-gitbook-description-html: <p>The symbol of the product.</p>
        ProductFullName:
          type: string
          description: The full name of the product.
          x-gitbook-description-html: <p>The full name of the product.</p>
        MasterDataUniqueProductSymbol:
          type: string
          description: Always an empty string, for future provision.
          x-gitbook-description-html: <p>Always an empty string, for future provision.</p>
        ProductType:
          type: string
          enum:
            - Unknown
            - NationalCurrency
            - CryptoCurrency
            - Contract
          description: >-
            The nature of the product. Unknown represents an error. One of: 0
            Unknown, 1 NationalCurrency, 2 CryptoCurrency, 3 Contract.
          x-gitbook-description-html: >-
            <p>The nature of the product. Unknown represents an error. One of: 0
            Unknown, 1 NationalCurrency, 2 CryptoCurrency, 3 Contract.</p>
        DecimalPlaces:
          type: integer
          description: >-
            The maximum number of decimal places allowed for the amount of
            product that an account may have.
          x-gitbook-description-html: >-
            <p>The maximum number of decimal places allowed for the amount of
            product that an account may have.</p>
        TickSize:
          type: number
          format: decimal
          description: >-
            The smallest increment of the amount of the specific product that an
            account may have.
          x-gitbook-description-html: >-
            <p>The smallest increment of the amount of the specific product that
            an account may have.</p>
        DepositEnabled:
          type: boolean
          description: If deposit for the product are enabled.
          x-gitbook-description-html: <p>If deposit for the product are enabled.</p>
        WithdrawEnabled:
          type: boolean
          description: If withdrawal for the product is enabled.
          x-gitbook-description-html: <p>If withdrawal for the product is enabled.</p>
        NoFees:
          type: boolean
          description: >-
            If _false_, fees incurred by the account can be charged in the
            denomination of the specific product. If _NoFees_ is _true_, fees
            incurred by the account will never be charged in the denomination of
            the specific product.
          x-gitbook-description-html: >-
            <p>If <em>false</em>, fees incurred by the account can be charged in
            the denomination of the specific product. If <em>NoFees</em> is
            <em>true</em>, fees incurred by the account will never be charged in
            the denomination of the specific product.</p>
        IsDisabled:
          type: boolean
          description: >-
            If true, product is disabled and cannot be used, no deposits and
            withdrawals can be done.
          x-gitbook-description-html: >-
            <p>If true, product is disabled and cannot be used, no deposits and
            withdrawals can be done.</p>
        MarginEnabled:
          type: boolean
          default: false
          description: >-
            Margin is not yet supported so defaults to false; for future
            provisions.
          x-gitbook-description-html: >-
            <p>Margin is not yet supported so defaults to false; for future
            provisions.</p>
      required:
        - OMSId
        - ProductId
        - Product
        - ProductFullName
        - MasterDataUniqueProductSymbol
        - ProductType
        - DecimalPlaces
        - TickSize
        - DepositEnabled
        - WithdrawEnabled
        - NoFees
        - IsDisabled
        - MarginEnabled
    GetProductsRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS.
          x-gitbook-description-html: <p>The ID of the OMS.</p>
        Attribute:
          type: string
          description: >-
            The attribute key or name for which you want to filter the results
            with.
          x-gitbook-description-html: >-
            <p>The attribute key or name for which you want to filter the
            results with.</p>
        AttributeValue:
          type: string
          description: >-
            Used to filter the results further, only products whose attribute
            value will match the one set will be returned.
          x-gitbook-description-html: >-
            <p>Used to filter the results further, only products whose attribute
            value will match the one set will be returned.</p>
        GetDisabled:
          type: boolean
          description: >-
            Used to filter disabled products, setting this to true will return
            all products including the disabled ones.
          x-gitbook-description-html: >-
            <p>Used to filter disabled products, setting this to true will
            return all products including the disabled ones.</p>
        Depth:
          type: integer
          default: 50
          description: >-
            Used for pagination. Indicates the maximum number of
            results/products to be returned. Default is 50.
          x-gitbook-description-html: >-
            <p>Used for pagination. Indicates the maximum number of
            results/products to be returned. Default is 50.</p>
        StartIndex:
          type: integer
          default: 0
          description: >-
            Used for pagination. ProductId 1 represents index 0. A value of 2
            for this field will not include ProductId 1 and 2 in the results.
            Default is 0.
          x-gitbook-description-html: >-
            <p>Used for pagination. ProductId 1 represents index 0. A value of 2
            for this field will not include ProductId 1 and 2 in the results.
            Default is 0.</p>
      required:
        - OMSId
    GetProductsResponse:
      type: array
      items:
        type: object
        properties:
          OMSId:
            type: integer
            description: The ID of the OMS on which the product resides.
            x-gitbook-description-html: <p>The ID of the OMS on which the product resides.</p>
          ProductId:
            type: integer
            description: The ID of the product.
            x-gitbook-description-html: <p>The ID of the product.</p>
          Product:
            type: string
            description: The symbol of the product.
            x-gitbook-description-html: <p>The symbol of the product.</p>
          ProductFullName:
            type: string
            description: The full name of the product.
            x-gitbook-description-html: <p>The full name of the product.</p>
          MasterDataUniqueProductSymbol:
            type: string
            description: Always an empty string, for future provision.
            x-gitbook-description-html: <p>Always an empty string, for future provision.</p>
          ProductType:
            type: string
            enum:
              - Unknown
              - NationalCurrency
              - CryptoCurrency
              - Contract
            description: >-
              The nature of the product. Unknown represents an error. One of: 0
              Unknown, 1 NationalCurrency, 2 CryptoCurrency, 3 Contract.
            x-gitbook-description-html: >-
              <p>The nature of the product. Unknown represents an error. One of:
              0 Unknown, 1 NationalCurrency, 2 CryptoCurrency, 3 Contract.</p>
          DecimalPlaces:
            type: integer
            description: >-
              The maximum number of decimal places allowed for the amount of
              product that an account may have.
            x-gitbook-description-html: >-
              <p>The maximum number of decimal places allowed for the amount of
              product that an account may have.</p>
          TickSize:
            type: number
            format: decimal
            description: >-
              The smallest increment of the amount of the specific product that
              an account may have.
            x-gitbook-description-html: >-
              <p>The smallest increment of the amount of the specific product
              that an account may have.</p>
          DepositEnabled:
            type: boolean
            description: If deposit for the product are enabled.
            x-gitbook-description-html: <p>If deposit for the product are enabled.</p>
          WithdrawEnabled:
            type: boolean
            description: If withdrawal for the product is enabled.
            x-gitbook-description-html: <p>If withdrawal for the product is enabled.</p>
          NoFees:
            type: boolean
            description: >-
              If _false_, fees incurred by the account can be charged in the
              denomination of the specific product. If _NoFees_ is _true_, fees
              incurred by the account will never be charged in the denomination
              of the specific product.
            x-gitbook-description-html: >-
              <p>If <em>false</em>, fees incurred by the account can be charged
              in the denomination of the specific product. If <em>NoFees</em> is
              <em>true</em>, fees incurred by the account will never be charged
              in the denomination of the specific product.</p>
          IsDisabled:
            type: boolean
            description: >-
              If true, product is disabled and cannot be used, no deposits and
              withdrawals can be done.
            x-gitbook-description-html: >-
              <p>If true, product is disabled and cannot be used, no deposits
              and withdrawals can be done.</p>
          MarginEnabled:
            type: boolean
            default: false
            description: >-
              Margin is not yet supported so defaults to false; for future
              provisions.
            x-gitbook-description-html: >-
              <p>Margin is not yet supported so defaults to false; for future
              provisions.</p>
        required:
          - OMSId
          - ProductId
          - Product
          - ProductFullName
          - MasterDataUniqueProductSymbol
          - ProductType
          - DecimalPlaces
          - TickSize
          - DepositEnabled
          - WithdrawEnabled
          - NoFees
          - IsDisabled
          - MarginEnabled
    GetVerificationLevelConfigRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS on which the account resides.
          x-gitbook-description-html: <p>The ID of the OMS on which the account resides.</p>
        AccountId:
          type: integer
          description: >-
            The ID of the account for which you wish to get product verification
            level config for.
          x-gitbook-description-html: >-
            <p>The ID of the account for which you wish to get product
            verification level config for.</p>
      required:
        - OMSId
        - AccountId
    GetVerificationLevelConfigResponse:
      type: object
      properties:
        Level:
          type: integer
          description: The verification level the account specified is currently on.
          x-gitbook-description-html: <p>The verification level the account specified is currently on.</p>
        LevelName:
          type: string
          description: >-
            The of name the verification level the account specified is
            currently on.
          x-gitbook-description-html: >-
            <p>The of name the verification level the account specified is
            currently on.</p>
        OMSId:
          type: integer
          description: The ID of the OMS on which the account resides.
          x-gitbook-description-html: <p>The ID of the OMS on which the account resides.</p>
        Products:
          type: array
          items:
            type: object
            properties:
              ProductId:
                type: integer
                description: >-
                  The ID of the product to which the specific verification level
                  limits applies.
                x-gitbook-description-html: >-
                  <p>The ID of the product to which the specific verification
                  level limits applies.</p>
              ProductName:
                type: string
                description: >-
                  The name of the product to which the specific verification
                  level limits applies.
                x-gitbook-description-html: >-
                  <p>The name of the product to which the specific verification
                  level limits applies.</p>
              AutoWithdrawThreshold:
                type: decimal
                description: The maximum withdraw amount which can be autoaccepted.
                x-gitbook-description-html: <p>The maximum withdraw amount which can be autoaccepted.</p>
              DailyDepositLimit:
                type: decimal
                description: The maximum amount of the product that can be deposited daily.
                x-gitbook-description-html: >-
                  <p>The maximum amount of the product that can be deposited
                  daily.</p>
              DailyDepositNotionalLimit:
                type: decimal
                description: >-
                  The maximum notional amount of the product that can be
                  deposited daily.
                x-gitbook-description-html: >-
                  <p>The maximum notional amount of the product that can be
                  deposited daily.</p>
              MonthlyDepositLimit:
                type: decimal
                description: >-
                  The maximum amount of the product that can be deposited
                  monthly.
                x-gitbook-description-html: >-
                  <p>The maximum amount of the product that can be deposited
                  monthly.</p>
              MonthlyDepositNotionalLimit:
                type: decimal
                description: >-
                  The maximum notional amount of the product that can be
                  deposited monthly.
                x-gitbook-description-html: >-
                  <p>The maximum notional amount of the product that can be
                  deposited monthly.</p>
              YearlyDepositLimit:
                type: decimal
                description: >-
                  The maximum amount of the product that can be deposited
                  annually.
                x-gitbook-description-html: >-
                  <p>The maximum amount of the product that can be deposited
                  annually.</p>
              YearlyDepositNotionalLimit:
                type: decimal
                description: >-
                  The maximum notional amount of the product that can be
                  deposited annually.
                x-gitbook-description-html: >-
                  <p>The maximum notional amount of the product that can be
                  deposited annually.</p>
              DailyWithdrawLimit:
                type: decimal
                description: The maximum amount of the product that can be withdrawn daily.
                x-gitbook-description-html: >-
                  <p>The maximum amount of the product that can be withdrawn
                  daily.</p>
              DailyWithdrawNotionalLimit:
                type: decimal
                description: >-
                  The maximum notional amount of the product that can be
                  withdrawn daily.
                x-gitbook-description-html: >-
                  <p>The maximum notional amount of the product that can be
                  withdrawn daily.</p>
              MonthlyWithdrawLimit:
                type: decimal
                description: >-
                  The maximum amount of the product that can be withdrawn
                  monthly.
                x-gitbook-description-html: >-
                  <p>The maximum amount of the product that can be withdrawn
                  monthly.</p>
              MonthlyWithdrawNotionalLimit:
                type: decimal
                description: >-
                  The maximum notional amount of the product that can be
                  withdrawn monthly.
                x-gitbook-description-html: >-
                  <p>The maximum notional amount of the product that can be
                  withdrawn monthly.</p>
              YearlyWithdrawLimit:
                type: decimal
                description: >-
                  The maximum amount of the product that can be withdrawn
                  annually.
                x-gitbook-description-html: >-
                  <p>The maximum amount of the product that can be withdrawn
                  annually.</p>
              YearlyWithdrawNotionalLimit:
                type: decimal
                description: >-
                  The maximum notional amount of the product that can be
                  withdrawn annually.
                x-gitbook-description-html: >-
                  <p>The maximum notional amount of the product that can be
                  withdrawn annually.</p>
              NotionalProductId:
                type: integer
                description: The ID of the notional product.
                x-gitbook-description-html: <p>The ID of the notional product.</p>
              OverLimitRejected:
                type: boolean
                description: >-
                  If true, all deposit and withdrawals which exceeds limits will
                  be automatically rejected, else those tickets will stay at the
                  status New.
                x-gitbook-description-html: >-
                  <p>If true, all deposit and withdrawals which exceeds limits
                  will be automatically rejected, else those tickets will stay
                  at the status New.</p>
              WithdrawProcessingDelaySec:
                type: integer
                description: >-
                  The delay, in minutes, before a withdraw request will be
                  Submitted onchain after getting accepted.
                x-gitbook-description-html: >-
                  <p>The delay, in minutes, before a withdraw request will be
                  Submitted onchain after getting accepted.</p>
              DepositTicketWorkflow:
                type: string
                description: The deposit workflow.
                x-gitbook-description-html: <p>The deposit workflow.</p>
              WithdrawTicketWorkflow:
                type: string
                description: The withdraw workflow.
                x-gitbook-description-html: <p>The withdraw workflow.</p>
              RequireWhitelistedAddress:
                type: boolean
                description: >-
                  If true, users can only withdraw to whitelisted withdraw
                  address, if the user does not have a verified withdraw
                  address, he/she will not be able to submit a withdraw request.
                x-gitbook-description-html: >-
                  <p>If true, users can only withdraw to whitelisted withdraw
                  address, if the user does not have a verified withdraw
                  address, he/she will not be able to submit a withdraw
                  request.</p>
            required:
              - ProductId
              - ProductName
              - AutoWithdrawThreshold
              - DailyDepositLimit
              - DailyDepositNotionalLimit
              - MonthlyDepositLimit
              - MonthlyDepositNotionalLimit
              - YearlyDepositLimit
              - YearlyDepositNotionalLimit
              - DailyWithdrawLimit
              - DailyWithdrawNotionalLimit
              - MonthlyWithdrawLimit
              - MonthlyWithdrawNotionalLimit
              - YearlyWithdrawLimit
              - YearlyWithdrawNotionalLimit
              - NotionalProductId
              - OverLimitRejected
              - WithdrawProcessingDelaySec
              - DepositTicketWorkflow
              - WithdrawTicketWorkflow
              - RequireWhitelistedAddress
      required:
        - Level
        - LevelName
        - OMSId
        - Products
    GenerateTradeActivityReportRequest:
      type: object
      properties:
        accountIdList:
          type: array
          items:
            type: integer
          description: >-
            A comma-delimited array of one ore more account IDs, each valid on a
            single OMS for the authenticated user. The account user may not be
            the only user of the account.
          x-gitbook-description-html: >-
            <p>A comma-delimited array of one ore more account IDs, each valid
            on a single OMS for the authenticated user. The account user may not
            be the only user of the account.</p>
        omsId:
          type: integer
          description: The ID of the OMS on which the array of account IDs resides.
          x-gitbook-description-html: <p>The ID of the OMS on which the array of account IDs resides.</p>
        startTime:
          type: string
          description: >-
            Identifies the time and date for the historic beginning of the trade
            activity report.
          x-gitbook-description-html: >-
            <p>Identifies the time and date for the historic beginning of the
            trade activity report.</p>
        endTime:
          type: string
          description: >-
            Identifies the time and date for the historic end of the trade
            activity report.
          x-gitbook-description-html: >-
            <p>Identifies the time and date for the historic end of the trade
            activity report.</p>
      required:
        - accountIdList
        - omsId
        - startTime
        - endTime
    GenerateTradeActivityReportResponse:
      type: object
      properties:
        RequestingUser:
          type: integer
          description: >-
            The User ID of the person requesting the trade activity report. This
            confirms the ID of the authenticated user who made the request by
            returning it as part of the response.
          x-gitbook-description-html: >-
            <p>The User ID of the person requesting the trade activity report.
            This confirms the ID of the authenticated user who made the request
            by returning it as part of the response.</p>
        OMSId:
          type: integer
          description: The ID of the OMS on which the trade activity report will be run.
          x-gitbook-description-html: >-
            <p>The ID of the OMS on which the trade activity report will be
            run.</p>
        reportFlavor:
          type: string
          description: >-
            The type of report to be generated. In the case of
            GenerateTradeActivityReport, report flavor will always be
            **TradeActivity**.
          x-gitbook-description-html: >-
            <p>The type of report to be generated. In the case of
            GenerateTradeActivityReport, report flavor will always be
            <strong>TradeActivity</strong>.</p>
        createTime:
          type: string
          description: >-
            The time and date on which the request for the trade activity report
            was made.
          x-gitbook-description-html: >-
            <p>The time and date on which the request for the trade activity
            report was made.</p>
        initialRunTime:
          type: string
          description: The time and date at which the trade activity report was first run.
          x-gitbook-description-html: >-
            <p>The time and date at which the trade activity report was first
            run.</p>
        intervalStartTime:
          type: string
          description: The start of the period that the report will cover.
          x-gitbook-description-html: <p>The start of the period that the report will cover.</p>
        intervalEndTime:
          type: string
          description: The end of the period that the report will cover.
          x-gitbook-description-html: <p>The end of the period that the report will cover.</p>
        RequestStatus:
          type: string
          enum:
            - Submitted
            - Validating
            - Scheduled
            - InProgress
            - Completed
            - Aborting
            - Aborted
            - UserCancelled
            - SysRetired
            - UserCancelled
            - Pending
          description: >-
            The status of the request for the trade activity report. A
            **Generate~Report** request will always return _Submitted_. One of:
            Submitted, Validating, Scheduled, InProgress, Completed, Aborting,
            Aborted, UserCancelled, SysRetired, UserCancelled, Pending.
          x-gitbook-description-html: >-
            <p>The status of the request for the trade activity report. A
            <strong>Generate~Report</strong> request will always return
            <em>Submitted</em>. One of: Submitted, Validating, Scheduled,
            InProgress, Completed, Aborting, Aborted, UserCancelled, SysRetired,
            UserCancelled, Pending.</p>
        ReportFrequency:
          type: string
          enum:
            - OnDemand
            - Hourly
            - Daily
            - Weekly
            - Monthly
            - Annually
          description: >-
            When the report runs. For a **Generate~Report** request, this is
            always OnDemand. One of: OnDemand, Hourly, Daily, Weekly, Monthly,
            Annually.
          x-gitbook-description-html: >-
            <p>When the report runs. For a <strong>Generate~Report</strong>
            request, this is always OnDemand. One of: OnDemand, Hourly, Daily,
            Weekly, Monthly, Annually.</p>
        intervalDuration:
          type: integer
          format: int64
          description: >-
            The period that the report covers relative to the run date. The
            **Generate~Report** request requires a start time and an end time.
            The Notbank software calculates the difference between them as
            _intervalDuration_. For example, say that you specify a 90-day
            start-date-to-end-date window for a report. The _intervalDuration_
            value returns a value equivalent to 90 days. If you have called
            **Generate~Report**, that value simply confirms the length of time
            that the on-demand report covers.
          x-gitbook-description-html: >-
            <p>The period that the report covers relative to the run date. The
            <strong>Generate~Report</strong> request requires a start time and
            an end time. The Notbank software calculates the difference between
            them as <em>intervalDuration</em>. For example, say that you specify
            a 90-day start-date-to-end-date window for a report. The
            <em>intervalDuration</em> value returns a value equivalent to 90
            days. If you have called <strong>Generate~Report</strong>, that
            value simply confirms the length of time that the on-demand report
            covers.</p>
        RequestId:
          type: string
          description: >-
            The ID of the original request. Request IDs are long strings unique
            within the OMS.
          x-gitbook-description-html: >-
            <p>The ID of the original request. Request IDs are long strings
            unique within the OMS.</p>
        lastInstanceId:
          type: string
          description: >-
            For scheduled reports, the report ID of the most recent previously
            run report. Will be _null_ for a **Generate~Report** call, because
            generated reports are on-demand.
          x-gitbook-description-html: >-
            <p>For scheduled reports, the report ID of the most recent
            previously run report. Will be <em>null</em> for a
            <strong>Generate~Report</strong> call, because generated reports are
            on-demand.</p>
        accountIds:
          type: array
          items:
            type: integer
          description: >-
            A comma-delimited array of account IDs whose trades are reported in
            the trade activity report.
          x-gitbook-description-html: >-
            <p>A comma-delimited array of account IDs whose trades are reported
            in the trade activity report.</p>
      required:
        - RequestingUser
        - OMSId
        - reportFlavor
        - createTime
        - initialRunTime
        - intervalStartTime
        - intervalEndTime
        - RequestStatus
        - ReportFrequency
        - intervalDuration
        - RequestId
        - lastInstanceId
        - accountIds
    GenerateTransactionActivityReportRequest:
      type: object
      properties:
        accountIdList:
          type: array
          items:
            type: integer
          description: >-
            A comma-delimited array of one ore more account IDs, each valid on a
            single OMS for the authenticated user. The account user may not be
            the only user of the account.
          x-gitbook-description-html: >-
            <p>A comma-delimited array of one ore more account IDs, each valid
            on a single OMS for the authenticated user. The account user may not
            be the only user of the account.</p>
        omsId:
          type: integer
          description: The ID of the OMS on which the array of account IDs resides.
          x-gitbook-description-html: <p>The ID of the OMS on which the array of account IDs resides.</p>
        startTime:
          type: string
          description: >-
            Identifies the time and date for the historic beginning of the
            transaction activity report.
          x-gitbook-description-html: >-
            <p>Identifies the time and date for the historic beginning of the
            transaction activity report.</p>
        endTime:
          type: string
          description: >-
            Identifies the time and date for the historic end of the transaction
            activity report.
          x-gitbook-description-html: >-
            <p>Identifies the time and date for the historic end of the
            transaction activity report.</p>
      required:
        - accountIdList
        - omsId
        - startTime
        - endTime
    GenerateTransactionActivityReportResponse:
      type: object
      properties:
        RequestingUser:
          type: integer
          description: >-
            The User ID of the person requesting the transaction activity
            report. This confirms the ID of the authenticated user who made the
            request by returning it as part of the response.
          x-gitbook-description-html: >-
            <p>The User ID of the person requesting the transaction activity
            report. This confirms the ID of the authenticated user who made the
            request by returning it as part of the response.</p>
        OMSId:
          type: integer
          description: >-
            The ID of the OMS on which the transaction activity report will be
            run.
          x-gitbook-description-html: >-
            <p>The ID of the OMS on which the transaction activity report will
            be run.</p>
        reportFlavor:
          type: string
          description: >-
            The type of report to be generated. In the case of
            GenerateTransactionActivityReport, report flavor will always be
            **TransactionActivity**.
          x-gitbook-description-html: >-
            <p>The type of report to be generated. In the case of
            GenerateTransactionActivityReport, report flavor will always be
            <strong>TransactionActivity</strong>.</p>
        createTime:
          type: string
          description: >-
            The time and date on which the request for the transaction activity
            report was made.
          x-gitbook-description-html: >-
            <p>The time and date on which the request for the transaction
            activity report was made.</p>
        initialRunTime:
          type: string
          description: >-
            The time and date at which the transaction activity report was first
            run.
          x-gitbook-description-html: >-
            <p>The time and date at which the transaction activity report was
            first run.</p>
        intervalStartTime:
          type: string
          description: The start of the period that the report will cover.
          x-gitbook-description-html: <p>The start of the period that the report will cover.</p>
        intervalEndTime:
          type: string
          description: The end of the period that the report will cover.
          x-gitbook-description-html: <p>The end of the period that the report will cover.</p>
        RequestStatus:
          type: string
          enum:
            - Submitted
            - Validating
            - Scheduled
            - InProgress
            - Completed
            - Aborting
            - Aborted
            - UserCancelled
            - SysRetired
            - UserCancelled
            - Pending
          description: >-
            The status of the request for the transaction activity report. A
            Generate~Report request will always return _Submitted_. One of:
            Submitted, Validating, Scheduled, InProgress, Completed, Aborting,
            Aborted, UserCancelled, SysRetired, UserCancelled, Pending.
          x-gitbook-description-html: >-
            <p>The status of the request for the transaction activity report. A
            Generate~Report request will always return <em>Submitted</em>. One
            of: Submitted, Validating, Scheduled, InProgress, Completed,
            Aborting, Aborted, UserCancelled, SysRetired, UserCancelled,
            Pending.</p>
        ReportFrequency:
          type: string
          enum:
            - OnDemand
            - Hourly
            - Daily
            - Weekly
            - Monthly
            - Annually
          description: >-
            When the report runs. For a **Generate~Report** call, this is always
            OnDemand. One of: OnDemand, Hourly, Daily, Weekly, Monthly,
            Annually.
          x-gitbook-description-html: >-
            <p>When the report runs. For a <strong>Generate~Report</strong>
            call, this is always OnDemand. One of: OnDemand, Hourly, Daily,
            Weekly, Monthly, Annually.</p>
        intervalDuration:
          type: integer
          format: int64
          description: >-
            The period that the report covers relative to the run date. The
            **Generate~Report** call requires a start time and an end time. The
            Notbank software calculates the difference between them as
            _intervalDuration_. For example, say that you specify a 90-day
            start-date-to-end-date window for a report. The _intervalDuration_
            value returns a value equivalent to 90 days. If you have called
            **Generate~Report**, that value simply confirms the length of time
            that the on-demand report covers.
          x-gitbook-description-html: >-
            <p>The period that the report covers relative to the run date. The
            <strong>Generate~Report</strong> call requires a start time and an
            end time. The Notbank software calculates the difference between
            them as <em>intervalDuration</em>. For example, say that you specify
            a 90-day start-date-to-end-date window for a report. The
            <em>intervalDuration</em> value returns a value equivalent to 90
            days. If you have called <strong>Generate~Report</strong>, that
            value simply confirms the length of time that the on-demand report
            covers.</p>
        RequestId:
          type: string
          description: >-
            The ID of the original request. Request IDs are long strings unique
            within the OMS.
          x-gitbook-description-html: >-
            <p>The ID of the original request. Request IDs are long strings
            unique within the OMS.</p>
        lastInstanceId:
          type: string
          description: >-
            For scheduled reports, the report ID of the most recent previously
            run report. Will be _null_ for a **Generate~Report** call, because
            generated reports are on-demand.
          x-gitbook-description-html: >-
            <p>For scheduled reports, the report ID of the most recent
            previously run report. Will be <em>null</em> for a
            <strong>Generate~Report</strong> call, because generated reports are
            on-demand.</p>
        accountIds:
          type: array
          items:
            type: integer
          description: >-
            A comma-delimited array of account IDs whose transactions are
            reported in the transaction activity report.
          x-gitbook-description-html: >-
            <p>A comma-delimited array of account IDs whose transactions are
            reported in the transaction activity report.</p>
      required:
        - RequestingUser
        - OMSId
        - reportFlavor
        - createTime
        - initialRunTime
        - intervalStartTime
        - intervalEndTime
        - RequestStatus
        - ReportFrequency
        - intervalDuration
        - RequestId
        - lastInstanceId
        - accountIds
    GenerateProductDeltaActivityReportRequest:
      type: object
      properties:
        accountIdList:
          type: array
          items:
            type: integer
          description: >-
            A comma-delimited array of one ore more account IDs, each valid on a
            single OMS for the authenticated user. The account user may not be
            the only user of the account.
          x-gitbook-description-html: >-
            <p>A comma-delimited array of one ore more account IDs, each valid
            on a single OMS for the authenticated user. The account user may not
            be the only user of the account.</p>
        omsId:
          type: integer
          description: The ID of the OMS on which the array of account IDs resides.
          x-gitbook-description-html: <p>The ID of the OMS on which the array of account IDs resides.</p>
        startTime:
          type: string
          description: >-
            Identifies the time and date for the historic beginning of the
            product delta activity report.
          x-gitbook-description-html: >-
            <p>Identifies the time and date for the historic beginning of the
            product delta activity report.</p>
        endTime:
          type: string
          description: >-
            Identifies the time and date for the historic end of the product
            delta activity report.
          x-gitbook-description-html: >-
            <p>Identifies the time and date for the historic end of the product
            delta activity report.</p>
      required:
        - accountIdList
        - omsId
        - startTime
        - endTime
    GenerateProductDeltaActivityReportResponse:
      type: object
      properties:
        RequestingUser:
          type: integer
          description: >-
            The User ID of the person requesting the product delta activity
            report. This confirms the ID of the authenticated user who made the
            request by returning it as part of the response.
          x-gitbook-description-html: >-
            <p>The User ID of the person requesting the product delta activity
            report. This confirms the ID of the authenticated user who made the
            request by returning it as part of the response.</p>
        OMSId:
          type: integer
          description: >-
            The ID of the OMS on which the product delta activity report will be
            run.
          x-gitbook-description-html: >-
            <p>The ID of the OMS on which the product delta activity report will
            be run.</p>
        reportFlavor:
          type: string
          description: >-
            The type of report to be generated. In the case of
            GenerateProductDeltaActivityReport, report flavor will always be
            **ProductDelta**.
          x-gitbook-description-html: >-
            <p>The type of report to be generated. In the case of
            GenerateProductDeltaActivityReport, report flavor will always be
            <strong>ProductDelta</strong>.</p>
        createTime:
          type: string
          description: >-
            The time and date on which the request for the product delta
            activity report was made.
          x-gitbook-description-html: >-
            <p>The time and date on which the request for the product delta
            activity report was made.</p>
        initialRunTime:
          type: string
          description: >-
            The time and date at which the product delta activity report was
            first run.
          x-gitbook-description-html: >-
            <p>The time and date at which the product delta activity report was
            first run.</p>
        intervalStartTime:
          type: string
          description: The start of the period that the report will cover.
          x-gitbook-description-html: <p>The start of the period that the report will cover.</p>
        intervalEndTime:
          type: string
          description: The end of the period that the report will cover.
          x-gitbook-description-html: <p>The end of the period that the report will cover.</p>
        RequestStatus:
          type: string
          enum:
            - Submitted
            - Validating
            - Scheduled
            - InProgress
            - Completed
            - Aborting
            - Aborted
            - UserCancelled
            - SysRetired
            - UserCancelled
            - Pending
          description: >-
            The status of the request for the product delta activity report. A
            Generate~Report request will always return _Submitted_. One of:
            Submitted, Validating, Scheduled, InProgress, Completed, Aborting,
            Aborted, UserCancelled, SysRetired, UserCancelled, Pending.
          x-gitbook-description-html: >-
            <p>The status of the request for the product delta activity report.
            A Generate~Report request will always return <em>Submitted</em>. One
            of: Submitted, Validating, Scheduled, InProgress, Completed,
            Aborting, Aborted, UserCancelled, SysRetired, UserCancelled,
            Pending.</p>
        ReportFrequency:
          type: string
          enum:
            - OnDemand
            - Hourly
            - Daily
            - Weekly
            - Monthly
            - Annually
          description: >-
            When the report runs. For a **Generate~Report** call, this is always
            OnDemand. One of: OnDemand, Hourly, Daily, Weekly, Monthly,
            Annually.
          x-gitbook-description-html: >-
            <p>When the report runs. For a <strong>Generate~Report</strong>
            call, this is always OnDemand. One of: OnDemand, Hourly, Daily,
            Weekly, Monthly, Annually.</p>
        intervalDuration:
          type: integer
          format: int64
          description: >-
            The period that the report covers relative to the run date. The
            **Generate~Report** call requires a start time and an end time. The
            Notbank software calculates the difference between them as
            _intervalDuration_. For example, say that you specify a 90-day
            start-date-to-end-date window for a report. The _intervalDuration_
            value returns a value equivalent to 90 days. If you have called
            **Generate~Report**, that value simply confirms the length of time
            that the on-demand report covers.
          x-gitbook-description-html: >-
            <p>The period that the report covers relative to the run date. The
            <strong>Generate~Report</strong> call requires a start time and an
            end time. The Notbank software calculates the difference between
            them as <em>intervalDuration</em>. For example, say that you specify
            a 90-day start-date-to-end-date window for a report. The
            <em>intervalDuration</em> value returns a value equivalent to 90
            days. If you have called <strong>Generate~Report</strong>, that
            value simply confirms the length of time that the on-demand report
            covers.</p>
        RequestId:
          type: string
          description: >-
            The ID of the original request. Request IDs are long strings unique
            within the OMS.
          x-gitbook-description-html: >-
            <p>The ID of the original request. Request IDs are long strings
            unique within the OMS.</p>
        lastInstanceId:
          type: string
          description: >-
            For scheduled reports, the report ID of the most recent previously
            run report. Will be _null_ for a **Generate~Report** call, because
            generated reports are on-demand.
          x-gitbook-description-html: >-
            <p>For scheduled reports, the report ID of the most recent
            previously run report. Will be <em>null</em> for a
            <strong>Generate~Report</strong> call, because generated reports are
            on-demand.</p>
        accountIds:
          type: array
          items:
            type: integer
          description: >-
            A comma-delimited array of account IDs whose transactions are
            reported in the product delta activity report.
          x-gitbook-description-html: >-
            <p>A comma-delimited array of account IDs whose transactions are
            reported in the product delta activity report.</p>
      required:
        - RequestingUser
        - OMSId
        - reportFlavor
        - createTime
        - initialRunTime
        - intervalStartTime
        - intervalEndTime
        - RequestStatus
        - ReportFrequency
        - intervalDuration
        - RequestId
        - lastInstanceId
        - accountIds
    GeneratePnLActivityReportRequest:
      type: object
      properties:
        accountIdList:
          type: array
          items:
            type: integer
          description: >-
            A comma-delimited array of one ore more account IDs, each valid on a
            single OMS for the authenticated user. The account user may not be
            the only user of the account.
          x-gitbook-description-html: >-
            <p>A comma-delimited array of one ore more account IDs, each valid
            on a single OMS for the authenticated user. The account user may not
            be the only user of the account.</p>
        omsId:
          type: integer
          description: The ID of the OMS on which the array of account IDs resides.
          x-gitbook-description-html: <p>The ID of the OMS on which the array of account IDs resides.</p>
        startTime:
          type: string
          description: >-
            Identifies the time and date for the historic beginning of the
            profit and loss activity report.
          x-gitbook-description-html: >-
            <p>Identifies the time and date for the historic beginning of the
            profit and loss activity report.</p>
        endTime:
          type: string
          description: >-
            Identifies the time and date for the historic end of the profit and
            loss activity report.
          x-gitbook-description-html: >-
            <p>Identifies the time and date for the historic end of the profit
            and loss activity report.</p>
      required:
        - accountIdList
        - omsId
        - startTime
        - endTime
    GeneratePnLActivityReportResponse:
      type: object
      properties:
        RequestingUser:
          type: integer
          description: >-
            The User ID of the person requesting the profit and loss activity
            report. This confirms the ID of the authenticated user who made the
            request by returning it as part of the response.
          x-gitbook-description-html: >-
            <p>The User ID of the person requesting the profit and loss activity
            report. This confirms the ID of the authenticated user who made the
            request by returning it as part of the response.</p>
        OMSId:
          type: integer
          description: >-
            The ID of the OMS on which the profit and loss activity report will
            be run.
          x-gitbook-description-html: >-
            <p>The ID of the OMS on which the profit and loss activity report
            will be run.</p>
        reportFlavor:
          type: string
          description: >-
            The type of report to be generated. In the case of
            GeneratePnLActivityReport, report flavor will always be
            **ProfitAndLoss**.
          x-gitbook-description-html: >-
            <p>The type of report to be generated. In the case of
            GeneratePnLActivityReport, report flavor will always be
            <strong>ProfitAndLoss</strong>.</p>
        createTime:
          type: string
          description: >-
            The time and date on which the request for the profit and loss
            activity report was made.
          x-gitbook-description-html: >-
            <p>The time and date on which the request for the profit and loss
            activity report was made.</p>
        initialRunTime:
          type: string
          description: >-
            The time and date at which the profit and loss activity report was
            first run.
          x-gitbook-description-html: >-
            <p>The time and date at which the profit and loss activity report
            was first run.</p>
        intervalStartTime:
          type: string
          description: The start of the period that the report will cover.
          x-gitbook-description-html: <p>The start of the period that the report will cover.</p>
        intervalEndTime:
          type: string
          description: The end of the period that the report will cover.
          x-gitbook-description-html: <p>The end of the period that the report will cover.</p>
        RequestStatus:
          type: string
          enum:
            - Submitted
            - Validating
            - Scheduled
            - InProgress
            - Completed
            - Aborting
            - Aborted
            - UserCancelled
            - SysRetired
            - UserCancelled
            - Pending
          description: >-
            The status of the request for the profit and loss activity report. A
            Generate~Report request will always return _Submitted_. One of:
            Submitted, Validating, Scheduled, InProgress, Completed, Aborting,
            Aborted, UserCancelled, SysRetired, UserCancelled, Pending.
          x-gitbook-description-html: >-
            <p>The status of the request for the profit and loss activity
            report. A Generate~Report request will always return
            <em>Submitted</em>. One of: Submitted, Validating, Scheduled,
            InProgress, Completed, Aborting, Aborted, UserCancelled, SysRetired,
            UserCancelled, Pending.</p>
        ReportFrequency:
          type: string
          enum:
            - OnDemand
            - Hourly
            - Daily
            - Weekly
            - Monthly
            - Annually
          description: >-
            When the report runs. For a **Generate~Report** call, this is always
            OnDemand. One of: OnDemand, Hourly, Daily, Weekly, Monthly,
            Annually.
          x-gitbook-description-html: >-
            <p>When the report runs. For a <strong>Generate~Report</strong>
            call, this is always OnDemand. One of: OnDemand, Hourly, Daily,
            Weekly, Monthly, Annually.</p>
        intervalDuration:
          type: integer
          format: int64
          description: >-
            The period that the report covers relative to the run date. The
            **Generate~Report** call requires a start time and an end time. The
            Notbank software calculates the difference between them as
            _intervalDuration_. For example, say that you specify a 90-day
            start-date-to-end-date window for a report. The _intervalDuration_
            value returns a value equivalent to 90 days. If you have called
            **Generate~Report**, that value simply confirms the length of time
            that the on-demand report covers.
          x-gitbook-description-html: >-
            <p>The period that the report covers relative to the run date. The
            <strong>Generate~Report</strong> call requires a start time and an
            end time. The Notbank software calculates the difference between
            them as <em>intervalDuration</em>. For example, say that you specify
            a 90-day start-date-to-end-date window for a report. The
            <em>intervalDuration</em> value returns a value equivalent to 90
            days. If you have called <strong>Generate~Report</strong>, that
            value simply confirms the length of time that the on-demand report
            covers.</p>
        RequestId:
          type: string
          description: >-
            The ID of the original request. Request IDs are long strings unique
            within the OMS.
          x-gitbook-description-html: >-
            <p>The ID of the original request. Request IDs are long strings
            unique within the OMS.</p>
        lastInstanceId:
          type: string
          description: >-
            For scheduled reports, the report ID of the most recent previously
            run report. Will be _null_ for a **Generate~Report** call, because
            generated reports are on-demand.
          x-gitbook-description-html: >-
            <p>For scheduled reports, the report ID of the most recent
            previously run report. Will be <em>null</em> for a
            <strong>Generate~Report</strong> call, because generated reports are
            on-demand.</p>
        accountIds:
          type: array
          items:
            type: integer
          description: >-
            A comma-delimited array of account IDs whose transactions are
            reported in the profit and loss activity report.
          x-gitbook-description-html: >-
            <p>A comma-delimited array of account IDs whose transactions are
            reported in the profit and loss activity report.</p>
      required:
        - RequestingUser
        - OMSId
        - reportFlavor
        - createTime
        - initialRunTime
        - intervalStartTime
        - intervalEndTime
        - RequestStatus
        - ReportFrequency
        - intervalDuration
        - RequestId
        - lastInstanceId
        - accountIds
    ScheduleTradeActivityReportRequest:
      type: object
      properties:
        Frequency:
          oneOf:
            - type: integer
            - type: string
          enum:
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
          default: 0
          description: >-
            How often the report will run and a trade report get generated. One
            of: 0 Hourly, 1 Daily, 2 Weekly, 3 Monthly, 4 Annually, 5 onDemand.
            Default is 0 Hourly.
          x-gitbook-description-html: >-
            <p>How often the report will run and a trade report get generated.
            One of: 0 Hourly, 1 Daily, 2 Weekly, 3 Monthly, 4 Annually, 5
            onDemand. Default is 0 Hourly.</p>
        accountIdList:
          type: array
          items:
            type: integer
          description: >-
            Comma-separated integers; each element an account ID on the OMS
            whose trade activity will be reported on. All accounts must be from
            the same OMS.
          x-gitbook-description-html: >-
            <p>Comma-separated integers; each element an account ID on the OMS
            whose trade activity will be reported on. All accounts must be from
            the same OMS.</p>
        OMSId:
          type: integer
          description: The ID of the OMS on which the accounts named in the list reside.
          x-gitbook-description-html: >-
            <p>The ID of the OMS on which the accounts named in the list
            reside.</p>
        beginTime:
          type: string
          description: >-
            The time at which the periodic reports begin; the day and time when
            you want reporting to start, in Microsoft Ticks format.
          x-gitbook-description-html: >-
            <p>The time at which the periodic reports begin; the day and time
            when you want reporting to start, in Microsoft Ticks format.</p>
      required:
        - accountIdList
        - OMSId
        - beginTime
    ScheduleTradeActivityReportResponse:
      type: object
      properties:
        RequestingUser:
          type: integer
          description: >-
            The User ID of the person requesting the trade activity report. This
            confirms the ID of the authenticated user who made the request by
            returning it as part of the response.
          x-gitbook-description-html: >-
            <p>The User ID of the person requesting the trade activity report.
            This confirms the ID of the authenticated user who made the request
            by returning it as part of the response.</p>
        OMSId:
          type: integer
          description: The ID of the OMS on which the trade activity report will be run.
          x-gitbook-description-html: >-
            <p>The ID of the OMS on which the trade activity report will be
            run.</p>
        reportFlavor:
          type: string
          description: >-
            The type of report to be generated. In the case of
            ScheduleTradeActivityReport, report flavor will always be
            **TradeActivity**.
          x-gitbook-description-html: >-
            <p>The type of report to be generated. In the case of
            ScheduleTradeActivityReport, report flavor will always be
            <strong>TradeActivity</strong>.</p>
        createTime:
          type: string
          description: >-
            The time and date on which the request for the trade activity report
            was made, in Microsoft Ticks format.
          x-gitbook-description-html: >-
            <p>The time and date on which the request for the trade activity
            report was made, in Microsoft Ticks format.</p>
        initialRunTime:
          type: string
          description: >-
            The time and date at which the trade activity report was first run,
            in Microsoft Ticks format.
          x-gitbook-description-html: >-
            <p>The time and date at which the trade activity report was first
            run, in Microsoft Ticks format.</p>
        intervalStartTime:
          type: string
          description: >-
            The start of the period that the report will cover, in Microsoft
            Ticks format.
          x-gitbook-description-html: >-
            <p>The start of the period that the report will cover, in Microsoft
            Ticks format.</p>
        intervalEndTime:
          type: string
          description: >-
            The end of the period that the report will cover, in Microsoft Ticks
            format.
          x-gitbook-description-html: >-
            <p>The end of the period that the report will cover, in Microsoft
            Ticks format.</p>
        RequestStatus:
          type: string
          enum:
            - Submitted
            - Validating
            - Scheduled
            - InProgress
            - Completed
            - Aborting
            - Aborted
            - UserCancelled
            - SysRetired
            - UserCancelledPending
          description: >-
            The status of the request for the trade activity report. One of:
            Submitted, Validating, Scheduled, InProgress, Completed, Aborting,
            Aborted, UserCancelled, SysRetired, UserCancelledPending.
          x-gitbook-description-html: >-
            <p>The status of the request for the trade activity report. One of:
            Submitted, Validating, Scheduled, InProgress, Completed, Aborting,
            Aborted, UserCancelled, SysRetired, UserCancelledPending.</p>
        ReportFrequency:
          type: string
          enum:
            - OnDemand
            - Hourly
            - Daily
            - Weekly
            - Monthly
            - Annually
          description: >-
            When the report runs. One of: OnDemand, Hourly, Daily, Weekly,
            Monthly, Annually.
          x-gitbook-description-html: >-
            <p>When the report runs. One of: OnDemand, Hourly, Daily, Weekly,
            Monthly, Annually.</p>
        intervalDuration:
          type: integer
          format: int64
          description: >-
            The period that the report covers relative to the run date, in POSIX
            format. The call specifies a start time and an _intervalDuration_.
            In a scheduled report, the interval duration depends on the
            frequency. If the frequency is **Weekly**, the interval duration
            will be 1 week.
          x-gitbook-description-html: >-
            <p>The period that the report covers relative to the run date, in
            POSIX format. The call specifies a start time and an
            <em>intervalDuration</em>. In a scheduled report, the interval
            duration depends on the frequency. If the frequency is
            <strong>Weekly</strong>, the interval duration will be 1 week.</p>
        RequestId:
          type: string
          description: >-
            The ID of the original request. Request IDs are long strings unique
            within the OMS.
          x-gitbook-description-html: >-
            <p>The ID of the original request. Request IDs are long strings
            unique within the OMS.</p>
        lastInstanceId:
          type: string
          description: >-
            For scheduled reports, the report ID of the most recent previously
            run report.
          x-gitbook-description-html: >-
            <p>For scheduled reports, the report ID of the most recent
            previously run report.</p>
        accountIds:
          type: array
          items:
            type: integer
          description: >-
            A comma-delimited array of account IDs whose trades are reported in
            the trade activity report.
          x-gitbook-description-html: >-
            <p>A comma-delimited array of account IDs whose trades are reported
            in the trade activity report.</p>
      required:
        - RequestingUser
        - OMSId
        - reportFlavor
        - createTime
        - initialRunTime
        - intervalStartTime
        - intervalEndTime
        - RequestStatus
        - ReportFrequency
        - intervalDuration
        - RequestId
        - lastInstanceId
        - accountIds
    ScheduleTransactionActivityReportRequest:
      type: object
      properties:
        frequency:
          oneOf:
            - type: integer
            - type: string
          enum:
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
          default: Hourly
          description: >-
            How often the report will run and a trade report get generated. One
            of: 0 Hourly, 1 Daily, 2 Weekly, 3 Monthly, 4 Annually, 5 onDemand.
            Default is Hourly.
          x-gitbook-description-html: >-
            <p>How often the report will run and a trade report get generated.
            One of: 0 Hourly, 1 Daily, 2 Weekly, 3 Monthly, 4 Annually, 5
            onDemand. Default is Hourly.</p>
        accountIdList:
          type: array
          items:
            type: integer
          description: >-
            Comma-separated integers; each element an account ID on the OMS
            whose transaction activity will be reported on. All accounts must be
            from the same OMS.
          x-gitbook-description-html: >-
            <p>Comma-separated integers; each element an account ID on the OMS
            whose transaction activity will be reported on. All accounts must be
            from the same OMS.</p>
        omsId:
          type: integer
          description: The ID of the OMS on which the accounts named in the list reside.
          x-gitbook-description-html: >-
            <p>The ID of the OMS on which the accounts named in the list
            reside.</p>
        beginTime:
          type: string
          description: >-
            The time at which the periodic reports begin; the day and time when
            you want reporting to start, in Microsoft Ticks format.
          x-gitbook-description-html: >-
            <p>The time at which the periodic reports begin; the day and time
            when you want reporting to start, in Microsoft Ticks format.</p>
      required:
        - accountIdList
        - omsId
        - beginTime
    ScheduleTransactionActivityReportResponse:
      type: object
      properties:
        RequestingUser:
          type: integer
          description: >-
            The User ID of the person requesting the transaction activity
            report. This confirms the ID of the authenticated user who made the
            request by returning it as part of the response.
          x-gitbook-description-html: >-
            <p>The User ID of the person requesting the transaction activity
            report. This confirms the ID of the authenticated user who made the
            request by returning it as part of the response.</p>
        OMSId:
          type: integer
          description: >-
            The ID of the OMS on which the transaction activity report will be
            run.
          x-gitbook-description-html: >-
            <p>The ID of the OMS on which the transaction activity report will
            be run.</p>
        reportFlavor:
          type: string
          description: >-
            The type of report to be generated. In the case of
            ScheduleTransactionActivityReport, report flavor will always be
            **Transaction**.
          x-gitbook-description-html: >-
            <p>The type of report to be generated. In the case of
            ScheduleTransactionActivityReport, report flavor will always be
            <strong>Transaction</strong>.</p>
        createTime:
          type: string
          description: >-
            The time and date on which the request for the transaction activity
            report was made, in Microsoft Ticks format.
          x-gitbook-description-html: >-
            <p>The time and date on which the request for the transaction
            activity report was made, in Microsoft Ticks format.</p>
        initialRunTime:
          type: string
          description: >-
            The time and date at which the transaction activity report was first
            run, in Microsoft Ticks format.
          x-gitbook-description-html: >-
            <p>The time and date at which the transaction activity report was
            first run, in Microsoft Ticks format.</p>
        intervalStartTime:
          type: string
          description: >-
            The start of the period that the report will cover, in Microsoft
            Ticks format.
          x-gitbook-description-html: >-
            <p>The start of the period that the report will cover, in Microsoft
            Ticks format.</p>
        intervalEndTime:
          type: string
          description: >-
            The end of the period that the report will cover, in Microsoft Ticks
            format.
          x-gitbook-description-html: >-
            <p>The end of the period that the report will cover, in Microsoft
            Ticks format.</p>
        RequestStatus:
          type: string
          enum:
            - Submitted
            - Validating
            - Scheduled
            - InProgress
            - Completed
            - Aborting
            - Aborted
            - UserCancelled
            - SysRetired
            - UserCancelledPending
          description: >-
            The status of the request for the transaction activity report. One
            of: Submitted, Validating, Scheduled, InProgress, Completed,
            Aborting, Aborted, UserCancelled, SysRetired, UserCancelledPending.
          x-gitbook-description-html: >-
            <p>The status of the request for the transaction activity report.
            One of: Submitted, Validating, Scheduled, InProgress, Completed,
            Aborting, Aborted, UserCancelled, SysRetired,
            UserCancelledPending.</p>
        ReportFrequency:
          type: string
          enum:
            - OnDemand
            - Hourly
            - Daily
            - Weekly
            - Monthly
            - Annually
          description: >-
            When the report runs. One of: OnDemand, Hourly, Daily, Weekly,
            Monthly, Annually.
          x-gitbook-description-html: >-
            <p>When the report runs. One of: OnDemand, Hourly, Daily, Weekly,
            Monthly, Annually.</p>
        intervalDuration:
          type: integer
          format: int64
          description: >-
            The period that the report covers relative to the run date, in POSIX
            format. The call specifies a start time and an _intervalDuration_.
            In a scheduled report, the interval duration depends on the
            frequency, if the frequency is **Weekly**, the interval duration
            will be 1 week.
          x-gitbook-description-html: >-
            <p>The period that the report covers relative to the run date, in
            POSIX format. The call specifies a start time and an
            <em>intervalDuration</em>. In a scheduled report, the interval
            duration depends on the frequency, if the frequency is
            <strong>Weekly</strong>, the interval duration will be 1 week.</p>
        RequestId:
          type: string
          description: >-
            The ID of the original request. Request IDs are long strings unique
            within the OMS.
          x-gitbook-description-html: >-
            <p>The ID of the original request. Request IDs are long strings
            unique within the OMS.</p>
        lastInstanceId:
          type: string
          description: >-
            For scheduled reports, the report ID of the most recent previously
            run report.
          x-gitbook-description-html: >-
            <p>For scheduled reports, the report ID of the most recent
            previously run report.</p>
        accountIds:
          type: array
          items:
            type: integer
          description: >-
            A comma-delimited array of account IDs whose transactions are
            reported in the transaction activity report.
          x-gitbook-description-html: >-
            <p>A comma-delimited array of account IDs whose transactions are
            reported in the transaction activity report.</p>
      required:
        - RequestingUser
        - OMSId
        - reportFlavor
        - createTime
        - initialRunTime
        - intervalStartTime
        - intervalEndTime
        - RequestStatus
        - ReportFrequency
        - intervalDuration
        - RequestId
        - lastInstanceId
        - accountIds
    ScheduleProductDeltaActivityReportRequest:
      type: object
      properties:
        frequency:
          oneOf:
            - type: integer
            - type: string
          enum:
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
          default: 0
          description: >-
            How often the report will run and a product delta activity report
            get generated. One of: 0 Hourly, 1 Daily, 2 Weekly, 3 Monthly, 4
            Annually, 5 onDemand. Default is 0 Hourly.
          x-gitbook-description-html: >-
            <p>How often the report will run and a product delta activity report
            get generated. One of: 0 Hourly, 1 Daily, 2 Weekly, 3 Monthly, 4
            Annually, 5 onDemand. Default is 0 Hourly.</p>
        accountIdList:
          type: array
          items:
            type: integer
          description: >-
            Comma-separated integers; each element an account ID on the OMS
            whose product delta activity will be reported on. All accounts must
            be from the same OMS.
          x-gitbook-description-html: >-
            <p>Comma-separated integers; each element an account ID on the OMS
            whose product delta activity will be reported on. All accounts must
            be from the same OMS.</p>
        omsId:
          type: integer
          description: The ID of the OMS on which the accounts named in the list reside.
          x-gitbook-description-html: >-
            <p>The ID of the OMS on which the accounts named in the list
            reside.</p>
        beginTime:
          type: string
          description: >-
            The time at which the periodic reports begin; the day and time when
            you want reporting to start, in Microsoft Ticks format.
          x-gitbook-description-html: >-
            <p>The time at which the periodic reports begin; the day and time
            when you want reporting to start, in Microsoft Ticks format.</p>
      required:
        - accountIdList
        - omsId
        - beginTime
    ScheduleProductDeltaActivityReportResponse:
      type: object
      properties:
        RequestingUser:
          type: integer
          description: >-
            The User ID of the person requesting the product delta activity
            report. This confirms the ID of the authenticated user who made the
            request by returning it as part of the response.
          x-gitbook-description-html: >-
            <p>The User ID of the person requesting the product delta activity
            report. This confirms the ID of the authenticated user who made the
            request by returning it as part of the response.</p>
        OMSId:
          type: integer
          description: >-
            The ID of the OMS on which the product delta activity report will be
            run.
          x-gitbook-description-html: >-
            <p>The ID of the OMS on which the product delta activity report will
            be run.</p>
        reportFlavor:
          type: string
          description: >-
            The type of report to be generated. In the case of
            ScheduleProductDeltaActivityReport, report flavor will always be
            **ProductDelta**.
          x-gitbook-description-html: >-
            <p>The type of report to be generated. In the case of
            ScheduleProductDeltaActivityReport, report flavor will always be
            <strong>ProductDelta</strong>.</p>
        createTime:
          type: string
          description: >-
            The time and date on which the request for the product delta
            activity report was made, in Microsoft Ticks format.
          x-gitbook-description-html: >-
            <p>The time and date on which the request for the product delta
            activity report was made, in Microsoft Ticks format.</p>
        initialRunTime:
          type: string
          description: >-
            The time and date at which the product delta activity report was
            first run, in Microsoft Ticks format.
          x-gitbook-description-html: >-
            <p>The time and date at which the product delta activity report was
            first run, in Microsoft Ticks format.</p>
        intervalStartTime:
          type: string
          description: >-
            The start of the period that the report will cover, in Microsoft
            Ticks format.
          x-gitbook-description-html: >-
            <p>The start of the period that the report will cover, in Microsoft
            Ticks format.</p>
        intervalEndTime:
          type: string
          description: >-
            The end of the period that the report will cover, in Microsoft Ticks
            format.
          x-gitbook-description-html: >-
            <p>The end of the period that the report will cover, in Microsoft
            Ticks format.</p>
        RequestStatus:
          type: string
          enum:
            - Submitted
            - Validating
            - Scheduled
            - InProgress
            - Completed
            - Aborting
            - Aborted
            - UserCancelled
            - SysRetired
            - UserCancelledPending
          description: >-
            The status of the request for the product delta activity report. One
            of: Submitted, Validating, Scheduled, InProgress, Completed,
            Aborting, Aborted, UserCancelled, SysRetired, UserCancelledPending.
          x-gitbook-description-html: >-
            <p>The status of the request for the product delta activity report.
            One of: Submitted, Validating, Scheduled, InProgress, Completed,
            Aborting, Aborted, UserCancelled, SysRetired,
            UserCancelledPending.</p>
        ReportFrequency:
          type: string
          enum:
            - OnDemand
            - Hourly
            - Daily
            - Weekly
            - Monthly
            - Annually
          description: >-
            When the report runs. One of: OnDemand, Hourly, Daily, Weekly,
            Monthly, Annually.
          x-gitbook-description-html: >-
            <p>When the report runs. One of: OnDemand, Hourly, Daily, Weekly,
            Monthly, Annually.</p>
        intervalDuration:
          type: integer
          format: int64
          description: >-
            The period that the report covers relative to the run date, in POSIX
            format. The call specifies a start time and an _intervalDuration_.
            In a scheduled report, the interval duration depends on the
            frequency, if the frequency is **Weekly**, the interval duration
            will be 1 week.
          x-gitbook-description-html: >-
            <p>The period that the report covers relative to the run date, in
            POSIX format. The call specifies a start time and an
            <em>intervalDuration</em>. In a scheduled report, the interval
            duration depends on the frequency, if the frequency is
            <strong>Weekly</strong>, the interval duration will be 1 week.</p>
        RequestId:
          type: string
          description: >-
            The ID of the original request. Request IDs are long strings unique
            within the OMS.
          x-gitbook-description-html: >-
            <p>The ID of the original request. Request IDs are long strings
            unique within the OMS.</p>
        lastInstanceId:
          type: string
          description: >-
            For scheduled reports, the report ID of the most recent previously
            run report.
          x-gitbook-description-html: >-
            <p>For scheduled reports, the report ID of the most recent
            previously run report.</p>
        accountIds:
          type: array
          items:
            type: integer
          description: >-
            A comma-delimited array of account IDs whose transactions are
            reported in the product delta activity report.
          x-gitbook-description-html: >-
            <p>A comma-delimited array of account IDs whose transactions are
            reported in the product delta activity report.</p>
      required:
        - RequestingUser
        - OMSId
        - reportFlavor
        - createTime
        - initialRunTime
        - intervalStartTime
        - intervalEndTime
        - RequestStatus
        - ReportFrequency
        - intervalDuration
        - RequestId
        - lastInstanceId
        - accountIds
    ScheduleProfitAndLossActivityReportRequest:
      type: object
      properties:
        frequency:
          oneOf:
            - type: integer
            - type: string
          enum:
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
          default: 0
          description: >-
            How often the report will run and a profit and lost activity report
            get generated. One of: 0 Hourly, 1 Daily, 2 Weekly, 3 Monthly, 4
            Annually, 5 onDemand. Default is 0 Hourly.
          x-gitbook-description-html: >-
            <p>How often the report will run and a profit and lost activity
            report get generated. One of: 0 Hourly, 1 Daily, 2 Weekly, 3
            Monthly, 4 Annually, 5 onDemand. Default is 0 Hourly.</p>
        accountIdList:
          type: array
          items:
            type: integer
          description: >-
            Comma-separated integers; each element an account ID on the OMS
            whose profit and loss activity will be reported on. All accounts
            must be from the same OMS.
          x-gitbook-description-html: >-
            <p>Comma-separated integers; each element an account ID on the OMS
            whose profit and loss activity will be reported on. All accounts
            must be from the same OMS.</p>
        omsId:
          type: integer
          description: The ID of the OMS on which the accounts named in the list reside.
          x-gitbook-description-html: >-
            <p>The ID of the OMS on which the accounts named in the list
            reside.</p>
        beginTime:
          type: string
          description: >-
            The time at which the periodic reports begin; the day and time when
            you want reporting to start, in Microsoft Ticks format.
          x-gitbook-description-html: >-
            <p>The time at which the periodic reports begin; the day and time
            when you want reporting to start, in Microsoft Ticks format.</p>
      required:
        - accountIdList
        - omsId
        - beginTime
    ScheduleProfitAndLossActivityReportResponse:
      type: object
      properties:
        RequestingUser:
          type: integer
          description: >-
            The User ID of the person requesting the profit and loss activity
            report. This confirms the ID of the authenticated user who made the
            request by returning it as part of the response.
          x-gitbook-description-html: >-
            <p>The User ID of the person requesting the profit and loss activity
            report. This confirms the ID of the authenticated user who made the
            request by returning it as part of the response.</p>
        OMSId:
          type: integer
          description: >-
            The ID of the OMS on which the profit and loss activity report will
            be run.
          x-gitbook-description-html: >-
            <p>The ID of the OMS on which the profit and loss activity report
            will be run.</p>
        reportFlavor:
          type: string
          description: >-
            The type of report to be generated. In the case of
            ScheduleProfitandLossActivityReport, report flavor will always be
            **ProfitAndLoss**.
          x-gitbook-description-html: >-
            <p>The type of report to be generated. In the case of
            ScheduleProfitandLossActivityReport, report flavor will always be
            <strong>ProfitAndLoss</strong>.</p>
        createTime:
          type: string
          description: >-
            The time and date on which the request for the profit and loss
            activity report was made, in Microsoft Ticks format.
          x-gitbook-description-html: >-
            <p>The time and date on which the request for the profit and loss
            activity report was made, in Microsoft Ticks format.</p>
        initialRunTime:
          type: string
          description: >-
            The time and date at which the profit and loss activity report was
            first run, in Microsoft Ticks format.
          x-gitbook-description-html: >-
            <p>The time and date at which the profit and loss activity report
            was first run, in Microsoft Ticks format.</p>
        intervalStartTime:
          type: string
          description: >-
            The start of the period that the report will cover, in Microsoft
            Ticks format.
          x-gitbook-description-html: >-
            <p>The start of the period that the report will cover, in Microsoft
            Ticks format.</p>
        intervalEndTime:
          type: string
          description: >-
            The end of the period that the report will cover, in Microsoft Ticks
            format.
          x-gitbook-description-html: >-
            <p>The end of the period that the report will cover, in Microsoft
            Ticks format.</p>
        RequestStatus:
          type: string
          enum:
            - Submitted
            - Validating
            - Scheduled
            - InProgress
            - Completed
            - Aborting
            - Aborted
            - UserCancelled
            - SysRetired
            - UserCancelledPending
          description: >-
            The status of the request for the profit and loss activity report.
            One of: Submitted, Validating, Scheduled, InProgress, Completed,
            Aborting, Aborted, UserCancelled, SysRetired, UserCancelledPending.
          x-gitbook-description-html: >-
            <p>The status of the request for the profit and loss activity
            report. One of: Submitted, Validating, Scheduled, InProgress,
            Completed, Aborting, Aborted, UserCancelled, SysRetired,
            UserCancelledPending.</p>
        ReportFrequency:
          type: string
          enum:
            - OnDemand
            - Hourly
            - Daily
            - Weekly
            - Monthly
            - Annually
          description: >-
            When the report runs. One of: OnDemand, Hourly, Daily, Weekly,
            Monthly, Annually.
          x-gitbook-description-html: >-
            <p>When the report runs. One of: OnDemand, Hourly, Daily, Weekly,
            Monthly, Annually.</p>
        intervalDuration:
          type: integer
          format: int64
          description: >-
            The period that the report covers relative to the run date, in POSIX
            format. The call specifies a start time and an _intervalDuration_.
            In a scheduled report, the interval duration depends on the
            frequency, if the frequency is **Weekly**, the interval duration
            will be 1 week.
          x-gitbook-description-html: >-
            <p>The period that the report covers relative to the run date, in
            POSIX format. The call specifies a start time and an
            <em>intervalDuration</em>. In a scheduled report, the interval
            duration depends on the frequency, if the frequency is
            <strong>Weekly</strong>, the interval duration will be 1 week.</p>
        RequestId:
          type: string
          description: >-
            The ID of the original request. Request IDs are long strings unique
            within the OMS.
          x-gitbook-description-html: >-
            <p>The ID of the original request. Request IDs are long strings
            unique within the OMS.</p>
        lastInstanceId:
          type: string
          description: >-
            For scheduled reports, the report ID of the most recent previously
            run report.
          x-gitbook-description-html: >-
            <p>For scheduled reports, the report ID of the most recent
            previously run report.</p>
        accountIds:
          type: array
          items:
            type: integer
          description: >-
            A comma-delimited array of account IDs whose transactions are
            reported in the profit and loss activity report.
          x-gitbook-description-html: >-
            <p>A comma-delimited array of account IDs whose transactions are
            reported in the profit and loss activity report.</p>
      required:
        - RequestingUser
        - OMSId
        - reportFlavor
        - createTime
        - initialRunTime
        - intervalStartTime
        - intervalEndTime
        - RequestStatus
        - ReportFrequency
        - intervalDuration
        - RequestId
        - lastInstanceId
        - accountIds
    CancelUserReportRequest:
      type: object
      properties:
        UserReportId:
          type: string
          description: >-
            The GUID is a globally unique ID string that identifies the user
            report to be canceled. The OMS provides this ID when you create a
            report.
          x-gitbook-description-html: >-
            <p>The GUID is a globally unique ID string that identifies the user
            report to be canceled. The OMS provides this ID when you create a
            report.</p>
      required:
        - UserReportId
    CancelUserReportResponse:
      type: object
      properties:
        result:
          type: boolean
          description: >-
            A successful receipt of the cancellation returns true; and
            unsuccessful receipt of the cancellation (an error condition)
            returns false.
          x-gitbook-description-html: >-
            <p>A successful receipt of the cancellation returns true; and
            unsuccessful receipt of the cancellation (an error condition)
            returns false.</p>
        errormsg:
          type: string
          description: >-
            A successful receipt of the cancellation returns null; the
            _errormsg_ parameter for an unsuccessful receipt returns one of the
            following messages: Not Authorized (errorcode 20), Invalid Request
            (errorcode 100), Operation Failed (errorcode 101), Server Error
            (errorcode 102), Resource Not Found (errorcode 104).
          x-gitbook-description-html: >-
            <p>A successful receipt of the cancellation returns null; the
            <em>errormsg</em> parameter for an unsuccessful receipt returns one
            of the following messages: Not Authorized (errorcode 20), Invalid
            Request (errorcode 100), Operation Failed (errorcode 101), Server
            Error (errorcode 102), Resource Not Found (errorcode 104).</p>
        errorcode:
          type: integer
          description: >-
            A successful receipt of the cancellation returns 0. An unsuccessful
            receipt returns one of the _errorcodes_ shown in the _errormsg_
            list.
          x-gitbook-description-html: >-
            <p>A successful receipt of the cancellation returns 0. An
            unsuccessful receipt returns one of the <em>errorcodes</em> shown in
            the <em>errormsg</em> list.</p>
        detail:
          type: string
          description: Message text that the system may send. Usually _null_.
          x-gitbook-description-html: <p>Message text that the system may send. Usually <em>null</em>.</p>
      required:
        - result
        - errormsg
        - errorcode
        - detail
    GetUserReportWriterResultRecordsRequest:
      type: object
      properties:
        UserId:
          type: integer
          description: >-
            The ID of the user whose report writer result records will be
            returned.
          x-gitbook-description-html: >-
            <p>The ID of the user whose report writer result records will be
            returned.</p>
        Depth:
          type: integer
          description: >-
            The count of records to be returned, beginning at _startIndex_ and
            working backwards into the past. If not defined, all report writer
            result records will be returned.
          x-gitbook-description-html: >-
            <p>The count of records to be returned, beginning at
            <em>startIndex</em> and working backwards into the past. If not
            defined, all report writer result records will be returned.</p>
        StartIndex:
          type: integer
          description: >-
            The record number at which the call starts returning records; from
            there, record return moves into the past. The most recent record is
            record is at startindex 0.
          x-gitbook-description-html: >-
            <p>The record number at which the call starts returning records;
            from there, record return moves into the past. The most recent
            record is record is at startindex 0.</p>
      required:
        - UserId
    GetUserReportWriterResultRecordsResponse:
      type: object
      properties:
        RequestingUser:
          type: integer
          description: The ID of the user requesting the report writer result records.
          x-gitbook-description-html: >-
            <p>The ID of the user requesting the report writer result
            records.</p>
        urtTicketId:
          type: string
          description: >-
            An alphanumeric string containing the unique report ID of the
            report.
          x-gitbook-description-html: >-
            <p>An alphanumeric string containing the unique report ID of the
            report.</p>
        descriptorId:
          type: string
          description: >-
            A GUID (globally-unique identifier) that describes the report
            separately from the report ticket.
          x-gitbook-description-html: >-
            <p>A GUID (globally-unique identifier) that describes the report
            separately from the report ticket.</p>
        resultStatus:
          type: string
          enum:
            - NotStarted
            - NotComplete
            - ErrorComplete
            - SuccessComplete
            - Cancelled
          description: >-
            The status of each run of the reports. One of: 0 NotStarted, 1
            NotComplete, 2 ErrorComplete, 3 SuccessComplete, 4 Cancelled.
          x-gitbook-description-html: >-
            <p>The status of each run of the reports. One of: 0 NotStarted, 1
            NotComplete, 2 ErrorComplete, 3 SuccessComplete, 4 Cancelled.</p>
        reportExecutionStartTime:
          type: string
          description: >-
            The time that the report writer began execution, in Microsoft Ticks
            format.
          x-gitbook-description-html: >-
            <p>The time that the report writer began execution, in Microsoft
            Ticks format.</p>
        reportExecutionCompleteTime:
          type: string
          description: >-
            The time that the report writer completed the report, in Microsoft
            Ticks format.
          x-gitbook-description-html: >-
            <p>The time that the report writer completed the report, in
            Microsoft Ticks format.</p>
        reportOutputFilePathname:
          type: string
          description: The pathname (location) of the report output file.
          x-gitbook-description-html: <p>The pathname (location) of the report output file.</p>
        reportDescriptiveHeader:
          type: string
          description: A string describing the report.
          x-gitbook-description-html: <p>A string describing the report.</p>
      required:
        - RequestingUser
        - urtTicketId
        - descriptorId
        - resultStatus
        - reportExecutionStartTime
        - reportExecutionCompleteTime
        - reportOutputFilePathname
        - reportDescriptiveHeader
    GetUserReportTicketsRequest:
      type: object
      properties:
        UserId:
          type: integer
          description: The ID of the user whose user report tickets will be returned.
          x-gitbook-description-html: >-
            <p>The ID of the user whose user report tickets will be
            returned.</p>
      required:
        - UserId
    GetUserReportTicketsResponse:
      type: array
      items:
        type: object
        properties:
          RequestingUser:
            type: integer
            description: The User ID of the person requesting the report.
            x-gitbook-description-html: <p>The User ID of the person requesting the report.</p>
          OMSId:
            type: integer
            description: The ID of the OMS on which the report was run.
            x-gitbook-description-html: <p>The ID of the OMS on which the report was run.</p>
          reportFlavor:
            type: string
            description: The type of report. One of, Tradeactivity, Transaction, Treasury.
            x-gitbook-description-html: >-
              <p>The type of report. One of, Tradeactivity, Transaction,
              Treasury.</p>
          createTime:
            type: string
            description: >-
              The time and date at which the request for the report was made,
              Microsoft Ticks format.
            x-gitbook-description-html: >-
              <p>The time and date at which the request for the report was made,
              Microsoft Ticks format.</p>
          initialRunTime:
            type: string
            description: >-
              The time and date at which the report was first run, Microsoft
              Ticks format.
            x-gitbook-description-html: >-
              <p>The time and date at which the report was first run, Microsoft
              Ticks format.</p>
          intervalStartTime:
            type: string
            description: >-
              The start of the period that the report will cover, Microsoft
              Ticks format.
            x-gitbook-description-html: >-
              <p>The start of the period that the report will cover, Microsoft
              Ticks format.</p>
          intervalEndTime:
            type: string
            description: >-
              The end of the period that the report will cover, Microsoft Ticks
              format.
            x-gitbook-description-html: >-
              <p>The end of the period that the report will cover, Microsoft
              Ticks format.</p>
          RequestStatus:
            type: string
            enum:
              - Submitted
              - Validating
              - Scheduled
              - InProgress
              - Completed
              - Aborting
              - Aborted
              - UserCancelled
              - SysRetired
              - UserCancelPending
            description: >-
              The status of the request for the report. Each status returns one
              of: Submitted, Validating, Scheduled, InProgress, Completed,
              Aborting, Aborted, UserCancelled, SysRetired, UserCancelPending.
            x-gitbook-description-html: >-
              <p>The status of the request for the report. Each status returns
              one of: Submitted, Validating, Scheduled, InProgress, Completed,
              Aborting, Aborted, UserCancelled, SysRetired,
              UserCancelPending.</p>
          ReportFrequency:
            type: string
            description: >-
              When the report runs: OnDemand, Hourly, Daily, Weekly, Monthly,
              Annually.
            x-gitbook-description-html: >-
              <p>When the report runs: OnDemand, Hourly, Daily, Weekly, Monthly,
              Annually.</p>
          intervalDuration:
            type: integer
            format: int64
            description: >-
              The period that the report looks backward relative to the run
              date, in POSIX format. The system calculates _intervalDuration_
              between _intervalStartTime_ and _intervalEndTime_ and reports it
              in POSIX format. For example, say that you specify a 90-day
              start-to-end-date window for a report. The _intervalDuration_
              value returns a value equivalent to 90 days and represents the
              backward-looking period of the report. Say that you have set up a
              weekly report to look back 90 days. When the report runs again in
              a week's time, it again looks back 90 days -- but now those 90
              days are offset by a week from the first report.
            x-gitbook-description-html: >-
              <p>The period that the report looks backward relative to the run
              date, in POSIX format. The system calculates
              <em>intervalDuration</em> between <em>intervalStartTime</em> and
              <em>intervalEndTime</em> and reports it in POSIX format. For
              example, say that you specify a 90-day start-to-end-date window
              for a report. The <em>intervalDuration</em> value returns a value
              equivalent to 90 days and represents the backward-looking period
              of the report. Say that you have set up a weekly report to look
              back 90 days. When the report runs again in a week's time, it
              again looks back 90 days -- but now those 90 days are offset by a
              week from the first report.</p>
          RequestId:
            type: string
            description: >-
              The ID of the original request. Request IDs are long strings
              unique within the OMS.
            x-gitbook-description-html: >-
              <p>The ID of the original request. Request IDs are long strings
              unique within the OMS.</p>
          lastInstanceId:
            type: string
            description: >-
              For scheduled reports, the report ID of the most recent previously
              run report. This will be _null_ for a Generate~Report call,
              because generated reports are all on-demand.
            x-gitbook-description-html: >-
              <p>For scheduled reports, the report ID of the most recent
              previously run report. This will be <em>null</em> for a
              Generate~Report call, because generated reports are all
              on-demand.</p>
          accountIds:
            type: array
            items:
              type: integer
            description: >-
              A comma-delimited array of account IDs whose trades are reported
              in the trade activity report.
            x-gitbook-description-html: >-
              <p>A comma-delimited array of account IDs whose trades are
              reported in the trade activity report.</p>
        required:
          - RequestingUser
          - OMSId
          - reportFlavor
          - createTime
          - initialRunTime
          - intervalStartTime
          - intervalEndTime
          - RequestStatus
          - ReportFrequency
          - intervalDuration
          - RequestId
          - lastInstanceId
          - accountIds
    RemoveUserReportTicketRequest:
      type: string
      description: the user report TicketId of the ticket to remove.
      example: '{e27e5268-db50-70fa-de84-ee0b6ae16093}'
      required: true
      x-gitbook-description-html: <p>the user report TicketId of the ticket to remove.</p>
    RemoveUserReportTicketResponse:
      type: object
      properties:
        result:
          type: boolean
          description: >-
            A successful request returns _true_; and unsuccessful request (an
            error condition) returns _false_.
          x-gitbook-description-html: >-
            <p>A successful request returns <em>true</em>; and unsuccessful
            request (an error condition) returns <em>false</em>.</p>
        errormsg:
          type: string
          description: >-
            A successful request returns _null_; the _errormsg_ parameter for an
            unsuccessful request returns one of the following messages:. Not
            Authorized (errorcode 20). Invalid Request (errorcode 100).
            Operation Failed (errorcode 101). Server Error (errorcode 102).
            Resource Not Found (errorcode 104).
          x-gitbook-description-html: >-
            <p>A successful request returns <em>null</em>; the <em>errormsg</em>
            parameter for an unsuccessful request returns one of the following
            messages:. Not Authorized (errorcode 20). Invalid Request (errorcode
            100). Operation Failed (errorcode 101). Server Error (errorcode
            102). Resource Not Found (errorcode 104).</p>
        errorcode:
          type: integer
          description: >-
            A successful request returns 0. An unsuccessful receipt returns one
            of the _errorcodes_ shown in the _errormsg_ list.
          x-gitbook-description-html: >-
            <p>A successful request returns 0. An unsuccessful receipt returns
            one of the <em>errorcodes</em> shown in the <em>errormsg</em>
            list.</p>
        detail:
          type: string
          description: Additional message details sent by the system. Usually _null_.
          x-gitbook-description-html: >-
            <p>Additional message details sent by the system. Usually
            <em>null</em>.</p>
      required:
        - result
        - errormsg
        - errorcode
        - detail
    GetUserReportTicketsByStatusRequest:
      type: array
      items:
        type: object
        description: >-
          The statuses of user report tickets you wish to retrieve. Multiple
          statuses can be specified. If no Request status is defined, the
          default status that the backend will look for is Submitted.
        properties:
          RequestStatus:
            type: string
            enum:
              - Submitted
              - Validating
              - Scheduled
              - InProgress
              - Completed
              - Aborting
              - Aborted
              - UserCancelled
              - SysRetired
              - UserCancelPending
            description: >-
              A status of user report tickets. One of: Submitted, Validating,
              Scheduled, InProgress, Completed, Aborting, Aborted,
              UserCancelled, SysRetired, UserCancelPending.
            x-gitbook-description-html: >-
              <p>A status of user report tickets. One of: Submitted, Validating,
              Scheduled, InProgress, Completed, Aborting, Aborted,
              UserCancelled, SysRetired, UserCancelPending.</p>
        required:
          - RequestStatus
        x-gitbook-description-html: >-
          <p>The statuses of user report tickets you wish to retrieve. Multiple
          statuses can be specified. If no Request status is defined, the
          default status that the backend will look for is Submitted.</p>
    GetUserReportTicketsByStatusResponse:
      type: array
      items:
        type: object
        properties:
          RequestingUser:
            type: integer
            description: >-
              The User ID of the person requesting the trade activity report.
              This confirms the ID of the authenticated user who made the
              request by returning it as part of the response.
            x-gitbook-description-html: >-
              <p>The User ID of the person requesting the trade activity report.
              This confirms the ID of the authenticated user who made the
              request by returning it as part of the response.</p>
          OMSId:
            type: integer
            description: The ID of the OMS on which the trade activity report will be run.
            x-gitbook-description-html: >-
              <p>The ID of the OMS on which the trade activity report will be
              run.</p>
          reportFlavor:
            type: string
            description: >-
              The type of report to be generated. In the case of
              GenerateTradeActivityReport, report flavor will always be
              **TradeActivity**.
            x-gitbook-description-html: >-
              <p>The type of report to be generated. In the case of
              GenerateTradeActivityReport, report flavor will always be
              <strong>TradeActivity</strong>.</p>
          createTime:
            type: string
            description: >-
              The time and date on which the request for the trade activity
              report was made.
            x-gitbook-description-html: >-
              <p>The time and date on which the request for the trade activity
              report was made.</p>
          initialRunTime:
            type: string
            description: >-
              The time and date at which the trade activity report was first
              run.
            x-gitbook-description-html: >-
              <p>The time and date at which the trade activity report was first
              run.</p>
          intervalStartTime:
            type: string
            description: The start of the period that the report will cover.
            x-gitbook-description-html: <p>The start of the period that the report will cover.</p>
          intervalEndTime:
            type: string
            description: The end of the period that the report will cover.
            x-gitbook-description-html: <p>The end of the period that the report will cover.</p>
          RequestStatus:
            type: string
            enum:
              - Submitted
              - Validating
              - Scheduled
              - InProgress
              - Completed
              - Aborting
              - Aborted
              - UserCancelled
              - SysRetired
              - UserCancelled
              - Pending
            description: >-
              The status of the request for the trade activity report. A
              **Generate~Report** request will always return _Submitted_. One
              of: Submitted, Validating, Scheduled, InProgress, Completed,
              Aborting, Aborted, UserCancelled, SysRetired, UserCancelled,
              Pending.
            x-gitbook-description-html: >-
              <p>The status of the request for the trade activity report. A
              <strong>Generate~Report</strong> request will always return
              <em>Submitted</em>. One of: Submitted, Validating, Scheduled,
              InProgress, Completed, Aborting, Aborted, UserCancelled,
              SysRetired, UserCancelled, Pending.</p>
          ReportFrequency:
            type: string
            enum:
              - OnDemand
              - Hourly
              - Daily
              - Weekly
              - Monthly
              - Annually
            description: >-
              When the report runs. For a **Generate~Report** request, this is
              always OnDemand. One of: OnDemand, Hourly, Daily, Weekly, Monthly,
              Annually.
            x-gitbook-description-html: >-
              <p>When the report runs. For a <strong>Generate~Report</strong>
              request, this is always OnDemand. One of: OnDemand, Hourly, Daily,
              Weekly, Monthly, Annually.</p>
          intervalDuration:
            type: integer
            format: int64
            description: >-
              The period that the report covers relative to the run date. The
              **Generate~Report** request requires a start time and an end time.
              The Notbank software calculates the difference between them as
              _intervalDuration_. For example, say that you specify a 90-day
              start-date-to-end-date window for a report. The _intervalDuration_
              value returns a value equivalent to 90 days. If you have called
              **Generate~Report**, that value simply confirms the length of time
              that the on-demand report covers.
            x-gitbook-description-html: >-
              <p>The period that the report covers relative to the run date. The
              <strong>Generate~Report</strong> request requires a start time and
              an end time. The Notbank software calculates the difference
              between them as <em>intervalDuration</em>. For example, say that
              you specify a 90-day start-date-to-end-date window for a report.
              The <em>intervalDuration</em> value returns a value equivalent to
              90 days. If you have called <strong>Generate~Report</strong>, that
              value simply confirms the length of time that the on-demand report
              covers.</p>
          RequestId:
            type: string
            description: >-
              The ID of the original request. Request IDs are long strings
              unique within the OMS.
            x-gitbook-description-html: >-
              <p>The ID of the original request. Request IDs are long strings
              unique within the OMS.</p>
          lastInstanceId:
            type: string
            description: >-
              For scheduled reports, the report ID of the most recent previously
              run report. Will be _null_ for a **Generate~Report** call, because
              generated reports are on-demand.
            x-gitbook-description-html: >-
              <p>For scheduled reports, the report ID of the most recent
              previously run report. Will be <em>null</em> for a
              <strong>Generate~Report</strong> call, because generated reports
              are on-demand.</p>
          accountIds:
            type: array
            items:
              type: integer
            description: >-
              A comma-delimited array of account IDs whose trades are reported
              in the trade activity report.
            x-gitbook-description-html: >-
              <p>A comma-delimited array of account IDs whose trades are
              reported in the trade activity report.</p>
        required:
          - RequestingUser
          - OMSId
          - reportFlavor
          - createTime
          - initialRunTime
          - intervalStartTime
          - intervalEndTime
          - RequestStatus
          - ReportFrequency
          - intervalDuration
          - RequestId
          - lastInstanceId
          - accountIds
    DownloadDocumentRequest:
      type: object
      properties:
        DescriptorId:
          type: string
          description: The GUID that uniquely identifies a report that can be downloaded.
          x-gitbook-description-html: >-
            <p>The GUID that uniquely identifies a report that can be
            downloaded.</p>
      required:
        - DescriptorId
    DownloadDocumentResponse:
      type: object
      properties:
        DescriptorId:
          type: string
          description: The GUID that uniquely identifies a report that can be downloaded.
          x-gitbook-description-html: >-
            <p>The GUID that uniquely identifies a report that can be
            downloaded.</p>
        DocName:
          type: string
          description: The actual filename of the document stored in the server.
          x-gitbook-description-html: <p>The actual filename of the document stored in the server.</p>
        NumSlices:
          type: integer
          description: The number of slices.
          x-gitbook-description-html: <p>The number of slices.</p>
        statusCode:
          type: string
          enum:
            - Success
            - Error
          description: 'One of: **Success**, **Error**.'
          x-gitbook-description-html: '<p>One of: <strong>Success</strong>, <strong>Error</strong>.</p>'
        statusMessage:
          type: string
          enum:
            - success
            - error
          description: 'One of: **success**, **error**.'
          x-gitbook-description-html: '<p>One of: <strong>success</strong>, <strong>error</strong>.</p>'
      required:
        - DescriptorId
        - DocName
        - NumSlices
        - statusCode
        - statusMessage
    DownloadDocumentSliceRequest:
      type: object
      properties:
        DescriptorId:
          type: string
          description: The GUID that uniquely identifies a report that can be downloaded.
          x-gitbook-description-html: >-
            <p>The GUID that uniquely identifies a report that can be
            downloaded.</p>
        sliceNum:
          type: integer
          default: 0
          description: Default is 0.
          x-gitbook-description-html: <p>Default is 0.</p>
      required:
        - DescriptorId
    DownloadDocumentSliceResponse:
      type: object
      properties:
        DescriptorId:
          type: string
          description: The GUID that uniquely identifies a report that can be downloaded.
          x-gitbook-description-html: >-
            <p>The GUID that uniquely identifies a report that can be
            downloaded.</p>
        base64Bytes:
          type: string
          description: The actual contents of the document in base64 format.
          x-gitbook-description-html: <p>The actual contents of the document in base64 format.</p>
        statusCode:
          type: string
          enum:
            - Success
            - Error
          description: 'One of: **Success**, **Error**.'
          x-gitbook-description-html: '<p>One of: <strong>Success</strong>, <strong>Error</strong>.</p>'
        statusMessage:
          type: string
          enum:
            - success
            - error
          description: 'One of: **success**, **error**.'
          x-gitbook-description-html: '<p>One of: <strong>success</strong>, <strong>error</strong>.</p>'
      required:
        - DescriptorId
        - base64Bytes
        - statusCode
        - statusMessage
    PingRequest:
      type: object
      properties:
        msg:
          type: string
          description: >-
            PONG means Ping request was successful and the gateway has
            responded.
          x-gitbook-description-html: >-
            <p>PONG means Ping request was successful and the gateway has
            responded.</p>
      required:
        - msg
    PingResponse:
      type: object
      properties:
        msg:
          type: string
          description: >-
            PONG means Ping request was successful and the gateway has
            responded.
          x-gitbook-description-html: >-
            <p>PONG means Ping request was successful and the gateway has
            responded.</p>
      required:
        - msg
    HealthCheckResponse:
      type: object
      properties:
        result:
          type: boolean
          description: >-
            A successful request returns true; and unsuccessful request (an
            error condition) returns false.
          x-gitbook-description-html: >-
            <p>A successful request returns true; and unsuccessful request (an
            error condition) returns false.</p>
        errormsg:
          type: string
          description: >-
            A successful request returns null; the _errormsg_ parameter for an
            unsuccessful request returns one of the following messages: Not
            Authorized (errorcode 20), Invalid Request (errorcode 100),
            Operation Failed (errorcode 101), Server Error (errorcode 102),
            Resource Not Found (errorcode 104).
          x-gitbook-description-html: >-
            <p>A successful request returns null; the <em>errormsg</em>
            parameter for an unsuccessful request returns one of the following
            messages: Not Authorized (errorcode 20), Invalid Request (errorcode
            100), Operation Failed (errorcode 101), Server Error (errorcode
            102), Resource Not Found (errorcode 104).</p>
        errorcode:
          type: integer
          description: >-
            A successful request returns 0. An unsuccessful request returns one
            of the _errorcodes_ shown in the _errormsg_ list.
          x-gitbook-description-html: >-
            <p>A successful request returns 0. An unsuccessful request returns
            one of the <em>errorcodes</em> shown in the <em>errormsg</em>
            list.</p>
        detail:
          type: string
          description: >-
            A string description of the status of the exchange, plus the json
            string representation, defnied as: { "LatencyMetadata": { "type":
            "object", "description": "Detailed timestamps and round-trip metrics
            for request tracing.", "properties": { "ExchangeId": { "type":
            "integer", "format": "int32", "description": "The unique ID of the
            Exchange.", "example": 1 }, "Data1": { "type": "integer", "format":
            "int64", "description": "Initial processing timestamp in UTC." },
            "Data2": { "type": "integer", "format": "int64", "description":
            "Internal flag.", "default": 1 }, "OmsId": { "type": "integer",
            "format": "int64", "default": 0 }, "GatewayIn": { "type": "integer",
            "format": "int64", "description": "Timestamp when the request
            reached the Gateway (UTC)." }, "OmsIn": { "type": "integer",
            "format": "int64", "description": "Timestamp when the request
            reached the OMS (UTC)." }, "MatchingEngineIn": { "type": "integer",
            "format": "int64", "description": "Timestamp when the request
            reached the Matching Engine (UTC)." }, "OmsOut": { "type":
            "integer", "format": "int64", "description": "Timestamp when the OMS
            finished the check (UTC)." }, "GatewayOut": { "type": "integer",
            "format": "int64", "description": "Timestamp when the response left
            the Gateway (UTC)." }, "RoundTripTimeMic": { "type": "integer",
            "format": "int64", "description": "Total duration of all internal
            checks in milliseconds.", "example": 15 } } } } 
          x-gitbook-description-html: >-
            <p>A string description of the status of the exchange, plus the json
            string representation, defnied as: { "LatencyMetadata": { "type":
            "object", "description": "Detailed timestamps and round-trip metrics
            for request tracing.", "properties": { "ExchangeId": { "type":
            "integer", "format": "int32", "description": "The unique ID of the
            Exchange.", "example": 1 }, "Data1": { "type": "integer", "format":
            "int64", "description": "Initial processing timestamp in UTC." },
            "Data2": { "type": "integer", "format": "int64", "description":
            "Internal flag.", "default": 1 }, "OmsId": { "type": "integer",
            "format": "int64", "default": 0 }, "GatewayIn": { "type": "integer",
            "format": "int64", "description": "Timestamp when the request
            reached the Gateway (UTC)." }, "OmsIn": { "type": "integer",
            "format": "int64", "description": "Timestamp when the request
            reached the OMS (UTC)." }, "MatchingEngineIn": { "type": "integer",
            "format": "int64", "description": "Timestamp when the request
            reached the Matching Engine (UTC)." }, "OmsOut": { "type":
            "integer", "format": "int64", "description": "Timestamp when the OMS
            finished the check (UTC)." }, "GatewayOut": { "type": "integer",
            "format": "int64", "description": "Timestamp when the response left
            the Gateway (UTC)." }, "RoundTripTimeMic": { "type": "integer",
            "format": "int64", "description": "Total duration of all internal
            checks in milliseconds.", "example": 15 } } } }</p>
      required:
        - result
        - errormsg
        - errorcode
        - detail
    SendOrderListRequest:
      type: array
      items:
        type: object
        properties:
          InstrumentId:
            type: integer
            description: The ID of the instrument being traded.
            x-gitbook-description-html: <p>The ID of the instrument being traded.</p>
          OMSId:
            type: integer
            description: The ID of the OMS on which the instrument is being traded.
            x-gitbook-description-html: <p>The ID of the OMS on which the instrument is being traded.</p>
          AccountId:
            type: integer
            description: The ID of the account the order will be placed for.
            x-gitbook-description-html: <p>The ID of the account the order will be placed for.</p>
          TimeInForce:
            type: integer
            enum:
              - 0
              - 1
              - 2
              - 3
              - 4
              - 5
              - 6
            description: >-
              An integer that represents the period during which the new order
              is executable. One of: **0** Unknown (an error condition), **1**
              GTC (good 'til canceled, the default), **2** OPG (execute as close
              to opening price as possible: not yet used, for future provision),
              **3** IOC (immediate or canceled), **4** FOK (fill-or-kill &mdash;
              fill immediately or kill immediately), **5** GTX (good 'til
              executed: not yet used, for future provision), **6** GTD (good
              'til date: not yet used, for future provision).
            x-gitbook-description-html: >-
              <p>An integer that represents the period during which the new
              order is executable. One of: <strong>0</strong> Unknown (an error
              condition), <strong>1</strong> GTC (good 'til canceled, the
              default), <strong>2</strong> OPG (execute as close to opening
              price as possible: not yet used, for future provision),
              <strong>3</strong> IOC (immediate or canceled), <strong>4</strong>
              FOK (fill-or-kill — fill immediately or kill immediately),
              <strong>5</strong> GTX (good 'til executed: not yet used, for
              future provision), <strong>6</strong> GTD (good 'til date: not yet
              used, for future provision).</p>
          ClientOrderId:
            type: integer
            format: int64
            default: 0
            description: >-
              A user-assigned ID for the order (like a purchase-order number
              assigned by a company). This ID is useful for recognizing future
              states related to this order. Duplicate client orderid of two open
              orders of the same account is not allowed, the incoming order with
              the same ClientOrderId will get rejected. Default is 0.
            x-gitbook-description-html: >-
              <p>A user-assigned ID for the order (like a purchase-order number
              assigned by a company). This ID is useful for recognizing future
              states related to this order. Duplicate client orderid of two open
              orders of the same account is not allowed, the incoming order with
              the same ClientOrderId will get rejected. Default is 0.</p>
          OrderIdOCO:
            type: integer
            format: int64
            description: >-
              The order ID if One Cancels the Other — If this order is order A,
              _OrderIdOCO_ refers to the order ID of an order B (which is _not_
              the order being created by this call). If order B executes, then
              order A created by this call is canceled. You can also set up
              order B to watch order A in the same way, but that may require an
              update to order B to make it watch this one, which could have
              implications for priority in the order book. See
              [**CancelReplaceOrder**](#operation/CancelReplaceOrder) and
              [**ModifyOrder**](#operation/ModifyOrder).
            x-gitbook-description-html: >-
              <p>The order ID if One Cancels the Other — If this order is order
              A, <em>OrderIdOCO</em> refers to the order ID of an order B (which
              is <em>not</em> the order being created by this call). If order B
              executes, then order A created by this call is canceled. You can
              also set up order B to watch order A in the same way, but that may
              require an update to order B to make it watch this one, which
              could have implications for priority in the order book. See <a
              href="#operation/CancelReplaceOrder"><strong>CancelReplaceOrder</strong></a>
              and <a
              href="#operation/ModifyOrder"><strong>ModifyOrder</strong></a>.</p>
          UseDisplayQuantity:
            type: boolean
            default: false
            description: >-
              If you enter a Limit order with a reserve (reserve order), you
              must set _UseDisplayQuantity_ to _true_ else, the quantity of your
              order will be 0, defaults to **false**.
            x-gitbook-description-html: >-
              <p>If you enter a Limit order with a reserve (reserve order), you
              must set <em>UseDisplayQuantity</em> to <em>true</em> else, the
              quantity of your order will be 0, defaults to
              <strong>false</strong>.</p>
          Side:
            type: integer
            enum:
              - 0
              - 1
            description: >-
              A number representing the side of a trade. One of: **0** Buy,
              **1** Sell.
            x-gitbook-description-html: >-
              <p>A number representing the side of a trade. One of:
              <strong>0</strong> Buy, <strong>1</strong> Sell.</p>
          Quantity:
            type: number
            format: decimal
            description: >-
              The quantity of the instrument being ordered. Not required if
              **OrderType** is Market (1) and as long as **Value** is defined.
            x-gitbook-description-html: >-
              <p>The quantity of the instrument being ordered. Not required if
              <strong>OrderType</strong> is Market (1) and as long as
              <strong>Value</strong> is defined.</p>
          OrderType:
            type: integer
            enum:
              - 0
              - 1
              - 2
              - 3
              - 4
              - 5
              - 6
              - 7
            description: >-
              The type of the order. One of: **0** Unknown, **1** Market, **2**
              Limit, **3** StopMarket, **4** StopLimit, **5**
              TrailingStopMarket, **6** TrailingStopLimit, **7** BlockTrade.
            x-gitbook-description-html: >-
              <p>The type of the order. One of: <strong>0</strong> Unknown,
              <strong>1</strong> Market, <strong>2</strong> Limit,
              <strong>3</strong> StopMarket, <strong>4</strong> StopLimit,
              <strong>5</strong> TrailingStopMarket, <strong>6</strong>
              TrailingStopLimit, <strong>7</strong> BlockTrade.</p>
          PegPriceType:
            oneOf:
              - type: integer
              - type: string
            enum:
              - 1
              - 2
              - 3
              - 4
            default: 1
            description: >-
              Only applicable to TrailingStop and Stop orders. The type of price
              that pegs the stop. One of: 1 Last, 2 Bid, 3 Ask, 4 Midpoint
              (Currently unsupported; for future provision). Default is 1 Last.
            x-gitbook-description-html: >-
              <p>Only applicable to TrailingStop and Stop orders. The type of
              price that pegs the stop. One of: 1 Last, 2 Bid, 3 Ask, 4 Midpoint
              (Currently unsupported; for future provision). Default is 1
              Last.</p>
          LimitPrice:
            type: number
            format: decimal
            description: >-
              The price at which the order will be placed. Required if OrderType
              is **2 Limit** or **4 StopLimit** or **7 TrailingStopLimit**.
            x-gitbook-description-html: >-
              <p>The price at which the order will be placed. Required if
              OrderType is <strong>2 Limit</strong> or <strong>4
              StopLimit</strong> or <strong>7 TrailingStopLimit</strong>.</p>
          StopPrice:
            type: number
            format: decimal
            default: 0
            description: >-
              Applicable to TrailingStop (Limit and Market) and Stop (Limit and
              Market) orders only; the price at which the order will get
              activated. Is not required to be defined for TrailingStop order as
              this price will be determined automatically based on the
              **TrailingAmount**, **PegPriceType** and most importantly the
              movement of the price where the order is pegged
              (**PegPriceType**). Default is 0.
            x-gitbook-description-html: >-
              <p>Applicable to TrailingStop (Limit and Market) and Stop (Limit
              and Market) orders only; the price at which the order will get
              activated. Is not required to be defined for TrailingStop order as
              this price will be determined automatically based on the
              <strong>TrailingAmount</strong>, <strong>PegPriceType</strong> and
              most importantly the movement of the price where the order is
              pegged (<strong>PegPriceType</strong>). Default is 0.</p>
          TrailingAmount:
            type: number
            format: decimal
            description: >-
              Applicable to TrailingStopLimit and TrailingStopMarket orders
              only; a number that will be either added to (buy side) or
              subtracted from (sell side) the price where the order is
              pegged(depends on the **PegPriceType**); the sum or the difference
              will be the **StopPrice** of the **TrailingStop** order. On the
              buy side, if the price where the order is pegged increases and
              never goes down below the value when the order was placed, the
              resulting StopPrice will be the sum of the price where the order
              is pegged during submission and the TrailingAmount; however, if
              the price where the order is pegged decreases, the StopPrice will
              change, it will be the sum of the whatever is the lowest value the
              pegged price will have and the TrailingAmount: the logic on the
              sell side is the opposite.
            x-gitbook-description-html: >-
              <p>Applicable to TrailingStopLimit and TrailingStopMarket orders
              only; a number that will be either added to (buy side) or
              subtracted from (sell side) the price where the order is
              pegged(depends on the <strong>PegPriceType</strong>); the sum or
              the difference will be the <strong>StopPrice</strong> of the
              <strong>TrailingStop</strong> order. On the buy side, if the price
              where the order is pegged increases and never goes down below the
              value when the order was placed, the resulting StopPrice will be
              the sum of the price where the order is pegged during submission
              and the TrailingAmount; however, if the price where the order is
              pegged decreases, the StopPrice will change, it will be the sum of
              the whatever is the lowest value the pegged price will have and
              the TrailingAmount: the logic on the sell side is the
              opposite.</p>
          LimitOffset:
            type: number
            format: decimal
            description: >-
              Applicable to TrailingStopLimit only; a number that will be either
              added (buy side) or subtracted (sell side) to the **StopPrice**,
              the sum or the difference will be the LimitPrice of the order when
              it gets activated.
            x-gitbook-description-html: >-
              <p>Applicable to TrailingStopLimit only; a number that will be
              either added (buy side) or subtracted (sell side) to the
              <strong>StopPrice</strong>, the sum or the difference will be the
              LimitPrice of the order when it gets activated.</p>
          DisplayQuantity:
            type: integer
            description: >-
              If _UseDisplayQuantity_ is set to _true_, you must set a value of
              this field greater than 0, else, order will not appear in the
              orderbook.
            x-gitbook-description-html: >-
              <p>If <em>UseDisplayQuantity</em> is set to <em>true</em>, you
              must set a value of this field greater than 0, else, order will
              not appear in the orderbook.</p>
          Value:
            type: number
            format: decimal
            description: >-
              The total value of the trade. Only applicable in a market order
              type: a user can opt to input a value instead of defining the
              quantity which will then be automatically calculated:
              value/marketprice.
            x-gitbook-description-html: >-
              <p>The total value of the trade. Only applicable in a market order
              type: a user can opt to input a value instead of defining the
              quantity which will then be automatically calculated:
              value/marketprice.</p>
          PostOlny:
            type: boolean
            description: If the order is post only.
            x-gitbook-description-html: <p>If the order is post only.</p>
        required:
          - InstrumentId
          - OMSId
          - AccountId
          - TimeInForce
          - Side
          - Quantity
          - OrderType
          - LimitPrice
          - StopPrice
          - TrailingAmount
          - LimitOffset
    SendOrderListResponse:
      type: object
      properties:
        result:
          type: boolean
          description: >-
            Specifically for this API method only, it returns false even if the
            request went through.
          x-gitbook-description-html: >-
            <p>Specifically for this API method only, it returns false even if
            the request went through.</p>
        errormsg:
          type: string
          description: >-
            A successful request returns **Operation In Process**; the
            _errormsg_ parameter for an unsuccessful request returns one of the
            following messages: Not Authorized (errorcode 20), Invalid Request
            (errorcode 100), Operation Failed (errorcode 101), Server Error
            (errorcode 102), Resource Not Found (errorcode 104).
          x-gitbook-description-html: >-
            <p>A successful request returns <strong>Operation In
            Process</strong>; the <em>errormsg</em> parameter for an
            unsuccessful request returns one of the following messages: Not
            Authorized (errorcode 20), Invalid Request (errorcode 100),
            Operation Failed (errorcode 101), Server Error (errorcode 102),
            Resource Not Found (errorcode 104).</p>
        errorcode:
          type: integer
          description: >-
            A successful request returns 107. An unsuccessful request returns
            one of the _errorcodes_ shown in the _errormsg_ list.
          x-gitbook-description-html: >-
            <p>A successful request returns 107. An unsuccessful request returns
            one of the <em>errorcodes</em> shown in the <em>errormsg</em>
            list.</p>
        detail:
          type: string
          description: Message text that the system may send. Usually _null_.
          x-gitbook-description-html: <p>Message text that the system may send. Usually <em>null</em>.</p>
      required:
        - result
        - errormsg
        - errorcode
        - detail
    SendCancelListRequest:
      type: array
      items:
        type: object
        properties:
          OMSId:
            type: integer
            description: The ID of the OMS on which the original order was placed.
            x-gitbook-description-html: <p>The ID of the OMS on which the original order was placed.</p>
          OrderId:
            type: integer
            description: >-
              The ID of the order/s to be canceled. To get orderid/s of open
              orders, you can use the
              [**GetOpenOrders**](#operation/GetOpenOrders) API method.
            x-gitbook-description-html: >-
              <p>The ID of the order/s to be canceled. To get orderid/s of open
              orders, you can use the <a
              href="#operation/GetOpenOrders"><strong>GetOpenOrders</strong></a>
              API method.</p>
          AccountId:
            type: integer
            description: >-
              Account for which order/s will be canceled. If not specified,
              order/s will not be cancelled.
            x-gitbook-description-html: >-
              <p>Account for which order/s will be canceled. If not specified,
              order/s will not be cancelled.</p>
        required:
          - OMSId
          - OrderId
          - AccountId
    SendCancelListResponse:
      type: object
      properties:
        result:
          type: boolean
          description: >-
            A successful request returns true; and unsuccessful request (an
            error condition) returns false.
          x-gitbook-description-html: >-
            <p>A successful request returns true; and unsuccessful request (an
            error condition) returns false.</p>
        errormsg:
          type: string
          description: >-
            A successful request returns null; the _errormsg_ parameter for an
            unsuccessful request returns one of the following messages: Not
            Authorized (errorcode 20), Invalid Request (errorcode 100),
            Operation Failed (errorcode 101), Server Error (errorcode 102),
            Resource Not Found (errorcode 104).
          x-gitbook-description-html: >-
            <p>A successful request returns null; the <em>errormsg</em>
            parameter for an unsuccessful request returns one of the following
            messages: Not Authorized (errorcode 20), Invalid Request (errorcode
            100), Operation Failed (errorcode 101), Server Error (errorcode
            102), Resource Not Found (errorcode 104).</p>
        errorcode:
          type: integer
          description: >-
            A successful request returns 0. An unsuccessful request returns one
            of the _errorcodes_ shown in the _errormsg_ list.
          x-gitbook-description-html: >-
            <p>A successful request returns 0. An unsuccessful request returns
            one of the <em>errorcodes</em> shown in the <em>errormsg</em>
            list.</p>
        detail:
          type: string
          description: Message text that the system may send. Usually _null_.
          x-gitbook-description-html: <p>Message text that the system may send. Usually <em>null</em>.</p>
      required:
        - result
        - errormsg
        - errorcode
        - detail
    SendCancelReplaceListRequest:
      type: array
      items:
        type: object
        properties:
          OmsId:
            type: integer
            description: >-
              The ID of the OMS on which the order is being canceled and
              replaced by another order.
            x-gitbook-description-html: >-
              <p>The ID of the OMS on which the order is being canceled and
              replaced by another order.</p>
          ReplaceOrderId:
            type: integer
            format: int64
            description: The ID of the order to be replaced.
            x-gitbook-description-html: <p>The ID of the order to be replaced.</p>
          ReplaceClientOrderId:
            type: integer
            format: int64
            description: The ClientOrderId of the existing order to be replaced.
            x-gitbook-description-html: <p>The ClientOrderId of the existing order to be replaced.</p>
          ClientOrderId:
            type: integer
            format: int64
            default: 0
            description: >-
              A custom ID that can identify the replacement order later on. It
              is required for this field to be unique for every working order.
              Default is 0.
            x-gitbook-description-html: >-
              <p>A custom ID that can identify the replacement order later on.
              It is required for this field to be unique for every working
              order. Default is 0.</p>
          OrderType:
            oneOf:
              - type: integer
              - type: string
            enum:
              - 0
              - 1
              - 2
              - 3
              - 4
              - 5
              - 6
              - 7
            description: >-
              The type of the replacement order. Either the integer or string
              value is accepted. One of: 0 Unknown, 1 Market, 2 Limit, 3
              StopMarket, 4 StopLimit, 5 TrailingStopMarket, 6
              TrailingStopLimit, 7 BlockTrade.
            x-gitbook-description-html: >-
              <p>The type of the replacement order. Either the integer or string
              value is accepted. One of: 0 Unknown, 1 Market, 2 Limit, 3
              StopMarket, 4 StopLimit, 5 TrailingStopMarket, 6
              TrailingStopLimit, 7 BlockTrade.</p>
          Side:
            type: integer
            enum:
              - 0
              - 1
            description: >-
              An integer representing the side of the replacement order. One of:
              0 Buy, 1 Sell.
            x-gitbook-description-html: >-
              <p>An integer representing the side of the replacement order. One
              of: 0 Buy, 1 Sell.</p>
          AccountId:
            type: integer
            description: >-
              The ID of the account who owns the order and is replacing the
              order, AccountId of the replacement order must match the AccountId
              of the existing order.
            x-gitbook-description-html: >-
              <p>The ID of the account who owns the order and is replacing the
              order, AccountId of the replacement order must match the AccountId
              of the existing order.</p>
          InstrumentId:
            type: integer
            description: The ID of the instrument being traded.
            x-gitbook-description-html: <p>The ID of the instrument being traded.</p>
          UseDisplayQuantity:
            type: boolean
            description: >-
              The display quantity is the quantity of a product shown to the
              market to buy or sell. A larger quantity may be wanted or
              available, but it may disadvantageous to display it when buying or
              selling. The display quantity is set when placing an order (using
              **SendOrder** or **CancelReplaceOrder** for instance). If you
              enter a Limit order with reserve, you must set
              _useDisplayQuantity_ to _true_.
            x-gitbook-description-html: >-
              <p>The display quantity is the quantity of a product shown to the
              market to buy or sell. A larger quantity may be wanted or
              available, but it may disadvantageous to display it when buying or
              selling. The display quantity is set when placing an order (using
              <strong>SendOrder</strong> or <strong>CancelReplaceOrder</strong>
              for instance). If you enter a Limit order with reserve, you must
              set <em>useDisplayQuantity</em> to <em>true</em>.</p>
          DisplayQuantity:
            type: number
            format: decimal
            default: 0
            description: >-
              The quantity of a product that is available to buy or sell that is
              publicly displayed to the market or simply in the orderbook. Will
              be used when **UseDisplayQuantity** is set to true, and in that
              case it needs to be defined else order will not appear in the
              order book as it defaults to 0.
            x-gitbook-description-html: >-
              <p>The quantity of a product that is available to buy or sell that
              is publicly displayed to the market or simply in the orderbook.
              Will be used when <strong>UseDisplayQuantity</strong> is set to
              true, and in that case it needs to be defined else order will not
              appear in the order book as it defaults to 0.</p>
          LimitPrice:
            type: number
            format: decimal
            description: >-
              The price at which to execute the new order, if the new order is a
              limit order. If the replacement order is a market order, there is
              no need to define this field. Expressed in ticks for trailing
              stops.
            x-gitbook-description-html: >-
              <p>The price at which to execute the new order, if the new order
              is a limit order. If the replacement order is a market order,
              there is no need to define this field. Expressed in ticks for
              trailing stops.</p>
          StopPrice:
            type: number
            format: decimal
            description: >-
              The price at which to execute the new order if the replacement
              order is a stop order. If the replacement order is a not a stop
              order, there is no need to define this field. Expressed in ticks
              for trailing stops.
            x-gitbook-description-html: >-
              <p>The price at which to execute the new order if the replacement
              order is a stop order. If the replacement order is a not a stop
              order, there is no need to define this field. Expressed in ticks
              for trailing stops.</p>
          ReferencePrice:
            type: number
            format: decimal
            description: >-
              Used if the replacement order is trailing order. If the
              replacement order is not a trailing order, there is no need to
              define this field.
            x-gitbook-description-html: >-
              <p>Used if the replacement order is trailing order. If the
              replacement order is not a trailing order, there is no need to
              define this field.</p>
          PegPriceType:
            oneOf:
              - type: integer
              - type: string
            enum:
              - 0
              - 1
              - 2
              - 3
              - 4
            description: >-
              The type of price you set in a stop/trailing order to "peg the
              stop". One of: 0 Unknown, 1 Last, 2 Bid, 3 Ask, 4 Midpoint. If the
              replacement order is not a trailing/stop order, there is no need
              to define this field.
            x-gitbook-description-html: >-
              <p>The type of price you set in a stop/trailing order to "peg the
              stop". One of: 0 Unknown, 1 Last, 2 Bid, 3 Ask, 4 Midpoint. If the
              replacement order is not a trailing/stop order, there is no need
              to define this field.</p>
          TimeInForce:
            oneOf:
              - type: integer
              - type: string
            enum:
              - 0
              - 1
              - 2
              - 3
              - 4
              - 5
              - 6
            description: >-
              Represents the period during which the new order is executable.
              One of: 0 Unknown (an error condition), 1 GTC (good 'til canceled,
              the default), 2 OPG (execute as close to opening price as
              possible: not yet used, for future provision), 3 IOC (immediate or
              canceled), 4 FOK (fill or kill &mdash; fill the order immediately,
              or cancel it immediately), 5 GTX (good 'til executed: not yet
              used, for future provision), 6 GTD (good 'til date: not yet used,
              for future provision).
            x-gitbook-description-html: >-
              <p>Represents the period during which the new order is executable.
              One of: 0 Unknown (an error condition), 1 GTC (good 'til canceled,
              the default), 2 OPG (execute as close to opening price as
              possible: not yet used, for future provision), 3 IOC (immediate or
              canceled), 4 FOK (fill or kill — fill the order immediately, or
              cancel it immediately), 5 GTX (good 'til executed: not yet used,
              for future provision), 6 GTD (good 'til date: not yet used, for
              future provision).</p>
          OrderIdOCO:
            type: integer
            description: >-
              If the order being canceled in this call is order A, and the order
              replacing order A in this call is order B, then _OrderIdOCO_
              refers to an order C that is currently open. If order C executes,
              then order B is canceled. You can also set up order C to watch
              order B in this way, but that will require an update to order C.
              Orderid to link this order to for OCO, negative values represent
              ordinal offset to current orderid, i.e., -1 = previous order.
            x-gitbook-description-html: >-
              <p>If the order being canceled in this call is order A, and the
              order replacing order A in this call is order B, then
              <em>OrderIdOCO</em> refers to an order C that is currently open.
              If order C executes, then order B is canceled. You can also set up
              order C to watch order B in this way, but that will require an
              update to order C. Orderid to link this order to for OCO, negative
              values represent ordinal offset to current orderid, i.e., -1 =
              previous order.</p>
          Quantity:
            type: number
            format: decimal
            description: The quantity of the replacement order.
            x-gitbook-description-html: <p>The quantity of the replacement order.</p>
        required:
          - OmsId
          - ReplaceOrderId
          - OrderType
          - Side
          - AccountId
          - InstrumentId
          - LimitPrice
          - StopPrice
          - ReferencePrice
          - PegPriceType
          - TimeInForce
          - Quantity
    SendCancelReplaceListResponse:
      type: object
      properties:
        result:
          type: boolean
          description: >-
            A successful request returns true; and unsuccessful request (an
            error condition) returns false.
          x-gitbook-description-html: >-
            <p>A successful request returns true; and unsuccessful request (an
            error condition) returns false.</p>
        errormsg:
          type: string
          description: >-
            A successful request returns null; the _errormsg_ parameter for an
            unsuccessful request returns one of the following messages: Not
            Authorized (errorcode 20), Invalid Request (errorcode 100),
            Operation Failed (errorcode 101), Server Error (errorcode 102),
            Resource Not Found (errorcode 104), Order Not Found (errorcode 104).
          x-gitbook-description-html: >-
            <p>A successful request returns null; the <em>errormsg</em>
            parameter for an unsuccessful request returns one of the following
            messages: Not Authorized (errorcode 20), Invalid Request (errorcode
            100), Operation Failed (errorcode 101), Server Error (errorcode
            102), Resource Not Found (errorcode 104), Order Not Found (errorcode
            104).</p>
        errorcode:
          type: integer
          description: >-
            A successful request returns 0. An unsuccessful request returns one
            of the _errorcodes_ shown in the _errormsg_ list.
          x-gitbook-description-html: >-
            <p>A successful request returns 0. An unsuccessful request returns
            one of the <em>errorcodes</em> shown in the <em>errormsg</em>
            list.</p>
        detail:
          type: string
          description: Message text that the system may send. Usually _null_.
          x-gitbook-description-html: <p>Message text that the system may send. Usually <em>null</em>.</p>
      required:
        - result
        - errormsg
        - errorcode
        - detail
    ModifyOrderRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS on which the original order was placed.
          x-gitbook-description-html: <p>The ID of the OMS on which the original order was placed.</p>
        OrderId:
          type: integer
          format: int64
          description: >-
            The ID of the order to be modified. The ID was supplied by the
            server when the order was created.
          x-gitbook-description-html: >-
            <p>The ID of the order to be modified. The ID was supplied by the
            server when the order was created.</p>
        InstrumentId:
          type: integer
          description: The ID of the instrument traded in the order.
          x-gitbook-description-html: <p>The ID of the instrument traded in the order.</p>
        Quantity:
          type: number
          format: decimal
          description: >-
            The new quantity of the order. This value can only be reduced from a
            previous quantity.
          x-gitbook-description-html: >-
            <p>The new quantity of the order. This value can only be reduced
            from a previous quantity.</p>
        AccountId:
          type: integer
          description: Account for which order will be modified.
          x-gitbook-description-html: <p>Account for which order will be modified.</p>
      required:
        - OMSId
        - OrderId
        - InstrumentId
        - Quantity
        - AccountId
    ModifyOrderResponse:
      type: object
      properties:
        result:
          type: boolean
          description: >-
            The successful receipt of a modify order request returns _true_;
            otherwise, returns _false_. This is the acknowledgment of receipt of
            the request to modify, not a confirmation that the modification has
            taken place.
          x-gitbook-description-html: >-
            <p>The successful receipt of a modify order request returns
            <em>true</em>; otherwise, returns <em>false</em>. This is the
            acknowledgment of receipt of the request to modify, not a
            confirmation that the modification has taken place.</p>
        errormsg:
          type: string
          description: >-
            A successful receipt of a modify request returns _null_; the
            _errormsg_ parameter for an unsuccessful request returns one of the
            following messages:. Not Authorized (errorcode 20). Invalid Request
            (errorcode 100). Invalid Quantity (errorcode 100). Operation Failed
            (errorcode 101). Server Error (errorcode 102). Resource Not Found
            (errorcode 104).
          x-gitbook-description-html: >-
            <p>A successful receipt of a modify request returns <em>null</em>;
            the <em>errormsg</em> parameter for an unsuccessful request returns
            one of the following messages:. Not Authorized (errorcode 20).
            Invalid Request (errorcode 100). Invalid Quantity (errorcode 100).
            Operation Failed (errorcode 101). Server Error (errorcode 102).
            Resource Not Found (errorcode 104).</p>
        errorcode:
          type: integer
          description: >-
            The receipt of a successful request to modify returns 0. An
            unsuccessful request returns one of the _errorcodes_ shown in the
            _errormsg_ list.
          x-gitbook-description-html: >-
            <p>The receipt of a successful request to modify returns 0. An
            unsuccessful request returns one of the <em>errorcodes</em> shown in
            the <em>errormsg</em> list.</p>
        detail:
          type: string
          description: Message text that the system may send. Usually _null_.
          x-gitbook-description-html: <p>Message text that the system may send. Usually <em>null</em>.</p>
      required:
        - result
        - errormsg
        - errorcode
        - detail
    CancelAllOrdersRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS on which the account operates.
          x-gitbook-description-html: <p>The ID of the OMS on which the account operates.</p>
        AccountId:
          type: integer
          description: >-
            The account for which all orders are being canceled. If no AccountId
            is defined, orders for all accounts will be cancelled.
          x-gitbook-description-html: >-
            <p>The account for which all orders are being canceled. If no
            AccountId is defined, orders for all accounts will be cancelled.</p>
        IntrumentId:
          type: integer
          description: >-
            The instrument for which all orders are being canceled. If there is
            no instrumentid defined, all orders for all instruments will be
            cancelled.
          x-gitbook-description-html: >-
            <p>The instrument for which all orders are being canceled. If there
            is no instrumentid defined, all orders for all instruments will be
            cancelled.</p>
      required:
        - OMSId
    CancelAllOrdersResponse:
      type: object
      properties:
        result:
          type: boolean
          description: >-
            If the call has been successfully received by the OMS, _result_ is
            _true;_ otherwise it is _false._.
          x-gitbook-description-html: >-
            <p>If the call has been successfully received by the OMS,
            <em>result</em> is <em>true;</em> otherwise it is
            <em>false.</em>.</p>
        errormsg:
          type: string
          description: >-
            A successful receipt of the call returns _null._ The _errormsg_ key
            for an unsuccessful call returns one of the following messages:. Not
            Authorized (errorcode 20). Invalid Response (errorcode 100).
            Operation Failed (errorcode 101). Server Error (errorcode 102).
            Resource Not Found (errorcode 104). Operation Not Supported
            (errorcode 106).
          x-gitbook-description-html: >-
            <p>A successful receipt of the call returns <em>null.</em> The
            <em>errormsg</em> key for an unsuccessful call returns one of the
            following messages:. Not Authorized (errorcode 20). Invalid Response
            (errorcode 100). Operation Failed (errorcode 101). Server Error
            (errorcode 102). Resource Not Found (errorcode 104). Operation Not
            Supported (errorcode 106).</p>
        errorcode:
          type: integer
          description: >-
            A successful receipt of the call returns 0. An unsuccessful receipt
            of the call returns one of the _errorcodes_ shown in the _errormsg_
            list.
          x-gitbook-description-html: >-
            <p>A successful receipt of the call returns 0. An unsuccessful
            receipt of the call returns one of the <em>errorcodes</em> shown in
            the <em>errormsg</em> list.</p>
        detail:
          type: string
          description: Message text that the system may send.
          x-gitbook-description-html: <p>Message text that the system may send.</p>
      required:
        - result
        - errormsg
        - errorcode
        - detail
    GetOrderStatusRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS on which the order was placed.
          x-gitbook-description-html: <p>The ID of the OMS on which the order was placed.</p>
        AccountId:
          type: integer
          description: The ID of the account under which the order was placed.
          x-gitbook-description-html: <p>The ID of the account under which the order was placed.</p>
        OrderId:
          type: integer
          description: The ID of the order whose status will be returned.
          x-gitbook-description-html: <p>The ID of the order whose status will be returned.</p>
      required:
        - AccountId
        - OrderId
    GetOrderStatusResponse:
      type: object
      properties:
        Side:
          type: string
          enum:
            - Buy
            - Sell
          description: 'The side of a trade. One of: **0** Buy, **1** Sell.'
          x-gitbook-description-html: >-
            <p>The side of a trade. One of: <strong>0</strong> Buy,
            <strong>1</strong> Sell.</p>
        OrderId:
          type: integer
          format: int64
          description: The ID of the open order. The _OrderID_ is unique in each OMS.
          x-gitbook-description-html: >-
            <p>The ID of the open order. The <em>OrderID</em> is unique in each
            OMS.</p>
        Price:
          type: number
          format: decimal
          description: The price at which the buy or sell has been ordered.
          x-gitbook-description-html: <p>The price at which the buy or sell has been ordered.</p>
        Quantity:
          type: number
          format: decimal
          description: The quantity of the product to be bought or sold.
          x-gitbook-description-html: <p>The quantity of the product to be bought or sold.</p>
        DisplayQuantity:
          type: number
          format: decimal
          description: >-
            The quantity available to buy or sell that is publicly displayed to
            the market. To display a _displayQuantity_ value, an order must be a
            Limit order with a reserve.
          x-gitbook-description-html: >-
            <p>The quantity available to buy or sell that is publicly displayed
            to the market. To display a <em>displayQuantity</em> value, an order
            must be a Limit order with a reserve.</p>
        Instrument:
          type: integer
          description: >-
            The ID of the instrument being traded. The call
            [**GetInstruments**](#operation/GetInstruments) can supply the
            instrument IDs that are available.
          x-gitbook-description-html: >-
            <p>The ID of the instrument being traded. The call <a
            href="#operation/GetInstruments"><strong>GetInstruments</strong></a>
            can supply the instrument IDs that are available.</p>
        Account:
          type: integer
          description: The ID of the of the account which submitted the order.
          x-gitbook-description-html: <p>The ID of the of the account which submitted the order.</p>
        AccountName:
          type: string
          description: Name of the of the account which submitted the order.
          x-gitbook-description-html: <p>Name of the of the account which submitted the order.</p>
        OrderType:
          type: string
          description: >-
            Will always be **BlockTrade** as this GetOpenTradeReports API will
            only return open blocktrades.
          x-gitbook-description-html: >-
            <p>Will always be <strong>BlockTrade</strong> as this
            GetOpenTradeReports API will only return open blocktrades.</p>
        ClientOrderId:
          type: integer
          format: int64
          default: 0
          description: >-
            An ID supplied by the client to identify the order (like a purchase
            order number). Default is 0.
          x-gitbook-description-html: >-
            <p>An ID supplied by the client to identify the order (like a
            purchase order number). Default is 0.</p>
        OrderState:
          type: string
          enum:
            - Unknown
            - Working
            - Rejected
            - Canceled
            - Expired
            - FullyExecuted
          description: >-
            The state of the order. One of: 0 Unknown, 1 Working, 2 Rejected, 3
            Canceled, 4 Expired, 5 FullyExecuted.
          x-gitbook-description-html: >-
            <p>The state of the order. One of: 0 Unknown, 1 Working, 2 Rejected,
            3 Canceled, 4 Expired, 5 FullyExecuted.</p>
        ReceiveTime:
          type: integer
          format: int64
          description: >-
            Time stamp of the order in POSIX format x 1000 (milliseconds since
            1/1/1970 in UTC time zone).
          x-gitbook-description-html: >-
            <p>Time stamp of the order in POSIX format x 1000 (milliseconds
            since 1/1/1970 in UTC time zone).</p>
        ReceiveTimeTicks:
          type: integer
          format: int64
          description: >-
            Time stamp of the order Microsoft Ticks format and UTC time zone.
            **Note:** Microsoft Ticks format is usually provided as a string.
            Here it is provided as a long integer.
          x-gitbook-description-html: >-
            <p>Time stamp of the order Microsoft Ticks format and UTC time zone.
            <strong>Note:</strong> Microsoft Ticks format is usually provided as
            a string. Here it is provided as a long integer.</p>
        OrigQuantity:
          type: number
          format: decimal
          description: >-
            If the open order has been changed or partially filled, this value
            shows the original quantity of the order.
          x-gitbook-description-html: >-
            <p>If the open order has been changed or partially filled, this
            value shows the original quantity of the order.</p>
        QuantityExecuted:
          type: number
          format: decimal
          description: >-
            If the open order has been at least partially executed, this value
            shows the amount that has been executed.
          x-gitbook-description-html: >-
            <p>If the open order has been at least partially executed, this
            value shows the amount that has been executed.</p>
        GrossValueExecuted:
          type: number
          format: decimal
          description: >-
            If the open order has been at least partially executed, this value
            shows the gross amount that has been executed.
          x-gitbook-description-html: >-
            <p>If the open order has been at least partially executed, this
            value shows the gross amount that has been executed.</p>
        AvgPrice:
          type: number
          format: decimal
          description: The average executed price of the order.
          x-gitbook-description-html: <p>The average executed price of the order.</p>
        CounterPartyId:
          type: integer
          description: >-
            The ID of the account who is the counterparty for the trade if order
            is already executed, either partial or fully executed.
          x-gitbook-description-html: >-
            <p>The ID of the account who is the counterparty for the trade if
            order is already executed, either partial or fully executed.</p>
        ChangeReason:
          type: string
          enum:
            - Unknown
            - NewInputAccepted
            - NewInputRejected
            - OtherRejected
            - Expired
            - Trade
            - SystemCanceled_NoMoreMarket
            - SystemCanceled_BelowMinimum
            - SystemCanceled_PriceCollar
            - SystemCanceled_MarginFailed
            - UserModified
          description: >-
            If the order has been changed, this string value holds the reason.
            One of: 0 Unknown, 1 NewInputAccepted, 2 NewInputRejected, 3
            OtherRejected, 4 Expired, 5 Trade, 6 SystemCanceled_NoMoreMarket, 7
            SystemCanceled_BelowMinimum, 8 SystemCanceled_PriceCollar, 9
            SystemCanceled_MarginFailed, 100 UserModified. An order that is
            newly added to book will have **NewInputAccepted** value by default.
          x-gitbook-description-html: >-
            <p>If the order has been changed, this string value holds the
            reason. One of: 0 Unknown, 1 NewInputAccepted, 2 NewInputRejected, 3
            OtherRejected, 4 Expired, 5 Trade, 6 SystemCanceled_NoMoreMarket, 7
            SystemCanceled_BelowMinimum, 8 SystemCanceled_PriceCollar, 9
            SystemCanceled_MarginFailed, 100 UserModified. An order that is
            newly added to book will have <strong>NewInputAccepted</strong>
            value by default.</p>
        OrigOrderId:
          type: integer
          description: >-
            If the order is a replacement order, this is the ID of the original
            order.
          x-gitbook-description-html: >-
            <p>If the order is a replacement order, this is the ID of the
            original order.</p>
        OrigClOrdId:
          type: integer
          description: >-
            If the order is a replacement order, this is the client order ID or
            the original order.
          x-gitbook-description-html: >-
            <p>If the order is a replacement order, this is the client order ID
            or the original order.</p>
        EnteredBy:
          type: integer
          description: The ID of the user who submitted the order.
          x-gitbook-description-html: <p>The ID of the user who submitted the order.</p>
        Username:
          type: string
          description: >-
            The username of the user who submitted the order. Usually returns as
            an empty string.
          x-gitbook-description-html: >-
            <p>The username of the user who submitted the order. Usually returns
            as an empty string.</p>
        IsQuote:
          type: boolean
          description: >-
            If this order is a quote, the value for _IsQuote_ is _true_,
            otherwise it is _false._.
          x-gitbook-description-html: >-
            <p>If this order is a quote, the value for <em>IsQuote</em> is
            <em>true</em>, otherwise it is <em>false.</em>.</p>
        InsideAsk:
          type: number
          format: decimal
          description: If this order is a quote, this value is the Inside Ask price.
          x-gitbook-description-html: <p>If this order is a quote, this value is the Inside Ask price.</p>
        InsideAskSize:
          type: number
          format: decimal
          description: >-
            If this order is a quote, this value is the quantity of the Inside
            Ask quote.
          x-gitbook-description-html: >-
            <p>If this order is a quote, this value is the quantity of the
            Inside Ask quote.</p>
        InsideBid:
          type: number
          format: decimal
          description: If this order is a quote, this value is the Inside Bid price.
          x-gitbook-description-html: <p>If this order is a quote, this value is the Inside Bid price.</p>
        InsideBidSize:
          type: number
          format: decimal
          description: >-
            If this order is a quote, this value is the quantity of the Inside
            Bid quote.
          x-gitbook-description-html: >-
            <p>If this order is a quote, this value is the quantity of the
            Inside Bid quote.</p>
        LastTradePrice:
          type: number
          format: decimal
          description: The last price that this instrument traded at.
          x-gitbook-description-html: <p>The last price that this instrument traded at.</p>
        RejectReason:
          type: string
          description: >-
            If this open order has been rejected, this string holds the reason
            for the rejection.
          x-gitbook-description-html: >-
            <p>If this open order has been rejected, this string holds the
            reason for the rejection.</p>
        IsLockedIn:
          type: boolean
          description: >-
            For a block trade, if both parties to the block trade agree that one
            of the parties will report the trade for both sides, this value is
            _true._ Othersise, _false._.
          x-gitbook-description-html: >-
            <p>For a block trade, if both parties to the block trade agree that
            one of the parties will report the trade for both sides, this value
            is <em>true.</em> Othersise, <em>false.</em>.</p>
        CancelReason:
          type: string
          description: >-
            If this order has been canceled, this string holds the cancellation
            reason.
          x-gitbook-description-html: >-
            <p>If this order has been canceled, this string holds the
            cancellation reason.</p>
        OrderFlag:
          type: string
          description: >-
            One or more of: **NoAccountRiskCheck**, **AddedToBook**,
            **RemovedFromBook**, **PostOnly**, **Liquidation**,
            **ReverseMarginPosition**, **Synthetic**.
          x-gitbook-description-html: >-
            <p>One or more of: <strong>NoAccountRiskCheck</strong>,
            <strong>AddedToBook</strong>, <strong>RemovedFromBook</strong>,
            <strong>PostOnly</strong>, <strong>Liquidation</strong>,
            <strong>ReverseMarginPosition</strong>,
            <strong>Synthetic</strong>.</p>
        UseMargin:
          type: boolean
          default: false
          description: Margin is not yet supported so this always defaults to false.
          x-gitbook-description-html: <p>Margin is not yet supported so this always defaults to false.</p>
        StopPrice:
          type: number
          format: decimal
          description: >-
            The price at which the order executes, if the order is a stop order.
            Defaults to 0 if order is another type.
          x-gitbook-description-html: >-
            <p>The price at which the order executes, if the order is a stop
            order. Defaults to 0 if order is another type.</p>
        PegPriceType:
          type: string
          description: The type of price to peg the Stop to for Stop/Trailing orders.
          x-gitbook-description-html: >-
            <p>The type of price to peg the Stop to for Stop/Trailing
            orders.</p>
        PegOffset:
          type: number
          format: decimal
          description: >-
            Only applicable to trailing/stop orders. Defaults to 0 if order is
            another type.
          x-gitbook-description-html: >-
            <p>Only applicable to trailing/stop orders. Defaults to 0 if order
            is another type.</p>
        PegLimitOffset:
          type: number
          format: decimal
          description: >-
            Only applicable to trailing/stop orders. Defaults to 0 if order is
            another type.
          x-gitbook-description-html: >-
            <p>Only applicable to trailing/stop orders. Defaults to 0 if order
            is another type.</p>
        IpAddress:
          type: string
          description: The IP address from where the order was submitted.
          x-gitbook-description-html: <p>The IP address from where the order was submitted.</p>
        OMSId:
          type: integer
          description: The ID of the OMS.
          x-gitbook-description-html: <p>The ID of the OMS.</p>
      required:
        - Side
        - OrderId
        - Price
        - Quantity
        - DisplayQuantity
        - Instrument
        - Account
        - AccountName
        - OrderType
        - ClientOrderId
        - OrderState
        - ReceiveTime
        - ReceiveTimeTicks
        - OrigQuantity
        - QuantityExecuted
        - GrossValueExecuted
        - AvgPrice
        - CounterPartyId
        - ChangeReason
        - OrigOrderId
        - OrigClOrdId
        - EnteredBy
        - Username
        - IsQuote
        - InsideAsk
        - InsideAskSize
        - InsideBid
        - InsideBidSize
        - LastTradePrice
        - RejectReason
        - IsLockedIn
        - CancelReason
        - OrderFlag
        - UseMargin
        - StopPrice
        - PegPriceType
        - PegOffset
        - PegLimitOffset
        - IpAddress
        - OMSId
    GetOrdersHistoryRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS on which the orders took place.
          x-gitbook-description-html: <p>The ID of the OMS on which the orders took place.</p>
        AccountId:
          type: integer
          description: >-
            The account ID that made the trades. A user with NotbankTrading
            permission must be associated with this account, although other
            users also can be associated with the account. Not explicitly
            required if the authenticated user has elevated permission/s.
          x-gitbook-description-html: >-
            <p>The account ID that made the trades. A user with NotbankTrading
            permission must be associated with this account, although other
            users also can be associated with the account. Not explicitly
            required if the authenticated user has elevated permission/s.</p>
        OrderState:
          type: string
          enum:
            - Unknown
            - Working
            - Rejected
            - Canceled
            - Expired
            - FullyExecuted
          description: >-
            The current state of the order. Can be used to filter results. If
            not specified all orders regardless of the order state will be
            returned. One of: 0 Unknown, 1 Working, 2 Rejected, 3 Canceled, 4
            Expired, 5 FullyExecuted.
          x-gitbook-description-html: >-
            <p>The current state of the order. Can be used to filter results. If
            not specified all orders regardless of the order state will be
            returned. One of: 0 Unknown, 1 Working, 2 Rejected, 3 Canceled, 4
            Expired, 5 FullyExecuted.</p>
        OrderId:
          type: integer
          format: int64
          description: >-
            The ID of the order. Can be used to filter results. Can be used to
            filter for a specific orderid. There is a specific API call
            **GetOrderHistoryByOrderId** for filtering orders by **OrderId**.
          x-gitbook-description-html: >-
            <p>The ID of the order. Can be used to filter results. Can be used
            to filter for a specific orderid. There is a specific API call
            <strong>GetOrderHistoryByOrderId</strong> for filtering orders by
            <strong>OrderId</strong>.</p>
        ClientOrderId:
          type: integer
          format: int64
          default: 0
          description: >-
            A user-assigned ID for the order (like a purchase-order number
            assigned by a company). Can be used to filter results. Default is 0.
          x-gitbook-description-html: >-
            <p>A user-assigned ID for the order (like a purchase-order number
            assigned by a company). Can be used to filter results. Default is
            0.</p>
        OriginalOrderId:
          type: integer
          format: int64
          description: >-
            The original ID of the order. If specified, the call returns changed
            orders associated with this order ID. Can be used to filter results.
          x-gitbook-description-html: >-
            <p>The original ID of the order. If specified, the call returns
            changed orders associated with this order ID. Can be used to filter
            results.</p>
        OriginalClientOrderId:
          type: integer
          format: int64
          description: >-
            If the order has been changed, shows the original client order ID, a
            value that the client can create (much like a purchase order). Can
            be used to filter results.
          x-gitbook-description-html: >-
            <p>If the order has been changed, shows the original client order
            ID, a value that the client can create (much like a purchase order).
            Can be used to filter results.</p>
        UserId:
          type: integer
          description: >-
            The ID of the user whose account orders will be returned. If not
            specified, the call returns the orders of the logged-in user. Can be
            used to filter results.
          x-gitbook-description-html: >-
            <p>The ID of the user whose account orders will be returned. If not
            specified, the call returns the orders of the logged-in user. Can be
            used to filter results.</p>
        InstrumentId:
          type: integer
          format: int64
          description: >-
            The ID of the instrument named in the order. If not specified, the
            call returns orders for all instruments traded by this account. Can
            be used to filter results.
          x-gitbook-description-html: >-
            <p>The ID of the instrument named in the order. If not specified,
            the call returns orders for all instruments traded by this account.
            Can be used to filter results.</p>
        StartTimestamp:
          type: integer
          format: int64
          description: >-
            Date and time at which to begin the orders history, in POSIX format.
            Can be used to filter results.
          x-gitbook-description-html: >-
            <p>Date and time at which to begin the orders history, in POSIX
            format. Can be used to filter results.</p>
        EndTimestamp:
          type: integer
          format: int64
          description: >-
            Date and time at which to end the orders report, in POSIX format.
            Can be used to filter results.
          x-gitbook-description-html: >-
            <p>Date and time at which to end the orders report, in POSIX format.
            Can be used to filter results.</p>
        Depth:
          type: integer
          description: >-
            In this case, the maximum number/count of unique orders to return,
            counting from the _StartIndex_ if it is also specified. If not
            specified, returns the 100 most recent to orders; results can vary
            depending if other optional fields are defined such as _StartIndex_,
            _StartTimestamp_, and _EndTimestamp_. Can be used to filter results
            and for pagination.
          x-gitbook-description-html: >-
            <p>In this case, the maximum number/count of unique orders to
            return, counting from the <em>StartIndex</em> if it is also
            specified. If not specified, returns the 100 most recent to orders;
            results can vary depending if other optional fields are defined such
            as <em>StartIndex</em>, <em>StartTimestamp</em>, and
            <em>EndTimestamp</em>. Can be used to filter results and for
            pagination.</p>
        Limit:
          type: integer
          description: Functions exactly the same as the **Depth** field.
          x-gitbook-description-html: >-
            <p>Functions exactly the same as the <strong>Depth</strong>
            field.</p>
        StartIndex:
          type: integer
          default: 0
          description: >-
            A value of 0 means the first object in the result will be the the
            most recent order, a value of 2 means that the first object in the
            result set will be the third most recent order. Can be used to
            filter results or for pagination. Default is 0.
          x-gitbook-description-html: >-
            <p>A value of 0 means the first object in the result will be the the
            most recent order, a value of 2 means that the first object in the
            result set will be the third most recent order. Can be used to
            filter results or for pagination. Default is 0.</p>
      required:
        - OMSId
        - AccountId
    GetOrdersHistoryResponse:
      type: array
      items:
        type: object
        properties:
          Side:
            type: string
            enum:
              - Buy
              - Sell
            description: 'The side of a trade. One of: **0** Buy, **1** Sell.'
            x-gitbook-description-html: >-
              <p>The side of a trade. One of: <strong>0</strong> Buy,
              <strong>1</strong> Sell.</p>
          OrderId:
            type: integer
            format: int64
            description: The ID of the open order. The _OrderID_ is unique in each OMS.
            x-gitbook-description-html: >-
              <p>The ID of the open order. The <em>OrderID</em> is unique in
              each OMS.</p>
          Price:
            type: number
            format: decimal
            description: The price at which the buy or sell has been ordered.
            x-gitbook-description-html: <p>The price at which the buy or sell has been ordered.</p>
          Quantity:
            type: number
            format: decimal
            description: The quantity of the product to be bought or sold.
            x-gitbook-description-html: <p>The quantity of the product to be bought or sold.</p>
          DisplayQuantity:
            type: number
            format: decimal
            description: >-
              The quantity available to buy or sell that is publicly displayed
              to the market. To display a _displayQuantity_ value, an order must
              be a Limit order with a reserve.
            x-gitbook-description-html: >-
              <p>The quantity available to buy or sell that is publicly
              displayed to the market. To display a <em>displayQuantity</em>
              value, an order must be a Limit order with a reserve.</p>
          Instrument:
            type: integer
            description: >-
              The ID of the instrument being traded. The API method
              [**GetInstruments**](#operation/GetInstruments) can supply the
              instrument IDs that are available.
            x-gitbook-description-html: >-
              <p>The ID of the instrument being traded. The API method <a
              href="#operation/GetInstruments"><strong>GetInstruments</strong></a>
              can supply the instrument IDs that are available.</p>
          Account:
            type: integer
            description: The ID of the of the account which the order belongs to.
            x-gitbook-description-html: <p>The ID of the of the account which the order belongs to.</p>
          AccountName:
            type: string
            description: Name of the of the account which which the order belongs to.
            x-gitbook-description-html: >-
              <p>Name of the of the account which which the order belongs
              to.</p>
          OrderType:
            type: string
            enum:
              - Unknown an error condition
              - Market order
              - Limit
              - StopMarket
              - StopLimit
              - TrailingStopMarket
              - TrailingStopLimit
              - BlockTrade
            description: >-
              Describes the type of order this is. One of: 0 Unknown (an error
              condition), 1 Market order, 2 Limit, 3 StopMarket, 4 StopLimit, 5
              TrailingStopMarket, 6 TrailingStopLimit, 7 BlockTrade.
            x-gitbook-description-html: >-
              <p>Describes the type of order this is. One of: 0 Unknown (an
              error condition), 1 Market order, 2 Limit, 3 StopMarket, 4
              StopLimit, 5 TrailingStopMarket, 6 TrailingStopLimit, 7
              BlockTrade.</p>
          ClientOrderId:
            type: integer
            format: int64
            default: 0
            description: >-
              An ID supplied by the client to identify the order (like a
              purchase order number). Default is 0.
            x-gitbook-description-html: >-
              <p>An ID supplied by the client to identify the order (like a
              purchase order number). Default is 0.</p>
          OrderState:
            type: string
            enum:
              - Unknown
              - Working
              - Rejected
              - Canceled
              - Expired
              - Fully Executed
            description: >-
              The current or the latest state of the order. One of: 0 Unknown, 1
              Working, 2 Rejected, 3 Canceled, 4 Expired, 5 Fully Executed.
            x-gitbook-description-html: >-
              <p>The current or the latest state of the order. One of: 0
              Unknown, 1 Working, 2 Rejected, 3 Canceled, 4 Expired, 5 Fully
              Executed.</p>
          ReceiveTime:
            type: integer
            format: int64
            description: >-
              Time stamp of the order in POSIX format x 1000 (milliseconds since
              1/1/1970 in UTC time zone).
            x-gitbook-description-html: >-
              <p>Time stamp of the order in POSIX format x 1000 (milliseconds
              since 1/1/1970 in UTC time zone).</p>
          ReceiveTimeTicks:
            type: integer
            format: int64
            description: >-
              Time stamp of the order Microsoft Ticks format and UTC time zone.
              **Note:** Microsoft Ticks format is usually provided as a string.
              Here it is provided as a long integer.
            x-gitbook-description-html: >-
              <p>Time stamp of the order Microsoft Ticks format and UTC time
              zone. <strong>Note:</strong> Microsoft Ticks format is usually
              provided as a string. Here it is provided as a long integer.</p>
          LastUpdatedTime:
            type: integer
            format: int64
            description: >-
              Time stamp when the order was last updated, in POSIX format x 1000
              (milliseconds since 1/1/1970 in UTC time zone).
            x-gitbook-description-html: >-
              <p>Time stamp when the order was last updated, in POSIX format x
              1000 (milliseconds since 1/1/1970 in UTC time zone).</p>
          LastUpdatedTimeTicks:
            type: integer
            format: int64
            description: >-
              Time stamp when the order was last updated, in Microsoft Ticks
              format and UTC time zone. **Note:** Microsoft Ticks format is
              usually provided as a string. Here it is provided as a long
              integer.
            x-gitbook-description-html: >-
              <p>Time stamp when the order was last updated, in Microsoft Ticks
              format and UTC time zone. <strong>Note:</strong> Microsoft Ticks
              format is usually provided as a string. Here it is provided as a
              long integer.</p>
          OrigQuantity:
            type: number
            format: decimal
            description: >-
              If the open order has been changed or partially filled, this value
              shows the original quantity of the order.
            x-gitbook-description-html: >-
              <p>If the open order has been changed or partially filled, this
              value shows the original quantity of the order.</p>
          QuantityExecuted:
            type: number
            format: decimal
            description: >-
              If the open order has been at least partially executed, this value
              shows the amount that has been executed.
            x-gitbook-description-html: >-
              <p>If the open order has been at least partially executed, this
              value shows the amount that has been executed.</p>
          GrossValueExecuted:
            type: number
            format: decimal
            description: >-
              If the open order has been at least partially executed, this value
              shows the gross amount that has been executed.
            x-gitbook-description-html: >-
              <p>If the open order has been at least partially executed, this
              value shows the gross amount that has been executed.</p>
          ExecutableValue:
            type: number
            format: decimal
            description: Defaults to 0. For future provision.
            x-gitbook-description-html: <p>Defaults to 0. For future provision.</p>
          AvgPrice:
            type: number
            format: decimal
            description: The average executed price of the order.
            x-gitbook-description-html: <p>The average executed price of the order.</p>
          CounterPartyId:
            type: integer
            description: >-
              The ID of the account who is the counterparty for the trade if
              order is already executed, either partial or fully executed.
            x-gitbook-description-html: >-
              <p>The ID of the account who is the counterparty for the trade if
              order is already executed, either partial or fully executed.</p>
          ChangeReason:
            type: string
            enum:
              - Unknown
              - NewInputAccepted
              - NewInputRejected
              - OtherRejected
              - Expired
              - Trade
              - SystemCanceled_NoMoreMarket
              - SystemCanceled_BelowMinimum
              - SystemCanceled_PriceCollar
              - SystemCanceled_MarginFailed
              - UserModified
            description: >-
              If the order has been changed, this string value holds the reason.
              One of: 0 Unknown, 1 NewInputAccepted, 2 NewInputRejected, 3
              OtherRejected, 4 Expired, 5 Trade, 6 SystemCanceled_NoMoreMarket,
              7 SystemCanceled_BelowMinimum, 8 SystemCanceled_PriceCollar, 9
              SystemCanceled_MarginFailed, 100 UserModified. An order that is
              newly added to book will have **NewInputAccepted** value by
              default.
            x-gitbook-description-html: >-
              <p>If the order has been changed, this string value holds the
              reason. One of: 0 Unknown, 1 NewInputAccepted, 2 NewInputRejected,
              3 OtherRejected, 4 Expired, 5 Trade, 6
              SystemCanceled_NoMoreMarket, 7 SystemCanceled_BelowMinimum, 8
              SystemCanceled_PriceCollar, 9 SystemCanceled_MarginFailed, 100
              UserModified. An order that is newly added to book will have
              <strong>NewInputAccepted</strong> value by default.</p>
          OrigOrderId:
            type: integer
            format: int64
            description: >-
              If the order is a replacement order, this is the ID of the
              original order.
            x-gitbook-description-html: >-
              <p>If the order is a replacement order, this is the ID of the
              original order.</p>
          OrigClOrdId:
            type: integer
            format: int64
            description: >-
              If the order is a replacement order, this is the client order ID
              or the original order.
            x-gitbook-description-html: >-
              <p>If the order is a replacement order, this is the client order
              ID or the original order.</p>
          EnteredBy:
            type: integer
            description: The ID of the user who submitted the order.
            x-gitbook-description-html: <p>The ID of the user who submitted the order.</p>
          Username:
            type: string
            description: The username of the user who submitted the order.
            x-gitbook-description-html: <p>The username of the user who submitted the order.</p>
          IsQuote:
            type: boolean
            description: >-
              If this order is a quote, the value for _IsQuote_ is _true_,
              otherwise it is _false._.
            x-gitbook-description-html: >-
              <p>If this order is a quote, the value for <em>IsQuote</em> is
              <em>true</em>, otherwise it is <em>false.</em>.</p>
          InsideAsk:
            type: number
            format: decimal
            description: If this order is a quote, this value is the Inside Ask price.
            x-gitbook-description-html: >-
              <p>If this order is a quote, this value is the Inside Ask
              price.</p>
          InsideAskSize:
            type: number
            format: decimal
            description: >-
              If this order is a quote, this value is the quantity of the Inside
              Ask quote.
            x-gitbook-description-html: >-
              <p>If this order is a quote, this value is the quantity of the
              Inside Ask quote.</p>
          InsideBid:
            type: number
            format: decimal
            description: If this order is a quote, this value is the Inside Bid price.
            x-gitbook-description-html: >-
              <p>If this order is a quote, this value is the Inside Bid
              price.</p>
          InsideBidSize:
            type: number
            format: decimal
            description: >-
              If this order is a quote, this value is the quantity of the Inside
              Bid quote.
            x-gitbook-description-html: >-
              <p>If this order is a quote, this value is the quantity of the
              Inside Bid quote.</p>
          LastTradePrice:
            type: number
            format: decimal
            description: The last price that this instrument traded at.
            x-gitbook-description-html: <p>The last price that this instrument traded at.</p>
          RejectReason:
            type: string
            description: >-
              If this open order has been rejected, this string holds the reason
              for the rejection.
            x-gitbook-description-html: >-
              <p>If this open order has been rejected, this string holds the
              reason for the rejection.</p>
          IsLockedIn:
            type: boolean
            description: >-
              For a block trade, if both parties to the block trade agree that
              one of the parties will report the trade for both sides, this
              value is _true._ Othersise, _false._.
            x-gitbook-description-html: >-
              <p>For a block trade, if both parties to the block trade agree
              that one of the parties will report the trade for both sides, this
              value is <em>true.</em> Othersise, <em>false.</em>.</p>
          CancelReason:
            type: string
            description: >-
              If this order has been canceled, this string holds the
              cancellation reason.
            x-gitbook-description-html: >-
              <p>If this order has been canceled, this string holds the
              cancellation reason.</p>
          OrderFlag:
            oneOf:
              - type: integer
              - type: string
            description: >-
              One or more of:. 1 NoAccountRiskCheck. 2 AddedToBook. 4
              RemovedFromBook. 8 PostOnly. 16 Liquidation. 32
              ReverseMarginPosition.
            x-gitbook-description-html: >-
              <p>One or more of:. 1 NoAccountRiskCheck. 2 AddedToBook. 4
              RemovedFromBook. 8 PostOnly. 16 Liquidation. 32
              ReverseMarginPosition.</p>
          UseMargin:
            type: boolean
            default: false
            description: Margin is not yet supported so this always defaults to false.
            x-gitbook-description-html: >-
              <p>Margin is not yet supported so this always defaults to
              false.</p>
          StopPrice:
            type: number
            format: decimal
            description: >-
              The price at which the order executes, if the order is a stop
              order. Defaults to 0 if order is another type.
            x-gitbook-description-html: >-
              <p>The price at which the order executes, if the order is a stop
              order. Defaults to 0 if order is another type.</p>
          PegPriceType:
            type: string
            description: The type of price to peg the Stop to for Stop/Trailing orders.
            x-gitbook-description-html: >-
              <p>The type of price to peg the Stop to for Stop/Trailing
              orders.</p>
          PegOffset:
            type: number
            format: decimal
            description: >-
              Only applicable to trailing/stop orders. Defaults to 0 if order is
              another type.
            x-gitbook-description-html: >-
              <p>Only applicable to trailing/stop orders. Defaults to 0 if order
              is another type.</p>
          PegLimitOffset:
            type: number
            format: decimal
            description: >-
              Only applicable to trailing/stop orders. Defaults to 0 if order is
              another type.
            x-gitbook-description-html: >-
              <p>Only applicable to trailing/stop orders. Defaults to 0 if order
              is another type.</p>
          IpAddress:
            type: string
            description: The IP address from where the order was submitted.
            x-gitbook-description-html: <p>The IP address from where the order was submitted.</p>
          IPv6a:
            type: string
            description: >-
              **UInt64**. The IPv6 where the order was submitted from. Currently
              not being used, for future provision. Defaults to 0.
            x-gitbook-description-html: >-
              <p><strong>UInt64</strong>. The IPv6 where the order was submitted
              from. Currently not being used, for future provision. Defaults to
              0.</p>
          OMSId:
            type: integer
            description: The ID of the OMS.
            x-gitbook-description-html: <p>The ID of the OMS.</p>
        required:
          - Side
          - OrderId
          - Price
          - Quantity
          - DisplayQuantity
          - Instrument
          - Account
          - AccountName
          - OrderType
          - ClientOrderId
          - OrderState
          - ReceiveTime
          - ReceiveTimeTicks
          - LastUpdatedTime
          - LastUpdatedTimeTicks
          - OrigQuantity
          - QuantityExecuted
          - GrossValueExecuted
          - ExecutableValue
          - AvgPrice
          - CounterPartyId
          - ChangeReason
          - OrigOrderId
          - OrigClOrdId
          - EnteredBy
          - Username
          - IsQuote
          - InsideAsk
          - InsideAskSize
          - InsideBid
          - InsideBidSize
          - LastTradePrice
          - RejectReason
          - IsLockedIn
          - CancelReason
          - OrderFlag
          - UseMargin
          - StopPrice
          - PegPriceType
          - PegOffset
          - PegLimitOffset
          - IpAddress
          - IPv6a
          - IPv6a
          - OMSId
    GetTradesHistoryRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS on which the trades took place.
          x-gitbook-description-html: <p>The ID of the OMS on which the trades took place.</p>
        AccountId:
          type: integer
          description: >-
            The account ID that made the trades. If no account ID is supplied,
            the system assumes the default account for the logged-in user making
            the call.
          x-gitbook-description-html: >-
            <p>The account ID that made the trades. If no account ID is
            supplied, the system assumes the default account for the logged-in
            user making the call.</p>
        InstrumentId:
          type: integer
          default: 0
          description: >-
            The ID of the instrument whose trade history is reported. If not
            specified, defaults to 0 which means results won't be filtered
            according to it.
          x-gitbook-description-html: >-
            <p>The ID of the instrument whose trade history is reported. If not
            specified, defaults to 0 which means results won't be filtered
            according to it.</p>
        TradeId:
          type: integer
          format: int64
          description: The ID of a specific trade.
          x-gitbook-description-html: <p>The ID of a specific trade.</p>
        OrderId:
          type: integer
          format: int64
          default: 0
          description: >-
            The ID of the order resulting in the trade. If specified, the call
            returns all trades associated with the order. If not specified,
            defaults to 0 which means results won't be filtered according to it.
          x-gitbook-description-html: >-
            <p>The ID of the order resulting in the trade. If specified, the
            call returns all trades associated with the order. If not specified,
            defaults to 0 which means results won't be filtered according to
            it.</p>
        UserId:
          type: integer
          description: >-
            If not specified, the call returns trades associated with the users
            belonging to the default account for the logged-in user.
          x-gitbook-description-html: >-
            <p>If not specified, the call returns trades associated with the
            users belonging to the default account for the logged-in user.</p>
        StartTimeStamp:
          type: integer
          format: int64
          default: 0
          description: >-
            The historical date and time at which to begin the trade report, in
            POSIX format. If not specified, defaults to 0 which means results
            won't be filtered according to it. Value must be in **milliseconds**
            if to be used.
          x-gitbook-description-html: >-
            <p>The historical date and time at which to begin the trade report,
            in POSIX format. If not specified, defaults to 0 which means results
            won't be filtered according to it. Value must be in
            <strong>milliseconds</strong> if to be used.</p>
        EndTimeStamp:
          type: integer
          format: int64
          default: 0
          description: >-
            Date and time at which to end the trade report, in POSIX format. If
            not specified, defaults to 0 which means results won't be filtered
            according to it. Value must be in **milliseconds** if to be used.
          x-gitbook-description-html: >-
            <p>Date and time at which to end the trade report, in POSIX format.
            If not specified, defaults to 0 which means results won't be
            filtered according to it. Value must be in
            <strong>milliseconds</strong> if to be used.</p>
        Depth:
          type: integer
          description: >-
            In this case, the count of trades to return, counting from the
            _StartIndex_. If _Depth_ is not specified, returns all trades
            between _BeginTimeStamp_ and _EndTimeStamp_, beginning at
            _StartIndex_. If no other filter parameter is defined, the maximum
            will result set will be according to the **MaxApiResponseResultSet**
            Gateway config value.
          x-gitbook-description-html: >-
            <p>In this case, the count of trades to return, counting from the
            <em>StartIndex</em>. If <em>Depth</em> is not specified, returns all
            trades between <em>BeginTimeStamp</em> and <em>EndTimeStamp</em>,
            beginning at <em>StartIndex</em>. If no other filter parameter is
            defined, the maximum will result set will be according to the
            <strong>MaxApiResponseResultSet</strong> Gateway config value.</p>
        StartIndex:
          type: integer
          default: 0
          description: >-
            The starting index into the history of trades, from 0 (the most
            recent trade) and moving backwards in time. If not specified,
            defaults to 0 which means results won't be filtered according to it.
          x-gitbook-description-html: >-
            <p>The starting index into the history of trades, from 0 (the most
            recent trade) and moving backwards in time. If not specified,
            defaults to 0 which means results won't be filtered according to
            it.</p>
        ExecutionId:
          type: integer
          default: 0
          description: >-
            The ID of the individual buy or sell execution. If not specified,
            defaults to 0 which means results won't be filtered according to it.
          x-gitbook-description-html: >-
            <p>The ID of the individual buy or sell execution. If not specified,
            defaults to 0 which means results won't be filtered according to
            it.</p>
      required:
        - OMSId
    GetTradesHistoryResponse:
      type: array
      items:
        type: object
        properties:
          OMSId:
            type: integer
            description: The ID of the OMS on which the account resides.
            x-gitbook-description-html: <p>The ID of the OMS on which the account resides.</p>
          ExecutionId:
            type: integer
            description: >-
              The ID of this account's side of the trade. Every trade has two
              sides.
            x-gitbook-description-html: >-
              <p>The ID of this account's side of the trade. Every trade has two
              sides.</p>
          TradeId:
            type: integer
            format: int64
            description: The ID of the overall trade.
            x-gitbook-description-html: <p>The ID of the overall trade.</p>
          OrderId:
            type: integer
            format: int64
            description: The ID of the order causing the trade (buy or sell).
            x-gitbook-description-html: <p>The ID of the order causing the trade (buy or sell).</p>
          AccountId:
            type: integer
            description: The ID of the account that made the trade (buy or sell).
            x-gitbook-description-html: <p>The ID of the account that made the trade (buy or sell).</p>
          AccountName:
            type: string
            description: The Name of the account that made the trade (buy or sell).
            x-gitbook-description-html: <p>The Name of the account that made the trade (buy or sell).</p>
          SubAccountId:
            type: integer
            description: Not currently used; reserved for future use. Defaults to 0.
            x-gitbook-description-html: <p>Not currently used; reserved for future use. Defaults to 0.</p>
          ClientOrderId:
            type: integer
            format: int64
            default: 0
            description: >-
              An ID supplied by the client to identify the order (like a
              purchase order number). Default is 0.
            x-gitbook-description-html: >-
              <p>An ID supplied by the client to identify the order (like a
              purchase order number). Default is 0.</p>
          InstrumentId:
            type: integer
            description: >-
              The ID of the instrument being traded. An instrument comprises two
              products, for example Dollars and Bitcoin.
            x-gitbook-description-html: >-
              <p>The ID of the instrument being traded. An instrument comprises
              two products, for example Dollars and Bitcoin.</p>
          Side:
            type: string
            enum:
              - Buy
              - Sell
            description: 'One of: **0** Buy, **1** Sell.'
            x-gitbook-description-html: '<p>One of: <strong>0</strong> Buy, <strong>1</strong> Sell.</p>'
          OrderType:
            type: string
            enum:
              - Market
              - Limit
              - BlockTrade
              - StopMarket
              - StopLimit
              - TrailingStopLimit
              - StopMarket
              - TrailingStopMarket
            description: >-
              One of: Market, Limit, BlockTrade, StopMarket, StopLimit,
              TrailingStopLimit, StopMarket, TrailingStopMarket.
            x-gitbook-description-html: >-
              <p>One of: Market, Limit, BlockTrade, StopMarket, StopLimit,
              TrailingStopLimit, StopMarket, TrailingStopMarket.</p>
          Quantity:
            type: number
            format: decimal
            description: The unit quantity of this side of the trade.
            x-gitbook-description-html: <p>The unit quantity of this side of the trade.</p>
          RemainingQuantity:
            type: number
            format: decimal
            description: >-
              The number of units remaining to be traded by the order after this
              execution. This number is not revealed to the other party in the
              trade. This value is also known as "leave size" or "leave
              quantity.".
            x-gitbook-description-html: >-
              <p>The number of units remaining to be traded by the order after
              this execution. This number is not revealed to the other party in
              the trade. This value is also known as "leave size" or "leave
              quantity.".</p>
          Price:
            type: number
            format: decimal
            description: The unit price at which the instrument traded.
            x-gitbook-description-html: <p>The unit price at which the instrument traded.</p>
          Value:
            type: number
            format: decimal
            description: >-
              The total value of the deal. The system calculates this as:. unit
              price X quantity executed.
            x-gitbook-description-html: >-
              <p>The total value of the deal. The system calculates this as:.
              unit price X quantity executed.</p>
          CounterParty:
            type: string
            description: >-
              The ID of the other party in a block trade. Usually, IDs are
              stated as integers; this value is an integer written as a string.
            x-gitbook-description-html: >-
              <p>The ID of the other party in a block trade. Usually, IDs are
              stated as integers; this value is an integer written as a
              string.</p>
          OrderTradeRevision:
            type: integer
            description: The revision number of this trade; usually 1.
            x-gitbook-description-html: <p>The revision number of this trade; usually 1.</p>
          Direction:
            type: integer
            enum:
              - 0
              - 1
              - 2
            description: >-
              The effect of the trade on the instrument's market price. One of:
              **0** No change, **1** Uptick, **2** DownTick.
            x-gitbook-description-html: >-
              <p>The effect of the trade on the instrument's market price. One
              of: <strong>0</strong> No change, <strong>1</strong> Uptick,
              <strong>2</strong> DownTick.</p>
          IsBlockTrade:
            type: boolean
            description: >-
              A value of _true_ means that this trade was a block trade; a value
              of _false_ that it was not a block trade.
            x-gitbook-description-html: >-
              <p>A value of <em>true</em> means that this trade was a block
              trade; a value of <em>false</em> that it was not a block
              trade.</p>
          Fee:
            type: number
            format: decimal
            description: Any fee levied against the trade by the Exchange.
            x-gitbook-description-html: <p>Any fee levied against the trade by the Exchange.</p>
          FeeProductId:
            type: integer
            description: The ID of the product in which the fee was levied.
            x-gitbook-description-html: <p>The ID of the product in which the fee was levied.</p>
          OrderOriginator:
            type: integer
            description: The ID of the user who initiated the trade.
            x-gitbook-description-html: <p>The ID of the user who initiated the trade.</p>
          UserName:
            type: string
            description: The UserName of the user who initiated the trade.
            x-gitbook-description-html: <p>The UserName of the user who initiated the trade.</p>
          TradeTimeMS:
            type: integer
            format: int64
            description: >-
              The date and time that the trade took place, in milliseconds and
              POSIX format. All dates and times are UTC.
            x-gitbook-description-html: >-
              <p>The date and time that the trade took place, in milliseconds
              and POSIX format. All dates and times are UTC.</p>
          MakerTaker:
            type: string
            enum:
              - Maker
              - Taker
            description: 'One of: Maker, Taker.'
            x-gitbook-description-html: '<p>One of: Maker, Taker.</p>'
          AdapterTradeId:
            type: integer
            description: The ID of the adapter of the overall trade.
            x-gitbook-description-html: <p>The ID of the adapter of the overall trade.</p>
          InsideBid:
            type: number
            format: decimal
            description: >-
              The best (highest) price level of the buy side of the book at the
              time of the trade.
            x-gitbook-description-html: >-
              <p>The best (highest) price level of the buy side of the book at
              the time of the trade.</p>
          InsideBidSize:
            type: number
            format: decimal
            description: >-
              The quantity of the best (highest) price level of the buy side of
              the book at the time of the trade.
            x-gitbook-description-html: >-
              <p>The quantity of the best (highest) price level of the buy side
              of the book at the time of the trade.</p>
          InsideAsk:
            type: number
            format: decimal
            description: >-
              The best (lowest) price level of the sell side of the book at the
              time of the trade.
            x-gitbook-description-html: >-
              <p>The best (lowest) price level of the sell side of the book at
              the time of the trade.</p>
          InsideAskSize:
            type: number
            format: decimal
            description: >-
              The quantity of the best (lowest) price level of the sell side of
              the book at the time of the trade.
            x-gitbook-description-html: >-
              <p>The quantity of the best (lowest) price level of the sell side
              of the book at the time of the trade.</p>
          CounterPartyClientUserId:
            type: integer
            description: Indicates counterparty source of trade (OMS, Remarketer, FIX).
            x-gitbook-description-html: >-
              <p>Indicates counterparty source of trade (OMS, Remarketer,
              FIX).</p>
          NotionalProductId:
            type: integer
            description: The id of the notional product the notional value was captured in.
            x-gitbook-description-html: >-
              <p>The id of the notional product the notional value was captured
              in.</p>
          NotionalRate:
            type: number
            format: decimal
            description: Notional rate from base currency at time of trade.
            x-gitbook-description-html: <p>Notional rate from base currency at time of trade.</p>
          NotionalValue:
            type: number
            format: decimal
            description: Notional value in base currency of venue at time of trade.
            x-gitbook-description-html: <p>Notional value in base currency of venue at time of trade.</p>
          TradeTime:
            type: integer
            format: int64
            description: >-
              The date and time that the trade took place, in C# Ticks. All
              dates and times are UTC.
            x-gitbook-description-html: >-
              <p>The date and time that the trade took place, in C# Ticks. All
              dates and times are UTC.</p>
        required:
          - OMSId
          - ExecutionId
          - TradeId
          - OrderId
          - AccountId
          - AccountName
          - SubAccountId
          - ClientOrderId
          - InstrumentId
          - Side
          - OrderType
          - Quantity
          - RemainingQuantity
          - Price
          - Value
          - CounterParty
          - OrderTradeRevision
          - Direction
          - IsBlockTrade
          - Fee
          - FeeProductId
          - OrderOriginator
          - UserName
          - TradeTimeMS
          - MakerTaker
          - AdapterTradeId
          - InsideBid
          - InsideBidSize
          - InsideAsk
          - InsideAskSize
          - CounterPartyClientUserId
          - NotionalProductId
          - NotionalRate
          - NotionalValue
          - TradeTime
    GetOrderHistoryByOrderIdRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS.
          x-gitbook-description-html: <p>The ID of the OMS.</p>
        OrderId:
          type: integer
          format: int64
          description: >-
            The ID of the of the order which you want to get details and history
            of.
          x-gitbook-description-html: >-
            <p>The ID of the of the order which you want to get details and
            history of.</p>
      required:
        - OMSId
        - OrderId
    GetOrderHistoryByOrderIdResponse:
      type: array
      items:
        type: object
        properties:
          Side:
            type: string
            enum:
              - Buy
              - Sell
            description: 'The side of a trade. One of: **0** Buy, **1** Sell.'
            x-gitbook-description-html: >-
              <p>The side of a trade. One of: <strong>0</strong> Buy,
              <strong>1</strong> Sell.</p>
          OrderId:
            type: integer
            format: int64
            description: The ID of the open order. The _OrderID_ is unique in each OMS.
            x-gitbook-description-html: >-
              <p>The ID of the open order. The <em>OrderID</em> is unique in
              each OMS.</p>
          Price:
            type: number
            format: decimal
            description: The price at which the buy or sell has been ordered.
            x-gitbook-description-html: <p>The price at which the buy or sell has been ordered.</p>
          Quantity:
            type: number
            format: decimal
            description: The quantity of the product to be bought or sold.
            x-gitbook-description-html: <p>The quantity of the product to be bought or sold.</p>
          DisplayQuantity:
            type: number
            format: decimal
            description: >-
              The quantity available to buy or sell that is publicly displayed
              to the market. To display a _displayQuantity_ value, an order must
              be a Limit order with a reserve.
            x-gitbook-description-html: >-
              <p>The quantity available to buy or sell that is publicly
              displayed to the market. To display a <em>displayQuantity</em>
              value, an order must be a Limit order with a reserve.</p>
          Instrument:
            type: integer
            description: >-
              The ID of the instrument being traded. The call **GetInstruments**
              can supply the instrument IDs that are available.
            x-gitbook-description-html: >-
              <p>The ID of the instrument being traded. The call
              <strong>GetInstruments</strong> can supply the instrument IDs that
              are available.</p>
          Account:
            type: integer
            description: The ID of the of the account which the order belongs to.
            x-gitbook-description-html: <p>The ID of the of the account which the order belongs to.</p>
          AccountName:
            type: string
            description: Name of the of the account which which the order belongs to.
            x-gitbook-description-html: >-
              <p>Name of the of the account which which the order belongs
              to.</p>
          OrderType:
            type: string
            enum:
              - Unknown an error condition
              - Market order
              - Limit
              - StopMarket
              - StopLimit
              - TrailingStopMarket
              - TrailingStopLimit
              - BlockTrade
            description: >-
              Describes the type of order this is. One of: 0 Unknown (an error
              condition), 1 Market order, 2 Limit, 3 StopMarket, 4 StopLimit, 5
              TrailingStopMarket, 6 TrailingStopLimit, 7 BlockTrade.
            x-gitbook-description-html: >-
              <p>Describes the type of order this is. One of: 0 Unknown (an
              error condition), 1 Market order, 2 Limit, 3 StopMarket, 4
              StopLimit, 5 TrailingStopMarket, 6 TrailingStopLimit, 7
              BlockTrade.</p>
          ClientOrderId:
            type: integer
            format: int64
            default: 0
            description: >-
              An ID supplied by the client to identify the order (like a
              purchase order number). Default is 0.
            x-gitbook-description-html: >-
              <p>An ID supplied by the client to identify the order (like a
              purchase order number). Default is 0.</p>
          OrderState:
            type: string
            enum:
              - Unknown
              - Working
              - Rejected
              - Canceled
              - Expired
              - Fully Executed
            description: >-
              The current or the latest state of the order. One of: 0 Unknown, 1
              Working, 2 Rejected, 3 Canceled, 4 Expired, 5 Fully Executed.
            x-gitbook-description-html: >-
              <p>The current or the latest state of the order. One of: 0
              Unknown, 1 Working, 2 Rejected, 3 Canceled, 4 Expired, 5 Fully
              Executed.</p>
          ReceiveTime:
            type: integer
            format: int64
            description: >-
              Time stamp of the order in POSIX format x 1000 (milliseconds since
              1/1/1970 in UTC time zone).
            x-gitbook-description-html: >-
              <p>Time stamp of the order in POSIX format x 1000 (milliseconds
              since 1/1/1970 in UTC time zone).</p>
          ReceiveTimeTicks:
            type: integer
            format: int64
            description: >-
              Time stamp of the order Microsoft Ticks format and UTC time zone.
              **Note:** Microsoft Ticks format is usually provided as a string.
              Here it is provided as a long integer.
            x-gitbook-description-html: >-
              <p>Time stamp of the order Microsoft Ticks format and UTC time
              zone. <strong>Note:</strong> Microsoft Ticks format is usually
              provided as a string. Here it is provided as a long integer.</p>
          LastUpdatedTime:
            type: integer
            format: int64
            description: >-
              Time stamp when the order was last updated, UNIX timestamp format
              x 1000 (milliseconds since 1/1/1970 in UTC time zone).
            x-gitbook-description-html: >-
              <p>Time stamp when the order was last updated, UNIX timestamp
              format x 1000 (milliseconds since 1/1/1970 in UTC time zone).</p>
          LastUpdatedTimeTicks:
            type: integer
            format: int64
            description: >-
              Time stamp when the order was last updated, in Microsoft Ticks
              format and UTC time zone. **Note:** Microsoft Ticks format is
              usually provided as a string. Here it is provided as a long
              integer.
            x-gitbook-description-html: >-
              <p>Time stamp when the order was last updated, in Microsoft Ticks
              format and UTC time zone. <strong>Note:</strong> Microsoft Ticks
              format is usually provided as a string. Here it is provided as a
              long integer.</p>
          OrigQuantity:
            type: number
            format: decimal
            description: >-
              If the open order has been changed or partially filled, this value
              shows the original quantity of the order.
            x-gitbook-description-html: >-
              <p>If the open order has been changed or partially filled, this
              value shows the original quantity of the order.</p>
          QuantityExecuted:
            type: number
            format: decimal
            description: >-
              If the open order has been at least partially executed, this value
              shows the amount that has been executed.
            x-gitbook-description-html: >-
              <p>If the open order has been at least partially executed, this
              value shows the amount that has been executed.</p>
          GrossValueExecuted:
            type: number
            format: decimal
            description: >-
              If the open order has been at least partially executed, this value
              shows the gross amount that has been executed.
            x-gitbook-description-html: >-
              <p>If the open order has been at least partially executed, this
              value shows the gross amount that has been executed.</p>
          ExecutableValue:
            type: number
            format: decimal
            description: Defaults to 0. For future provision.
            x-gitbook-description-html: <p>Defaults to 0. For future provision.</p>
          AvgPrice:
            type: number
            format: decimal
            description: The average executed price of the order.
            x-gitbook-description-html: <p>The average executed price of the order.</p>
          CounterPartyId:
            type: integer
            description: >-
              The ID of the account who is the counterparty for the trade if
              order is already executed, either partial or fully executed.
            x-gitbook-description-html: >-
              <p>The ID of the account who is the counterparty for the trade if
              order is already executed, either partial or fully executed.</p>
          ChangeReason:
            type: string
            enum:
              - Unknown
              - NewInputAccepted
              - NewInputRejected
              - OtherRejected
              - Expired
              - Trade
              - SystemCanceled_NoMoreMarket
              - SystemCanceled_BelowMinimum
              - SystemCanceled_PriceCollar
              - SystemCanceled_MarginFailed
              - UserModified
            description: >-
              If the order has been changed, this string value holds the reason.
              One of: 0 Unknown, 1 NewInputAccepted, 2 NewInputRejected, 3
              OtherRejected, 4 Expired, 5 Trade, 6 SystemCanceled_NoMoreMarket,
              7 SystemCanceled_BelowMinimum, 8 SystemCanceled_PriceCollar, 9
              SystemCanceled_MarginFailed, 100 UserModified. An order that is
              newly added to book will have **NewInputAccepted** value by
              default.
            x-gitbook-description-html: >-
              <p>If the order has been changed, this string value holds the
              reason. One of: 0 Unknown, 1 NewInputAccepted, 2 NewInputRejected,
              3 OtherRejected, 4 Expired, 5 Trade, 6
              SystemCanceled_NoMoreMarket, 7 SystemCanceled_BelowMinimum, 8
              SystemCanceled_PriceCollar, 9 SystemCanceled_MarginFailed, 100
              UserModified. An order that is newly added to book will have
              <strong>NewInputAccepted</strong> value by default.</p>
          OrigOrderId:
            type: integer
            format: int64
            description: >-
              If the order is a replacement order, this is the ID of the
              original order.
            x-gitbook-description-html: >-
              <p>If the order is a replacement order, this is the ID of the
              original order.</p>
          OrigClOrdId:
            type: integer
            format: int64
            description: >-
              If the order is a replacement order, this is the client order ID
              or the original order.
            x-gitbook-description-html: >-
              <p>If the order is a replacement order, this is the client order
              ID or the original order.</p>
          EnteredBy:
            type: integer
            description: The ID of the user who submitted the order.
            x-gitbook-description-html: <p>The ID of the user who submitted the order.</p>
          Username:
            type: string
            description: The username of the user who submitted the order.
            x-gitbook-description-html: <p>The username of the user who submitted the order.</p>
          IsQuote:
            type: boolean
            description: >-
              If this order is a quote, the value for _IsQuote_ is _true_,
              otherwise it is _false._.
            x-gitbook-description-html: >-
              <p>If this order is a quote, the value for <em>IsQuote</em> is
              <em>true</em>, otherwise it is <em>false.</em>.</p>
          InsideAsk:
            type: number
            format: decimal
            description: If this order is a quote, this value is the Inside Ask price.
            x-gitbook-description-html: >-
              <p>If this order is a quote, this value is the Inside Ask
              price.</p>
          InsideAskSize:
            type: number
            format: decimal
            description: >-
              If this order is a quote, this value is the quantity of the Inside
              Ask quote.
            x-gitbook-description-html: >-
              <p>If this order is a quote, this value is the quantity of the
              Inside Ask quote.</p>
          InsideBid:
            type: number
            format: decimal
            description: If this order is a quote, this value is the Inside Bid price.
            x-gitbook-description-html: >-
              <p>If this order is a quote, this value is the Inside Bid
              price.</p>
          InsideBidSize:
            type: number
            format: decimal
            description: >-
              If this order is a quote, this value is the quantity of the Inside
              Bid quote.
            x-gitbook-description-html: >-
              <p>If this order is a quote, this value is the quantity of the
              Inside Bid quote.</p>
          LastTradePrice:
            type: number
            format: decimal
            description: The last price that this instrument traded at.
            x-gitbook-description-html: <p>The last price that this instrument traded at.</p>
          RejectReason:
            type: string
            description: >-
              If this open order has been rejected, this string holds the reason
              for the rejection.
            x-gitbook-description-html: >-
              <p>If this open order has been rejected, this string holds the
              reason for the rejection.</p>
          IsLockedIn:
            type: boolean
            description: >-
              For a block trade, if both parties to the block trade agree that
              one of the parties will report the trade for both sides, this
              value is _true._ Othersise, _false._.
            x-gitbook-description-html: >-
              <p>For a block trade, if both parties to the block trade agree
              that one of the parties will report the trade for both sides, this
              value is <em>true.</em> Othersise, <em>false.</em>.</p>
          CancelReason:
            type: string
            description: >-
              If this order has been canceled, this string holds the
              cancellation reason.
            x-gitbook-description-html: >-
              <p>If this order has been canceled, this string holds the
              cancellation reason.</p>
          OrderFlag:
            oneOf:
              - type: integer
              - type: string
            description: >-
              One or more of:. 1 NoAccountRiskCheck. 2 AddedToBook. 4
              RemovedFromBook. 8 PostOnly. 16 Liquidation. 32
              ReverseMarginPosition.
            x-gitbook-description-html: >-
              <p>One or more of:. 1 NoAccountRiskCheck. 2 AddedToBook. 4
              RemovedFromBook. 8 PostOnly. 16 Liquidation. 32
              ReverseMarginPosition.</p>
          UseMargin:
            type: boolean
            default: false
            description: Margin is not yet supported so this always defaults to false.
            x-gitbook-description-html: >-
              <p>Margin is not yet supported so this always defaults to
              false.</p>
          StopPrice:
            type: number
            format: decimal
            description: >-
              The price at which the order executes, if the order is a stop
              order. Defaults to 0 if order is another type.
            x-gitbook-description-html: >-
              <p>The price at which the order executes, if the order is a stop
              order. Defaults to 0 if order is another type.</p>
          PegPriceType:
            type: string
            description: The type of price to peg the Stop to for Stop/Trailing orders.
            x-gitbook-description-html: >-
              <p>The type of price to peg the Stop to for Stop/Trailing
              orders.</p>
          PegOffset:
            type: number
            format: decimal
            description: >-
              Only applicable to trailing/stop orders. Defaults to 0 if order is
              another type.
            x-gitbook-description-html: >-
              <p>Only applicable to trailing/stop orders. Defaults to 0 if order
              is another type.</p>
          PegLimitOffset:
            type: number
            format: decimal
            description: >-
              Only applicable to trailing/stop orders. Defaults to 0 if order is
              another type.
            x-gitbook-description-html: >-
              <p>Only applicable to trailing/stop orders. Defaults to 0 if order
              is another type.</p>
          IpAddress:
            type: string
            description: The IP address from where the order was submitted.
            x-gitbook-description-html: <p>The IP address from where the order was submitted.</p>
          IPv6a:
            type: string
            description: >-
              **UInt64**. The IPv6 where the order was submitted from. Currently
              not being used, for future provision. Defaults to 0.
            x-gitbook-description-html: >-
              <p><strong>UInt64</strong>. The IPv6 where the order was submitted
              from. Currently not being used, for future provision. Defaults to
              0.</p>
          OMSId:
            type: integer
            description: The ID of the OMS.
            x-gitbook-description-html: <p>The ID of the OMS.</p>
        required:
          - Side
          - OrderId
          - Price
          - Quantity
          - DisplayQuantity
          - Instrument
          - Account
          - AccountName
          - OrderType
          - ClientOrderId
          - OrderState
          - ReceiveTime
          - ReceiveTimeTicks
          - LastUpdatedTime
          - LastUpdatedTimeTicks
          - OrigQuantity
          - QuantityExecuted
          - GrossValueExecuted
          - ExecutableValue
          - AvgPrice
          - CounterPartyId
          - ChangeReason
          - OrigOrderId
          - OrigClOrdId
          - EnteredBy
          - Username
          - IsQuote
          - InsideAsk
          - InsideAskSize
          - InsideBid
          - InsideBidSize
          - LastTradePrice
          - RejectReason
          - IsLockedIn
          - CancelReason
          - OrderFlag
          - UseMargin
          - StopPrice
          - PegPriceType
          - PegOffset
          - PegLimitOffset
          - IpAddress
          - IPv6a
          - IPv6a
          - OMSId
    GetTickerHistoryRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS.
          x-gitbook-description-html: <p>The ID of the OMS.</p>
        InstrumentId:
          type: integer
          description: The ID of a specific instrument.
          x-gitbook-description-html: <p>The ID of a specific instrument.</p>
        Interval:
          type: integer
          description: >-
            The time between ticks, in seconds. For example, a value of 60
            returns ticker array elements between _FromDate_ to _ToDate_ in
            60-second increments.
          x-gitbook-description-html: >-
            <p>The time between ticks, in seconds. For example, a value of 60
            returns ticker array elements between <em>FromDate</em> to
            <em>ToDate</em> in 60-second increments.</p>
        FromDate:
          type: string
          default: '00:00:00'
          description: >-
            Oldest date from which the ticker history will start; in DateTime
            format (hour:minutes:seconds). Default is 00:00:00.
          x-gitbook-description-html: >-
            <p>Oldest date from which the ticker history will start; in DateTime
            format (hour:minutes:seconds). Default is 00:00:00.</p>
        ToDate:
          type: string
          default: '00:00:00'
          description: >-
            Most recent date, at which the ticker history will end; in DateTime
            format (hour:minutes:seconds). Default is 00:00:00.
          x-gitbook-description-html: >-
            <p>Most recent date, at which the ticker history will end; in
            DateTime format (hour:minutes:seconds). Default is 00:00:00.</p>
      required:
        - OMSId
        - InstrumentId
        - Interval
        - FromDate
        - ToDate
    GetTickerHistoryResponse:
      type: array
      items:
        type: array
        example:
          - 1692926460000 //EndDateTime
          - 28432.44 //High
          - 28432.44 //Low
          - 28432.44 //Open
          - 28432.44 //Close
          - 0 //Volume
          - 0 //Best Bid
          - 0 //Best Ask
          - 1 //InstrumentId
          - 1692926400000 //BeginDateTime
        prefixItems:
          - type: integer
            format: int64
            description: >-
              EndDateTime. The end/closing date and time of the ticker, in UTC
              and POSIX format.
            x-gitbook-description-html: >-
              <p>EndDateTime. The end/closing date and time of the ticker, in
              UTC and POSIX format.</p>
          - type: number
            format: decimal
            description: >-
              High. The Highest Trade Price for the Time-Period ( 0 if no trades
              ).
            x-gitbook-description-html: >-
              <p>High. The Highest Trade Price for the Time-Period ( 0 if no
              trades ).</p>
          - type: number
            format: decimal
            description: >-
              Low. The Lowest Trade Price for the Time-Period ( 0 if no trades
              ).
            x-gitbook-description-html: >-
              <p>Low. The Lowest Trade Price for the Time-Period ( 0 if no
              trades ).</p>
          - type: number
            format: decimal
            description: >-
              Open. The Opening Trade Price for the Time-Period ( 0 if no trades
              ).
            x-gitbook-description-html: >-
              <p>Open. The Opening Trade Price for the Time-Period ( 0 if no
              trades ).</p>
          - type: number
            format: decimal
            description: >-
              Close. The Last Trade Price for the Time-Period ( 0 if no trades
              ).
            x-gitbook-description-html: >-
              <p>Close. The Last Trade Price for the Time-Period ( 0 if no
              trades ).</p>
          - type: number
            format: decimal
            description: Volume. The Total Trade Volume since the last Tick.
            x-gitbook-description-html: <p>Volume. The Total Trade Volume since the last Tick.</p>
          - type: number
            format: decimal
            description: Bid. The best bid price at the time of the Tick.
            x-gitbook-description-html: <p>Bid. The best bid price at the time of the Tick.</p>
          - type: number
            format: decimal
            description: Ask. The best ask price at the time of the Tick.
            x-gitbook-description-html: <p>Ask. The best ask price at the time of the Tick.</p>
          - type: integer
            description: InstrumentId. The ID of the instrument.
            x-gitbook-description-html: <p>InstrumentId. The ID of the instrument.</p>
          - type: integer
            format: int64
            description: >-
              BeginDateTime. The start/opening date and time of the ticker, in
              UTC and POSIX format.
            x-gitbook-description-html: >-
              <p>BeginDateTime. The start/opening date and time of the ticker,
              in UTC and POSIX format.</p>
    GetLastTradesRequest:
      type: object
      properties:
        OMSId:
          type: string
          description: The ID of the OMS on which the instrument is being traded.
          x-gitbook-description-html: <p>The ID of the OMS on which the instrument is being traded.</p>
        InstrumentId:
          type: string
          description: The ID of the instrument.
          x-gitbook-description-html: <p>The ID of the instrument.</p>
        Count:
          type: string
          default: 100
          description: >-
            Value represents the number of trades you want to get, value of 10
            will return 10 most recent trades. Default is 100.
          x-gitbook-description-html: >-
            <p>Value represents the number of trades you want to get, value of
            10 will return 10 most recent trades. Default is 100.</p>
      required:
        - OMSId
        - InstrumentId
    GetLastTradesResponse:
      type: array
      items:
        type: array
        items: false
        prefixItems:
          - type: integer
            description: TradeId. The ID of this trade.
            x-gitbook-description-html: <p>TradeId. The ID of this trade.</p>
          - type: integer
            description: InstrumentId. The ID of the instrument.
            x-gitbook-description-html: <p>InstrumentId. The ID of the instrument.</p>
          - type: number
            format: decimal
            description: Quantity. The quantity of the instrument traded.
            x-gitbook-description-html: <p>Quantity. The quantity of the instrument traded.</p>
          - type: number
            format: decimal
            description: Price.The price at which the instrument was traded.
            x-gitbook-description-html: <p>Price.The price at which the instrument was traded.</p>
          - type: integer
            description: >-
              Order1. The ID of the first order that resulted in the trade,
              either Buy or Sell.
            x-gitbook-description-html: >-
              <p>Order1. The ID of the first order that resulted in the trade,
              either Buy or Sell.</p>
          - type: integer
            description: >-
              Order2. The ID of the second order that resulted in the trade,
              either Buy or Sell.
            x-gitbook-description-html: >-
              <p>Order2. The ID of the second order that resulted in the trade,
              either Buy or Sell.</p>
          - type: integer
            format: int64
            description: Tradetime. UTC trade time in Total Milliseconds. POSIX format.
            x-gitbook-description-html: >-
              <p>Tradetime. UTC trade time in Total Milliseconds. POSIX
              format.</p>
          - type: integer
            enum:
              - 0
              - 1
              - 2
            description: >-
              Direction. Effect of the trade on the instrument’s market price.
              One of: 0 NoChange, 1 UpTick, 2 DownTick.
            x-gitbook-description-html: >-
              <p>Direction. Effect of the trade on the instrument’s market
              price. One of: 0 NoChange, 1 UpTick, 2 DownTick.</p>
          - type: integer
            enum:
              - 0
              - 1
            description: >-
              TakerSide. Which side of the trade took liquidity? One of: 0 Buy,
              1 Sell. The maker side of the trade provides liquidity by placing
              the order on the book (this can be a buy or a sell order). The
              other, taker, side takes the liquidity. It, too, can be buy-side
              or sell-side.
            x-gitbook-description-html: >-
              <p>TakerSide. Which side of the trade took liquidity? One of: 0
              Buy, 1 Sell. The maker side of the trade provides liquidity by
              placing the order on the book (this can be a buy or a sell order).
              The other, taker, side takes the liquidity. It, too, can be
              buy-side or sell-side.</p>
          - type: boolean
            default: false
            description: >-
              BlockTrade. True if it was a privately negotiated trade. Private
              trade returns 1 (_true_); otherwise 0 (_false_). Default is
              _false_.
            x-gitbook-description-html: >-
              <p>BlockTrade. True if it was a privately negotiated trade.
              Private trade returns 1 (<em>true</em>); otherwise 0
              (<em>false</em>). Default is <em>false</em>.</p>
          - type: integer
            description: >-
              order1ClientId or order2ClientId. The client-supplied order ID for
              the trade. Internal logic determines whether the program reports
              the _order1ClientId_ or the _order2ClientId_.
            x-gitbook-description-html: >-
              <p>order1ClientId or order2ClientId. The client-supplied order ID
              for the trade. Internal logic determines whether the program
              reports the <em>order1ClientId</em> or the
              <em>order2ClientId</em>.</p>
        example:
          - 14 // TradeId. The ID of this trade
          - 2 // InstrumentId. The ID of the instrument
          - 0.02 // Quantity. The quantity of the instrument traded
          - 1970 // Price.The price at which the instrument was traded
          - >-
            5922 // Order1. The ID of the first order that resulted in the
            trade, either Buy or Sell
          - >-
            5923 // Order2. The ID of the second order that resulted in the
            trade, either Buy or Sell
          - >-
            1675332676849 // Tradetime. UTC trade time in Total Milliseconds.
            POSIX format
          - >-
            1 // Direction. Effect of the trade on the instrument\u2019s market
            price. One of: 0 NoChange, 1 UpTick, 2 DownTick
          - >-
            0 // TakerSide. Which side of the trade took liquidity? One of: 0
            Buy, 1 Sell. The maker side of the trade provides liquidity by
            placing the order on the book (this can be a buy or a sell order).
            The other, taker, side takes the liquidity. It, too, can be buy-side
            or sell-side
          - >-
            0 // BlockTrade. True if it was a privately negotiated trade.
            Private trade returns 1 (_true_); otherwise 0 (_false_). Default is
            _false_
          - >-
            0 // order1ClientId or order2ClientId. The client-supplied order ID
            for the trade. Internal logic determines whether the program reports
            the _order1ClientId_ or the _order2ClientId_
    GetLevel1SummaryRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS.
          x-gitbook-description-html: <p>The ID of the OMS.</p>
      required:
        - OMSId
    GetLevel1SummaryResponse:
      type: array
      items:
        type: string
        description: >-
          Level1 summary information in JSON format. The format is as follows {
          "TickerUpdate": { "type": "object", "description": "Standard market
          data update containing quote and session statistics.", "properties": {
          "OMSId": { "type": "integer", "description": "The ID of the OMS." },
          "InstrumentId": { "type": "integer", "description": "The ID of the
          instrument." }, "BestBid": { "type": "number", "format": "decimal",
          "description": "Current best bid price." }, "BestOffer": { "type":
          "number", "format": "decimal", "description": "Current best offer
          price." }, "LastTradedPx": { "type": "number", "format": "decimal",
          "description": "Last-traded price." }, "LastTradedQty": { "type":
          "number", "format": "decimal", "description": "Last-traded quantity."
          }, "LastTradeTime": { "type": "integer", "format": "int64",
          "description": "Time of last trade (POSIX)." }, "SessionOpen": {
          "type": "number", "format": "decimal", "description": "Opening price.
          In markets with openings and closings, this is the opening price for
          the current session; in 24-hour markets, it is the price as of UTC
          Midnight." }, "SessionHigh": { "type": "number", "format": "decimal",
          "description": "Highest price during the trading day, either during a
          session with opening and closing prices or UTC midnight to UTC
          midnight." }, "SessionLow": { "type": "number", "format": "decimal",
          "description": "Lowest price during the trading day, either during a
          session with opening and closing prices or UTC midnight to UTC
          midnight." }, "SessionClose": { "type": "number", "format": "decimal",
          "description": "The closing price. In markets with openings and
          closings, this is the closing price for the current session; in
          24-hour markets, it is the price as of UTC Midnight." }, "Volume": {
          "type": "number", "format": "decimal", "description": "The last-traded
          quantity for the instrument, same value as LastTradedQty." },
          "CurrentDayVolume": { "type": "number", "format": "decimal",
          "description": "The unit volume of the instrument traded either during
          a session with openings and closings or in 24-hour markets, the period
          from UTC Midnight to UTC Midnight." }, "CurrentDayNumTrades": {
          "type": "integer", "description": "The number of trades during the
          current day, either during a session with openings and closings or in
          24-hour markets, the period from UTC Midnight to UTC Midnight." },
          "CurrentDayPxChange": { "type": "number", "format": "decimal",
          "description": "Current day price change, either during a trading
          session or UTC Midnight to UTC midnight." }, "CurrentNotional": {
          "type": "number", "format": "decimal", "description": "Current day
          quote volume (resets at UTC Midnight)." }, "Rolling24HrNotional": {
          "type": "number", "format": "decimal", "description": "Rolling 24
          hours quote volume." }, "Rolling24HrVolume": { "type": "number",
          "format": "decimal", "description": "Unit volume (quantity traded, in
          the product 1 or in the base currency denomination) of the instrument
          during the past 24 hours, regardless of time zone. Recalculates
          continuously." }, "Rolling24HrNumTrades": { "type": "integer",
          "description": "Number of trades during the past 24 hours, regardless
          of time zone. Recalculates continuously." }, "Rolling24HrPxChange": {
          "type": "number", "format": "decimal", "description": "Price change
          during the past 24 hours, regardless of time zone. Recalculates
          continuously." }, "Rolling24HrPxChangePercent": { "type": "number",
          "format": "decimal", "description": "Percent change in price during
          the past 24hours regardless of the timezone. Recalculates
          continuously." }, "TimeStamp": { "type": "string", "description": "The
          time this information was provided, in POSIX format." }, "BidQty": {
          "type": "number", "format": "decimal", "description": "Quantity
          currently being bid." }, "AskQty": { "type": "number", "format":
          "decimal", "description": "Quantity currently being asked." },
          "BidOrderCt": { "type": "integer", "description": "Count of bid
          orders." }, "AskOrderCt": { "type": "integer", "description": "Count
          of ask orders." } } } }
        x-gitbook-description-html: >-
          <p>Level1 summary information in JSON format. The format is as follows
          { "TickerUpdate": { "type": "object", "description": "Standard market
          data update containing quote and session statistics.", "properties": {
          "OMSId": { "type": "integer", "description": "The ID of the OMS." },
          "InstrumentId": { "type": "integer", "description": "The ID of the
          instrument." }, "BestBid": { "type": "number", "format": "decimal",
          "description": "Current best bid price." }, "BestOffer": { "type":
          "number", "format": "decimal", "description": "Current best offer
          price." }, "LastTradedPx": { "type": "number", "format": "decimal",
          "description": "Last-traded price." }, "LastTradedQty": { "type":
          "number", "format": "decimal", "description": "Last-traded quantity."
          }, "LastTradeTime": { "type": "integer", "format": "int64",
          "description": "Time of last trade (POSIX)." }, "SessionOpen": {
          "type": "number", "format": "decimal", "description": "Opening price.
          In markets with openings and closings, this is the opening price for
          the current session; in 24-hour markets, it is the price as of UTC
          Midnight." }, "SessionHigh": { "type": "number", "format": "decimal",
          "description": "Highest price during the trading day, either during a
          session with opening and closing prices or UTC midnight to UTC
          midnight." }, "SessionLow": { "type": "number", "format": "decimal",
          "description": "Lowest price during the trading day, either during a
          session with opening and closing prices or UTC midnight to UTC
          midnight." }, "SessionClose": { "type": "number", "format": "decimal",
          "description": "The closing price. In markets with openings and
          closings, this is the closing price for the current session; in
          24-hour markets, it is the price as of UTC Midnight." }, "Volume": {
          "type": "number", "format": "decimal", "description": "The last-traded
          quantity for the instrument, same value as LastTradedQty." },
          "CurrentDayVolume": { "type": "number", "format": "decimal",
          "description": "The unit volume of the instrument traded either during
          a session with openings and closings or in 24-hour markets, the period
          from UTC Midnight to UTC Midnight." }, "CurrentDayNumTrades": {
          "type": "integer", "description": "The number of trades during the
          current day, either during a session with openings and closings or in
          24-hour markets, the period from UTC Midnight to UTC Midnight." },
          "CurrentDayPxChange": { "type": "number", "format": "decimal",
          "description": "Current day price change, either during a trading
          session or UTC Midnight to UTC midnight." }, "CurrentNotional": {
          "type": "number", "format": "decimal", "description": "Current day
          quote volume (resets at UTC Midnight)." }, "Rolling24HrNotional": {
          "type": "number", "format": "decimal", "description": "Rolling 24
          hours quote volume." }, "Rolling24HrVolume": { "type": "number",
          "format": "decimal", "description": "Unit volume (quantity traded, in
          the product 1 or in the base currency denomination) of the instrument
          during the past 24 hours, regardless of time zone. Recalculates
          continuously." }, "Rolling24HrNumTrades": { "type": "integer",
          "description": "Number of trades during the past 24 hours, regardless
          of time zone. Recalculates continuously." }, "Rolling24HrPxChange": {
          "type": "number", "format": "decimal", "description": "Price change
          during the past 24 hours, regardless of time zone. Recalculates
          continuously." }, "Rolling24HrPxChangePercent": { "type": "number",
          "format": "decimal", "description": "Percent change in price during
          the past 24hours regardless of the timezone. Recalculates
          continuously." }, "TimeStamp": { "type": "string", "description": "The
          time this information was provided, in POSIX format." }, "BidQty": {
          "type": "number", "format": "decimal", "description": "Quantity
          currently being bid." }, "AskQty": { "type": "number", "format":
          "decimal", "description": "Quantity currently being asked." },
          "BidOrderCt": { "type": "integer", "description": "Count of bid
          orders." }, "AskOrderCt": { "type": "integer", "description": "Count
          of ask orders." } } } }</p>
    GetLevel1SummaryMinRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS.
          x-gitbook-description-html: <p>The ID of the OMS.</p>
        InstrumentIds:
          type: string
          description: >-
            An array but will be passed as a string. List of instrument ids to
            get level1 summaries of. If this field is not specified, level1
            summary of all instruments will be returned.
          x-gitbook-description-html: >-
            <p>An array but will be passed as a string. List of instrument ids
            to get level1 summaries of. If this field is not specified, level1
            summary of all instruments will be returned.</p>
      required:
        - OMSId
    GetLevel1SummaryMinResponse:
      type: array
      items:
        type: array
        items: false
        prefixItems:
          - type: integer
            description: InstrumentId. The ID of the instrument.
            x-gitbook-description-html: <p>InstrumentId. The ID of the instrument.</p>
          - type: string
            description: InstrumentSymbol. The symbol of the instrument.
            x-gitbook-description-html: <p>InstrumentSymbol. The symbol of the instrument.</p>
          - type: number
            format: decimal
            description: LastTradedPX. The last-traded price for the instrument.
            x-gitbook-description-html: <p>LastTradedPX. The last-traded price for the instrument.</p>
          - type: number
            format: decimal
            description: >-
              Rolling24HrVolume. Unit volume (quantity traded, in the product 1
              or in the base currency denomination) of the instrument during the
              past 24 hours, regardless of time zone. Recalculates continuously.
            x-gitbook-description-html: >-
              <p>Rolling24HrVolume. Unit volume (quantity traded, in the product
              1 or in the base currency denomination) of the instrument during
              the past 24 hours, regardless of time zone. Recalculates
              continuously.</p>
          - type: number
            format: decimal
            description: >-
              Rolling24HrPxChange. Change in price during the past 24 hours
              regardless of the timezone. Recalculates continuously.
            x-gitbook-description-html: >-
              <p>Rolling24HrPxChange. Change in price during the past 24 hours
              regardless of the timezone. Recalculates continuously.</p>
          - type: number
            format: decimal
            description: >-
              Rolling24HrPxChangePercent. Percent change in price during the
              past 24 hours regardless of the timezone. Recalculates
              continuously.
            x-gitbook-description-html: >-
              <p>Rolling24HrPxChangePercent. Percent change in price during the
              past 24 hours regardless of the timezone. Recalculates
              continuously.</p>
        example:
          - 1 //InstrumentId
          - '"BTCUSD", //Instrument symbol'
          - 29900 //LastTradedPx
          - '-1100 //Rolling24HrPxChange'
          - '-3.5483870967741935483870967700 //Rolling24HrPxChangePercent'
          - 0.0021000000000000000000000000 //Rolling24HrVolume
    GetOpenTradeReportsRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS.
          x-gitbook-description-html: <p>The ID of the OMS.</p>
        AccountId:
          type: integer
          description: The ID of the account whose open blocktrade/s will be retrieved.
          x-gitbook-description-html: >-
            <p>The ID of the account whose open blocktrade/s will be
            retrieved.</p>
      required:
        - OMSId
        - AccountId
    GetOpenTradeReportsResponse:
      type: array
      items:
        type: object
        properties:
          Side:
            type: string
            enum:
              - Buy
              - Sell
            description: 'The side of a trade. One of: 0 Buy, 1 Sell.'
            x-gitbook-description-html: '<p>The side of a trade. One of: 0 Buy, 1 Sell.</p>'
          OrderId:
            type: integer
            format: int64
            description: The ID of the open order. The _OrderID_ is unique in each OMS.
            x-gitbook-description-html: >-
              <p>The ID of the open order. The <em>OrderID</em> is unique in
              each OMS.</p>
          Price:
            type: number
            format: decimal
            description: The price at which the buy or sell has been ordered.
            x-gitbook-description-html: <p>The price at which the buy or sell has been ordered.</p>
          Quantity:
            type: number
            format: decimal
            description: The quantity of the product to be bought or sold.
            x-gitbook-description-html: <p>The quantity of the product to be bought or sold.</p>
          DisplayQuantity:
            type: number
            format: decimal
            description: >-
              The quantity available to buy or sell that is publicly displayed
              to the market. To display a _displayQuantity_ value, an order must
              be a Limit order with a reserve.
            x-gitbook-description-html: >-
              <p>The quantity available to buy or sell that is publicly
              displayed to the market. To display a <em>displayQuantity</em>
              value, an order must be a Limit order with a reserve.</p>
          Instrument:
            type: integer
            description: >-
              The ID of the instrument being traded. The call **GetInstruments**
              can supply the instrument IDs that are available.
            x-gitbook-description-html: >-
              <p>The ID of the instrument being traded. The call
              <strong>GetInstruments</strong> can supply the instrument IDs that
              are available.</p>
          Account:
            type: integer
            description: The ID of the of the account which submitted the order.
            x-gitbook-description-html: <p>The ID of the of the account which submitted the order.</p>
          AccountName:
            type: string
            description: Name of the of the account which submitted the order.
            x-gitbook-description-html: <p>Name of the of the account which submitted the order.</p>
          OrderType:
            type: string
            description: >-
              Will always be **BlockTrade** as this GetOpenTradeReports API will
              only return open blocktrades.
            x-gitbook-description-html: >-
              <p>Will always be <strong>BlockTrade</strong> as this
              GetOpenTradeReports API will only return open blocktrades.</p>
          ClientOrderId:
            type: integer
            format: int64
            default: 0
            description: >-
              An ID supplied by the client to identify the order (like a
              purchase order number). Default is 0.
            x-gitbook-description-html: >-
              <p>An ID supplied by the client to identify the order (like a
              purchase order number). Default is 0.</p>
          OrderState:
            type: string
            enum:
              - Unknown
              - Working
              - Rejected
              - Canceled
              - Expired
              - FullyExecuted
            description: >-
              The current state of the order. One of: 0 Unknown, 1 Working, 2
              Rejected, 3 Canceled, 4 Expired, 5 FullyExecuted.
            x-gitbook-description-html: >-
              <p>The current state of the order. One of: 0 Unknown, 1 Working, 2
              Rejected, 3 Canceled, 4 Expired, 5 FullyExecuted.</p>
          ReceiveTime:
            type: integer
            format: int64
            description: >-
              Time stamp of the order in POSIX format x 1000 (milliseconds since
              1/1/1970 in UTC time zone).
            x-gitbook-description-html: >-
              <p>Time stamp of the order in POSIX format x 1000 (milliseconds
              since 1/1/1970 in UTC time zone).</p>
          ReceiveTimeTicks:
            type: integer
            format: int64
            description: >-
              Time stamp of the order Microsoft Ticks format and UTC time zone.
              **Note:** Microsoft Ticks format is usually provided as a string.
              Here it is provided as a long integer.
            x-gitbook-description-html: >-
              <p>Time stamp of the order Microsoft Ticks format and UTC time
              zone. <strong>Note:</strong> Microsoft Ticks format is usually
              provided as a string. Here it is provided as a long integer.</p>
          OrigQuantity:
            type: number
            format: decimal
            description: >-
              If the open order has been changed or partially filled, this value
              shows the original quantity of the order.
            x-gitbook-description-html: >-
              <p>If the open order has been changed or partially filled, this
              value shows the original quantity of the order.</p>
          QuantityExecuted:
            type: number
            format: decimal
            description: >-
              If the open order has been at least partially executed, this value
              shows the amount that has been executed.
            x-gitbook-description-html: >-
              <p>If the open order has been at least partially executed, this
              value shows the amount that has been executed.</p>
          GrossValueExecuted:
            type: number
            format: decimal
            description: >-
              If the open order has been at least partially executed, this value
              shows the gross amount that has been executed.
            x-gitbook-description-html: >-
              <p>If the open order has been at least partially executed, this
              value shows the gross amount that has been executed.</p>
          AvgPrice:
            type: number
            format: decimal
            description: The average executed price of the order.
            x-gitbook-description-html: <p>The average executed price of the order.</p>
          CounterPartyId:
            type: integer
            description: >-
              The ID of the account who will be the counter party of the
              blocktrade.
            x-gitbook-description-html: >-
              <p>The ID of the account who will be the counter party of the
              blocktrade.</p>
          ChangeReason:
            type: string
            enum:
              - Unknown
              - NewInputAccepted
              - NewInputRejected
              - OtherRejected
              - Expired
              - Trade
              - SystemCanceled_NoMoreMarket
              - SystemCanceled_BelowMinimum
              - SystemCanceled_PriceCollar
              - SystemCanceled_MarginFailed
              - UserModified
            description: >-
              If the order has been changed, this string value holds the reason.
              One of: 0 Unknown, 1 NewInputAccepted, 2 NewInputRejected, 3
              OtherRejected, 4 Expired, 5 Trade, 6 SystemCanceled_NoMoreMarket,
              7 SystemCanceled_BelowMinimum, 8 SystemCanceled_PriceCollar, 9
              SystemCanceled_MarginFailed, 100 UserModified.
            x-gitbook-description-html: >-
              <p>If the order has been changed, this string value holds the
              reason. One of: 0 Unknown, 1 NewInputAccepted, 2 NewInputRejected,
              3 OtherRejected, 4 Expired, 5 Trade, 6
              SystemCanceled_NoMoreMarket, 7 SystemCanceled_BelowMinimum, 8
              SystemCanceled_PriceCollar, 9 SystemCanceled_MarginFailed, 100
              UserModified.</p>
          OrigOrderId:
            type: integer
            description: >-
              If the order has been changed, this is the ID of the original
              order.
            x-gitbook-description-html: >-
              <p>If the order has been changed, this is the ID of the original
              order.</p>
          OrigClOrdId:
            type: integer
            description: >-
              If the order has been changed, this is the ID of the original
              client order ID.
            x-gitbook-description-html: >-
              <p>If the order has been changed, this is the ID of the original
              client order ID.</p>
          EnteredBy:
            type: integer
            description: The ID of the user who submitted the order.
            x-gitbook-description-html: <p>The ID of the user who submitted the order.</p>
          Username:
            type: integer
            description: The username of the user who submitted the order.
            x-gitbook-description-html: <p>The username of the user who submitted the order.</p>
          IsQuote:
            type: boolean
            description: >-
              If this order is a quote (created using
              [**CreateDirectQuote**](#operation/CreateDirectQuote) API method
              or the [**CreateInverseQuote**](#operation/CreateInverseQuote) API
              method), the value for _IsQuote_ is _true_, else _false._.
            x-gitbook-description-html: >-
              <p>If this order is a quote (created using <a
              href="#operation/CreateDirectQuote"><strong>CreateDirectQuote</strong></a>
              API method or the <a
              href="#operation/CreateInverseQuote"><strong>CreateInverseQuote</strong></a>
              API method), the value for <em>IsQuote</em> is <em>true</em>, else
              <em>false.</em>.</p>
          InsideAsk:
            type: number
            format: decimal
            description: If this order is a quote, this value is the Inside Ask price.
            x-gitbook-description-html: >-
              <p>If this order is a quote, this value is the Inside Ask
              price.</p>
          InsideAskSize:
            type: number
            format: decimal
            description: >-
              If this order is a quote, this value is the quantity of the Inside
              Ask quote.
            x-gitbook-description-html: >-
              <p>If this order is a quote, this value is the quantity of the
              Inside Ask quote.</p>
          InsideBid:
            type: number
            format: decimal
            description: If this order is a quote, this value is the Inside Bid price.
            x-gitbook-description-html: >-
              <p>If this order is a quote, this value is the Inside Bid
              price.</p>
          InsideBidSize:
            type: number
            format: decimal
            description: >-
              If this order is a quote, this value is the quantity of the Inside
              Bid quote.
            x-gitbook-description-html: >-
              <p>If this order is a quote, this value is the quantity of the
              Inside Bid quote.</p>
          LastTradePrice:
            type: number
            format: decimal
            description: The last price that this instrument traded at.
            x-gitbook-description-html: <p>The last price that this instrument traded at.</p>
          RejectReason:
            type: string
            description: >-
              If this open order has been rejected, this string holds the reason
              for the rejection.
            x-gitbook-description-html: >-
              <p>If this open order has been rejected, this string holds the
              reason for the rejection.</p>
          IsLockedIn:
            type: boolean
            description: >-
              For a block trade, if both parties to the block trade agree that
              one of the parties will report the trade for both sides, this
              value is _true._ Othersise, _false._.
            x-gitbook-description-html: >-
              <p>For a block trade, if both parties to the block trade agree
              that one of the parties will report the trade for both sides, this
              value is <em>true.</em> Othersise, <em>false.</em>.</p>
          CancelReason:
            type: string
            description: >-
              If this order has been canceled, this string holds the
              cancellation reason.
            x-gitbook-description-html: >-
              <p>If this order has been canceled, this string holds the
              cancellation reason.</p>
          UseMargin:
            type: boolean
            default: false
            description: Margin is not yet supported so this always defaults to false.
            x-gitbook-description-html: >-
              <p>Margin is not yet supported so this always defaults to
              false.</p>
          StopPrice:
            type: number
            format: decimal
            description: >-
              The price at which the order executes, if the order is a stop
              order. Defaults to 0 if order is another type.
            x-gitbook-description-html: >-
              <p>The price at which the order executes, if the order is a stop
              order. Defaults to 0 if order is another type.</p>
          PegPriceType:
            type: string
            description: Not applicable for an order resulting from **SubmitBlockTrade**.
            x-gitbook-description-html: >-
              <p>Not applicable for an order resulting from
              <strong>SubmitBlockTrade</strong>.</p>
          PegOffset:
            type: number
            format: decimal
            description: Not applicable for an order resulting from **SubmitBlockTrade**.
            x-gitbook-description-html: >-
              <p>Not applicable for an order resulting from
              <strong>SubmitBlockTrade</strong>.</p>
          PegLimitOffset:
            type: number
            format: decimal
            description: Not applicable for an order resulting from **SubmitBlockTrade**.
            x-gitbook-description-html: >-
              <p>Not applicable for an order resulting from
              <strong>SubmitBlockTrade</strong>.</p>
          IpAddress:
            type: string
            description: The IP address from where the order was submitted.
            x-gitbook-description-html: <p>The IP address from where the order was submitted.</p>
          OMSId:
            type: integer
            description: The ID of the OMS.
            x-gitbook-description-html: <p>The ID of the OMS.</p>
        required:
          - Side
          - OrderId
          - Price
          - Quantity
          - DisplayQuantity
          - Instrument
          - Account
          - AccountName
          - OrderType
          - ClientOrderId
          - OrderState
          - ReceiveTime
          - ReceiveTimeTicks
          - OrigQuantity
          - QuantityExecuted
          - GrossValueExecuted
          - AvgPrice
          - CounterPartyId
          - ChangeReason
          - OrigOrderId
          - OrigClOrdId
          - EnteredBy
          - Username
          - IsQuote
          - InsideAsk
          - InsideAskSize
          - InsideBid
          - InsideBidSize
          - LastTradePrice
          - RejectReason
          - IsLockedIn
          - CancelReason
          - UseMargin
          - StopPrice
          - PegPriceType
          - PegOffset
          - PegLimitOffset
          - IpAddress
          - OMSId
    GetOrdersRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS on which the orders took place.
          x-gitbook-description-html: <p>The ID of the OMS on which the orders took place.</p>
        AccountId:
          type: integer
          description: >-
            The account ID that made the trades. A user with NotbankTrading
            permission must be associated with this account, although other
            users also can be associated with the account.
          x-gitbook-description-html: >-
            <p>The account ID that made the trades. A user with NotbankTrading
            permission must be associated with this account, although other
            users also can be associated with the account.</p>
        OrderState:
          type: string
          enum:
            - Unknown
            - Working
            - Rejected
            - Canceled
            - Expired
            - FullyExecuted
          description: >-
            The current state of the order. Can be used to filter results. If
            not specified all orders regardless of the order state will be
            returned. One of: 0 Unknown, 1 Working, 2 Rejected, 3 Canceled, 4
            Expired, 5 FullyExecuted.
          x-gitbook-description-html: >-
            <p>The current state of the order. Can be used to filter results. If
            not specified all orders regardless of the order state will be
            returned. One of: 0 Unknown, 1 Working, 2 Rejected, 3 Canceled, 4
            Expired, 5 FullyExecuted.</p>
        OrderId:
          type: integer
          format: int64
          description: >-
            The ID for the order. Can be used to filter results. Can be used to
            filter for a specific orderId. There is a specific API call
            [**GetOrderHistoryByOrderId**](#operation/GetOrderHistoryByOrderId)
            for filtering orders by **OrderId**.
          x-gitbook-description-html: >-
            <p>The ID for the order. Can be used to filter results. Can be used
            to filter for a specific orderId. There is a specific API call <a
            href="#operation/GetOrderHistoryByOrderId"><strong>GetOrderHistoryByOrderId</strong></a>
            for filtering orders by <strong>OrderId</strong>.</p>
        ClientOrderId:
          type: integer
          format: int64
          default: 0
          description: >-
            A user-assigned ID for the order (like a purchase-order number
            assigned by a company). Can be used to filter results. Default is 0.
          x-gitbook-description-html: >-
            <p>A user-assigned ID for the order (like a purchase-order number
            assigned by a company). Can be used to filter results. Default is
            0.</p>
        OriginalOrderId:
          type: integer
          format: int64
          description: >-
            The original ID of the order. If specified, the call returns changed
            orders associated with this order ID. Can be used to filter results.
          x-gitbook-description-html: >-
            <p>The original ID of the order. If specified, the call returns
            changed orders associated with this order ID. Can be used to filter
            results.</p>
        OriginalClientOrderId:
          type: integer
          format: int64
          description: >-
            If the order has been changed, shows the original client order ID, a
            value that the client can create (much like a purchase order). Can
            be used to filter results.
          x-gitbook-description-html: >-
            <p>If the order has been changed, shows the original client order
            ID, a value that the client can create (much like a purchase order).
            Can be used to filter results.</p>
        UserId:
          type: integer
          description: >-
            The ID of the user whose account orders will be returned. If not
            specified, the call returns the orders of the logged-in user. Can be
            used to filter results.
          x-gitbook-description-html: >-
            <p>The ID of the user whose account orders will be returned. If not
            specified, the call returns the orders of the logged-in user. Can be
            used to filter results.</p>
        InstrumentId:
          type: integer
          format: int64
          description: >-
            The ID of the instrument named in the order. If not specified, the
            call returns orders for all instruments traded by this account. Can
            be used to filter results.
          x-gitbook-description-html: >-
            <p>The ID of the instrument named in the order. If not specified,
            the call returns orders for all instruments traded by this account.
            Can be used to filter results.</p>
        StartTimestamp:
          type: integer
          format: int64
          description: >-
            Date and time at which to begin the orders history, in POSIX format.
            Can be used to filter results.
          x-gitbook-description-html: >-
            <p>Date and time at which to begin the orders history, in POSIX
            format. Can be used to filter results.</p>
        EndTimestamp:
          type: integer
          format: int64
          description: >-
            Date and time at which to end the orders report, in POSIX format.
            Can be used to filter results.
          x-gitbook-description-html: >-
            <p>Date and time at which to end the orders report, in POSIX format.
            Can be used to filter results.</p>
        Depth:
          type: integer
          description: >-
            In this case, the maximum number/count of orders to return, counting
            from the _StartIndex_ if it is also specified. If not specified,
            returns all orders from the most recent to oldest; results can vary
            depending if other optional fields are defined such as _StartIndex_,
            _StartTimestamp_, and _EndTimestamp_. Can be used to filter results
            and for pagination.
          x-gitbook-description-html: >-
            <p>In this case, the maximum number/count of orders to return,
            counting from the <em>StartIndex</em> if it is also specified. If
            not specified, returns all orders from the most recent to oldest;
            results can vary depending if other optional fields are defined such
            as <em>StartIndex</em>, <em>StartTimestamp</em>, and
            <em>EndTimestamp</em>. Can be used to filter results and for
            pagination.</p>
        Limit:
          type: integer
          description: Functions exactly the same as the **Depth** field.
          x-gitbook-description-html: >-
            <p>Functions exactly the same as the <strong>Depth</strong>
            field.</p>
        StartIndex:
          type: integer
          default: 0
          description: >-
            A value of 0 means the first object in the result will be the the
            most recent order, a value of 2 means that the first object in the
            result set will be the third most recent order. Can be used to
            filter results or for pagination. Default is 0.
          x-gitbook-description-html: >-
            <p>A value of 0 means the first object in the result will be the the
            most recent order, a value of 2 means that the first object in the
            result set will be the third most recent order. Can be used to
            filter results or for pagination. Default is 0.</p>
      required:
        - OMSId
        - AccountId
    GetOrdersResponse:
      type: array
      items:
        type: object
        properties:
          Side:
            type: string
            enum:
              - Buy
              - Sell
            description: 'The side of a trade. One of: **0** Buy, **1** Sell.'
            x-gitbook-description-html: >-
              <p>The side of a trade. One of: <strong>0</strong> Buy,
              <strong>1</strong> Sell.</p>
          OrderId:
            type: integer
            format: int64
            description: The ID of the open order. The _OrderID_ is unique in each OMS.
            x-gitbook-description-html: >-
              <p>The ID of the open order. The <em>OrderID</em> is unique in
              each OMS.</p>
          Price:
            type: number
            format: decimal
            description: The price at which the buy or sell has been ordered.
            x-gitbook-description-html: <p>The price at which the buy or sell has been ordered.</p>
          Quantity:
            type: number
            format: decimal
            description: The quantity of the product to be bought or sold.
            x-gitbook-description-html: <p>The quantity of the product to be bought or sold.</p>
          DisplayQuantity:
            type: number
            format: decimal
            description: >-
              The quantity available to buy or sell that is publicly displayed
              to the market. To display a _displayQuantity_ value, an order must
              be a Limit order with a reserve.
            x-gitbook-description-html: >-
              <p>The quantity available to buy or sell that is publicly
              displayed to the market. To display a <em>displayQuantity</em>
              value, an order must be a Limit order with a reserve.</p>
          Instrument:
            type: integer
            description: >-
              The ID of the instrument being traded. The API method
              [**GetInstruments**](#operation/GetInstruments) can supply the
              instrument IDs that are available.
            x-gitbook-description-html: >-
              <p>The ID of the instrument being traded. The API method <a
              href="#operation/GetInstruments"><strong>GetInstruments</strong></a>
              can supply the instrument IDs that are available.</p>
          Account:
            type: integer
            description: The ID of the of the account which the order belongs to.
            x-gitbook-description-html: <p>The ID of the of the account which the order belongs to.</p>
          AccountName:
            type: string
            description: Name of the of the account which which the order belongs to.
            x-gitbook-description-html: >-
              <p>Name of the of the account which which the order belongs
              to.</p>
          OrderType:
            type: string
            enum:
              - Unknown an error condition
              - Market
              - Limit
              - StopMarket
              - StopLimit
              - TrailingStopMarket
              - TrailingStopLimit
              - BlockTrade
            description: >-
              Describes the type of order this is. One of: 0 Unknown (an error
              condition), 1 Market, 2 Limit, 3 StopMarket, 4 StopLimit, 5
              TrailingStopMarket, 6 TrailingStopLimit, 7 BlockTrade.
            x-gitbook-description-html: >-
              <p>Describes the type of order this is. One of: 0 Unknown (an
              error condition), 1 Market, 2 Limit, 3 StopMarket, 4 StopLimit, 5
              TrailingStopMarket, 6 TrailingStopLimit, 7 BlockTrade.</p>
          ClientOrderId:
            type: integer
            format: int64
            default: 0
            description: >-
              An ID supplied by the client to identify the order (like a
              purchase order number). Default is 0.
            x-gitbook-description-html: >-
              <p>An ID supplied by the client to identify the order (like a
              purchase order number). Default is 0.</p>
          OrderState:
            type: string
            enum:
              - Unknown
              - Working
              - Rejected
              - Canceled
              - Expired
              - Fully Executed
            description: >-
              The current or the latest state of the order. One of: 0 Unknown, 1
              Working, 2 Rejected, 3 Canceled, 4 Expired, 5 Fully Executed.
            x-gitbook-description-html: >-
              <p>The current or the latest state of the order. One of: 0
              Unknown, 1 Working, 2 Rejected, 3 Canceled, 4 Expired, 5 Fully
              Executed.</p>
          ReceiveTime:
            type: integer
            format: int64
            description: >-
              Time stamp of the order in POSIX format x 1000 (milliseconds since
              1/1/1970 in UTC time zone).
            x-gitbook-description-html: >-
              <p>Time stamp of the order in POSIX format x 1000 (milliseconds
              since 1/1/1970 in UTC time zone).</p>
          ReceiveTimeTicks:
            type: integer
            format: int64
            description: >-
              Time stamp of the order Microsoft Ticks format and UTC time zone.
              **Note:** Microsoft Ticks format is usually provided as a string.
              Here it is provided as a long integer.
            x-gitbook-description-html: >-
              <p>Time stamp of the order Microsoft Ticks format and UTC time
              zone. <strong>Note:</strong> Microsoft Ticks format is usually
              provided as a string. Here it is provided as a long integer.</p>
          LastUpdatedTime:
            type: integer
            format: int64
            description: >-
              Time stamp when the order was last updated, in POSIX format x 1000
              (milliseconds since 1/1/1970 in UTC time zone).
            x-gitbook-description-html: >-
              <p>Time stamp when the order was last updated, in POSIX format x
              1000 (milliseconds since 1/1/1970 in UTC time zone).</p>
          LastUpdatedTimeTicks:
            type: integer
            format: int64
            description: >-
              Time stamp when the order was last updated, in Microsoft Ticks
              format and UTC time zone. **Note:** Microsoft Ticks format is
              usually provided as a string. Here it is provided as a long
              integer.
            x-gitbook-description-html: >-
              <p>Time stamp when the order was last updated, in Microsoft Ticks
              format and UTC time zone. <strong>Note:</strong> Microsoft Ticks
              format is usually provided as a string. Here it is provided as a
              long integer.</p>
          OrigQuantity:
            type: number
            format: decimal
            description: >-
              If the open order has been changed or partially filled, this value
              shows the original quantity of the order.
            x-gitbook-description-html: >-
              <p>If the open order has been changed or partially filled, this
              value shows the original quantity of the order.</p>
          QuantityExecuted:
            type: number
            format: decimal
            description: >-
              If the open order has been at least partially executed, this value
              shows the amount that has been executed.
            x-gitbook-description-html: >-
              <p>If the open order has been at least partially executed, this
              value shows the amount that has been executed.</p>
          GrossValueExecuted:
            type: number
            format: decimal
            description: >-
              If the open order has been at least partially executed, this value
              shows the gross amount that has been executed.
            x-gitbook-description-html: >-
              <p>If the open order has been at least partially executed, this
              value shows the gross amount that has been executed.</p>
          ExecutableValue:
            type: number
            format: decimal
            description: Defaults to 0. For future provision.
            x-gitbook-description-html: <p>Defaults to 0. For future provision.</p>
          AvgPrice:
            type: number
            format: decimal
            description: The average executed price of the order.
            x-gitbook-description-html: <p>The average executed price of the order.</p>
          CounterPartyId:
            type: integer
            description: >-
              The ID of the account who is the counterparty for the trade if
              order is already executed, either partial or fully executed.
            x-gitbook-description-html: >-
              <p>The ID of the account who is the counterparty for the trade if
              order is already executed, either partial or fully executed.</p>
          ChangeReason:
            type: string
            enum:
              - Unknown
              - NewInputAccepted
              - NewInputRejected
              - OtherRejected
              - Expired
              - Trade
              - SystemCanceled_NoMoreMarket
              - SystemCanceled_BelowMinimum
              - SystemCanceled_PriceCollar
              - SystemCanceled_MarginFailed
              - UserModified
            description: >-
              If the order has been changed, this string value holds the reason.
              One of: 0 Unknown, 1 NewInputAccepted, 2 NewInputRejected, 3
              OtherRejected, 4 Expired, 5 Trade, 6 SystemCanceled_NoMoreMarket,
              7 SystemCanceled_BelowMinimum, 8 SystemCanceled_PriceCollar, 9
              SystemCanceled_MarginFailed, 100 UserModified. An order that is
              newly added to book will have **NewInputAccepted** value by
              default.
            x-gitbook-description-html: >-
              <p>If the order has been changed, this string value holds the
              reason. One of: 0 Unknown, 1 NewInputAccepted, 2 NewInputRejected,
              3 OtherRejected, 4 Expired, 5 Trade, 6
              SystemCanceled_NoMoreMarket, 7 SystemCanceled_BelowMinimum, 8
              SystemCanceled_PriceCollar, 9 SystemCanceled_MarginFailed, 100
              UserModified. An order that is newly added to book will have
              <strong>NewInputAccepted</strong> value by default.</p>
          OrigOrderId:
            type: integer
            format: int64
            description: >-
              If the order is a replacement order, this is the ID of the
              original order.
            x-gitbook-description-html: >-
              <p>If the order is a replacement order, this is the ID of the
              original order.</p>
          OrigClOrdId:
            type: integer
            format: int64
            description: >-
              If the order is a replacement order, this is the client order ID
              or the original order.
            x-gitbook-description-html: >-
              <p>If the order is a replacement order, this is the client order
              ID or the original order.</p>
          EnteredBy:
            type: integer
            description: The ID of the user who submitted the order.
            x-gitbook-description-html: <p>The ID of the user who submitted the order.</p>
          Username:
            type: string
            description: The username of the user who submitted the order.
            x-gitbook-description-html: <p>The username of the user who submitted the order.</p>
          IsQuote:
            type: boolean
            description: >-
              If this order is a quote, the value for _IsQuote_ is _true_,
              otherwise it is _false._.
            x-gitbook-description-html: >-
              <p>If this order is a quote, the value for <em>IsQuote</em> is
              <em>true</em>, otherwise it is <em>false.</em>.</p>
          InsideAsk:
            type: number
            format: decimal
            description: If this order is a quote, this value is the Inside Ask price.
            x-gitbook-description-html: >-
              <p>If this order is a quote, this value is the Inside Ask
              price.</p>
          InsideAskSize:
            type: number
            format: decimal
            description: >-
              If this order is a quote, this value is the quantity of the Inside
              Ask quote.
            x-gitbook-description-html: >-
              <p>If this order is a quote, this value is the quantity of the
              Inside Ask quote.</p>
          InsideBid:
            type: number
            format: decimal
            description: If this order is a quote, this value is the Inside Bid price.
            x-gitbook-description-html: >-
              <p>If this order is a quote, this value is the Inside Bid
              price.</p>
          InsideBidSize:
            type: number
            format: decimal
            description: >-
              If this order is a quote, this value is the quantity of the Inside
              Bid quote.
            x-gitbook-description-html: >-
              <p>If this order is a quote, this value is the quantity of the
              Inside Bid quote.</p>
          LastTradePrice:
            type: number
            format: decimal
            description: The last price that this instrument traded at.
            x-gitbook-description-html: <p>The last price that this instrument traded at.</p>
          RejectReason:
            type: string
            description: >-
              If this open order has been rejected, this string holds the reason
              for the rejection.
            x-gitbook-description-html: >-
              <p>If this open order has been rejected, this string holds the
              reason for the rejection.</p>
          IsLockedIn:
            type: boolean
            description: >-
              For a block trade, if both parties to the block trade agree that
              one of the parties will report the trade for both sides, this
              value is _true._ Othersise, _false._.
            x-gitbook-description-html: >-
              <p>For a block trade, if both parties to the block trade agree
              that one of the parties will report the trade for both sides, this
              value is <em>true.</em> Othersise, <em>false.</em>.</p>
          CancelReason:
            type: string
            description: >-
              If this order has been canceled, this string holds the
              cancellation reason.
            x-gitbook-description-html: >-
              <p>If this order has been canceled, this string holds the
              cancellation reason.</p>
          OrderFlag:
            oneOf:
              - type: integer
              - type: string
            description: >-
              One or more of:. 1 NoAccountRiskCheck. 2 AddedToBook. 4
              RemovedFromBook. 8 PostOnly. 16 Liquidation. 32
              ReverseMarginPosition.
            x-gitbook-description-html: >-
              <p>One or more of:. 1 NoAccountRiskCheck. 2 AddedToBook. 4
              RemovedFromBook. 8 PostOnly. 16 Liquidation. 32
              ReverseMarginPosition.</p>
          UseMargin:
            type: boolean
            default: false
            description: Margin is not yet supported so this always defaults to false.
            x-gitbook-description-html: >-
              <p>Margin is not yet supported so this always defaults to
              false.</p>
          StopPrice:
            type: number
            format: decimal
            description: >-
              The price at which the order executes, if the order is a stop
              order. Defaults to 0 if order is another type.
            x-gitbook-description-html: >-
              <p>The price at which the order executes, if the order is a stop
              order. Defaults to 0 if order is another type.</p>
          PegPriceType:
            type: string
            description: The type of price to peg the Stop to for Stop/Trailing orders.
            x-gitbook-description-html: >-
              <p>The type of price to peg the Stop to for Stop/Trailing
              orders.</p>
          PegOffset:
            type: number
            format: decimal
            description: >-
              Only applicable to trailing/stop orders. Defaults to 0 if order is
              another type.
            x-gitbook-description-html: >-
              <p>Only applicable to trailing/stop orders. Defaults to 0 if order
              is another type.</p>
          PegLimitOffset:
            type: number
            format: decimal
            description: >-
              Only applicable to trailing/stop orders. Defaults to 0 if order is
              another type.
            x-gitbook-description-html: >-
              <p>Only applicable to trailing/stop orders. Defaults to 0 if order
              is another type.</p>
          IpAddress:
            type: string
            description: The IP address from where the order was submitted.
            x-gitbook-description-html: <p>The IP address from where the order was submitted.</p>
          IPv6a:
            type: string
            description: >-
              **UInt64**. The IPv6 where the order was submitted from. Currently
              not being used, for future provision. Defaults to 0.
            x-gitbook-description-html: >-
              <p><strong>UInt64</strong>. The IPv6 where the order was submitted
              from. Currently not being used, for future provision. Defaults to
              0.</p>
          OMSId:
            type: integer
            description: The ID of the OMS.
            x-gitbook-description-html: <p>The ID of the OMS.</p>
        required:
          - Side
          - OrderId
          - Price
          - Quantity
          - DisplayQuantity
          - Instrument
          - Account
          - AccountName
          - OrderType
          - ClientOrderId
          - OrderState
          - ReceiveTime
          - ReceiveTimeTicks
          - LastUpdatedTime
          - LastUpdatedTimeTicks
          - OrigQuantity
          - QuantityExecuted
          - GrossValueExecuted
          - ExecutableValue
          - AvgPrice
          - CounterPartyId
          - ChangeReason
          - OrigOrderId
          - OrigClOrdId
          - EnteredBy
          - Username
          - IsQuote
          - InsideAsk
          - InsideAskSize
          - InsideBid
          - InsideBidSize
          - LastTradePrice
          - RejectReason
          - IsLockedIn
          - CancelReason
          - OrderFlag
          - UseMargin
          - StopPrice
          - PegPriceType
          - PegOffset
          - PegLimitOffset
          - IpAddress
          - IPv6a
          - IPv6a
          - OMSId
    GetOrderHistoryRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS on which the orders took place.
          x-gitbook-description-html: <p>The ID of the OMS on which the orders took place.</p>
        AccountId:
          type: integer
          description: >-
            The account ID that made the trades. A user with NotbankTrading
            permission must be associated with this account, although other
            users also can be associated with the account.
          x-gitbook-description-html: >-
            <p>The account ID that made the trades. A user with NotbankTrading
            permission must be associated with this account, although other
            users also can be associated with the account.</p>
        OrderState:
          type: string
          enum:
            - Unknown
            - Working
            - Rejected
            - Canceled
            - Expired
            - FullyExecuted
          description: >-
            The current state of the order. Can be used to filter results. If
            not specified all orders regardless of the order state will be
            returned. One of: 0 Unknown, 1 Working, 2 Rejected, 3 Canceled, 4
            Expired, 5 FullyExecuted.
          x-gitbook-description-html: >-
            <p>The current state of the order. Can be used to filter results. If
            not specified all orders regardless of the order state will be
            returned. One of: 0 Unknown, 1 Working, 2 Rejected, 3 Canceled, 4
            Expired, 5 FullyExecuted.</p>
        OrderId:
          type: integer
          format: int64
          description: >-
            The ID for the order. Can be used to filter results. Can be used to
            filter for a specific orderId. There is a specific API call
            [**GetOrderHistoryByOrderId**](#operation/GetOrderHistoryByOrderId)
            for filtering orders by **OrderId**.
          x-gitbook-description-html: >-
            <p>The ID for the order. Can be used to filter results. Can be used
            to filter for a specific orderId. There is a specific API call <a
            href="#operation/GetOrderHistoryByOrderId"><strong>GetOrderHistoryByOrderId</strong></a>
            for filtering orders by <strong>OrderId</strong>.</p>
        ClientOrderId:
          type: integer
          format: int64
          default: 0
          description: >-
            A user-assigned ID for the order (like a purchase-order number
            assigned by a company). Can be used to filter results. Default is 0.
          x-gitbook-description-html: >-
            <p>A user-assigned ID for the order (like a purchase-order number
            assigned by a company). Can be used to filter results. Default is
            0.</p>
        OriginalOrderId:
          type: integer
          format: int64
          description: >-
            The original ID of the order. If specified, the call returns changed
            orders associated with this order ID. Can be used to filter results.
          x-gitbook-description-html: >-
            <p>The original ID of the order. If specified, the call returns
            changed orders associated with this order ID. Can be used to filter
            results.</p>
        OriginalClientOrderId:
          type: integer
          format: int64
          description: >-
            If the order has been changed, shows the original client order ID, a
            value that the client can create (much like a purchase order). Can
            be used to filter results.
          x-gitbook-description-html: >-
            <p>If the order has been changed, shows the original client order
            ID, a value that the client can create (much like a purchase order).
            Can be used to filter results.</p>
        UserId:
          type: integer
          description: >-
            The ID of the user whose account orders will be returned. If not
            specified, the call returns the orders of the logged-in user. Can be
            used to filter results.
          x-gitbook-description-html: >-
            <p>The ID of the user whose account orders will be returned. If not
            specified, the call returns the orders of the logged-in user. Can be
            used to filter results.</p>
        InstrumentId:
          type: integer
          format: int64
          description: >-
            The ID of the instrument named in the order. If not specified, the
            call returns orders for all instruments traded by this account. Can
            be used to filter results.
          x-gitbook-description-html: >-
            <p>The ID of the instrument named in the order. If not specified,
            the call returns orders for all instruments traded by this account.
            Can be used to filter results.</p>
        StartTimestamp:
          type: integer
          format: int64
          description: >-
            Date and time at which to begin the orders history, in POSIX format.
            Can be used to filter results.
          x-gitbook-description-html: >-
            <p>Date and time at which to begin the orders history, in POSIX
            format. Can be used to filter results.</p>
        EndTimestamp:
          type: integer
          format: int64
          description: >-
            Date and time at which to end the orders report, in POSIX format.
            Can be used to filter results.
          x-gitbook-description-html: >-
            <p>Date and time at which to end the orders report, in POSIX format.
            Can be used to filter results.</p>
        Depth:
          type: integer
          description: >-
            In this case, the maximum number/count of orders to return, counting
            from the _StartIndex_ if it is also specified. If not specified,
            returns 100 most recent orders; results can vary depending if other
            optional fields are defined such as _StartIndex_, _StartTimestamp_,
            and _EndTimestamp_. Can be used to filter results and for
            pagination.
          x-gitbook-description-html: >-
            <p>In this case, the maximum number/count of orders to return,
            counting from the <em>StartIndex</em> if it is also specified. If
            not specified, returns 100 most recent orders; results can vary
            depending if other optional fields are defined such as
            <em>StartIndex</em>, <em>StartTimestamp</em>, and
            <em>EndTimestamp</em>. Can be used to filter results and for
            pagination.</p>
        Limit:
          type: integer
          description: Functions exactly the same as the **Depth** field.
          x-gitbook-description-html: >-
            <p>Functions exactly the same as the <strong>Depth</strong>
            field.</p>
        StartIndex:
          type: integer
          default: 0
          description: >-
            A value of 0 means the first object in the result will be the the
            most recent order, a value of 2 means that the first object in the
            result set will be the third most recent order. Can be used to
            filter results or for pagination. Default is 0.
          x-gitbook-description-html: >-
            <p>A value of 0 means the first object in the result will be the the
            most recent order, a value of 2 means that the first object in the
            result set will be the third most recent order. Can be used to
            filter results or for pagination. Default is 0.</p>
      required:
        - OMSId
        - AccountId
    GetOrderHistoryResponse:
      type: array
      items:
        type: object
        properties:
          Side:
            type: string
            enum:
              - Buy
              - Sell
            description: 'The side of a trade. One of: 0 Buy, 1 Sell.'
            x-gitbook-description-html: '<p>The side of a trade. One of: 0 Buy, 1 Sell.</p>'
          OrderId:
            type: integer
            format: int64
            description: The ID of the open order. The _OrderID_ is unique in each OMS.
            x-gitbook-description-html: >-
              <p>The ID of the open order. The <em>OrderID</em> is unique in
              each OMS.</p>
          Price:
            type: number
            format: decimal
            description: The price at which the buy or sell has been ordered.
            x-gitbook-description-html: <p>The price at which the buy or sell has been ordered.</p>
          Quantity:
            type: number
            format: decimal
            description: The quantity of the product to be bought or sold.
            x-gitbook-description-html: <p>The quantity of the product to be bought or sold.</p>
          DisplayQuantity:
            type: number
            format: decimal
            description: >-
              The quantity available to buy or sell that is publicly displayed
              to the market. To display a _displayQuantity_ value, an order must
              be a Limit order with a reserve.
            x-gitbook-description-html: >-
              <p>The quantity available to buy or sell that is publicly
              displayed to the market. To display a <em>displayQuantity</em>
              value, an order must be a Limit order with a reserve.</p>
          Instrument:
            type: integer
            description: >-
              The ID of the instrument being traded. The call
              [**GetInstruments**](#operation/GetInstruments) can supply the
              instrument IDs that are available.
            x-gitbook-description-html: >-
              <p>The ID of the instrument being traded. The call <a
              href="#operation/GetInstruments"><strong>GetInstruments</strong></a>
              can supply the instrument IDs that are available.</p>
          Account:
            type: integer
            description: The ID of the of the account which the order belongs to.
            x-gitbook-description-html: <p>The ID of the of the account which the order belongs to.</p>
          AccountName:
            type: string
            description: Name of the of the account which which the order belongs to.
            x-gitbook-description-html: >-
              <p>Name of the of the account which which the order belongs
              to.</p>
          OrderType:
            type: string
            enum:
              - Unknown an error condition
              - Market order
              - Limit
              - StopMarket
              - StopLimit
              - TrailingStopMarket
              - TrailingStopLimit
              - BlockTrade
            description: >-
              Describes the type of order this is. One of: 0 Unknown (an error
              condition), 1 Market order, 2 Limit, 3 StopMarket, 4 StopLimit, 5
              TrailingStopMarket, 6 TrailingStopLimit, 7 BlockTrade.
            x-gitbook-description-html: >-
              <p>Describes the type of order this is. One of: 0 Unknown (an
              error condition), 1 Market order, 2 Limit, 3 StopMarket, 4
              StopLimit, 5 TrailingStopMarket, 6 TrailingStopLimit, 7
              BlockTrade.</p>
          ClientOrderId:
            type: integer
            format: int64
            default: 0
            description: >-
              An ID supplied by the client to identify the order (like a
              purchase order number). Default is 0.
            x-gitbook-description-html: >-
              <p>An ID supplied by the client to identify the order (like a
              purchase order number). Default is 0.</p>
          OrderState:
            type: string
            enum:
              - Unknown
              - Working
              - Rejected
              - Canceled
              - Expired
              - Fully Executed
            description: >-
              The current or the latest state of the order. One of: 0 Unknown, 1
              Working, 2 Rejected, 3 Canceled, 4 Expired, 5 Fully Executed.
            x-gitbook-description-html: >-
              <p>The current or the latest state of the order. One of: 0
              Unknown, 1 Working, 2 Rejected, 3 Canceled, 4 Expired, 5 Fully
              Executed.</p>
          ReceiveTime:
            type: integer
            format: int64
            description: >-
              Time stamp of the order in POSIX format x 1000 (milliseconds since
              1/1/1970 in UTC time zone).
            x-gitbook-description-html: >-
              <p>Time stamp of the order in POSIX format x 1000 (milliseconds
              since 1/1/1970 in UTC time zone).</p>
          ReceiveTimeTicks:
            type: integer
            format: int64
            description: >-
              Time stamp of the order Microsoft Ticks format and UTC time zone.
              **Note:** Microsoft Ticks format is usually provided as a string.
              Here it is provided as a long integer.
            x-gitbook-description-html: >-
              <p>Time stamp of the order Microsoft Ticks format and UTC time
              zone. <strong>Note:</strong> Microsoft Ticks format is usually
              provided as a string. Here it is provided as a long integer.</p>
          LastUpdatedTime:
            type: integer
            format: int64
            description: >-
              Time stamp when the order was last updated, in POSIX format x 1000
              (milliseconds since 1/1/1970 in UTC time zone).
            x-gitbook-description-html: >-
              <p>Time stamp when the order was last updated, in POSIX format x
              1000 (milliseconds since 1/1/1970 in UTC time zone).</p>
          LastUpdatedTimeTicks:
            type: integer
            format: int64
            description: >-
              Time stamp when the order was last updated, in Microsoft Ticks
              format and UTC time zone. **Note:** Microsoft Ticks format is
              usually provided as a string. Here it is provided as a long
              integer.
            x-gitbook-description-html: >-
              <p>Time stamp when the order was last updated, in Microsoft Ticks
              format and UTC time zone. <strong>Note:</strong> Microsoft Ticks
              format is usually provided as a string. Here it is provided as a
              long integer.</p>
          OrigQuantity:
            type: number
            format: decimal
            description: >-
              If the open order has been changed or partially filled, this value
              shows the original quantity of the order.
            x-gitbook-description-html: >-
              <p>If the open order has been changed or partially filled, this
              value shows the original quantity of the order.</p>
          QuantityExecuted:
            type: number
            format: decimal
            description: >-
              If the open order has been at least partially executed, this value
              shows the amount that has been executed.
            x-gitbook-description-html: >-
              <p>If the open order has been at least partially executed, this
              value shows the amount that has been executed.</p>
          GrossValueExecuted:
            type: number
            format: decimal
            description: >-
              If the open order has been at least partially executed, this value
              shows the gross amount that has been executed.
            x-gitbook-description-html: >-
              <p>If the open order has been at least partially executed, this
              value shows the gross amount that has been executed.</p>
          ExecutableValue:
            type: number
            format: decimal
            description: Defaults to 0. For future provision.
            x-gitbook-description-html: <p>Defaults to 0. For future provision.</p>
          AvgPrice:
            type: number
            format: decimal
            description: The average executed price of the order.
            x-gitbook-description-html: <p>The average executed price of the order.</p>
          CounterPartyId:
            type: integer
            description: >-
              The ID of the account who is the counterparty for the trade if
              order is already executed, either partial or fully executed.
            x-gitbook-description-html: >-
              <p>The ID of the account who is the counterparty for the trade if
              order is already executed, either partial or fully executed.</p>
          ChangeReason:
            type: string
            enum:
              - Unknown
              - NewInputAccepted
              - NewInputRejected
              - OtherRejected
              - Expired
              - Trade
              - SystemCanceled_NoMoreMarket
              - SystemCanceled_BelowMinimum
              - SystemCanceled_PriceCollar
              - SystemCanceled_MarginFailed
              - UserModified
            description: >-
              If the order has been changed, this string value holds the reason.
              One of: 0 Unknown, 1 NewInputAccepted, 2 NewInputRejected, 3
              OtherRejected, 4 Expired, 5 Trade, 6 SystemCanceled_NoMoreMarket,
              7 SystemCanceled_BelowMinimum, 8 SystemCanceled_PriceCollar, 9
              SystemCanceled_MarginFailed, 100 UserModified. An order that is
              newly added to book will have **NewInputAccepted** value by
              default.
            x-gitbook-description-html: >-
              <p>If the order has been changed, this string value holds the
              reason. One of: 0 Unknown, 1 NewInputAccepted, 2 NewInputRejected,
              3 OtherRejected, 4 Expired, 5 Trade, 6
              SystemCanceled_NoMoreMarket, 7 SystemCanceled_BelowMinimum, 8
              SystemCanceled_PriceCollar, 9 SystemCanceled_MarginFailed, 100
              UserModified. An order that is newly added to book will have
              <strong>NewInputAccepted</strong> value by default.</p>
          OrigOrderId:
            type: integer
            format: int64
            description: >-
              If the order is a replacement order, this is the ID of the
              original order.
            x-gitbook-description-html: >-
              <p>If the order is a replacement order, this is the ID of the
              original order.</p>
          OrigClOrdId:
            type: integer
            format: int64
            description: >-
              If the order is a replacement order, this is the client order ID
              or the original order.
            x-gitbook-description-html: >-
              <p>If the order is a replacement order, this is the client order
              ID or the original order.</p>
          EnteredBy:
            type: integer
            description: The ID of the user who submitted the order.
            x-gitbook-description-html: <p>The ID of the user who submitted the order.</p>
          Username:
            type: string
            description: The username of the user who submitted the order.
            x-gitbook-description-html: <p>The username of the user who submitted the order.</p>
          IsQuote:
            type: boolean
            description: >-
              If this order is a quote, the value for _IsQuote_ is _true_,
              otherwise it is _false._.
            x-gitbook-description-html: >-
              <p>If this order is a quote, the value for <em>IsQuote</em> is
              <em>true</em>, otherwise it is <em>false.</em>.</p>
          InsideAsk:
            type: number
            format: decimal
            description: If this order is a quote, this value is the Inside Ask price.
            x-gitbook-description-html: >-
              <p>If this order is a quote, this value is the Inside Ask
              price.</p>
          InsideAskSize:
            type: number
            format: decimal
            description: >-
              If this order is a quote, this value is the quantity of the Inside
              Ask quote.
            x-gitbook-description-html: >-
              <p>If this order is a quote, this value is the quantity of the
              Inside Ask quote.</p>
          InsideBid:
            type: number
            format: decimal
            description: If this order is a quote, this value is the Inside Bid price.
            x-gitbook-description-html: >-
              <p>If this order is a quote, this value is the Inside Bid
              price.</p>
          InsideBidSize:
            type: number
            format: decimal
            description: >-
              If this order is a quote, this value is the quantity of the Inside
              Bid quote.
            x-gitbook-description-html: >-
              <p>If this order is a quote, this value is the quantity of the
              Inside Bid quote.</p>
          LastTradePrice:
            type: number
            format: decimal
            description: The last price that this instrument traded at.
            x-gitbook-description-html: <p>The last price that this instrument traded at.</p>
          RejectReason:
            type: string
            description: >-
              If this open order has been rejected, this string holds the reason
              for the rejection.
            x-gitbook-description-html: >-
              <p>If this open order has been rejected, this string holds the
              reason for the rejection.</p>
          IsLockedIn:
            type: boolean
            description: >-
              For a block trade, if both parties to the block trade agree that
              one of the parties will report the trade for both sides, this
              value is _true._ Othersise, _false._.
            x-gitbook-description-html: >-
              <p>For a block trade, if both parties to the block trade agree
              that one of the parties will report the trade for both sides, this
              value is <em>true.</em> Othersise, <em>false.</em>.</p>
          CancelReason:
            type: string
            description: >-
              If this order has been canceled, this string holds the
              cancellation reason.
            x-gitbook-description-html: >-
              <p>If this order has been canceled, this string holds the
              cancellation reason.</p>
          OrderFlag:
            oneOf:
              - type: integer
              - type: string
            description: >-
              One or more of:. 1 NoAccountRiskCheck. 2 AddedToBook. 4
              RemovedFromBook. 8 PostOnly. 16 Liquidation. 32
              ReverseMarginPosition.
            x-gitbook-description-html: >-
              <p>One or more of:. 1 NoAccountRiskCheck. 2 AddedToBook. 4
              RemovedFromBook. 8 PostOnly. 16 Liquidation. 32
              ReverseMarginPosition.</p>
          UseMargin:
            type: boolean
            default: false
            description: Margin is not yet supported so this always defaults to false.
            x-gitbook-description-html: >-
              <p>Margin is not yet supported so this always defaults to
              false.</p>
          StopPrice:
            type: number
            format: decimal
            description: >-
              The price at which the order executes, if the order is a stop
              order. Defaults to 0 if order is another type.
            x-gitbook-description-html: >-
              <p>The price at which the order executes, if the order is a stop
              order. Defaults to 0 if order is another type.</p>
          PegPriceType:
            type: string
            description: The type of price to peg the Stop to for Stop/Trailing orders.
            x-gitbook-description-html: >-
              <p>The type of price to peg the Stop to for Stop/Trailing
              orders.</p>
          PegOffset:
            type: number
            format: decimal
            description: >-
              Only applicable to trailing/stop orders. Defaults to 0 if order is
              another type.
            x-gitbook-description-html: >-
              <p>Only applicable to trailing/stop orders. Defaults to 0 if order
              is another type.</p>
          PegLimitOffset:
            type: number
            format: decimal
            description: >-
              Only applicable to trailing/stop orders. Defaults to 0 if order is
              another type.
            x-gitbook-description-html: >-
              <p>Only applicable to trailing/stop orders. Defaults to 0 if order
              is another type.</p>
          IpAddress:
            type: string
            description: The IP address from where the order was submitted.
            x-gitbook-description-html: <p>The IP address from where the order was submitted.</p>
          IPv6a:
            type: string
            description: >-
              **UInt64**. The IPv6 where the order was submitted from. Currently
              not being used, for future provision. Defaults to 0.
            x-gitbook-description-html: >-
              <p><strong>UInt64</strong>. The IPv6 where the order was submitted
              from. Currently not being used, for future provision. Defaults to
              0.</p>
          OMSId:
            type: integer
            description: The ID of the OMS.
            x-gitbook-description-html: <p>The ID of the OMS.</p>
        required:
          - Side
          - OrderId
          - Price
          - Quantity
          - DisplayQuantity
          - Instrument
          - Account
          - AccountName
          - OrderType
          - ClientOrderId
          - OrderState
          - ReceiveTime
          - ReceiveTimeTicks
          - LastUpdatedTime
          - LastUpdatedTimeTicks
          - OrigQuantity
          - QuantityExecuted
          - GrossValueExecuted
          - ExecutableValue
          - AvgPrice
          - CounterPartyId
          - ChangeReason
          - OrigOrderId
          - OrigClOrdId
          - EnteredBy
          - Username
          - IsQuote
          - InsideAsk
          - InsideAskSize
          - InsideBid
          - InsideBidSize
          - LastTradePrice
          - RejectReason
          - IsLockedIn
          - CancelReason
          - OrderFlag
          - UseMargin
          - StopPrice
          - PegPriceType
          - PegOffset
          - PegLimitOffset
          - IpAddress
          - IPv6a
          - IPv6a
          - OMSId
    SendOrderRequest:
      type: object
      properties:
        InstrumentId:
          type: integer
          description: The ID of the instrument being traded.
          x-gitbook-description-html: <p>The ID of the instrument being traded.</p>
        OMSId:
          type: integer
          description: The ID of the OMS on which the instrument is being traded.
          x-gitbook-description-html: <p>The ID of the OMS on which the instrument is being traded.</p>
        AccountId:
          type: integer
          description: The ID of the account the order will be placed for.
          x-gitbook-description-html: <p>The ID of the account the order will be placed for.</p>
        TimeInForce:
          type: integer
          enum:
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
          description: >-
            An integer that represents the period during which the new order is
            executable. One of: **0** Unknown (an error condition), **1** GTC
            (good 'til canceled, the default), **2** OPG (execute as close to
            opening price as possible: not yet used, for future provision),
            **3** IOC (immediate or canceled), **4** FOK (fill-or-kill &mdash;
            fill immediately or kill immediately), **5** GTX (good 'til
            executed: not yet used, for future provision), **6** GTD (good 'til
            date: not yet used, for future provision).
          x-gitbook-description-html: >-
            <p>An integer that represents the period during which the new order
            is executable. One of: <strong>0</strong> Unknown (an error
            condition), <strong>1</strong> GTC (good 'til canceled, the
            default), <strong>2</strong> OPG (execute as close to opening price
            as possible: not yet used, for future provision), <strong>3</strong>
            IOC (immediate or canceled), <strong>4</strong> FOK (fill-or-kill —
            fill immediately or kill immediately), <strong>5</strong> GTX (good
            'til executed: not yet used, for future provision),
            <strong>6</strong> GTD (good 'til date: not yet used, for future
            provision).</p>
        ClientOrderId:
          type: integer
          format: int64
          default: 0
          description: >-
            A user-assigned ID for the order (like a purchase-order number
            assigned by a company). This ID is useful for recognizing future
            states related to this order. Duplicate client orderid of two open
            orders of the same account is not allowed, the incoming order with
            the same ClientOrderId will get rejected. Default is 0.
          x-gitbook-description-html: >-
            <p>A user-assigned ID for the order (like a purchase-order number
            assigned by a company). This ID is useful for recognizing future
            states related to this order. Duplicate client orderid of two open
            orders of the same account is not allowed, the incoming order with
            the same ClientOrderId will get rejected. Default is 0.</p>
        OrderIdOCO:
          type: integer
          format: int64
          description: >-
            The order ID if One Cancels the Other — If this order is order A,
            _OrderIdOCO_ refers to the order ID of an order B (which is _not_
            the order being created by this call). If order B executes, then
            order A created by this call is canceled. You can also set up order
            B to watch order A in the same way, but that may require an update
            to order B to make it watch this one, which could have implications
            for priority in the order book. See
            [**CancelReplaceOrder**](#operation/CancelReplaceOrder) and
            [**ModifyOrder**](#operation/ModifyOrder).
          x-gitbook-description-html: >-
            <p>The order ID if One Cancels the Other — If this order is order A,
            <em>OrderIdOCO</em> refers to the order ID of an order B (which is
            <em>not</em> the order being created by this call). If order B
            executes, then order A created by this call is canceled. You can
            also set up order B to watch order A in the same way, but that may
            require an update to order B to make it watch this one, which could
            have implications for priority in the order book. See <a
            href="#operation/CancelReplaceOrder"><strong>CancelReplaceOrder</strong></a>
            and <a
            href="#operation/ModifyOrder"><strong>ModifyOrder</strong></a>.</p>
        UseDisplayQuantity:
          type: boolean
          default: false
          description: >-
            If you enter a Limit order with a reserve (reserve order), you must
            set _UseDisplayQuantity_ to _true_ else, the quantity of your order
            will be 0, defaults to **false**.
          x-gitbook-description-html: >-
            <p>If you enter a Limit order with a reserve (reserve order), you
            must set <em>UseDisplayQuantity</em> to <em>true</em> else, the
            quantity of your order will be 0, defaults to
            <strong>false</strong>.</p>
        Side:
          type: integer
          enum:
            - 0
            - 1
          description: >-
            A number representing the side of a trade. One of: **0** Buy, **1**
            Sell.
          x-gitbook-description-html: >-
            <p>A number representing the side of a trade. One of:
            <strong>0</strong> Buy, <strong>1</strong> Sell.</p>
        Quantity:
          type: number
          format: decimal
          description: >-
            The quantity of the instrument being ordered. Not required if
            **OrderType** is Market (1) and as long as **Value** is defined.
          x-gitbook-description-html: >-
            <p>The quantity of the instrument being ordered. Not required if
            <strong>OrderType</strong> is Market (1) and as long as
            <strong>Value</strong> is defined.</p>
        OrderType:
          type: integer
          enum:
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
          description: >-
            The type of the order. One of: **0** Unknown, **1** Market, **2**
            Limit, **3** StopMarket, **4** StopLimit, **5** TrailingStopMarket,
            **6** TrailingStopLimit, **7** BlockTrade.
          x-gitbook-description-html: >-
            <p>The type of the order. One of: <strong>0</strong> Unknown,
            <strong>1</strong> Market, <strong>2</strong> Limit,
            <strong>3</strong> StopMarket, <strong>4</strong> StopLimit,
            <strong>5</strong> TrailingStopMarket, <strong>6</strong>
            TrailingStopLimit, <strong>7</strong> BlockTrade.</p>
        PegPriceType:
          oneOf:
            - type: integer
            - type: string
          enum:
            - 1
            - 2
            - 3
            - 4
          default: 1
          description: >-
            Only applicable to TrailingStop and Stop orders. The type of price
            that pegs the stop. One of: 1 Last, 2 Bid, 3 Ask, 4 Midpoint
            (Currently unsupported; for future provision). Default is 1 Last.
          x-gitbook-description-html: >-
            <p>Only applicable to TrailingStop and Stop orders. The type of
            price that pegs the stop. One of: 1 Last, 2 Bid, 3 Ask, 4 Midpoint
            (Currently unsupported; for future provision). Default is 1
            Last.</p>
        LimitPrice:
          type: number
          format: decimal
          description: >-
            The price at which the order will be placed. Required if OrderType
            is **2 Limit** or **4 StopLimit** or **7 TrailingStopLimit**.
          x-gitbook-description-html: >-
            <p>The price at which the order will be placed. Required if
            OrderType is <strong>2 Limit</strong> or <strong>4
            StopLimit</strong> or <strong>7 TrailingStopLimit</strong>.</p>
        StopPrice:
          type: number
          format: decimal
          default: 0
          description: >-
            Applicable to TrailingStop (Limit and Market) and Stop (Limit and
            Market) orders only; the price at which the order will get
            activated. Is not required to be defined for TrailingStop order as
            this price will be determined automatically based on the
            **TrailingAmount**, **PegPriceType** and most importantly the
            movement of the price where the order is pegged (**PegPriceType**).
            Default is 0.
          x-gitbook-description-html: >-
            <p>Applicable to TrailingStop (Limit and Market) and Stop (Limit and
            Market) orders only; the price at which the order will get
            activated. Is not required to be defined for TrailingStop order as
            this price will be determined automatically based on the
            <strong>TrailingAmount</strong>, <strong>PegPriceType</strong> and
            most importantly the movement of the price where the order is pegged
            (<strong>PegPriceType</strong>). Default is 0.</p>
        TrailingAmount:
          type: number
          format: decimal
          description: >-
            Applicable to TrailingStopLimit and TrailingStopMarket orders only;
            a number that will be either added to (buy side) or subtracted from
            (sell side) the price where the order is pegged(depends on the
            **PegPriceType**); the sum or the difference will be the
            **StopPrice** of the **TrailingStop** order. On the buy side, if the
            price where the order is pegged increases and never goes down below
            the value when the order was placed, the resulting StopPrice will be
            the sum of the price where the order is pegged during submission and
            the TrailingAmount; however, if the price where the order is pegged
            decreases, the StopPrice will change, it will be the sum of the
            whatever is the lowest value the pegged price will have and the
            TrailingAmount: the logic on the sell side is the opposite.
          x-gitbook-description-html: >-
            <p>Applicable to TrailingStopLimit and TrailingStopMarket orders
            only; a number that will be either added to (buy side) or subtracted
            from (sell side) the price where the order is pegged(depends on the
            <strong>PegPriceType</strong>); the sum or the difference will be
            the <strong>StopPrice</strong> of the <strong>TrailingStop</strong>
            order. On the buy side, if the price where the order is pegged
            increases and never goes down below the value when the order was
            placed, the resulting StopPrice will be the sum of the price where
            the order is pegged during submission and the TrailingAmount;
            however, if the price where the order is pegged decreases, the
            StopPrice will change, it will be the sum of the whatever is the
            lowest value the pegged price will have and the TrailingAmount: the
            logic on the sell side is the opposite.</p>
        LimitOffset:
          type: number
          format: decimal
          description: >-
            Applicable to TrailingStopLimit only; a number that will be either
            added (buy side) or subtracted (sell side) to the **StopPrice**, the
            sum or the difference will be the LimitPrice of the order when it
            gets activated.
          x-gitbook-description-html: >-
            <p>Applicable to TrailingStopLimit only; a number that will be
            either added (buy side) or subtracted (sell side) to the
            <strong>StopPrice</strong>, the sum or the difference will be the
            LimitPrice of the order when it gets activated.</p>
        DisplayQuantity:
          type: integer
          description: >-
            If _UseDisplayQuantity_ is set to _true_, you must set a value of
            this field greater than 0, else, order will not appear in the
            orderbook.
          x-gitbook-description-html: >-
            <p>If <em>UseDisplayQuantity</em> is set to <em>true</em>, you must
            set a value of this field greater than 0, else, order will not
            appear in the orderbook.</p>
        Value:
          type: number
          format: decimal
          description: >-
            The total value of the trade. Only applicable in a market order
            type: a user can opt to input a value instead of defining the
            quantity which will then be automatically calculated:
            value/marketprice.
          x-gitbook-description-html: >-
            <p>The total value of the trade. Only applicable in a market order
            type: a user can opt to input a value instead of defining the
            quantity which will then be automatically calculated:
            value/marketprice.</p>
        PostOlny:
          type: boolean
          description: If the order is post only.
          x-gitbook-description-html: <p>If the order is post only.</p>
      required:
        - InstrumentId
        - OMSId
        - AccountId
        - TimeInForce
        - Side
        - Quantity
        - OrderType
        - LimitPrice
        - StopPrice
        - TrailingAmount
        - LimitOffset
    SendOrderResponse:
      type: object
      properties:
        status:
          type: string
          description: >-
            If the order is accepted by the system, it returns "Accepted," if
            not it returns "Rejected.". Accepted. Rejected.
          x-gitbook-description-html: >-
            <p>If the order is accepted by the system, it returns "Accepted," if
            not it returns "Rejected.". Accepted. Rejected.</p>
        errormsg:
          type: string
          description: Any error message the server returns.
          x-gitbook-description-html: <p>Any error message the server returns.</p>
        OrderId:
          type: integer
          format: int64
          description: >-
            The ID assigned to the order by the server. This allows you to track
            the order.
          x-gitbook-description-html: >-
            <p>The ID assigned to the order by the server. This allows you to
            track the order.</p>
      required:
        - status
        - errormsg
        - OrderId
    CancelReplaceOrderRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: >-
            The ID of the OMS on which the order is being canceled and replaced
            by another order.
          x-gitbook-description-html: >-
            <p>The ID of the OMS on which the order is being canceled and
            replaced by another order.</p>
        OrderIdToReplace:
          type: integer
          format: int64
          description: The ID of the order to replace with this order.
          x-gitbook-description-html: <p>The ID of the order to replace with this order.</p>
        ClientOrderId:
          type: integer
          format: int64
          default: 0
          description: >-
            A user-assigned ID for the new, replacement order (like a
            purchase-order number assigned by a company). This ID is useful for
            recognizing future states related to this order. Default is 0.
          x-gitbook-description-html: >-
            <p>A user-assigned ID for the new, replacement order (like a
            purchase-order number assigned by a company). This ID is useful for
            recognizing future states related to this order. Default is 0.</p>
        OrderType:
          oneOf:
            - type: integer
            - type: string
          enum:
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
          description: >-
            The type of the replacement order. One of: 0 Unknown, 1 Market, 2
            Limit, 3 StopMarket, 4 StopLimit, 5 TrailingStopMarket, 6
            TrailingStopLimit, 7 BlockTrade.
          x-gitbook-description-html: >-
            <p>The type of the replacement order. One of: 0 Unknown, 1 Market, 2
            Limit, 3 StopMarket, 4 StopLimit, 5 TrailingStopMarket, 6
            TrailingStopLimit, 7 BlockTrade.</p>
        Side:
          oneOf:
            - type: integer
            - type: string
          enum:
            - 0
            - 1
            - 2
            - 3
          description: >-
            The side of the replacement order. One of: 0 Buy, 1 Sell, 2
            Short(reserved for future use), 3 Unknown (an error condition).
          x-gitbook-description-html: >-
            <p>The side of the replacement order. One of: 0 Buy, 1 Sell, 2
            Short(reserved for future use), 3 Unknown (an error condition).</p>
        AccountId:
          type: integer
          description: >-
            The ID of the account under which the original order was placed and
            the new order will be placed. If AccountId will not match the one on
            the order to be replaced, request will fail.
          x-gitbook-description-html: >-
            <p>The ID of the account under which the original order was placed
            and the new order will be placed. If AccountId will not match the
            one on the order to be replaced, request will fail.</p>
        InstrumentId:
          type: integer
          description: >-
            The ID of the instrument being traded. Must be identical with the
            instrument ID of the order to be replaced, else, request will fail.
          x-gitbook-description-html: >-
            <p>The ID of the instrument being traded. Must be identical with the
            instrument ID of the order to be replaced, else, request will
            fail.</p>
        UseDisplayQuantity:
          type: boolean
          description: >-
            The display quantity is the quantity of a product shown to the
            market to buy or sell. A larger quantity may be wanted or available,
            but it may disadvantageous to display it when buying or selling. The
            display quantity is set when placing an order (using
            [**SendOrder**](#operation/SendOrder) or
            [**CancelReplaceOrder**](#operation/CancelReplaceOrder) for
            instance). If you enter a Limit order with reserve, you must set
            _useDisplayQuantity_ to _true_.
          x-gitbook-description-html: >-
            <p>The display quantity is the quantity of a product shown to the
            market to buy or sell. A larger quantity may be wanted or available,
            but it may disadvantageous to display it when buying or selling. The
            display quantity is set when placing an order (using <a
            href="#operation/SendOrder"><strong>SendOrder</strong></a> or <a
            href="#operation/CancelReplaceOrder"><strong>CancelReplaceOrder</strong></a>
            for instance). If you enter a Limit order with reserve, you must set
            <em>useDisplayQuantity</em> to <em>true</em>.</p>
        DisplayQuantity:
          type: number
          format: decimal
          description: >-
            The quantity of a product that is available to buy or sell that is
            publicly displayed to the market. Needs to be defined with a value
            greater than 0 if **UseDisplayQuantity** is set to true, otherwise
            new order will not be visible in the orderbook.
          x-gitbook-description-html: >-
            <p>The quantity of a product that is available to buy or sell that
            is publicly displayed to the market. Needs to be defined with a
            value greater than 0 if <strong>UseDisplayQuantity</strong> is set
            to true, otherwise new order will not be visible in the
            orderbook.</p>
        LimitPrice:
          type: number
          format: decimal
          description: >-
            The price at which to execute the new order, if the new order is a
            limit order.
          x-gitbook-description-html: >-
            <p>The price at which to execute the new order, if the new order is
            a limit order.</p>
        StopPrice:
          type: number
          format: decimal
          description: >-
            The price at which to execute the new order, if the order is a stop
            order.
          x-gitbook-description-html: >-
            <p>The price at which to execute the new order, if the order is a
            stop order.</p>
        ReferencePrice:
          type: number
          format: decimal
          description: The reference price of the instrument in the order.
          x-gitbook-description-html: <p>The reference price of the instrument in the order.</p>
        PegPriceType:
          oneOf:
            - type: integer
            - type: string
          enum:
            - 1
            - 2
            - 3
            - 4
          description: >-
            When entering a stop/trailing order, set PegPriceType to the type of
            price that pegs the stop. One of: 1 Last, 2 Bid, 3 Ask, 4 Midpoint.
          x-gitbook-description-html: >-
            <p>When entering a stop/trailing order, set PegPriceType to the type
            of price that pegs the stop. One of: 1 Last, 2 Bid, 3 Ask, 4
            Midpoint.</p>
        TimeInForce:
          oneOf:
            - type: integer
            - type: string
          enum:
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
          description: >-
            The period during which the new order is executable. One of: 0
            Unknown (an error condition), 1 GTC (good 'til canceled, the
            default), 2 OPG (execute as close to opening price as possible: not
            yet used, for future provision), 3 IOC (immediate or canceled), 4
            FOK (fill or kill &mdash; fill the order immediately, or cancel it
            immediately), 5 GTX (good 'til executed: not yet used, for future
            provision), 6 GTD (good 'til date: not yet used, for future
            provision).  The string value or the equivalent integer value can be
            used.
          x-gitbook-description-html: >-
            <p>The period during which the new order is executable. One of: 0
            Unknown (an error condition), 1 GTC (good 'til canceled, the
            default), 2 OPG (execute as close to opening price as possible: not
            yet used, for future provision), 3 IOC (immediate or canceled), 4
            FOK (fill or kill — fill the order immediately, or cancel it
            immediately), 5 GTX (good 'til executed: not yet used, for future
            provision), 6 GTD (good 'til date: not yet used, for future
            provision).  The string value or the equivalent integer value can be
            used.</p>
        OrderIdOCO:
          type: integer
          format: int64
          description: >-
            One Cancels the Other — If the order being canceled in this call is
            order A, and the order replacing order A in this call is order B,
            then _OrderIdOCO_ refers to an order C that is currently open. If
            order C executes, then order B is canceled. You can also set up
            order C to watch order B in this way, but that will require an
            update to order C.
          x-gitbook-description-html: >-
            <p>One Cancels the Other — If the order being canceled in this call
            is order A, and the order replacing order A in this call is order B,
            then <em>OrderIdOCO</em> refers to an order C that is currently
            open. If order C executes, then order B is canceled. You can also
            set up order C to watch order B in this way, but that will require
            an update to order C.</p>
        Quantity:
          type: number
          format: decimal
          default: 0
          description: >-
            The amount of the order (either buy or sell). Not explicitly
            required but defaults to 0 when not defined, so it makes sense to be
            set greater than 0.
          x-gitbook-description-html: >-
            <p>The amount of the order (either buy or sell). Not explicitly
            required but defaults to 0 when not defined, so it makes sense to be
            set greater than 0.</p>
      required:
        - OMSId
        - OrderIdToReplace
        - OrderType
        - Side
        - AccountId
        - InstrumentId
        - UseDisplayQuantity
        - DisplayQuantity
        - LimitPrice
        - StopPrice
        - PegPriceType
        - TimeInForce
        - Quantity
    CancelReplaceOrderResponse:
      type: object
      properties:
        replacementOrderId:
          type: integer
          description: The order ID assigned to the replacement order by the server.
          x-gitbook-description-html: <p>The order ID assigned to the replacement order by the server.</p>
        replacementClOrdId:
          type: integer
          format: int64
          description: Echoes the contents of the _clientOrderId_ value from the request.
          x-gitbook-description-html: >-
            <p>Echoes the contents of the <em>clientOrderId</em> value from the
            request.</p>
        origOrderId:
          type: integer
          description: >-
            Echoes _orderIdToReplace_, which is the original order you are
            replacing.
          x-gitbook-description-html: >-
            <p>Echoes <em>orderIdToReplace</em>, which is the original order you
            are replacing.</p>
        origClOrdId:
          type: integer
          format: int64
          description: >-
            Provides the client order ID of the original order (not specified in
            the requesting call).
          x-gitbook-description-html: >-
            <p>Provides the client order ID of the original order (not specified
            in the requesting call).</p>
      required:
        - replacementOrderId
        - replacementClOrdId
        - origOrderId
        - origClOrdId
    CancelOrderRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS on which the order exists.
          x-gitbook-description-html: <p>The ID of the OMS on which the order exists.</p>
        AccountId:
          type: integer
          description: The ID of the account under which the order was placed.
          x-gitbook-description-html: <p>The ID of the account under which the order was placed.</p>
        OrderId:
          type: integer
          format: int64
          description: The order to be canceled.
          x-gitbook-description-html: <p>The order to be canceled.</p>
      required:
        - OMSId
        - AccountId
        - OrderId
    CancelOrderResponse:
      type: object
      properties:
        result:
          type: boolean
          description: >-
            Returns _true_ if the call to cancel the order has been successfully
            received, otherwise returns _false_.
          x-gitbook-description-html: >-
            <p>Returns <em>true</em> if the call to cancel the order has been
            successfully received, otherwise returns <em>false</em>.</p>
        errormsg:
          type: string
          description: >-
            A successful receipt of a call to cancel an order returns _null_;
            the _errormsg_ parameter for an unsuccessful call to cancel an order
            returns one of the following messages:. Not Authorized (errorcode
            20). Invalid Request (errorcode 100). Operation Failed (errorcode
            101). Server Error (errorcode 102). Resource Not Found (errorcode
            104). Operation Not Supported (errorcode 106).
          x-gitbook-description-html: >-
            <p>A successful receipt of a call to cancel an order returns
            <em>null</em>; the <em>errormsg</em> parameter for an unsuccessful
            call to cancel an order returns one of the following messages:. Not
            Authorized (errorcode 20). Invalid Request (errorcode 100).
            Operation Failed (errorcode 101). Server Error (errorcode 102).
            Resource Not Found (errorcode 104). Operation Not Supported
            (errorcode 106).</p>
        errorcode:
          type: integer
          description: >-
            A successfully received call to cancel an order returns 0. An
            unsuccessfully received call to cancel an order returns one of the
            _errorcodes_ shown in the _errormsg_ list.
          x-gitbook-description-html: >-
            <p>A successfully received call to cancel an order returns 0. An
            unsuccessfully received call to cancel an order returns one of the
            <em>errorcodes</em> shown in the <em>errormsg</em> list.</p>
        detail:
          type: string
          description: >-
            Message text that the system may send. The contents of this
            parameter are usually null.
          x-gitbook-description-html: >-
            <p>Message text that the system may send. The contents of this
            parameter are usually null.</p>
      required:
        - result
        - errormsg
        - errorcode
        - detail
    GetOpenOrdersRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS on which the user resides.
          x-gitbook-description-html: <p>The ID of the OMS on which the user resides.</p>
        AccountId:
          type: integer
          description: The ID of the account which you are getting open orders for.
          x-gitbook-description-html: <p>The ID of the account which you are getting open orders for.</p>
        InstrumentId:
          type: integer
          description: The ID of a specific instrument, can be used to filter results.
          x-gitbook-description-html: >-
            <p>The ID of a specific instrument, can be used to filter
            results.</p>
      required:
        - OMSId
        - AccountId
    GetOpenOrdersResponse:
      type: array
      items:
        type: object
        properties:
          Side:
            type: string
            enum:
              - Buy
              - Sell
            description: 'The side of a trade. One of: 0 Buy, 1 Sell.'
            x-gitbook-description-html: '<p>The side of a trade. One of: 0 Buy, 1 Sell.</p>'
          OrderId:
            type: integer
            format: int64
            description: The ID of the open order. The _OrderID_ is unique in each OMS.
            x-gitbook-description-html: >-
              <p>The ID of the open order. The <em>OrderID</em> is unique in
              each OMS.</p>
          Price:
            type: number
            format: decimal
            description: The price at which the buy or sell has been ordered.
            x-gitbook-description-html: <p>The price at which the buy or sell has been ordered.</p>
          Quantity:
            type: number
            format: decimal
            description: The quantity of the product to be bought or sold.
            x-gitbook-description-html: <p>The quantity of the product to be bought or sold.</p>
          DisplayQuantity:
            type: number
            format: decimal
            description: >-
              The quantity available to buy or sell that is publicly displayed
              to the market. To display a _displayQuantity_ value, an order must
              be a Limit order with a reserve.
            x-gitbook-description-html: >-
              <p>The quantity available to buy or sell that is publicly
              displayed to the market. To display a <em>displayQuantity</em>
              value, an order must be a Limit order with a reserve.</p>
          Instrument:
            type: integer
            description: >-
              The ID of the instrument being traded. The API method
              [**GetInstruments**](#operation/GetInstruments) can supply the
              instrument IDs that are available.
            x-gitbook-description-html: >-
              <p>The ID of the instrument being traded. The API method <a
              href="#operation/GetInstruments"><strong>GetInstruments</strong></a>
              can supply the instrument IDs that are available.</p>
          Account:
            type: integer
            description: The ID of the of the account which the order belongs to.
            x-gitbook-description-html: <p>The ID of the of the account which the order belongs to.</p>
          AccountName:
            type: string
            description: Name of the of the account which which the order belongs to.
            x-gitbook-description-html: >-
              <p>Name of the of the account which which the order belongs
              to.</p>
          OrderType:
            type: string
            enum:
              - Unknown an error condition
              - Market order
              - Limit
              - StopMarket
              - StopLimit
              - TrailingStopMarket
              - TrailingStopLimit
              - BlockTrade
            description: >-
              Describes the type of order this is. One of: 0 Unknown (an error
              condition), 1 Market order, 2 Limit, 3 StopMarket, 4 StopLimit, 5
              TrailingStopMarket, 6 TrailingStopLimit, 7 BlockTrade.
            x-gitbook-description-html: >-
              <p>Describes the type of order this is. One of: 0 Unknown (an
              error condition), 1 Market order, 2 Limit, 3 StopMarket, 4
              StopLimit, 5 TrailingStopMarket, 6 TrailingStopLimit, 7
              BlockTrade.</p>
          ClientOrderId:
            type: integer
            format: int64
            default: 0
            description: >-
              An ID supplied by the client to identify the order (like a
              purchase order number). Default is 0.
            x-gitbook-description-html: >-
              <p>An ID supplied by the client to identify the order (like a
              purchase order number). Default is 0.</p>
          OrderState:
            type: string
            description: >-
              The current state of the order. Will always be Working as this API
              method is getting **open orders**.
            x-gitbook-description-html: >-
              <p>The current state of the order. Will always be Working as this
              API method is getting <strong>open orders</strong>.</p>
          ReceiveTime:
            type: integer
            format: int64
            description: >-
              Time stamp of the order in POSIX format x 1000 (milliseconds since
              1/1/1970 in UTC time zone).
            x-gitbook-description-html: >-
              <p>Time stamp of the order in POSIX format x 1000 (milliseconds
              since 1/1/1970 in UTC time zone).</p>
          ReceiveTimeTicks:
            type: integer
            format: int64
            description: >-
              Time stamp of the order Microsoft Ticks format and UTC time zone.
              **Note:** Microsoft Ticks format is usually provided as a string.
              Here it is provided as a long integer.
            x-gitbook-description-html: >-
              <p>Time stamp of the order Microsoft Ticks format and UTC time
              zone. <strong>Note:</strong> Microsoft Ticks format is usually
              provided as a string. Here it is provided as a long integer.</p>
          LastUpdatedTime:
            type: integer
            format: int64
            description: >-
              Time stamp when the order was last updated, in POSIX format x 1000
              (milliseconds since 1/1/1970 in UTC time zone).
            x-gitbook-description-html: >-
              <p>Time stamp when the order was last updated, in POSIX format x
              1000 (milliseconds since 1/1/1970 in UTC time zone).</p>
          LastUpdatedTimeTicks:
            type: integer
            format: int64
            description: >-
              Time stamp when the order was last updated, in Microsoft Ticks
              format and UTC time zone. **Note:** Microsoft Ticks format is
              usually provided as a string. Here it is provided as a long
              integer.
            x-gitbook-description-html: >-
              <p>Time stamp when the order was last updated, in Microsoft Ticks
              format and UTC time zone. <strong>Note:</strong> Microsoft Ticks
              format is usually provided as a string. Here it is provided as a
              long integer.</p>
          OrigQuantity:
            type: number
            format: decimal
            description: >-
              If the open order has been changed or partially filled, this value
              shows the original quantity of the order.
            x-gitbook-description-html: >-
              <p>If the open order has been changed or partially filled, this
              value shows the original quantity of the order.</p>
          QuantityExecuted:
            type: number
            format: decimal
            description: >-
              If the open order has been at least partially executed, this value
              shows the amount that has been executed.
            x-gitbook-description-html: >-
              <p>If the open order has been at least partially executed, this
              value shows the amount that has been executed.</p>
          GrossValueExecuted:
            type: number
            format: decimal
            description: >-
              If the open order has been at least partially executed, this value
              shows the gross amount that has been executed.
            x-gitbook-description-html: >-
              <p>If the open order has been at least partially executed, this
              value shows the gross amount that has been executed.</p>
          ExecutableValue:
            type: number
            format: decimal
            description: Defaults to 0. For future provision.
            x-gitbook-description-html: <p>Defaults to 0. For future provision.</p>
          AvgPrice:
            type: number
            format: decimal
            description: The average executed price of the order.
            x-gitbook-description-html: <p>The average executed price of the order.</p>
          CounterPartyId:
            type: integer
            description: >-
              The ID of the account who is the counterparty for the trade if
              order is already executed, either partial or fully executed.
            x-gitbook-description-html: >-
              <p>The ID of the account who is the counterparty for the trade if
              order is already executed, either partial or fully executed.</p>
          ChangeReason:
            type: string
            enum:
              - Unknown
              - NewInputAccepted
              - NewInputRejected
              - OtherRejected
              - Expired
              - Trade
              - SystemCanceled_NoMoreMarket
              - SystemCanceled_BelowMinimum
              - SystemCanceled_PriceCollar
              - SystemCanceled_MarginFailed
              - UserModified
            description: >-
              If the order has been changed, this string value holds the reason.
              One of: 0 Unknown, **1** NewInputAccepted, 2 NewInputRejected, 3
              OtherRejected, 4 Expired, 5 Trade, 6 SystemCanceled_NoMoreMarket,
              7 SystemCanceled_BelowMinimum, 8 SystemCanceled_PriceCollar, 9
              SystemCanceled_MarginFailed, 100 UserModified. An order that is
              newly added to book will have **NewInputAccepted** value by
              default.
            x-gitbook-description-html: >-
              <p>If the order has been changed, this string value holds the
              reason. One of: 0 Unknown, <strong>1</strong> NewInputAccepted, 2
              NewInputRejected, 3 OtherRejected, 4 Expired, 5 Trade, 6
              SystemCanceled_NoMoreMarket, 7 SystemCanceled_BelowMinimum, 8
              SystemCanceled_PriceCollar, 9 SystemCanceled_MarginFailed, 100
              UserModified. An order that is newly added to book will have
              <strong>NewInputAccepted</strong> value by default.</p>
          OrigOrderId:
            type: integer
            format: int64
            description: >-
              If the order is a replacement order, this is the ID of the
              original order.
            x-gitbook-description-html: >-
              <p>If the order is a replacement order, this is the ID of the
              original order.</p>
          OrigClOrdId:
            type: integer
            format: int64
            description: >-
              If the order is a replacement order, this is the client order ID
              or the original order.
            x-gitbook-description-html: >-
              <p>If the order is a replacement order, this is the client order
              ID or the original order.</p>
          EnteredBy:
            type: integer
            description: The ID of the user who submitted the order.
            x-gitbook-description-html: <p>The ID of the user who submitted the order.</p>
          Username:
            type: string
            description: The username of the user who submitted the order.
            x-gitbook-description-html: <p>The username of the user who submitted the order.</p>
          IsQuote:
            type: boolean
            description: >-
              If this order is a quote, the value for _IsQuote_ is _true_,
              otherwise it is _false._.
            x-gitbook-description-html: >-
              <p>If this order is a quote, the value for <em>IsQuote</em> is
              <em>true</em>, otherwise it is <em>false.</em>.</p>
          InsideAsk:
            type: number
            format: decimal
            description: If this order is a quote, this value is the Inside Ask price.
            x-gitbook-description-html: >-
              <p>If this order is a quote, this value is the Inside Ask
              price.</p>
          InsideAskSize:
            type: number
            format: decimal
            description: >-
              If this order is a quote, this value is the quantity of the Inside
              Ask quote.
            x-gitbook-description-html: >-
              <p>If this order is a quote, this value is the quantity of the
              Inside Ask quote.</p>
          InsideBid:
            type: number
            format: decimal
            description: If this order is a quote, this value is the Inside Bid price.
            x-gitbook-description-html: >-
              <p>If this order is a quote, this value is the Inside Bid
              price.</p>
          InsideBidSize:
            type: number
            format: decimal
            description: >-
              If this order is a quote, this value is the quantity of the Inside
              Bid quote.
            x-gitbook-description-html: >-
              <p>If this order is a quote, this value is the quantity of the
              Inside Bid quote.</p>
          LastTradePrice:
            type: number
            format: decimal
            description: The last price that this instrument traded at.
            x-gitbook-description-html: <p>The last price that this instrument traded at.</p>
          RejectReason:
            type: string
            description: >-
              If this open order has been rejected, this string holds the reason
              for the rejection.
            x-gitbook-description-html: >-
              <p>If this open order has been rejected, this string holds the
              reason for the rejection.</p>
          IsLockedIn:
            type: boolean
            description: >-
              For a block trade, if both parties to the block trade agree that
              one of the parties will report the trade for both sides, this
              value is _true._ Othersise, _false._.
            x-gitbook-description-html: >-
              <p>For a block trade, if both parties to the block trade agree
              that one of the parties will report the trade for both sides, this
              value is <em>true.</em> Othersise, <em>false.</em>.</p>
          CancelReason:
            type: string
            description: >-
              If this order has been canceled, this string holds the
              cancellation reason.
            x-gitbook-description-html: >-
              <p>If this order has been canceled, this string holds the
              cancellation reason.</p>
          OrderFlag:
            oneOf:
              - type: integer
              - type: string
            description: >-
              One or more of:. 1 NoAccountRiskCheck. 2 AddedToBook. 4
              RemovedFromBook. 8 PostOnly. 16 Liquidation. 32
              ReverseMarginPosition.
            x-gitbook-description-html: >-
              <p>One or more of:. 1 NoAccountRiskCheck. 2 AddedToBook. 4
              RemovedFromBook. 8 PostOnly. 16 Liquidation. 32
              ReverseMarginPosition.</p>
          UseMargin:
            type: boolean
            default: false
            description: Margin is not yet supported so this always defaults to false.
            x-gitbook-description-html: >-
              <p>Margin is not yet supported so this always defaults to
              false.</p>
          StopPrice:
            type: number
            format: decimal
            description: >-
              The price at which the order executes, if the order is a stop
              order. Defaults to 0 if order is another type.
            x-gitbook-description-html: >-
              <p>The price at which the order executes, if the order is a stop
              order. Defaults to 0 if order is another type.</p>
          PegPriceType:
            type: string
            description: The type of price to peg the Stop to for Stop/Trailing orders.
            x-gitbook-description-html: >-
              <p>The type of price to peg the Stop to for Stop/Trailing
              orders.</p>
          PegOffset:
            type: number
            format: decimal
            description: >-
              Only applicable to trailing/stop orders. Defaults to 0 if order is
              another type.
            x-gitbook-description-html: >-
              <p>Only applicable to trailing/stop orders. Defaults to 0 if order
              is another type.</p>
          PegLimitOffset:
            type: number
            format: decimal
            description: >-
              Only applicable to trailing/stop orders. Defaults to 0 if order is
              another type.
            x-gitbook-description-html: >-
              <p>Only applicable to trailing/stop orders. Defaults to 0 if order
              is another type.</p>
          IpAddress:
            type: string
            description: The IP address from where the order was submitted.
            x-gitbook-description-html: <p>The IP address from where the order was submitted.</p>
          IPv6a:
            type: string
            description: >-
              **UInt64**. The IPv6 where the order was submitted from. Currently
              not being used, for future provision. Defaults to 0.
            x-gitbook-description-html: >-
              <p><strong>UInt64</strong>. The IPv6 where the order was submitted
              from. Currently not being used, for future provision. Defaults to
              0.</p>
          OMSId:
            type: integer
            description: The ID of the OMS.
            x-gitbook-description-html: <p>The ID of the OMS.</p>
        required:
          - Side
          - OrderId
          - Price
          - Quantity
          - DisplayQuantity
          - Instrument
          - Account
          - AccountName
          - OrderType
          - ClientOrderId
          - OrderState
          - ReceiveTime
          - ReceiveTimeTicks
          - LastUpdatedTime
          - LastUpdatedTimeTicks
          - OrigQuantity
          - QuantityExecuted
          - GrossValueExecuted
          - ExecutableValue
          - AvgPrice
          - CounterPartyId
          - ChangeReason
          - OrigOrderId
          - OrigClOrdId
          - EnteredBy
          - Username
          - IsQuote
          - InsideAsk
          - InsideAskSize
          - InsideBid
          - InsideBidSize
          - LastTradePrice
          - RejectReason
          - IsLockedIn
          - CancelReason
          - OrderFlag
          - UseMargin
          - StopPrice
          - PegPriceType
          - PegOffset
          - PegLimitOffset
          - IpAddress
          - IPv6a
          - IPv6a
          - OMSId
    GetAccountTradesRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS on which the user resides.
          x-gitbook-description-html: <p>The ID of the OMS on which the user resides.</p>
        AccountId:
          type: integer
          description: >-
            The ID of the account. If not specified, if authenticated user has
            the default permissions, its default account's trades will be
            returned, else if the authenticated user has elevated permissions,
            trades of any account will be returned.
          x-gitbook-description-html: >-
            <p>The ID of the account. If not specified, if authenticated user
            has the default permissions, its default account's trades will be
            returned, else if the authenticated user has elevated permissions,
            trades of any account will be returned.</p>
        StartIndex:
          type: integer
          description: >-
            The starting index into the history of trades, beginning from 0 (the
            most recent trade).
          x-gitbook-description-html: >-
            <p>The starting index into the history of trades, beginning from 0
            (the most recent trade).</p>
        Count or Depth:
          type: integer
          description: >-
            The number of trades to return. The system can return up to 200
            trades.
          x-gitbook-description-html: >-
            <p>The number of trades to return. The system can return up to 200
            trades.</p>
        InstrumentId:
          type: integer
          description: >-
            The ID of the instrument for which account trades will be returned,
            filter parameter.
          x-gitbook-description-html: >-
            <p>The ID of the instrument for which account trades will be
            returned, filter parameter.</p>
        TradeId:
          type: integer
          description: The ID of a specific trade, filter parameter.
          x-gitbook-description-html: <p>The ID of a specific trade, filter parameter.</p>
        OrderId:
          type: integer
          description: The ID of a specific order, filter parameter.
          x-gitbook-description-html: <p>The ID of a specific order, filter parameter.</p>
        StartTimeStamp:
          type: integer
          format: int64
          description: Filter parameter.
          x-gitbook-description-html: <p>Filter parameter.</p>
        EndTimeStamp:
          type: integer
          format: int64
          description: Filter parameter.
          x-gitbook-description-html: <p>Filter parameter.</p>
        ExecutionId:
          type: integer
          description: Filter parameter.
          x-gitbook-description-html: <p>Filter parameter.</p>
      required:
        - OMSId
    GetAccountTradesResponse:
      type: array
      items:
        type: object
        properties:
          OMSId:
            type: integer
            description: The ID of the OMS on which the account resdies.
            x-gitbook-description-html: <p>The ID of the OMS on which the account resdies.</p>
          ExecutionId:
            type: integer
            description: >-
              The ID of this account's side of the trade. Every trade has two
              sides.
            x-gitbook-description-html: >-
              <p>The ID of this account's side of the trade. Every trade has two
              sides.</p>
          TradeId:
            type: integer
            description: The ID of the overall trade.
            x-gitbook-description-html: <p>The ID of the overall trade.</p>
          OrderId:
            type: integer
            format: int64
            description: The ID of the order causing the trade (buy or sell).
            x-gitbook-description-html: <p>The ID of the order causing the trade (buy or sell).</p>
          AccountId:
            type: integer
            description: The ID of the account that made the trade (buy or sell).
            x-gitbook-description-html: <p>The ID of the account that made the trade (buy or sell).</p>
          AccountName:
            type: string
            description: The Name of the account that made the trade (buy or sell).
            x-gitbook-description-html: <p>The Name of the account that made the trade (buy or sell).</p>
          SubAccountId:
            type: integer
            description: Not currently used; reserved for future use. Defaults to 0.
            x-gitbook-description-html: <p>Not currently used; reserved for future use. Defaults to 0.</p>
          ClientOrderId:
            type: integer
            format: int64
            default: 0
            description: >-
              An ID supplied by the client to identify the order (like a
              purchase order number). Default is 0.
            x-gitbook-description-html: >-
              <p>An ID supplied by the client to identify the order (like a
              purchase order number). Default is 0.</p>
          InstrumentId:
            type: integer
            description: >-
              The ID of the instrument being traded. An instrument comprises two
              products, for example Dollars and Bitcoin.
            x-gitbook-description-html: >-
              <p>The ID of the instrument being traded. An instrument comprises
              two products, for example Dollars and Bitcoin.</p>
          Side:
            type: string
            enum:
              - Buy
              - Sell
            description: 'One of: 0 Buy, 1 Sell.'
            x-gitbook-description-html: '<p>One of: 0 Buy, 1 Sell.</p>'
          OrderType:
            type: string
            enum:
              - Market
              - Limit
              - BlockTrade
              - StopMarket
              - StopLimit
              - TrailingStopLimit
              - StopMarket
              - TrailingStopMarket
            description: >-
              One of: Market, Limit, BlockTrade, StopMarket, StopLimit,
              TrailingStopLimit, StopMarket, TrailingStopMarket.
            x-gitbook-description-html: >-
              <p>One of: Market, Limit, BlockTrade, StopMarket, StopLimit,
              TrailingStopLimit, StopMarket, TrailingStopMarket.</p>
          Quantity:
            type: number
            format: decimal
            description: The unit quantity of this side of the trade.
            x-gitbook-description-html: <p>The unit quantity of this side of the trade.</p>
          RemainingQuantity:
            type: number
            format: decimal
            description: >-
              The number of units remaining to be traded by the order after this
              execution. This number is not revealed to the other party in the
              trade. This value is also known as "leave size" or "leave
              quantity".
            x-gitbook-description-html: >-
              <p>The number of units remaining to be traded by the order after
              this execution. This number is not revealed to the other party in
              the trade. This value is also known as "leave size" or "leave
              quantity".</p>
          Price:
            type: number
            format: decimal
            description: The unit price at which the instrument traded.
            x-gitbook-description-html: <p>The unit price at which the instrument traded.</p>
          Value:
            type: number
            format: decimal
            description: >-
              The total value of the deal. The system calculates this as:. unit
              price X quantity executed.
            x-gitbook-description-html: >-
              <p>The total value of the deal. The system calculates this as:.
              unit price X quantity executed.</p>
          CounterParty:
            type: string
            description: >-
              The ID of the other party in a block trade. Usually, IDs are
              stated as integers; this value is an integer written as a string.
            x-gitbook-description-html: >-
              <p>The ID of the other party in a block trade. Usually, IDs are
              stated as integers; this value is an integer written as a
              string.</p>
          OrderTradeRevision:
            type: integer
            description: The revision number of this trade; usually 1.
            x-gitbook-description-html: <p>The revision number of this trade; usually 1.</p>
          Direction:
            type: string
            enum:
              - No change
              - Uptick
              - DownTick
            description: >-
              The effect of the trade on the instrument's market price. One of:
              **0** No change, **1** Uptick, **2** DownTick.
            x-gitbook-description-html: >-
              <p>The effect of the trade on the instrument's market price. One
              of: <strong>0</strong> No change, <strong>1</strong> Uptick,
              <strong>2</strong> DownTick.</p>
          IsBlockTrade:
            type: boolean
            description: >-
              A value of _true_ means that this trade was a block trade; a value
              of _false_ that it was not a block trade.
            x-gitbook-description-html: >-
              <p>A value of <em>true</em> means that this trade was a block
              trade; a value of <em>false</em> that it was not a block
              trade.</p>
          Fee:
            type: number
            format: decimal
            description: Any fee levied against the trade by the Exchange.
            x-gitbook-description-html: <p>Any fee levied against the trade by the Exchange.</p>
          FeeProductId:
            type: integer
            description: The ID of the product in which the fee was levied.
            x-gitbook-description-html: <p>The ID of the product in which the fee was levied.</p>
          OrderOriginator:
            type: integer
            description: The ID of the user who initiated the trade.
            x-gitbook-description-html: <p>The ID of the user who initiated the trade.</p>
          UserName:
            type: integer
            description: The UserName of the user who initiated the trade.
            x-gitbook-description-html: <p>The UserName of the user who initiated the trade.</p>
          TradeTimeMS:
            type: integer
            format: int64
            description: >-
              The date and time that the trade took place, in milliseconds and
              POSIX format. All dates and times are UTC.
            x-gitbook-description-html: >-
              <p>The date and time that the trade took place, in milliseconds
              and POSIX format. All dates and times are UTC.</p>
          MakerTaker:
            type: string
            enum:
              - Maker
              - Taker
            description: 'One of: Maker, Taker.'
            x-gitbook-description-html: '<p>One of: Maker, Taker.</p>'
          AdapterTradeId:
            type: integer
            description: The ID of the adapter of the overall trade.
            x-gitbook-description-html: <p>The ID of the adapter of the overall trade.</p>
          InsideBid:
            type: number
            format: decimal
            description: >-
              The best (highest) price level of the buy side of the book at the
              time of the trade.
            x-gitbook-description-html: >-
              <p>The best (highest) price level of the buy side of the book at
              the time of the trade.</p>
          InsideBidSize:
            type: number
            format: decimal
            description: >-
              The quantity of the best (highest) price level of the buy side of
              the book at the time of the trade.
            x-gitbook-description-html: >-
              <p>The quantity of the best (highest) price level of the buy side
              of the book at the time of the trade.</p>
          InsideAsk:
            type: number
            format: decimal
            description: >-
              The best (lowest) price level of the sell side of the book at the
              time of the trade.
            x-gitbook-description-html: >-
              <p>The best (lowest) price level of the sell side of the book at
              the time of the trade.</p>
          InsideAskSize:
            type: number
            format: decimal
            description: >-
              The quantity of the best (lowest) price level of the sell side of
              the book at the time of the trade.
            x-gitbook-description-html: >-
              <p>The quantity of the best (lowest) price level of the sell side
              of the book at the time of the trade.</p>
          CounterPartyClientUserId:
            type: integer
            description: Indicates counterparty source of trade (OMS, Remarketer, FIX).
            x-gitbook-description-html: >-
              <p>Indicates counterparty source of trade (OMS, Remarketer,
              FIX).</p>
          NotionalProductId:
            type: integer
            description: Notional product the notional value was captured in.
            x-gitbook-description-html: <p>Notional product the notional value was captured in.</p>
          NotionalRate:
            type: number
            format: decimal
            description: Notional rate from base currency at time of trade.
            x-gitbook-description-html: <p>Notional rate from base currency at time of trade.</p>
          NotionalValue:
            type: number
            format: decimal
            description: Notional value in base currency of venue at time of trade.
            x-gitbook-description-html: <p>Notional value in base currency of venue at time of trade.</p>
          TradeTime:
            type: integer
            format: int64
            description: >-
              The date and time that the trade took place, in C# Ticks. All
              dates and times are UTC.
            x-gitbook-description-html: >-
              <p>The date and time that the trade took place, in C# Ticks. All
              dates and times are UTC.</p>
        required:
          - OMSId
          - ExecutionId
          - TradeId
          - OrderId
          - AccountId
          - AccountName
          - SubAccountId
          - ClientOrderId
          - InstrumentId
          - Side
          - OrderType
          - Quantity
          - RemainingQuantity
          - Price
          - Value
          - CounterParty
          - OrderTradeRevision
          - Direction
          - IsBlockTrade
          - Fee
          - FeeProductId
          - OrderOriginator
          - UserName
          - TradeTimeMS
          - MakerTaker
          - AdapterTradeId
          - InsideBid
          - InsideBidSize
          - InsideAsk
          - InsideAskSize
          - CounterPartyClientUserId
          - NotionalProductId
          - NotionalRate
          - NotionalValue
          - TradeTime
    SummaryResponse:
      type: array
      items:
        type: object
        properties:
          trading_pairs:
            type: string
            description: The instrument pair.
            x-gitbook-description-html: <p>The instrument pair.</p>
          last_price:
            type: number
            format: decimal
            description: The last traded price of the instrument.
            x-gitbook-description-html: <p>The last traded price of the instrument.</p>
          lowest_ask:
            type: number
            format: decimal
            description: The current lowest ask for the instrument.
            x-gitbook-description-html: <p>The current lowest ask for the instrument.</p>
          highest_bid:
            type: number
            format: decimal
            description: The current highest bid for the instrument.
            x-gitbook-description-html: <p>The current highest bid for the instrument.</p>
          base_volume:
            type: number
            format: decimal
            description: The current base volume of the instrument.
            x-gitbook-description-html: <p>The current base volume of the instrument.</p>
          quote_volume:
            type: number
            format: decimal
            description: The current quote volume of the instrument.
            x-gitbook-description-html: <p>The current quote volume of the instrument.</p>
          price_change_percent_24h:
            type: number
            format: decimal
            description: >-
              The price percentage change of the instrument in 24H, resets UTC
              midnight.
            x-gitbook-description-html: >-
              <p>The price percentage change of the instrument in 24H, resets
              UTC midnight.</p>
          highest_price_24h:
            type: number
            format: decimal
            description: >-
              The highest traded price of the instrument in 24H, resets UTC
              midnight.
            x-gitbook-description-html: >-
              <p>The highest traded price of the instrument in 24H, resets UTC
              midnight.</p>
          lowest_price_24h:
            type: number
            format: decimal
            description: >-
              The lowest traded price of the instrument in 24H, resets UTC
              midnight.
            x-gitbook-description-html: >-
              <p>The lowest traded price of the instrument in 24H, resets UTC
              midnight.</p>
        required:
          - trading_pairs
          - last_price
          - lowest_ask
          - highest_bid
          - base_volume
          - quote_volume
          - price_change_percent_24h
          - highest_price_24h
          - lowest_price_24h
    TickerRequest:
      type: object
      properties:
        base_id:
          type: integer
          description: The unified cryptoasset id of the base product of the instrument.
          x-gitbook-description-html: >-
            <p>The unified cryptoasset id of the base product of the
            instrument.</p>
        quote_id:
          type: integer
          description: The quote id of the instrument.
          x-gitbook-description-html: <p>The quote id of the instrument.</p>
        last_price:
          type: number
          format: decimal
          description: The last traded price of the instrument.
          x-gitbook-description-html: <p>The last traded price of the instrument.</p>
        base_volume:
          type: number
          format: decimal
          description: The current base volume of the instrument.
          x-gitbook-description-html: <p>The current base volume of the instrument.</p>
        quote_volume:
          type: number
          format: decimal
          description: The current quote volume of the instrument.
          x-gitbook-description-html: <p>The current quote volume of the instrument.</p>
      required:
        - base_id
        - quote_id
        - last_price
        - base_volume
        - quote_volume
    TickerResponse:
      type: object
      description: >-
        A map of ticker information where the key is the market pair in the
        format "BASE_QUOTE", e.g., "BTC_USD".
      '{market_pair}':
        type: object
        properties:
          base_id:
            type: integer
            description: The unified cryptoasset id of the base product of the instrument.
            x-gitbook-description-html: >-
              <p>The unified cryptoasset id of the base product of the
              instrument.</p>
          quote_id:
            type: integer
            description: The quote id of the instrument.
            x-gitbook-description-html: <p>The quote id of the instrument.</p>
          last_price:
            type: number
            format: decimal
            description: The last traded price of the instrument.
            x-gitbook-description-html: <p>The last traded price of the instrument.</p>
          base_volume:
            type: number
            format: decimal
            description: The current base volume of the instrument.
            x-gitbook-description-html: <p>The current base volume of the instrument.</p>
          quote_volume:
            type: number
            format: decimal
            description: The current quote volume of the instrument.
            x-gitbook-description-html: <p>The current quote volume of the instrument.</p>
        required:
          - base_id
          - quote_id
          - last_price
          - base_volume
          - quote_volume
      x-gitbook-description-html: >-
        <p>A map of ticker information where the key is the market pair in the
        format "BASE_QUOTE", e.g., "BTC_USD".</p>
    OrderBookRequest:
      type: object
      properties:
        Market_Pair:
          type: string
          description: The instrument symbol, instrument id is not accepted.
          x-gitbook-description-html: <p>The instrument symbol, instrument id is not accepted.</p>
        Depth:
          type: integer
          description: >-
            Depth of the orderbook you want to see, this only applicable if
            **Level** parameter is set to 2. Depth will always be 1 if this is
            not set or if Level is set to 1.
          x-gitbook-description-html: >-
            <p>Depth of the orderbook you want to see, this only applicable if
            <strong>Level</strong> parameter is set to 2. Depth will always be 1
            if this is not set or if Level is set to 1.</p>
        Level:
          type: integer
          enum:
            - 1
            - 2
          default: 1
          description: >-
            One of: 1, 2. 1 mean you only want to see the best bid and best ask,
            2 means you want to see other levels of the book, number of bids and
            ask you will see depends on the **Depth** set, if **Depth** is not
            set and **Level** is set to 2, best bid and best ask will only be
            the ones to be returned. Default is 1.
          x-gitbook-description-html: >-
            <p>One of: 1, 2. 1 mean you only want to see the best bid and best
            ask, 2 means you want to see other levels of the book, number of
            bids and ask you will see depends on the <strong>Depth</strong> set,
            if <strong>Depth</strong> is not set and <strong>Level</strong> is
            set to 2, best bid and best ask will only be the ones to be
            returned. Default is 1.</p>
      required:
        - Market_Pair
    OrderBookResponse:
      type: object
      properties:
        timestamp:
          type: integer
          format: int64
          description: >-
            Unix timestamp in milliseconds, equivalent to the current timestamp
            when the response was returned.
          x-gitbook-description-html: >-
            <p>Unix timestamp in milliseconds, equivalent to the current
            timestamp when the response was returned.</p>
        bids:
          type: array
          items:
            type: array
            items: false
            prefixItems:
              - type: number
                format: decimal
                description: The quantity per level which someone is willing to buy.
                x-gitbook-description-html: <p>The quantity per level which someone is willing to buy.</p>
              - type: number
                format: decimal
                description: The price per level which someone is willing to buy.
                x-gitbook-description-html: <p>The price per level which someone is willing to buy.</p>
            example:
              - 2 //Quantity
              - 28900 //Price
        asks:
          type: array
          items:
            type: array
            items: false
            prefixItems:
              - type: number
                format: decimal
                description: The quantity per level which someone is willing to sell.
                x-gitbook-description-html: >-
                  <p>The quantity per level which someone is willing to
                  sell.</p>
              - type: number
                format: decimal
                description: The price per level which someone is willing to sell.
                x-gitbook-description-html: <p>The price per level which someone is willing to sell.</p>
            example:
              - 0.5 //Quantity
              - 29000 //Price
      required:
        - timestamp
        - bids
        - asks
    TradesRequest:
      type: object
      properties:
        market_pair:
          type: string
          description: The market pair or instrument symbol.
          x-gitbook-description-html: <p>The market pair or instrument symbol.</p>
      required:
        - market_pair
    TradesResponse:
      type: object
      properties:
        trade_id:
          type: integer
          description: The ID of the trade execution.
          x-gitbook-description-html: <p>The ID of the trade execution.</p>
        price:
          type: number
          format: decimal
          description: The price at which the trade was executed.
          x-gitbook-description-html: <p>The price at which the trade was executed.</p>
        base_volume:
          type: number
          format: decimal
          description: The traded quantity of the base product/currency.
          x-gitbook-description-html: <p>The traded quantity of the base product/currency.</p>
        quote_volume:
          type: number
          format: decimal
          description: The traded quantity of the quote product/currency.
          x-gitbook-description-html: <p>The traded quantity of the quote product/currency.</p>
        timestamp:
          type: string
          description: The exact date and time when the trade was executed, in UTC.
          x-gitbook-description-html: <p>The exact date and time when the trade was executed, in UTC.</p>
        type:
          type: string
          enum:
            - buy
            - sell
          description: 'The side of the trade, One of: **buy**, **sell**.'
          x-gitbook-description-html: >-
            <p>The side of the trade, One of: <strong>buy</strong>,
            <strong>sell</strong>.</p>
      required:
        - trade_id
        - price
        - base_volume
        - quote_volume
        - timestamp
        - type
    GetL2SnapshotRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS.
          x-gitbook-description-html: <p>The ID of the OMS.</p>
        InstrumentId:
          type: integer
          description: The ID of the instrument that is the subject of the snapshot.
          x-gitbook-description-html: <p>The ID of the instrument that is the subject of the snapshot.</p>
        Depth:
          type: integer
          description: >-
            Maximum number of bids and asks that can be included in the results.
            If set to 10, there can be maximum of 10 bids and 10 asks in the
            results.
          x-gitbook-description-html: >-
            <p>Maximum number of bids and asks that can be included in the
            results. If set to 10, there can be maximum of 10 bids and 10 asks
            in the results.</p>
      required:
        - OMSId
        - InstrumentId
        - Depth
    GetL2SnapshotResponse:
      type: array
      items: false
      prefixItems:
        - type: integer
          description: >-
            MDUpdateID. Market Data Update ID. This sequential ID identifies the
            order in which the update was created.
          x-gitbook-description-html: >-
            <p>MDUpdateID. Market Data Update ID. This sequential ID identifies
            the order in which the update was created.</p>
        - type: integer
          description: Number of Unique Accounts. Number of accounts that placed orders.
          x-gitbook-description-html: >-
            <p>Number of Unique Accounts. Number of accounts that placed
            orders.</p>
        - type: integer
          format: int64
          description: >-
            ActionDateTime. Identifies the time and date that the snapshot was
            taken or the event occurred, in POSIX format X 1000 (milliseconds
            since 1 January 1970).
          x-gitbook-description-html: >-
            <p>ActionDateTime. Identifies the time and date that the snapshot
            was taken or the event occurred, in POSIX format X 1000
            (milliseconds since 1 January 1970).</p>
        - type: string
          description: >-
            ActionType. L2 information provides price data. This value shows
            whether this data is:. **0** new. **1** update. **2** deletion.
          x-gitbook-description-html: >-
            <p>ActionType. L2 information provides price data. This value shows
            whether this data is:. <strong>0</strong> new. <strong>1</strong>
            update. <strong>2</strong> deletion.</p>
        - type: number
          format: decimal
          description: LastTradePrice. The price at which the instrument was last traded.
          x-gitbook-description-html: >-
            <p>LastTradePrice. The price at which the instrument was last
            traded.</p>
        - type: integer
          description: Number of Orders. Number of orders in the GetL2Snapshot.
          x-gitbook-description-html: <p>Number of Orders. Number of orders in the GetL2Snapshot.</p>
        - type: number
          format: decimal
          description: Price. Bid or Ask price for the Quantity (see _Quantity_ below).
          x-gitbook-description-html: >-
            <p>Price. Bid or Ask price for the Quantity (see <em>Quantity</em>
            below).</p>
        - type: integer
          description: >-
            ProductPairCode. is the same value and used for the same purpose as
            _InstrumentID_. The two are completely equivalent. _InstrumentId_ 47
            = _ProductPairCode_ 47.
          x-gitbook-description-html: >-
            <p>ProductPairCode. is the same value and used for the same purpose
            as <em>InstrumentID</em>. The two are completely equivalent.
            <em>InstrumentId</em> 47 = <em>ProductPairCode</em> 47.</p>
        - type: number
          format: decimal
          description: >-
            Quantity. Quantity available at a given Bid or Ask price (see
            _Price_ above).
          x-gitbook-description-html: >-
            <p>Quantity. Quantity available at a given Bid or Ask price (see
            <em>Price</em> above).</p>
        - type: integer
          enum:
            - 0
            - 1
            - 2
            - 3
          description: >-
            Side. One of: **0** Buy means it is on the bid side, **1** Sell
            means it is on the ask side, **2** Short (reserved for future use),
            **3** Unknown (an error condition).
          x-gitbook-description-html: >-
            <p>Side. One of: <strong>0</strong> Buy means it is on the bid side,
            <strong>1</strong> Sell means it is on the ask side,
            <strong>2</strong> Short (reserved for future use),
            <strong>3</strong> Unknown (an error condition).</p>
      example:
        - 26 // MDUpdateId
        - 1 // Number of Unique Accounts
        - 1679559223042 //ActionDateTime in Posix format X 1000
        - 0 // ActionType 0 (New), 1 (Update), 2(Delete)
        - 29000 // LastTradePrice
        - 1 // Number of Orders
        - 28700 //Price
        - 1 // ProductPairCode
        - 0.5 // Quantity
        - 0 // Side 0 means buy and it is on the bid side
    GetLevel1Request:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS.
          x-gitbook-description-html: <p>The ID of the OMS.</p>
        InstrumentId:
          type: integer
          description: >-
            The ID of the instrument whose Level 1 market snapshot will be
            taken.
          x-gitbook-description-html: >-
            <p>The ID of the instrument whose Level 1 market snapshot will be
            taken.</p>
      required:
        - OMSId
        - InstrumentId
    GetLevel1Response:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS.
          x-gitbook-description-html: <p>The ID of the OMS.</p>
        InstrumentId:
          type: integer
          description: The ID of the instrument being tracked.
          x-gitbook-description-html: <p>The ID of the instrument being tracked.</p>
        BestBid:
          type: number
          format: decimal
          description: The current best bid for the instrument.
          x-gitbook-description-html: <p>The current best bid for the instrument.</p>
        BestOffer:
          type: number
          format: decimal
          description: The current best offer for the instrument.
          x-gitbook-description-html: <p>The current best offer for the instrument.</p>
        LastTradedPx:
          type: number
          format: decimal
          description: The last-traded price for the instrument.
          x-gitbook-description-html: <p>The last-traded price for the instrument.</p>
        LastTradedQty:
          type: number
          format: decimal
          description: The last-traded quantity for the instrument.
          x-gitbook-description-html: <p>The last-traded quantity for the instrument.</p>
        LastTradeTime:
          type: integer
          format: int64
          description: The time of the last trade, in POSIX format.
          x-gitbook-description-html: <p>The time of the last trade, in POSIX format.</p>
        SessionOpen:
          type: number
          format: decimal
          description: >-
            Opening price. In markets with openings and closings, this is the
            opening price for the current session; in 24-hour markets, it is the
            price as of UTC Midnight.
          x-gitbook-description-html: >-
            <p>Opening price. In markets with openings and closings, this is the
            opening price for the current session; in 24-hour markets, it is the
            price as of UTC Midnight.</p>
        SessionHigh:
          type: number
          format: decimal
          description: >-
            Highest price during the trading day, either during a session with
            opening and closing prices or UTC midnight to UTC midnight.
          x-gitbook-description-html: >-
            <p>Highest price during the trading day, either during a session
            with opening and closing prices or UTC midnight to UTC midnight.</p>
        SessionLow:
          type: number
          format: decimal
          description: >-
            Lowest price during the trading day, either during a session with
            opening and closing prices or UTC midnight to UTC midnight.
          x-gitbook-description-html: >-
            <p>Lowest price during the trading day, either during a session with
            opening and closing prices or UTC midnight to UTC midnight.</p>
        SessionClose:
          type: number
          format: decimal
          description: >-
            The closing price. In markets with openings and closings, this is
            the closing price for the current session; in 24-hour markets, it is
            the price as of UTC Midnight.
          x-gitbook-description-html: >-
            <p>The closing price. In markets with openings and closings, this is
            the closing price for the current session; in 24-hour markets, it is
            the price as of UTC Midnight.</p>
        Volume:
          type: number
          format: decimal
          description: >-
            The last-traded quantity for the instrument, same value as
            LastTradedQty.
          x-gitbook-description-html: >-
            <p>The last-traded quantity for the instrument, same value as
            LastTradedQty.</p>
        CurrentDayVolume:
          type: number
          format: decimal
          description: >-
            The unit volume of the instrument traded either during a session
            with openings and closings or in 24-hour markets, the period from
            UTC Midnight to UTC Midnight.
          x-gitbook-description-html: >-
            <p>The unit volume of the instrument traded either during a session
            with openings and closings or in 24-hour markets, the period from
            UTC Midnight to UTC Midnight.</p>
        CurrentDayNumTrades:
          type: integer
          description: >-
            The number of trades during the current day, either during a session
            with openings and closings or in 24-hour markets, the period from
            UTC Midnight to UTC Midnight.
          x-gitbook-description-html: >-
            <p>The number of trades during the current day, either during a
            session with openings and closings or in 24-hour markets, the period
            from UTC Midnight to UTC Midnight.</p>
        CurrentDayPxChange:
          type: number
          format: decimal
          description: >-
            Current day price change, either during a trading session or UTC
            Midnight to UTC midnight.
          x-gitbook-description-html: >-
            <p>Current day price change, either during a trading session or UTC
            Midnight to UTC midnight.</p>
        CurrentNotional:
          type: number
          format: decimal
          description: Current day quote volume - resets at UTC Midnight.
          x-gitbook-description-html: <p>Current day quote volume - resets at UTC Midnight.</p>
        Rolling24HrNotional:
          type: number
          format: decimal
          description: Rolling 24 hours quote volume.
          x-gitbook-description-html: <p>Rolling 24 hours quote volume.</p>
        Rolling24HrVolume:
          type: number
          format: decimal
          description: >-
            Unit volume(quantity traded, in the product 1 or in the base
            currency denomination) of the instrument during the past 24 hours,
            regardless of time zone. Recalculates continuously.
          x-gitbook-description-html: >-
            <p>Unit volume(quantity traded, in the product 1 or in the base
            currency denomination) of the instrument during the past 24 hours,
            regardless of time zone. Recalculates continuously.</p>
        Rolling24HrNumTrades:
          type: integer
          description: >-
            Number of trades during the past 24 hours, regardless of time zone.
            Recalculates continuously.
          x-gitbook-description-html: >-
            <p>Number of trades during the past 24 hours, regardless of time
            zone. Recalculates continuously.</p>
        Rolling24HrPxChange:
          type: number
          format: decimal
          description: >-
            Price change during the past 24 hours, regardless of time zone.
            Recalculates continuously.
          x-gitbook-description-html: >-
            <p>Price change during the past 24 hours, regardless of time zone.
            Recalculates continuously.</p>
        TimeStamp:
          type: string
          description: The time this information was provided, in POSIX format.
          x-gitbook-description-html: <p>The time this information was provided, in POSIX format.</p>
        BidQty:
          type: number
          format: decimal
          description: The quantity currently being bid.
          x-gitbook-description-html: <p>The quantity currently being bid.</p>
        AskQty:
          type: number
          format: decimal
          description: The quantity currently being asked.
          x-gitbook-description-html: <p>The quantity currently being asked.</p>
        BidOrderCt:
          type: integer
          description: The count of bid orders.
          x-gitbook-description-html: <p>The count of bid orders.</p>
        AskOrderCt:
          type: integer
          description: The count of ask orders.
          x-gitbook-description-html: <p>The count of ask orders.</p>
        Rolling24HrPxChangePercent:
          type: number
          format: decimal
          description: >-
            Percent change in price during the past 24hours regardles of the
            timezone. Recalculates continuously.
          x-gitbook-description-html: >-
            <p>Percent change in price during the past 24hours regardles of the
            timezone. Recalculates continuously.</p>
      required:
        - OMSId
        - InstrumentId
        - BestBid
        - BestOffer
        - LastTradedPx
        - LastTradedQty
        - LastTradeTime
        - SessionOpen
        - SessionHigh
        - SessionLow
        - SessionClose
        - Volume
        - CurrentDayVolume
        - CurrentDayNumTrades
        - CurrentDayPxChange
        - CurrentNotional
        - Rolling24HrNotional
        - Rolling24HrVolume
        - Rolling24HrNumTrades
        - Rolling24HrPxChange
        - TimeStamp
        - BidQty
        - AskQty
        - BidOrderCt
        - AskOrderCt
        - Rolling24HrPxChangePercent
    GetEnumsRequest:
      type: object
      properties:
        Class:
          type: string
          description: >-
            The class name. Since GetEnums is solely for Orders currently, the
            class name will always be **Order**.
          x-gitbook-description-html: >-
            <p>The class name. Since GetEnums is solely for Orders currently,
            the class name will always be <strong>Order</strong>.</p>
        Property:
          type: string
          description: >-
            The property name, since GetEnums is solely for Orders currently,
            property name will always be **OrderState**.
          x-gitbook-description-html: >-
            <p>The property name, since GetEnums is solely for Orders currently,
            property name will always be <strong>OrderState</strong>.</p>
        Enums:
          type: string
          description: >-
            The actual enum values for Orders..  **Name** - . The name of the
            order state enum..  **Description** - . The description of the order
            state enum..   - . The number of the order state enum.
          x-gitbook-description-html: >-
            <p>The actual enum values for Orders..  <strong>Name</strong> - .
            The name of the order state enum..  <strong>Description</strong> - .
            The description of the order state enum..   - . The number of the
            order state enum.</p>
      required:
        - Class
        - Property
        - Enums
    GetEnumsResponse:
      type: array
      items:
        type: object
        properties:
          Class:
            type: string
            description: >-
              The class name. Since GetEnums is solely for Orders currently, the
              class name will always be **Order**.
            x-gitbook-description-html: >-
              <p>The class name. Since GetEnums is solely for Orders currently,
              the class name will always be <strong>Order</strong>.</p>
          Property:
            type: string
            description: >-
              The property name, since GetEnums is solely for Orders currently,
              property name will always be **OrderState**.
            x-gitbook-description-html: >-
              <p>The property name, since GetEnums is solely for Orders
              currently, property name will always be
              <strong>OrderState</strong>.</p>
          Enums:
            type: object
            description: The actual enum values for Orders.
            properties:
              Name:
                type: string
                description: The name of the order state enum.
                x-gitbook-description-html: <p>The name of the order state enum.</p>
              Description:
                type: string
                description: The description of the order state enum.
                x-gitbook-description-html: <p>The description of the order state enum.</p>
              Value:
                type: integer
                description: The number of the order state enum.
                x-gitbook-description-html: <p>The number of the order state enum.</p>
            x-gitbook-description-html: <p>The actual enum values for Orders.</p>
        required:
          - Class
          - Property
          - Enums
    GetUserAccountsRequest:
      type: object
      properties:
        OMSId:
          type: integer
          description: The ID of the OMS on which the user has one ore more accounts.
          x-gitbook-description-html: >-
            <p>The ID of the OMS on which the user has one ore more
            accounts.</p>
        UserId:
          type: integer
          description: >-
            The ID of the user whose accounts you want to return. If not
            specified, the accounts of the user currently authenticated will be
            returned. A user with elevated permissions can specify any UserID
            and will be able to get the account/s owned by any user.
          x-gitbook-description-html: >-
            <p>The ID of the user whose accounts you want to return. If not
            specified, the accounts of the user currently authenticated will be
            returned. A user with elevated permissions can specify any UserID
            and will be able to get the account/s owned by any user.</p>
      required: []
    GetUserAccountsResponse:
      type: array
      description: A list of account IDs associated to the user.
      items:
        type: integer
      x-gitbook-description-html: <p>A list of account IDs associated to the user.</p>
    GetUserDevicesRequest:
      type: object
      properties:
        UserId:
          type: integer
          description: >-
            The ID of the user for whose registered device/s will be returned.
            If not, the registered devices of the authenticated user will be
            returned.
          x-gitbook-description-html: >-
            <p>The ID of the user for whose registered device/s will be
            returned. If not, the registered devices of the authenticated user
            will be returned.</p>
      required: []
    GetUserDevicesResponse:
      type: object
      properties:
        HashCode:
          type: integer
          description: A unique code that identifies the user registered device.
          x-gitbook-description-html: <p>A unique code that identifies the user registered device.</p>
        Location:
          type: string
          description: Defaults to empty string, for future provision.
          x-gitbook-description-html: <p>Defaults to empty string, for future provision.</p>
        DeviceName:
          type: string
          description: The name of the device.
          x-gitbook-description-html: <p>The name of the device.</p>
        IpAddress:
          type: string
          description: The IpAddress from where the user registered the device.
          x-gitbook-description-html: <p>The IpAddress from where the user registered the device.</p>
        UserId:
          type: integer
          description: The ID of the user who owns the device.
          x-gitbook-description-html: <p>The ID of the user who owns the device.</p>
        IsTrusted:
          type: boolean
          description: >-
            If true the device is trusted, which means the user has confirmed
            it, otherwise it is false.
          x-gitbook-description-html: >-
            <p>If true the device is trusted, which means the user has confirmed
            it, otherwise it is false.</p>
        ExpirationTime:
          type: integer
          format: int64
          description: >-
            The date and time up to when the device will be trusted. In
            **ticks** format.
          x-gitbook-description-html: >-
            <p>The date and time up to when the device will be trusted. In
            <strong>ticks</strong> format.</p>
      required:
        - HashCode
        - Location
        - DeviceName
        - IpAddress
        - UserId
        - IsTrusted
        - ExpirationTime
    GetBanksRequest:
      type: object
      properties:
        country:
          type: string
          description: Country code in ISO 3166-1 alpha-2 format.
          x-gitbook-description-html: <p>Country code in ISO 3166-1 alpha-2 format.</p>
        page:
          type: string
          default: 1
          description: Page number. Default is _1_.
          x-gitbook-description-html: <p>Page number. Default is <em>1</em>.</p>
        page_size:
          type: string
          default: 10
          description: Number of elements per page. Default is _10_.
          x-gitbook-description-html: <p>Number of elements per page. Default is <em>10</em>.</p>
      required:
        - country
    GetBanksResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        total:
          type: integer
          description: Number of entries in the response.
          x-gitbook-description-html: <p>Number of entries in the response.</p>
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: UUID
                description: The identifier of the bank.
                x-gitbook-description-html: <p>The identifier of the bank.</p>
              name:
                type: string
                description: The name of the bank.
                x-gitbook-description-html: <p>The name of the bank.</p>
              country:
                type: string
                description: Country code in ISO 3166-1 alpha-2 format.
                x-gitbook-description-html: <p>Country code in ISO 3166-1 alpha-2 format.</p>
            required:
              - country
      required:
        - status
        - total
        - data
    GetProvincesRequest:
      type: object
      properties:
        country:
          type: string
          description: Country code in ISO 3166-1 alpha-2 format.
          x-gitbook-description-html: <p>Country code in ISO 3166-1 alpha-2 format.</p>
      required:
        - country
    GetProvincesResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        data:
          type: array
          items:
            type: array
            items: false
            prefixItems:
              - type: string
                description: Province code.
                x-gitbook-description-html: <p>Province code.</p>
              - type: string
                description: Province name.
                x-gitbook-description-html: <p>Province name.</p>
      required:
        - status
        - data
    AddClientBankAccountRequest:
      type: object
      properties:
        country:
          type: string
          enum:
            - AR
            - BR
            - CL
            - PE
            - CO
          description: >-
            Country code in ISO 3166-1 alpha-2 format. One of: AR, BR, CL, PE,
            CO.
          x-gitbook-description-html: >-
            <p>Country code in ISO 3166-1 alpha-2 format. One of: AR, BR, CL,
            PE, CO.</p>
        bank:
          type: string
          description: Bank identifier.
          x-gitbook-description-html: <p>Bank identifier.</p>
        number:
          type: string
          description: Bank account number.
          x-gitbook-description-html: <p>Bank account number.</p>
        kind:
          type: string
          description: >-
            Bank account type.. 1. If _country_ is **AR**, the options are: <br>
            - corriente<br> - vista<br> - ahorro<br> - electronic_checkbook<br>
            - ar_cbu<br> - ar_cvu<br> - ar_alia <br>2. If _country_ is **BR**,
            the options are: <br> - br_corriente_fisica<br> -
            br_simple_fisica<br> - br_corriente_juridica<br> -
            br_poupanca_fisica<br> - br_poupanca_juridica<br> -
            br_caixa_facil<br> - br_pix<br>3. If _country_ is **CL**, the
            options are: <br> - corriente<br> - vista<br> - ahorro<br> -
            electronic_checkbook<br>4. If _country_ is **PE**, the options are:
            <br> - corriente<br> - ahorro<br>5. If _country_ is **CO**, the
            options are: <br> - corriente<br> - ahorro<br>.
          x-gitbook-description-html: >-
            <p>Bank account type.. 1. If <em>country</em> is
            <strong>AR</strong>, the options are:  - corriente - vista - ahorro
            - electronic_checkbook - ar_cbu - ar_cvu - ar_alia 2. If
            <em>country</em> is <strong>BR</strong>, the options are:  -
            br_corriente_fisica - br_simple_fisica - br_corriente_juridica -
            br_poupanca_fisica - br_poupanca_juridica - br_caixa_facil -
            br_pix3. If <em>country</em> is <strong>CL</strong>, the options
            are:  - corriente - vista - ahorro - electronic_checkbook4. If
            <em>country</em> is <strong>PE</strong>, the options are:  -
            corriente - ahorro5. If <em>country</em> is <strong>CO</strong>, the
            options are:  - corriente - ahorro.</p>
        pix_type:
          type: string
          description: >-
            PIX account type. Only required if _country_ is **BR** and _kind_ is
            **br_pix**. Options are: <br> - CPF<br> - CNPJ<br> - Email<br> -
            Phone<br> - Otro<br>.
          x-gitbook-description-html: >-
            <p>PIX account type. Only required if <em>country</em> is
            <strong>BR</strong> and <em>kind</em> is <strong>br_pix</strong>.
            Options are:  - CPF - CNPJ - Email - Phone - Otro.</p>
        agency:
          type: string
          description: Bank account agency. Only required if _country_ is **BR**.
          x-gitbook-description-html: >-
            <p>Bank account agency. Only required if <em>country</em> is
            <strong>BR</strong>.</p>
        dv:
          type: string
          description: >-
            Bank account verification digit. Only required if  _country_ is
            **BR**.
          x-gitbook-description-html: >-
            <p>Bank account verification digit. Only required if 
            <em>country</em> is <strong>BR</strong>.</p>
        province:
          type: string
          description: Province of the bank account. Only required if _country_ is **PE**.
          x-gitbook-description-html: >-
            <p>Province of the bank account. Only required if <em>country</em>
            is <strong>PE</strong>.</p>
        user_id:
          type: string
          description: >-
            If the process is being made for a managed user, then this is the
            user id of the managed user.
          x-gitbook-description-html: >-
            <p>If the process is being made for a managed user, then this is the
            user id of the managed user.</p>
      required:
        - country
        - bank
        - number
        - kind
        - pix_type
        - agency
        - dv
        - province
    AddClientBankAccountResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        data:
          type: object
          properties:
            id:
              type: string
              format: UUID
              description: Bank account identifier.
              x-gitbook-description-html: <p>Bank account identifier.</p>
            country:
              type: string
              enum:
                - AR
                - BR
                - CL
                - PE
                - CO
              description: >-
                Country code in ISO 3166-1 alpha-2 format. One of: AR, BR, CL,
                PE, CO.
              x-gitbook-description-html: >-
                <p>Country code in ISO 3166-1 alpha-2 format. One of: AR, BR,
                CL, PE, CO.</p>
            bank:
              type: object
              properties:
                id:
                  type: string
                  format: UUID
                  description: The identifier of the bank.
                  x-gitbook-description-html: <p>The identifier of the bank.</p>
                name:
                  type: string
                  description: The name of the bank.
                  x-gitbook-description-html: <p>The name of the bank.</p>
                country:
                  type: string
                  description: Country code in ISO 3166-1 alpha-2 format.
                  x-gitbook-description-html: <p>Country code in ISO 3166-1 alpha-2 format.</p>
              required:
                - id
                - name
                - country
            number:
              type: string
              description: Bank account number.
              x-gitbook-description-html: <p>Bank account number.</p>
            kind:
              type: string
              description: >-
                Bank account type. If _country_ is **AR**, the options are:
                corriente, vista, ahorro, electronic_checkbook, ar_cbu, ar_cvu,
                ar_alia. If _country_ is **BR**, the options are:
                br_corriente_fisica, br_simple_fisica, br_corriente_juridica,
                br_poupanca_fisica, br_poupanca_juridica, br_caixa_facil,
                br_pix. If _country_ is **CL**, the options are: corriente,
                vista, ahorro, electronic_checkbook. If _country_ is **PE**, the
                options are: corriente, ahorro. If _country_ is **CO**, the
                options are: corriente, ahorro.
              x-gitbook-description-html: >-
                <p>Bank account type. If <em>country</em> is
                <strong>AR</strong>, the options are: corriente, vista, ahorro,
                electronic_checkbook, ar_cbu, ar_cvu, ar_alia. If
                <em>country</em> is <strong>BR</strong>, the options are:
                br_corriente_fisica, br_simple_fisica, br_corriente_juridica,
                br_poupanca_fisica, br_poupanca_juridica, br_caixa_facil,
                br_pix. If <em>country</em> is <strong>CL</strong>, the options
                are: corriente, vista, ahorro, electronic_checkbook. If
                <em>country</em> is <strong>PE</strong>, the options are:
                corriente, ahorro. If <em>country</em> is <strong>CO</strong>,
                the options are: corriente, ahorro.</p>
            currency:
              type: string
              description: The currency of the bank account.
              x-gitbook-description-html: <p>The currency of the bank account.</p>
            agency:
              type: string
              description: Bank account agency. May be null.
              x-gitbook-description-html: <p>Bank account agency. May be null.</p>
            dv:
              type: string
              description: Bank account verification digit. May be null.
              x-gitbook-description-html: <p>Bank account verification digit. May be null.</p>
            province:
              type: string
              description: Province of the bank account. May be null.
              x-gitbook-description-html: <p>Province of the bank account. May be null.</p>
            pix_type:
              type: string
              description: >-
                PIX account type. One of: CPF, CNPJ, Email, Phone, Otro. May be
                null.
              x-gitbook-description-html: >-
                <p>PIX account type. One of: CPF, CNPJ, Email, Phone, Otro. May
                be null.</p>
          required:
            - id
            - country
            - bank
            - number
            - kind
            - currency
            - agency
            - dv
            - province
            - pix_type
      required:
        - status
        - data
    GetClientBankAccountRequest:
      type: object
      properties:
        bank-account-id:
          type: string
          description: Bank account identifier.
          x-gitbook-description-html: <p>Bank account identifier.</p>
        user_id:
          type: string
          description: >-
            If the process is being made for a managed user, then this is the
            user id of the managed user.
          x-gitbook-description-html: >-
            <p>If the process is being made for a managed user, then this is the
            user id of the managed user.</p>
      required:
        - bank-account-id
    GetClientBankAccountResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        data:
          type: object
          properties:
            id:
              type: string
              format: UUID
              description: Bank account identifier.
              x-gitbook-description-html: <p>Bank account identifier.</p>
            country:
              type: string
              enum:
                - AR
                - BR
                - CL
                - PE
                - CO
              description: >-
                Country code in ISO 3166-1 alpha-2 format. One of: AR, BR, CL,
                PE, CO.
              x-gitbook-description-html: >-
                <p>Country code in ISO 3166-1 alpha-2 format. One of: AR, BR,
                CL, PE, CO.</p>
            bank:
              type: object
              properties:
                id:
                  type: string
                  format: UUID
                  description: The identifier of the bank.
                  x-gitbook-description-html: <p>The identifier of the bank.</p>
                name:
                  type: string
                  description: The name of the bank.
                  x-gitbook-description-html: <p>The name of the bank.</p>
                country:
                  type: string
                  description: Country code in ISO 3166-1 alpha-2 format.
                  x-gitbook-description-html: <p>Country code in ISO 3166-1 alpha-2 format.</p>
              required:
                - id
                - name
                - country
            number:
              type: string
              description: Bank account number.
              x-gitbook-description-html: <p>Bank account number.</p>
            kind:
              type: string
              description: >-
                Bank account type. If _country_ is **AR**, the options are:
                corriente, vista, ahorro, electronic_checkbook, ar_cbu, ar_cvu,
                ar_alia. If _country_ is **BR**, the options are:
                br_corriente_fisica, br_simple_fisica, br_corriente_juridica,
                br_poupanca_fisica, br_poupanca_juridica, br_caixa_facil,
                br_pix. If _country_ is **CL**, the options are: corriente,
                vista, ahorro, electronic_checkbook. If _country_ is **PE**, the
                options are: corriente, ahorro. If _country_ is **CO**, the
                options are: corriente, ahorro.
              x-gitbook-description-html: >-
                <p>Bank account type. If <em>country</em> is
                <strong>AR</strong>, the options are: corriente, vista, ahorro,
                electronic_checkbook, ar_cbu, ar_cvu, ar_alia. If
                <em>country</em> is <strong>BR</strong>, the options are:
                br_corriente_fisica, br_simple_fisica, br_corriente_juridica,
                br_poupanca_fisica, br_poupanca_juridica, br_caixa_facil,
                br_pix. If <em>country</em> is <strong>CL</strong>, the options
                are: corriente, vista, ahorro, electronic_checkbook. If
                <em>country</em> is <strong>PE</strong>, the options are:
                corriente, ahorro. If <em>country</em> is <strong>CO</strong>,
                the options are: corriente, ahorro.</p>
            currency:
              type: string
              description: The currency of the bank account.
              x-gitbook-description-html: <p>The currency of the bank account.</p>
            agency:
              type: string
              description: Bank account agency. May be null.
              x-gitbook-description-html: <p>Bank account agency. May be null.</p>
            dv:
              type: string
              description: Bank account verification digit. May be null.
              x-gitbook-description-html: <p>Bank account verification digit. May be null.</p>
            province:
              type: string
              description: Province of the bank account. May be null.
              x-gitbook-description-html: <p>Province of the bank account. May be null.</p>
            pix_type:
              type: string
              description: >-
                PIX account type. One of: CPF, CNPJ, Email, Phone, Otro. May be
                null.
              x-gitbook-description-html: >-
                <p>PIX account type. One of: CPF, CNPJ, Email, Phone, Otro. May
                be null.</p>
          required:
            - id
            - country
            - bank
            - number
            - kind
            - currency
            - agency
            - dv
            - province
            - pix_type
      required:
        - status
        - data
    GetClientBankAccountsRequest:
      type: object
      properties:
        page:
          type: string
          default: 1
          description: Page number. Default is _1_.
          x-gitbook-description-html: <p>Page number. Default is <em>1</em>.</p>
        page_size:
          type: string
          default: 10
          description: Number of elements per page. Default is _10_.
          x-gitbook-description-html: <p>Number of elements per page. Default is <em>10</em>.</p>
        user_id:
          type: string
          description: >-
            If the process is being made for a managed user, then this is the
            user id of the managed user.
          x-gitbook-description-html: >-
            <p>If the process is being made for a managed user, then this is the
            user id of the managed user.</p>
      required: []
    GetClientBankAccountsResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                format: UUID
                description: Bank account identifier.
                x-gitbook-description-html: <p>Bank account identifier.</p>
              country:
                type: string
                enum:
                  - AR
                  - BR
                  - CL
                  - PE
                  - CO
                description: >-
                  Country code in ISO 3166-1 alpha-2 format. One of: AR, BR, CL,
                  PE, CO.
                x-gitbook-description-html: >-
                  <p>Country code in ISO 3166-1 alpha-2 format. One of: AR, BR,
                  CL, PE, CO.</p>
              bank:
                type: object
                properties:
                  id:
                    type: string
                    format: UUID
                    description: The identifier of the bank.
                    x-gitbook-description-html: <p>The identifier of the bank.</p>
                  name:
                    type: string
                    description: The name of the bank.
                    x-gitbook-description-html: <p>The name of the bank.</p>
                  country:
                    type: string
                    description: Country code in ISO 3166-1 alpha-2 format.
                    x-gitbook-description-html: <p>Country code in ISO 3166-1 alpha-2 format.</p>
                required:
                  - id
                  - name
                  - country
              number:
                type: string
                description: Bank account number.
                x-gitbook-description-html: <p>Bank account number.</p>
              kind:
                type: string
                description: >-
                  Bank account type. If _country_ is **AR**, the options are:
                  corriente, vista, ahorro, electronic_checkbook, ar_cbu,
                  ar_cvu, ar_alia. If _country_ is **BR**, the options are:
                  br_corriente_fisica, br_simple_fisica, br_corriente_juridica,
                  br_poupanca_fisica, br_poupanca_juridica, br_caixa_facil,
                  br_pix. If _country_ is **CL**, the options are: corriente,
                  vista, ahorro, electronic_checkbook. If _country_ is **PE**,
                  the options are: corriente, ahorro. If _country_ is **CO**,
                  the options are: corriente, ahorro.
                x-gitbook-description-html: >-
                  <p>Bank account type. If <em>country</em> is
                  <strong>AR</strong>, the options are: corriente, vista,
                  ahorro, electronic_checkbook, ar_cbu, ar_cvu, ar_alia. If
                  <em>country</em> is <strong>BR</strong>, the options are:
                  br_corriente_fisica, br_simple_fisica, br_corriente_juridica,
                  br_poupanca_fisica, br_poupanca_juridica, br_caixa_facil,
                  br_pix. If <em>country</em> is <strong>CL</strong>, the
                  options are: corriente, vista, ahorro, electronic_checkbook.
                  If <em>country</em> is <strong>PE</strong>, the options are:
                  corriente, ahorro. If <em>country</em> is <strong>CO</strong>,
                  the options are: corriente, ahorro.</p>
              currency:
                type: string
                description: The currency of the bank account.
                x-gitbook-description-html: <p>The currency of the bank account.</p>
              agency:
                type: string
                description: Bank account agency. May be null.
                x-gitbook-description-html: <p>Bank account agency. May be null.</p>
              dv:
                type: string
                description: Bank account verification digit. May be null.
                x-gitbook-description-html: <p>Bank account verification digit. May be null.</p>
              province:
                type: string
                description: Province of the bank account. May be null.
                x-gitbook-description-html: <p>Province of the bank account. May be null.</p>
              pix_type:
                type: string
                description: >-
                  PIX account type. One of: CPF, CNPJ, Email, Phone, Otro. May
                  be null.
                x-gitbook-description-html: >-
                  <p>PIX account type. One of: CPF, CNPJ, Email, Phone, Otro.
                  May be null.</p>
            required:
              - id
              - country
              - bank
              - number
              - kind
              - currency
              - agency
              - dv
              - province
              - pix_type
      required:
        - status
        - data
    DeleteClientBankAccountRequest:
      type: object
      properties:
        bank-account-id:
          type: string
          description: Bank account identifier.
          x-gitbook-description-html: <p>Bank account identifier.</p>
        user_id:
          type: string
          description: >-
            If the process is being made for a managed user, then this is the
            user id of the managed user.
          x-gitbook-description-html: >-
            <p>If the process is being made for a managed user, then this is the
            user id of the managed user.</p>
      required:
        - bank-account-id
    DeleteClientBankAccountResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
      required:
        - status
    GetNetworksTemplatesRequest:
      type: object
      properties:
        currency:
          type: string
          description: Currency (Product) identifier.
          x-gitbook-description-html: <p>Currency (Product) identifier.</p>
        network:
          type: string
          description: Currency (Product) network identifier.
          x-gitbook-description-html: <p>Currency (Product) network identifier.</p>
      required:
        - currency
    GetNetworksTemplatesResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        data:
          type: array
          items:
            type: object
            properties:
              currency:
                type: string
                description: Currency (Product) identifier.
                x-gitbook-description-html: <p>Currency (Product) identifier.</p>
              network:
                type: string
                description: Currency (Product) network identifier.
                x-gitbook-description-html: <p>Currency (Product) network identifier.</p>
              network_name:
                type: string
                description: Name of the currency (Product) network.
                x-gitbook-description-html: <p>Name of the currency (Product) network.</p>
              network_protocol:
                type: string
                description: Protocol of the currency (Product) network.
                x-gitbook-description-html: <p>Protocol of the currency (Product) network.</p>
              template:
                type: array
                items:
                  type: object
                  properties:
                    name:
                      type: string
                      description: Name of the template field.
                      x-gitbook-description-html: <p>Name of the template field.</p>
                    type:
                      type: string
                      description: Type of the template field.
                      x-gitbook-description-html: <p>Type of the template field.</p>
                    required:
                      type: boolean
                      description: Whether the template field is required.
                      x-gitbook-description-html: <p>Whether the template field is required.</p>
                    maxLength:
                      type: integer
                      description: Maximum length of the template field.
                      x-gitbook-description-html: <p>Maximum length of the template field.</p>
                    minLength:
                      type: integer
                      description: Minimum length of the template field.
                      x-gitbook-description-html: <p>Minimum length of the template field.</p>
                    decimalPlaces:
                      type: integer
                      description: Number of decimal places for the template field.
                      x-gitbook-description-html: <p>Number of decimal places for the template field.</p>
                  required:
                    - name
                    - type
                    - required
            required:
              - currency
              - network
              - network_name
              - network_protocol
              - template
      required:
        - status
        - data
    GetDepositAddressesRequest:
      type: object
      properties:
        account_id:
          type: integer
          description: The account identifier.
          x-gitbook-description-html: <p>The account identifier.</p>
        currency:
          type: string
          description: Currency (Product) identifier.
          x-gitbook-description-html: <p>Currency (Product) identifier.</p>
        network:
          type: string
          description: Currency (Product) network identifier.
          x-gitbook-description-html: <p>Currency (Product) network identifier.</p>
        user_id:
          type: string
          description: >-
            If the process is being made for a managed user, then this is the
            user id of the managed user.
          x-gitbook-description-html: >-
            <p>If the process is being made for a managed user, then this is the
            user id of the managed user.</p>
      required:
        - account_id
        - currency
        - network
    GetDepositAddressesResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        data:
          type: array
          items:
            type: string
            description: Deposit address.
            x-gitbook-description-html: <p>Deposit address.</p>
      required:
        - status
        - data
    CreateDepositAddressRequest:
      type: object
      properties:
        account_id:
          type: integer
          description: The account identifier.
          x-gitbook-description-html: <p>The account identifier.</p>
        currency:
          type: string
          description: Currency identifier.
          x-gitbook-description-html: <p>Currency identifier.</p>
        network:
          type: string
          description: Currency network identifier.
          x-gitbook-description-html: <p>Currency network identifier.</p>
        user_id:
          type: string
          description: >-
            If the process is being made for a managed user, then this is the
            user id of the managed user.
          x-gitbook-description-html: >-
            <p>If the process is being made for a managed user, then this is the
            user id of the managed user.</p>
      required:
        - account_id
        - currency
        - network
    CreateDepositAddressResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        data:
          type: string
          description: The new deposit address.
          x-gitbook-description-html: <p>The new deposit address.</p>
      required:
        - status
        - data
    GetWhitelistedAddressesRequest:
      type: object
      properties:
        account_id:
          type: integer
          description: The ID of the account for which whitelisted addresses were created.
          x-gitbook-description-html: >-
            <p>The ID of the account for which whitelisted addresses were
            created.</p>
        search:
          type: string
          description: >-
            Filters the addresses by label, currency, or whitelisted address
            identifier.
          x-gitbook-description-html: >-
            <p>Filters the addresses by label, currency, or whitelisted address
            identifier.</p>
        user_id:
          type: string
          description: >-
            If the process is being made for a managed user, then this is the
            user id of the managed user.
          x-gitbook-description-html: >-
            <p>If the process is being made for a managed user, then this is the
            user id of the managed user.</p>
      required:
        - account_id
    GetWhitelistedAddressesResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        data:
          type: object
          properties:
            id:
              type: string
              format: UUID
              description: Whitelisted address identifier.
              x-gitbook-description-html: <p>Whitelisted address identifier.</p>
            currency:
              type: string
              description: currency (Product) of the address.
              x-gitbook-description-html: <p>currency (Product) of the address.</p>
            label:
              type: string
              description: Name or description of the address.
              x-gitbook-description-html: <p>Name or description of the address.</p>
            network:
              type: string
              description: Address network.
              x-gitbook-description-html: <p>Address network.</p>
            address:
              type: string
              description: Address identifier.
              x-gitbook-description-html: <p>Address identifier.</p>
            memo:
              type: string
              description: Address memo or tag. May be null.
              x-gitbook-description-html: <p>Address memo or tag. May be null.</p>
            verified:
              type: boolean
              description: Whether the address has been verified.
              x-gitbook-description-html: <p>Whether the address has been verified.</p>
            provider_id:
              type: integer
              description: Identifier of the provider associated with the address.
              x-gitbook-description-html: <p>Identifier of the provider associated with the address.</p>
          required:
            - id
            - currency
            - label
            - network
            - address
            - verified
            - provider_id
      required:
        - status
        - data
    AddWhitelistedAddressRequest:
      type: object
      properties:
        account_id:
          type: integer
          description: >-
            The ID of the account for which whitelisted addresses will be
            created.
          x-gitbook-description-html: >-
            <p>The ID of the account for which whitelisted addresses will be
            created.</p>
        currency:
          type: string
          description: Address currency identifier.
          x-gitbook-description-html: <p>Address currency identifier.</p>
        network:
          type: string
          description: Address network.
          x-gitbook-description-html: <p>Address network.</p>
        address:
          type: string
          description: Address identifier.
          x-gitbook-description-html: <p>Address identifier.</p>
        label:
          type: string
          description: Name or description of the address.
          x-gitbook-description-html: <p>Name or description of the address.</p>
        memo_or_tag:
          type: string
          description: Address memo or tag.
          x-gitbook-description-html: <p>Address memo or tag.</p>
        otp:
          type: string
          description: Two-step authentication code.
          x-gitbook-description-html: <p>Two-step authentication code.</p>
        user_id:
          type: string
          description: >-
            If the process is being made for a managed user, then this is the
            user id of the managed user.
          x-gitbook-description-html: >-
            <p>If the process is being made for a managed user, then this is the
            user id of the managed user.</p>
      required:
        - account_id
        - currency
        - network
        - address
        - label
        - otp
    AddWhitelistedAddressResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        data:
          type: object
          properties:
            id:
              type: integer
              description: The ID of the address added to the whitelist.
              x-gitbook-description-html: <p>The ID of the address added to the whitelist.</p>
          required:
            - id
      required:
        - status
        - data
    ConfirmWhitelistedAddressRequest:
      type: object
      properties:
        whitelisted-address-id:
          type: string
          description: Whitelisted address identifier.
          x-gitbook-description-html: <p>Whitelisted address identifier.</p>
      required:
        - whitelisted-address-id
    ConfirmWhitelistedAddressResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
      required:
        - status
    ResendVerificationCodeWhitelistedAddressRequest:
      type: object
      properties:
        whitelisted-address-id:
          type: string
          description: Whitelisted address identifier.
          x-gitbook-description-html: <p>Whitelisted address identifier.</p>
      required:
        - whitelisted-address-id
    ResendVerificationCodeWhitelistedAddressResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
      required:
        - status
    DeleteWhitelistedAddressRequest:
      type: object
      properties:
        whitelisted-address-id:
          type: string
          description: Whitelisted address identifier.
          x-gitbook-description-html: <p>Whitelisted address identifier.</p>
      required:
        - whitelisted-address-id
    DeleteWhitelistedAddressResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
      required:
        - status
    UpdateOneStepWithdrawRequest:
      type: object
      properties:
        account_id:
          type: integer
          description: The account identifier.
          x-gitbook-description-html: <p>The account identifier.</p>
        action:
          type: string
          enum:
            - enable
            - disable
          description: 'Action to configure. One of: **enable**, **disable**.'
          x-gitbook-description-html: >-
            <p>Action to configure. One of: <strong>enable</strong>,
            <strong>disable</strong>.</p>
        otp:
          type: string
          description: Two-step authentication code.
          x-gitbook-description-html: <p>Two-step authentication code.</p>
        user_id:
          type: string
          description: >-
            If the process is being made for a managed user, then this is the
            user id of the managed user.
          x-gitbook-description-html: >-
            <p>If the process is being made for a managed user, then this is the
            user id of the managed user.</p>
      required:
        - account_id
        - action
        - otp
    UpdateOneStepWithdrawResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
      required:
        - status
    CreateCryptoWithdrawRequest:
      type: object
      properties:
        account_id:
          type: integer
          description: The ID of the account.
          x-gitbook-description-html: <p>The ID of the account.</p>
        currency:
          type: string
          description: Currency identifier.
          x-gitbook-description-html: <p>Currency identifier.</p>
        network:
          type: string
          description: Network identifier.
          x-gitbook-description-html: <p>Network identifier.</p>
        address:
          type: string
          description: Destination address.
          x-gitbook-description-html: <p>Destination address.</p>
        amount:
          oneOf:
            - type: number
            - type: string
          description: '**string or number**. Withdrawal amount.'
          x-gitbook-description-html: <p><strong>string or number</strong>. Withdrawal amount.</p>
        memo_or_tag:
          type: string
          description: Memo or tag of the destination address.
          x-gitbook-description-html: <p>Memo or tag of the destination address.</p>
        otp:
          type: string
          description: Two-step authentication code.
          x-gitbook-description-html: <p>Two-step authentication code.</p>
        user_id:
          type: string
          description: >-
            If the process is being made for a managed user, then this is the
            user id of the managed user.
          x-gitbook-description-html: >-
            <p>If the process is being made for a managed user, then this is the
            user id of the managed user.</p>
      required:
        - account_id
        - currency
        - network
        - address
        - amount
        - memo_or_tag
        - otp
    CreateCryptoWithdrawResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        data:
          type: string
          description: The identifier of the created withdrawal.
          x-gitbook-description-html: <p>The identifier of the created withdrawal.</p>
      required:
        - status
        - data
    CreateFiatDepositRequest:
      type: object
      properties:
        account_id:
          type: integer
          description: Account identifier.
          x-gitbook-description-html: <p>Account identifier.</p>
        payment_method:
          type: integer
          enum:
            - 1
            - 2
          description: >-
            Deposit payment method. One of: **1** (Bank transfer), **2**
            (Webpay, only for **CLP**).
          x-gitbook-description-html: >-
            <p>Deposit payment method. One of: <strong>1</strong> (Bank
            transfer), <strong>2</strong> (Webpay, only for
            <strong>CLP</strong>).</p>
        currency:
          type: string
          enum:
            - ARS
            - BRL
            - CLP
            - COP
            - PEN
          description: >-
            Currency of the deposit. One of: **ARS**, **BRL**, **CLP**, **COP**,
            **PEN**.
          x-gitbook-description-html: >-
            <p>Currency of the deposit. One of: <strong>ARS</strong>,
            <strong>BRL</strong>, <strong>CLP</strong>, <strong>COP</strong>,
            <strong>PEN</strong>.</p>
        amount:
          oneOf:
            - type: number
            - type: string
          description: '**string or number**. Deposit amount.'
          x-gitbook-description-html: <p><strong>string or number</strong>. Deposit amount.</p>
        bank_account_id:
          type: string
          description: Bank account identifier. Only required if _payment_method_ is **1**.
          x-gitbook-description-html: >-
            <p>Bank account identifier. Only required if <em>payment_method</em>
            is <strong>1</strong>.</p>
        voucher:
          type: string
          format: binary
          description: >-
            Proof of deposit. Only required if _payment_method_ is **1** and
            _currency_ is **PEN**.
          x-gitbook-description-html: >-
            <p>Proof of deposit. Only required if <em>payment_method</em> is
            <strong>1</strong> and <em>currency</em> is
            <strong>PEN</strong>.</p>
        user_id:
          type: string
          description: >-
            If the process is being made for a managed user, then this is the
            user id of the managed user.
          x-gitbook-description-html: >-
            <p>If the process is being made for a managed user, then this is the
            user id of the managed user.</p>
      required:
        - account_id
        - payment_method
        - currency
        - amount
        - bank_account_id
        - voucher
    CreateFiatDepositResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        message:
          type: string
          description: result of the deposit.
          x-gitbook-description-html: <p>result of the deposit.</p>
        data:
          type: object
          properties:
            url:
              type: string
              description: URL to make the deposit.
              x-gitbook-description-html: <p>URL to make the deposit.</p>
          required:
            - url
      required:
        - status
    GetOwnersFiatWithdrawRequest:
      type: object
      properties:
        cbu:
          type: string
          description: CBU account number to obtain the account owners.
          x-gitbook-description-html: <p>CBU account number to obtain the account owners.</p>
      required:
        - cbu
    GetOwnersFiatWithdrawResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        data:
          type: array
          items:
            type: object
            properties:
              person_type:
                type: string
                enum:
                  - F
                  - J
                description: 'Person type. One of: F (natural person), J (juridical person).'
                x-gitbook-description-html: >-
                  <p>Person type. One of: F (natural person), J (juridical
                  person).</p>
              cuit:
                type: string
                description: CUIT number of the person.
                x-gitbook-description-html: <p>CUIT number of the person.</p>
              name:
                type: string
                description: Name of the person.
                x-gitbook-description-html: <p>Name of the person.</p>
            required:
              - person_type
              - cuit
              - name
      required:
        - status
        - data
    CreateFiatWithdrawRequest:
      type: object
      properties:
        account_id:
          type: integer
          description: Account identifier.
          x-gitbook-description-html: <p>Account identifier.</p>
        payment_method:
          type: integer
          enum:
            - 1
          description: 'Deposit payment method. One of: **1** (Bank transfer).'
          x-gitbook-description-html: >-
            <p>Deposit payment method. One of: <strong>1</strong> (Bank
            transfer).</p>
        currency:
          type: string
          enum:
            - ARS
            - BRL
            - CLP
            - COP
            - PEN
          description: >-
            Currency of the deposit. One of: **ARS**, **BRL**, **CLP**, **COP**,
            **PEN**.
          x-gitbook-description-html: >-
            <p>Currency of the deposit. One of: <strong>ARS</strong>,
            <strong>BRL</strong>, <strong>CLP</strong>, <strong>COP</strong>,
            <strong>PEN</strong>.</p>
        amount:
          oneOf:
            - type: number
            - type: string
          description: '**string or number**. Deposit amount.'
          x-gitbook-description-html: <p><strong>string or number</strong>. Deposit amount.</p>
        bank_account_id:
          type: string
          description: Bank account identifier. Only required if _payment_method_ is **1**.
          x-gitbook-description-html: >-
            <p>Bank account identifier. Only required if <em>payment_method</em>
            is <strong>1</strong>.</p>
        cbu:
          type: string
          description: Destination account CBU. Only required if _currency_ is **ARS**.
          x-gitbook-description-html: >-
            <p>Destination account CBU. Only required if <em>currency</em> is
            <strong>ARS</strong>.</p>
        person_type:
          type: string
          description: >-
            Type of person who owns the destination account. Only required if
            _currency_ is **ARS**.
          x-gitbook-description-html: >-
            <p>Type of person who owns the destination account. Only required if
            <em>currency</em> is <strong>ARS</strong>.</p>
        cuit:
          type: string
          description: >-
            CUIT of the person who owns the destination account. Only required
            if the _currency_ is **ARS**.
          x-gitbook-description-html: >-
            <p>CUIT of the person who owns the destination account. Only
            required if the <em>currency</em> is <strong>ARS</strong>.</p>
        name:
          type: string
          description: >-
            Name of the person who owns the destination account. Only required
            if the _currency_ is **ARS**.
          x-gitbook-description-html: >-
            <p>Name of the person who owns the destination account. Only
            required if the <em>currency</em> is <strong>ARS</strong>.</p>
        user_id:
          type: string
          description: >-
            If the process is being made for a managed user, then this is the
            user id of the managed user.
          x-gitbook-description-html: >-
            <p>If the process is being made for a managed user, then this is the
            user id of the managed user.</p>
      required:
        - account_id
        - payment_method
        - currency
        - amount
        - bank_account_id
        - cbu
        - person_type
        - cuit
        - name
    CreateFiatWithdrawResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        message:
          type: string
          description: Result of the withdrawal request.
          x-gitbook-description-html: <p>Result of the withdrawal request.</p>
        data:
          type: object
          properties:
            withdrawal_id:
              type: string
              description: Withdrawal request identifier.
              x-gitbook-description-html: <p>Withdrawal request identifier.</p>
          required:
            - withdrawal_id
      required:
        - status
    ConfirmFiatWithdrawRequest:
      type: object
      properties:
        withdrawal_id:
          type: string
          description: Withdrawal request identifier.
          x-gitbook-description-html: <p>Withdrawal request identifier.</p>
      required:
        - withdrawal_id
    ConfirmFiatWithdrawResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        message:
          type: string
          description: Result of the withdrawal confirmation.
          x-gitbook-description-html: <p>Result of the withdrawal confirmation.</p>
      required:
        - status
        - message
    TransferFundsRequest:
      type: object
      properties:
        sender_account_id:
          type: integer
          description: The source account identifier.
          x-gitbook-description-html: <p>The source account identifier.</p>
        receiver_account_id:
          type: integer
          description: The destination account identifier.
          x-gitbook-description-html: <p>The destination account identifier.</p>
        currency_name:
          type: string
          description: Name of the currency.
          x-gitbook-description-html: <p>Name of the currency.</p>
        amount:
          oneOf:
            - type: number
            - type: string
          description: '**string or number**. Amount to transfer.'
          x-gitbook-description-html: <p><strong>string or number</strong>. Amount to transfer.</p>
        notes:
          type: string
          description: Description of the transfer.
          x-gitbook-description-html: <p>Description of the transfer.</p>
        otp:
          type: string
          description: Two-step authentication code.
          x-gitbook-description-html: <p>Two-step authentication code.</p>
        user_id:
          type: string
          description: >-
            If the process is being made for a managed user, then this is the
            user id of the managed user.
          x-gitbook-description-html: >-
            <p>If the process is being made for a managed user, then this is the
            user id of the managed user.</p>
      required:
        - sender_account_id
        - receiver_account_id
        - currency_name
        - amount
        - otp
    TransferFundsResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        data:
          type: string
          description: The identifier of the created transfer.
          x-gitbook-description-html: <p>The identifier of the created transfer.</p>
      required:
        - status
        - data
    GetTransactionsRequest:
      type: object
      properties:
        from_date:
          type: string
          description: >-
            The oldest date from which the transaction history will begin. The
            supported format is DD/MM/YYYY.
          x-gitbook-description-html: >-
            <p>The oldest date from which the transaction history will begin.
            The supported format is DD/MM/YYYY.</p>
        to_date:
          type: string
          description: >-
            The most recent date on which the transaction history will end. The
            supported format is DD/MM/YYYY.
          x-gitbook-description-html: >-
            <p>The most recent date on which the transaction history will end.
            The supported format is DD/MM/YYYY.</p>
        sort:
          type: string
          enum:
            - ASC
            - DESC
          default: DESC
          description: 'History sorting. One of: **ASC**, **DESC**. Default is **DESC**.'
          x-gitbook-description-html: >-
            <p>History sorting. One of: <strong>ASC</strong>,
            <strong>DESC</strong>. Default is <strong>DESC</strong>.</p>
        currency:
          type: string
          description: Transaction history currency.
          x-gitbook-description-html: <p>Transaction history currency.</p>
        page:
          type: integer
          default: 1
          description: Page numbre of the transaction history. Default is _1_.
          x-gitbook-description-html: >-
            <p>Page numbre of the transaction history. Default is
            <em>1</em>.</p>
        page_size:
          type: integer
          default: 10
          description: Number of transactions per page. Default is _10_.
          x-gitbook-description-html: <p>Number of transactions per page. Default is <em>10</em>.</p>
        user_id:
          type: string
          description: >-
            If the process is being made for a managed user, then this is the
            user id of the managed user.
          x-gitbook-description-html: >-
            <p>If the process is being made for a managed user, then this is the
            user id of the managed user.</p>
        account_id:
          type: string
          description: >-
            Can be used to filter results. If set, only transactions for the
            specific account id will be returned, else, all transactions
            regardless of the account (of the user) will be returned.
          x-gitbook-description-html: >-
            <p>Can be used to filter results. If set, only transactions for the
            specific account id will be returned, else, all transactions
            regardless of the account (of the user) will be returned.</p>
        type:
          type: integer
          enum:
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
            - 8
            - 9
            - 10
            - 11
            - 12
          description: >-
            Can be used to filter results. If set, only transactions with the
            specific type specified will be returned, else, all transactions
            regardless of the type will be returned. One of: **0** OTHER, **1**
            DEPOSIT, **2** WITHDRAW, **3** TRANSFER, **4** TRADE, **5** PAYMENT,
            **6** RECTIFICATION, **7** FEE, **8** REVERSE, **9** HOLD, **10**
            MARGIN, **11** AIRDROP, **12** DISTRIBUTION.
          x-gitbook-description-html: >-
            <p>Can be used to filter results. If set, only transactions with the
            specific type specified will be returned, else, all transactions
            regardless of the type will be returned. One of: <strong>0</strong>
            OTHER, <strong>1</strong> DEPOSIT, <strong>2</strong> WITHDRAW,
            <strong>3</strong> TRANSFER, <strong>4</strong> TRADE,
            <strong>5</strong> PAYMENT, <strong>6</strong> RECTIFICATION,
            <strong>7</strong> FEE, <strong>8</strong> REVERSE,
            <strong>9</strong> HOLD, <strong>10</strong> MARGIN,
            <strong>11</strong> AIRDROP, <strong>12</strong> DISTRIBUTION.</p>
        sub_type:
          type: integer
          enum:
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
            - 8
            - 9
            - 10
            - 11
            - 12
            - 13
            - 14
            - 15
            - 16
          description: >-
            Can be used to filter results. If set, only transactions with the
            specific sub type specified will be returned, else, all transactions
            regardless of the sub type will be returned. One of: **0** OTHER,
            **1** PAYOUT, **2** PAYIN, **3** DEPOSIT, **4** WITHDRAW, **5**
            BANK_TO_EXCHANGE, **6** EXCHANGE_TO_BANK, **7** TRADE, **8**
            PAYMENT, **9** SIMPLE, **10** RECTIFICATION, **11** TRANSFER, **12**
            HOLD, **13** MARGIN, **14** AIRDROP, **15** ORDER, **16**
            DISTRIBUTION_ENTRY.
          x-gitbook-description-html: >-
            <p>Can be used to filter results. If set, only transactions with the
            specific sub type specified will be returned, else, all transactions
            regardless of the sub type will be returned. One of:
            <strong>0</strong> OTHER, <strong>1</strong> PAYOUT,
            <strong>2</strong> PAYIN, <strong>3</strong> DEPOSIT,
            <strong>4</strong> WITHDRAW, <strong>5</strong> BANK_TO_EXCHANGE,
            <strong>6</strong> EXCHANGE_TO_BANK, <strong>7</strong> TRADE,
            <strong>8</strong> PAYMENT, <strong>9</strong> SIMPLE,
            <strong>10</strong> RECTIFICATION, <strong>11</strong> TRANSFER,
            <strong>12</strong> HOLD, <strong>13</strong> MARGIN,
            <strong>14</strong> AIRDROP, <strong>15</strong> ORDER,
            <strong>16</strong> DISTRIBUTION_ENTRY.</p>
      required: []
    GetTransactionsResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
                description: Transaction identifier.
                x-gitbook-description-html: <p>Transaction identifier.</p>
              legacy_id:
                type: string
                description: Legacy transaction identifier.
                x-gitbook-description-html: <p>Legacy transaction identifier.</p>
              currency:
                type: string
                description: Transaction currency.
                x-gitbook-description-html: <p>Transaction currency.</p>
              direction:
                type: integer
                enum:
                  - 1
                  - 2
                  - 0
                description: >-
                  Transaction direction. One of: **1** Income, **2** Outgoing,
                  **0** Other.
                x-gitbook-description-html: >-
                  <p>Transaction direction. One of: <strong>1</strong> Income,
                  <strong>2</strong> Outgoing, <strong>0</strong> Other.</p>
              amount:
                type: string
                description: Transaction amount.
                x-gitbook-description-html: <p>Transaction amount.</p>
              fee:
                type: string
                description: Transaction fee.
                x-gitbook-description-html: <p>Transaction fee.</p>
              balance:
                type: string
                description: Balance recorded after the transaction.
                x-gitbook-description-html: <p>Balance recorded after the transaction.</p>
              address:
                type: string
                description: Wallet address associated with the transaction.
                x-gitbook-description-html: <p>Wallet address associated with the transaction.</p>
              hash:
                type: string
                description: Hash associated with the transaction.
                x-gitbook-description-html: <p>Hash associated with the transaction.</p>
              type:
                type: integer
                enum:
                  - 0
                  - 1
                  - 2
                  - 3
                  - 4
                  - 5
                  - 6
                description: >-
                  Transaction type. One of: **0** Other, **1** Deposit, **2**
                  Withdrawal, **3** Transfer, **4** Trade, **5** Payment, **6**
                  Correction.
                x-gitbook-description-html: >-
                  <p>Transaction type. One of: <strong>0</strong> Other,
                  <strong>1</strong> Deposit, <strong>2</strong> Withdrawal,
                  <strong>3</strong> Transfer, <strong>4</strong> Trade,
                  <strong>5</strong> Payment, <strong>6</strong> Correction.</p>
              sub_type:
                type: integer
                enum:
                  - 0
                  - 1
                  - 2
                  - 3
                  - 4
                  - 5
                  - 6
                  - 7
                  - 8
                  - 9
                  - 10
                description: >-
                  Transaction type. One of: **0** Other, **1** Payout, **2**
                  Payin, **3** Deposit, **4** Withdrawal, **5** Wallet to
                  Exchange, **6** Exchange to Wallet, **7** Trade, **8**
                  Payment, **9** Simple, **10** Correction.
                x-gitbook-description-html: >-
                  <p>Transaction type. One of: <strong>0</strong> Other,
                  <strong>1</strong> Payout, <strong>2</strong> Payin,
                  <strong>3</strong> Deposit, <strong>4</strong> Withdrawal,
                  <strong>5</strong> Wallet to Exchange, <strong>6</strong>
                  Exchange to Wallet, <strong>7</strong> Trade,
                  <strong>8</strong> Payment, <strong>9</strong> Simple,
                  <strong>10</strong> Correction.</p>
              status:
                type: integer
                enum:
                  - 0
                  - 1
                  - 2
                  - 3
                  - 4
                  - 5
                description: >-
                  Transaction status. One of: **0** Other, **1** Created, **2**
                  Pending, **3** Success, **4** Failed, **5** Reversed.
                x-gitbook-description-html: >-
                  <p>Transaction status. One of: <strong>0</strong> Other,
                  <strong>1</strong> Created, <strong>2</strong> Pending,
                  <strong>3</strong> Success, <strong>4</strong> Failed,
                  <strong>5</strong> Reversed.</p>
              created_at:
                type: string
                description: Transaction creation date. ISO-8601 format.
                x-gitbook-description-html: <p>Transaction creation date. ISO-8601 format.</p>
              updated_at:
                type: string
                description: Date of the last transaction update. ISO-8601 format.
                x-gitbook-description-html: <p>Date of the last transaction update. ISO-8601 format.</p>
            required:
              - id
              - legacy_id
              - currency
              - direction
              - amount
              - fee
              - balance
              - address
              - hash
              - type
              - sub_type
              - status
              - created_at
              - updated_at
      required:
        - status
        - data
    GetQuotesRequest:
      type: object
      properties:
        mode:
          type: string
          enum:
            - direct
            - inverse
          description: 'Simple operation mode. One of: **direct**, **inverse**.'
          x-gitbook-description-html: >-
            <p>Simple operation mode. One of: <strong>direct</strong>,
            <strong>inverse</strong>.</p>
        user_id:
          type: string
          description: >-
            If the process is being made for a managed user, then this is the
            user id of the managed user.
          x-gitbook-description-html: >-
            <p>If the process is being made for a managed user, then this is the
            user id of the managed user.</p>
      required: []
    GetQuotesResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: Operation identifier.
                x-gitbook-description-html: <p>Operation identifier.</p>
              is_inverse:
                type: boolean
                description: Indicates whether it is a inverse operation.
                x-gitbook-description-html: <p>Indicates whether it is a inverse operation.</p>
              type:
                type: integer
                enum:
                  - 1
                  - 2
                  - 3
                description: >-
                  Transaction type. One of: **1** Buy, **2** Sell, **3**
                  Conversion.
                x-gitbook-description-html: >-
                  <p>Transaction type. One of: <strong>1</strong> Buy,
                  <strong>2</strong> Sell, <strong>3</strong> Conversion.</p>
              state:
                type: integer
                enum:
                  - 0
                  - 1
                  - 3
                  - 4
                  - 5
                  - 6
                description: >-
                  Transaction status. One of: **0** Pending, **1** Executed,
                  **3** Insufficient Balance, **4** Not Executed, **5** Other,
                  **6** Expired.
                x-gitbook-description-html: >-
                  <p>Transaction status. One of: <strong>0</strong> Pending,
                  <strong>1</strong> Executed, <strong>3</strong> Insufficient
                  Balance, <strong>4</strong> Not Executed, <strong>5</strong>
                  Other, <strong>6</strong> Expired.</p>
              currency_in:
                type: string
                description: Input currency of the operation.
                x-gitbook-description-html: <p>Input currency of the operation.</p>
              currency_out:
                type: string
                description: Output currency of the operation.
                x-gitbook-description-html: <p>Output currency of the operation.</p>
              amount_in:
                type: string
                description: Input amount of the operation.
                x-gitbook-description-html: <p>Input amount of the operation.</p>
              amount_out:
                type: string
                description: Output amount of the operation.
                x-gitbook-description-html: <p>Output amount of the operation.</p>
              amount_usdt_out:
                type: string
                description: Output amount in USDT of the operation.
                x-gitbook-description-html: <p>Output amount in USDT of the operation.</p>
              fee_amount:
                type: string
                description: Operation fee.
                x-gitbook-description-html: <p>Operation fee.</p>
              fee_detail:
                type: string
                description: Detail of the transaction fee.
                x-gitbook-description-html: <p>Detail of the transaction fee.</p>
              user_id:
                type: string
                description: >-
                  If the process is being made for a managed user, then this is
                  the user id of the managed user.
                x-gitbook-description-html: >-
                  <p>If the process is being made for a managed user, then this
                  is the user id of the managed user.</p>
            required:
              - id
              - is_inverse
              - type
              - state
              - currency_in
              - currency_out
              - amount_in
              - amount_out
              - amount_usdt_out
              - fee_amount
              - fee_detail
      required:
        - status
        - data
    CreateDirectQuoteRequest:
      type: object
      properties:
        account_id:
          type: integer
          description: The ID of the account.
          x-gitbook-description-html: <p>The ID of the account.</p>
        from_currency:
          type: string
          description: Input currency.
          x-gitbook-description-html: <p>Input currency.</p>
        from_amount:
          oneOf:
            - type: number
            - type: string
          description: '**string or number**. Amount of the transaction.'
          x-gitbook-description-html: <p><strong>string or number</strong>. Amount of the transaction.</p>
        to_currency:
          type: string
          description: Output currency.
          x-gitbook-description-html: <p>Output currency.</p>
        operation:
          type: string
          enum:
            - Buy
            - Sell
            - Conversion
          description: 'Transaction type. One of: 1 Buy, 2 Sell, 3 Conversion.'
          x-gitbook-description-html: '<p>Transaction type. One of: 1 Buy, 2 Sell, 3 Conversion.</p>'
        user_id:
          type: string
          description: >-
            If the process is being made for a managed user, then this is the
            user id of the managed user.
          x-gitbook-description-html: >-
            <p>If the process is being made for a managed user, then this is the
            user id of the managed user.</p>
      required:
        - account_id
        - from_currency
        - from_amount
        - to_currency
        - operation
    CreateDirectQuoteResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        data:
          type: object
          properties:
            id:
              type: string
              description: The identifier of the created quote.
              x-gitbook-description-html: <p>The identifier of the created quote.</p>
          required:
            - id
      required:
        - status
        - data
    CreateInverseQuoteRequest:
      type: object
      properties:
        account_id:
          type: integer
          description: The ID of the account.
          x-gitbook-description-html: <p>The ID of the account.</p>
        from_currency:
          type: string
          description: Input currency.
          x-gitbook-description-html: <p>Input currency.</p>
        to_currency:
          type: string
          description: Output currency.
          x-gitbook-description-html: <p>Output currency.</p>
        to_amount:
          oneOf:
            - type: number
            - type: string
          description: '**string or number**. Amount of the transaction.'
          x-gitbook-description-html: <p><strong>string or number</strong>. Amount of the transaction.</p>
        user_id:
          type: string
          description: >-
            If the process is being made for a managed user, then this is the
            user id of the managed user.
          x-gitbook-description-html: >-
            <p>If the process is being made for a managed user, then this is the
            user id of the managed user.</p>
      required:
        - account_id
        - from_currency
        - to_currency
        - to_amount
    CreateInverseQuoteResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        data:
          type: object
          properties:
            id:
              type: string
              description: The identifier of the created quote.
              x-gitbook-description-html: <p>The identifier of the created quote.</p>
          required:
            - id
      required:
        - status
        - data
    GetQuoteRequest:
      type: object
      properties:
        quote_id:
          type: string
          description: The Simple operation identifier.
          x-gitbook-description-html: <p>The Simple operation identifier.</p>
        user_id:
          type: string
          description: >-
            If the process is being made for a managed user, then this is the
            user id of the managed user.
          x-gitbook-description-html: >-
            <p>If the process is being made for a managed user, then this is the
            user id of the managed user.</p>
      required:
        - quote_id
    GetQuoteResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        data:
          type: object
          properties:
            id:
              type: string
              description: Operation identifier.
              x-gitbook-description-html: <p>Operation identifier.</p>
            is_inverse:
              type: boolean
              description: Indicates whether it is a inverse operation.
              x-gitbook-description-html: <p>Indicates whether it is a inverse operation.</p>
            type:
              type: integer
              enum:
                - 1
                - 2
                - 3
              description: >-
                Transaction type. One of: **1** Buy, **2** Sell, **3**
                Conversion.
              x-gitbook-description-html: >-
                <p>Transaction type. One of: <strong>1</strong> Buy,
                <strong>2</strong> Sell, <strong>3</strong> Conversion.</p>
            state:
              type: integer
              enum:
                - 0
                - 1
                - 3
                - 4
                - 5
                - 6
              description: >-
                Transaction status. One of: **0** Pending, **1** Executed, **3**
                Insufficient Balance, **4** Not Executed, **5** Other, **6**
                Expired.
              x-gitbook-description-html: >-
                <p>Transaction status. One of: <strong>0</strong> Pending,
                <strong>1</strong> Executed, <strong>3</strong> Insufficient
                Balance, <strong>4</strong> Not Executed, <strong>5</strong>
                Other, <strong>6</strong> Expired.</p>
            currency_in:
              type: string
              description: Input currency of the operation.
              x-gitbook-description-html: <p>Input currency of the operation.</p>
            currency_out:
              type: string
              description: Output currency of the operation.
              x-gitbook-description-html: <p>Output currency of the operation.</p>
            amount_in:
              type: string
              description: Input amount of the operation.
              x-gitbook-description-html: <p>Input amount of the operation.</p>
            amount_out:
              type: string
              description: Output amount of the operation.
              x-gitbook-description-html: <p>Output amount of the operation.</p>
            amount_usdt_out:
              type: string
              description: Output amount in USDT of the operation.
              x-gitbook-description-html: <p>Output amount in USDT of the operation.</p>
            fee_amount:
              type: string
              description: Operation fee.
              x-gitbook-description-html: <p>Operation fee.</p>
            fee_detail:
              type: string
              description: Detail of the transaction fee.
              x-gitbook-description-html: <p>Detail of the transaction fee.</p>
          required:
            - id
            - is_inverse
            - type
            - state
            - currency_in
            - currency_out
            - amount_in
            - amount_out
            - amount_usdt_out
            - fee_amount
            - fee_detail
      required:
        - status
        - data
    ExecuteQuoteResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        data:
          type: object
          properties:
            id:
              type: string
              description: Operation identifier.
              x-gitbook-description-html: <p>Operation identifier.</p>
            is_inverse:
              type: boolean
              description: Indicates whether it is a inverse operation.
              x-gitbook-description-html: <p>Indicates whether it is a inverse operation.</p>
            type:
              type: integer
              enum:
                - 1
                - 2
                - 3
              description: >-
                Transaction type. One of: **1** Buy, **2** Sell, **3**
                Conversion.
              x-gitbook-description-html: >-
                <p>Transaction type. One of: <strong>1</strong> Buy,
                <strong>2</strong> Sell, <strong>3</strong> Conversion.</p>
            state:
              type: integer
              enum:
                - 0
                - 1
                - 3
                - 4
                - 5
                - 6
              description: >-
                Transaction status. One of: **0** Pending, **1** Executed, **3**
                Insufficient Balance, **4** Not Executed, **5** Other, **6**
                Expired.
              x-gitbook-description-html: >-
                <p>Transaction status. One of: <strong>0</strong> Pending,
                <strong>1</strong> Executed, <strong>3</strong> Insufficient
                Balance, <strong>4</strong> Not Executed, <strong>5</strong>
                Other, <strong>6</strong> Expired.</p>
            currency_in:
              type: string
              description: Input currency of the operation.
              x-gitbook-description-html: <p>Input currency of the operation.</p>
            currency_out:
              type: string
              description: Output currency of the operation.
              x-gitbook-description-html: <p>Output currency of the operation.</p>
            amount_in:
              type: string
              description: Input amount of the operation.
              x-gitbook-description-html: <p>Input amount of the operation.</p>
            amount_out:
              type: string
              description: Output amount of the operation.
              x-gitbook-description-html: <p>Output amount of the operation.</p>
            amount_usdt_out:
              type: string
              description: Output amount in USDT of the operation.
              x-gitbook-description-html: <p>Output amount in USDT of the operation.</p>
            fee_amount:
              type: string
              description: Operation fee.
              x-gitbook-description-html: <p>Operation fee.</p>
            fee_detail:
              type: string
              description: Detail of the transaction fee.
              x-gitbook-description-html: <p>Detail of the transaction fee.</p>
            user_id:
              type: string
              description: >-
                If the process is being made for a managed user, then this is
                the user id of the managed user.
              x-gitbook-description-html: >-
                <p>If the process is being made for a managed user, then this is
                the user id of the managed user.</p>
          required:
            - id
            - is_inverse
            - type
            - state
            - currency_in
            - currency_out
            - amount_in
            - amount_out
            - amount_usdt_out
            - fee_amount
            - fee_detail
      required:
        - status
        - data
    VerifyBasicRequest:
      type: object
      properties:
        user_id:
          type: string
          description: The ID of the user to verify.
          x-gitbook-description-html: <p>The ID of the user to verify.</p>
        is_business:
          type: boolean
          description: If is going to be an institutional/company user.
          x-gitbook-description-html: <p>If is going to be an institutional/company user.</p>
        profession:
          type: string
          enum:
            - trader
            - investor
            - student
            - housewife
            - accountant
            - actor_actress
            - air_hostess
            - archaeologist
            - architect
            - astronaut
            - baker
            - biologist
            - bricklayer
            - driver
            - businessman
            - butcher
            - caretaker_janitor_porter
            - carpenter
            - cashier
            - cleaner
            - clown
            - cobbler
            - cook_chef
            - chemist
            - dancer
            - decorator
            - dentist
            - designer
            - physician
            - dressmaker
            - dustman
            - economist
            - electrician
            - engineer
            - farmer
            - fireman
            - fisherman
            - florist
            - fruiterer
            - gardener
            - geologist
            - hairdresser
            - jeweller
            - journalist
            - judge
            - lawyer
            - librarian
            - life_guard
            - mailman_postman
            - mechanic
            - meteorologist
            - cryptocurrency_miner
            - mineral_miner
            - model
            - nanny_nursemaid
            - nun
            - nurse
            - painter
            - pastry_cook
            - pharmacist
            - photographer
            - physicist
            - plumber
            - policeman_policewoman
            - politician
            - priest
            - professor_teacher
            - programmer
            - psychiatrist
            - psychologist
            - receptionist
            - researcher_scientist
            - sailor
            - salesman
            - secretary
            - shop_assistant
            - singer
            - social_worker
            - sportsman
            - surgeon
            - taxi_driver
            - telephone_operator
            - travel_agent
            - veterinarian
            - waiter_waitress
            - writer
            - deliveryman
            - uber_driver
            - pilot
            - administrative
            - public_servant
            - other
            - customer_care
            - military
            - manager_officier
          description: >-
            User profession. One of: trader, investor, student, housewife,
            accountant, actor_actress, air_hostess, archaeologist, architect,
            astronaut, baker, biologist, bricklayer, driver, businessman,
            butcher, caretaker_janitor_porter, carpenter, cashier, cleaner,
            clown, cobbler, cook_chef, chemist, dancer, decorator, dentist,
            designer, physician, dressmaker, dustman, economist, electrician,
            engineer, farmer, fireman, fisherman, florist, fruiterer, gardener,
            geologist, hairdresser, jeweller, journalist, judge, lawyer,
            librarian, life_guard, mailman_postman, mechanic, meteorologist,
            cryptocurrency_miner, mineral_miner, model, nanny_nursemaid, nun,
            nurse, painter, pastry_cook, pharmacist, photographer, physicist,
            plumber, policeman_policewoman, politician, priest,
            professor_teacher, programmer, psychiatrist, psychologist,
            receptionist, researcher_scientist, sailor, salesman, secretary,
            shop_assistant, singer, social_worker, sportsman, surgeon,
            taxi_driver, telephone_operator, travel_agent, veterinarian,
            waiter_waitress, writer, deliveryman, uber_driver, pilot,
            administrative, public_servant, other, customer_care, military,
            manager_officier.
          x-gitbook-description-html: >-
            <p>User profession. One of: trader, investor, student, housewife,
            accountant, actor_actress, air_hostess, archaeologist, architect,
            astronaut, baker, biologist, bricklayer, driver, businessman,
            butcher, caretaker_janitor_porter, carpenter, cashier, cleaner,
            clown, cobbler, cook_chef, chemist, dancer, decorator, dentist,
            designer, physician, dressmaker, dustman, economist, electrician,
            engineer, farmer, fireman, fisherman, florist, fruiterer, gardener,
            geologist, hairdresser, jeweller, journalist, judge, lawyer,
            librarian, life_guard, mailman_postman, mechanic, meteorologist,
            cryptocurrency_miner, mineral_miner, model, nanny_nursemaid, nun,
            nurse, painter, pastry_cook, pharmacist, photographer, physicist,
            plumber, policeman_policewoman, politician, priest,
            professor_teacher, programmer, psychiatrist, psychologist,
            receptionist, researcher_scientist, sailor, salesman, secretary,
            shop_assistant, singer, social_worker, sportsman, surgeon,
            taxi_driver, telephone_operator, travel_agent, veterinarian,
            waiter_waitress, writer, deliveryman, uber_driver, pilot,
            administrative, public_servant, other, customer_care, military,
            manager_officier.</p>
        gender:
          type: integer
          enum:
            - 0
            - 1
          description: 'User gender. One of: **0** woman, **1** man.'
          x-gitbook-description-html: >-
            <p>User gender. One of: <strong>0</strong> woman, <strong>1</strong>
            man.</p>
        city:
          type: string
          description: City of residence.
          x-gitbook-description-html: <p>City of residence.</p>
        street:
          type: string
          description: Street of residence.
          x-gitbook-description-html: <p>Street of residence.</p>
        country:
          type: string
          description: Country of residence, given by the ISO 3166-1 alpha-2 standard.
          x-gitbook-description-html: >-
            <p>Country of residence, given by the ISO 3166-1 alpha-2
            standard.</p>
        subject_comply:
          type: string
          description: >-
            **bool**. If user or company is financilly or legally regulated.
            Required if `country` is `AR`.
          x-gitbook-description-html: >-
            <p><strong>bool</strong>. If user or company is financilly or
            legally regulated. Required if <code>country</code> is
            <code>AR</code>.</p>
        province:
          type: integer
          enum:
            - 1
            - 10
            - 14
            - 20
            - 43
            - 3
            - 15
            - 5
            - 13
            - 11
            - 18
            - 9
            - 4
            - 16
            - 19
            - 21
            - 12
            - 7
            - 8
            - 22
            - 2
            - 6
            - 23
            - 17
          description: >-
            Province of residence. Required if `country` is `AR`. One of: **1**
            Buenos Aires, **10** Catamarca, **14** Chaco, **20** Chubut, **43**
            Ciudad Autónoma de Buenos Aires, **3** Córdoba, **15** Corrientes,
            **5** Entre Ríos, **13** Formosa, **11** Jujuy, **18** La Pampa,
            **9** La Rioja, **4** Mendoza, **16** Misiones, **19** Neuquén,
            **21** Río Negro, **12** Salta, **7** San Juan, **8** San Luis,
            **22** Santa Cruz, **2** Santa Fe, **6** Santiago del Estero, **23**
            Tierra del Fuego, Antártida e Islas del Atlántico Sur, **17**
            Tucumán.
          x-gitbook-description-html: >-
            <p>Province of residence. Required if <code>country</code> is
            <code>AR</code>. One of: <strong>1</strong> Buenos Aires,
            <strong>10</strong> Catamarca, <strong>14</strong> Chaco,
            <strong>20</strong> Chubut, <strong>43</strong> Ciudad Autónoma de
            Buenos Aires, <strong>3</strong> Córdoba, <strong>15</strong>
            Corrientes, <strong>5</strong> Entre Ríos, <strong>13</strong>
            Formosa, <strong>11</strong> Jujuy, <strong>18</strong> La Pampa,
            <strong>9</strong> La Rioja, <strong>4</strong> Mendoza,
            <strong>16</strong> Misiones, <strong>19</strong> Neuquén,
            <strong>21</strong> Río Negro, <strong>12</strong> Salta,
            <strong>7</strong> San Juan, <strong>8</strong> San Luis,
            <strong>22</strong> Santa Cruz, <strong>2</strong> Santa Fe,
            <strong>6</strong> Santiago del Estero, <strong>23</strong> Tierra
            del Fuego, Antártida e Islas del Atlántico Sur, <strong>17</strong>
            Tucumán.</p>
        district:
          type: string
          description: District of residence. Required if `country` is `BR`.
          x-gitbook-description-html: >-
            <p>District of residence. Required if <code>country</code> is
            <code>BR</code>.</p>
        number:
          type: string
          description: Number of residence. Required if `country` is `BR`.
          x-gitbook-description-html: >-
            <p>Number of residence. Required if <code>country</code> is
            <code>BR</code>.</p>
        state:
          type: string
          enum:
            - RO
            - AC
            - AM
            - RR
            - PA
            - AP
            - TO
            - MA
            - PI
            - CE
            - RN
            - PB
            - PE
            - AL
            - SE
            - BA
            - MG
            - ES
            - RJ
            - SP
            - PR
            - SC
            - RS
            - MS
            - MT
            - GO
            - DF
          description: >-
            State of residence. Required if `country` is `BR`. One of: **RO**
            Rondônia, **AC** Acre, **AM** Amazonas, **RR** Roraima, **PA** Pará,
            **AP** Amapá, **TO** Tocantins, **MA** Maranhão, **PI** Piauí,
            **CE** Ceará, **RN** Rio Grande do Norte, **PB** Paraíba, **PE**
            Pernambuco, **AL** Alagoas, **SE** Sergipe, **BA** Bahia, **MG**
            Minas Gerais, **ES** Espírito Santo, **RJ** Rio de Janeiro, **SP**
            São Paulo, **PR** Paraná, **SC** Santa Catarina, **RS** Rio Grande
            do Sul, **MS** Mato Grosso do Sul, **MT** Mato Grosso, **GO** Goiás,
            **DF** Distrito Federal.
          x-gitbook-description-html: >-
            <p>State of residence. Required if <code>country</code> is
            <code>BR</code>. One of: <strong>RO</strong> Rondônia,
            <strong>AC</strong> Acre, <strong>AM</strong> Amazonas,
            <strong>RR</strong> Roraima, <strong>PA</strong> Pará,
            <strong>AP</strong> Amapá, <strong>TO</strong> Tocantins,
            <strong>MA</strong> Maranhão, <strong>PI</strong> Piauí,
            <strong>CE</strong> Ceará, <strong>RN</strong> Rio Grande do Norte,
            <strong>PB</strong> Paraíba, <strong>PE</strong> Pernambuco,
            <strong>AL</strong> Alagoas, <strong>SE</strong> Sergipe,
            <strong>BA</strong> Bahia, <strong>MG</strong> Minas Gerais,
            <strong>ES</strong> Espírito Santo, <strong>RJ</strong> Rio de
            Janeiro, <strong>SP</strong> São Paulo, <strong>PR</strong> Paraná,
            <strong>SC</strong> Santa Catarina, <strong>RS</strong> Rio Grande
            do Sul, <strong>MS</strong> Mato Grosso do Sul, <strong>MT</strong>
            Mato Grosso, <strong>GO</strong> Goiás, <strong>DF</strong> Distrito
            Federal.</p>
        comune:
          type: string
          enum:
            - Arica
            - Camarones
            - General Lagos
            - Putre
            - Alto Hospicio
            - Camiña
            - Colchane
            - Huara
            - Iquique
            - Pica
            - Pozo Almonte
            - Antofagasta
            - Calama
            - María Elena
            - Mejillones
            - Ollagüe
            - San Pedro de Atacama
            - Sierra Gorda
            - Taltal
            - Tocopilla
            - Alto del Carmen
            - Caldera
            - Chañaral
            - Copiapó
            - Diego de Almagro
            - Freirina
            - Huasco
            - Tierra Amarilla
            - Vallenar
            - Andacollo
            - Canela
            - Combarbalá
            - Coquimbo
            - Illapel
            - La Higuera
            - La Serena
            - Los Vilos
            - Monte Patria
            - Ovalle
            - Paiguano
            - Punitaqui
            - Río Hurtado
            - Salamanca
            - Vicuña
            - Algarrobo
            - Cabildo
            - Calera
            - Calle Larga
            - Cartagena
            - Casablanca
            - Catemu
            - Concón
            - El Quisco
            - El Tabo
            - Hijuelas
            - Isla de Pascua
            - Juan Fernández
            - La Cruz
            - La Ligua
            - Limache
            - Llaillay
            - Los Andes
            - Nogales
            - Olmué
            - Panquehue
            - Papudo
            - Petorca
            - Puchuncaví
            - Putaendo
            - Quillota
            - Quilpué
            - Quintero
            - Rinconada
            - San Antonio
            - San Esteban
            - San Felipe
            - Santa María
            - Santo Domingo
            - Valparaíso
            - Villa Alemana
            - Viña del Mar
            - Zapallar
            - Alhué
            - Buin
            - Calera de Tango
            - Cerrillos
            - Cerro Navia
            - Colina
            - Conchalí
            - Curacaví
            - El Bosque
            - El Monte
            - Estación Central
            - Huechuraba
            - Independencia
            - Isla de Maipo
            - La Cisterna
            - La Florida
            - La Granja
            - La Pintana
            - La Reina
            - Lampa
            - Las Condes
            - Lo Barnechea
            - Lo Espejo
            - Lo Prado
            - Macul
            - Maipú
            - María Pinto
            - Melipilla
            - Ñuñoa
            - Padre Hurtado
            - Paine
            - Pedro Aguirre Cerda
            - Peñaflor
            - Peñalolén
            - Pirque
            - Providencia
            - Pudahuel
            - Puente Alto
            - Quilicura
            - Quinta Normal
            - Recoleta
            - Renca
            - San Bernardo
            - San Joaquín
            - San José de Maipo
            - San Miguel
            - San Pedro
            - San Ramón
            - Santiago
            - Talagante
            - Tiltil
            - Vitacura
            - Chimbarongo
            - Chépica
            - Codegua
            - Coinco
            - Coltauco
            - Doñihue
            - Graneros
            - La Estrella
            - Las Cabras
            - Litueche
            - Lolol
            - Machalí
            - Malloa
            - Marchihue
            - Nancagua
            - Navidad
            - Olivar
            - Palmilla
            - Paredones
            - Peralillo
            - Peumo
            - Pichidegua
            - Pichilemu
            - Placilla
            - Pumanque
            - Quinta de Tilcoco
            - Rancagua
            - Rengo
            - Requínoa
            - San Fernando
            - San Francisco de Mostazal
            - San Vicente de Tagua Tagua
            - Santa Cruz
            - Cauquenes
            - Chanco
            - Colbún
            - Constitución
            - Curepto
            - Curicó
            - Empedrado
            - Hualañé
            - Licantén
            - Linares
            - Longaví
            - Maule
            - Molina
            - Parral
            - Pelarco
            - Pelluhue
            - Pencahue
            - Rauco
            - Retiro
            - Romeral
            - Río Claro
            - Sagrada Familia
            - San Clemente
            - San Javier de Loncomilla
            - San Rafael
            - Talca
            - Teno
            - Vichuquén
            - Villa Alegre
            - Yerbas Buenas
            - Bulnes
            - Chillán Viejo
            - Chillán
            - Cobquecura
            - Coelemu
            - Coihueco
            - El Carmen
            - Ninhue
            - Ñiquén
            - Pemuco
            - Pinto
            - Portezuelo
            - Quillón
            - Quirihue
            - Ránquil
            - San Carlos
            - San Fabián
            - San Ignacio
            - San Nicolás
            - Treguaco
            - Yungay
            - Alto Biobío
            - Antuco
            - Arauco
            - Cabrero
            - Cañete
            - Chiguayante
            - Concepción
            - Contulmo
            - Coronel
            - Curanilahue
            - Florida
            - Hualpén
            - Hualqui
            - Laja
            - Lebu
            - Los Álamos
            - Los Ángeles
            - Lota
            - Mulchén
            - Nacimiento
            - Negrete
            - Penco
            - Quilaco
            - Quilleco
            - San Pedro de la Paz
            - San Rosendo
            - Santa Bárbara
            - Santa Juana
            - Talcahuano
            - Tirúa
            - Tomé
            - Tucapel
            - Yumbel
            - Angol
            - Carahue
            - Cholchol
            - Collipulli
            - Cunco
            - Curacautín
            - Curarrehue
            - Ercilla
            - Freire
            - Galvarino
            - Gorbea
            - Lautaro
            - Loncoche
            - Lonquimay
            - Los Sauces
            - Lumaco
            - Melipeuco
            - Nueva Imperial
            - Padre las Casas
            - Perquenco
            - Pitrufquén
            - Pucón
            - Purén
            - Renaico
            - Saavedra
            - Temuco
            - Teodoro Schmidt
            - Toltén
            - Traiguén
            - Victoria
            - Vilcún
            - Villarrica
            - Corral
            - Futrono
            - La Unión
            - Lago Ranco
            - Lanco
            - Los Lagos
            - Mariquina
            - Máfil
            - Paillaco
            - Panguipulli
            - Río Bueno
            - Valdivia
            - Ancud
            - Calbuco
            - Castro
            - Chaitén
            - Chonchi
            - Cochamó
            - Curaco de Vélez
            - Dalcahue
            - Fresia
            - Frutillar
            - Futaleufú
            - Hualaihué
            - Llanquihue
            - Los Muermos
            - Maullín
            - Osorno
            - Palena
            - Puerto Montt
            - Puerto Octay
            - Puerto Varas
            - Puqueldón
            - Purranque
            - Puyehue
            - Queilén
            - Quellón
            - Quemchi
            - Quinchao
            - Río Negro
            - San Juan de la Costa
            - San Pablo
            - Aisén
            - Chile Chico
            - Cisnes
            - Cochrane
            - Coihaique
            - Guaitecas
            - Lago Verde
            - O’Higgins
            - Río Ibáñez
            - Tortel
            - Antártica
            - Cabo de Hornos Ex Navarino
            - Laguna Blanca
            - Natales
            - Porvenir
            - Primavera
            - Punta Arenas
            - Río Verde
            - San Gregorio
            - Timaukel
            - Torres del Paine
          description: >-
            Commune of residence. Required if `country` is `CL`. One of: Arica,
            Camarones, General Lagos, Putre, Alto Hospicio, Camiña, Colchane,
            Huara, Iquique, Pica, Pozo Almonte, Antofagasta, Calama, María
            Elena, Mejillones, Ollagüe, San Pedro de Atacama, Sierra Gorda,
            Taltal, Tocopilla, Alto del Carmen, Caldera, Chañaral, Copiapó,
            Diego de Almagro, Freirina, Huasco, Tierra Amarilla, Vallenar,
            Andacollo, Canela, Combarbalá, Coquimbo, Illapel, La Higuera, La
            Serena, Los Vilos, Monte Patria, Ovalle, Paiguano, Punitaqui, Río
            Hurtado, Salamanca, Vicuña, Algarrobo, Cabildo, Calera, Calle Larga,
            Cartagena, Casablanca, Catemu, Concón, El Quisco, El Tabo, Hijuelas,
            Isla de Pascua, Juan Fernández, La Cruz, La Ligua, Limache,
            Llaillay, Los Andes, Nogales, Olmué, Panquehue, Papudo, Petorca,
            Puchuncaví, Putaendo, Quillota, Quilpué, Quintero, Rinconada, San
            Antonio, San Esteban, San Felipe, Santa María, Santo Domingo,
            Valparaíso, Villa Alemana, Viña del Mar, Zapallar, Alhué, Buin,
            Calera de Tango, Cerrillos, Cerro Navia, Colina, Conchalí, Curacaví,
            El Bosque, El Monte, Estación Central, Huechuraba, Independencia,
            Isla de Maipo, La Cisterna, La Florida, La Granja, La Pintana, La
            Reina, Lampa, Las Condes, Lo Barnechea, Lo Espejo, Lo Prado, Macul,
            Maipú, María Pinto, Melipilla, Ñuñoa, Padre Hurtado, Paine, Pedro
            Aguirre Cerda, Peñaflor, Peñalolén, Pirque, Providencia, Pudahuel,
            Puente Alto, Quilicura, Quinta Normal, Recoleta, Renca, San
            Bernardo, San Joaquín, San José de Maipo, San Miguel, San Pedro, San
            Ramón, Santiago, Talagante, Tiltil, Vitacura, Chimbarongo, Chépica,
            Codegua, Coinco, Coltauco, Doñihue, Graneros, La Estrella, Las
            Cabras, Litueche, Lolol, Machalí, Malloa, Marchihue, Nancagua,
            Navidad, Olivar, Palmilla, Paredones, Peralillo, Peumo, Pichidegua,
            Pichilemu, Placilla, Pumanque, Quinta de Tilcoco, Rancagua, Rengo,
            Requínoa, San Fernando, San Francisco de Mostazal, San Vicente de
            Tagua Tagua, Santa Cruz, Cauquenes, Chanco, Colbún, Constitución,
            Curepto, Curicó, Empedrado, Hualañé, Licantén, Linares, Longaví,
            Maule, Molina, Parral, Pelarco, Pelluhue, Pencahue, Rauco, Retiro,
            Romeral, Río Claro, Sagrada Familia, San Clemente, San Javier de
            Loncomilla, San Rafael, Talca, Teno, Vichuquén, Villa Alegre, Yerbas
            Buenas, Bulnes, Chillán Viejo, Chillán, Cobquecura, Coelemu,
            Coihueco, El Carmen, Ninhue, Ñiquén, Pemuco, Pinto, Portezuelo,
            Quillón, Quirihue, Ránquil, San Carlos, San Fabián, San Ignacio, San
            Nicolás, Treguaco, Yungay, Alto Biobío, Antuco, Arauco, Cabrero,
            Cañete, Chiguayante, Concepción, Contulmo, Coronel, Curanilahue,
            Florida, Hualpén, Hualqui, Laja, Lebu, Los Álamos, Los Ángeles,
            Lota, Mulchén, Nacimiento, Negrete, Penco, Quilaco, Quilleco, San
            Pedro de la Paz, San Rosendo, Santa Bárbara, Santa Juana,
            Talcahuano, Tirúa, Tomé, Tucapel, Yumbel, Angol, Carahue, Cholchol,
            Collipulli, Cunco, Curacautín, Curarrehue, Ercilla, Freire,
            Galvarino, Gorbea, Lautaro, Loncoche, Lonquimay, Los Sauces, Lumaco,
            Melipeuco, Nueva Imperial, Padre las Casas, Perquenco, Pitrufquén,
            Pucón, Purén, Renaico, Saavedra, Temuco, Teodoro Schmidt, Toltén,
            Traiguén, Victoria, Vilcún, Villarrica, Corral, Futrono, La Unión,
            Lago Ranco, Lanco, Los Lagos, Mariquina, Máfil, Paillaco,
            Panguipulli, Río Bueno, Valdivia, Ancud, Calbuco, Castro, Chaitén,
            Chonchi, Cochamó, Curaco de Vélez, Dalcahue, Fresia, Frutillar,
            Futaleufú, Hualaihué, Llanquihue, Los Muermos, Maullín, Osorno,
            Palena, Puerto Montt, Puerto Octay, Puerto Varas, Puqueldón,
            Purranque, Puyehue, Queilén, Quellón, Quemchi, Quinchao, Río Negro,
            San Juan de la Costa, San Pablo, Aisén, Chile Chico, Cisnes,
            Cochrane, Coihaique, Guaitecas, Lago Verde, O’Higgins, Río Ibáñez,
            Tortel, Antártica, Cabo de Hornos (Ex Navarino), Laguna Blanca,
            Natales, Porvenir, Primavera, Punta Arenas, Río Verde, San Gregorio,
            Timaukel, Torres del Paine.
          x-gitbook-description-html: >-
            <p>Commune of residence. Required if <code>country</code> is
            <code>CL</code>. One of: Arica, Camarones, General Lagos, Putre,
            Alto Hospicio, Camiña, Colchane, Huara, Iquique, Pica, Pozo Almonte,
            Antofagasta, Calama, María Elena, Mejillones, Ollagüe, San Pedro de
            Atacama, Sierra Gorda, Taltal, Tocopilla, Alto del Carmen, Caldera,
            Chañaral, Copiapó, Diego de Almagro, Freirina, Huasco, Tierra
            Amarilla, Vallenar, Andacollo, Canela, Combarbalá, Coquimbo,
            Illapel, La Higuera, La Serena, Los Vilos, Monte Patria, Ovalle,
            Paiguano, Punitaqui, Río Hurtado, Salamanca, Vicuña, Algarrobo,
            Cabildo, Calera, Calle Larga, Cartagena, Casablanca, Catemu, Concón,
            El Quisco, El Tabo, Hijuelas, Isla de Pascua, Juan Fernández, La
            Cruz, La Ligua, Limache, Llaillay, Los Andes, Nogales, Olmué,
            Panquehue, Papudo, Petorca, Puchuncaví, Putaendo, Quillota, Quilpué,
            Quintero, Rinconada, San Antonio, San Esteban, San Felipe, Santa
            María, Santo Domingo, Valparaíso, Villa Alemana, Viña del Mar,
            Zapallar, Alhué, Buin, Calera de Tango, Cerrillos, Cerro Navia,
            Colina, Conchalí, Curacaví, El Bosque, El Monte, Estación Central,
            Huechuraba, Independencia, Isla de Maipo, La Cisterna, La Florida,
            La Granja, La Pintana, La Reina, Lampa, Las Condes, Lo Barnechea, Lo
            Espejo, Lo Prado, Macul, Maipú, María Pinto, Melipilla, Ñuñoa, Padre
            Hurtado, Paine, Pedro Aguirre Cerda, Peñaflor, Peñalolén, Pirque,
            Providencia, Pudahuel, Puente Alto, Quilicura, Quinta Normal,
            Recoleta, Renca, San Bernardo, San Joaquín, San José de Maipo, San
            Miguel, San Pedro, San Ramón, Santiago, Talagante, Tiltil, Vitacura,
            Chimbarongo, Chépica, Codegua, Coinco, Coltauco, Doñihue, Graneros,
            La Estrella, Las Cabras, Litueche, Lolol, Machalí, Malloa,
            Marchihue, Nancagua, Navidad, Olivar, Palmilla, Paredones,
            Peralillo, Peumo, Pichidegua, Pichilemu, Placilla, Pumanque, Quinta
            de Tilcoco, Rancagua, Rengo, Requínoa, San Fernando, San Francisco
            de Mostazal, San Vicente de Tagua Tagua, Santa Cruz, Cauquenes,
            Chanco, Colbún, Constitución, Curepto, Curicó, Empedrado, Hualañé,
            Licantén, Linares, Longaví, Maule, Molina, Parral, Pelarco,
            Pelluhue, Pencahue, Rauco, Retiro, Romeral, Río Claro, Sagrada
            Familia, San Clemente, San Javier de Loncomilla, San Rafael, Talca,
            Teno, Vichuquén, Villa Alegre, Yerbas Buenas, Bulnes, Chillán Viejo,
            Chillán, Cobquecura, Coelemu, Coihueco, El Carmen, Ninhue, Ñiquén,
            Pemuco, Pinto, Portezuelo, Quillón, Quirihue, Ránquil, San Carlos,
            San Fabián, San Ignacio, San Nicolás, Treguaco, Yungay, Alto Biobío,
            Antuco, Arauco, Cabrero, Cañete, Chiguayante, Concepción, Contulmo,
            Coronel, Curanilahue, Florida, Hualpén, Hualqui, Laja, Lebu, Los
            Álamos, Los Ángeles, Lota, Mulchén, Nacimiento, Negrete, Penco,
            Quilaco, Quilleco, San Pedro de la Paz, San Rosendo, Santa Bárbara,
            Santa Juana, Talcahuano, Tirúa, Tomé, Tucapel, Yumbel, Angol,
            Carahue, Cholchol, Collipulli, Cunco, Curacautín, Curarrehue,
            Ercilla, Freire, Galvarino, Gorbea, Lautaro, Loncoche, Lonquimay,
            Los Sauces, Lumaco, Melipeuco, Nueva Imperial, Padre las Casas,
            Perquenco, Pitrufquén, Pucón, Purén, Renaico, Saavedra, Temuco,
            Teodoro Schmidt, Toltén, Traiguén, Victoria, Vilcún, Villarrica,
            Corral, Futrono, La Unión, Lago Ranco, Lanco, Los Lagos, Mariquina,
            Máfil, Paillaco, Panguipulli, Río Bueno, Valdivia, Ancud, Calbuco,
            Castro, Chaitén, Chonchi, Cochamó, Curaco de Vélez, Dalcahue,
            Fresia, Frutillar, Futaleufú, Hualaihué, Llanquihue, Los Muermos,
            Maullín, Osorno, Palena, Puerto Montt, Puerto Octay, Puerto Varas,
            Puqueldón, Purranque, Puyehue, Queilén, Quellón, Quemchi, Quinchao,
            Río Negro, San Juan de la Costa, San Pablo, Aisén, Chile Chico,
            Cisnes, Cochrane, Coihaique, Guaitecas, Lago Verde, O’Higgins, Río
            Ibáñez, Tortel, Antártica, Cabo de Hornos (Ex Navarino), Laguna
            Blanca, Natales, Porvenir, Primavera, Punta Arenas, Río Verde, San
            Gregorio, Timaukel, Torres del Paine.</p>
      required:
        - is_business
        - profession
        - gender
        - city
        - street
        - country
        - subject_comply
        - province
        - district
        - number
        - state
        - comune
    VerifyBasicResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        data:
          type: object
          properties:
            metamap_url:
              type: string
              description: Link for the verification process.
              x-gitbook-description-html: <p>Link for the verification process.</p>
          required:
            - metamap_url
      required:
        - status
        - data
    VerifyTraderRequest:
      type: object
      properties:
        pep:
          type: string
          description: '**bool**. If user or company is financilly or legally regulated.'
          x-gitbook-description-html: >-
            <p><strong>bool</strong>. If user or company is financilly or
            legally regulated.</p>
        subject_comply:
          type: string
          description: '**bool**. If user or company is financilly or legally regulated.'
          x-gitbook-description-html: >-
            <p><strong>bool</strong>. If user or company is financilly or
            legally regulated.</p>
        is_public_servant:
          type: string
          description: '**bool**. If user works for a goverment.'
          x-gitbook-description-html: <p><strong>bool</strong>. If user works for a goverment.</p>
        document_address_file:
          type: string
          format: binary
          description: >-
            A document giving proof of residence of the user. The residence must
            be the same as given in the basic verification.
          x-gitbook-description-html: >-
            <p>A document giving proof of residence of the user. The residence
            must be the same as given in the basic verification.</p>
        document_address_type:
          type: integer
          enum:
            - 3
            - 30
            - 35
            - 36
            - 37
            - 38
            - 39
            - 41
            - 40
            - 42
          description: >-
            One of:. **3** SERVICE. **30** PROOF_ADDRESS. **35**
            CREDIT_CARD_BILL. **36** SALARY_STATEMENTS. **37**
            NEIGHBOURS_CERTIFICATE. **38** NOTARY_ADDRESS_CERTIFICATE. **39**
            PRODUCT_BILL_WITH_PAYMENT_CERTIFICATE. **41** SERVICE_WITH_BIRTH.
            **40** SERVICE_WITH_MARRIAGE. **42** DRIVER_LICENSE_WITH_ADDRESS.
          x-gitbook-description-html: >-
            <p>One of:. <strong>3</strong> SERVICE. <strong>30</strong>
            PROOF_ADDRESS. <strong>35</strong> CREDIT_CARD_BILL.
            <strong>36</strong> SALARY_STATEMENTS. <strong>37</strong>
            NEIGHBOURS_CERTIFICATE. <strong>38</strong>
            NOTARY_ADDRESS_CERTIFICATE. <strong>39</strong>
            PRODUCT_BILL_WITH_PAYMENT_CERTIFICATE. <strong>41</strong>
            SERVICE_WITH_BIRTH. <strong>40</strong> SERVICE_WITH_MARRIAGE.
            <strong>42</strong> DRIVER_LICENSE_WITH_ADDRESS.</p>
      required:
        - pep
        - subject_comply
        - is_public_servant
        - document_address_file
        - document_address_type
    VerifyTraderResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
      required:
        - status
    GetTraderPlusVerificationSchemasRequest:
      type: object
      properties:
        country:
          type: string
          description: Country of residence, given by the ISO 3166-1 alpha-2 standard.
          x-gitbook-description-html: >-
            <p>Country of residence, given by the ISO 3166-1 alpha-2
            standard.</p>
        user_id:
          type: string
          description: >-
            If the process is being made for a managed user, then this is the
            user id of the managed user.
          x-gitbook-description-html: >-
            <p>If the process is being made for a managed user, then this is the
            user id of the managed user.</p>
      required:
        - country
    GetTraderPlusVerificationSchemasResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        data:
          type: array
          items:
            type: object
            description: the schema.
            x-gitbook-description-html: <p>the schema.</p>
      required:
        - status
        - data
    VerifyTraderPlusRequest:
      type: object
      properties:
        user_id:
          type: string
          description: >-
            If the process is being made for a managed user, then this is the
            user id of the managed user.
          x-gitbook-description-html: >-
            <p>If the process is being made for a managed user, then this is the
            user id of the managed user.</p>
        country:
          type: string
          description: Country of the user, given by the ISO 3166-1 alpha-2 standard.
          x-gitbook-description-html: >-
            <p>Country of the user, given by the ISO 3166-1 alpha-2
            standard.</p>
        declaration_template_id:
          type: string
          description: The id of the schema.
          x-gitbook-description-html: <p>The id of the schema.</p>
        declaration_id:
          type: string
          description: The id of the declaration.
          x-gitbook-description-html: <p>The id of the declaration.</p>
        '{filed_name}':
          oneOf:
            - type: integer
            - type: string
            - type: boolean
          description: >-
            A value required by the schema, its key (*field_key*) is defined in
            the corresponding schema. This endpoint may required many field like
            this. depending on the schema.
          x-gitbook-description-html: >-
            <p>A value required by the schema, its key (<em>field_key</em>) is
            defined in the corresponding schema. This endpoint may required many
            field like this. depending on the schema.</p>
        '{file_name}':
          type: string
          format: binary
          description: >-
            A File, its key (*file_name*) is defined in the corresponding
            schema. This endpoint may require many fields like this, depending
            on the schema.
          x-gitbook-description-html: >-
            <p>A File, its key (<em>file_name</em>) is defined in the
            corresponding schema. This endpoint may require many fields like
            this, depending on the schema.</p>
      required:
        - country
        - declaration_template_id
        - declaration_id
        - '{filed_name}'
        - '{file_name}'
    VerifyTraderPlusResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
      required:
        - status
    GetInstitutionalCompanySchemasRequest:
      type: object
      properties:
        country:
          type: string
          description: >-
            Country of the company to be verified as a 2 character
            representation, given by the ISO 3166-1 alpha-2 standard. Examples:
            AR, BR, CL, CO, PE.
          x-gitbook-description-html: >-
            <p>Country of the company to be verified as a 2 character
            representation, given by the ISO 3166-1 alpha-2 standard. Examples:
            AR, BR, CL, CO, PE.</p>
      required:
        - country
    GetInstitutionalCompanySchemasResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        data:
          type: array
          items:
            type: object
            description: the schema.
            x-gitbook-description-html: <p>the schema.</p>
      required:
        - status
        - data
    VerifyInstitutionalCompanyRequest:
      type: object
      properties:
        declaration_template_id:
          type: integer
          description: The id of the schema.
          x-gitbook-description-html: <p>The id of the schema.</p>
        declaration_id:
          type: integer
          description: The id of the declaration.
          x-gitbook-description-html: <p>The id of the declaration.</p>
        country:
          type: string
          description: Country of the company, given by the ISO 3166-1 alpha-2 standard.
          x-gitbook-description-html: >-
            <p>Country of the company, given by the ISO 3166-1 alpha-2
            standard.</p>
        user_id:
          type: string
          description: >-
            User that will be verifying the company. If not provided, then the
            authenticated user making the method call will be considered.
          x-gitbook-description-html: >-
            <p>User that will be verifying the company. If not provided, then
            the authenticated user making the method call will be
            considered.</p>
        '{filed_name}':
          oneOf:
            - type: integer
            - type: string
            - type: boolean
          description: >-
            A value required by the schema, its key (*field_key*) is defined in
            the corresponding schema. This endpoint may required many field like
            this. depending on the schema.
          x-gitbook-description-html: >-
            <p>A value required by the schema, its key (<em>field_key</em>) is
            defined in the corresponding schema. This endpoint may required many
            field like this. depending on the schema.</p>
        '{file_name}':
          type: string
          format: binary
          description: >-
            A File, the field key (*file_name*) is defined in the corresponding
            schema. This endpoint may require many fields like this, depending
            on the schema.
          x-gitbook-description-html: >-
            <p>A File, the field key (<em>file_name</em>) is defined in the
            corresponding schema. This endpoint may require many fields like
            this, depending on the schema.</p>
      required:
        - declaration_template_id
        - country
        - '{filed_name}'
        - '{file_name}'
    VerifyInstitutionalCompanyResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
      required:
        - status
    GetInstitutionalCompanyVerificationStatusResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        data:
          type: object
          properties:
            status:
              type: string
              enum:
                - success
                - in_review
                - pending
                - error
                - expired
              description: 'One of: success, in_review, pending, error, expired.'
              x-gitbook-description-html: '<p>One of: success, in_review, pending, error, expired.</p>'
            form:
              type: object
              description: The company information.
              properties:
                country:
                  type: string
                  description: Country of the company.
                  x-gitbook-description-html: <p>Country of the company.</p>
                city:
                  type: string
                  description: City of the company.
                  x-gitbook-description-html: <p>City of the company.</p>
                province:
                  type: string
                  description: Province of the company.
                  x-gitbook-description-html: <p>Province of the company.</p>
                address:
                  type: string
                  description: Address of the company.
                  x-gitbook-description-html: <p>Address of the company.</p>
                name:
                  type: string
                  description: Name of the company.
                  x-gitbook-description-html: <p>Name of the company.</p>
                identity:
                  type: string
                  description: Identity of the company.
                  x-gitbook-description-html: <p>Identity of the company.</p>
                field:
                  type: string
                  description: Sector of the company.
                  x-gitbook-description-html: <p>Sector of the company.</p>
              required:
                - country
                - city
                - province
                - address
                - name
                - identity
                - field
              x-gitbook-description-html: <p>The company information.</p>
          required:
            - status
            - form
      required:
        - status
        - data
    GetInstitutionalMemberTypesResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        data:
          type: array
          items:
            type: object
            properties:
              value:
                type: integer
                description: The ID of the member type.
                x-gitbook-description-html: <p>The ID of the member type.</p>
              label:
                type: string
                description: Member type description.
                x-gitbook-description-html: <p>Member type description.</p>
            required:
              - value
              - label
      required:
        - status
        - data
    GetInstitutionalMemberSchemasRequest:
      type: object
      properties:
        country:
          type: string
          description: >-
            Country of the company to be verified, given by the ISO 3166-1
            alpha-2 standard.
          x-gitbook-description-html: >-
            <p>Country of the company to be verified, given by the ISO 3166-1
            alpha-2 standard.</p>
        member_type:
          type: integer
          enum:
            - 1
            - 2
            - 3
          description: >-
            Member type. One of: **1** Directory, **2** Beneficial owner, **3**
            Legal representative.
          x-gitbook-description-html: >-
            <p>Member type. One of: <strong>1</strong> Directory,
            <strong>2</strong> Beneficial owner, <strong>3</strong> Legal
            representative.</p>
      required:
        - country
        - member_type
    GetInstitutionalMemberSchemasResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        data:
          type: object
          description: the schema.
          x-gitbook-description-html: <p>the schema.</p>
      required:
        - status
        - data
    VerifyInstitutionalMemberRequest:
      type: object
      properties:
        member_type:
          type: integer
          description: Member type id.
          x-gitbook-description-html: <p>Member type id.</p>
        member_template_id:
          type: string
          description: Member scheme id.
          x-gitbook-description-html: <p>Member scheme id.</p>
        '{filed_name}':
          oneOf:
            - type: integer
            - type: string
            - type: boolean
          description: >-
            A value required by the schema, its key (*field_key*) is defined in
            the corresponding schema. This endpoint may required many field like
            this. depending on the schema.
          x-gitbook-description-html: >-
            <p>A value required by the schema, its key (<em>field_key</em>) is
            defined in the corresponding schema. This endpoint may required many
            field like this. depending on the schema.</p>
        '{file_name}':
          type: string
          format: binary
          description: >-
            A File, fhe field key (*file_name*) is defined in the corresponding
            schema. This endpoint may require many fields like this, depending
            on the schema.
          x-gitbook-description-html: >-
            <p>A File, fhe field key (<em>file_name</em>) is defined in the
            corresponding schema. This endpoint may require many fields like
            this, depending on the schema.</p>
      required:
        - member_type
        - member_template_id
        - '{filed_name}'
        - '{file_name}'
    VerifyInstitutionalMemberResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
      required:
        - status
    GetInstitutionalMemberVerificationStatusResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        data:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
                description: Role of the user inside the company.
                x-gitbook-description-html: <p>Role of the user inside the company.</p>
              name:
                type: string
                description: Name of an user part of the company.
                x-gitbook-description-html: <p>Name of an user part of the company.</p>
              createdAt:
                type: string
                description: Creation time of the verification request.
                x-gitbook-description-html: <p>Creation time of the verification request.</p>
              status:
                type: string
                enum:
                  - success
                  - error
                  - pending
                description: 'One of: success, error, pending.'
                x-gitbook-description-html: '<p>One of: success, error, pending.</p>'
            required:
              - type
              - name
              - createdAt
              - status
      required:
        - status
        - data
    GetInstitutionalDocumentTypesResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        data:
          type: array
          items:
            type: object
            properties:
              value:
                type: integer
                description: The ID of the document type.
                x-gitbook-description-html: <p>The ID of the document type.</p>
              label:
                type: string
                description: Document type description.
                x-gitbook-description-html: <p>Document type description.</p>
            required:
              - value
              - label
      required:
        - status
        - data
    VerifyInstitutionalDocumentRequest:
      type: object
      properties:
        type:
          type: integer
          description: Document type as given in document types.
          x-gitbook-description-html: <p>Document type as given in document types.</p>
        file:
          type: string
          format: binary
          description: The document to verify.
          x-gitbook-description-html: <p>The document to verify.</p>
      required:
        - type
        - file
    VerifyInstitutionalDocumentResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
      required:
        - status
    GetInstitutionalDocumentVerificationStatusResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: integer
                description: The id of the document type.
                x-gitbook-description-html: <p>The id of the document type.</p>
              type:
                type: string
                description: The document type.
                x-gitbook-description-html: <p>The document type.</p>
              name:
                type: string
                description: Name of the document file.
                x-gitbook-description-html: <p>Name of the document file.</p>
              createdAt:
                type: string
                description: Creation time of the verification request.
                x-gitbook-description-html: <p>Creation time of the verification request.</p>
              status:
                type: string
                enum:
                  - success
                  - error
                  - pending
                description: 'One of: success, error, pending.'
                x-gitbook-description-html: '<p>One of: success, error, pending.</p>'
            required:
              - id
              - type
              - name
              - createdAt
              - status
      required:
        - status
        - data
    GetVerificationStatusRequest:
      type: object
      properties:
        user_id:
          type: string
          description: >-
            The ID of the user to get the verification status from. If not
            defined, the verification status is for the authenticated user
            making the call.
          x-gitbook-description-html: >-
            <p>The ID of the user to get the verification status from. If not
            defined, the verification status is for the authenticated user
            making the call.</p>
      required: []
    GetVerificationStatusResponse:
      type: object
      properties:
        status:
          type: string
          enum:
            - success
          example: success
        data:
          type: object
          properties:
            id:
              type: string
              description: The ID of the verification process.
              x-gitbook-description-html: <p>The ID of the verification process.</p>
            type:
              type: string
              enum:
                - basic
                - trader
                - trader_plus
                - institutional
              description: 'One of: basic, trader, trader_plus, institutional.'
              x-gitbook-description-html: '<p>One of: basic, trader, trader_plus, institutional.</p>'
            status:
              type: string
              enum:
                - pending
                - approved
                - rejected
              description: 'One of: pending, approved, rejected.'
              x-gitbook-description-html: '<p>One of: pending, approved, rejected.</p>'
            has_errors:
              type: boolean
              description: If a current verification process has errors.
              x-gitbook-description-html: <p>If a current verification process has errors.</p>
            errors:
              type: array
              items:
                type: string
              description: The possible errors of the verification process.
              x-gitbook-description-html: <p>The possible errors of the verification process.</p>
            is_business:
              type: boolean
              description: If the current user is considered a business (an institution).
              x-gitbook-description-html: >-
                <p>If the current user is considered a business (an
                institution).</p>
            verification_tier:
              type: integer
              enum:
                - 0
                - 1
                - 2
                - 3
                - 4
              description: 'One of: 0, 1, 2, 3, 4.'
              x-gitbook-description-html: '<p>One of: 0, 1, 2, 3, 4.</p>'
            current_process_data:
              type: object
              description: Current user verification data in notbank.
              x-gitbook-description-html: <p>Current user verification data in notbank.</p>
          required:
            - id
            - type
            - status
            - has_errors
            - errors
            - is_business
            - verification_tier
            - current_process_data
      required:
        - status
        - data
