---
components:
  schemas:
    Account:
      properties:
        account_number:
          example: '5366'
          type: string
        apr:
          example: 1.0
          type: number
        apy:
          example: 1.0
          type: number
        available_balance:
          example: 1000.0
          type: number
        available_credit:
          example: 1000.0
          type: number
        balance:
          example: 1000.0
          type: number
        cash_balance:
          example: 1000.0
          type: number
        cash_surrender_value:
          example: 1000.0
          type: number
        created_at:
          example: '2016-10-13T17:57:37.000Z'
          type: string
        credit_limit:
          example: 100.0
          type: number
        currency_code:
          example: USD
          type: string
        day_payment_is_due:
          example: 20
          type: integer
        death_benefit:
          example: 1000
          type: integer
        guid:
          example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          type: string
        holdings_value:
          example: 1000.0
          type: number
        id:
          example: '1040434698'
          type: string
        institution_code:
          example: chase
          type: string
        insured_name:
          example: Frodo Baggins
          type: string
        interest_rate:
          example: 1.0
          type: number
        is_closed:
          example: false
          type: boolean
        is_hidden:
          example: false
          type: boolean
        last_payment:
          example: 100.0
          type: number
        last_payment_at:
          example: '2015-10-13T17:57:37.000Z'
          type: string
        loan_amount:
          example: 1000.0
          type: number
        matures_on:
          example: '2015-10-13T17:57:37.000Z'
          type: string
        member_guid:
          example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          type: string
        minimum_balance:
          example: 100.0
          type: number
        minimum_payment:
          example: 10.0
          type: number
        name:
          example: Test account 2
          type: string
        original_balance:
          example: 10.0
          type: number
        pay_out_amount:
          example: 10.0
          type: number
        payment_due_at:
          example: '2015-10-13T17:57:37.000Z'
          type: string
        payoff_balance:
          example: 10.0
          type: number
        premium_amount:
          example: 1.0
          type: number
        started_on:
          example: '2015-10-13T17:57:37.000Z'
          type: string
        subtype:
          example: NONE
          type: string
        total_account_value:
          example: 1.0
          type: number
        type:
          example: SAVINGS
          type: string
        updated_at:
          example: '2016-10-13T18:08:00.000Z'
          type: string
        user_guid:
          example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
          type: string
      type: object
    AccountNumber:
      properties:
        account_guid:
          example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          type: string
        account_number:
          example: '10001'
          type: string
        guid:
          example: ACN-8899832e-e5b4-42cd-aa25-bbf1dc889a8f
          type: string
        institution_number:
          example: '123'
          type: string
        member_guid:
          example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          type: string
        routing_number:
          example: '68899990000000'
          type: string
        transit_number:
          example: '12345'
          type: string
        user_guid:
          example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
          type: string
      type: object
    AccountOwner:
      properties:
        account_guid:
          example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          type: string
        address:
          example: 123 This Way
          type: string
        city:
          example: Middlesex
          type: string
        country:
          example: US
          type: string
        email:
          example: donnie@darko.co
          type: string
        guid:
          example: ACO-63dc7714-6fc0-4aa2-a069-c06cdccd1af9
          type: string
        member_guid:
          example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          type: string
        owner_name:
          example: Donnie Darko
          type: string
        phone:
          example: 555-555-5555
          type: string
        postal_code:
          example: 00000-0000
          type: string
        state:
          example: VA
          type: string
        user_guid:
          example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
          type: string
      type: object
    Category:
      properties:
        created_at:
          example: '2015-04-13T18:01:23.000Z'
          type: string
        guid:
          example: CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874
          type: string
        is_default:
          example: true
          type: boolean
        is_income:
          example: false
          type: boolean
        metadata:
          example: some metadata
          type: string
        name:
          example: Auto Insurance
          type: string
        parent_guid:
          example: CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874
          type: string
        updated_at:
          example: '2015-05-13T18:01:23.000Z'
          type: string
      type: object
    Challenge:
      properties:
        field_name:
          example: Who is this guy?
          type: string
        guid:
          example: CRD-ce76d2e3-86bd-ec4a-ec52-eb53b5194bf5
          type: string
        image_data:
          example: Who is this guy?
          type: string
        image_options:
          items:
            properties:
              data_uri:
                example: data:image/png;base64,iVBORw0KGgoAAAANSUh ... more image
                  data ...
                type: string
              label:
                example: IMAGE_1
                type: string
              value:
                example: image_data
                type: string
            type: object
          type: array
        label:
          example: Who is this guy?
          type: string
        options:
          items:
            properties:
              label:
                example: IMAGE_1
                type: string
              value:
                example: image_data
                type: string
            type: object
          type: array
        type:
          example: IMAGE_DATA
          type: string
      type: object
    ConnectWidget:
      properties:
        connect_widget_url:
          example: https://int-widgets.moneydesktop.com/md/connect/jb1rA14m85tw2lyvpgfx4gc6d3Z8z8Ayb8
          type: string
        guid:
          example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
          type: string
      type: object
    Credential:
      properties:
        display_order:
          example: 1
          type: integer
        field_name:
          example: LOGIN
          type: string
        field_type:
          example: TEXT
          type: string
        guid:
          example: CRD-1ec152cd-e628-e81a-e852-d1e7104624da
          type: string
        label:
          example: Username
          type: string
      type: object
    EnhancedTransaction:
      properties:
        amount:
          example: 21.33
          type: number
        category:
          example: Fast Food
          type: string
        description:
          example: IN-N-OUT BURGER
          type: string
        id:
          example: ID-123
          type: string
        is_bill_pay:
          example: false
          type: boolean
        is_direct_deposit:
          example: false
          type: boolean
        is_expense:
          example: false
          type: boolean
        is_fee:
          example: false
          type: boolean
        is_income:
          example: false
          type: boolean
        is_international:
          example: false
          type: boolean
        is_overdraft_fee:
          example: false
          type: boolean
        is_payroll_advance:
          example: false
          type: boolean
        merchant_category_code:
          example: 5411
          type: integer
        merchant_guid:
          example: MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b
          type: string
        original_description:
          example: IN-N-OUT BURGER
          type: string
        type:
          example: DEBIT
          type: string
      type: object
    Holding:
      properties:
        account_guid:
          example: HOL-d65683e8-9eab-26bb-bcfd-ced159c9abe2
          type: string
        cost_basis:
          example: 827.0
          type: number
        created_at:
          example: '2015-04-13T18:01:23.000Z'
          type: string
        currency_code:
          example: USD
          type: string
        cusip:
          example: 18383M878
          type: string
        daily_change:
          example: 2.5
          type: number
        description:
          example: Guggenheim Defensive Equity ETF
          type: string
        guid:
          example: HOL-d65683e8-9eab-26bb-bcfd-ced159c9abe2
          type: string
        holding_type:
          example: MONEY_MARKET
          type: string
        id:
          example: ID-123
          type: string
        market_value:
          example: 989.5
          type: number
        member_guid:
          example: MBR-d65683e8-9eab-26bb-bcfd-ced159c9abe
          type: string
        metadata:
          example: metadata
          type: string
        purchase_price:
          example: 26.3
          type: number
        shares:
          example: 6.0
          type: number
        symbol:
          example: DEF
          type: string
        updated_at:
          example: '2015-04-13T18:01:23.000Z'
          type: string
        user_guid:
          example: USR-743e5d7f-1116-28fa-5de1-d3ba02e41d8d
          type: string
      type: object
    Institution:
      properties:
        code:
          example: chase
          type: string
        medium_logo_url:
          example: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/100x100/default_100x100.png
          type: string
        name:
          example: Chase Bank
          type: string
        small_logo_url:
          example: https://content.moneydesktop.com/storage/MD_Assets/Ipad%20Logos/50x50/default_50x50.png
          type: string
        supports_account_identification:
          example: true
          type: boolean
        supports_account_statement:
          example: true
          type: boolean
        supports_account_verification:
          example: true
          type: boolean
        supports_oauth:
          example: true
          type: boolean
        supports_transaction_history:
          example: true
          type: boolean
        url:
          example: https://www.chase.com
          type: string
      type: object
    Member:
      properties:
        aggregated_at:
          example: '2016-10-13T18:07:57.000Z'
          type: string
        connection_status:
          example: CONNECTED
          type: string
        guid:
          example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          type: string
        id:
          example: unique_id
          type: string
        institution_code:
          example: chase
          type: string
        is_being_aggregated:
          example: false
          type: boolean
        is_oauth:
          example: false
          type: boolean
        metadata:
          example: '\"credentials_last_refreshed_at\": \"2015-10-15\"'
          type: string
        name:
          example: Chase Bank
          type: string
        oauth_window_uri:
          example: int-widgets.moneydesktop.com/oauth/predirect_to/MBR-df96fd60-7122-4464-b3c2-ff11d8c74f6f/p8v7rxpxg3pdAsfgwxcrwxwhz3Zbygxfr6wAb931qv91hpb57k6bkr6t6m9djrfrfd467p8xkgqp6w7k1r9g8k8bfxqbfw2lq5tdwjq2sngAx76fm0jrw0dpmbtlkxchgjsw3r7r0hhq6A8sshqptfxql2rt123shfpkyhhpfvy67yvprbkb7lmlyrpwsd9yj0s22pmsyjhcw7d2q44d9fsxn5kfsmr2zqc79c2AxAx5gkjgbczf22A1sjx70t2pvnggzyh55s7bh62dd5wq7f1r4x90mcxn1tfhhrq5b09mjkt5hg66cjn700pcf6fgA42lbsp7v1pdch85mswycrp21c6j2sxffm14Asg3?skip_aggregation=false&referral_source=APP&ui_message_webview_url_scheme=myapp
          type: string
        successfully_aggregated_at:
          example: '2016-10-13T17:57:38.000Z'
          type: string
        user_guid:
          example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
          type: string
      type: object
    MemberStatus:
      properties:
        aggregated_at:
          example: '2016-10-13T18:07:57.000Z'
          type: string
        challenges:
          items:
            "$ref": "#/components/schemas/Challenge"
          type: array
        connection_status:
          example: CONNECTED
          type: string
        guid:
          example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          type: string
        has_processed_accounts:
          example: true
          type: boolean
        has_processed_transactions:
          example: false
          type: boolean
        is_authenticated:
          example: false
          type: boolean
        is_being_aggregated:
          example: false
          type: boolean
        successfully_aggregated_at:
          example: '2016-10-13T17:57:38.000Z'
          type: string
      type: object
    Merchant:
      properties:
        created_at:
          example: '2017-04-20T19:30:12.000Z'
          type: string
        guid:
          example: MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b
          type: string
        logo_url:
          example: https://s3.amazonaws.com/MD_Assets/merchant_logos/comcast.png
          type: string
        name:
          example: Comcast
          type: string
        updated_at:
          example: '2018-09-28T21:13:53.000Z'
          type: string
        website_url:
          example: https://www.xfinity.com
          type: string
      type: object
    OAuthWindow:
      properties:
        guid:
          example: MBR-df96fd60-7122-4464-b3c2-ff11d8c74f6f
          type: string
        oauth_window_uri:
          example: int-widgets.moneydesktop.com/oauth/predirect_to/MBR-df96fd60-7122-4464-b3c2-ff11d8c74f6f/zgknnw5k7dmztn2njmwlgz574mZlnft6vdrv7kzn9ptj325th6c5p0w6c7j83Ap1bqg01mhsr1bqjgf2fry3ly9wff497c6fcczbyrfgj7s39cygw95Akl7vlpmcAy2kmvh1mlkytg7jA1z3vnw1w3zx2r1wt65s6f6r3ryqqrysl9qA1kr6cAj6vhr1zl325Azz6hx52j1ll3vwbvvbv5xzy7d6csplyw25brA7147vAfq29ArjjAj4qmc6r6h457hkcj2946m0kjp2xzpkz6hz55lsp3Avmdb8dsq4xzqmzzqk68s6bp5tj9jsskw4wvcb95vm4fwh9w8phgp67hfj2flrtwcy5bxbtk74?skip_aggregation=false
          type: string
      type: object
    Pagination:
      properties:
        current_page:
          example: 1
          type: integer
        per_page:
          example: 25
          type: integer
        total_entries:
          example: 1
          type: integer
        total_pages:
          example: 1
          type: integer
      type: object
    Statement:
      properties:
        account_guid:
          example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          type: string
        content_hash:
          example: ca53785b812d00ef821c3d94bfd6e5bbc0020504410589b7ea8552169f021981
          type: string
        created_at:
          example: '2016-10-13T18:08:00+00:00'
          type: string
        guid:
          example: STA-737a344b-caae-0f6e-1384-01f52e75dcb1
          type: string
        member_guid:
          example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          type: string
        updated_at:
          example: '2016-10-13T18:09:00+00:00'
          type: string
        uri:
          example: uri/to/statement
          type: string
        user_guid:
          example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
          type: string
      type: object
    Tag:
      properties:
        guid:
          example: TAG-aef36e72-6294-4c38-844d-e573e80aed52
          type: string
        name:
          example: MY TAG
          type: string
        user_guid:
          example: USR-11141024-90b3-1bce-cac9-c06ced52ab4c
          type: string
      type: object
    Tagging:
      properties:
        guid:
          example: TGN-007f5486-17e1-45fc-8b87-8f03984430fe
          type: string
        member_is_managed_by_user:
          example: false
          type: boolean
        tag_guid:
          example: TAG-40faf068-abb4-405c-8f6a-e883ed541fff
          type: string
        transaction_guid:
          example: TRN-810828b0-5210-4878-9bd3-f4ce514f90c4
          type: string
        user_guid:
          example: USR-11141024-90b3-1bce-cac9-c06ced52ab4c
          type: string
      type: object
    Transaction:
      properties:
        account_guid:
          example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
          type: string
        amount:
          example: 61.11
          type: number
        category:
          example: Groceries
          type: string
        check_number_string:
          example: '6812'
          type: string
        created_at:
          example: '2016-10-06T09:43:42.000Z'
          type: string
        currency_code:
          example: USD
          type: string
        date:
          example: '2013-09-23T00:00:00.000Z'
          type: string
        description:
          example: Whole foods
          type: string
        guid:
          example: TRN-265abee9-889b-af6a-c69b-25157db2bdd9
          type: string
        id:
          example: transaction-265abee9-889b-af6a-c69b-25157db2bdd9
          type: string
        is_bill_pay:
          example: false
          type: boolean
        is_direct_deposit:
          example: false
          type: boolean
        is_expense:
          example: true
          type: boolean
        is_fee:
          example: false
          type: boolean
        is_income:
          example: false
          type: boolean
        is_international:
          example: false
          type: boolean
        is_overdraft_fee:
          example: false
          type: boolean
        is_payroll_advance:
          example: false
          type: boolean
        is_recurring:
          example: false
          type: boolean
        is_subscription:
          example: false
          type: boolean
        latitude:
          example: -43.2075
          type: number
        localized_description:
          example: This is a localized_description
          type: string
        localized_memo:
          example: This is a localized_memo
          type: string
        longitude:
          example: 139.691706
          type: number
        member_guid:
          example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
          type: string
        memo:
          example: This is a memo
          type: string
        merchant_category_code:
          example: 5411
          type: integer
        merchant_guid:
          example: MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b
          type: string
        original_description:
          example: WHOLEFDS TSQ 102
          type: string
        posted_at:
          example: '2016-10-07T06:00:00.000Z'
          type: string
        status:
          example: POSTED
          type: string
        top_level_category:
          example: Food & Dining
          type: string
        transacted_at:
          example: '2016-10-06T13:00:00.000Z'
          type: string
        type:
          example: DEBIT
          type: string
        updated_at:
          example: '2016-10-07T05:49:12.000Z'
          type: string
        user_guid:
          example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
          type: string
      type: object
    TransactionRule:
      properties:
        category_guid:
          example: CAT-b1de2a04-db08-b6ed-f6fe-ca2f5b11c2d0
          type: string
        created_at:
          example: '2018-10-02T22:00:50+00:00'
          type: string
        description:
          example: Wal-mart food storage
          type: string
        guid:
          example: TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3
          type: string
        match_description:
          example: Wal-mart
          type: string
        updated_at:
          example: '2018-10-02T23:54:40+00:00'
          type: string
        user_guid:
          example: USR-22fc3203-b3e6-8340-43db-8e50b2f56995
          type: string
      type: object
    User:
      properties:
        email:
          example: email@provider.com
          type: string
        guid:
          example: USR-d74cb14f-fd0a-449f-991b-e0362a63d9c6
          type: string
        id:
          example: My-Unique-ID
          type: string
        is_disabled:
          example: false
          type: boolean
        metadata:
          example: '{\"first_name\": \"Steven\", \"last_name\": \"Universe\"}'
          type: string
      type: object
    Widget:
      properties:
        type:
          example: connect_widget
          type: string
        url:
          example: https://int-widgets.moneydesktop.com/md/connect/yxcdk7f1nb99jwApp34lA24m0AZ8rzprgmw17gm8z8h2AzjyAnd1rj42qfv42r3xnn07Amfwlg3j09hwp8bkq8tc5z21j33xjggmp2qtlpkz2v4gywfhfn31l44tx2w91bfc2thc58j4syqp0hgxcyvA4g7754hk7gjc56kt7tc36s45mmkdz2jqqqydspytmtr3dAb9jh6fkb24f3zkfpdjj0v77f0vmrtzvzxkmxz7dklsq8gd0gstkbhlw5bgpgc3m9mAtpAcr2w15gwy5xc4blgxppl42Avnm63291z3cyp0wm3lqgmvgzdAddct423gAdqxdlfx5d4mvc0ck2gt7ktqgks4vxq1pAy5
          type: string
        user_id:
          example: U-jeff-201709221210
          type: string
      type: object
  securitySchemes:
    basicAuth:
      scheme: basic
      type: http
info:
  contact:
    name: MX Platform API
    url: https://www.mx.com/products/platform-api
  description: The MX Platform API is a powerful, fully-featured API designed to make
    aggregating and enhancing financial data easy and reliable. It can seamlessly
    connect your app or website to tens of thousands of financial institutions.
  title: MX Platform API
  version: 0.1.0
openapi: 3.0.0
paths:
  "/institutions":
    get:
      description: This endpoint returns a list of institutions based on the specified
        search term or parameter.
      operationId: ListInstitutions
      parameters:
      - description: This will list only institutions in which the appended string
          appears.
        example: chase
        in: query
        name: name
        schema:
          type: string
      - description: Filter only institutions which support account identification.
        example: true
        in: query
        name: supports_account_identification
        schema:
          type: boolean
      - description: Filter only institutions which support account statements.
        example: true
        in: query
        name: supports_account_statement
        schema:
          type: boolean
      - description: Filter only institutions which support account verification.
        example: true
        in: query
        name: supports_account_verification
        schema:
          type: boolean
      - description: Filter only institutions which support extended transaction history.
        example: true
        in: query
        name: supports_transaction_history
        schema:
          type: boolean
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  institutions:
                    items:
                      "$ref": "#/components/schemas/Institution"
                    type: array
                  pagination:
                    "$ref": "#/components/schemas/Pagination"
                type: object
          description: OK
      summary: List institutions
      tags:
      - Institution
  "/institutions/favorites":
    get:
      description: This endpoint returns a paginated list containing institutions
        that have been set as the partner’s favorites, sorted by popularity. Please
        contact MX to set a list of favorites.
      operationId: ListFavorites
      parameters:
      - description: Specify current page.
        example: 1
        in: query
        name: page
        schema:
          type: integer
      - description: Specify records per page.
        example: 10
        in: query
        name: records_per_page
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  institutions:
                    items:
                      "$ref": "#/components/schemas/Institution"
                    type: array
                  pagination:
                    "$ref": "#/components/schemas/Pagination"
                type: object
          description: OK
      summary: List favorites
      tags:
      - Institution
  "/institutions/{institution_code}":
    get:
      description: This endpoint returns information about the institution specified
        by `institution_code`.
      operationId: ReadInstitution
      parameters:
      - description: The institution_code of the institution.
        example: chase
        in: path
        name: institution_code
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  institution:
                    "$ref": "#/components/schemas/Institution"
                type: object
          description: OK
      summary: Read institution
      tags:
      - Institution
  "/institutions/{institution_code}/credentials":
    get:
      description: Use this endpoint to see which credentials will be needed to create
        a member for a specific institution.
      operationId: ListInstitutionRequiredCredentials
      parameters:
      - description: The institution_code of the institution.
        example: chase
        in: path
        name: institution_code
        required: true
        schema:
          type: string
      - description: Specify current page.
        example: 1
        in: query
        name: page
        schema:
          type: integer
      - description: Specify records per page.
        example: 10
        in: query
        name: records_per_page
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  credentials:
                    items:
                      "$ref": "#/components/schemas/Credential"
                    type: array
                  pagination:
                    "$ref": "#/components/schemas/Pagination"
                type: object
          description: OK
      summary: List institution-required credentials
      tags:
      - Credential
  "/merchants":
    get:
      description: This endpoint returns a paginated list of all the merchants in
        the MX system.
      operationId: ListMerchants
      parameters:
      - description: Specify current page.
        example: 1
        in: query
        name: page
        schema:
          type: integer
      - description: Specify records per page.
        example: 10
        in: query
        name: records_per_page
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  merchants:
                    items:
                      "$ref": "#/components/schemas/Merchant"
                    type: array
                  pagination:
                    "$ref": "#/components/schemas/Pagination"
                type: object
          description: OK
      summary: List merchants
      tags:
      - Merchant
  "/merchants/{merchant_guid}":
    get:
      description: Returns information about a particular merchant, such as a logo,
        name, and website.
      operationId: ReadMerchant
      parameters:
      - description: The unique id for a `merchant`.
        example: MCH-7ed79542-884d-2b1b-dd74-501c5cc9d25b
        in: path
        name: merchant_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  merchant:
                    "$ref": "#/components/schemas/Merchant"
                type: object
          description: OK
      summary: Read merchant
      tags:
      - Merchant
  "/transactions/enhance":
    post:
      description: Use this endpoint to categorize, cleanse, and classify transactions.
        These transactions are not persisted or stored on the MX platform.
      operationId: EnhanceTransactions
      requestBody:
        content:
          application/json:
            schema:
              properties:
                transactions:
                  items:
                    properties:
                      amount:
                        example: 21.33
                        type: number
                      description:
                        example: IN-N-OUT BURGER
                        type: string
                      id:
                        example: ID-123
                        type: string
                      merchant_category_code:
                        example: 123
                        type: integer
                      type:
                        example: DEBIT
                        type: string
                    required:
                    - description
                    - id
                    type: object
                  type: array
              type: object
        description: Transaction object to be enhanced
        required: true
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  transactions:
                    items:
                      "$ref": "#/components/schemas/EnhancedTransaction"
                    type: array
                type: object
          description: OK
      summary: Enhance transactions
      tags:
      - EnhancedTransaction
  "/users":
    get:
      description: Use this endpoint to list every user you've created in the MX Platform
        API.
      operationId: ListUsers
      parameters:
      - description: Specify current page.
        example: 1
        in: query
        name: page
        schema:
          type: integer
      - description: Specify records per page.
        example: 10
        in: query
        name: records_per_page
        schema:
          type: integer
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  pagination:
                    "$ref": "#/components/schemas/Pagination"
                  users:
                    items:
                      "$ref": "#/components/schemas/User"
                    type: array
                type: object
          description: OK
      summary: List users
      tags:
      - User
    post:
      description: Call this endpoint to create a new user. The MX Platform API will
        respond with the newly-created user object if successful. This endpoint accepts
        several parameters - id, metadata, and is_disabled. Disabling a user means
        that accounts and transactions associated with it will not be updated in the
        background by MX. It will also restrict access to that users data until they
        are no longer disabled. Users who are disabled for the entirety of an MX Platform
        API billing period will not be factored into that months bill.
      operationId: CreateUser
      requestBody:
        content:
          application/json:
            schema:
              properties:
                user:
                  properties:
                    email:
                      example: email@provider.com
                      type: string
                    id:
                      example: My-Unique-ID
                      type: string
                    is_disabled:
                      example: false
                      type: boolean
                    metadata:
                      example: '{\"first_name\": \"Steven\", \"last_name\": \"Universe\"}'
                      type: string
                  type: object
              type: object
        description: User object to be created. (None of these parameters are required,
          but the user object cannot be empty)
        required: true
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  user:
                    "$ref": "#/components/schemas/User"
                type: object
          description: OK
      summary: Create user
      tags:
      - User
  "/users/{user_guid}":
    delete:
      description: Use this endpoint to delete the specified `user`. The response
        will have a status of `204 No Content` without an object.
      operationId: DeleteUser
      parameters:
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '204':
          content:
            application/vnd.mx.api.v1+json:
              example:
          description: No Content
      summary: Delete user
      tags:
      - User
    get:
      description: Use this endpoint to read the attributes of a specific user.
      operationId: ReadUser
      parameters:
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  user:
                    "$ref": "#/components/schemas/User"
                type: object
          description: OK
      summary: Read user
      tags:
      - User
    put:
      description: Use this endpoint to update the attributes of a specific user.
        The MX Platform API will respond with the updated user object. Disabling a
        user means that accounts and transactions associated with it will not be updated
        in the background by MX. It will also restrict access to that users data until
        they are no longer disabled. Users who are disabled for the entirety of an
        MX Platform API billing period will not be factored into that months bill.
        To disable a user, update it and set the is_disabled parameter to true. Set
        it to false to re-enable the user.
      operationId: UpdateUser
      parameters:
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                user:
                  properties:
                    email:
                      example: email@provider.com
                      type: string
                    id:
                      example: My-Unique-ID
                      type: string
                    is_disabled:
                      example: false
                      type: boolean
                    metadata:
                      example: '{\"first_name\": \"Steven\", \"last_name\": \"Universe\"}'
                      type: string
                  type: object
              type: object
        description: User object to be updated (None of these parameters are required,
          but the user object cannot be empty.)
        required: true
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  user:
                    "$ref": "#/components/schemas/User"
                type: object
          description: OK
      summary: Update user
      tags:
      - User
  "/users/{user_guid}/accounts":
    get:
      description: This endpoint returns a list of all the accounts associated with
        the specified `user`.
      operationId: ListUserAccounts
      parameters:
      - description: Specify current page.
        example: 1
        in: query
        name: page
        schema:
          type: integer
      - description: Specify records per page.
        example: 10
        in: query
        name: records_per_page
        schema:
          type: integer
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  accounts:
                    items:
                      "$ref": "#/components/schemas/Account"
                    type: array
                  pagination:
                    "$ref": "#/components/schemas/Pagination"
                type: object
          description: OK
      summary: List accounts
      tags:
      - Account
  "/users/{user_guid}/accounts/{account_guid}":
    get:
      description: This endpoint returns the specified `account` resource.
      operationId: ReadAccount
      parameters:
      - description: The unique id for an `account`.
        example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
        in: path
        name: account_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  account:
                    "$ref": "#/components/schemas/Account"
                type: object
          description: OK
      summary: Read account
      tags:
      - Account
  "/users/{user_guid}/accounts/{account_guid}/account_numbers":
    get:
      description: This endpoint returns a list of account numbers associated with
        the specified `account`.
      operationId: ListAccountNumbersByAccount
      parameters:
      - description: The unique id for an `account`.
        example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
        in: path
        name: account_guid
        required: true
        schema:
          type: string
      - description: Specify current page.
        example: 1
        in: query
        name: page
        schema:
          type: integer
      - description: Specify records per page.
        example: 10
        in: query
        name: records_per_page
        schema:
          type: integer
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  account_numbers:
                    items:
                      "$ref": "#/components/schemas/AccountNumber"
                    type: array
                  pagination:
                    "$ref": "#/components/schemas/Pagination"
                type: object
          description: OK
      summary: List account numbers by account
      tags:
      - AccountNumber
  "/users/{user_guid}/accounts/{account_guid}/transactions":
    get:
      description: This endpoint returns a list of the last 90 days of transactions
        associated with the specified account.
      operationId: ListTransactionsByAccount
      parameters:
      - description: Filter transactions from this date.
        example: '2015-09-20'
        in: query
        name: from_date
        schema:
          type: string
      - description: The unique id for an `account`.
        example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
        in: path
        name: account_guid
        required: true
        schema:
          type: string
      - description: Specify current page.
        example: 1
        in: query
        name: page
        schema:
          type: integer
      - description: Specify records per page.
        example: 10
        in: query
        name: records_per_page
        schema:
          type: integer
      - description: Filter transactions to this date.
        example: '2019-10-20'
        in: query
        name: to_date
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  pagination:
                    "$ref": "#/components/schemas/Pagination"
                  transactions:
                    items:
                      "$ref": "#/components/schemas/Transaction"
                    type: array
                type: object
          description: OK
      summary: List transactions by account
      tags:
      - Transaction
  "/users/{user_guid}/categories":
    get:
      description: Use this endpoint to list all categories associated with a `user`,
        including both default and custom categories.
      operationId: ListCategories
      parameters:
      - description: Specify current page.
        example: 1
        in: query
        name: page
        schema:
          type: integer
      - description: Specify records per page.
        example: 10
        in: query
        name: records_per_page
        schema:
          type: integer
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  categories:
                    items:
                      "$ref": "#/components/schemas/Category"
                    type: array
                  pagination:
                    "$ref": "#/components/schemas/Pagination"
                type: object
          description: OK
      summary: List categories
      tags:
      - Category
    post:
      description: Use this endpoint to create a new custom category for a specific
        `user`.
      operationId: CreateCategory
      parameters:
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                category:
                  properties:
                    metadata:
                      example: some metadata
                      type: string
                    name:
                      example: Online Shopping
                      type: string
                    parent_guid:
                      example: CAT-aad51b46-d6f7-3da5-fd6e-492328b3023f
                      type: string
                  required:
                  - name
                  type: object
              type: object
        description: Custom category object to be created
        required: true
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  category:
                    "$ref": "#/components/schemas/Category"
                type: object
          description: OK
      summary: Create category
      tags:
      - Category
  "/users/{user_guid}/categories/default":
    get:
      description: Use this endpoint to read the attributes of a specific user.
      operationId: ListDefaultCategories
      parameters:
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  categories:
                    items:
                      "$ref": "#/components/schemas/Category"
                    type: array
                  pagination:
                    "$ref": "#/components/schemas/Pagination"
                type: object
          description: OK
      summary: List default categories
      tags:
      - Category
  "/users/{user_guid}/categories/{category_guid}":
    delete:
      description: Use this endpoint to delete a specific custom category according
        to its unique GUID. The API will respond with an empty object and a status
        of `204 No Content`.
      operationId: DeleteCategory
      parameters:
      - description: The unique id for a `category`.
        example: CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874
        in: path
        name: category_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '204':
          content:
            application/vnd.mx.api.v1+json:
              example:
          description: No Content
      summary: Delete category
      tags:
      - Category
    get:
      description: Use this endpoint to read the attributes of either a default category
        or a custom category.
      operationId: ReadCategory
      parameters:
      - description: The unique id for a `category`.
        example: CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874
        in: path
        name: category_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  category:
                    "$ref": "#/components/schemas/Category"
                type: object
          description: OK
      summary: Read category
      tags:
      - Category
    put:
      description: Use this endpoint to update the attributes of a custom category
        according to its unique GUID.
      operationId: UpdateCategory
      parameters:
      - description: The unique id for a `category`.
        example: CAT-7829f71c-2e8c-afa5-2f55-fa3634b89874
        in: path
        name: category_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                category:
                  properties:
                    metadata:
                      example: some metadata
                      type: string
                    name:
                      example: Web shopping
                      type: string
                  type: object
              type: object
        description: Category object to be updated (While no single parameter is required,
          the `category` object cannot be empty)
        required: true
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  category:
                    "$ref": "#/components/schemas/Category"
                type: object
          description: OK
      summary: Update category
      tags:
      - Category
  "/users/{user_guid}/connect_widget_url":
    post:
      description: This endpoint will return a URL for an embeddable version of MX
        Connect.
      operationId: RequestConnectWidgetURL
      parameters:
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                config:
                  properties:
                    color_scheme:
                      example: light
                      type: string
                    current_institution_code:
                      example: chase
                      type: string
                    current_member_guid:
                      example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
                      type: string
                    disable_institution_search:
                      example: false
                      type: boolean
                    include_transactions:
                      example: true
                      type: boolean
                    is_mobile_webview:
                      example: true
                      type: boolean
                    mode:
                      example: aggregation
                      type: string
                    ui_message_version:
                      example: 4
                      type: integer
                    ui_message_webview_url_scheme:
                      example: mx
                      type: string
                    update_credentials:
                      example: false
                      type: boolean
                    wait_for_full_aggregation:
                      example: false
                      type: boolean
                  type: object
              type: object
        description: Optional config options for WebView (is_mobile_webview, current_institution_code,
          current_member_guid, update_credentials)
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  user:
                    "$ref": "#/components/schemas/ConnectWidget"
                type: object
          description: OK
      summary: Request connect widget URL
      tags:
      - ConnectWidget
  "/users/{user_guid}/holdings":
    get:
      description: This endpoint returns all holdings associated with the specified
        `user` across all accounts and members.
      operationId: ListHoldingsByUser
      parameters:
      - description: Filter holdings from this date.
        example: '2015-09-20'
        in: query
        name: from_date
        schema:
          type: string
      - description: Specify current page.
        example: 1
        in: query
        name: page
        schema:
          type: integer
      - description: Specify records per page.
        example: 10
        in: query
        name: records_per_page
        schema:
          type: integer
      - description: Filter holdings to this date.
        example: '2019-10-20'
        in: query
        name: to_date
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  holdings:
                    items:
                      "$ref": "#/components/schemas/Holding"
                    type: array
                  pagination:
                    "$ref": "#/components/schemas/Pagination"
                type: object
          description: OK
      summary: List holdings by user
      tags:
      - Holding
  "/users/{user_guid}/holdings/{holding_guid}":
    get:
      description: Use this endpoint to read the attributes of a specific `holding`.
      operationId: ReadHolding
      parameters:
      - description: The unique id for a `holding`.
        example: HOL-d65683e8-9eab-26bb-bcfd-ced159c9abe2
        in: path
        name: holding_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  holding:
                    "$ref": "#/components/schemas/Holding"
                type: object
          description: OK
      summary: Read holding
      tags:
      - Holding
  "/users/{user_guid}/members":
    get:
      description: This endpoint returns an array which contains information on every
        member associated with a specific user.
      operationId: ListMembers
      parameters:
      - description: Specify current page.
        example: 1
        in: query
        name: page
        schema:
          type: integer
      - description: Specify records per page.
        example: 10
        in: query
        name: records_per_page
        schema:
          type: integer
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  members:
                    items:
                      "$ref": "#/components/schemas/Member"
                    type: array
                  pagination:
                    "$ref": "#/components/schemas/Pagination"
                type: object
          description: OK
      summary: List members
      tags:
      - Member
    post:
      description: This endpoint allows you to create a new member. Members are created
        with the required parameters credentials and institution_code, and the optional
        parameters id and metadata. When creating a member, youll need to include
        the correct type of credential required by the financial institution and provided
        by the user. You can find out which credential type is required with the `/institutions/{institution_code}/credentials`
        endpoint. If successful, the MX Platform API will respond with the newly-created
        member object. Once you successfully create a member, MX will immediately
        validate the provided credentials and attempt to aggregate data for accounts
        and transactions.
      operationId: CreateMember
      parameters:
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                member:
                  properties:
                    background_aggregation_is_disabled:
                      example: false
                      type: boolean
                    credentials:
                      items:
                        properties:
                          guid:
                            example: CRD-27d0edb8-1d50-5b90-bcbc-be270ca42b9f
                            type: string
                          value:
                            example: password
                            type: string
                        type: object
                      type: array
                    id:
                      example: unique_id
                      type: string
                    institution_code:
                      example: chase
                      type: string
                    is_oauth:
                      example: false
                      type: boolean
                    metadata:
                      example: '\"credentials_last_refreshed_at\": \"2015-10-15\"'
                      type: string
                    skip_aggregation:
                      example: false
                      type: boolean
                  required:
                  - credentials
                  - institution_code
                  type: object
                referral_source:
                  example: APP
                  type: string
                ui_message_webview_url_scheme:
                  example: mx
                  type: string
              type: object
        description: Member object to be created with optional parameters (id and
          metadata) and required parameters (credentials and institution_code)
        required: true
      responses:
        '202':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  member:
                    "$ref": "#/components/schemas/Member"
                type: object
          description: Accepted
      summary: Create member
      tags:
      - Member
  "/users/{user_guid}/members/{member_guid}":
    delete:
      description: Accessing this endpoint will permanently delete a member.
      operationId: DeleteMember
      parameters:
      - description: The unique id for a `member`.
        example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
        in: path
        name: member_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '204':
          content:
            application/vnd.mx.api.v1+json:
              example:
          description: No Content
      summary: Delete member
      tags:
      - Member
    get:
      description: Use this endpoint to read the attributes of a specific member.
      operationId: ReadMember
      parameters:
      - description: The unique id for a `member`.
        example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
        in: path
        name: member_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  member:
                    "$ref": "#/components/schemas/Member"
                type: object
          description: OK
      summary: Read member
      tags:
      - Member
    put:
      description: Use this endpoint to update a members attributes. Only the credentials,
        id, and metadata parameters can be updated. To get a list of the required
        credentials for the member, use the list member credentials endpoint.
      operationId: UpdateMember
      parameters:
      - description: The unique id for a `member`.
        example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
        in: path
        name: member_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                member:
                  properties:
                    background_aggregation_is_disabled:
                      example: false
                      type: boolean
                    credentials:
                      items:
                        properties:
                          guid:
                            example: CRD-27d0edb8-1d50-5b90-bcbc-be270ca42b9f
                            type: string
                          value:
                            example: password
                            type: string
                        type: object
                      type: array
                    id:
                      example: unique_id
                      type: string
                    metadata:
                      example: '\"credentials_last_refreshed_at\": \"2015-10-15\"'
                      type: string
                    skip_aggregation:
                      example: false
                      type: boolean
                  type: object
              type: object
        description: Member object to be updated (While no single parameter is required,
          the request body can't be empty)
        required: true
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  member:
                    "$ref": "#/components/schemas/Member"
                type: object
          description: OK
      summary: Update member
      tags:
      - Member
  "/users/{user_guid}/members/{member_guid}/account_numbers":
    get:
      description: This endpoint returns a list of account numbers associated with
        the specified `member`.
      operationId: ListAccountNumbersByMember
      parameters:
      - description: The unique id for a `member`.
        example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
        in: path
        name: member_guid
        required: true
        schema:
          type: string
      - description: Specify current page.
        example: 1
        in: query
        name: page
        schema:
          type: integer
      - description: Specify records per page.
        example: 10
        in: query
        name: records_per_page
        schema:
          type: integer
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  account_numbers:
                    items:
                      "$ref": "#/components/schemas/AccountNumber"
                    type: array
                  pagination:
                    "$ref": "#/components/schemas/Pagination"
                type: object
          description: OK
      summary: List account numbers by member
      tags:
      - AccountNumber
  "/users/{user_guid}/members/{member_guid}/account_owners":
    get:
      description: This endpoint returns an array with information about every account
        associated with a particular member.
      operationId: ListAccountOwners
      parameters:
      - description: The unique id for a `member`.
        example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
        in: path
        name: member_guid
        required: true
        schema:
          type: string
      - description: Specify current page.
        example: 1
        in: query
        name: page
        schema:
          type: integer
      - description: Specify records per page.
        example: 10
        in: query
        name: records_per_page
        schema:
          type: integer
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  account_owners:
                    items:
                      "$ref": "#/components/schemas/AccountOwner"
                    type: array
                  pagination:
                    "$ref": "#/components/schemas/Pagination"
                type: object
          description: OK
      summary: List account owners
      tags:
      - AccountOwner
  "/users/{user_guid}/members/{member_guid}/accounts/{account_guid}":
    put:
      description: This endpoint allows you to update certain attributes of an `account`
        resource.
      operationId: UpdateAccount
      parameters:
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `member`.
        example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
        in: path
        name: member_guid
        required: true
        schema:
          type: string
      - description: The unique id for an `account`.
        example: ACT-06d7f44b-caae-0f6e-1384-01f52e75dcb1
        in: path
        name: account_guid
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                account:
                  properties:
                    is_hidden:
                      example: false
                      type: boolean
                  type: object
              type: object
        description: Account object to be created with optional parameters (is_hidden)
        required: true
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  account:
                    "$ref": "#/components/schemas/Account"
                type: object
          description: OK
      summary: Update account
      tags:
      - Account
  "/users/{user_guid}/members/{member_guid}/aggregate":
    post:
      description: Calling this endpoint initiates an aggregation event for the member.
        This brings in the latest account and transaction data from the connected
        institution. If this data has recently been updated, MX may not initiate an
        aggregation event.
      operationId: AggregateMember
      parameters:
      - description: The unique id for a `member`.
        example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
        in: path
        name: member_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '202':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  member:
                    "$ref": "#/components/schemas/Member"
                type: object
          description: Accepted
      summary: Aggregate member
      tags:
      - Member
  "/users/{user_guid}/members/{member_guid}/challenges":
    get:
      description: Use this endpoint for information on what multi-factor authentication
        challenges need to be answered in order to aggregate a member. If the aggregation
        is not challenged, i.e., the member does not have a connection status of `CHALLENGED`,
        then code `204 No Content` will be returned. If the aggregation has been challenged,
        i.e., the member does have a connection status of `CHALLENGED`, then code
        `200 OK` will be returned - along with the corresponding credentials.
      operationId: ListMemberChallenges
      parameters:
      - description: The unique id for a `member`.
        example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
        in: path
        name: member_guid
        required: true
        schema:
          type: string
      - description: Specify current page.
        example: 1
        in: query
        name: page
        schema:
          type: integer
      - description: Specify records per page.
        example: 10
        in: query
        name: records_per_page
        schema:
          type: integer
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  challenges:
                    items:
                      "$ref": "#/components/schemas/Challenge"
                    type: array
                  pagination:
                    "$ref": "#/components/schemas/Pagination"
                type: object
          description: OK
      summary: List member challenges
      tags:
      - Challenge
  "/users/{user_guid}/members/{member_guid}/check_balance":
    post:
      description: This endpoint operates much like the aggregate member endpoint
        except that it gathers only account balance information; it does not gather
        any transaction data.
      operationId: CheckBalances
      parameters:
      - description: The unique id for a `member`.
        example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
        in: path
        name: member_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '202':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  member:
                    "$ref": "#/components/schemas/Member"
                type: object
          description: Accepted
      summary: Check balances
      tags:
      - Member
  "/users/{user_guid}/members/{member_guid}/credentials":
    get:
      description: This endpoint returns an array which contains information on every
        non-MFA credential associated with a specific member.
      operationId: ListMemberCredentials
      parameters:
      - description: The unique id for a `member`.
        example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
        in: path
        name: member_guid
        required: true
        schema:
          type: string
      - description: Specify current page.
        example: 1
        in: query
        name: page
        schema:
          type: integer
      - description: Specify records per page.
        example: 10
        in: query
        name: records_per_page
        schema:
          type: integer
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  credentials:
                    items:
                      "$ref": "#/components/schemas/Credential"
                    type: array
                  pagination:
                    "$ref": "#/components/schemas/Pagination"
                type: object
          description: OK
      summary: List member credentials
      tags:
      - Credential
  "/users/{user_guid}/members/{member_guid}/extend_history":
    post:
      description: Some institutions allow developers to access an extended transaction
        history with up to 24 months of data associated with a particular member.
        The process for fetching and then reading this extended transaction history
        is much like standard aggregation, and it may trigger multi-factor authentication.
      operationId: ExtendHistory
      parameters:
      - description: The unique identifier for a `member`.
        example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
        in: path
        name: member_guid
        required: true
        schema:
          type: string
      - description: The unique identifier for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '202':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  member:
                    "$ref": "#/components/schemas/Member"
                type: object
          description: Accepted
      summary: Extend history
      tags:
      - Member
  "/users/{user_guid}/members/{member_guid}/fetch_statements":
    post:
      description: Use this endpoint to fetch the statements associated with a particular
        member.
      operationId: FetchStatementsByMember
      parameters:
      - description: The unique id for a `member`.
        example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
        in: path
        name: member_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '202':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  member:
                    "$ref": "#/components/schemas/Member"
                type: object
          description: Accepted
      summary: Fetch statements by member
      tags:
      - Member
  "/users/{user_guid}/members/{member_guid}/holdings":
    get:
      description: This endpoint returns all holdings associated with the specified
        `member` across all accounts.
      operationId: ListHoldingsByMember
      parameters:
      - description: Filter holdings from this date.
        example: '2015-09-20'
        in: query
        name: from_date
        schema:
          type: string
      - description: The unique id for a `member`.
        example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
        in: path
        name: member_guid
        required: true
        schema:
          type: string
      - description: Specify current page.
        example: 1
        in: query
        name: page
        schema:
          type: integer
      - description: Specify records per page.
        example: 10
        in: query
        name: records_per_page
        schema:
          type: integer
      - description: Filter holdings to this date.
        example: '2019-10-20'
        in: query
        name: to_date
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  holdings:
                    items:
                      "$ref": "#/components/schemas/Holding"
                    type: array
                  pagination:
                    "$ref": "#/components/schemas/Pagination"
                type: object
          description: OK
      summary: List holdings by member
      tags:
      - Holding
  "/users/{user_guid}/members/{member_guid}/identify":
    post:
      description: The identify endpoint begins an identification process for an already-existing
        member.
      operationId: IdentifyMember
      parameters:
      - description: The unique id for a `member`.
        example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
        in: path
        name: member_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '202':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  member:
                    "$ref": "#/components/schemas/Member"
                type: object
          description: Accepted
      summary: Identify member
      tags:
      - Member
  "/users/{user_guid}/members/{member_guid}/oauth_window_uri":
    get:
      description: This endpoint will generate an `oauth_window_uri` for the specified
        `member`.
      operationId: RequestOAuthWindow
      parameters:
      - description: The unique id for a `member`.
        example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
        in: path
        name: member_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      - description: Must be either `BROWSER` or `APP` depending on the implementation.
          Defaults to `BROWSER`.
        example: APP
        in: query
        name: referral_source
        schema:
          type: string
      - description: A scheme for routing the user back to the application state they
          were previously in.
        example: mx
        in: query
        name: ui_message_webview_url_scheme
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  member:
                    "$ref": "#/components/schemas/OAuthWindow"
                type: object
          description: OK
      summary: Read member
      tags:
      - OAuthWindow
  "/users/{user_guid}/members/{member_guid}/resume":
    put:
      description: This endpoint answers the challenges needed when a member has been
        challenged by multi-factor authentication.
      operationId: ResumeAggregation
      parameters:
      - description: The unique id for a `member`.
        example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
        in: path
        name: member_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                member:
                  properties:
                    challenges:
                      items:
                        properties:
                          guid:
                            example: CRD-2378634-33ub5bhk54kjb
                            type: string
                          value:
                            example: user-entered-value
                            type: string
                        type: object
                      type: array
                  type: object
              type: object
        description: Member object with MFA challenge answers
        required: true
      responses:
        '202':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  member:
                    "$ref": "#/components/schemas/Member"
                type: object
          description: Accepted
      summary: Resume aggregation
      tags:
      - Member
  "/users/{user_guid}/members/{member_guid}/statements":
    get:
      description: Use this endpoint to get an array of available statements.
      operationId: ListStatementsByMember
      parameters:
      - description: The unique id for a `member`.
        example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
        in: path
        name: member_guid
        required: true
        schema:
          type: string
      - description: Specify current page.
        example: 1
        in: query
        name: page
        schema:
          type: integer
      - description: Specify records per page.
        example: 10
        in: query
        name: records_per_page
        schema:
          type: integer
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  pagination:
                    "$ref": "#/components/schemas/Pagination"
                  statements:
                    items:
                      "$ref": "#/components/schemas/Statement"
                    type: array
                type: object
          description: OK
      summary: List statements by member
      tags:
      - Statement
  "/users/{user_guid}/members/{member_guid}/statements/{statement_guid}":
    get:
      description: Use this endpoint to read a JSON representation of the statement.
      operationId: ReadStatementByMember
      parameters:
      - description: The unique id for a `member`.
        example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
        in: path
        name: member_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `statement`.
        example: STA-737a344b-caae-0f6e-1384-01f52e75dcb1
        in: path
        name: statement_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  statement:
                    "$ref": "#/components/schemas/Statement"
                type: object
          description: OK
      summary: Read statement by member
      tags:
      - Statement
  "/users/{user_guid}/members/{member_guid}/statements/{statement_guid}.pdf":
    get:
      description: Use this endpoint to download a specified statement PDF.
      operationId: DownloadStatementPDF
      parameters:
      - description: The unique id for a `member`.
        example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
        in: path
        name: member_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `statement`.
        example: STA-737a344b-caae-0f6e-1384-01f52e75dcb1
        in: path
        name: statement_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+pdf:
              schema:
                format: binary
                type: string
          description: OK
      summary: Download statement PDF
      tags:
      - Statement
  "/users/{user_guid}/members/{member_guid}/status":
    get:
      description: This endpoint provides the status of the members most recent aggregation
        event. This is an important step in the aggregation process, and the results
        returned by this endpoint should determine what you do next in order to successfully
        aggregate a member. MX has introduced new, more detailed information on the
        current status of a members connection to a financial institution and the
        state of its aggregation - the connection_status field. These are intended
        to replace and expand upon the information provided in the status field, which
        will soon be deprecated; support for the status field remains for the time
        being.
      operationId: ReadMemberStatus
      parameters:
      - description: The unique id for a `member`.
        example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
        in: path
        name: member_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  member:
                    "$ref": "#/components/schemas/MemberStatus"
                type: object
          description: OK
      summary: Read member status
      tags:
      - MemberStatus
  "/users/{user_guid}/members/{member_guid}/transactions":
    get:
      description: Requests to this endpoint return a list of transactions associated
        with the specified `member`, accross all accounts associated with that `member`.
      operationId: ListTransactionsByMember
      parameters:
      - description: Filter transactions from this date.
        example: '2015-09-20'
        in: query
        name: from_date
        schema:
          type: string
      - description: The unique id for a `member`.
        example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
        in: path
        name: member_guid
        required: true
        schema:
          type: string
      - description: Specify current page.
        example: 1
        in: query
        name: page
        schema:
          type: integer
      - description: Specify records per page.
        example: 10
        in: query
        name: records_per_page
        schema:
          type: integer
      - description: Filter transactions to this date.
        example: '2019-10-20'
        in: query
        name: to_date
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  pagination:
                    "$ref": "#/components/schemas/Pagination"
                  transactions:
                    items:
                      "$ref": "#/components/schemas/Transaction"
                    type: array
                type: object
          description: OK
      summary: List transactions by member
      tags:
      - Transaction
  "/users/{user_guid}/members/{member_guid}/verify":
    post:
      description: The verify endpoint begins a verification process for a member.
      operationId: VerifyMember
      parameters:
      - description: The unique id for a `member`.
        example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
        in: path
        name: member_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  member:
                    "$ref": "#/components/schemas/Member"
                type: object
          description: OK
      summary: Verify member
      tags:
      - Member
  "/users/{user_guid}/taggings":
    get:
      description: Use this endpoint to retrieve a list of all the taggings associated
        with a specific user.
      operationId: ListTaggings
      parameters:
      - description: Specify current page.
        example: 1
        in: query
        name: page
        schema:
          type: integer
      - description: Specify records per page.
        example: 10
        in: query
        name: records_per_page
        schema:
          type: integer
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  pagination:
                    "$ref": "#/components/schemas/Pagination"
                  taggings:
                    items:
                      "$ref": "#/components/schemas/Tagging"
                    type: array
                type: object
          description: OK
      summary: List taggings
      tags:
      - Tagging
    post:
      description: Use this endpoint to create a new association between a tag and
        a particular transaction, according to their unique GUIDs.
      operationId: CreateTagging
      parameters:
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                tagging:
                  properties:
                    tag_guid:
                      example: TAG-40faf068-abb4-405c-8f6a-e883ed541fff
                      type: string
                    transaction_guid:
                      example: TRN-810828b0-5210-4878-9bd3-f4ce514f90c4
                      type: string
                  required:
                  - tag_guid
                  - transaction_guid
                  type: object
              type: object
        description: Tagging object to be created with required parameters (tag_guid
          and transaction_guid)
        required: true
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  tagging:
                    "$ref": "#/components/schemas/Tagging"
                type: object
          description: Accepted
      summary: Create tagging
      tags:
      - Tagging
  "/users/{user_guid}/taggings/{tagging_guid}":
    delete:
      description: Use this endpoint to delete a tagging according to its unique GUID.
        If successful, the API will respond with an empty body and a status of 204
        NO Content.
      operationId: DeleteTagging
      parameters:
      - description: The unique id for a `tagging`.
        example: TGN-007f5486-17e1-45fc-8b87-8f03984430fe
        in: path
        name: tagging_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '204':
          content:
            application/vnd.mx.api.v1+json:
              example:
          description: No Content
      summary: Delete tagging
      tags:
      - Tagging
    get:
      description: Use this endpoint to read the attributes of a `tagging` according
        to its unique GUID.
      operationId: ReadTagging
      parameters:
      - description: The unique id for a `tagging`.
        example: TGN-007f5486-17e1-45fc-8b87-8f03984430fe
        in: path
        name: tagging_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  tagging:
                    "$ref": "#/components/schemas/Tagging"
                type: object
          description: OK
      summary: Read tagging
      tags:
      - Tagging
    put:
      description: Use this endpoint to update a tagging.
      operationId: UpdateTagging
      parameters:
      - description: The unique id for a `tagging`.
        example: TGN-007f5486-17e1-45fc-8b87-8f03984430fe
        in: path
        name: tagging_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                tagging:
                  properties:
                    tag_guid:
                      example: TAG-40faf068-abb4-405c-8f6a-e883ed541fff
                      type: string
                  required:
                  - tag_guid
                  type: object
              type: object
        description: Tagging object to be updated with required parameter (tag_guid)
        required: true
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  tagging:
                    "$ref": "#/components/schemas/Tagging"
                type: object
          description: OK
      summary: Update tagging
      tags:
      - Tagging
  "/users/{user_guid}/tags":
    get:
      description: Use this endpoint to list all tags associated with the specified
        `user`. Each user includes the `Business` tag by default.
      operationId: ListTags
      parameters:
      - description: Specify current page.
        example: 1
        in: query
        name: page
        schema:
          type: integer
      - description: Specify records per page.
        example: 10
        in: query
        name: records_per_page
        schema:
          type: integer
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  pagination:
                    "$ref": "#/components/schemas/Pagination"
                  tags:
                    items:
                      "$ref": "#/components/schemas/Tag"
                    type: array
                type: object
          description: OK
      summary: List tags
      tags:
      - Tag
    post:
      description: Use this endpoint to create a new custom tag.
      operationId: CreateTag
      parameters:
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                tag:
                  properties:
                    name:
                      example: MY TAG
                      type: string
                  required:
                  - name
                  type: object
              type: object
        description: Tag object to be created with required parameters (tag_guid)
        required: true
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  tag:
                    "$ref": "#/components/schemas/Tag"
                type: object
          description: OK
      summary: Create tag
      tags:
      - Tag
  "/users/{user_guid}/tags/{tag_guid}":
    delete:
      description: Use this endpoint to permanently delete a specific tag based on
        its unique GUID. If successful, the API will respond with status of `204 No
        Content`.
      operationId: DeleteTag
      parameters:
      - description: The unique id for a `tag`.
        example: TAG-aef36e72-6294-4c38-844d-e573e80aed52
        in: path
        name: tag_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '204':
          content:
            application/vnd.mx.api.v1+json:
              example:
          description: No Content
      summary: Delete tag
      tags:
      - Tag
    get:
      description: Use this endpoint to read the attributes of a particular tag according
        to its unique GUID.
      operationId: ReadTag
      parameters:
      - description: The unique id for a `tag`.
        example: TAG-aef36e72-6294-4c38-844d-e573e80aed52
        in: path
        name: tag_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  tag:
                    "$ref": "#/components/schemas/Tag"
                type: object
          description: OK
      summary: Read tag
      tags:
      - Tag
    put:
      description: Use this endpoint to update the name of a specific tag according
        to its unique GUID.
      operationId: UpdateTag
      parameters:
      - description: The unique id for a `tag`.
        example: TAG-aef36e72-6294-4c38-844d-e573e80aed52
        in: path
        name: tag_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                tag:
                  properties:
                    name:
                      example: MY TAG
                      type: string
                  required:
                  - name
                  type: object
              type: object
        description: Tag object to be updated with required parameter (tag_guid)
        required: true
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  tag:
                    "$ref": "#/components/schemas/Tag"
                type: object
          description: OK
      summary: Update tag
      tags:
      - Tag
  "/users/{user_guid}/tags/{tag_guid}/transactions":
    get:
      description: Use this endpoint to get a list of all transactions associated
        with a particular tag according to the tag’s unique GUID. In other words,
        a list of all transactions that have been assigned to a particular tag using
        the create a tagging endpoint.
      operationId: ListTransactionsByTag
      parameters:
      - description: The unique id for a `tag`.
        example: TAG-aef36e72-6294-4c38-844d-e573e80aed52
        in: path
        name: tag_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  pagination:
                    "$ref": "#/components/schemas/Pagination"
                  transactions:
                    items:
                      "$ref": "#/components/schemas/Transaction"
                    type: array
                type: object
          description: OK
      summary: List transactions by tag
      tags:
      - Transaction
  "/users/{user_guid}/transaction_rules":
    get:
      description: Use this endpoint to read the attributes of all existing transaction
        rules belonging to the user.
      operationId: ListTransactionRulesByUser
      parameters:
      - description: Specify current page.
        example: 1
        in: query
        name: page
        schema:
          type: integer
      - description: Specify records per page.
        example: 10
        in: query
        name: records_per_page
        schema:
          type: integer
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  pagination:
                    "$ref": "#/components/schemas/Pagination"
                  transaction_rules:
                    items:
                      "$ref": "#/components/schemas/TransactionRule"
                    type: array
                type: object
          description: OK
      summary: List transaction rules by user
      tags:
      - TransactionRule
    post:
      description: Use this endpoint to create a new transaction rule. The newly-created
        `transaction_rule` object will be returned if successful.
      operationId: CreateTransactionRule
      parameters:
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                transaction_rule:
                  properties:
                    category_guid:
                      example: CAT-b1de2a04-db08-b6ed-f6fe-ca2f5b11c2d0
                      type: string
                    description:
                      example: Wal-mart food storage
                      type: string
                    match_description:
                      example: Wal-mart
                      type: string
                  required:
                  - category_guid
                  - match_description
                  type: object
              type: object
        description: TransactionRule object to be created with optional parameters
          (description) and required parameters (category_guid and match_description)
        required: true
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  transaction_rule:
                    "$ref": "#/components/schemas/TransactionRule"
                type: object
          description: OK
      summary: Create transaction rule
      tags:
      - TransactionRule
  "/users/{user_guid}/transaction_rules/{transaction_rule_guid}":
    delete:
      description: Use this endpoint to permanently delete a transaction rule based
        on its unique GUID.
      operationId: DeleteTransactionRule
      parameters:
      - description: The unique id for a `transaction_rule`.
        example: TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3
        in: path
        name: transaction_rule_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '204':
          content:
            application/vnd.mx.api.v1+json:
              example:
          description: No Content
      summary: Delete transaction rule
      tags:
      - TransactionRule
    get:
      description: Use this endpoint to read the attributes of an existing transaction
        rule based on the rule’s unique GUID.
      operationId: ReadTransactionRule
      parameters:
      - description: The unique id for a `transaction_rule`.
        example: TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3
        in: path
        name: transaction_rule_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  transaction_rule:
                    "$ref": "#/components/schemas/TransactionRule"
                type: object
          description: OK
      summary: Read transaction rule
      tags:
      - TransactionRule
    put:
      description: Use this endpoint to update the attributes of a specific transaction
        rule based on its unique GUID. The API will respond with the updated transaction_rule
        object. Any attributes not provided will be left unchanged.
      operationId: UpdateTransactionRule
      parameters:
      - description: The unique id for a `transaction_rule`.
        example: TXR-a080e0f9-a2d4-4d6f-9e03-672cc357a4d3
        in: path
        name: transaction_rule_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                transaction_rule:
                  properties:
                    category_guid:
                      example: CAT-b1de2a04-db08-b6ed-f6fe-ca2f5b11c2d0
                      type: string
                    description:
                      example: Wal-mart food storage
                      type: string
                    match_description:
                      example: Wal-mart
                      type: string
                  type: object
              type: object
        description: TransactionRule object to be updated
        required: true
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  transaction_rule:
                    "$ref": "#/components/schemas/TransactionRule"
                type: object
          description: OK
      summary: Update transaction_rule
      tags:
      - TransactionRule
  "/users/{user_guid}/transactions":
    get:
      description: Requests to this endpoint return a list of transactions associated
        with the specified `user`, accross all members and accounts associated with
        that `user`.
      operationId: ListTransactionsByUser
      parameters:
      - description: Filter transactions from this date.
        example: '2015-09-20'
        in: query
        name: from_date
        schema:
          type: string
      - description: Specify current page.
        example: 1
        in: query
        name: page
        schema:
          type: integer
      - description: Specify records per page.
        example: 10
        in: query
        name: records_per_page
        schema:
          type: integer
      - description: Filter transactions to this date.
        example: '2019-10-20'
        in: query
        name: to_date
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  pagination:
                    "$ref": "#/components/schemas/Pagination"
                  transactions:
                    items:
                      "$ref": "#/components/schemas/Transaction"
                    type: array
                type: object
          description: OK
      summary: List transactions by user
      tags:
      - Transaction
  "/users/{user_guid}/transactions/{transaction_guid}":
    get:
      description: Requests to this endpoint will return the attributes of the specified
        `transaction`.
      operationId: ReadTransaction
      parameters:
      - description: The unique id for a `transaction`.
        example: TRN-810828b0-5210-4878-9bd3-f4ce514f90c4
        in: path
        name: transaction_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  transaction:
                    "$ref": "#/components/schemas/Transaction"
                type: object
          description: OK
      summary: Read transaction
      tags:
      - Transaction
    put:
      description: Use this endpoint to update the `description` of a specific transaction
        according to its unique GUID.
      operationId: UpdateTransaction
      parameters:
      - description: The unique id for a `transaction`.
        example: TRN-810828b0-5210-4878-9bd3-f4ce514f90c4
        in: path
        name: transaction_guid
        required: true
        schema:
          type: string
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                transaction:
                  properties:
                    description:
                      example: new description
                      type: string
                  required:
                  - description
                  type: object
              type: object
        description: Transaction object to be updated with a new description
        required: true
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  transaction:
                    "$ref": "#/components/schemas/Transaction"
                type: object
          description: OK
      summary: Update transaction
      tags:
      - Transaction
  "/users/{user_guid}/widget_urls":
    post:
      description: This endpoint allows partners to get a URL by passing the `widget_type`
        in the request body, as well as configuring it in several different ways.
        In the case of Connect, that means setting the `widget_type` to `connect_widget`.
        Partners may also pass an optional `Accept-Language` header as well as a number
        of configuration options. Note that this is a `POST` request.
      operationId: RequestWidgetURL
      parameters:
      - description: The unique id for a `user`.
        example: USR-fa7537f3-48aa-a683-a02a-b18940482f54
        in: path
        name: user_guid
        required: true
        schema:
          type: string
      - description: The desired language of the widget.
        example: en-US
        in: header
        name: Accept-Language
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              properties:
                widget_url:
                  properties:
                    color_scheme:
                      example: light
                      type: string
                    current_institution_code:
                      example: chase
                      type: string
                    current_institution_guid:
                      example: INS-f1a3285d-e855-b61f-6aa7-8ae575c0e0e9
                      type: string
                    current_member_guid:
                      example: MBR-7c6f361b-e582-15b6-60c0-358f12466b4b
                      type: string
                    disable_institution_search:
                      example: false
                      type: boolean
                    include_transactions:
                      example: true
                      type: boolean
                    is_mobile_webview:
                      example: true
                      type: boolean
                    mode:
                      example: aggregation
                      type: string
                    ui_message_version:
                      example: 4
                      type: integer
                    ui_message_webview_url_scheme:
                      example: mx
                      type: string
                    update_credentials:
                      example: false
                      type: boolean
                    wait_for_full_aggregation:
                      example: false
                      type: boolean
                    widget_type:
                      example: connect_widget
                      type: string
                  required:
                  - widget_type
                  type: object
              type: object
        description: The widget url configuration options.
        required: true
      responses:
        '200':
          content:
            application/vnd.mx.api.v1+json:
              schema:
                properties:
                  widget_url:
                    "$ref": "#/components/schemas/Widget"
                type: object
          description: OK
      summary: Request a widget URL
      tags:
      - Widget
security:
- basicAuth: []
servers:
- url: https://api.mx.com
- url: https://int-api.mx.com
tags:
- name: Account
- name: AccountNumber
- name: AccountOwner
- name: Category
- name: Challenge
- name: ConnectWidget
- name: Credential
- name: EnhancedTransaction
- name: Holding
- name: Institution
- name: Member
- name: MemberStatus
- name: Merchant
- name: OAuthWindow
- name: Statement
- name: Tag
- name: Tagging
- name: Transaction
- name: TransactionRule
- name: User
- name: Widget