openapi: 3.0.2
servers:
  - url: https://api.increase.com
  - url: https://sandbox.increase.com
info:
  title: Increase API
  version: 0.0.1
  x-logo:
    url: https://storage.googleapis.com/bank-277721-web-static-assets/imgs/card.jpg
  x-origin:
    - format: openapi
      url: https://increase.com/openapi.json
      version: "3.0"
  x-providerName: increase.com
security:
  - bearerAuth: []
tags:
  - description: Accounts are your bank accounts with Increase. They store money, receive transfers, and send payments. They earn interest and have depository insurance.
    name: Accounts
  - description: Represents a request to lookup the balance of an Account at a given point in time.
    name: Balance Lookups
  - description: Each account can have multiple account and routing numbers. We recommend that you use a set per vendor. This is similar to how you use different passwords for different websites. Account numbers can also be used to seamlessly reconcile inbound payments. Generating a unique account number per vendor ensures you always know the originator of an incoming payment.
    name: Account Numbers
  - description: Cards are commercial credit cards. They'll immediately work for online purchases after you create them. All cards maintain a credit limit of 100% of the Account’s available balance at the time of transaction. Funds are deducted from the Account upon transaction settlement.
    name: Cards
  - description: If unauthorized activity occurs on a card, you can create a Card Dispute and we'll return the funds if appropriate.
    name: Card Disputes
  - description: This contains artwork and metadata relating to a Card's appearance in digital wallet apps like Apple Pay and Google Pay. For more information, see our guide on [digital card artwork](https://increase.com/documentation/card-art)
    name: Card Profiles
  - description: A Digital Wallet Token is created when a user adds a Card to their Apple Pay or Google Pay app. The Digital Wallet Token can be used for purchases just like a Card.
    name: Digital Wallet Tokens
  - description: Transactions are the immutable additions and removals of money from your bank account. They're the equivalent of line items on your bank statement.
    name: Transactions
  - description: Pending Transactions are potential future additions and removals of money from your bank account.
    name: Pending Transactions
  - description: Declined Transactions are refused additions and removals of money from your bank account. For example, Declined Transactions are caused when your Account has an insufficient balance or your Limits are triggered.
    name: Declined Transactions
  - description: You can set limits at the Account, Account Number, or Card level. Limits applied to Accounts will apply to all Account Numbers and Cards in the Account. You can specify any number of Limits and they will all be applied to inbound debits and card authorizations. Volume and count Limits are designed to prevent unauthorized debits.
    name: Limits
  - description: Account transfers move funds between your own accounts at Increase.
    name: Account Transfers
  - description: ACH transfers move funds between your Increase account and any other account accessible by the Automated Clearing House (ACH).
    name: ACH Transfers
  - description: ACH Prenotifications are one way you can verify account and routing numbers by Automated Clearing House (ACH).
    name: ACH Prenotifications
  - description: If unauthorized activity occurs via ACH, you can create an Inbound ACH Transfer Return and we'll reverse the transaction. You can create an Inbound ACH Transfer return the first two days after receiving an Inbound ACH Transfer.
    name: Inbound ACH Transfer Returns
  - description: Wire transfers move funds between your Increase account and any other account accessible by Fedwire.
    name: Wire Transfers
  - description: Wire drawdown requests enable you to request that someone else send you a wire. This feature is in beta; reach out to [support@increase.com](mailto:support@increase.com) to learn more.
    name: Wire Drawdown Requests
  - description: Inbound wire drawdown requests are requests from someone else to send them a wire. This feature is in beta; reach out to [support@increase.com](mailto:support@increase.com) to learn more.
    name: Inbound Wire Drawdown Requests
  - description: Check Transfers move funds from your Increase account by mailing a physical check.
    name: Check Transfers
  - description: Check Deposits allow you to deposit images of paper checks into your account.
    name: Check Deposits
  - description: Routing numbers are used to identify your bank in a financial transaction.
    name: Routing Numbers
  - description: External Accounts represent accounts at financial institutions other than Increase. You can use this API to store their details for reuse.
    name: External Accounts
  - description: Entities are the legal entities that own accounts. They can be people, corporations, partnerships, or trusts.
    name: Entities
  - description: Account Statements are generated monthly for every active Account. You can access the statement's data via the API or retrieve a PDF with its details via its associated File.
    name: Account Statements
  - description: Files are objects that represent a file hosted on Increase's servers. The file may have been uploaded by you (for example, when uploading a check image) or it may have been created by Increase (for example, an autogenerated statement PDF).
    name: Files
  - description: Increase generates certain documents / forms automatically for your application; they can be listed here. Currently the only supported document type is IRS Form 1099-INT.
    name: Documents
  - description: Events are records of things that happened to objects in the API. They also result in webhooks being generated.
    name: Events
  - description: Webhooks are event notifications we send to you by HTTPS POST requests. Event Subscriptions are how you configure your application to listen for them. You can create an Event Subscription through your [developer dashboard](https://dashboard.increase.com/developers/webhooks) or the API. For more information, see our [webhooks guide](https://increase.com/documentation/webhooks).
    name: Event Subscriptions
  - description: Real Time Decisions are created when your application needs to take action in real-time to some event such as a card authorization. Real time decisions are currently in beta; please contact support@increase.com if you're interested in trying them out!
    name: Real-Time Decisions
  - description: Exports are batch summaries of your Increase data. You can make them from the API or dashboard. Since they can take a while, they are generated asynchronously. We send a webhook when they are ready. For more information, please read our [Exports documentation](https://increase.com/documentation/exports).
    name: Exports
  - description: Groups represent organizations using Increase. You can retrieve information about your own organization via the API, or (more commonly) OAuth platforms can retrieve information about the organizations that have granted them access.
    name: Groups
  - description: Programs determine the compliance and commercial terms of Accounts. By default, you have a Commercial Banking program for managing your own funds. If you are lending or managing funds on behalf of your customers, or otherwise engaged in regulated activity, we will work together to create additional Programs for you.
    name: Programs
  - description: Accounts are T-accounts. They can store accounting entries.
    name: Bookkeeping Accounts
  - description: When a user authorizes your OAuth application, an OAuth Connection object is created.
    name: OAuth Connections
  - description: Real Time Payments transfers move funds, within seconds, between your Increase account and any other account on the Real Time Payments network.
    name: Real Time Payments Transfers
  - description: When building your application, you can use these APIs to simulate external effects. They can be helpful to quickly test events that might take several hours in the real world (like receiving a wire or ACH). *These APIs will only work in the sandbox.* If you have a sandbox [Event Subscription](#event-subscriptions) configured, calling these APIs will also result in the appropriate webhooks being sent to your endpoint.
    name: Simulations
paths:
  /account_numbers:
    get:
      operationId: list_account_numbers
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
        - in: query
          name: status
          required: false
          schema:
            description: The status to retrieve Account Numbers for.
            enum:
              - active
              - disabled
              - canceled
            type: string
            x-enum-descriptions:
              - The account number is active.
              - The account number is temporarily disabled.
              - The account number is permanently disabled.
        - in: query
          name: account_id
          required: false
          schema:
            description: Filter Account Numbers to those belonging to the specified Account.
            type: string
        - in: query
          name: created_at.after
          required: false
          schema:
            description: Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.before
          required: false
          schema:
            description: Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_after
          required: false
          schema:
            description: Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_before
          required: false
          schema:
            description: Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/account_number_list"
          description: Account Number List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List Account Numbers
      x-tag: Account Numbers
    post:
      operationId: create_an_account_number
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/create_an_account_number_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/account_number"
          description: Account Number
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Create an Account Number
      x-tag: Account Numbers
  "/account_numbers/{account_number_id}":
    get:
      operationId: retrieve_an_account_number
      parameters:
        - example: account_number_v18nkfqm6afpsrvy82b2
          in: path
          name: account_number_id
          required: true
          schema:
            description: The identifier of the Account Number to retrieve.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/account_number"
          description: Account Number
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve an Account Number
      x-tag: Account Numbers
    patch:
      operationId: update_an_account_number
      parameters:
        - example: account_number_v18nkfqm6afpsrvy82b2
          in: path
          name: account_number_id
          required: true
          schema:
            description: The identifier of the Account Number.
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/update_an_account_number_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/account_number"
          description: Account Number
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Update an Account Number
      x-tag: Account Numbers
  /account_statements:
    get:
      operationId: list_account_statements
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
        - example: account_in71c4amph0vgo2qllky
          in: query
          name: account_id
          required: false
          schema:
            description: Filter Account Statements to those belonging to the specified Account.
            type: string
        - in: query
          name: statement_period_start.after
          required: false
          schema:
            description: Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: statement_period_start.before
          required: false
          schema:
            description: Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: statement_period_start.on_or_after
          required: false
          schema:
            description: Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: statement_period_start.on_or_before
          required: false
          schema:
            description: Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/account_statement_list"
          description: Account Statement List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List Account Statements
      x-tag: Account Statements
  "/account_statements/{account_statement_id}":
    get:
      operationId: retrieve_an_account_statement
      parameters:
        - example: account_statement_lkc03a4skm2k7f38vj15
          in: path
          name: account_statement_id
          required: true
          schema:
            description: The identifier of the Account Statement to retrieve.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/account_statement"
          description: Account Statement
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve an Account Statement
      x-tag: Account Statements
  /account_transfers:
    get:
      operationId: list_account_transfers
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
        - example: account_in71c4amph0vgo2qllky
          in: query
          name: account_id
          required: false
          schema:
            description: Filter Account Transfers to those that originated from the specified Account.
            type: string
        - in: query
          name: created_at.after
          required: false
          schema:
            description: Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.before
          required: false
          schema:
            description: Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_after
          required: false
          schema:
            description: Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_before
          required: false
          schema:
            description: Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/account_transfer_list"
          description: Account Transfer List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List Account Transfers
      x-tag: Account Transfers
    post:
      operationId: create_an_account_transfer
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/create_an_account_transfer_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/account_transfer"
          description: Account Transfer
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Create an Account Transfer
      x-tag: Account Transfers
  "/account_transfers/{account_transfer_id}":
    get:
      operationId: retrieve_an_account_transfer
      parameters:
        - example: account_transfer_7k9qe1ysdgqztnt63l7n
          in: path
          name: account_transfer_id
          required: true
          schema:
            description: The identifier of the Account Transfer.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/account_transfer"
          description: Account Transfer
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve an Account Transfer
      x-tag: Account Transfers
  "/account_transfers/{account_transfer_id}/approve":
    post:
      operationId: approve_an_account_transfer
      parameters:
        - example: account_transfer_7k9qe1ysdgqztnt63l7n
          in: path
          name: account_transfer_id
          required: true
          schema:
            description: The identifier of the Account Transfer to approve.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/account_transfer"
          description: Account Transfer
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Approve an Account Transfer
      x-tag: Account Transfers
  "/account_transfers/{account_transfer_id}/cancel":
    post:
      operationId: cancel_an_account_transfer
      parameters:
        - example: account_transfer_7k9qe1ysdgqztnt63l7n
          in: path
          name: account_transfer_id
          required: true
          schema:
            description: The identifier of the pending Account Transfer to cancel.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/account_transfer"
          description: Account Transfer
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Cancel an Account Transfer
      x-tag: Account Transfers
  /accounts:
    get:
      operationId: list_accounts
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
        - example: entity_n8y8tnk2p9339ti393yi
          in: query
          name: entity_id
          required: false
          schema:
            description: Filter Accounts for those belonging to the specified Entity.
            type: string
        - in: query
          name: status
          required: false
          schema:
            description: Filter Accounts for those with the specified status.
            enum:
              - open
              - closed
            type: string
            x-enum-descriptions:
              - Open Accounts that are ready to use.
              - Closed Accounts on which no new activity can occur.
        - in: query
          name: created_at.after
          required: false
          schema:
            description: Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.before
          required: false
          schema:
            description: Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_after
          required: false
          schema:
            description: Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_before
          required: false
          schema:
            description: Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/account_list"
          description: Account List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List Accounts
      x-tag: Accounts
    post:
      operationId: create_an_account
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/create_an_account_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/account"
          description: Account
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Create an Account
      x-tag: Accounts
  "/accounts/{account_id}":
    get:
      operationId: retrieve_an_account
      parameters:
        - example: account_in71c4amph0vgo2qllky
          in: path
          name: account_id
          required: true
          schema:
            description: The identifier of the Account to retrieve.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/account"
          description: Account
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve an Account
      x-tag: Accounts
    patch:
      operationId: update_an_account
      parameters:
        - example: account_in71c4amph0vgo2qllky
          in: path
          name: account_id
          required: true
          schema:
            description: The identifier of the Account to update.
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/update_an_account_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/account"
          description: Account
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Update an Account
      x-tag: Accounts
  "/accounts/{account_id}/close":
    post:
      operationId: close_an_account
      parameters:
        - example: account_in71c4amph0vgo2qllky
          in: path
          name: account_id
          required: true
          schema:
            description: The identifier of the Account to close.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/account"
          description: Account
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Close an Account
      x-tag: Accounts
  /ach_prenotifications:
    get:
      operationId: list_ach_prenotifications
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
        - in: query
          name: created_at.after
          required: false
          schema:
            description: Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.before
          required: false
          schema:
            description: Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_after
          required: false
          schema:
            description: Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_before
          required: false
          schema:
            description: Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ach_prenotification_list"
          description: ACH Prenotification List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List ACH Prenotifications
      x-tag: ACH Prenotifications
    post:
      operationId: create_an_ach_prenotification
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/create_an_ach_prenotification_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ach_prenotification"
          description: ACH Prenotification
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Create an ACH Prenotification
      x-tag: ACH Prenotifications
  "/ach_prenotifications/{ach_prenotification_id}":
    get:
      operationId: retrieve_an_ach_prenotification
      parameters:
        - example: ach_prenotification_ubjf9qqsxl3obbcn1u34
          in: path
          name: ach_prenotification_id
          required: true
          schema:
            description: The identifier of the ACH Prenotification to retrieve.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ach_prenotification"
          description: ACH Prenotification
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve an ACH Prenotification
      x-tag: ACH Prenotifications
  /ach_transfers:
    get:
      operationId: list_ach_transfers
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
        - example: account_in71c4amph0vgo2qllky
          in: query
          name: account_id
          required: false
          schema:
            description: Filter ACH Transfers to those that originated from the specified Account.
            type: string
        - in: query
          name: external_account_id
          required: false
          schema:
            description: Filter ACH Transfers to those made to the specified External Account.
            type: string
        - in: query
          name: created_at.after
          required: false
          schema:
            description: Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.before
          required: false
          schema:
            description: Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_after
          required: false
          schema:
            description: Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_before
          required: false
          schema:
            description: Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ach_transfer_list"
          description: ACH Transfer List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List ACH Transfers
      x-tag: ACH Transfers
    post:
      operationId: create_an_ach_transfer
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/create_an_ach_transfer_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ach_transfer"
          description: ACH Transfer
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Create an ACH Transfer
      x-tag: ACH Transfers
  "/ach_transfers/{ach_transfer_id}":
    get:
      operationId: retrieve_an_ach_transfer
      parameters:
        - example: ach_transfer_uoxatyh3lt5evrsdvo7q
          in: path
          name: ach_transfer_id
          required: true
          schema:
            description: The identifier of the ACH Transfer.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ach_transfer"
          description: ACH Transfer
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve an ACH Transfer
      x-tag: ACH Transfers
  "/ach_transfers/{ach_transfer_id}/approve":
    post:
      description: Approves an ACH Transfer in a pending_approval state.
      operationId: approve_an_ach_transfer
      parameters:
        - example: ach_transfer_uoxatyh3lt5evrsdvo7q
          in: path
          name: ach_transfer_id
          required: true
          schema:
            description: The identifier of the ACH Transfer to approve.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ach_transfer"
          description: ACH Transfer
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Approve an ACH Transfer
      x-tag: ACH Transfers
  "/ach_transfers/{ach_transfer_id}/cancel":
    post:
      description: Cancels an ACH Transfer in a pending_approval state.
      operationId: cancel_a_pending_ach_transfer
      parameters:
        - example: ach_transfer_uoxatyh3lt5evrsdvo7q
          in: path
          name: ach_transfer_id
          required: true
          schema:
            description: The identifier of the pending ACH Transfer to cancel.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ach_transfer"
          description: ACH Transfer
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Cancel a pending ACH Transfer
      x-tag: ACH Transfers
  /balance_lookups:
    post:
      operationId: look_up_the_balance_for_an_account
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/look_up_the_balance_for_an_account_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/balance_lookup"
          description: Balance Lookup
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Look up the balance for an Account
      x-tag: Balance Lookups
  /bookkeeping_accounts:
    get:
      operationId: list_bookkeeping_accounts
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/bookkeeping_account_list"
          description: Bookkeeping Account List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List Bookkeeping Accounts
      x-tag: Bookkeeping Accounts
    post:
      operationId: create_a_bookkeeping_account
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/create_a_bookkeeping_account_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/bookkeeping_account"
          description: Bookkeeping Account
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Create a Bookkeeping Account
      x-tag: Bookkeeping Accounts
  /bookkeeping_entries:
    get:
      operationId: list_bookkeeping_entries
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/bookkeeping_entry_list"
          description: Bookkeeping Entry List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List Bookkeeping Entries
      x-tag: Bookkeeping Accounts
  /bookkeeping_entry_sets:
    post:
      operationId: create_a_bookkeeping_entry_set
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/create_a_bookkeeping_entry_set_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/bookkeeping_entry_set"
          description: Bookkeeping Entry Set
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Create a Bookkeeping Entry Set
      x-tag: Bookkeeping Accounts
  /card_disputes:
    get:
      operationId: list_card_disputes
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
        - in: query
          name: created_at.after
          required: false
          schema:
            description: Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.before
          required: false
          schema:
            description: Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_after
          required: false
          schema:
            description: Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_before
          required: false
          schema:
            description: Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: status.in
          required: false
          schema:
            description: Filter Card Disputes for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.
            items:
              enum:
                - pending_reviewing
                - accepted
                - rejected
              type: string
              x-enum-descriptions:
                - The Card Dispute is pending review.
                - The Card Dispute has been accepted and your funds have been returned.
                - The Card Dispute has been rejected.
            type: array
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/card_dispute_list"
          description: Card Dispute List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List Card Disputes
      x-tag: Card Disputes
    post:
      operationId: create_a_card_dispute
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/create_a_card_dispute_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/card_dispute"
          description: Card Dispute
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Create a Card Dispute
      x-tag: Card Disputes
  "/card_disputes/{card_dispute_id}":
    get:
      operationId: retrieve_a_card_dispute
      parameters:
        - example: card_dispute_h9sc95nbl1cgltpp7men
          in: path
          name: card_dispute_id
          required: true
          schema:
            description: The identifier of the Card Dispute.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/card_dispute"
          description: Card Dispute
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve a Card Dispute
      x-tag: Card Disputes
  /card_profiles:
    get:
      operationId: list_card_profiles
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
        - in: query
          name: status.in
          required: false
          schema:
            description: Filter Card Profiles for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.
            items:
              enum:
                - pending
                - rejected
                - active
                - archived
              type: string
              x-enum-descriptions:
                - The Card Profile is awaiting review from Increase and/or processing by card networks.
                - There is an issue with the Card Profile preventing it from use.
                - The Card Profile can be assigned to Cards.
                - The Card Profile is no longer in use.
            type: array
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/card_profile_list"
          description: Card Profile List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List Card Profiles
      x-tag: Card Profiles
    post:
      operationId: create_a_card_profile
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/create_a_card_profile_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/card_profile"
          description: Card Profile
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Create a Card Profile
      x-tag: Card Profiles
  "/card_profiles/{card_profile_id}":
    get:
      operationId: retrieve_a_card_profile
      parameters:
        - example: card_profile_cox5y73lob2eqly18piy
          in: path
          name: card_profile_id
          required: true
          schema:
            description: The identifier of the Card Profile.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/card_profile"
          description: Card Profile
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve a Card Profile
      x-tag: Card Profiles
  /cards:
    get:
      operationId: list_cards
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
        - example: account_in71c4amph0vgo2qllky
          in: query
          name: account_id
          required: false
          schema:
            description: Filter Cards to ones belonging to the specified Account.
            type: string
        - in: query
          name: created_at.after
          required: false
          schema:
            description: Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.before
          required: false
          schema:
            description: Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_after
          required: false
          schema:
            description: Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_before
          required: false
          schema:
            description: Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/card_list"
          description: Card List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List Cards
      x-tag: Cards
    post:
      operationId: create_a_card
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/create_a_card_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/card"
          description: Card
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Create a Card
      x-tag: Cards
  "/cards/{card_id}":
    get:
      operationId: retrieve_a_card
      parameters:
        - example: card_oubs0hwk5rn6knuecxg2
          in: path
          name: card_id
          required: true
          schema:
            description: The identifier of the Card.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/card"
          description: Card
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve a Card
      x-tag: Cards
    patch:
      operationId: update_a_card
      parameters:
        - example: card_oubs0hwk5rn6knuecxg2
          in: path
          name: card_id
          required: true
          schema:
            description: The card identifier.
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/update_a_card_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/card"
          description: Card
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Update a Card
      x-tag: Cards
  "/cards/{card_id}/details":
    get:
      operationId: retrieve_sensitive_details_for_a_card
      parameters:
        - example: card_oubs0hwk5rn6knuecxg2
          in: path
          name: card_id
          required: true
          schema:
            description: The identifier of the Card to retrieve details for.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/card_details"
          description: Card Details
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve sensitive details for a Card
      x-tag: Cards
  /check_deposits:
    get:
      operationId: list_check_deposits
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
        - example: account_in71c4amph0vgo2qllky
          in: query
          name: account_id
          required: false
          schema:
            description: Filter Check Deposits to those belonging to the specified Account.
            type: string
        - in: query
          name: created_at.after
          required: false
          schema:
            description: Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.before
          required: false
          schema:
            description: Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_after
          required: false
          schema:
            description: Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_before
          required: false
          schema:
            description: Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/check_deposit_list"
          description: Check Deposit List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List Check Deposits
      x-tag: Check Deposits
    post:
      operationId: create_a_check_deposit
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/create_a_check_deposit_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/check_deposit"
          description: Check Deposit
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Create a Check Deposit
      x-tag: Check Deposits
  "/check_deposits/{check_deposit_id}":
    get:
      operationId: retrieve_a_check_deposit
      parameters:
        - example: check_deposit_instruction_q2shv7x9qhevfm71kor8
          in: path
          name: check_deposit_id
          required: true
          schema:
            description: The identifier of the Check Deposit to retrieve.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/check_deposit"
          description: Check Deposit
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve a Check Deposit
      x-tag: Check Deposits
  /check_transfers:
    get:
      operationId: list_check_transfers
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
        - example: account_in71c4amph0vgo2qllky
          in: query
          name: account_id
          required: false
          schema:
            description: Filter Check Transfers to those that originated from the specified Account.
            type: string
        - in: query
          name: created_at.after
          required: false
          schema:
            description: Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.before
          required: false
          schema:
            description: Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_after
          required: false
          schema:
            description: Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_before
          required: false
          schema:
            description: Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/check_transfer_list"
          description: Check Transfer List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List Check Transfers
      x-tag: Check Transfers
    post:
      operationId: create_a_check_transfer
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/create_a_check_transfer_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/check_transfer"
          description: Check Transfer
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Create a Check Transfer
      x-tag: Check Transfers
  "/check_transfers/{check_transfer_id}":
    get:
      operationId: retrieve_a_check_transfer
      parameters:
        - example: check_transfer_30b43acfu9vw8fyc4f5
          in: path
          name: check_transfer_id
          required: true
          schema:
            description: The identifier of the Check Transfer.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/check_transfer"
          description: Check Transfer
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve a Check Transfer
      x-tag: Check Transfers
  "/check_transfers/{check_transfer_id}/approve":
    post:
      operationId: approve_a_check_transfer
      parameters:
        - example: check_transfer_30b43acfu9vw8fyc4f5
          in: path
          name: check_transfer_id
          required: true
          schema:
            description: The identifier of the Check Transfer to approve.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/check_transfer"
          description: Check Transfer
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Approve a Check Transfer
      x-tag: Check Transfers
  "/check_transfers/{check_transfer_id}/cancel":
    post:
      operationId: cancel_a_pending_check_transfer
      parameters:
        - example: check_transfer_30b43acfu9vw8fyc4f5
          in: path
          name: check_transfer_id
          required: true
          schema:
            description: The identifier of the pending Check Transfer to cancel.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/check_transfer"
          description: Check Transfer
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Cancel a pending Check Transfer
      x-tag: Check Transfers
  "/check_transfers/{check_transfer_id}/stop_payment":
    post:
      operationId: request_a_stop_payment_on_a_check_transfer
      parameters:
        - example: check_transfer_30b43acfu9vw8fyc4f5
          in: path
          name: check_transfer_id
          required: true
          schema:
            description: The identifier of the Check Transfer.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/check_transfer"
          description: Check Transfer
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Request a stop payment on a Check Transfer
      x-tag: Check Transfers
  /declined_transactions:
    get:
      operationId: list_declined_transactions
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
        - in: query
          name: account_id
          required: false
          schema:
            description: Filter Declined Transactions to ones belonging to the specified Account.
            type: string
        - in: query
          name: created_at.after
          required: false
          schema:
            description: Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.before
          required: false
          schema:
            description: Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_after
          required: false
          schema:
            description: Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_before
          required: false
          schema:
            description: Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: route_id
          required: false
          schema:
            description: Filter Declined Transactions to those belonging to the specified route.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/declined_transaction_list"
          description: Declined Transaction List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List Declined Transactions
      x-tag: Declined Transactions
  "/declined_transactions/{declined_transaction_id}":
    get:
      operationId: retrieve_a_declined_transaction
      parameters:
        - example: declined_transaction_17jbn0yyhvkt4v4ooym8
          in: path
          name: declined_transaction_id
          required: true
          schema:
            description: The identifier of the Declined Transaction.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/declined_transaction"
          description: Declined Transaction
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve a Declined Transaction
      x-tag: Declined Transactions
  /digital_wallet_tokens:
    get:
      operationId: list_digital_wallet_tokens
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
        - example: card_oubs0hwk5rn6knuecxg2
          in: query
          name: card_id
          required: false
          schema:
            description: Filter Digital Wallet Tokens to ones belonging to the specified Card.
            type: string
        - in: query
          name: created_at.after
          required: false
          schema:
            description: Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.before
          required: false
          schema:
            description: Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_after
          required: false
          schema:
            description: Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_before
          required: false
          schema:
            description: Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/digital_wallet_token_list"
          description: Digital Wallet Token List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List Digital Wallet Tokens
      x-tag: Digital Wallet Tokens
  "/digital_wallet_tokens/{digital_wallet_token_id}":
    get:
      operationId: retrieve_a_digital_wallet_token
      parameters:
        - example: digital_wallet_token_izi62go3h51p369jrie0
          in: path
          name: digital_wallet_token_id
          required: true
          schema:
            description: The identifier of the Digital Wallet Token.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/digital_wallet_token"
          description: Digital Wallet Token
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve a Digital Wallet Token
      x-tag: Digital Wallet Tokens
  /documents:
    get:
      operationId: list_documents
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
        - in: query
          name: entity_id
          required: false
          schema:
            description: Filter Documents to ones belonging to the specified Entity.
            type: string
        - in: query
          name: category.in
          required: false
          schema:
            description: Filter Documents for those with the specified category or categories. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.
            items:
              enum:
                - account_opening_disclosures
                - anti_money_laundering_policy
                - anti_money_laundering_procedures
                - audit_report
                - background_checks
                - business_continuity_plan
                - collections_policy
                - complaints_policy
                - complaint_report
                - compliance_report
                - compliance_staffing_plan
                - compliance_management_system_policy
                - consumer_privacy_notice
                - consumer_protection_policy
                - corporate_formation_document
                - credit_monitoring_report
                - customer_information_program_policy
                - electronic_funds_tranfer_act_policy
                - employee_overview
                - end_user_terms_of_service
                - e_sign_policy
                - financial_statement
                - form_1099_int
                - fraud_prevention_policy
                - funds_availability_policy
                - funds_availability_disclosure
                - funds_flow_diagram
                - gramm_leach_bliley_act_policy
                - information_security_policy
                - insurance_policy
                - investor_presentation
                - loan_application_processing_policy
                - management_biography
                - marketing_and_advertising_policy
                - network_security_diagram
                - onboarding_questionnaire
                - penetration_test_report
                - program_risk_assessment
                - security_audit_report
                - servicing_policy
                - transaction_monitoring_report
                - truth_in_savings_act_policy
                - underwriting_policy
                - vendor_list
                - vendor_management_policy
                - vendor_risk_management_report
                - volume_forecast
              type: string
              x-enum-descriptions:
                - The disclosures that the company uses to manage its account opening.
                - The policy that the company uses to manage its anti-money laundering.
                - The procedures that the company uses to implement it's AML policy.
                - An audit report for the company.
                - The results of one or more background checks.
                - A business continuity plan for the company.
                - The policy that the company uses to manage its collections.
                - The policy that the company uses to manage its complaints.
                - A report that was used to manage the company's complaints.
                - A compliance report not covered by another category.
                - A list of employees or organizational chart for the compliance/risk team. If absent, description of compliance vendor or compliance staffing plan for future hires.
                - The policy that the company uses to manage its compliance.
                - The notice that the company uses to manage its consumer privacy.
                - The policy that the company uses to manage its consumer protection.
                - The document that was used to form the company.
                - A report that was used to monitor the company's credit.
                - The policy that the company uses to manage its customer information.
                - The policy that the company uses to manage its Electronic Funds Transfer Act.
                - An overview of the company's employees.
                - The terms of service that the company uses for its end users.
                - The policy that the company uses to manage its e-signatures.
                - A financial statement for the company.
                - Internal Revenue Service Form 1099-INT.
                - The policy that the company uses to manage its fraud prevention.
                - The policy that the company uses to manage its funds availability.
                - The disclosure that the company uses to manage its funds availability.
                - A diagram of the company's funds flow.
                - The policy that the company uses to manage its Gramm-Leach-Bliley Act.
                - The policy that the company uses to manage its information security.
                - The policy that the company uses to manage its insurance.
                - A presentation that was given to investors.
                - The policy that the company uses to manage its loan application processing.
                - A biography of the company management.
                - The policy that the company uses to manage its marketing and advertising.
                - A diagram of the company's network security.
                - A questionnaire that was filled out by the company.
                - A report that was used to test the company's security.
                - An assessment of the program's risk.
                - A report that was used to audit the company's security.
                - The policy that the company uses to manage its servicing.
                - A report that was used to monitor the company's transactions.
                - The policy that the company uses to manage its Truth in Savings Act.
                - The policy that the company uses to manage its underwriting.
                - A risk-rated list of the company's vendors.
                - The policy that the company uses to manage its vendors.
                - A report that was used to manage the company's vendors.
                - A forecast of the company's volume.
            type: array
        - in: query
          name: created_at.after
          required: false
          schema:
            description: Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.before
          required: false
          schema:
            description: Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_after
          required: false
          schema:
            description: Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_before
          required: false
          schema:
            description: Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/document_list"
          description: Document List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List Documents
      x-tag: Documents
  "/documents/{document_id}":
    get:
      operationId: retrieve_a_document
      parameters:
        - example: document_qjtqc6s4c14ve2q89izm
          in: path
          name: document_id
          required: true
          schema:
            description: The identifier of the Document to retrieve.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/document"
          description: Document
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve a Document
      x-tag: Documents
  /entities:
    get:
      operationId: list_entities
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
        - in: query
          name: created_at.after
          required: false
          schema:
            description: Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.before
          required: false
          schema:
            description: Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_after
          required: false
          schema:
            description: Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_before
          required: false
          schema:
            description: Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/entity_list"
          description: Entity List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List Entities
      x-tag: Entities
    post:
      operationId: create_an_entity
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/create_an_entity_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/entity"
          description: Entity
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Create an Entity
      x-tag: Entities
  "/entities/{entity_id}":
    get:
      operationId: retrieve_an_entity
      parameters:
        - example: entity_n8y8tnk2p9339ti393yi
          in: path
          name: entity_id
          required: true
          schema:
            description: The identifier of the Entity to retrieve.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/entity"
          description: Entity
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve an Entity
      x-tag: Entities
  "/entities/{entity_id}/supplemental_documents":
    post:
      operationId: create_a_supplemental_document_for_an_entity
      parameters:
        - example: entity_n8y8tnk2p9339ti393yi
          in: path
          name: entity_id
          required: true
          schema:
            description: The identifier of the Entity to retrieve.
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/create_a_supplemental_document_for_an_entity_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/entity"
          description: Entity
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Create a supplemental document for an Entity
      x-tag: Entities
  /event_subscriptions:
    get:
      operationId: list_event_subscriptions
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/event_subscription_list"
          description: Event Subscription List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List Event Subscriptions
      x-tag: Event Subscriptions
    post:
      operationId: create_an_event_subscription
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/create_an_event_subscription_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/event_subscription"
          description: Event Subscription
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Create an Event Subscription
      x-tag: Event Subscriptions
  "/event_subscriptions/{event_subscription_id}":
    get:
      operationId: retrieve_an_event_subscription
      parameters:
        - example: event_subscription_001dzz0r20rcdxgb013zqb8m04g
          in: path
          name: event_subscription_id
          required: true
          schema:
            description: The identifier of the Event Subscription.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/event_subscription"
          description: Event Subscription
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve an Event Subscription
      x-tag: Event Subscriptions
    patch:
      operationId: update_an_event_subscription
      parameters:
        - example: event_subscription_001dzz0r20rcdxgb013zqb8m04g
          in: path
          name: event_subscription_id
          required: true
          schema:
            description: The identifier of the Event Subscription.
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/update_an_event_subscription_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/event_subscription"
          description: Event Subscription
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Update an Event Subscription
      x-tag: Event Subscriptions
  /events:
    get:
      operationId: list_events
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
        - in: query
          name: created_at.after
          required: false
          schema:
            description: Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.before
          required: false
          schema:
            description: Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_after
          required: false
          schema:
            description: Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_before
          required: false
          schema:
            description: Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: category.in
          required: false
          schema:
            description: Filter Events for those with the specified category or categories. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.
            items:
              enum:
                - account.created
                - account.updated
                - account_number.created
                - account_number.updated
                - account_statement.created
                - account_transfer.created
                - account_transfer.updated
                - ach_prenotification.created
                - ach_prenotification.updated
                - ach_transfer.created
                - ach_transfer.updated
                - card.created
                - card.updated
                - card_payment.created
                - card_payment.updated
                - card_dispute.created
                - card_dispute.updated
                - check_deposit.created
                - check_deposit.updated
                - check_transfer.created
                - check_transfer.updated
                - declined_transaction.created
                - digital_wallet_token.created
                - digital_wallet_token.updated
                - document.created
                - entity.created
                - entity.updated
                - external_account.created
                - file.created
                - group.updated
                - group.heartbeat
                - inbound_ach_transfer_return.created
                - inbound_ach_transfer_return.updated
                - inbound_wire_drawdown_request.created
                - oauth_connection.created
                - oauth_connection.deactivated
                - pending_transaction.created
                - pending_transaction.updated
                - real_time_decision.card_authorization_requested
                - real_time_decision.digital_wallet_token_requested
                - real_time_decision.digital_wallet_authentication_requested
                - real_time_payments_transfer.created
                - real_time_payments_transfer.updated
                - real_time_payments_request_for_payment.created
                - real_time_payments_request_for_payment.updated
                - transaction.created
                - wire_drawdown_request.created
                - wire_drawdown_request.updated
                - wire_transfer.created
                - wire_transfer.updated
              type: string
              x-enum-descriptions:
                - Occurs whenever an Account is created.
                - Occurs whenever an Account is updated.
                - Occurs whenever an Account Number is created.
                - Occurs whenever an Account Number is updated.
                - Occurs whenever an Account Statement is created.
                - Occurs whenever an Account Transfer is created.
                - Occurs whenever an Account Transfer is updated.
                - Occurs whenever an ACH Prenotification is created.
                - Occurs whenever an ACH Prenotification is updated.
                - Occurs whenever an ACH Transfer is created.
                - Occurs whenever an ACH Transfer is updated.
                - Occurs whenever a Card is created.
                - Occurs whenever a Card is updated.
                - Occurs whenever a Card Payment is created.
                - Occurs whenever a Card Payment is updated.
                - Occurs whenever a Card Dispute is created.
                - Occurs whenever a Card Dispute is updated.
                - Occurs whenever a Check Deposit is created.
                - Occurs whenever a Check Deposit is updated.
                - Occurs whenever a Check Transfer is created.
                - Occurs whenever a Check Transfer is updated.
                - Occurs whenever a Declined Transaction is created.
                - Occurs whenever a Digital Wallet Token is created.
                - Occurs whenever a Digital Wallet Token is updated.
                - Occurs whenever a Document is created.
                - Occurs whenever an Entity is created.
                - Occurs whenever an Entity is updated.
                - Occurs whenever an External Account is created.
                - Occurs whenever a File is created.
                - Occurs whenever a Group is updated.
                - Increase may send webhooks with this category to see if a webhook endpoint is working properly.
                - Occurs whenever an Inbound ACH Transfer Return is created.
                - Occurs whenever an Inbound ACH Transfer Return is updated.
                - Occurs whenever an Inbound Wire Drawdown Request is created.
                - Occurs whenever an OAuth Connection is created.
                - Occurs whenever an OAuth Connection is deactivated.
                - Occurs whenever a Pending Transaction is created.
                - Occurs whenever a Pending Transaction is updated.
                - Occurs whenever a Real-Time Decision is created in response to a card authorization.
                - Occurs whenever a Real-Time Decision is created in response to a digital wallet provisioning attempt.
                - Occurs whenever a Real-Time Decision is created in response to a digital wallet requiring two-factor authentication.
                - Occurs whenever a Real Time Payments Transfer is created.
                - Occurs whenever a Real Time Payments Transfer is updated.
                - Occurs whenever a Real Time Payments Request for Payment is created.
                - Occurs whenever a Real Time Payments Request for Payment is updated.
                - Occurs whenever a Transaction is updated.
                - Occurs whenever a Wire Drawdown Request is created.
                - Occurs whenever a Wire Drawdown Request is updated.
                - Occurs whenever a Wire Transfer is created.
                - Occurs whenever a Wire Transfer is updated.
            type: array
        - in: query
          name: associated_object_id
          required: false
          schema:
            description: Filter Events to those belonging to the object with the provided identifier.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/event_list"
          description: Event List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List Events
      x-tag: Events
  "/events/{event_id}":
    get:
      operationId: retrieve_an_event
      parameters:
        - example: event_001dzz0r20rzr4zrhrr1364hy80
          in: path
          name: event_id
          required: true
          schema:
            description: The identifier of the Event.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/event"
          description: Event
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve an Event
      x-tag: Events
  /exports:
    get:
      operationId: list_exports
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/export_list"
          description: Export List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List Exports
      x-tag: Exports
    post:
      operationId: create_an_export
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/create_an_export_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/export"
          description: Export
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Create an Export
      x-tag: Exports
  "/exports/{export_id}":
    get:
      operationId: retrieve_an_export
      parameters:
        - example: export_8s4m48qz3bclzje0zwh9
          in: path
          name: export_id
          required: true
          schema:
            description: The identifier of the Export to retrieve.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/export"
          description: Export
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve an Export
      x-tag: Exports
  /external_accounts:
    get:
      operationId: list_external_accounts
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
        - in: query
          name: status.in
          required: false
          schema:
            description: Filter External Accounts for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.
            items:
              enum:
                - active
                - archived
              type: string
              x-enum-descriptions:
                - The External Acccount is active.
                - The External Account is archived and won't appear in the dashboard.
            type: array
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/external_account_list"
          description: External Account List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List External Accounts
      x-tag: External Accounts
    post:
      operationId: create_an_external_account
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/create_an_external_account_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/external_account"
          description: External Account
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Create an External Account
      x-tag: External Accounts
  "/external_accounts/{external_account_id}":
    get:
      operationId: retrieve_an_external_account
      parameters:
        - example: external_account_ukk55lr923a3ac0pp7iv
          in: path
          name: external_account_id
          required: true
          schema:
            description: The identifier of the External Account.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/external_account"
          description: External Account
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve an External Account
      x-tag: External Accounts
    patch:
      operationId: update_an_external_account
      parameters:
        - example: external_account_ukk55lr923a3ac0pp7iv
          in: path
          name: external_account_id
          required: true
          schema:
            description: The external account identifier.
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/update_an_external_account_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/external_account"
          description: External Account
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Update an External Account
      x-tag: External Accounts
  /files:
    get:
      operationId: list_files
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
        - in: query
          name: created_at.after
          required: false
          schema:
            description: Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.before
          required: false
          schema:
            description: Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_after
          required: false
          schema:
            description: Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_before
          required: false
          schema:
            description: Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: purpose.in
          required: false
          schema:
            description: Filter Files for those with the specified purpose or purposes. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.
            items:
              enum:
                - check_image_front
                - check_image_back
                - form_1099_int
                - form_ss_4
                - identity_document
                - increase_statement
                - other
                - trust_formation_document
                - digital_wallet_artwork
                - digital_wallet_app_icon
                - document_request
                - entity_supplemental_document
                - export
              type: string
              x-enum-descriptions:
                - An image of the front of a check, used for check deposits.
                - An image of the back of a check, used for check deposits.
                - IRS Form 1099-INT.
                - IRS Form SS-4.
                - An image of a government-issued ID.
                - A statement generated by Increase.
                - A file purpose not covered by any of the other cases.
                - A legal document forming a trust.
                - A card image to be rendered inside digital wallet apps. This must be a 1536x969 pixel PNG.
                - An icon for you app to be rendered inside digital wallet apps. This must be a 100x100 pixel PNG.
                - A document requested by Increase.
                - A supplemental document associated an an Entity.
                - The results of an Export you requested via the dashboard or API.
            type: array
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/file_list"
          description: File List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List Files
      x-tag: Files
    post:
      description: To upload a file to Increase, you'll need to send a request of Content-Type `multipart/form-data`. The request should contain the file you would like to upload, as well as the parameters for creating a file.
      operationId: create_a_file
      parameters: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: "#/components/schemas/create_a_file_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/file"
          description: File
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Create a File
      x-tag: Files
  "/files/{file_id}":
    get:
      operationId: retrieve_a_file
      parameters:
        - example: file_makxrc67oh9l6sg7w9yc
          in: path
          name: file_id
          required: true
          schema:
            description: The identifier of the File.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/file"
          description: File
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve a File
      x-tag: Files
  /groups/current:
    get:
      description: Returns details for the currently authenticated Group.
      operationId: retrieve_group_details
      parameters: []
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/group"
          description: Group
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve Group details
      x-tag: Groups
  /inbound_ach_transfer_returns:
    get:
      operationId: list_inbound_ach_transfer_returns
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/inbound_ach_transfer_return_list"
          description: Inbound ACH Transfer Return List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List Inbound ACH Transfer Returns
      x-tag: Inbound ACH Transfer Returns
    post:
      operationId: create_an_ach_return
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/create_an_ach_return_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/inbound_ach_transfer_return"
          description: Inbound ACH Transfer Return
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Create an ACH Return
      x-tag: Inbound ACH Transfer Returns
  "/inbound_ach_transfer_returns/{inbound_ach_transfer_return_id}":
    get:
      operationId: retrieve_an_inbound_ach_transfer_return
      parameters:
        - example: inbound_ach_transfer_return_fhcxk5huskwhmt7iz0gk
          in: path
          name: inbound_ach_transfer_return_id
          required: true
          schema:
            description: The identifier of the Inbound ACH Transfer Return to retrieve.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/inbound_ach_transfer_return"
          description: Inbound ACH Transfer Return
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve an Inbound ACH Transfer Return
      x-tag: Inbound ACH Transfer Returns
  /inbound_wire_drawdown_requests:
    get:
      operationId: list_inbound_wire_drawdown_requests
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/inbound_wire_drawdown_request_list"
          description: Inbound Wire Drawdown Request List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List Inbound Wire Drawdown Requests
      x-tag: Inbound Wire Drawdown Requests
  "/inbound_wire_drawdown_requests/{inbound_wire_drawdown_request_id}":
    get:
      operationId: retrieve_an_inbound_wire_drawdown_request
      parameters:
        - example: inbound_wire_drawdown_request_u5a92ikqhz1ytphn799e
          in: path
          name: inbound_wire_drawdown_request_id
          required: true
          schema:
            description: The identifier of the Inbound Wire Drawdown Request to retrieve.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/inbound_wire_drawdown_request"
          description: Inbound Wire Drawdown Request
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve an Inbound Wire Drawdown Request
      x-tag: Inbound Wire Drawdown Requests
  /limits:
    get:
      operationId: list_limits
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
        - example: account_number_v18nkfqm6afpsrvy82b2
          in: query
          name: model_id
          required: false
          schema:
            description: The model to retrieve limits for.
            maxLength: 200
            minLength: 1
            type: string
        - example: active
          in: query
          name: status
          required: false
          schema:
            description: The status to retrieve limits for.
            maxLength: 200
            minLength: 1
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/limit_list"
          description: Limit List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List Limits
      x-tag: Limits
    post:
      operationId: create_a_limit
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/create_a_limit_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/limit"
          description: Limit
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Create a Limit
      x-tag: Limits
  "/limits/{limit_id}":
    get:
      operationId: retrieve_a_limit
      parameters:
        - example: limit_fku42k0qtc8ulsuas38q
          in: path
          name: limit_id
          required: true
          schema:
            description: The identifier of the Limit to retrieve.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/limit"
          description: Limit
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve a Limit
      x-tag: Limits
    patch:
      operationId: update_a_limit
      parameters:
        - example: limit_fku42k0qtc8ulsuas38q
          in: path
          name: limit_id
          required: true
          schema:
            description: The limit to update.
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/update_a_limit_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/limit"
          description: Limit
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Update a Limit
      x-tag: Limits
  /oauth_connections:
    get:
      operationId: list_oauth_connections
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/oauth_connection_list"
          description: OAuth Connection List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List OAuth Connections
      x-tag: OAuth Connections
  "/oauth_connections/{oauth_connection_id}":
    get:
      operationId: retrieve_an_oauth_connection
      parameters:
        - example: connection_dauknoksyr4wilz4e6my
          in: path
          name: oauth_connection_id
          required: true
          schema:
            description: The identifier of the OAuth Connection.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/oauth_connection"
          description: OAuth Connection
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve an OAuth Connection
      x-tag: OAuth Connections
  /pending_transactions:
    get:
      operationId: list_pending_transactions
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
        - in: query
          name: account_id
          required: false
          schema:
            description: Filter pending transactions to those belonging to the specified Account.
            type: string
        - in: query
          name: route_id
          required: false
          schema:
            description: Filter pending transactions to those belonging to the specified Route.
            type: string
        - in: query
          name: source_id
          required: false
          schema:
            description: Filter pending transactions to those caused by the specified source.
            type: string
        - in: query
          name: status.in
          required: false
          schema:
            description: Filter Pending Transactions for those with the specified status. By default only Pending Transactions in with status `pending` will be returned. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.
            items:
              enum:
                - pending
                - complete
              type: string
              x-enum-descriptions:
                - The Pending Transaction is still awaiting confirmation.
                - The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc.
            type: array
        - in: query
          name: created_at.after
          required: false
          schema:
            description: Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.before
          required: false
          schema:
            description: Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_after
          required: false
          schema:
            description: Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_before
          required: false
          schema:
            description: Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/pending_transaction_list"
          description: Pending Transaction List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List Pending Transactions
      x-tag: Pending Transactions
  "/pending_transactions/{pending_transaction_id}":
    get:
      operationId: retrieve_a_pending_transaction
      parameters:
        - example: pending_transaction_k1sfetcau2qbvjbzgju4
          in: path
          name: pending_transaction_id
          required: true
          schema:
            description: The identifier of the Pending Transaction.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/pending_transaction"
          description: Pending Transaction
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve a Pending Transaction
      x-tag: Pending Transactions
  /programs:
    get:
      operationId: list_programs
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/program_list"
          description: Program List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List Programs
      x-tag: Programs
  "/programs/{program_id}":
    get:
      operationId: retrieve_a_program
      parameters:
        - example: program_i2v2os4mwza1oetokh9i
          in: path
          name: program_id
          required: true
          schema:
            description: The identifier of the Program to retrieve.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/program"
          description: Program
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve a Program
      x-tag: Programs
  "/real_time_decisions/{real_time_decision_id}":
    get:
      operationId: retrieve_a_real_time_decision
      parameters:
        - example: real_time_decision_j76n2e810ezcg3zh5qtn
          in: path
          name: real_time_decision_id
          required: true
          schema:
            description: The identifier of the Real-Time Decision.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/real_time_decision"
          description: Real-Time Decision
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve a Real-Time Decision
      x-tag: Real-Time Decisions
  "/real_time_decisions/{real_time_decision_id}/action":
    post:
      operationId: action_a_real_time_decision
      parameters:
        - example: real_time_decision_j76n2e810ezcg3zh5qtn
          in: path
          name: real_time_decision_id
          required: true
          schema:
            description: The identifier of the Real-Time Decision.
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/action_a_real_time_decision_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/real_time_decision"
          description: Real-Time Decision
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Action a Real-Time Decision
      x-tag: Real-Time Decisions
  /real_time_payments_transfers:
    get:
      operationId: list_real_time_payments_transfers
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
        - example: account_in71c4amph0vgo2qllky
          in: query
          name: account_id
          required: false
          schema:
            description: Filter Real Time Payments Transfers to those belonging to the specified Account.
            type: string
        - in: query
          name: external_account_id
          required: false
          schema:
            description: Filter Real Time Payments Transfers to those made to the specified External Account.
            type: string
        - in: query
          name: created_at.after
          required: false
          schema:
            description: Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.before
          required: false
          schema:
            description: Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_after
          required: false
          schema:
            description: Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_before
          required: false
          schema:
            description: Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/real_time_payments_transfer_list"
          description: Real Time Payments Transfer List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List Real Time Payments Transfers
      x-tag: Real Time Payments Transfers
    post:
      operationId: create_a_real_time_payments_transfer
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/create_a_real_time_payments_transfer_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/real_time_payments_transfer"
          description: Real Time Payments Transfer
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Create a Real Time Payments Transfer
      x-tag: Real Time Payments Transfers
  "/real_time_payments_transfers/{real_time_payments_transfer_id}":
    get:
      operationId: retrieve_a_real_time_payments_transfer
      parameters:
        - example: real_time_payments_transfer_iyuhl5kdn7ssmup83mvq
          in: path
          name: real_time_payments_transfer_id
          required: true
          schema:
            description: The identifier of the Real Time Payments Transfer.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/real_time_payments_transfer"
          description: Real Time Payments Transfer
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve a Real Time Payments Transfer
      x-tag: Real Time Payments Transfers
  /routing_numbers:
    get:
      description: You can use this API to confirm if a routing number is valid, such as when a user is providing you with bank account details. Since routing numbers uniquely identify a bank, this will always return 0 or 1 entry. In Sandbox, the only valid routing number for this method is 110000000.
      operationId: list_routing_numbers
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
        - example: "021000021"
          in: query
          name: routing_number
          required: true
          schema:
            description: Filter financial institutions by routing number.
            maxLength: 9
            minLength: 9
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/routing_number_list"
          description: Routing Number List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List Routing Numbers
      x-tag: Routing Numbers
  /simulations/account_statements:
    post:
      description: Simulates an [Account Statement](#account-statements) being created for an account. In production, Account Statements are generated once per month.
      operationId: simulate_an_account_statement_being_created
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/simulate_an_account_statement_being_created_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/account_statement"
          description: Account Statement
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Simulate an Account Statement being created
      x-tag: Simulations
  "/simulations/account_transfers/{account_transfer_id}/complete":
    post:
      description: If your account is configured to require approval for each transfer, this endpoint simulates the approval of an [Account Transfer](#account-transfers). You can also approve sandbox Account Transfers in the dashboard. This transfer must first have a `status` of `pending_approval`.
      operationId: complete_a_sandbox_account_transfer
      parameters:
        - example: account_transfer_7k9qe1ysdgqztnt63l7n
          in: path
          name: account_transfer_id
          required: true
          schema:
            description: The identifier of the Account Transfer you wish to complete.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/account_transfer"
          description: Account Transfer
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Complete a Sandbox Account Transfer
      x-tag: Simulations
  "/simulations/ach_transfers/{ach_transfer_id}/return":
    post:
      description: Simulates the return of an [ACH Transfer](#ach-transfers) by the Federal Reserve due to an error condition. This will also create a Transaction to account for the returned funds. This transfer must first have a `status` of `submitted`.
      operationId: return_a_sandbox_ach_transfer
      parameters:
        - example: ach_transfer_uoxatyh3lt5evrsdvo7q
          in: path
          name: ach_transfer_id
          required: true
          schema:
            description: The identifier of the ACH Transfer you wish to return.
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/return_a_sandbox_ach_transfer_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ach_transfer"
          description: ACH Transfer
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Return a Sandbox ACH Transfer
      x-tag: Simulations
  "/simulations/ach_transfers/{ach_transfer_id}/submit":
    post:
      description: Simulates the submission of an [ACH Transfer](#ach-transfers) to the Federal Reserve. This transfer must first have a `status` of `pending_approval` or `pending_submission`. In production, Increase submits ACH Transfers to the Federal Reserve three times per day on weekdays. Since sandbox ACH Transfers are not submitted to the Federal Reserve, this endpoint allows you to skip that delay and transition the ACH Transfer to a status of `submitted`.
      operationId: submit_a_sandbox_ach_transfer
      parameters:
        - example: ach_transfer_uoxatyh3lt5evrsdvo7q
          in: path
          name: ach_transfer_id
          required: true
          schema:
            description: The identifier of the ACH Transfer you wish to submit.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/ach_transfer"
          description: ACH Transfer
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Submit a Sandbox ACH Transfer
      x-tag: Simulations
  /simulations/card_authorizations:
    post:
      description: Simulates a purchase authorization on a [Card](#cards). Depending on the balance available to the card and the `amount` submitted, the authorization activity will result in a [Pending Transaction](#pending-transactions) of type `card_authorization` or a [Declined Transaction](#declined-transactions) of type `card_decline`. You can pass either a Card id or a [Digital Wallet Token](#digital-wallet-tokens) id to simulate the two different ways purchases can be made.
      operationId: simulate_an_authorization_on_a_card
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/simulate_an_authorization_on_a_card_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/inbound_card_authorization_simulation_result"
          description: Inbound Card Authorization Simulation Result
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Simulate an authorization on a Card
      x-tag: Simulations
  "/simulations/card_disputes/{card_dispute_id}/action":
    post:
      description: After a [Card Dispute](#card-disputes) is created in production, the dispute will be reviewed. Since no review happens in sandbox, this endpoint simulates moving a Card Dispute into a rejected or accepted state. A Card Dispute can only be actioned one time and must have a status of `pending_reviewing`.
      operationId: simulates_advancing_the_state_of_a_card_dispute
      parameters:
        - example: card_dispute_h9sc95nbl1cgltpp7men
          in: path
          name: card_dispute_id
          required: true
          schema:
            description: The dispute you would like to action.
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/simulates_advancing_the_state_of_a_card_dispute_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/card_dispute"
          description: Card Dispute
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Simulates advancing the state of a card dispute
      x-tag: Simulations
  /simulations/card_refunds:
    post:
      description: Simulates refunding a card transaction. The full value of the original sandbox transaction is refunded.
      operationId: simulate_a_refund_on_a_card
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/simulate_a_refund_on_a_card_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/transaction"
          description: Transaction
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Simulate a refund on a card
      x-tag: Simulations
  /simulations/card_settlements:
    post:
      description: Simulates the settlement of an authorization by a card acquirer. After a card authorization is created, the merchant will eventually send a settlement. This simulates that event, which may occur many days after the purchase in production. The amount settled can be different from the amount originally authorized, for example, when adding a tip to a restaurant bill.
      operationId: simulate_settling_a_card_authorization
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/simulate_settling_a_card_authorization_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/transaction"
          description: Transaction
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Simulate settling a card authorization
      x-tag: Simulations
  "/simulations/check_deposits/{check_deposit_id}/reject":
    post:
      description: Simulates the rejection of a [Check Deposit](#check-deposits) by Increase due to factors like poor image quality. This Check Deposit must first have a `status` of `pending`.
      operationId: reject_a_sandbox_check_deposit
      parameters:
        - example: check_deposit_f06n9gpg7sxn8t19lfc1
          in: path
          name: check_deposit_id
          required: true
          schema:
            description: The identifier of the Check Deposit you wish to reject.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/check_deposit"
          description: Check Deposit
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Reject a Sandbox Check Deposit
      x-tag: Simulations
  "/simulations/check_deposits/{check_deposit_id}/return":
    post:
      description: Simulates the return of a [Check Deposit](#check-deposits). This Check Deposit must first have a `status` of `submitted`.
      operationId: return_a_sandbox_check_deposit
      parameters:
        - example: check_deposit_f06n9gpg7sxn8t19lfc1
          in: path
          name: check_deposit_id
          required: true
          schema:
            description: The identifier of the Check Deposit you wish to return.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/check_deposit"
          description: Check Deposit
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Return a Sandbox Check Deposit
      x-tag: Simulations
  "/simulations/check_deposits/{check_deposit_id}/submit":
    post:
      description: Simulates the submission of a [Check Deposit](#check-deposits) to the Federal Reserve. This Check Deposit must first have a `status` of `pending`.
      operationId: submit_a_sandbox_check_deposit
      parameters:
        - example: check_deposit_f06n9gpg7sxn8t19lfc1
          in: path
          name: check_deposit_id
          required: true
          schema:
            description: The identifier of the Check Deposit you wish to submit.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/check_deposit"
          description: Check Deposit
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Submit a Sandbox Check Deposit
      x-tag: Simulations
  "/simulations/check_transfers/{check_transfer_id}/deposit":
    post:
      description: Simulates a [Check Transfer](#check-transfers) being deposited at a bank. This transfer must first have a `status` of `mailed`.
      operationId: deposit_a_sandbox_check_transfer
      parameters:
        - example: check_transfer_30b43acfu9vw8fyc4f5
          in: path
          name: check_transfer_id
          required: true
          schema:
            description: The identifier of the Check Transfer you wish to mark deposited.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/check_transfer"
          description: Check Transfer
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Deposit a Sandbox Check Transfer
      x-tag: Simulations
  "/simulations/check_transfers/{check_transfer_id}/mail":
    post:
      description: Simulates the mailing of a [Check Transfer](#check-transfers), which happens once per weekday in production but can be sped up in sandbox. This transfer must first have a `status` of `pending_approval` or `pending_submission`.
      operationId: mail_a_sandbox_check_transfer
      parameters:
        - example: check_transfer_30b43acfu9vw8fyc4f5
          in: path
          name: check_transfer_id
          required: true
          schema:
            description: The identifier of the Check Transfer you wish to mail.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/check_transfer"
          description: Check Transfer
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Mail a Sandbox Check Transfer
      x-tag: Simulations
  "/simulations/check_transfers/{check_transfer_id}/return":
    post:
      description: Simulates a [Check Transfer](#check-transfers) being returned via USPS to Increase. This transfer must first have a `status` of `mailed`.
      operationId: return_a_sandbox_check_transfer
      parameters:
        - example: check_transfer_30b43acfu9vw8fyc4f5
          in: path
          name: check_transfer_id
          required: true
          schema:
            description: The identifier of the Check Transfer you wish to mark returned.
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/return_a_sandbox_check_transfer_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/check_transfer"
          description: Check Transfer
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Return a Sandbox Check Transfer
      x-tag: Simulations
  /simulations/digital_wallet_token_requests:
    post:
      description: Simulates a user attempting add a [Card](#cards) to a digital wallet such as Apple Pay.
      operationId: simulate_digital_wallet_provisioning_for_a_card
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/simulate_digital_wallet_provisioning_for_a_card_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/inbound_digital_wallet_token_request_simulation_result"
          description: Inbound Digital Wallet Token Request Simulation Result
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Simulate digital wallet provisioning for a card
      x-tag: Simulations
  /simulations/documents:
    post:
      description: Simulates an tax document being created for an account.
      operationId: simulate_a_tax_document_being_created
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/simulate_a_tax_document_being_created_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/document"
          description: Document
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Simulate a tax document being created
      x-tag: Simulations
  /simulations/inbound_ach_transfers:
    post:
      description: Simulates an inbound ACH transfer to your account. This imitates initiating a transaction to an Increase account from a different financial institution. The transfer may be either a credit or a debit depending on if the `amount` is positive or negative. The result of calling this API will be either a [Transaction](#transactions) or a [Declined Transaction](#declined-transactions) depending on whether or not the transfer is allowed.
      operationId: simulate_an_ach_transfer_to_your_account
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/simulate_an_ach_transfer_to_your_account_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/inbound_ach_transfer_simulation_result"
          description: Inbound ACH Transfer Simulation Result
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Simulate an ACH Transfer to your account
      x-tag: Simulations
  /simulations/inbound_real_time_payments_transfers:
    post:
      description: Simulates an inbound Real Time Payments transfer to your account. Real Time Payments are a beta feature.
      operationId: simulate_a_real_time_payments_transfer_to_your_account
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/simulate_a_real_time_payments_transfer_to_your_account_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/inbound_real_time_payments_transfer_simulation_result"
          description: Inbound Real Time Payments Transfer Simulation Result
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Simulate a Real Time Payments Transfer to your account
      x-tag: Simulations
  /simulations/inbound_wire_drawdown_requests:
    post:
      description: Simulates the receival of an [Inbound Wire Drawdown Request](#inbound-wire-drawdown-requests).
      operationId: simulate_an_inbound_wire_drawdown_request_being_created
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/simulate_an_inbound_wire_drawdown_request_being_created_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/inbound_wire_drawdown_request"
          description: Inbound Wire Drawdown Request
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Simulate an Inbound Wire Drawdown request being created
      x-tag: Simulations
  /simulations/inbound_wire_transfers:
    post:
      description: Simulates an inbound Wire Transfer to your account.
      operationId: simulate_a_wire_transfer_to_your_account
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/simulate_a_wire_transfer_to_your_account_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/inbound_wire_transfer_simulation_result"
          description: Inbound Wire Transfer Simulation Result
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Simulate a Wire Transfer to your account
      x-tag: Simulations
  /simulations/interest_payment:
    post:
      description: Simulates an interest payment to your account. In production, this happens automatically on the first of each month.
      operationId: simulate_an_interest_payment_to_your_account
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/simulate_an_interest_payment_to_your_account_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/interest_payment_simulation_result"
          description: Interest Payment Simulation Result
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Simulate an Interest Payment to your account
      x-tag: Simulations
  "/simulations/real_time_payments_transfers/{real_time_payments_transfer_id}/complete":
    post:
      description: Simulates submission of a Real Time Payments transfer and handling the response from the destination financial institution. This transfer must first have a `status` of `pending_submission`.
      operationId: complete_a_sandbox_real_time_payments_transfer
      parameters:
        - example: real_time_payments_transfer_iyuhl5kdn7ssmup83mvq
          in: path
          name: real_time_payments_transfer_id
          required: true
          schema:
            description: The identifier of the Real Time Payments Transfer you wish to complete.
            type: string
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/complete_a_sandbox_real_time_payments_transfer_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/real_time_payments_transfer"
          description: Real Time Payments Transfer
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Complete a Sandbox Real Time Payments Transfer
      x-tag: Simulations
  "/simulations/wire_transfers/{wire_transfer_id}/reverse":
    post:
      description: Simulates the reversal of a [Wire Transfer](#wire-transfers) by the Federal Reserve due to error conditions. This will also create a [Transaction](#transaction) to account for the returned funds. This Wire Transfer must first have a `status` of `complete`.'
      operationId: reverse_a_sandbox_wire_transfer
      parameters:
        - example: wire_transfer_5akynk7dqsq25qwk9q2u
          in: path
          name: wire_transfer_id
          required: true
          schema:
            description: The identifier of the Wire Transfer you wish to reverse.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/wire_transfer"
          description: Wire Transfer
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Reverse a Sandbox Wire Transfer
      x-tag: Simulations
  "/simulations/wire_transfers/{wire_transfer_id}/submit":
    post:
      description: Simulates the submission of a [Wire Transfer](#wire-transfers) to the Federal Reserve. This transfer must first have a `status` of `pending_approval` or `pending_creating`.
      operationId: submit_a_sandbox_wire_transfer
      parameters:
        - example: wire_transfer_5akynk7dqsq25qwk9q2u
          in: path
          name: wire_transfer_id
          required: true
          schema:
            description: The identifier of the Wire Transfer you wish to submit.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/wire_transfer"
          description: Wire Transfer
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Submit a Sandbox Wire Transfer
      x-tag: Simulations
  /transactions:
    get:
      operationId: list_transactions
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
        - in: query
          name: account_id
          required: false
          schema:
            description: Filter Transactions for those belonging to the specified Account.
            type: string
        - in: query
          name: created_at.after
          required: false
          schema:
            description: Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.before
          required: false
          schema:
            description: Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_after
          required: false
          schema:
            description: Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_before
          required: false
          schema:
            description: Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: category.in
          required: false
          schema:
            description: Return results whose value is in the provided list. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.
            items:
              enum:
                - account_transfer_intention
                - ach_check_conversion_return
                - ach_check_conversion
                - ach_transfer_intention
                - ach_transfer_rejection
                - ach_transfer_return
                - card_dispute_acceptance
                - card_refund
                - card_settlement
                - card_revenue_payment
                - check_deposit_acceptance
                - check_deposit_return
                - check_transfer_intention
                - check_transfer_return
                - check_transfer_rejection
                - check_transfer_stop_payment_request
                - dispute_resolution
                - empyreal_cash_deposit
                - fee_payment
                - inbound_ach_transfer
                - inbound_ach_transfer_return_intention
                - inbound_check
                - inbound_international_ach_transfer
                - inbound_real_time_payments_transfer_confirmation
                - inbound_wire_drawdown_payment_reversal
                - inbound_wire_drawdown_payment
                - inbound_wire_reversal
                - inbound_wire_transfer
                - interest_payment
                - internal_general_ledger_transaction
                - internal_source
                - card_route_refund
                - card_route_settlement
                - real_time_payments_transfer_acknowledgement
                - sample_funds
                - wire_drawdown_payment_intention
                - wire_drawdown_payment_rejection
                - wire_transfer_intention
                - wire_transfer_rejection
                - other
              type: string
              x-enum-descriptions:
                - The Transaction was created by a Account Transfer Intention object. Details will be under the `account_transfer_intention` object.
                - The Transaction was created by a ACH Check Conversion Return object. Details will be under the `ach_check_conversion_return` object.
                - The Transaction was created by a ACH Check Conversion object. Details will be under the `ach_check_conversion` object.
                - The Transaction was created by a ACH Transfer Intention object. Details will be under the `ach_transfer_intention` object.
                - The Transaction was created by a ACH Transfer Rejection object. Details will be under the `ach_transfer_rejection` object.
                - The Transaction was created by a ACH Transfer Return object. Details will be under the `ach_transfer_return` object.
                - The Transaction was created by a Card Dispute Acceptance object. Details will be under the `card_dispute_acceptance` object.
                - The Transaction was created by a Card Refund object. Details will be under the `card_refund` object.
                - The Transaction was created by a Card Settlement object. Details will be under the `card_settlement` object.
                - The Transaction was created by a Card Revenue Payment object. Details will be under the `card_revenue_payment` object.
                - The Transaction was created by a Check Deposit Acceptance object. Details will be under the `check_deposit_acceptance` object.
                - The Transaction was created by a Check Deposit Return object. Details will be under the `check_deposit_return` object.
                - The Transaction was created by a Check Transfer Intention object. Details will be under the `check_transfer_intention` object.
                - The Transaction was created by a Check Transfer Return object. Details will be under the `check_transfer_return` object.
                - The Transaction was created by a Check Transfer Rejection object. Details will be under the `check_transfer_rejection` object.
                - The Transaction was created by a Check Transfer Stop Payment Request object. Details will be under the `check_transfer_stop_payment_request` object.
                - The Transaction was created by a Dispute Resolution object. Details will be under the `dispute_resolution` object.
                - The Transaction was created by a Empyreal Cash Deposit object. Details will be under the `empyreal_cash_deposit` object.
                - The Transaction was created by a Fee Payment object. Details will be under the `fee_payment` object.
                - The Transaction was created by a Inbound ACH Transfer object. Details will be under the `inbound_ach_transfer` object.
                - The Transaction was created by a Inbound ACH Transfer Return Intention object. Details will be under the `inbound_ach_transfer_return_intention` object.
                - The Transaction was created by a Inbound Check object. Details will be under the `inbound_check` object.
                - The Transaction was created by a Inbound International ACH Transfer object. Details will be under the `inbound_international_ach_transfer` object.
                - The Transaction was created by a Inbound Real Time Payments Transfer Confirmation object. Details will be under the `inbound_real_time_payments_transfer_confirmation` object.
                - The Transaction was created by a Inbound Wire Drawdown Payment Reversal object. Details will be under the `inbound_wire_drawdown_payment_reversal` object.
                - The Transaction was created by a Inbound Wire Drawdown Payment object. Details will be under the `inbound_wire_drawdown_payment` object.
                - The Transaction was created by a Inbound Wire Reversal object. Details will be under the `inbound_wire_reversal` object.
                - The Transaction was created by a Inbound Wire Transfer object. Details will be under the `inbound_wire_transfer` object.
                - The Transaction was created by a Interest Payment object. Details will be under the `interest_payment` object.
                - The Transaction was created by a Internal General Ledger Transaction object. Details will be under the `internal_general_ledger_transaction` object.
                - The Transaction was created by a Internal Source object. Details will be under the `internal_source` object.
                - The Transaction was created by a Deprecated Card Refund object. Details will be under the `card_route_refund` object.
                - The Transaction was created by a Deprecated Card Settlement object. Details will be under the `card_route_settlement` object.
                - The Transaction was created by a Real Time Payments Transfer Acknowledgement object. Details will be under the `real_time_payments_transfer_acknowledgement` object.
                - The Transaction was created by a Sample Funds object. Details will be under the `sample_funds` object.
                - The Transaction was created by a Wire Drawdown Payment Intention object. Details will be under the `wire_drawdown_payment_intention` object.
                - The Transaction was created by a Wire Drawdown Payment Rejection object. Details will be under the `wire_drawdown_payment_rejection` object.
                - The Transaction was created by a Wire Transfer Intention object. Details will be under the `wire_transfer_intention` object.
                - The Transaction was created by a Wire Transfer Rejection object. Details will be under the `wire_transfer_rejection` object.
                - The Transaction was made for an undocumented or deprecated reason.
            type: array
        - in: query
          name: route_id
          required: false
          schema:
            description: Filter Transactions for those belonging to the specified route.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/transaction_list"
          description: Transaction List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List Transactions
      x-tag: Transactions
  "/transactions/{transaction_id}":
    get:
      operationId: retrieve_a_transaction
      parameters:
        - example: transaction_uyrp7fld2ium70oa7oi
          in: path
          name: transaction_id
          required: true
          schema:
            description: The identifier of the Transaction to retrieve.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/transaction"
          description: Transaction
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve a Transaction
      x-tag: Transactions
  /wire_drawdown_requests:
    get:
      operationId: list_wire_drawdown_requests
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/wire_drawdown_request_list"
          description: Wire Drawdown Request List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List Wire Drawdown Requests
      x-tag: Wire Drawdown Requests
    post:
      operationId: create_a_wire_drawdown_request
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/create_a_wire_drawdown_request_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/wire_drawdown_request"
          description: Wire Drawdown Request
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Create a Wire Drawdown Request
      x-tag: Wire Drawdown Requests
  "/wire_drawdown_requests/{wire_drawdown_request_id}":
    get:
      operationId: retrieve_a_wire_drawdown_request
      parameters:
        - example: wire_drawdown_request_q6lmocus3glo0lr2bfv3
          in: path
          name: wire_drawdown_request_id
          required: true
          schema:
            description: The identifier of the Wire Drawdown Request to retrieve.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/wire_drawdown_request"
          description: Wire Drawdown Request
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve a Wire Drawdown Request
      x-tag: Wire Drawdown Requests
  /wire_transfers:
    get:
      operationId: list_wire_transfers
      parameters:
        - in: query
          name: cursor
          required: false
          schema:
            description: Return the page of entries after this one.
            type: string
        - in: query
          name: limit
          required: false
          schema:
            description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
            minimum: 0
            type: integer
        - example: account_in71c4amph0vgo2qllky
          in: query
          name: account_id
          required: false
          schema:
            description: Filter Wire Transfers to those belonging to the specified Account.
            type: string
        - in: query
          name: external_account_id
          required: false
          schema:
            description: Filter Wire Transfers to those made to the specified External Account.
            type: string
        - in: query
          name: created_at.after
          required: false
          schema:
            description: Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.before
          required: false
          schema:
            description: Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_after
          required: false
          schema:
            description: Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
        - in: query
          name: created_at.on_or_before
          required: false
          schema:
            description: Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
            format: date-time
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/wire_transfer_list"
          description: Wire Transfer List
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: List Wire Transfers
      x-tag: Wire Transfers
    post:
      operationId: create_a_wire_transfer
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/create_a_wire_transfer_parameters"
        required: true
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/wire_transfer"
          description: Wire Transfer
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Create a Wire Transfer
      x-tag: Wire Transfers
  "/wire_transfers/{wire_transfer_id}":
    get:
      operationId: retrieve_a_wire_transfer
      parameters:
        - example: wire_transfer_5akynk7dqsq25qwk9q2u
          in: path
          name: wire_transfer_id
          required: true
          schema:
            description: The identifier of the Wire Transfer.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/wire_transfer"
          description: Wire Transfer
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Retrieve a Wire Transfer
      x-tag: Wire Transfers
  "/wire_transfers/{wire_transfer_id}/approve":
    post:
      operationId: approve_a_wire_transfer
      parameters:
        - example: wire_transfer_5akynk7dqsq25qwk9q2u
          in: path
          name: wire_transfer_id
          required: true
          schema:
            description: The identifier of the Wire Transfer to approve.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/wire_transfer"
          description: Wire Transfer
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Approve a Wire Transfer
      x-tag: Wire Transfers
  "/wire_transfers/{wire_transfer_id}/cancel":
    post:
      operationId: cancel_a_pending_wire_transfer
      parameters:
        - example: wire_transfer_5akynk7dqsq25qwk9q2u
          in: path
          name: wire_transfer_id
          required: true
          schema:
            description: The identifier of the pending Wire Transfer to cancel.
            type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/wire_transfer"
          description: Wire Transfer
        default:
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/error"
          description: Error
      summary: Cancel a pending Wire Transfer
      x-tag: Wire Transfers
components:
  schemas:
    account:
      description: Accounts are your bank accounts with Increase. They store money, receive transfers, and send payments. They earn interest and have depository insurance.
      example:
        balances:
          available_balance: 100
          current_balance: 100
        bank: first_internet_bank
        created_at: 2020-01-31T23:59:59Z
        currency: USD
        entity_id: entity_n8y8tnk2p9339ti393yi
        id: account_in71c4amph0vgo2qllky
        informational_entity_id: null
        interest_accrued: "0.01"
        interest_accrued_at: 2020-01-31
        name: My first account!
        replacement:
          replaced_account_id: null
          replaced_by_account_id: null
        status: open
        type: account
      properties:
        created_at:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account was created.
          format: date-time
          type: string
        currency:
          description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Account currency.
          enum:
            - CAD
            - CHF
            - EUR
            - GBP
            - JPY
            - USD
          type: string
          x-enum-descriptions:
            - Canadian Dollar (CAD)
            - Swiss Franc (CHF)
            - Euro (EUR)
            - British Pound (GBP)
            - Japanese Yen (JPY)
            - US Dollar (USD)
        entity_id:
          description: The identifier for the Entity the Account belongs to.
          nullable: true
          type: string
        id:
          description: The Account identifier.
          type: string
        informational_entity_id:
          description: The identifier of an Entity that, while not owning the Account, is associated with its activity.
          nullable: true
          type: string
        interest_accrued:
          description: The interest accrued but not yet paid, expressed as a string containing a floating-point value.
          type: string
        interest_accrued_at:
          description: The latest [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which interest was accrued.
          format: date
          nullable: true
          type: string
        name:
          description: The name you choose for the Account.
          type: string
        status:
          description: The status of the Account.
          enum:
            - open
            - closed
          type: string
          x-enum-descriptions:
            - Open Accounts that are ready to use.
            - Closed Accounts on which no new activity can occur.
        type:
          description: A constant representing the object's type. For this resource it will always be `account`.
          enum:
            - account
          type: string
      required:
        - created_at
        - currency
        - entity_id
        - informational_entity_id
        - id
        - interest_accrued
        - interest_accrued_at
        - name
        - status
        - type
      title: Account
      type: object
      x-tag: Accounts
      x-title-plural: Accounts
    account_list:
      description: A list of Account objects
      example:
        data:
          - balances:
              available_balance: 100
              current_balance: 100
            bank: first_internet_bank
            created_at: 2020-01-31T23:59:59Z
            currency: USD
            entity_id: entity_n8y8tnk2p9339ti393yi
            id: account_in71c4amph0vgo2qllky
            informational_entity_id: null
            interest_accrued: "0.01"
            interest_accrued_at: 2020-01-31
            name: My first account!
            replacement:
              replaced_account_id: null
              replaced_by_account_id: null
            status: open
            type: account
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/account"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: Account List
      type: object
      x-title-plural: Account Lists
    account_number:
      description: Each account can have multiple account and routing numbers. We recommend that you use a set per vendor. This is similar to how you use different passwords for different websites. Account numbers can also be used to seamlessly reconcile inbound payments. Generating a unique account number per vendor ensures you always know the originator of an incoming payment.
      example:
        account_id: account_in71c4amph0vgo2qllky
        account_number: "987654321"
        created_at: 2020-01-31T23:59:59Z
        id: account_number_v18nkfqm6afpsrvy82b2
        name: ACH
        replacement:
          replaced_account_number_id: null
          replaced_by_account_number_id: null
        routing_number: "101050001"
        status: active
        type: account_number
      properties:
        account_id:
          description: The identifier for the account this Account Number belongs to.
          type: string
        account_number:
          description: The account number.
          type: string
        created_at:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account Number was created.
          format: date-time
          type: string
        id:
          description: The Account Number identifier.
          type: string
        name:
          description: The name you choose for the Account Number.
          type: string
        routing_number:
          description: The American Bankers' Association (ABA) Routing Transit Number (RTN).
          type: string
        status:
          description: This indicates if payments can be made to the Account Number.
          enum:
            - active
            - disabled
            - canceled
          type: string
          x-enum-descriptions:
            - The account number is active.
            - The account number is temporarily disabled.
            - The account number is permanently disabled.
        type:
          description: A constant representing the object's type. For this resource it will always be `account_number`.
          enum:
            - account_number
          type: string
      required:
        - account_id
        - account_number
        - id
        - created_at
        - name
        - routing_number
        - status
        - type
      title: Account Number
      type: object
      x-tag: Account Numbers
      x-title-plural: Account Numbers
    account_number_list:
      description: A list of Account Number objects
      example:
        data:
          - account_id: account_in71c4amph0vgo2qllky
            account_number: "987654321"
            created_at: 2020-01-31T23:59:59Z
            id: account_number_v18nkfqm6afpsrvy82b2
            name: ACH
            replacement:
              replaced_account_number_id: null
              replaced_by_account_number_id: null
            routing_number: "101050001"
            status: active
            type: account_number
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/account_number"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: Account Number List
      type: object
      x-title-plural: Account Number Lists
    account_statement:
      description: Account Statements are generated monthly for every active Account. You can access the statement's data via the API or retrieve a PDF with its details via its associated File.
      example:
        account_id: account_in71c4amph0vgo2qllky
        created_at: 2020-01-31T23:59:59Z
        ending_balance: 100
        file_id: file_makxrc67oh9l6sg7w9yc
        id: account_statement_lkc03a4skm2k7f38vj15
        starting_balance: 0
        statement_period_end: 2020-01-31T23:59:59Z
        statement_period_start: 2020-01-31T23:59:59Z
        type: account_statement
      properties:
        account_id:
          description: The identifier for the Account this Account Statement belongs to.
          type: string
        created_at:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account Statement was created.
          format: date-time
          type: string
        ending_balance:
          description: The Account's balance at the start of its statement period.
          type: integer
        file_id:
          description: The identifier of the File containing a PDF of the statement.
          type: string
        id:
          description: The Account Statement identifier.
          type: string
        starting_balance:
          description: The Account's balance at the start of its statement period.
          type: integer
        statement_period_end:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the end of the period the Account Statement covers.
          format: date-time
          type: string
        statement_period_start:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the start of the period the Account Statement covers.
          format: date-time
          type: string
        type:
          description: A constant representing the object's type. For this resource it will always be `account_statement`.
          enum:
            - account_statement
          type: string
      required:
        - id
        - account_id
        - created_at
        - file_id
        - statement_period_start
        - statement_period_end
        - starting_balance
        - ending_balance
        - type
      title: Account Statement
      type: object
      x-tag: Account Statements
      x-title-plural: Account Statements
    account_statement_list:
      description: A list of Account Statement objects
      example:
        data:
          - account_id: account_in71c4amph0vgo2qllky
            created_at: 2020-01-31T23:59:59Z
            ending_balance: 100
            file_id: file_makxrc67oh9l6sg7w9yc
            id: account_statement_lkc03a4skm2k7f38vj15
            starting_balance: 0
            statement_period_end: 2020-01-31T23:59:59Z
            statement_period_start: 2020-01-31T23:59:59Z
            type: account_statement
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/account_statement"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: Account Statement List
      type: object
      x-title-plural: Account Statement Lists
    account_transfer:
      description: Account transfers move funds between your own accounts at Increase.
      example:
        account_id: account_in71c4amph0vgo2qllky
        amount: 100
        approval:
          approved_at: 2020-01-31T23:59:59Z
          approved_by: null
        cancellation: null
        created_at: 2020-01-31T23:59:59Z
        currency: USD
        description: Move money into savings
        destination_account_id: account_uf16sut2ct5bevmq3eh
        destination_transaction_id: transaction_j3itv8dtk5o8pw3p1xj4
        id: account_transfer_7k9qe1ysdgqztnt63l7n
        network: account
        status: complete
        transaction_id: transaction_uyrp7fld2ium70oa7oi
        type: account_transfer
      properties:
        account_id:
          description: The Account to which the transfer belongs.
          type: string
        amount:
          description: The transfer amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
          type: integer
        approval:
          description: If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
          example:
            approved_at: 2020-01-31T23:59:59Z
            approved_by: null
          nullable: true
          properties:
            approved_at:
              description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was approved.
              format: date-time
              type: string
            approved_by:
              description: If the Transfer was approved by a user in the dashboard, the email address of that user.
              nullable: true
              type: string
          required:
            - approved_at
            - approved_by
          title: Transfer Approval
          type: object
          x-title-plural: Transfer Approvals
        cancellation:
          description: If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
          example:
            canceled_at: 2020-01-31T23:59:59Z
            canceled_by: null
          nullable: true
          properties:
            canceled_at:
              description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Transfer was canceled.
              format: date-time
              type: string
            canceled_by:
              description: If the Transfer was canceled by a user in the dashboard, the email address of that user.
              nullable: true
              type: string
          required:
            - canceled_at
            - canceled_by
          title: Transfer Cancellation
          type: object
          x-title-plural: Transfer Cancellations
        created_at:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.
          format: date-time
          type: string
        currency:
          description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.
          enum:
            - CAD
            - CHF
            - EUR
            - GBP
            - JPY
            - USD
          type: string
          x-enum-descriptions:
            - Canadian Dollar (CAD)
            - Swiss Franc (CHF)
            - Euro (EUR)
            - British Pound (GBP)
            - Japanese Yen (JPY)
            - US Dollar (USD)
        description:
          description: The description that will show on the transactions.
          type: string
        destination_account_id:
          description: The destination account's identifier.
          type: string
        destination_transaction_id:
          description: The ID for the transaction receiving the transfer.
          nullable: true
          type: string
        id:
          description: The account transfer's identifier.
          type: string
        network:
          description: The transfer's network.
          enum:
            - account
          type: string
        status:
          description: The lifecycle status of the transfer.
          enum:
            - pending_approval
            - canceled
            - complete
          type: string
          x-enum-descriptions:
            - The transfer is pending approval.
            - The transfer has been canceled.
            - The transfer has been completed.
        transaction_id:
          description: The ID for the transaction funding the transfer.
          nullable: true
          type: string
        type:
          description: A constant representing the object's type. For this resource it will always be `account_transfer`.
          enum:
            - account_transfer
          type: string
      required:
        - id
        - amount
        - account_id
        - currency
        - destination_account_id
        - destination_transaction_id
        - created_at
        - description
        - network
        - status
        - transaction_id
        - approval
        - cancellation
        - type
      title: Account Transfer
      type: object
      x-tag: Account Transfers
      x-title-plural: Account Transfers
    account_transfer_list:
      description: A list of Account Transfer objects
      example:
        data:
          - account_id: account_in71c4amph0vgo2qllky
            amount: 100
            approval:
              approved_at: 2020-01-31T23:59:59Z
              approved_by: null
            cancellation: null
            created_at: 2020-01-31T23:59:59Z
            currency: USD
            description: Move money into savings
            destination_account_id: account_uf16sut2ct5bevmq3eh
            destination_transaction_id: transaction_j3itv8dtk5o8pw3p1xj4
            id: account_transfer_7k9qe1ysdgqztnt63l7n
            network: account
            status: complete
            transaction_id: transaction_uyrp7fld2ium70oa7oi
            type: account_transfer
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/account_transfer"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: Account Transfer List
      type: object
      x-title-plural: Account Transfer Lists
    ach_prenotification:
      description: ACH Prenotifications are one way you can verify account and routing numbers by Automated Clearing House (ACH).
      example:
        account_number: "987654321"
        addendum: null
        company_descriptive_date: null
        company_discretionary_data: null
        company_entry_description: null
        company_name: null
        created_at: 2020-01-31T23:59:59Z
        credit_debit_indicator: null
        effective_date: null
        id: ach_prenotification_ubjf9qqsxl3obbcn1u34
        prenotification_return: null
        routing_number: "101050001"
        status: submitted
        type: ach_prenotification
      properties:
        account_number:
          description: The destination account number.
          type: string
        addendum:
          description: Additional information for the recipient.
          nullable: true
          type: string
        company_descriptive_date:
          description: The description of the date of the notification.
          nullable: true
          type: string
        company_discretionary_data:
          description: Optional data associated with the notification.
          nullable: true
          type: string
        company_entry_description:
          description: The description of the notification.
          nullable: true
          type: string
        company_name:
          description: The name by which you know the company.
          nullable: true
          type: string
        created_at:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the prenotification was created.
          format: date-time
          type: string
        credit_debit_indicator:
          description: If the notification is for a future credit or debit.
          enum:
            - credit
            - debit
          nullable: true
          type: string
          x-enum-descriptions:
            - The Prenotification is for an anticipated credit.
            - The Prenotification is for an anticipated debit.
        effective_date:
          description: The effective date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
          format: date-time
          nullable: true
          type: string
        id:
          description: The ACH Prenotification's identifier.
          type: string
        prenotification_return:
          description: If your prenotification is returned, this will contain details of the return.
          example:
            created_at: 2020-01-31T23:59:59Z
            return_reason_code: corporate_customer_advised_not_authorized
          nullable: true
          properties:
            created_at:
              description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Prenotification was returned.
              format: date-time
              type: string
            return_reason_code:
              description: Why the Prenotification was returned.
              type: string
          required:
            - created_at
            - return_reason_code
          title: ACH Prenotification Return
          type: object
          x-title-plural: ACH Prenotification Returns
        routing_number:
          description: The American Bankers' Association (ABA) Routing Transit Number (RTN).
          type: string
        status:
          description: The lifecycle status of the ACH Prenotification.
          enum:
            - pending_submitting
            - requires_attention
            - returned
            - submitted
          type: string
          x-enum-descriptions:
            - The Prenotification is pending submission.
            - The Prenotification requires attention.
            - The Prenotification has been returned.
            - The Prentification is complete.
        type:
          description: A constant representing the object's type. For this resource it will always be `ach_prenotification`.
          enum:
            - ach_prenotification
          type: string
      required:
        - id
        - account_number
        - addendum
        - company_descriptive_date
        - company_discretionary_data
        - company_entry_description
        - company_name
        - credit_debit_indicator
        - effective_date
        - routing_number
        - prenotification_return
        - created_at
        - status
        - type
      title: ACH Prenotification
      type: object
      x-tag: ACH Prenotifications
      x-title-plural: ACH Prenotifications
    ach_prenotification_list:
      description: A list of ACH Prenotification objects
      example:
        data:
          - account_number: "987654321"
            addendum: null
            company_descriptive_date: null
            company_discretionary_data: null
            company_entry_description: null
            company_name: null
            created_at: 2020-01-31T23:59:59Z
            credit_debit_indicator: null
            effective_date: null
            id: ach_prenotification_ubjf9qqsxl3obbcn1u34
            prenotification_return: null
            routing_number: "101050001"
            status: submitted
            type: ach_prenotification
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/ach_prenotification"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: ACH Prenotification List
      type: object
      x-title-plural: ACH Prenotification Lists
    ach_transfer:
      description: ACH transfers move funds between your Increase account and any other account accessible by the Automated Clearing House (ACH).
      example:
        account_id: account_in71c4amph0vgo2qllky
        account_number: "987654321"
        addendum: null
        amount: 100
        approval:
          approved_at: 2020-01-31T23:59:59Z
          approved_by: null
        cancellation: null
        company_descriptive_date: null
        company_discretionary_data: null
        company_entry_description: null
        company_name: National Phonograph Company
        created_at: 2020-01-31T23:59:59Z
        currency: USD
        effective_date: null
        external_account_id: external_account_ukk55lr923a3ac0pp7iv
        funding: checking
        id: ach_transfer_uoxatyh3lt5evrsdvo7q
        individual_id: null
        individual_name: Ian Crease
        network: ach
        notifications_of_change: []
        return: null
        routing_number: "101050001"
        standard_entry_class_code: corporate_credit_or_debit
        statement_descriptor: Statement descriptor
        status: returned
        submission:
          submitted_at: 2020-01-31T23:59:59Z
          trace_number: "058349238292834"
        transaction_id: transaction_uyrp7fld2ium70oa7oi
        type: ach_transfer
      properties:
        account_id:
          description: The Account to which the transfer belongs.
          type: string
        account_number:
          description: The destination account number.
          type: string
        addendum:
          description: Additional information that will be sent to the recipient.
          nullable: true
          type: string
        amount:
          description: The transfer amount in USD cents. A positive amount indicates a credit transfer pushing funds to the receiving account. A negative amount indicates a debit transfer pulling funds from the receiving account.
          type: integer
        approval:
          description: If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
          example:
            approved_at: 2020-01-31T23:59:59Z
            approved_by: null
          nullable: true
          properties:
            approved_at:
              description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was approved.
              format: date-time
              type: string
            approved_by:
              description: If the Transfer was approved by a user in the dashboard, the email address of that user.
              nullable: true
              type: string
          required:
            - approved_at
            - approved_by
          title: Transfer Approval
          type: object
          x-title-plural: Transfer Approvals
        cancellation:
          description: If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
          example:
            canceled_at: 2020-01-31T23:59:59Z
            canceled_by: null
          nullable: true
          properties:
            canceled_at:
              description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Transfer was canceled.
              format: date-time
              type: string
            canceled_by:
              description: If the Transfer was canceled by a user in the dashboard, the email address of that user.
              nullable: true
              type: string
          required:
            - canceled_at
            - canceled_by
          title: Transfer Cancellation
          type: object
          x-title-plural: Transfer Cancellations
        company_descriptive_date:
          description: The description of the date of the transfer.
          nullable: true
          type: string
        company_discretionary_data:
          description: The data you chose to associate with the transfer.
          nullable: true
          type: string
        company_entry_description:
          description: The description of the transfer you set to be shown to the recipient.
          nullable: true
          type: string
        company_name:
          description: The name by which the recipient knows you.
          nullable: true
          type: string
        created_at:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.
          format: date-time
          type: string
        currency:
          description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's currency. For ACH transfers this is always equal to `usd`.
          enum:
            - CAD
            - CHF
            - EUR
            - GBP
            - JPY
            - USD
          type: string
          x-enum-descriptions:
            - Canadian Dollar (CAD)
            - Swiss Franc (CHF)
            - Euro (EUR)
            - British Pound (GBP)
            - Japanese Yen (JPY)
            - US Dollar (USD)
        effective_date:
          description: The transfer effective date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
          format: date
          nullable: true
          type: string
        external_account_id:
          description: The identifier of the External Account the transfer was made to, if any.
          nullable: true
          type: string
        funding:
          description: The type of the account to which the transfer will be sent.
          enum:
            - checking
            - savings
          type: string
          x-enum-descriptions:
            - A checking account.
            - A savings account.
        id:
          description: The ACH transfer's identifier.
          type: string
        individual_id:
          description: Your identifer for the transfer recipient.
          nullable: true
          type: string
        individual_name:
          description: The name of the transfer recipient. This value is information and not verified by the recipient's bank.
          nullable: true
          type: string
        network:
          description: The transfer's network.
          enum:
            - ach
          type: string
        notifications_of_change:
          description: If the receiving bank accepts the transfer but notifies that future transfers should use different details, this will contain those details.
          items:
            example:
              change_code: incorrect_transaction_code
              corrected_data: "32"
              created_at: 2020-01-31T23:59:59Z
            properties:
              change_code:
                description: The type of change that occurred.
                type: string
              corrected_data:
                description: The corrected data.
                type: string
              created_at:
                description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the notification occurred.
                format: date-time
                type: string
            required:
              - created_at
              - change_code
              - corrected_data
            title: ACH Notification of Change
            type: object
            x-title-plural: ACH Notification of Changes
          type: array
        return:
          description: If your transfer is returned, this will contain details of the return.
          example:
            created_at: 2020-01-31T23:59:59Z
            return_reason_code: insufficient_fund
            transaction_id: transaction_uyrp7fld2ium70oa7oi
            transfer_id: ach_transfer_uoxatyh3lt5evrsdvo7q
          nullable: true
          properties:
            created_at:
              description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.
              format: date-time
              type: string
            return_reason_code:
              description: Why the ACH Transfer was returned.
              enum:
                - insufficient_fund
                - no_account
                - account_closed
                - invalid_account_number_structure
                - account_frozen_entry_returned_per_ofac_instruction
                - credit_entry_refused_by_receiver
                - unauthorized_debit_to_consumer_account_using_corporate_sec_code
                - corporate_customer_advised_not_authorized
                - payment_stopped
                - non_transaction_account
                - uncollected_funds
                - routing_number_check_digit_error
                - customer_advised_unauthorized_improper_ineligible_or_incomplete
                - amount_field_error
                - authorization_revoked_by_customer
                - invalid_ach_routing_number
                - file_record_edit_criteria
                - enr_invalid_individual_name
                - returned_per_odfi_request
                - addenda_error
                - limited_participation_dfi
                - incorrectly_coded_outbound_international_payment
                - other
              type: string
              x-enum-descriptions:
                - Insufficient funds in the source account.
                - The account does not exist or the receiving bank was unable to locate it.
                - The account is closed.
                - The account number is invalid at the receiving bank.
                - The account was frozen per the Office of Foreign Assets Control.
                - The receiving bank account refused a credit transfer.
                - The receiving bank rejected because of an incorrect Standard Entry Class code.
                - The corporate customer reversed the transfer.
                - The receiving bank stopped payment on this transfer.
                - The receiving bank account does not perform transfers.
                - The receiving bank account does not have enough available balance for the transfer.
                - The routing number is incorrect.
                - The customer reversed the transfer.
                - The amount field is incorrect or too large.
                - The customer who initiated the transfer revoked authorization.
                - The routing number is invalid.
                - The receiving bank is unable to process a field in the transfer.
                - The individual name field was invalid.
                - The originating financial institution reversed the transfer.
                - The addenda record is incorrect or missing.
                - The receiving bank's regulatory supervisor has limited their participation.
                - The outbound international ACH transfer was incorrect.
                - Any other ACH return reason.
            transaction_id:
              description: The identifier of the Tranasaction associated with this return.
              type: string
            transfer_id:
              description: The identifier of the ACH Transfer associated with this return.
              type: string
          required:
            - created_at
            - return_reason_code
            - transfer_id
            - transaction_id
          title: ACH Transfer Return
          type: object
          x-title-plural: ACH Transfer Returns
        routing_number:
          description: The American Bankers' Association (ABA) Routing Transit Number (RTN).
          type: string
        standard_entry_class_code:
          description: The Standard Entry Class (SEC) code to use for the transfer.
          enum:
            - corporate_credit_or_debit
            - prearranged_payments_and_deposit
            - internet_initiated
          type: string
          x-enum-descriptions:
            - Corporate Credit and Debit (CCD).
            - Prearranged Payments and Deposits (PPD).
            - Internet Initiated (WEB).
        statement_descriptor:
          description: The descriptor that will show on the recipient's bank statement.
          type: string
        status:
          description: The lifecycle status of the transfer.
          enum:
            - pending_approval
            - canceled
            - pending_reviewing
            - pending_submission
            - submitted
            - returned
            - requires_attention
            - rejected
          type: string
          x-enum-descriptions:
            - The transfer is pending approval.
            - The transfer has been canceled.
            - The transfer is pending review by Increase.
            - The transfer is pending submission to the Federal Reserve.
            - The transfer is complete.
            - The transfer has been returned.
            - The transfer requires your attention.
            - The transfer has been rejected.
        submission:
          description: After the transfer is submitted to FedACH, this will contain supplemental details.
          example:
            submitted_at: 2020-01-31T23:59:59Z
            trace_number: "058349238292834"
          nullable: true
          properties:
            submitted_at:
              description: When the ACH transfer was sent to FedACH.
              format: date-time
              type: string
            trace_number:
              description: The trace number for the submission.
              type: string
          required:
            - trace_number
            - submitted_at
          title: ACH Transfer Submission
          type: object
          x-title-plural: ACH Transfer Submissions
        transaction_id:
          description: The ID for the transaction funding the transfer.
          nullable: true
          type: string
        type:
          description: A constant representing the object's type. For this resource it will always be `ach_transfer`.
          enum:
            - ach_transfer
          type: string
      required:
        - account_id
        - account_number
        - addendum
        - amount
        - currency
        - approval
        - cancellation
        - created_at
        - external_account_id
        - id
        - network
        - notifications_of_change
        - return
        - routing_number
        - statement_descriptor
        - status
        - submission
        - transaction_id
        - company_descriptive_date
        - company_discretionary_data
        - company_entry_description
        - company_name
        - funding
        - individual_id
        - individual_name
        - effective_date
        - standard_entry_class_code
        - type
      title: ACH Transfer
      type: object
      x-tag: ACH Transfers
      x-title-plural: ACH Transfers
    ach_transfer_list:
      description: A list of ACH Transfer objects
      example:
        data:
          - account_id: account_in71c4amph0vgo2qllky
            account_number: "987654321"
            addendum: null
            amount: 100
            approval:
              approved_at: 2020-01-31T23:59:59Z
              approved_by: null
            cancellation: null
            company_descriptive_date: null
            company_discretionary_data: null
            company_entry_description: null
            company_name: National Phonograph Company
            created_at: 2020-01-31T23:59:59Z
            currency: USD
            effective_date: null
            external_account_id: external_account_ukk55lr923a3ac0pp7iv
            funding: checking
            id: ach_transfer_uoxatyh3lt5evrsdvo7q
            individual_id: null
            individual_name: Ian Crease
            network: ach
            notifications_of_change: []
            return: null
            routing_number: "101050001"
            standard_entry_class_code: corporate_credit_or_debit
            statement_descriptor: Statement descriptor
            status: returned
            submission:
              submitted_at: 2020-01-31T23:59:59Z
              trace_number: "058349238292834"
            transaction_id: transaction_uyrp7fld2ium70oa7oi
            type: ach_transfer
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/ach_transfer"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: ACH Transfer List
      type: object
      x-title-plural: ACH Transfer Lists
    action_a_real_time_decision_parameters:
      example:
        card_authorization:
          decision: approve
      properties:
        card_authorization:
          description: If the Real-Time Decision relates to a card authorization attempt, this object contains your response to the authorization.
          properties:
            decision:
              description: Whether the card authorization should be approved or declined.
              enum:
                - approve
                - decline
              type: string
              x-enum-descriptions:
                - Approve the authorization.
                - Decline the authorization.
          required:
            - decision
          type: object
        digital_wallet_authentication:
          description: If the Real-Time Decision relates to a digital wallet authentication attempt, this object contains your response to the authentication.
          properties:
            result:
              description: Whether your application was able to deliver the one-time passcode.
              enum:
                - success
                - failure
              type: string
              x-enum-descriptions:
                - Your application successfully delivered the one-time passcode to the cardholder.
                - Your application failed to deliver the one-time passcode to the cardholder.
          required:
            - result
          type: object
        digital_wallet_token:
          description: If the Real-Time Decision relates to a digital wallet token provisioning attempt, this object contains your response to the attempt.
          properties:
            approval:
              description: If your application approves the provisioning attempt, this contains metadata about the digital wallet token that will be generated.
              properties:
                card_profile_id:
                  description: The identifier of the Card Profile to assign to the Digital Wallet token.
                  type: string
                email:
                  description: An email address that can be used to verify the cardholder via one-time passcode.
                  maxLength: 200
                  minLength: 1
                  type: string
                phone:
                  description: A phone number that can be used to verify the cardholder via one-time passcode over SMS.
                  maxLength: 200
                  minLength: 1
                  type: string
              required:
                - card_profile_id
              type: object
            decline:
              description: If your application declines the provisioning attempt, this contains details about the decline.
              properties:
                reason:
                  description: Why the tokenization attempt was declined. This is for logging purposes only and is not displayed to the end-user.
                  maxLength: 200
                  minLength: 1
                  type: string
              type: object
          type: object
      type: object
    balance_lookup:
      description: Represents a request to lookup the balance of an Account at a given point in time.
      example:
        account_id: account_in71c4amph0vgo2qllky
        available_balance: 100
        current_balance: 100
        type: balance_lookup
      properties:
        account_id:
          description: The identifier for the account for which the balance was queried.
          type: string
        available_balance:
          description: The Account's available balance, representing the current balance less any open Pending Transactions on the Account.
          type: integer
        current_balance:
          description: The Account's current balance, representing the sum of all posted Transactions on the Account.
          type: integer
        type:
          description: A constant representing the object's type. For this resource it will always be `balance_lookup`.
          enum:
            - balance_lookup
          type: string
      required:
        - account_id
        - current_balance
        - available_balance
        - type
      title: Balance Lookup
      type: object
      x-tag: Balance Lookups
      x-title-plural: Balance Lookups
    bookkeeping_account:
      description: Accounts are T-accounts. They can store accounting entries.
      example:
        account_id: null
        compliance_category: customer_balance
        entity_id: entity_n8y8tnk2p9339ti393yi
        id: account_in71c4amph0vgo2qllky
        name: John Doe Balance
        type: bookkeeping_account
      properties:
        account_id:
          description: The API Account associated with this bookkeeping account.
          nullable: true
          type: string
        compliance_category:
          description: The compliance category of the account.
          enum:
            - commingled_cash
            - customer_balance
          nullable: true
          type: string
          x-enum-descriptions:
            - A cash in an commingled Increase Account.
            - A customer balance.
        entity_id:
          description: The Entity associated with this bookkeeping account.
          nullable: true
          type: string
        id:
          description: The account identifier.
          type: string
        name:
          description: The name you choose for the account.
          type: string
        type:
          description: A constant representing the object's type. For this resource it will always be `bookkeeping_account`.
          enum:
            - bookkeeping_account
          type: string
      required:
        - id
        - compliance_category
        - account_id
        - entity_id
        - name
        - type
      title: Bookkeeping Account
      type: object
      x-tag: Bookkeeping Accounts
      x-title-plural: Bookkeeping Accounts
    bookkeeping_account_list:
      description: A list of Bookkeeping Account objects
      example:
        data:
          - account_id: null
            compliance_category: customer_balance
            entity_id: entity_n8y8tnk2p9339ti393yi
            id: account_in71c4amph0vgo2qllky
            name: John Doe Balance
            type: bookkeeping_account
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/bookkeeping_account"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: Bookkeeping Account List
      type: object
      x-title-plural: Bookkeeping Account Lists
    bookkeeping_entry:
      description: Entries are T-account entries recording debits and credits.
      example:
        account_id: account_in71c4amph0vgo2qllky
        amount: 1750
        entry_set_id: entry_set_tqh22twrtpwz9jomqilq
        id: entry_d3gsxji3ne7i7gflpgqr
        type: bookkeeping_entry
      properties:
        account_id:
          description: The identifier for the Account the Entry belongs to.
          type: string
        amount:
          description: The Entry amount in the minor unit of its currency. For dollars, for example, this is cents.
          type: integer
        entry_set_id:
          description: The identifier for the Account the Entry belongs to.
          type: string
        id:
          description: The entry identifier.
          type: string
        type:
          description: A constant representing the object's type. For this resource it will always be `bookkeeping_entry`.
          enum:
            - bookkeeping_entry
          type: string
      required:
        - account_id
        - amount
        - entry_set_id
        - id
        - type
      title: Bookkeeping Entry
      type: object
      x-title-plural: Bookkeeping Entrys
    bookkeeping_entry_list:
      description: A list of Bookkeeping Entry objects
      example:
        data:
          - account_id: account_in71c4amph0vgo2qllky
            amount: 1750
            entry_set_id: entry_set_tqh22twrtpwz9jomqilq
            id: entry_d3gsxji3ne7i7gflpgqr
            type: bookkeeping_entry
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/bookkeeping_entry"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: Bookkeeping Entry List
      type: object
      x-title-plural: Bookkeeping Entry Lists
    bookkeeping_entry_set:
      description: Entry Sets are accounting entries that are transactionally applied.
      example:
        date: 2020-01-31T23:59:59Z
        entries:
          - account_id: account_in71c4amph0vgo2qllky
            amount: 1750
            id: entry_d3gsxji3ne7i7gflpgqr
          - account_id: account_in71c4amph0vgo2qllky
            amount: -1750
            id: entry_d3gsxji3ne7i7gflpgqr
        id: entry_set_tqh22twrtpwz9jomqilq
        transaction_id: null
        type: bookkeeping_entry_set
      properties:
        date:
          description: The timestamp of the entry set.
          format: date-time
          type: string
        entries:
          description: The entries
          items:
            properties:
              account_id:
                description: The bookkeeping account impacted by the entry.
                type: string
              amount:
                description: The amount of the entry in minor units.
                type: integer
              id:
                description: The entry identifier.
                type: string
            required:
              - account_id
              - amount
              - id
            title: Entries Element
            type: object
            x-title-plural: Entries Elements
          type: array
        id:
          description: The entry set identifier.
          type: string
        transaction_id:
          description: The transaction identifier, if any.
          nullable: true
          type: string
        type:
          description: A constant representing the object's type. For this resource it will always be `bookkeeping_entry_set`.
          enum:
            - bookkeeping_entry_set
          type: string
      required:
        - id
        - transaction_id
        - date
        - entries
        - type
      title: Bookkeeping Entry Set
      type: object
      x-title-plural: Bookkeeping Entry Sets
    card:
      description: Cards are commercial credit cards. They'll immediately work for online purchases after you create them. All cards maintain a credit limit of 100% of the Account’s available balance at the time of transaction. Funds are deducted from the Account upon transaction settlement.
      example:
        account_id: account_in71c4amph0vgo2qllky
        billing_address:
          city: New York
          line1: 33 Liberty Street
          line2: null
          postal_code: "10045"
          state: NY
        created_at: 2020-01-31T23:59:59Z
        description: Office Expenses
        digital_wallet:
          card_profile_id: card_profile_cox5y73lob2eqly18piy
          email: user@example.com
          phone: "+15551234567"
        expiration_month: 11
        expiration_year: 2028
        id: card_oubs0hwk5rn6knuecxg2
        last4: "4242"
        replacement:
          replaced_by_card_id: null
          replaced_card_id: null
        status: active
        type: card
      properties:
        account_id:
          description: The identifier for the account this card belongs to.
          type: string
        billing_address:
          description: The Card's billing address.
          example:
            city: New York
            line1: 33 Liberty Street
            line2: null
            postal_code: "10045"
            state: NY
          properties:
            city:
              description: The city of the billing address.
              nullable: true
              type: string
            line1:
              description: The first line of the billing address.
              nullable: true
              type: string
            line2:
              description: The second line of the billing address.
              nullable: true
              type: string
            postal_code:
              description: The postal code of the billing address.
              nullable: true
              type: string
            state:
              description: The US state of the billing address.
              nullable: true
              type: string
          required:
            - line1
            - line2
            - city
            - state
            - postal_code
          title: Billing Address
          type: object
          x-title-plural: Billing Addresss
        created_at:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card was created.
          format: date-time
          type: string
        description:
          description: The card's description for display purposes.
          nullable: true
          type: string
        digital_wallet:
          description: The contact information used in the two-factor steps for digital wallet card creation. At least one field must be present to complete the digital wallet steps.
          nullable: true
          properties:
            card_profile_id:
              description: The card profile assigned to this digital card. Card profiles may also be assigned at the program level.
              nullable: true
              type: string
            email:
              description: An email address that can be used to verify the cardholder via one-time passcode over email.
              nullable: true
              type: string
            phone:
              description: A phone number that can be used to verify the cardholder via one-time passcode over SMS.
              nullable: true
              type: string
          required:
            - email
            - phone
            - card_profile_id
          title: Digital Wallet
          type: object
          x-title-plural: Digital Wallets
        expiration_month:
          description: The month the card expires in M format (e.g., August is 8).
          type: integer
        expiration_year:
          description: The year the card expires in YYYY format (e.g., 2025).
          type: integer
        id:
          description: The card identifier.
          type: string
        last4:
          description: The last 4 digits of the Card's Primary Account Number.
          type: string
        status:
          description: This indicates if payments can be made with the card.
          enum:
            - active
            - disabled
            - canceled
          type: string
          x-enum-descriptions:
            - The card is active.
            - The card is temporarily disabled.
            - The card is temporarily canceled.
        type:
          description: A constant representing the object's type. For this resource it will always be `card`.
          enum:
            - card
          type: string
      required:
        - id
        - account_id
        - created_at
        - description
        - last4
        - expiration_month
        - expiration_year
        - status
        - billing_address
        - digital_wallet
        - type
      title: Card
      type: object
      x-tag: Cards
      x-title-plural: Cards
    card_details:
      description: An object containing the sensitive details (card number, cvc, etc) for a Card.
      example:
        card_id: card_oubs0hwk5rn6knuecxg2
        expiration_month: 7
        expiration_year: 2025
        primary_account_number: "4242424242424242"
        type: card_details
        verification_code: "123"
      properties:
        card_id:
          description: The identifier for the Card for which sensitive details have been returned.
          type: string
        expiration_month:
          description: The month the card expires in M format (e.g., August is 8).
          type: integer
        expiration_year:
          description: The year the card expires in YYYY format (e.g., 2025).
          type: integer
        primary_account_number:
          description: The card number.
          type: string
        type:
          description: A constant representing the object's type. For this resource it will always be `card_details`.
          enum:
            - card_details
          type: string
        verification_code:
          description: The three-digit verification code for the card. It's also known as the Card Verification Code (CVC), the Card Verification Value (CVV), or the Card Identification (CID).
          type: string
      required:
        - card_id
        - primary_account_number
        - expiration_month
        - expiration_year
        - verification_code
        - type
      title: Card Details
      type: object
      x-title-plural: Card Detailss
    card_dispute:
      description: If unauthorized activity occurs on a card, you can create a Card Dispute and we'll return the funds if appropriate.
      example:
        acceptance: null
        created_at: 2020-01-31T23:59:59Z
        disputed_transaction_id: transaction_uyrp7fld2ium70oa7oi
        explanation: Unauthorized recurring purchase
        id: card_dispute_h9sc95nbl1cgltpp7men
        rejection: null
        status: pending_reviewing
        type: card_dispute
      properties:
        acceptance:
          description: If the Card Dispute's status is `accepted`, this will contain details of the successful dispute.
          example:
            accepted_at: 2020-01-31T23:59:59Z
            card_dispute_id: card_dispute_h9sc95nbl1cgltpp7men
            transaction_id: transaction_uyrp7fld2ium70oa7oi
          nullable: true
          properties:
            accepted_at:
              description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was accepted.
              format: date-time
              type: string
            card_dispute_id:
              description: The identifier of the Card Dispute that was accepted.
              type: string
            transaction_id:
              description: The identifier of the Transaction that was created to return the disputed funds to your account.
              type: string
          required:
            - accepted_at
            - card_dispute_id
            - transaction_id
          title: Card Dispute Acceptance
          type: object
          x-title-plural: Card Dispute Acceptances
        created_at:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was created.
          format: date-time
          type: string
        disputed_transaction_id:
          description: The identifier of the Transaction that was disputed.
          type: string
        explanation:
          description: Why you disputed the Transaction in question.
          type: string
        id:
          description: The Card Dispute identifier.
          type: string
        rejection:
          description: If the Card Dispute's status is `rejected`, this will contain details of the unsuccessful dispute.
          example:
            card_dispute_id: card_dispute_h9sc95nbl1cgltpp7men
            explanation: Acquirer provided evidence that the transaction was authorized.
            rejected_at: 2020-01-31T23:59:59Z
          nullable: true
          properties:
            card_dispute_id:
              description: The identifier of the Card Dispute that was rejected.
              type: string
            explanation:
              description: Why the Card Dispute was rejected.
              type: string
            rejected_at:
              description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was rejected.
              format: date-time
              type: string
          required:
            - explanation
            - rejected_at
            - card_dispute_id
          title: Card Dispute Rejection
          type: object
          x-title-plural: Card Dispute Rejections
        status:
          description: The results of the Dispute investigation.
          enum:
            - pending_reviewing
            - accepted
            - rejected
          type: string
          x-enum-descriptions:
            - The Card Dispute is pending review.
            - The Card Dispute has been accepted and your funds have been returned.
            - The Card Dispute has been rejected.
        type:
          description: A constant representing the object's type. For this resource it will always be `card_dispute`.
          enum:
            - card_dispute
          type: string
      required:
        - id
        - explanation
        - status
        - created_at
        - disputed_transaction_id
        - acceptance
        - rejection
        - type
      title: Card Dispute
      type: object
      x-tag: Card Disputes
      x-title-plural: Card Disputes
    card_dispute_list:
      description: A list of Card Dispute objects
      example:
        data:
          - acceptance: null
            created_at: 2020-01-31T23:59:59Z
            disputed_transaction_id: transaction_uyrp7fld2ium70oa7oi
            explanation: Unauthorized recurring purchase
            id: card_dispute_h9sc95nbl1cgltpp7men
            rejection: null
            status: pending_reviewing
            type: card_dispute
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/card_dispute"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: Card Dispute List
      type: object
      x-title-plural: Card Dispute Lists
    card_list:
      description: A list of Card objects
      example:
        data:
          - account_id: account_in71c4amph0vgo2qllky
            billing_address:
              city: New York
              line1: 33 Liberty Street
              line2: null
              postal_code: "10045"
              state: NY
            created_at: 2020-01-31T23:59:59Z
            description: Office Expenses
            digital_wallet:
              card_profile_id: card_profile_cox5y73lob2eqly18piy
              email: user@example.com
              phone: "+15551234567"
            expiration_month: 11
            expiration_year: 2028
            id: card_oubs0hwk5rn6knuecxg2
            last4: "4242"
            replacement:
              replaced_by_card_id: null
              replaced_card_id: null
            status: active
            type: card
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/card"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: Card List
      type: object
      x-title-plural: Card Lists
    card_profile:
      description: This contains artwork and metadata relating to a Card's appearance in digital wallet apps like Apple Pay and Google Pay. For more information, see our guide on [digital card artwork](https://increase.com/documentation/card-art)
      example:
        created_at: 2020-01-31T23:59:59Z
        description: My Card Profile
        digital_wallets:
          app_icon_file_id: file_8zxqkwlh43wo144u8yec
          background_image_file_id: file_1ai913suu1zfn1pdetru
          card_description: MyBank Signature Card
          contact_email: user@example.com
          contact_phone: "+18885551212"
          contact_website: https://example.com
          issuer_name: MyBank
          text_color:
            blue: 59
            green: 43
            red: 26
        id: card_profile_cox5y73lob2eqly18piy
        status: active
        type: card_profile
      properties:
        created_at:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was created.
          format: date-time
          type: string
        description:
          description: A description you can use to identify the Card Profile.
          type: string
        digital_wallets:
          description: How Cards should appear in digital wallets such as Apple Pay. Different wallets will use these values to render card artwork appropriately for their app.
          properties:
            app_icon_file_id:
              description: The identifier of the File containing the card's icon image.
              type: string
            background_image_file_id:
              description: The identifier of the File containing the card's front image.
              type: string
            card_description:
              description: A user-facing description for the card itself.
              type: string
            contact_email:
              description: An email address the user can contact to receive support for their card.
              nullable: true
              type: string
            contact_phone:
              description: A phone number the user can contact to receive support for their card.
              nullable: true
              type: string
            contact_website:
              description: A website the user can visit to view and receive support for their card.
              nullable: true
              type: string
            issuer_name:
              description: A user-facing description for whoever is issuing the card.
              type: string
            text_color:
              description: The Card's text color, specified as an RGB triple.
              properties:
                blue:
                  description: The value of the blue channel in the RGB color.
                  type: integer
                green:
                  description: The value of the green channel in the RGB color.
                  type: integer
                red:
                  description: The value of the red channel in the RGB color.
                  type: integer
              required:
                - red
                - green
                - blue
              title: Text Color
              type: object
              x-title-plural: Text Colors
          required:
            - text_color
            - issuer_name
            - card_description
            - contact_website
            - contact_email
            - contact_phone
            - background_image_file_id
            - app_icon_file_id
          title: Digital Wallets
          type: object
          x-title-plural: Digital Walletss
        id:
          description: The Card Profile identifier.
          type: string
        status:
          description: The status of the Card Profile.
          enum:
            - pending
            - rejected
            - active
            - archived
          type: string
          x-enum-descriptions:
            - The Card Profile is awaiting review from Increase and/or processing by card networks.
            - There is an issue with the Card Profile preventing it from use.
            - The Card Profile can be assigned to Cards.
            - The Card Profile is no longer in use.
        type:
          description: A constant representing the object's type. For this resource it will always be `card_profile`.
          enum:
            - card_profile
          type: string
      required:
        - id
        - created_at
        - status
        - description
        - digital_wallets
        - type
      title: Card Profile
      type: object
      x-tag: Card Profiles
      x-title-plural: Card Profiles
    card_profile_list:
      description: A list of Card Profile objects
      example:
        data:
          - created_at: 2020-01-31T23:59:59Z
            description: My Card Profile
            digital_wallets:
              app_icon_file_id: file_8zxqkwlh43wo144u8yec
              background_image_file_id: file_1ai913suu1zfn1pdetru
              card_description: MyBank Signature Card
              contact_email: user@example.com
              contact_phone: "+18885551212"
              contact_website: https://example.com
              issuer_name: MyBank
              text_color:
                blue: 59
                green: 43
                red: 26
            id: card_profile_cox5y73lob2eqly18piy
            status: active
            type: card_profile
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/card_profile"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: Card Profile List
      type: object
      x-title-plural: Card Profile Lists
    check_deposit:
      description: Check Deposits allow you to deposit images of paper checks into your account.
      example:
        account_id: account_in71c4amph0vgo2qllky
        amount: 1000
        back_image_file_id: null
        created_at: 2020-01-31T23:59:59Z
        currency: USD
        deposit_acceptance: null
        deposit_rejection: null
        deposit_return: null
        front_image_file_id: file_makxrc67oh9l6sg7w9yc
        id: check_deposit_f06n9gpg7sxn8t19lfc1
        status: submitted
        transaction_id: transaction_uyrp7fld2ium70oa7oi
        type: check_deposit
      properties:
        account_id:
          description: The Account the check was deposited into.
          type: string
        amount:
          description: The deposited amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
          type: integer
        back_image_file_id:
          description: The ID for the File containing the image of the back of the check.
          nullable: true
          type: string
        created_at:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.
          format: date-time
          type: string
        currency:
          description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the deposit.
          enum:
            - CAD
            - CHF
            - EUR
            - GBP
            - JPY
            - USD
          type: string
          x-enum-descriptions:
            - Canadian Dollar (CAD)
            - Swiss Franc (CHF)
            - Euro (EUR)
            - British Pound (GBP)
            - Japanese Yen (JPY)
            - US Dollar (USD)
        deposit_acceptance:
          description: If your deposit is successfully parsed and accepted by Increase, this will contain details of the parsed check.
          example:
            account_number: "987654321"
            amount: 100
            auxiliary_on_us: "101"
            check_deposit_id: check_deposit_f06n9gpg7sxn8t19lfc1
            currency: USD
            routing_number: "101050001"
            serial_number: null
          nullable: true
          properties:
            account_number:
              description: The account number printed on the check.
              type: string
            amount:
              description: The amount to be deposited in the minor unit of the transaction's currency. For dollars, for example, this is cents.
              type: integer
            auxiliary_on_us:
              description: An additional line of metadata printed on the check. This typically includes the check number for business checks.
              nullable: true
              type: string
            check_deposit_id:
              description: The ID of the Check Deposit that was accepted.
              type: string
            currency:
              description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
              enum:
                - CAD
                - CHF
                - EUR
                - GBP
                - JPY
                - USD
              type: string
              x-enum-descriptions:
                - Canadian Dollar (CAD)
                - Swiss Franc (CHF)
                - Euro (EUR)
                - British Pound (GBP)
                - Japanese Yen (JPY)
                - US Dollar (USD)
            routing_number:
              description: The routing number printed on the check.
              type: string
            serial_number:
              description: The check serial number, if present, for consumer checks. For business checks, the serial number is usually in the `auxiliary_on_us` field.
              nullable: true
              type: string
          required:
            - amount
            - currency
            - account_number
            - routing_number
            - auxiliary_on_us
            - serial_number
            - check_deposit_id
          title: Check Deposit Acceptance
          type: object
          x-title-plural: Check Deposit Acceptances
        deposit_rejection:
          description: If your deposit is rejected by Increase, this will contain details as to why it was rejected.
          example:
            amount: 1750
            currency: USD
            reason: incomplete_image
            rejected_at: 2020-01-31T23:59:59Z
          nullable: true
          properties:
            amount:
              description: The rejected amount in the minor unit of check's currency. For dollars, for example, this is cents.
              type: integer
            currency:
              description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency.
              enum:
                - CAD
                - CHF
                - EUR
                - GBP
                - JPY
                - USD
              type: string
              x-enum-descriptions:
                - Canadian Dollar (CAD)
                - Swiss Franc (CHF)
                - Euro (EUR)
                - British Pound (GBP)
                - Japanese Yen (JPY)
                - US Dollar (USD)
            reason:
              description: Why the check deposit was rejected.
              enum:
                - incomplete_image
                - duplicate
                - poor_image_quality
                - incorrect_amount
                - incorrect_recipient
                - not_eligible_for_mobile_deposit
                - unknown
              type: string
              x-enum-descriptions:
                - The check's image is incomplete.
                - This is a duplicate check submission.
                - This check has poor image quality.
                - The check was deposited with the incorrect amount.
                - The check is made out to someone other than the account holder.
                - This check was not eligible for mobile deposit.
                - The check was rejected for an unknown reason.
            rejected_at:
              description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check deposit was rejected.
              format: date-time
              type: string
          required:
            - amount
            - currency
            - reason
            - rejected_at
          title: Check Deposit Rejection
          type: object
          x-title-plural: Check Deposit Rejections
        deposit_return:
          description: If your deposit is returned, this will contain details as to why it was returned.
          example:
            amount: 100
            check_deposit_id: check_deposit_f06n9gpg7sxn8t19lfc1
            currency: USD
            return_reason: insufficient_funds
            returned_at: 2020-01-31T23:59:59Z
            transaction_id: transaction_uyrp7fld2ium70oa7oi
          nullable: true
          properties:
            amount:
              description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
              type: integer
            check_deposit_id:
              description: The identifier of the Check Deposit that was returned.
              type: string
            currency:
              description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
              enum:
                - CAD
                - CHF
                - EUR
                - GBP
                - JPY
                - USD
              type: string
              x-enum-descriptions:
                - Canadian Dollar (CAD)
                - Swiss Franc (CHF)
                - Euro (EUR)
                - British Pound (GBP)
                - Japanese Yen (JPY)
                - US Dollar (USD)
            return_reason:
              description: ""
              enum:
                - ach_conversion_not_supported
                - closed_account
                - duplicate_submission
                - insufficient_funds
                - no_account
                - not_authorized
                - stale_dated
                - stop_payment
                - unknown_reason
                - unmatched_details
                - unreadable_image
              type: string
              x-enum-descriptions:
                - The check doesn't allow ACH conversion.
                - The account is closed.
                - The check has already been deposited.
                - Insufficient funds
                - No account was found matching the check details.
                - The check was not authorized.
                - The check is too old.
                - The payment has been stopped by the account holder.
                - The reason for the return is unknown.
                - The image doesn't match the details submitted.
                - The image could not be read.
            returned_at:
              description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check deposit was returned.
              format: date-time
              type: string
            transaction_id:
              description: The identifier of the transaction that reversed the original check deposit transaction.
              type: string
          required:
            - amount
            - returned_at
            - currency
            - check_deposit_id
            - transaction_id
            - return_reason
          title: Check Deposit Return
          type: object
          x-title-plural: Check Deposit Returns
        front_image_file_id:
          description: The ID for the File containing the image of the front of the check.
          type: string
        id:
          description: The deposit's identifier.
          type: string
        status:
          description: The status of the Check Deposit.
          enum:
            - pending
            - submitted
            - rejected
            - returned
          type: string
          x-enum-descriptions:
            - The Check Deposit is pending review.
            - The Check Deposit has been deposited.
            - The Check Deposit has been rejected.
            - The Check Deposit has been returned.
        transaction_id:
          description: The ID for the Transaction created by the deposit.
          nullable: true
          type: string
        type:
          description: A constant representing the object's type. For this resource it will always be `check_deposit`.
          enum:
            - check_deposit
          type: string
      required:
        - id
        - amount
        - created_at
        - currency
        - status
        - account_id
        - front_image_file_id
        - back_image_file_id
        - transaction_id
        - deposit_acceptance
        - deposit_rejection
        - deposit_return
        - type
      title: Check Deposit
      type: object
      x-tag: Check Deposits
      x-title-plural: Check Deposits
    check_deposit_list:
      description: A list of Check Deposit objects
      example:
        data:
          - account_id: account_in71c4amph0vgo2qllky
            amount: 1000
            back_image_file_id: null
            created_at: 2020-01-31T23:59:59Z
            currency: USD
            deposit_acceptance: null
            deposit_rejection: null
            deposit_return: null
            front_image_file_id: file_makxrc67oh9l6sg7w9yc
            id: check_deposit_f06n9gpg7sxn8t19lfc1
            status: submitted
            transaction_id: transaction_uyrp7fld2ium70oa7oi
            type: check_deposit
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/check_deposit"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: Check Deposit List
      type: object
      x-title-plural: Check Deposit Lists
    check_transfer:
      description: Check Transfers move funds from your Increase account by mailing a physical check.
      example:
        account_id: account_in71c4amph0vgo2qllky
        address_city: New York
        address_line1: 33 Liberty Street
        address_line2: null
        address_state: NY
        address_zip: "10045"
        amount: 1000
        approval: null
        cancellation: null
        created_at: 2020-01-31T23:59:59Z
        currency: USD
        deposit: null
        id: check_transfer_30b43acfu9vw8fyc4f5
        mailed_at: 2020-01-31T23:59:59Z
        message: Invoice 29582
        note: null
        recipient_name: Ian Crease
        return_address: null
        return_details:
          file_id: null
          reason: mail_delivery_failure
          returned_at: 2020-01-31T23:59:59Z
          transaction_id: transaction_uyrp7fld2ium70oa7oi
          transfer_id: check_transfer_30b43acfu9vw8fyc4f5
        status: mailed
        stop_payment_request: null
        submission:
          check_number: "130670"
          submitted_at: 2020-01-31T23:59:59Z
        submitted_at: 2020-01-31T23:59:59Z
        transaction_id: transaction_uyrp7fld2ium70oa7oi
        type: check_transfer
      properties:
        account_id:
          description: The identifier of the Account from which funds will be transferred.
          type: string
        address_city:
          description: The city of the check's destination.
          type: string
        address_line1:
          description: The street address of the check's destination.
          type: string
        address_line2:
          description: The second line of the address of the check's destination.
          nullable: true
          type: string
        address_state:
          description: The state of the check's destination.
          type: string
        address_zip:
          description: The postal code of the check's destination.
          type: string
        amount:
          description: The transfer amount in USD cents.
          type: integer
        approval:
          description: If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
          example:
            approved_at: 2020-01-31T23:59:59Z
            approved_by: null
          nullable: true
          properties:
            approved_at:
              description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was approved.
              format: date-time
              type: string
            approved_by:
              description: If the Transfer was approved by a user in the dashboard, the email address of that user.
              nullable: true
              type: string
          required:
            - approved_at
            - approved_by
          title: Transfer Approval
          type: object
          x-title-plural: Transfer Approvals
        cancellation:
          description: If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
          example:
            canceled_at: 2020-01-31T23:59:59Z
            canceled_by: null
          nullable: true
          properties:
            canceled_at:
              description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Transfer was canceled.
              format: date-time
              type: string
            canceled_by:
              description: If the Transfer was canceled by a user in the dashboard, the email address of that user.
              nullable: true
              type: string
          required:
            - canceled_at
            - canceled_by
          title: Transfer Cancellation
          type: object
          x-title-plural: Transfer Cancellations
        created_at:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.
          format: date-time
          type: string
        currency:
          description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency.
          enum:
            - CAD
            - CHF
            - EUR
            - GBP
            - JPY
            - USD
          type: string
          x-enum-descriptions:
            - Canadian Dollar (CAD)
            - Swiss Franc (CHF)
            - Euro (EUR)
            - British Pound (GBP)
            - Japanese Yen (JPY)
            - US Dollar (USD)
        deposit:
          description: After a check transfer is deposited, this will contain supplemental details.
          example:
            back_image_file_id: file_makxrc67oh9l6sg7w9yc
            deposited_at: 2020-01-31T23:59:59Z
            front_image_file_id: file_makxrc67oh9l6sg7w9yc
            type: check_transfer_deposit
          nullable: true
          properties:
            back_image_file_id:
              description: The ID for the File containing the image of the rear of the check.
              nullable: true
              type: string
            deposited_at:
              description: When the check was deposited.
              format: date-time
              type: string
            front_image_file_id:
              description: The ID for the File containing the image of the front of the check.
              nullable: true
              type: string
            type:
              description: A constant representing the object's type. For this resource it will always be `check_transfer_deposit`.
              enum:
                - check_transfer_deposit
              type: string
          required:
            - deposited_at
            - front_image_file_id
            - back_image_file_id
            - type
          title: Check Transfer Deposit
          type: object
          x-title-plural: Check Transfer Deposits
        id:
          description: The Check transfer's identifier.
          type: string
        mailed_at:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check was mailed.
          format: date-time
          nullable: true
          type: string
        message:
          description: The descriptor that will be printed on the memo field on the check.
          type: string
        note:
          description: The descriptor that will be printed on the letter included with the check.
          nullable: true
          type: string
        recipient_name:
          description: The name that will be printed on the check.
          type: string
        return_address:
          description: The return address to be printed on the check.
          nullable: true
          properties:
            city:
              description: The city of the address.
              nullable: true
              type: string
            line1:
              description: The first line of the address.
              nullable: true
              type: string
            line2:
              description: The second line of the address.
              nullable: true
              type: string
            name:
              description: The name of the address.
              nullable: true
              type: string
            state:
              description: The US state of the address.
              nullable: true
              type: string
            zip:
              description: The postal code of the address.
              nullable: true
              type: string
          required:
            - name
            - line1
            - line2
            - city
            - state
            - zip
          title: Return Address
          type: object
          x-title-plural: Return Addresss
        return_details:
          description: After a check transfer is returned, this will contain supplemental details. A check transfer is returned when the receiver mails a never deposited check back to the bank printed on the check.
          example:
            file_id: null
            reason: mail_delivery_failure
            returned_at: 2020-01-31T23:59:59Z
            transaction_id: transaction_uyrp7fld2ium70oa7oi
            transfer_id: check_transfer_30b43acfu9vw8fyc4f5
          nullable: true
          properties:
            file_id:
              description: If available, a document with additional information about the return.
              nullable: true
              type: string
            reason:
              description: The reason why the check was returned.
              enum:
                - mail_delivery_failure
                - refused_by_recipient
              type: string
              x-enum-descriptions:
                - Mail delivery failed and the check was returned to sender.
                - The check arrived and the recipient refused to deposit it.
            returned_at:
              description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check was returned.
              format: date-time
              type: string
            transaction_id:
              description: The identifier of the Transaction that was created to credit you for the returned check.
              nullable: true
              type: string
            transfer_id:
              description: The identifier of the returned Check Transfer.
              type: string
          required:
            - transfer_id
            - returned_at
            - file_id
            - reason
            - transaction_id
          title: Check Transfer Return
          type: object
          x-title-plural: Check Transfer Returns
        status:
          description: The lifecycle status of the transfer.
          enum:
            - pending_approval
            - pending_submission
            - submitted
            - pending_mailing
            - mailed
            - canceled
            - deposited
            - stopped
            - returned
            - rejected
            - requires_attention
          type: string
          x-enum-descriptions:
            - The transfer is awaiting approval.
            - The transfer is pending submission.
            - The transfer is complete.
            - The check is queued for mailing.
            - The check has been mailed.
            - The transfer has been canceled.
            - The check has been deposited.
            - A stop-payment was requested for this check.
            - The transfer has been returned.
            - The transfer has been rejected.
            - The transfer requires your attention.
        stop_payment_request:
          description: After a stop-payment is requested on the check, this will contain supplemental details.
          example:
            requested_at: 2020-01-31T23:59:59Z
            transaction_id: transaction_uyrp7fld2ium70oa7oi
            transfer_id: check_transfer_30b43acfu9vw8fyc4f5
            type: check_transfer_stop_payment_request
          nullable: true
          properties:
            requested_at:
              description: The time the stop-payment was requested.
              format: date-time
              type: string
            transaction_id:
              description: The transaction ID of the corresponding credit transaction.
              type: string
            transfer_id:
              description: The ID of the check transfer that was stopped.
              type: string
            type:
              description: A constant representing the object's type. For this resource it will always be `check_transfer_stop_payment_request`.
              enum:
                - check_transfer_stop_payment_request
              type: string
          required:
            - transfer_id
            - transaction_id
            - requested_at
            - type
          title: Check Transfer Stop Payment Request
          type: object
          x-title-plural: Check Transfer Stop Payment Requests
        submission:
          description: After the transfer is submitted, this will contain supplemental details.
          example:
            check_number: "130670"
            submitted_at: 2020-01-31T23:59:59Z
          nullable: true
          properties:
            check_number:
              description: The identitying number of the check.
              type: string
            submitted_at:
              description: When this check transfer was submitted to our check printer.
              format: date-time
              type: string
          required:
            - submitted_at
            - check_number
          title: Check Transfer Submission
          type: object
          x-title-plural: Check Transfer Submissions
        submitted_at:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check was submitted.
          format: date-time
          nullable: true
          type: string
        transaction_id:
          description: The ID for the transaction caused by the transfer.
          nullable: true
          type: string
        type:
          description: A constant representing the object's type. For this resource it will always be `check_transfer`.
          enum:
            - check_transfer
          type: string
      required:
        - account_id
        - address_line1
        - address_line2
        - address_city
        - address_state
        - address_zip
        - return_address
        - amount
        - created_at
        - currency
        - approval
        - cancellation
        - id
        - mailed_at
        - message
        - note
        - recipient_name
        - status
        - submitted_at
        - submission
        - transaction_id
        - stop_payment_request
        - deposit
        - return_details
        - type
      title: Check Transfer
      type: object
      x-tag: Check Transfers
      x-title-plural: Check Transfers
    check_transfer_list:
      description: A list of Check Transfer objects
      example:
        data:
          - account_id: account_in71c4amph0vgo2qllky
            address_city: New York
            address_line1: 33 Liberty Street
            address_line2: null
            address_state: NY
            address_zip: "10045"
            amount: 1000
            approval: null
            cancellation: null
            created_at: 2020-01-31T23:59:59Z
            currency: USD
            deposit: null
            id: check_transfer_30b43acfu9vw8fyc4f5
            mailed_at: 2020-01-31T23:59:59Z
            message: Invoice 29582
            note: null
            recipient_name: Ian Crease
            return_address: null
            return_details:
              file_id: null
              reason: mail_delivery_failure
              returned_at: 2020-01-31T23:59:59Z
              transaction_id: transaction_uyrp7fld2ium70oa7oi
              transfer_id: check_transfer_30b43acfu9vw8fyc4f5
            status: mailed
            stop_payment_request: null
            submission:
              check_number: "130670"
              submitted_at: 2020-01-31T23:59:59Z
            submitted_at: 2020-01-31T23:59:59Z
            transaction_id: transaction_uyrp7fld2ium70oa7oi
            type: check_transfer
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/check_transfer"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: Check Transfer List
      type: object
      x-title-plural: Check Transfer Lists
    complete_a_sandbox_real_time_payments_transfer_parameters:
      example: {}
      properties:
        rejection:
          description: If set, the simulation will reject the transfer.
          properties:
            reject_reason_code:
              description: The reason code that the simulated rejection will have.
              enum:
                - account_closed
                - account_blocked
                - invalid_creditor_account_type
                - invalid_creditor_account_number
                - invalid_creditor_financial_institution_identifier
                - end_customer_deceased
                - narrative
                - transaction_forbidden
                - transaction_type_not_supported
                - unexpected_amount
                - amount_exceeds_bank_limits
                - invalid_creditor_address
                - unknown_end_customer
                - invalid_debtor_address
                - timeout
                - unsupported_message_for_recipient
                - recipient_connection_not_available
                - real_time_payments_suspended
                - instructed_agent_signed_off
                - processing_error
                - other
              type: string
              x-enum-descriptions:
                - The destination account is closed. Corresponds to the Real Time Payments reason code `AC04`.
                - The destination account is currently blocked from receiving transactions. Corresponds to the Real Time Payments reason code `AC06`.
                - The destination account is ineligible to receive Real Time Payments transfers. Corresponds to the Real Time Payments reason code `AC14`.
                - The destination account does not exist. Corresponds to the Real Time Payments reason code `AC03`.
                - The destination routing number is invalid. Corresponds to the Real Time Payments reason code `RC04`.
                - The destination account holder is deceased. Corresponds to the Real Time Payments reason code `MD07`.
                - The reason is provided as narrative information in the additional information field.
                - Real Time Payments transfers are not allowed to the destination account. Corresponds to the Real Time Payments reason code `AG01`.
                - Real Time Payments transfers are not enabled for the destination account. Corresponds to the Real Time Payments reason code `AG03`.
                - The amount of the transfer is different than expected by the recipient. Corresponds to the Real Time Payments reason code `AM09`.
                - The amount is higher than the recipient is authorized to send or receive. Corresponds to the Real Time Payments reason code `AM14`.
                - The creditor's address is required, but missing or invalid. Corresponds to the Real Time Payments reason code `BE04`.
                - The specified creditor is unknown. Corresponds to the Real Time Payments reason code `BE06`.
                - The debtor's address is required, but missing or invalid. Corresponds to the Real Time Payments reason code `BE07`.
                - There was a timeout processing the transfer. Corresponds to the Real Time Payments reason code `DS24`.
                - Real Time Payments transfers are not enabled for the destination account. Corresponds to the Real Time Payments reason code `NOAT`.
                - The destination financial institution is currently not connected to Real Time Payments. Corresponds to the Real Time Payments reason code `9912`.
                - Real Time Payments is currently unavailable. Corresponds to the Real Time Payments reason code `9948`.
                - The destination financial institution is currently signed off of Real Time Payments. Corresponds to the Real Time Payments reason code `9910`.
                - The transfer was rejected due to an internal Increase issue. We have been notified.
                - Some other error or issue has occurred.
          required:
            - reject_reason_code
          type: object
      type: object
    create_a_bookkeeping_account_parameters:
      example:
        name: New Account!
      properties:
        account_id:
          description: The entity, if `compliance_category` is `commingled_cash`.
          type: string
        compliance_category:
          description: The account compliance category.
          enum:
            - commingled_cash
            - customer_balance
          type: string
          x-enum-descriptions:
            - A cash in an commingled Increase Account.
            - A customer balance.
        entity_id:
          description: The entity, if `compliance_category` is `customer_balance`.
          type: string
        name:
          description: The name you choose for the account.
          maxLength: 200
          minLength: 1
          type: string
      required:
        - name
      type: object
    create_a_bookkeeping_entry_set_parameters:
      example:
        date: 2020-01-31T23:59:59Z
        entries: []
      properties:
        date:
          description: The date of the transaction. If `transaction_id` is provided, this must match the `created_at` field on that resource.
          format: date-time
          type: string
        entries:
          description: The bookkeeping entries.
          items:
            properties:
              account_id:
                description: The identifier for the Bookkeeping Account impacted by this entry.
                type: string
              amount:
                description: The entry amount in the minor unit of the account currency. For dollars, for example, this is cents. Debit entries have positive amounts; credit entries have negative amounts.
                type: integer
            required:
              - account_id
              - amount
            type: object
          type: array
        transaction_id:
          description: The identifier of the Transaction related to this entry set, if any.
          type: string
      required:
        - entries
      type: object
    create_a_card_dispute_parameters:
      example:
        disputed_transaction_id: transaction_uyrp7fld2ium70oa7oi
        explanation: Unauthorized recurring transaction.
      properties:
        disputed_transaction_id:
          description: The Transaction you wish to dispute. This Transaction must have a `source_type` of `card_settlement`.
          type: string
        explanation:
          description: Why you are disputing this Transaction.
          maxLength: 200
          minLength: 1
          type: string
      required:
        - disputed_transaction_id
        - explanation
      type: object
    create_a_card_parameters:
      example:
        account_id: account_in71c4amph0vgo2qllky
        description: Card for Ian Crease
      properties:
        account_id:
          description: The Account the card should belong to.
          type: string
        billing_address:
          description: The card's billing address.
          properties:
            city:
              description: The city of the billing address.
              maxLength: 200
              minLength: 1
              type: string
            line1:
              description: The first line of the billing address.
              maxLength: 200
              minLength: 1
              type: string
            line2:
              description: The second line of the billing address.
              maxLength: 200
              minLength: 1
              type: string
            postal_code:
              description: The postal code of the billing address.
              maxLength: 200
              minLength: 1
              type: string
            state:
              description: The US state of the billing address.
              maxLength: 200
              minLength: 1
              type: string
          required:
            - line1
            - city
            - state
            - postal_code
          type: object
        description:
          description: The description you choose to give the card.
          maxLength: 200
          minLength: 1
          type: string
        digital_wallet:
          description: The contact information used in the two-factor steps for digital wallet card creation. To add the card to a digital wallet, you may supply an email or phone number with this request. Otherwise, subscribe and then action a Real Time Decision with the category `digital_wallet_token_requested` or `digital_wallet_authentication_requested`.
          properties:
            card_profile_id:
              description: The card profile assigned to this digital card. Card profiles may also be assigned at the program level.
              type: string
            email:
              description: An email address that can be used to verify the cardholder via one-time passcode over email.
              maxLength: 200
              minLength: 1
              type: string
            phone:
              description: A phone number that can be used to verify the cardholder via one-time passcode over SMS.
              maxLength: 200
              minLength: 1
              type: string
          type: object
      required:
        - account_id
      type: object
    create_a_card_profile_parameters:
      example:
        description: My Card Profile
        digital_wallets:
          app_icon_file_id: file_8zxqkwlh43wo144u8yec
          background_image_file_id: file_1ai913suu1zfn1pdetru
          card_description: MyBank Signature Card
          contact_email: user@example.com
          contact_phone: "+18885551212"
          contact_website: https://example.com
          issuer_name: MyBank
          text_color:
            blue: 59
            green: 43
            red: 26
      properties:
        description:
          description: A description you can use to identify the Card Profile.
          maxLength: 200
          minLength: 1
          type: string
        digital_wallets:
          description: How Cards should appear in digital wallets such as Apple Pay. Different wallets will use these values to render card artwork appropriately for their app.
          properties:
            app_icon_file_id:
              description: The identifier of the File containing the card's icon image.
              type: string
            background_image_file_id:
              description: The identifier of the File containing the card's front image.
              type: string
            card_description:
              description: A user-facing description for the card itself.
              maxLength: 32
              minLength: 1
              type: string
            contact_email:
              description: An email address the user can contact to receive support for their card.
              maxLength: 32
              minLength: 1
              type: string
            contact_phone:
              description: A phone number the user can contact to receive support for their card.
              maxLength: 32
              minLength: 1
              type: string
            contact_website:
              description: A website the user can visit to view and receive support for their card.
              type: string
            issuer_name:
              description: A user-facing description for whoever is issuing the card.
              maxLength: 32
              minLength: 1
              type: string
            text_color:
              description: The Card's text color, specified as an RGB triple. The default is white.
              properties:
                blue:
                  description: The value of the blue channel in the RGB color.
                  maximum: 255
                  minimum: 0
                  type: integer
                green:
                  description: The value of the green channel in the RGB color.
                  maximum: 255
                  minimum: 0
                  type: integer
                red:
                  description: The value of the red channel in the RGB color.
                  maximum: 255
                  minimum: 0
                  type: integer
              required:
                - red
                - green
                - blue
              type: object
          required:
            - issuer_name
            - card_description
            - background_image_file_id
            - app_icon_file_id
          type: object
      required:
        - description
        - digital_wallets
      type: object
    create_a_check_deposit_parameters:
      example:
        account_id: account_in71c4amph0vgo2qllky
        amount: 1000
        back_image_file_id: file_26khfk98mzfz90a11oqx
        currency: USD
        front_image_file_id: file_hkv175ovmc2tb2v2zbrm
      properties:
        account_id:
          description: The identifier for the Account to deposit the check in.
          type: string
        amount:
          description: The deposit amount in the minor unit of the account currency. For dollars, for example, this is cents.
          minimum: 0
          type: integer
        back_image_file_id:
          description: The File containing the check's back image.
          type: string
        currency:
          description: The currency to use for the deposit.
          maxLength: 200
          minLength: 1
          type: string
        front_image_file_id:
          description: The File containing the check's front image.
          type: string
      required:
        - account_id
        - amount
        - currency
        - front_image_file_id
        - back_image_file_id
      type: object
    create_a_check_transfer_parameters:
      example:
        account_id: account_in71c4amph0vgo2qllky
        address_city: New York
        address_line1: 33 Liberty Street
        address_state: NY
        address_zip: "10045"
        amount: 1000
        currency: USD
        message: Check payment
        recipient_name: Ian Crease
      properties:
        account_id:
          description: The identifier for the account that will send the transfer.
          type: string
        address_city:
          description: The city of the check's destination.
          maxLength: 250
          minLength: 1
          type: string
        address_line1:
          description: The street address of the check's destination.
          maxLength: 250
          minLength: 1
          type: string
        address_line2:
          description: The second line of the address of the check's destination.
          maxLength: 250
          minLength: 1
          type: string
        address_state:
          description: The state of the check's destination.
          maxLength: 200
          minLength: 1
          type: string
        address_zip:
          description: The postal code of the check's destination.
          maxLength: 250
          minLength: 1
          type: string
        amount:
          description: The transfer amount in cents.
          minimum: 1
          type: integer
        message:
          description: The descriptor that will be printed on the memo field on the check.
          maxLength: 73
          minLength: 1
          type: string
        note:
          description: The descriptor that will be printed on the letter included with the check.
          maxLength: 200
          minLength: 1
          type: string
        recipient_name:
          description: The name that will be printed on the check.
          maxLength: 250
          minLength: 1
          type: string
        require_approval:
          description: Whether the transfer requires explicit approval via the dashboard or API.
          type: boolean
        return_address:
          description: The return address to be printed on the check. If omitted this will default to the address of the Entity of the Account used to make the Check Transfer.
          properties:
            city:
              description: The city of the return address.
              maxLength: 200
              minLength: 1
              type: string
            line1:
              description: The first line of the return address.
              maxLength: 200
              minLength: 1
              type: string
            line2:
              description: The second line of the return address.
              maxLength: 200
              minLength: 1
              type: string
            name:
              description: The name of the return address.
              maxLength: 200
              minLength: 1
              type: string
            state:
              description: The US state of the return address.
              maxLength: 200
              minLength: 1
              type: string
            zip:
              description: The postal code of the return address.
              maxLength: 200
              minLength: 1
              type: string
          required:
            - name
            - line1
            - city
            - state
            - zip
          type: object
      required:
        - account_id
        - address_line1
        - address_city
        - address_state
        - address_zip
        - amount
        - message
        - recipient_name
      type: object
    create_a_file_parameters:
      example:
        file: '"@tax_form.pdf"'
        purpose: check_image_front
      properties:
        description:
          description: The description you choose to give the File.
          maxLength: 200
          minLength: 1
          type: string
        file:
          description: The file contents. This should follow the specifications of [RFC 7578](https://datatracker.ietf.org/doc/html/rfc7578) which defines file transfers for the multipart/form-data protocol.
          format: binary
          type: string
        purpose:
          description: What the File will be used for in Increase's systems.
          enum:
            - check_image_front
            - check_image_back
            - form_ss_4
            - identity_document
            - other
            - trust_formation_document
            - digital_wallet_artwork
            - digital_wallet_app_icon
            - document_request
            - entity_supplemental_document
          type: string
          x-enum-descriptions:
            - An image of the front of a check, used for check deposits.
            - An image of the back of a check, used for check deposits.
            - IRS Form SS-4.
            - An image of a government-issued ID.
            - A file purpose not covered by any of the other cases.
            - A legal document forming a trust.
            - A card image to be rendered inside digital wallet apps. This must be a 1536x969 pixel PNG.
            - An icon for you app to be rendered inside digital wallet apps. This must be a 100x100 pixel PNG.
            - A document requested by Increase.
            - A supplemental document associated an an Entity.
      required:
        - file
        - purpose
      type: object
    create_a_limit_parameters:
      example:
        interval: month
        metric: volume
        model_id: account_in71c4amph0vgo2qllky
        value: 1234
      properties:
        interval:
          description: The interval for the metric. Required if `metric` is `count` or `volume`.
          enum:
            - transaction
            - day
            - week
            - month
            - year
            - all_time
          type: string
          x-enum-descriptions:
            - Enforce the limit per-transaction.
            - Enforce the limit based on the previous 24 hour period.
            - Enforce the limit based on the previous seven days.
            - Enforce the limit based on the previous month, going back to the current day in the previous month, or as close as possible given month length differences.
            - Enforce the limit based on the previous year.
            - Enforce the limit for all time.
        metric:
          description: The metric for the limit.
          enum:
            - count
            - volume
          type: string
          x-enum-descriptions:
            - The maximum number of debits allowed.
            - The maximum volume of debits allowed in the minor unit of the model's currency.
        model_id:
          description: The identifier of the Account or Account Number you wish to associate the limit with.
          maxLength: 200
          minLength: 1
          type: string
        value:
          description: The value to test the limit against.
          minimum: 0
          type: integer
      required:
        - metric
        - model_id
        - value
      type: object
    create_a_real_time_payments_transfer_parameters:
      example:
        amount: 100
        creditor_name: Ian Crease
        destination_account_number: "987654321"
        destination_routing_number: "101050001"
        remittance_information: Invoice 29582
        source_account_number_id: account_number_v18nkfqm6afpsrvy82b2
      properties:
        amount:
          description: The transfer amount in USD cents. For Real Time Payments transfers, must be positive.
          minimum: 1
          type: integer
        creditor_name:
          description: The name of the transfer's recipient.
          maxLength: 140
          minLength: 1
          type: string
        destination_account_number:
          description: The destination account number.
          maxLength: 34
          minLength: 1
          type: string
        destination_routing_number:
          description: The destination American Bankers' Association (ABA) Routing Transit Number (RTN).
          maxLength: 9
          minLength: 9
          type: string
        external_account_id:
          description: The ID of an External Account to initiate a transfer to. If this parameter is provided, `destination_account_number` and `destination_routing_number` must be absent.
          type: string
        remittance_information:
          description: Unstructured information that will show on the recipient's bank statement.
          maxLength: 140
          minLength: 1
          type: string
        require_approval:
          description: Whether the transfer requires explicit approval via the dashboard or API.
          type: boolean
        source_account_number_id:
          description: The identifier of the Account Number from which to send the transfer.
          type: string
      required:
        - source_account_number_id
        - amount
        - creditor_name
        - remittance_information
      type: object
    create_a_supplemental_document_for_an_entity_parameters:
      example:
        file_id: file_makxrc67oh9l6sg7w9yc
      properties:
        file_id:
          description: The identifier of the File containing the document.
          type: string
      required:
        - file_id
      type: object
    create_a_wire_drawdown_request_parameters:
      example:
        account_number_id: account_number_v18nkfqm6afpsrvy82b2
        amount: 10000
        message_to_recipient: Invoice 29582
        recipient_account_number: "987654321"
        recipient_address_line1: 33 Liberty Street
        recipient_address_line2: New York, NY, 10045
        recipient_name: Ian Crease
        recipient_routing_number: "101050001"
      properties:
        account_number_id:
          description: The Account Number to which the recipient should send funds.
          type: string
        amount:
          description: The amount requested from the recipient, in cents.
          minimum: 1
          type: integer
        message_to_recipient:
          description: A message the recipient will see as part of the request.
          maxLength: 140
          minLength: 1
          type: string
        recipient_account_number:
          description: The drawdown request's recipient's account number.
          maxLength: 200
          minLength: 1
          type: string
        recipient_address_line1:
          description: Line 1 of the drawdown request's recipient's address.
          maxLength: 35
          minLength: 1
          type: string
        recipient_address_line2:
          description: Line 2 of the drawdown request's recipient's address.
          maxLength: 35
          minLength: 1
          type: string
        recipient_address_line3:
          description: Line 3 of the drawdown request's recipient's address.
          maxLength: 35
          minLength: 1
          type: string
        recipient_name:
          description: The drawdown request's recipient's name.
          maxLength: 35
          minLength: 1
          type: string
        recipient_routing_number:
          description: The drawdown request's recipient's routing number.
          maxLength: 200
          minLength: 1
          type: string
      required:
        - account_number_id
        - amount
        - message_to_recipient
        - recipient_account_number
        - recipient_routing_number
        - recipient_name
      type: object
    create_a_wire_transfer_parameters:
      example:
        account_id: account_in71c4amph0vgo2qllky
        account_number: "987654321"
        amount: 100
        beneficiary_address_line1: 33 Liberty Street
        beneficiary_address_line2: New York
        beneficiary_address_line3: NY 10045
        beneficiary_name: Ian Crease
        message_to_recipient: New account transfer
        routing_number: "101050001"
      properties:
        account_id:
          description: The identifier for the account that will send the transfer.
          type: string
        account_number:
          description: The account number for the destination account.
          maxLength: 200
          minLength: 1
          type: string
        amount:
          description: The transfer amount in cents.
          minimum: 1
          type: integer
        beneficiary_address_line1:
          description: The beneficiary's address line 1.
          maxLength: 200
          minLength: 1
          type: string
        beneficiary_address_line2:
          description: The beneficiary's address line 2.
          maxLength: 200
          minLength: 1
          type: string
        beneficiary_address_line3:
          description: The beneficiary's address line 3.
          maxLength: 200
          minLength: 1
          type: string
        beneficiary_name:
          description: The beneficiary's name.
          maxLength: 200
          minLength: 1
          type: string
        external_account_id:
          description: The ID of an External Account to initiate a transfer to. If this parameter is provided, `account_number` and `routing_number` must be absent.
          type: string
        message_to_recipient:
          description: The message that will show on the recipient's bank statement.
          maxLength: 200
          minLength: 1
          type: string
        require_approval:
          description: Whether the transfer requires explicit approval via the dashboard or API.
          type: boolean
        routing_number:
          description: The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.
          maxLength: 9
          minLength: 9
          type: string
      required:
        - account_id
        - amount
        - message_to_recipient
        - beneficiary_name
      type: object
    create_an_account_number_parameters:
      example:
        account_id: account_in71c4amph0vgo2qllky
        name: Rent payments
      properties:
        account_id:
          description: The Account the Account Number should belong to.
          type: string
        name:
          description: The name you choose for the Account Number.
          maxLength: 200
          minLength: 1
          type: string
      required:
        - account_id
        - name
      type: object
    create_an_account_parameters:
      example:
        name: New Account!
      properties:
        entity_id:
          description: The identifier for the Entity that will own the Account.
          type: string
        informational_entity_id:
          description: The identifier of an Entity that, while not owning the Account, is associated with its activity. Its relationship to your group must be `informational`.
          type: string
        name:
          description: The name you choose for the Account.
          maxLength: 200
          minLength: 1
          type: string
        program_id:
          description: The identifier for the Program that this Account falls under.
          type: string
      required:
        - name
      type: object
    create_an_account_transfer_parameters:
      example:
        account_id: account_in71c4amph0vgo2qllky
        amount: 100
        description: Creating liquidity
        destination_account_id: account_uf16sut2ct5bevmq3eh
      properties:
        account_id:
          description: The identifier for the account that will send the transfer.
          type: string
        amount:
          description: The transfer amount in the minor unit of the account currency. For dollars, for example, this is cents.
          minimum: 1
          type: integer
        description:
          description: The description you choose to give the transfer.
          maxLength: 200
          minLength: 1
          type: string
        destination_account_id:
          description: The identifier for the account that will receive the transfer.
          type: string
        require_approval:
          description: Whether the transfer requires explicit approval via the dashboard or API.
          type: boolean
      required:
        - account_id
        - amount
        - description
        - destination_account_id
      type: object
    create_an_ach_prenotification_parameters:
      example:
        account_number: "987654321"
        routing_number: "101050001"
      properties:
        account_number:
          description: The account number for the destination account.
          maxLength: 200
          minLength: 1
          type: string
        addendum:
          description: Additional information that will be sent to the recipient.
          maxLength: 80
          minLength: 1
          type: string
        company_descriptive_date:
          description: The description of the date of the transfer.
          maxLength: 6
          minLength: 1
          type: string
        company_discretionary_data:
          description: The data you choose to associate with the transfer.
          maxLength: 20
          minLength: 1
          type: string
        company_entry_description:
          description: The description of the transfer you wish to be shown to the recipient.
          maxLength: 10
          minLength: 1
          type: string
        company_name:
          description: The name by which the recipient knows you.
          maxLength: 16
          minLength: 1
          type: string
        credit_debit_indicator:
          description: Whether the Prenotification is for a future debit or credit.
          enum:
            - credit
            - debit
          type: string
          x-enum-descriptions:
            - The Prenotification is for an anticipated credit.
            - The Prenotification is for an anticipated debit.
        effective_date:
          description: The transfer effective date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
          format: date
          type: string
        individual_id:
          description: Your identifer for the transfer recipient.
          maxLength: 22
          minLength: 1
          type: string
        individual_name:
          description: The name of the transfer recipient. This value is information and not verified by the recipient's bank.
          maxLength: 22
          minLength: 1
          type: string
        routing_number:
          description: The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.
          maxLength: 9
          minLength: 9
          type: string
        standard_entry_class_code:
          description: The Standard Entry Class (SEC) code to use for the ACH Prenotification.
          enum:
            - corporate_credit_or_debit
            - prearranged_payments_and_deposit
            - internet_initiated
          type: string
          x-enum-descriptions:
            - Corporate Credit and Debit (CCD).
            - Prearranged Payments and Deposits (PPD).
            - Internet Initiated (WEB).
      required:
        - account_number
        - routing_number
      type: object
    create_an_ach_return_parameters:
      example:
        reason: payment_stopped
        transaction_id: transaction_uyrp7fld2ium70oa7oi
      properties:
        reason:
          description: The reason why this transfer will be returned. The most usual return codes are `payment_stopped` for debits and `credit_entry_refused_by_receiver` for credits.
          enum:
            - authorization_revoked_by_customer
            - payment_stopped
            - customer_advised_unauthorized_improper_ineligible_or_incomplete
            - representative_payee_deceased_or_unable_to_continue_in_that_capacity
            - beneficiary_or_account_holder_deceased
            - credit_entry_refused_by_receiver
            - duplicate_entry
            - corporate_customer_advised_not_authorized
          type: string
          x-enum-descriptions:
            - The customer no longer authorizes this transaction. The Nacha return code is R07.
            - The customer asked for the payment to be stopped. This reason is only allowed for debits. The Nacha return code is R08.
            - The customer advises that the debit was unauthorized. The Nacha return code is R10.
            - The payee is deceased. The Nacha return code is R14.
            - The account holder is deceased. The Nacha return code is R15.
            - The customer refused a credit entry. This reason is only allowed for credits. The Nacha return code is R23.
            - The account holder identified this transaction as a duplicate. The Nacha return code is R24.
            - The corporate customer no longer authorizes this transaction. The Nacha return code is R29.
        transaction_id:
          description: The transaction identifier of the Inbound ACH Transfer to return to the originating financial institution.
          type: string
      required:
        - transaction_id
        - reason
      type: object
    create_an_ach_transfer_parameters:
      example:
        account_id: account_in71c4amph0vgo2qllky
        account_number: "987654321"
        amount: 100
        routing_number: "101050001"
        statement_descriptor: New ACH transfer
      properties:
        account_id:
          description: The Increase identifier for the account that will send the transfer.
          type: string
        account_number:
          description: The account number for the destination account.
          maxLength: 17
          minLength: 1
          type: string
        addendum:
          description: Additional information that will be sent to the recipient. This is included in the transfer data sent to the receiving bank.
          maxLength: 80
          minLength: 1
          type: string
        amount:
          description: The transfer amount in cents. A positive amount originates a credit transfer pushing funds to the receiving account. A negative amount originates a debit transfer pulling funds from the receiving account.
          type: integer
        company_descriptive_date:
          description: The description of the date of the transfer, usually in the format `YYMMDD`. This is included in the transfer data sent to the receiving bank.
          maxLength: 6
          minLength: 1
          type: string
        company_discretionary_data:
          description: The data you choose to associate with the transfer. This is included in the transfer data sent to the receiving bank.
          maxLength: 20
          minLength: 1
          type: string
        company_entry_description:
          description: A description of the transfer. This is included in the transfer data sent to the receiving bank.
          maxLength: 10
          minLength: 1
          type: string
        company_name:
          description: The name by which the recipient knows you. This is included in the transfer data sent to the receiving bank.
          maxLength: 16
          minLength: 1
          type: string
        effective_date:
          description: The transfer effective date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
          format: date
          type: string
        external_account_id:
          description: The ID of an External Account to initiate a transfer to. If this parameter is provided, `account_number`, `routing_number`, and `funding` must be absent.
          type: string
        funding:
          description: The type of the account to which the transfer will be sent.
          enum:
            - checking
            - savings
          type: string
          x-enum-descriptions:
            - A checking account.
            - A savings account.
        individual_id:
          description: Your identifer for the transfer recipient.
          maxLength: 15
          minLength: 1
          type: string
        individual_name:
          description: The name of the transfer recipient. This value is informational and not verified by the recipient's bank.
          maxLength: 22
          minLength: 1
          type: string
        require_approval:
          description: Whether the transfer requires explicit approval via the dashboard or API.
          type: boolean
        routing_number:
          description: The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.
          maxLength: 9
          minLength: 9
          type: string
        standard_entry_class_code:
          description: The Standard Entry Class (SEC) code to use for the transfer.
          enum:
            - corporate_credit_or_debit
            - prearranged_payments_and_deposit
            - internet_initiated
          type: string
          x-enum-descriptions:
            - Corporate Credit and Debit (CCD).
            - Prearranged Payments and Deposits (PPD).
            - Internet Initiated (WEB).
        statement_descriptor:
          description: A description you choose to give the transfer. This will be saved with the transfer details, displayed in the dashboard, and returned by the API. If `individual_name` and `company_name` are not explicitly set by this API, the `statement_descriptor` will be sent in those fields to the receiving bank to help the customer recognize the transfer. You are highly encouraged to pass `individual_name` and `company_name` instead of relying on this fallback.
          maxLength: 200
          minLength: 1
          type: string
      required:
        - account_id
        - amount
        - statement_descriptor
      type: object
    create_an_entity_parameters:
      example:
        corporation:
          address:
            city: New York
            line1: 33 Liberty Street
            state: NY
            zip: "10045"
          beneficial_owners:
            - company_title: CEO
              individual:
                address:
                  city: New York
                  line1: 33 Liberty Street
                  state: NY
                  zip: "10045"
                date_of_birth: 1970-01-31
                identification:
                  method: social_security_number
                  number: "078051120"
                name: Ian Crease
              prong: control
          incorporation_state: NY
          name: National Phonograph Company
          tax_identifier: "602214076"
          website: https://example.com
        relationship: informational
        structure: corporation
        supplemental_documents:
          - file_id: file_makxrc67oh9l6sg7w9yc
      properties:
        corporation:
          description: Details of the corporation entity to create. Required if `structure` is equal to `corporation`.
          properties:
            address:
              description: The corporation's address.
              properties:
                city:
                  description: The city of the address.
                  maxLength: 200
                  minLength: 1
                  type: string
                line1:
                  description: The first line of the address. This is usually the street number and street.
                  maxLength: 200
                  minLength: 1
                  type: string
                line2:
                  description: The second line of the address. This might be the floor or room number.
                  maxLength: 200
                  minLength: 1
                  type: string
                state:
                  description: The two-letter United States Postal Service (USPS) abbreviation for the state of the address.
                  maxLength: 200
                  minLength: 1
                  type: string
                zip:
                  description: The ZIP code of the address.
                  maxLength: 200
                  minLength: 1
                  type: string
              required:
                - line1
                - city
                - state
                - zip
              type: object
            beneficial_owners:
              description: The identifying details of anyone controlling or owning 25% or more of the corporation.
              items:
                properties:
                  company_title:
                    description: This person's role or title within the entity.
                    maxLength: 200
                    minLength: 1
                    type: string
                  individual:
                    description: Personal details for the beneficial owner.
                    properties:
                      address:
                        description: The individual's address.
                        properties:
                          city:
                            description: The city of the address.
                            maxLength: 200
                            minLength: 1
                            type: string
                          line1:
                            description: The first line of the address. This is usually the street number and street.
                            maxLength: 200
                            minLength: 1
                            type: string
                          line2:
                            description: The second line of the address. This might be the floor or room number.
                            maxLength: 200
                            minLength: 1
                            type: string
                          state:
                            description: The two-letter United States Postal Service (USPS) abbreviation for the state of the address.
                            maxLength: 200
                            minLength: 1
                            type: string
                          zip:
                            description: The ZIP code of the address.
                            maxLength: 200
                            minLength: 1
                            type: string
                        required:
                          - line1
                          - city
                          - state
                          - zip
                        type: object
                      confirmed_no_us_tax_id:
                        description: The identification method for an individual can only be a passport, driver's license, or other document if you've confirmed the individual does not have a US tax id (either a Social Security Number or Individual Taxpayer Identification Number).
                        type: boolean
                      date_of_birth:
                        description: The person's date of birth in YYYY-MM-DD format.
                        format: date
                        type: string
                      identification:
                        description: A means of verifying the person's identity.
                        properties:
                          drivers_license:
                            description: Information about the United States driver's license used for identification. Required if `method` is equal to `drivers_license`.
                            properties:
                              expiration_date:
                                description: The driver's license's expiration date in YYYY-MM-DD format.
                                format: date
                                type: string
                              file_id:
                                description: The identifier of the File containing the driver's license.
                                type: string
                              state:
                                description: The state that issued the provided driver's license.
                                maxLength: 200
                                minLength: 1
                                type: string
                            required:
                              - file_id
                              - expiration_date
                              - state
                            type: object
                          method:
                            description: A method that can be used to verify the individual's identity.
                            enum:
                              - social_security_number
                              - individual_taxpayer_identification_number
                              - passport
                              - drivers_license
                              - other
                            type: string
                            x-enum-descriptions:
                              - A social security number.
                              - An individual taxpayer identification number (ITIN).
                              - A passport number.
                              - A driver's license number.
                              - Another identifying document.
                          number:
                            description: An identification number that can be used to verify the individual's identity, such as a social security number.
                            maxLength: 200
                            minLength: 4
                            type: string
                          other:
                            description: Information about the identification document provided. Required if `method` is equal to `other`.
                            properties:
                              country:
                                description: The two-character ISO 3166-1 code representing the country that issued the document.
                                maxLength: 200
                                minLength: 1
                                type: string
                              description:
                                description: A description of the document submitted.
                                maxLength: 200
                                minLength: 1
                                type: string
                              expiration_date:
                                description: The document's expiration date in YYYY-MM-DD format.
                                format: date
                                type: string
                              file_id:
                                description: The identifier of the File containing the document.
                                type: string
                            required:
                              - country
                              - description
                              - file_id
                            type: object
                          passport:
                            description: Information about the passport used for identification. Required if `method` is equal to `passport`.
                            properties:
                              country:
                                description: The country that issued the passport.
                                maxLength: 200
                                minLength: 1
                                type: string
                              expiration_date:
                                description: The passport's expiration date in YYYY-MM-DD format.
                                format: date
                                type: string
                              file_id:
                                description: The identifier of the File containing the passport.
                                type: string
                            required:
                              - file_id
                              - expiration_date
                              - country
                            type: object
                        required:
                          - method
                          - number
                        type: object
                      name:
                        description: The person's legal name.
                        maxLength: 200
                        minLength: 1
                        type: string
                    required:
                      - name
                      - date_of_birth
                      - address
                      - identification
                    type: object
                  prong:
                    description: Why this person is considered a beneficial owner of the entity.
                    enum:
                      - ownership
                      - control
                    type: string
                    x-enum-descriptions:
                      - A person with 25% or greater direct or indirect ownership of the entity.
                      - A person who manages, directs, or has significant control of the entity.
                required:
                  - individual
                  - prong
                type: object
              type: array
            incorporation_state:
              description: The two-letter United States Postal Service (USPS) abbreviation for the corporation's state of incorporation.
              maxLength: 200
              minLength: 1
              type: string
            name:
              description: The legal name of the corporation.
              maxLength: 200
              minLength: 1
              type: string
            tax_identifier:
              description: The Employer Identification Number (EIN) for the corporation.
              maxLength: 200
              minLength: 1
              type: string
            website:
              description: The website of the corporation.
              type: string
          required:
            - name
            - tax_identifier
            - address
            - beneficial_owners
          type: object
        description:
          description: The description you choose to give the entity.
          maxLength: 200
          minLength: 1
          type: string
        joint:
          description: Details of the joint entity to create. Required if `structure` is equal to `joint`.
          properties:
            individuals:
              description: The two individuals that share control of the entity.
              items:
                properties:
                  address:
                    description: The individual's address.
                    properties:
                      city:
                        description: The city of the address.
                        maxLength: 200
                        minLength: 1
                        type: string
                      line1:
                        description: The first line of the address. This is usually the street number and street.
                        maxLength: 200
                        minLength: 1
                        type: string
                      line2:
                        description: The second line of the address. This might be the floor or room number.
                        maxLength: 200
                        minLength: 1
                        type: string
                      state:
                        description: The two-letter United States Postal Service (USPS) abbreviation for the state of the address.
                        maxLength: 200
                        minLength: 1
                        type: string
                      zip:
                        description: The ZIP code of the address.
                        maxLength: 200
                        minLength: 1
                        type: string
                    required:
                      - line1
                      - city
                      - state
                      - zip
                    type: object
                  confirmed_no_us_tax_id:
                    description: The identification method for an individual can only be a passport, driver's license, or other document if you've confirmed the individual does not have a US tax id (either a Social Security Number or Individual Taxpayer Identification Number).
                    type: boolean
                  date_of_birth:
                    description: The person's date of birth in YYYY-MM-DD format.
                    format: date
                    type: string
                  identification:
                    description: A means of verifying the person's identity.
                    properties:
                      drivers_license:
                        description: Information about the United States driver's license used for identification. Required if `method` is equal to `drivers_license`.
                        properties:
                          expiration_date:
                            description: The driver's license's expiration date in YYYY-MM-DD format.
                            format: date
                            type: string
                          file_id:
                            description: The identifier of the File containing the driver's license.
                            type: string
                          state:
                            description: The state that issued the provided driver's license.
                            maxLength: 200
                            minLength: 1
                            type: string
                        required:
                          - file_id
                          - expiration_date
                          - state
                        type: object
                      method:
                        description: A method that can be used to verify the individual's identity.
                        enum:
                          - social_security_number
                          - individual_taxpayer_identification_number
                          - passport
                          - drivers_license
                          - other
                        type: string
                        x-enum-descriptions:
                          - A social security number.
                          - An individual taxpayer identification number (ITIN).
                          - A passport number.
                          - A driver's license number.
                          - Another identifying document.
                      number:
                        description: An identification number that can be used to verify the individual's identity, such as a social security number.
                        maxLength: 200
                        minLength: 4
                        type: string
                      other:
                        description: Information about the identification document provided. Required if `method` is equal to `other`.
                        properties:
                          country:
                            description: The two-character ISO 3166-1 code representing the country that issued the document.
                            maxLength: 200
                            minLength: 1
                            type: string
                          description:
                            description: A description of the document submitted.
                            maxLength: 200
                            minLength: 1
                            type: string
                          expiration_date:
                            description: The document's expiration date in YYYY-MM-DD format.
                            format: date
                            type: string
                          file_id:
                            description: The identifier of the File containing the document.
                            type: string
                        required:
                          - country
                          - description
                          - file_id
                        type: object
                      passport:
                        description: Information about the passport used for identification. Required if `method` is equal to `passport`.
                        properties:
                          country:
                            description: The country that issued the passport.
                            maxLength: 200
                            minLength: 1
                            type: string
                          expiration_date:
                            description: The passport's expiration date in YYYY-MM-DD format.
                            format: date
                            type: string
                          file_id:
                            description: The identifier of the File containing the passport.
                            type: string
                        required:
                          - file_id
                          - expiration_date
                          - country
                        type: object
                    required:
                      - method
                      - number
                    type: object
                  name:
                    description: The person's legal name.
                    maxLength: 200
                    minLength: 1
                    type: string
                required:
                  - name
                  - date_of_birth
                  - address
                  - identification
                type: object
              type: array
            name:
              description: The name of the joint entity.
              maxLength: 200
              minLength: 1
              type: string
          required:
            - individuals
          type: object
        natural_person:
          description: Details of the natural person entity to create. Required if `structure` is equal to `natural_person`. Natural people entities should be submitted with `social_security_number` or `individual_taxpayer_identification_number` identification methods.
          properties:
            address:
              description: The individual's address.
              properties:
                city:
                  description: The city of the address.
                  maxLength: 200
                  minLength: 1
                  type: string
                line1:
                  description: The first line of the address. This is usually the street number and street.
                  maxLength: 200
                  minLength: 1
                  type: string
                line2:
                  description: The second line of the address. This might be the floor or room number.
                  maxLength: 200
                  minLength: 1
                  type: string
                state:
                  description: The two-letter United States Postal Service (USPS) abbreviation for the state of the address.
                  maxLength: 200
                  minLength: 1
                  type: string
                zip:
                  description: The ZIP code of the address.
                  maxLength: 200
                  minLength: 1
                  type: string
              required:
                - line1
                - city
                - state
                - zip
              type: object
            confirmed_no_us_tax_id:
              description: The identification method for an individual can only be a passport, driver's license, or other document if you've confirmed the individual does not have a US tax id (either a Social Security Number or Individual Taxpayer Identification Number).
              type: boolean
            date_of_birth:
              description: The person's date of birth in YYYY-MM-DD format.
              format: date
              type: string
            identification:
              description: A means of verifying the person's identity.
              properties:
                drivers_license:
                  description: Information about the United States driver's license used for identification. Required if `method` is equal to `drivers_license`.
                  properties:
                    expiration_date:
                      description: The driver's license's expiration date in YYYY-MM-DD format.
                      format: date
                      type: string
                    file_id:
                      description: The identifier of the File containing the driver's license.
                      type: string
                    state:
                      description: The state that issued the provided driver's license.
                      maxLength: 200
                      minLength: 1
                      type: string
                  required:
                    - file_id
                    - expiration_date
                    - state
                  type: object
                method:
                  description: A method that can be used to verify the individual's identity.
                  enum:
                    - social_security_number
                    - individual_taxpayer_identification_number
                    - passport
                    - drivers_license
                    - other
                  type: string
                  x-enum-descriptions:
                    - A social security number.
                    - An individual taxpayer identification number (ITIN).
                    - A passport number.
                    - A driver's license number.
                    - Another identifying document.
                number:
                  description: An identification number that can be used to verify the individual's identity, such as a social security number.
                  maxLength: 200
                  minLength: 4
                  type: string
                other:
                  description: Information about the identification document provided. Required if `method` is equal to `other`.
                  properties:
                    country:
                      description: The two-character ISO 3166-1 code representing the country that issued the document.
                      maxLength: 200
                      minLength: 1
                      type: string
                    description:
                      description: A description of the document submitted.
                      maxLength: 200
                      minLength: 1
                      type: string
                    expiration_date:
                      description: The document's expiration date in YYYY-MM-DD format.
                      format: date
                      type: string
                    file_id:
                      description: The identifier of the File containing the document.
                      type: string
                  required:
                    - country
                    - description
                    - file_id
                  type: object
                passport:
                  description: Information about the passport used for identification. Required if `method` is equal to `passport`.
                  properties:
                    country:
                      description: The country that issued the passport.
                      maxLength: 200
                      minLength: 1
                      type: string
                    expiration_date:
                      description: The passport's expiration date in YYYY-MM-DD format.
                      format: date
                      type: string
                    file_id:
                      description: The identifier of the File containing the passport.
                      type: string
                  required:
                    - file_id
                    - expiration_date
                    - country
                  type: object
              required:
                - method
                - number
              type: object
            name:
              description: The person's legal name.
              maxLength: 200
              minLength: 1
              type: string
          required:
            - name
            - date_of_birth
            - address
            - identification
          type: object
        relationship:
          description: The relationship between your group and the entity.
          enum:
            - affiliated
            - informational
            - unaffiliated
          type: string
          x-enum-descriptions:
            - The entity is controlled by your group.
            - The entity is for informational purposes only.
            - The entity is not controlled by your group, but can still directly open accounts.
        structure:
          description: The type of Entity to create.
          enum:
            - corporation
            - natural_person
            - joint
            - trust
          type: string
          x-enum-descriptions:
            - A corporation.
            - An individual person.
            - Multiple individual people.
            - A trust.
        supplemental_documents:
          description: Additional documentation associated with the entity.
          items:
            properties:
              file_id:
                description: The identifier of the File containing the document.
                type: string
            required:
              - file_id
            type: object
          type: array
        trust:
          description: Details of the trust entity to create. Required if `structure` is equal to `trust`.
          properties:
            address:
              description: The trust's address.
              properties:
                city:
                  description: The city of the address.
                  maxLength: 200
                  minLength: 1
                  type: string
                line1:
                  description: The first line of the address. This is usually the street number and street.
                  maxLength: 200
                  minLength: 1
                  type: string
                line2:
                  description: The second line of the address. This might be the floor or room number.
                  maxLength: 200
                  minLength: 1
                  type: string
                state:
                  description: The two-letter United States Postal Service (USPS) abbreviation for the state of the address.
                  maxLength: 200
                  minLength: 1
                  type: string
                zip:
                  description: The ZIP code of the address.
                  maxLength: 200
                  minLength: 1
                  type: string
              required:
                - line1
                - city
                - state
                - zip
              type: object
            category:
              description: Whether the trust is `revocable` or `irrevocable`. Irrevocable trusts require their own Employer Identification Number. Revocable trusts require information about the individual `grantor` who created the trust.
              enum:
                - revocable
                - irrevocable
              type: string
              x-enum-descriptions:
                - The trust is revocable by the grantor.
                - The trust cannot be revoked.
            formation_document_file_id:
              description: The identifier of the File containing the formation document of the trust.
              type: string
            formation_state:
              description: The two-letter United States Postal Service (USPS) abbreviation for the state in which the trust was formed.
              maxLength: 200
              minLength: 1
              type: string
            grantor:
              description: The grantor of the trust. Required if `category` is equal to `revocable`.
              properties:
                address:
                  description: The individual's address.
                  properties:
                    city:
                      description: The city of the address.
                      maxLength: 200
                      minLength: 1
                      type: string
                    line1:
                      description: The first line of the address. This is usually the street number and street.
                      maxLength: 200
                      minLength: 1
                      type: string
                    line2:
                      description: The second line of the address. This might be the floor or room number.
                      maxLength: 200
                      minLength: 1
                      type: string
                    state:
                      description: The two-letter United States Postal Service (USPS) abbreviation for the state of the address.
                      maxLength: 200
                      minLength: 1
                      type: string
                    zip:
                      description: The ZIP code of the address.
                      maxLength: 200
                      minLength: 1
                      type: string
                  required:
                    - line1
                    - city
                    - state
                    - zip
                  type: object
                confirmed_no_us_tax_id:
                  description: The identification method for an individual can only be a passport, driver's license, or other document if you've confirmed the individual does not have a US tax id (either a Social Security Number or Individual Taxpayer Identification Number).
                  type: boolean
                date_of_birth:
                  description: The person's date of birth in YYYY-MM-DD format.
                  format: date
                  type: string
                identification:
                  description: A means of verifying the person's identity.
                  properties:
                    drivers_license:
                      description: Information about the United States driver's license used for identification. Required if `method` is equal to `drivers_license`.
                      properties:
                        expiration_date:
                          description: The driver's license's expiration date in YYYY-MM-DD format.
                          format: date
                          type: string
                        file_id:
                          description: The identifier of the File containing the driver's license.
                          type: string
                        state:
                          description: The state that issued the provided driver's license.
                          maxLength: 200
                          minLength: 1
                          type: string
                      required:
                        - file_id
                        - expiration_date
                        - state
                      type: object
                    method:
                      description: A method that can be used to verify the individual's identity.
                      enum:
                        - social_security_number
                        - individual_taxpayer_identification_number
                        - passport
                        - drivers_license
                        - other
                      type: string
                      x-enum-descriptions:
                        - A social security number.
                        - An individual taxpayer identification number (ITIN).
                        - A passport number.
                        - A driver's license number.
                        - Another identifying document.
                    number:
                      description: An identification number that can be used to verify the individual's identity, such as a social security number.
                      maxLength: 200
                      minLength: 4
                      type: string
                    other:
                      description: Information about the identification document provided. Required if `method` is equal to `other`.
                      properties:
                        country:
                          description: The two-character ISO 3166-1 code representing the country that issued the document.
                          maxLength: 200
                          minLength: 1
                          type: string
                        description:
                          description: A description of the document submitted.
                          maxLength: 200
                          minLength: 1
                          type: string
                        expiration_date:
                          description: The document's expiration date in YYYY-MM-DD format.
                          format: date
                          type: string
                        file_id:
                          description: The identifier of the File containing the document.
                          type: string
                      required:
                        - country
                        - description
                        - file_id
                      type: object
                    passport:
                      description: Information about the passport used for identification. Required if `method` is equal to `passport`.
                      properties:
                        country:
                          description: The country that issued the passport.
                          maxLength: 200
                          minLength: 1
                          type: string
                        expiration_date:
                          description: The passport's expiration date in YYYY-MM-DD format.
                          format: date
                          type: string
                        file_id:
                          description: The identifier of the File containing the passport.
                          type: string
                      required:
                        - file_id
                        - expiration_date
                        - country
                      type: object
                  required:
                    - method
                    - number
                  type: object
                name:
                  description: The person's legal name.
                  maxLength: 200
                  minLength: 1
                  type: string
              required:
                - name
                - date_of_birth
                - address
                - identification
              type: object
            name:
              description: The legal name of the trust.
              maxLength: 200
              minLength: 1
              type: string
            tax_identifier:
              description: The Employer Identification Number (EIN) for the trust. Required if `category` is equal to `irrevocable`.
              maxLength: 200
              minLength: 1
              type: string
            trustees:
              description: The trustees of the trust.
              items:
                properties:
                  individual:
                    description: Details of the individual trustee. Required when the trustee `structure` is equal to `individual`.
                    properties:
                      address:
                        description: The individual's address.
                        properties:
                          city:
                            description: The city of the address.
                            maxLength: 200
                            minLength: 1
                            type: string
                          line1:
                            description: The first line of the address. This is usually the street number and street.
                            maxLength: 200
                            minLength: 1
                            type: string
                          line2:
                            description: The second line of the address. This might be the floor or room number.
                            maxLength: 200
                            minLength: 1
                            type: string
                          state:
                            description: The two-letter United States Postal Service (USPS) abbreviation for the state of the address.
                            maxLength: 200
                            minLength: 1
                            type: string
                          zip:
                            description: The ZIP code of the address.
                            maxLength: 200
                            minLength: 1
                            type: string
                        required:
                          - line1
                          - city
                          - state
                          - zip
                        type: object
                      confirmed_no_us_tax_id:
                        description: The identification method for an individual can only be a passport, driver's license, or other document if you've confirmed the individual does not have a US tax id (either a Social Security Number or Individual Taxpayer Identification Number).
                        type: boolean
                      date_of_birth:
                        description: The person's date of birth in YYYY-MM-DD format.
                        format: date
                        type: string
                      identification:
                        description: A means of verifying the person's identity.
                        properties:
                          drivers_license:
                            description: Information about the United States driver's license used for identification. Required if `method` is equal to `drivers_license`.
                            properties:
                              expiration_date:
                                description: The driver's license's expiration date in YYYY-MM-DD format.
                                format: date
                                type: string
                              file_id:
                                description: The identifier of the File containing the driver's license.
                                type: string
                              state:
                                description: The state that issued the provided driver's license.
                                maxLength: 200
                                minLength: 1
                                type: string
                            required:
                              - file_id
                              - expiration_date
                              - state
                            type: object
                          method:
                            description: A method that can be used to verify the individual's identity.
                            enum:
                              - social_security_number
                              - individual_taxpayer_identification_number
                              - passport
                              - drivers_license
                              - other
                            type: string
                            x-enum-descriptions:
                              - A social security number.
                              - An individual taxpayer identification number (ITIN).
                              - A passport number.
                              - A driver's license number.
                              - Another identifying document.
                          number:
                            description: An identification number that can be used to verify the individual's identity, such as a social security number.
                            maxLength: 200
                            minLength: 4
                            type: string
                          other:
                            description: Information about the identification document provided. Required if `method` is equal to `other`.
                            properties:
                              country:
                                description: The two-character ISO 3166-1 code representing the country that issued the document.
                                maxLength: 200
                                minLength: 1
                                type: string
                              description:
                                description: A description of the document submitted.
                                maxLength: 200
                                minLength: 1
                                type: string
                              expiration_date:
                                description: The document's expiration date in YYYY-MM-DD format.
                                format: date
                                type: string
                              file_id:
                                description: The identifier of the File containing the document.
                                type: string
                            required:
                              - country
                              - description
                              - file_id
                            type: object
                          passport:
                            description: Information about the passport used for identification. Required if `method` is equal to `passport`.
                            properties:
                              country:
                                description: The country that issued the passport.
                                maxLength: 200
                                minLength: 1
                                type: string
                              expiration_date:
                                description: The passport's expiration date in YYYY-MM-DD format.
                                format: date
                                type: string
                              file_id:
                                description: The identifier of the File containing the passport.
                                type: string
                            required:
                              - file_id
                              - expiration_date
                              - country
                            type: object
                        required:
                          - method
                          - number
                        type: object
                      name:
                        description: The person's legal name.
                        maxLength: 200
                        minLength: 1
                        type: string
                    required:
                      - name
                      - date_of_birth
                      - address
                      - identification
                    type: object
                  structure:
                    description: The structure of the trustee.
                    enum:
                      - individual
                    type: string
                    x-enum-descriptions:
                      - The trustee is an individual.
                required:
                  - structure
                type: object
              type: array
          required:
            - name
            - category
            - address
            - trustees
          type: object
      required:
        - structure
        - relationship
      type: object
    create_an_event_subscription_parameters:
      example:
        url: https://website.com/webhooks
      properties:
        selected_event_category:
          description: If specified, this subscription will only receive webhooks for Events with the specified `category`.
          enum:
            - account.created
            - account.updated
            - account_number.created
            - account_number.updated
            - account_statement.created
            - account_transfer.created
            - account_transfer.updated
            - ach_prenotification.created
            - ach_prenotification.updated
            - ach_transfer.created
            - ach_transfer.updated
            - card.created
            - card.updated
            - card_payment.created
            - card_payment.updated
            - card_dispute.created
            - card_dispute.updated
            - check_deposit.created
            - check_deposit.updated
            - check_transfer.created
            - check_transfer.updated
            - declined_transaction.created
            - digital_wallet_token.created
            - digital_wallet_token.updated
            - document.created
            - entity.created
            - entity.updated
            - external_account.created
            - file.created
            - group.updated
            - group.heartbeat
            - inbound_ach_transfer_return.created
            - inbound_ach_transfer_return.updated
            - inbound_wire_drawdown_request.created
            - oauth_connection.created
            - oauth_connection.deactivated
            - pending_transaction.created
            - pending_transaction.updated
            - real_time_decision.card_authorization_requested
            - real_time_decision.digital_wallet_token_requested
            - real_time_decision.digital_wallet_authentication_requested
            - real_time_payments_transfer.created
            - real_time_payments_transfer.updated
            - real_time_payments_request_for_payment.created
            - real_time_payments_request_for_payment.updated
            - transaction.created
            - wire_drawdown_request.created
            - wire_drawdown_request.updated
            - wire_transfer.created
            - wire_transfer.updated
          type: string
          x-enum-descriptions:
            - Occurs whenever an Account is created.
            - Occurs whenever an Account is updated.
            - Occurs whenever an Account Number is created.
            - Occurs whenever an Account Number is updated.
            - Occurs whenever an Account Statement is created.
            - Occurs whenever an Account Transfer is created.
            - Occurs whenever an Account Transfer is updated.
            - Occurs whenever an ACH Prenotification is created.
            - Occurs whenever an ACH Prenotification is updated.
            - Occurs whenever an ACH Transfer is created.
            - Occurs whenever an ACH Transfer is updated.
            - Occurs whenever a Card is created.
            - Occurs whenever a Card is updated.
            - Occurs whenever a Card Payment is created.
            - Occurs whenever a Card Payment is updated.
            - Occurs whenever a Card Dispute is created.
            - Occurs whenever a Card Dispute is updated.
            - Occurs whenever a Check Deposit is created.
            - Occurs whenever a Check Deposit is updated.
            - Occurs whenever a Check Transfer is created.
            - Occurs whenever a Check Transfer is updated.
            - Occurs whenever a Declined Transaction is created.
            - Occurs whenever a Digital Wallet Token is created.
            - Occurs whenever a Digital Wallet Token is updated.
            - Occurs whenever a Document is created.
            - Occurs whenever an Entity is created.
            - Occurs whenever an Entity is updated.
            - Occurs whenever an External Account is created.
            - Occurs whenever a File is created.
            - Occurs whenever a Group is updated.
            - Increase may send webhooks with this category to see if a webhook endpoint is working properly.
            - Occurs whenever an Inbound ACH Transfer Return is created.
            - Occurs whenever an Inbound ACH Transfer Return is updated.
            - Occurs whenever an Inbound Wire Drawdown Request is created.
            - Occurs whenever an OAuth Connection is created.
            - Occurs whenever an OAuth Connection is deactivated.
            - Occurs whenever a Pending Transaction is created.
            - Occurs whenever a Pending Transaction is updated.
            - Occurs whenever a Real-Time Decision is created in response to a card authorization.
            - Occurs whenever a Real-Time Decision is created in response to a digital wallet provisioning attempt.
            - Occurs whenever a Real-Time Decision is created in response to a digital wallet requiring two-factor authentication.
            - Occurs whenever a Real Time Payments Transfer is created.
            - Occurs whenever a Real Time Payments Transfer is updated.
            - Occurs whenever a Real Time Payments Request for Payment is created.
            - Occurs whenever a Real Time Payments Request for Payment is updated.
            - Occurs whenever a Transaction is updated.
            - Occurs whenever a Wire Drawdown Request is created.
            - Occurs whenever a Wire Drawdown Request is updated.
            - Occurs whenever a Wire Transfer is created.
            - Occurs whenever a Wire Transfer is updated.
        shared_secret:
          description: The key that will be used to sign webhooks. If no value is passed, a random string will be used as default.
          maxLength: 100
          minLength: 1
          type: string
        url:
          description: The URL you'd like us to send webhooks to.
          type: string
      required:
        - url
      type: object
    create_an_export_parameters:
      example:
        category: transaction_csv
        transaction_csv:
          account_id: account_in71c4amph0vgo2qllky
      properties:
        balance_csv:
          description: Options for the created export. Required if `category` is equal to `balance_csv`.
          properties:
            account_id:
              description: Filter exported Transactions to the specified Account.
              type: string
            created_at:
              description: Filter results by time range on the `created_at` attribute.
              properties:
                after:
                  description: Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
                  format: date-time
                  type: string
                before:
                  description: Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
                  format: date-time
                  type: string
                on_or_after:
                  description: Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
                  format: date-time
                  type: string
                on_or_before:
                  description: Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
                  format: date-time
                  type: string
              type: object
          type: object
        category:
          description: The type of Export to create.
          enum:
            - transaction_csv
            - balance_csv
          type: string
          x-enum-descriptions:
            - Export a CSV of all transactions for a given time range.
            - Export a CSV of account balances for the dates in a given range.
        transaction_csv:
          description: Options for the created export. Required if `category` is equal to `transaction_csv`.
          properties:
            account_id:
              description: Filter exported Transactions to the specified Account.
              type: string
            created_at:
              description: Filter results by time range on the `created_at` attribute.
              properties:
                after:
                  description: Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
                  format: date-time
                  type: string
                before:
                  description: Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
                  format: date-time
                  type: string
                on_or_after:
                  description: Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
                  format: date-time
                  type: string
                on_or_before:
                  description: Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
                  format: date-time
                  type: string
              type: object
          type: object
      required:
        - category
      type: object
    create_an_external_account_parameters:
      example:
        account_number: "987654321"
        description: Landlord
        routing_number: "101050001"
      properties:
        account_number:
          description: The account number for the destination account.
          maxLength: 17
          minLength: 1
          type: string
        description:
          description: The name you choose for the Account.
          maxLength: 200
          minLength: 1
          type: string
        funding:
          description: The type of the destination account. Defaults to `checking`.
          enum:
            - checking
            - savings
            - other
          type: string
          x-enum-descriptions:
            - A checking account.
            - A savings account.
            - A different type of account.
        routing_number:
          description: The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.
          maxLength: 9
          minLength: 9
          type: string
      required:
        - routing_number
        - account_number
        - description
      type: object
    declined_transaction:
      description: Declined Transactions are refused additions and removals of money from your bank account. For example, Declined Transactions are caused when your Account has an insufficient balance or your Limits are triggered.
      example:
        account_id: account_in71c4amph0vgo2qllky
        amount: 1750
        created_at: 2020-01-31T23:59:59Z
        currency: USD
        description: Frederick S. Holmes
        id: declined_transaction_17jbn0yyhvkt4v4ooym8
        route_id: account_number_v18nkfqm6afpsrvy82b2
        route_type: account_number
        source:
          ach_decline:
            amount: 1750
            originator_company_descriptive_date: null
            originator_company_discretionary_data: null
            originator_company_id: "0987654321"
            originator_company_name: BIG BANK
            reason: insufficient_funds
            receiver_id_number: "12345678900"
            receiver_name: IAN CREASE
            trace_number: "021000038461022"
          category: ach_decline
        type: declined_transaction
      properties:
        account_id:
          description: The identifier for the Account the Declined Transaction belongs to.
          type: string
        amount:
          description: The Declined Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.
          type: integer
        created_at:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Transaction occured.
          format: date-time
          type: string
        currency:
          description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined Transaction's currency. This will match the currency on the Declined Transcation's Account.
          enum:
            - CAD
            - CHF
            - EUR
            - GBP
            - JPY
            - USD
          type: string
          x-enum-descriptions:
            - Canadian Dollar (CAD)
            - Swiss Franc (CHF)
            - Euro (EUR)
            - British Pound (GBP)
            - Japanese Yen (JPY)
            - US Dollar (USD)
        description:
          description: This is the description the vendor provides.
          type: string
        id:
          description: The Declined Transaction identifier.
          type: string
        route_id:
          description: The identifier for the route this Declined Transaction came through. Routes are things like cards and ACH details.
          nullable: true
          type: string
        route_type:
          description: The type of the route this Declined Transaction came through.
          enum:
            - account_number
            - card
          nullable: true
          type: string
          x-enum-descriptions:
            - An Account Number.
            - A Card.
        source:
          description: This is an object giving more details on the network-level event that caused the Declined Transaction. For example, for a card transaction this lists the merchant's industry and location. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.
          example:
            ach_decline:
              amount: 1750
              originator_company_descriptive_date: null
              originator_company_discretionary_data: null
              originator_company_id: "0987654321"
              originator_company_name: BIG BANK
              reason: insufficient_funds
              receiver_id_number: "12345678900"
              receiver_name: IAN CREASE
              trace_number: "021000038461022"
            category: ach_decline
          properties:
            ach_decline:
              description: A ACH Decline object. This field will be present in the JSON response if and only if `category` is equal to `ach_decline`.
              example:
                amount: 1750
                originator_company_descriptive_date: null
                originator_company_discretionary_data: null
                originator_company_id: "0987654321"
                originator_company_name: BIG BANK
                reason: insufficient_funds
                receiver_id_number: "12345678900"
                receiver_name: IAN CREASE
                trace_number: "021000038461022"
              nullable: true
              properties:
                amount:
                  description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                  type: integer
                originator_company_descriptive_date:
                  description: ""
                  nullable: true
                  type: string
                originator_company_discretionary_data:
                  description: ""
                  nullable: true
                  type: string
                originator_company_id:
                  description: ""
                  type: string
                originator_company_name:
                  description: ""
                  type: string
                reason:
                  description: Why the ACH transfer was declined.
                  enum:
                    - ach_route_canceled
                    - ach_route_disabled
                    - breaches_limit
                    - credit_entry_refused_by_receiver
                    - duplicate_return
                    - entity_not_active
                    - group_locked
                    - insufficient_funds
                    - misrouted_return
                    - no_ach_route
                    - originator_request
                    - transaction_not_allowed
                  type: string
                  x-enum-descriptions:
                    - The account number is canceled.
                    - The account number is disabled.
                    - The transaction would cause a limit to be exceeded.
                    - A credit was refused.
                    - Other.
                    - The account's entity is not active.
                    - Your account is inactive.
                    - Your account contains insufficient funds.
                    - Other.
                    - The account number that was debited does not exist.
                    - Other.
                    - The transaction is not allowed per Increase's terms
                receiver_id_number:
                  description: ""
                  nullable: true
                  type: string
                receiver_name:
                  description: ""
                  nullable: true
                  type: string
                trace_number:
                  description: ""
                  type: string
              required:
                - amount
                - originator_company_name
                - originator_company_descriptive_date
                - originator_company_discretionary_data
                - originator_company_id
                - reason
                - receiver_id_number
                - receiver_name
                - trace_number
              title: ACH Decline
              type: object
              x-title-plural: ACH Declines
            card_decline:
              description: A Card Decline object. This field will be present in the JSON response if and only if `category` is equal to `card_decline`.
              example:
                amount: -1000
                currency: USD
                digital_wallet_token_id: null
                merchant_acceptor_id: "372909060886"
                merchant_category_code: "5998"
                merchant_city: "5364086000"
                merchant_country: USA
                merchant_descriptor: TENTS R US
                merchant_state: CA
                network: visa
                network_details:
                  visa:
                    electronic_commerce_indicator: secure_electronic_commerce
                    point_of_service_entry_mode: manual
                real_time_decision_id: null
                reason: insufficient_funds
              nullable: true
              properties:
                amount:
                  description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                  type: integer
                currency:
                  description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.
                  enum:
                    - CAD
                    - CHF
                    - EUR
                    - GBP
                    - JPY
                    - USD
                  type: string
                  x-enum-descriptions:
                    - Canadian Dollar (CAD)
                    - Swiss Franc (CHF)
                    - Euro (EUR)
                    - British Pound (GBP)
                    - Japanese Yen (JPY)
                    - US Dollar (USD)
                digital_wallet_token_id:
                  description: If the authorization was attempted using a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used.
                  nullable: true
                  type: string
                merchant_acceptor_id:
                  description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.
                  type: string
                merchant_category_code:
                  description: The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.
                  nullable: true
                  type: string
                merchant_city:
                  description: The city the merchant resides in.
                  nullable: true
                  type: string
                merchant_country:
                  description: The country the merchant resides in.
                  nullable: true
                  type: string
                merchant_descriptor:
                  description: The merchant descriptor of the merchant the card is transacting with.
                  type: string
                merchant_state:
                  description: The state the merchant resides in.
                  nullable: true
                  type: string
                network:
                  description: The payment network used to process this card authorization
                  enum:
                    - visa
                  type: string
                  x-enum-descriptions:
                    - Visa
                network_details:
                  description: Fields specific to the `network`
                  properties:
                    visa:
                      description: Fields specific to the `visa` network
                      properties:
                        electronic_commerce_indicator:
                          description: For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order.
                          enum:
                            - mail_phone_order
                            - recurring
                            - installment
                            - unknown_mail_phone_order
                            - secure_electronic_commerce
                            - non_authenticated_security_transaction_at_3ds_capable_merchant
                            - non_authenticated_security_transaction
                            - non_secure_transaction
                          nullable: true
                          type: string
                          x-enum-descriptions:
                            - "Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments."
                            - "Recurring transaction: Payment indicator used to indicate a recurring transaction that originates from an acquirer in the US region."
                            - "Installment payment: Payment indicator used to indicate one purchase of goods or services that is billed to the account in multiple charges over a period of time agreed upon by the cardholder and merchant from transactions that originate from an acquirer in the US region."
                            - "Unknown classification: other mail order: Use to indicate that the type of mail/telephone order is unknown."
                            - "Secure electronic commerce transaction: Use to indicate that the electronic commerce transaction has been authenticated using e.g., 3-D Secure"
                            - "Non-authenticated security transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure: Use to identify an electronic commerce transaction where the merchant attempted to authenticate the cardholder using 3-D Secure, but was unable to complete the authentication because the issuer or cardholder does not participate in the 3-D Secure program."
                            - "Non-authenticated security transaction: Use to identify an electronic commerce transaction that uses data encryption for security however , cardholder authentication is not performed using 3-D Secure."
                            - "Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection."
                        point_of_service_entry_mode:
                          description: The method used to enter the cardholder's primary account number and card expiration date
                          enum:
                            - manual
                            - magnetic_stripe_no_cvv
                            - optical_code
                            - integrated_circuit_card
                            - contactless
                            - credential_on_file
                            - magnetic_stripe
                            - contactless_magnetic_stripe
                            - integrated_circuit_card_no_cvv
                          nullable: true
                          type: string
                          x-enum-descriptions:
                            - Manual key entry
                            - Magnetic stripe read, without card verification value
                            - Optical code
                            - Contact chip card
                            - Contactless read of chip card
                            - Transaction iniated using a credential that has previously been stored on file
                            - Magnetic stripe read
                            - Contactless read of magnetic stripe data
                            - Contact chip card, without card verification value
                      required:
                        - electronic_commerce_indicator
                        - point_of_service_entry_mode
                      title: Visa
                      type: object
                      x-title-plural: Visas
                  required:
                    - visa
                  title: Network Details
                  type: object
                  x-title-plural: Network Detailss
                real_time_decision_id:
                  description: The identifier of the Real-Time Decision sent to approve or decline this transaction.
                  nullable: true
                  type: string
                reason:
                  description: Why the transaction was declined.
                  enum:
                    - card_not_active
                    - entity_not_active
                    - group_locked
                    - insufficient_funds
                    - cvv2_mismatch
                    - transaction_not_allowed
                    - breaches_limit
                    - webhook_declined
                    - webhook_timed_out
                    - declined_by_stand_in_processing
                    - invalid_physical_card
                    - missing_original_authorization
                  type: string
                  x-enum-descriptions:
                    - The Card was not active.
                    - The account's entity was not active.
                    - The account was inactive.
                    - The Card's Account did not have a sufficient available balance.
                    - The given CVV2 did not match the card's value.
                    - The attempted card transaction is not allowed per Increase's terms.
                    - The transaction was blocked by a Limit.
                    - Your application declined the transaction via webhook.
                    - Your application webhook did not respond without the required timeout.
                    - Declined by stand-in processing.
                    - The card read had an invalid CVV, dCVV, or authorization request cryptogram.
                    - The original card authorization for this incremental authorization does not exist.
              required:
                - merchant_acceptor_id
                - merchant_descriptor
                - merchant_category_code
                - merchant_city
                - merchant_country
                - network
                - network_details
                - amount
                - currency
                - reason
                - merchant_state
                - real_time_decision_id
                - digital_wallet_token_id
              title: Card Decline
              type: object
              x-title-plural: Card Declines
            card_route_decline:
              description: A Deprecated Card Decline object. This field will be present in the JSON response if and only if `category` is equal to `card_route_decline`.
              example:
                amount: -1000
                currency: USD
                merchant_acceptor_id: "372909060886"
                merchant_category_code: "5998"
                merchant_city: "5364086000"
                merchant_country: USA
                merchant_descriptor: TENTS R US
                merchant_state: CA
              nullable: true
              properties:
                amount:
                  description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                  type: integer
                currency:
                  description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.
                  enum:
                    - CAD
                    - CHF
                    - EUR
                    - GBP
                    - JPY
                    - USD
                  type: string
                  x-enum-descriptions:
                    - Canadian Dollar (CAD)
                    - Swiss Franc (CHF)
                    - Euro (EUR)
                    - British Pound (GBP)
                    - Japanese Yen (JPY)
                    - US Dollar (USD)
                merchant_acceptor_id:
                  description: ""
                  type: string
                merchant_category_code:
                  description: ""
                  nullable: true
                  type: string
                merchant_city:
                  description: ""
                  nullable: true
                  type: string
                merchant_country:
                  description: ""
                  type: string
                merchant_descriptor:
                  description: ""
                  type: string
                merchant_state:
                  description: ""
                  nullable: true
                  type: string
              required:
                - amount
                - currency
                - merchant_acceptor_id
                - merchant_city
                - merchant_country
                - merchant_descriptor
                - merchant_state
                - merchant_category_code
              title: Deprecated Card Decline
              type: object
              x-title-plural: Deprecated Card Declines
            category:
              description: The type of decline that took place. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
              enum:
                - ach_decline
                - card_decline
                - check_decline
                - inbound_real_time_payments_transfer_decline
                - international_ach_decline
                - card_route_decline
                - other
              type: string
              x-enum-descriptions:
                - The Declined Transaction was created by a ACH Decline object. Details will be under the `ach_decline` object.
                - The Declined Transaction was created by a Card Decline object. Details will be under the `card_decline` object.
                - The Declined Transaction was created by a Check Decline object. Details will be under the `check_decline` object.
                - The Declined Transaction was created by a Inbound Real Time Payments Transfer Decline object. Details will be under the `inbound_real_time_payments_transfer_decline` object.
                - The Declined Transaction was created by a International ACH Decline object. Details will be under the `international_ach_decline` object.
                - The Declined Transaction was created by a Deprecated Card Decline object. Details will be under the `card_route_decline` object.
                - The Declined Transaction was made for an undocumented or deprecated reason.
            check_decline:
              description: A Check Decline object. This field will be present in the JSON response if and only if `category` is equal to `check_decline`.
              example:
                amount: -1000
                auxiliary_on_us: "99999"
                reason: insufficient_funds
              nullable: true
              properties:
                amount:
                  description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                  type: integer
                auxiliary_on_us:
                  description: ""
                  nullable: true
                  type: string
                reason:
                  description: Why the check was declined.
                  enum:
                    - ach_route_canceled
                    - ach_route_disabled
                    - breaches_limit
                    - entity_not_active
                    - group_locked
                    - insufficient_funds
                    - unable_to_locate_account
                    - unable_to_process
                    - refer_to_image
                    - stop_payment_requested
                    - returned
                    - duplicate_presentment
                    - not_authorized
                  type: string
                  x-enum-descriptions:
                    - The account number is canceled.
                    - The account number is disabled.
                    - The transaction would cause a limit to be exceeded.
                    - The account's entity is not active.
                    - Your account is inactive.
                    - Your account contains insufficient funds.
                    - Unable to locate account.
                    - Unable to process.
                    - Refer to image.
                    - Stop payment requested for this check.
                    - Check was returned to sender.
                    - The check was a duplicate deposit.
                    - The transaction is not allowed.
              required:
                - amount
                - auxiliary_on_us
                - reason
              title: Check Decline
              type: object
              x-title-plural: Check Declines
            inbound_real_time_payments_transfer_decline:
              description: A Inbound Real Time Payments Transfer Decline object. This field will be present in the JSON response if and only if `category` is equal to `inbound_real_time_payments_transfer_decline`.
              example:
                amount: 100
                creditor_name: Ian Crease
                currency: USD
                debtor_account_number: "987654321"
                debtor_name: National Phonograph Company
                debtor_routing_number: "101050001"
                reason: account_number_disabled
                remittance_information: Invoice 29582
                transaction_identification: 20220501234567891T1BSLZO01745013025
              nullable: true
              properties:
                amount:
                  description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                  type: integer
                creditor_name:
                  description: The name the sender of the transfer specified as the recipient of the transfer.
                  type: string
                currency:
                  description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined transfer's currency. This will always be "USD" for a Real Time Payments transfer.
                  enum:
                    - CAD
                    - CHF
                    - EUR
                    - GBP
                    - JPY
                    - USD
                  type: string
                  x-enum-descriptions:
                    - Canadian Dollar (CAD)
                    - Swiss Franc (CHF)
                    - Euro (EUR)
                    - British Pound (GBP)
                    - Japanese Yen (JPY)
                    - US Dollar (USD)
                debtor_account_number:
                  description: The account number of the account that sent the transfer.
                  type: string
                debtor_name:
                  description: The name provided by the sender of the transfer.
                  type: string
                debtor_routing_number:
                  description: The routing number of the account that sent the transfer.
                  type: string
                reason:
                  description: Why the transfer was declined.
                  enum:
                    - account_number_canceled
                    - account_number_disabled
                    - group_locked
                    - entity_not_active
                    - real_time_payments_not_enabled
                  type: string
                  x-enum-descriptions:
                    - The account number is canceled.
                    - The account number is disabled.
                    - Your account is inactive.
                    - The account's entity is not active.
                    - Your account is not enabled to receive Real Time Payments transfers.
                remittance_information:
                  description: Additional information included with the transfer.
                  nullable: true
                  type: string
                transaction_identification:
                  description: The Real Time Payments network identification of the declined transfer.
                  type: string
              required:
                - amount
                - currency
                - reason
                - creditor_name
                - debtor_name
                - debtor_account_number
                - debtor_routing_number
                - transaction_identification
                - remittance_information
              title: Inbound Real Time Payments Transfer Decline
              type: object
              x-title-plural: Inbound Real Time Payments Transfer Declines
            international_ach_decline:
              description: A International ACH Decline object. This field will be present in the JSON response if and only if `category` is equal to `international_ach_decline`.
              example:
                amount: -1000
                destination_country_code: US
                destination_currency_code: USD
                foreign_exchange_indicator: fixed_to_fixed
                foreign_exchange_reference: null
                foreign_exchange_reference_indicator: blank
                foreign_payment_amount: 199
                foreign_trace_number: null
                international_transaction_type_code: internet_initiated
                originating_currency_code: USD
                originating_depository_financial_institution_branch_country: US
                originating_depository_financial_institution_id: "091000019"
                originating_depository_financial_institution_id_qualifier: national_clearing_system_number
                originating_depository_financial_institution_name: WELLS FARGO BANK
                originator_city: BERLIN
                originator_company_entry_description: RETRY PYMT
                originator_country: DE
                originator_identification: 770510487A
                originator_name: BERGHAIN
                originator_postal_code: "50825"
                originator_state_or_province: null
                originator_street_address: Ruedersdorferstr. 7
                payment_related_information: null
                payment_related_information2: null
                receiver_city: BEVERLY HILLS
                receiver_country: US
                receiver_identification_number: "1018790279274"
                receiver_postal_code: "90210"
                receiver_state_or_province: CA
                receiver_street_address: 123 FAKE ST
                receiving_company_or_individual_name: IAN CREASE
                receiving_depository_financial_institution_country: US
                receiving_depository_financial_institution_id: "101050001"
                receiving_depository_financial_institution_id_qualifier: national_clearing_system_number
                receiving_depository_financial_institution_name: BLUE RIDGE BANK, NATIONAL ASSOCIATI
                trace_number: "010202909100090"
              nullable: true
              properties:
                amount:
                  description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                  type: integer
                destination_country_code:
                  description: ""
                  type: string
                destination_currency_code:
                  description: ""
                  type: string
                foreign_exchange_indicator:
                  description: ""
                  type: string
                foreign_exchange_reference:
                  description: ""
                  nullable: true
                  type: string
                foreign_exchange_reference_indicator:
                  description: ""
                  type: string
                foreign_payment_amount:
                  description: ""
                  type: integer
                foreign_trace_number:
                  description: ""
                  nullable: true
                  type: string
                international_transaction_type_code:
                  description: ""
                  type: string
                originating_currency_code:
                  description: ""
                  type: string
                originating_depository_financial_institution_branch_country:
                  description: ""
                  type: string
                originating_depository_financial_institution_id:
                  description: ""
                  type: string
                originating_depository_financial_institution_id_qualifier:
                  description: ""
                  type: string
                originating_depository_financial_institution_name:
                  description: ""
                  type: string
                originator_city:
                  description: ""
                  type: string
                originator_company_entry_description:
                  description: ""
                  type: string
                originator_country:
                  description: ""
                  type: string
                originator_identification:
                  description: ""
                  type: string
                originator_name:
                  description: ""
                  type: string
                originator_postal_code:
                  description: ""
                  nullable: true
                  type: string
                originator_state_or_province:
                  description: ""
                  nullable: true
                  type: string
                originator_street_address:
                  description: ""
                  type: string
                payment_related_information:
                  description: ""
                  nullable: true
                  type: string
                payment_related_information2:
                  description: ""
                  nullable: true
                  type: string
                receiver_city:
                  description: ""
                  type: string
                receiver_country:
                  description: ""
                  type: string
                receiver_identification_number:
                  description: ""
                  nullable: true
                  type: string
                receiver_postal_code:
                  description: ""
                  nullable: true
                  type: string
                receiver_state_or_province:
                  description: ""
                  nullable: true
                  type: string
                receiver_street_address:
                  description: ""
                  type: string
                receiving_company_or_individual_name:
                  description: ""
                  type: string
                receiving_depository_financial_institution_country:
                  description: ""
                  type: string
                receiving_depository_financial_institution_id:
                  description: ""
                  type: string
                receiving_depository_financial_institution_id_qualifier:
                  description: ""
                  type: string
                receiving_depository_financial_institution_name:
                  description: ""
                  type: string
                trace_number:
                  description: ""
                  type: string
              required:
                - amount
                - foreign_exchange_indicator
                - foreign_exchange_reference_indicator
                - foreign_exchange_reference
                - destination_country_code
                - destination_currency_code
                - foreign_payment_amount
                - foreign_trace_number
                - international_transaction_type_code
                - originating_currency_code
                - originating_depository_financial_institution_name
                - originating_depository_financial_institution_id_qualifier
                - originating_depository_financial_institution_id
                - originating_depository_financial_institution_branch_country
                - originator_city
                - originator_company_entry_description
                - originator_country
                - originator_identification
                - originator_name
                - originator_postal_code
                - originator_street_address
                - originator_state_or_province
                - payment_related_information
                - payment_related_information2
                - receiver_identification_number
                - receiver_street_address
                - receiver_city
                - receiver_state_or_province
                - receiver_country
                - receiver_postal_code
                - receiving_company_or_individual_name
                - receiving_depository_financial_institution_name
                - receiving_depository_financial_institution_id_qualifier
                - receiving_depository_financial_institution_id
                - receiving_depository_financial_institution_country
                - trace_number
              title: International ACH Decline
              type: object
              x-title-plural: International ACH Declines
          required:
            - category
            - ach_decline
            - card_decline
            - check_decline
            - inbound_real_time_payments_transfer_decline
            - international_ach_decline
            - card_route_decline
          title: Declined Transaction Source
          type: object
          x-title-plural: Declined Transaction Sources
        type:
          description: A constant representing the object's type. For this resource it will always be `declined_transaction`.
          enum:
            - declined_transaction
          type: string
      required:
        - account_id
        - amount
        - currency
        - created_at
        - description
        - id
        - route_id
        - route_type
        - source
        - type
      title: Declined Transaction
      type: object
      x-tag: Declined Transactions
      x-title-plural: Declined Transactions
    declined_transaction_list:
      description: A list of Declined Transaction objects
      example:
        data:
          - account_id: account_in71c4amph0vgo2qllky
            amount: 1750
            created_at: 2020-01-31T23:59:59Z
            currency: USD
            description: Frederick S. Holmes
            id: declined_transaction_17jbn0yyhvkt4v4ooym8
            route_id: account_number_v18nkfqm6afpsrvy82b2
            route_type: account_number
            source:
              ach_decline:
                amount: 1750
                originator_company_descriptive_date: null
                originator_company_discretionary_data: null
                originator_company_id: "0987654321"
                originator_company_name: BIG BANK
                reason: insufficient_funds
                receiver_id_number: "12345678900"
                receiver_name: IAN CREASE
                trace_number: "021000038461022"
              category: ach_decline
            type: declined_transaction
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/declined_transaction"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: Declined Transaction List
      type: object
      x-title-plural: Declined Transaction Lists
    digital_wallet_token:
      description: A Digital Wallet Token is created when a user adds a Card to their Apple Pay or Google Pay app. The Digital Wallet Token can be used for purchases just like a Card.
      example:
        card_id: card_oubs0hwk5rn6knuecxg2
        created_at: 2020-01-31T23:59:59Z
        id: digital_wallet_token_izi62go3h51p369jrie0
        status: active
        token_requestor: apple_pay
        type: digital_wallet_token
      properties:
        card_id:
          description: The identifier for the Card this Digital Wallet Token belongs to.
          type: string
        created_at:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card was created.
          format: date-time
          type: string
        id:
          description: The Digital Wallet Token identifier.
          type: string
        status:
          description: This indicates if payments can be made with the Digital Wallet Token.
          enum:
            - active
            - inactive
            - suspended
            - deactivated
          type: string
          x-enum-descriptions:
            - The digital wallet token is active.
            - The digital wallet token has been created but not successfully activated via two-factor authentication yet.
            - The digital wallet token has been temporarily paused.
            - The digital wallet token has been permanently cancelled.
        token_requestor:
          description: The digital wallet app being used.
          enum:
            - apple_pay
            - google_pay
          type: string
          x-enum-descriptions:
            - Apple Pay
            - Google Pay
        type:
          description: A constant representing the object's type. For this resource it will always be `digital_wallet_token`.
          enum:
            - digital_wallet_token
          type: string
      required:
        - id
        - card_id
        - created_at
        - status
        - token_requestor
        - type
      title: Digital Wallet Token
      type: object
      x-tag: Digital Wallet Tokens
      x-title-plural: Digital Wallet Tokens
    digital_wallet_token_list:
      description: A list of Digital Wallet Token objects
      example:
        data:
          - card_id: card_oubs0hwk5rn6knuecxg2
            created_at: 2020-01-31T23:59:59Z
            id: digital_wallet_token_izi62go3h51p369jrie0
            status: active
            token_requestor: apple_pay
            type: digital_wallet_token
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/digital_wallet_token"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: Digital Wallet Token List
      type: object
      x-title-plural: Digital Wallet Token Lists
    document:
      description: Increase generates certain documents / forms automatically for your application; they can be listed here. Currently the only supported document type is IRS Form 1099-INT.
      example:
        category: form_1099_int
        created_at: 2020-01-31T23:59:59Z
        entity_id: entity_n8y8tnk2p9339ti393yi
        file_id: file_makxrc67oh9l6sg7w9yc
        id: document_qjtqc6s4c14ve2q89izm
        type: document
      properties:
        category:
          description: The type of document.
          enum:
            - account_opening_disclosures
            - anti_money_laundering_policy
            - anti_money_laundering_procedures
            - audit_report
            - background_checks
            - business_continuity_plan
            - collections_policy
            - complaints_policy
            - complaint_report
            - compliance_report
            - compliance_staffing_plan
            - compliance_management_system_policy
            - consumer_privacy_notice
            - consumer_protection_policy
            - corporate_formation_document
            - credit_monitoring_report
            - customer_information_program_policy
            - electronic_funds_tranfer_act_policy
            - employee_overview
            - end_user_terms_of_service
            - e_sign_policy
            - financial_statement
            - form_1099_int
            - fraud_prevention_policy
            - funds_availability_policy
            - funds_availability_disclosure
            - funds_flow_diagram
            - gramm_leach_bliley_act_policy
            - information_security_policy
            - insurance_policy
            - investor_presentation
            - loan_application_processing_policy
            - management_biography
            - marketing_and_advertising_policy
            - network_security_diagram
            - onboarding_questionnaire
            - penetration_test_report
            - program_risk_assessment
            - security_audit_report
            - servicing_policy
            - transaction_monitoring_report
            - truth_in_savings_act_policy
            - underwriting_policy
            - vendor_list
            - vendor_management_policy
            - vendor_risk_management_report
            - volume_forecast
          type: string
          x-enum-descriptions:
            - The disclosures that the company uses to manage its account opening.
            - The policy that the company uses to manage its anti-money laundering.
            - The procedures that the company uses to implement it's AML policy.
            - An audit report for the company.
            - The results of one or more background checks.
            - A business continuity plan for the company.
            - The policy that the company uses to manage its collections.
            - The policy that the company uses to manage its complaints.
            - A report that was used to manage the company's complaints.
            - A compliance report not covered by another category.
            - A list of employees or organizational chart for the compliance/risk team. If absent, description of compliance vendor or compliance staffing plan for future hires.
            - The policy that the company uses to manage its compliance.
            - The notice that the company uses to manage its consumer privacy.
            - The policy that the company uses to manage its consumer protection.
            - The document that was used to form the company.
            - A report that was used to monitor the company's credit.
            - The policy that the company uses to manage its customer information.
            - The policy that the company uses to manage its Electronic Funds Transfer Act.
            - An overview of the company's employees.
            - The terms of service that the company uses for its end users.
            - The policy that the company uses to manage its e-signatures.
            - A financial statement for the company.
            - Internal Revenue Service Form 1099-INT.
            - The policy that the company uses to manage its fraud prevention.
            - The policy that the company uses to manage its funds availability.
            - The disclosure that the company uses to manage its funds availability.
            - A diagram of the company's funds flow.
            - The policy that the company uses to manage its Gramm-Leach-Bliley Act.
            - The policy that the company uses to manage its information security.
            - The policy that the company uses to manage its insurance.
            - A presentation that was given to investors.
            - The policy that the company uses to manage its loan application processing.
            - A biography of the company management.
            - The policy that the company uses to manage its marketing and advertising.
            - A diagram of the company's network security.
            - A questionnaire that was filled out by the company.
            - A report that was used to test the company's security.
            - An assessment of the program's risk.
            - A report that was used to audit the company's security.
            - The policy that the company uses to manage its servicing.
            - A report that was used to monitor the company's transactions.
            - The policy that the company uses to manage its Truth in Savings Act.
            - The policy that the company uses to manage its underwriting.
            - A risk-rated list of the company's vendors.
            - The policy that the company uses to manage its vendors.
            - A report that was used to manage the company's vendors.
            - A forecast of the company's volume.
        created_at:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Document was created.
          format: date-time
          type: string
        entity_id:
          description: The identifier of the Entity the document was generated for.
          nullable: true
          type: string
        file_id:
          description: The identifier of the File containing the Document's contents.
          type: string
        id:
          description: The Document identifier.
          type: string
        type:
          description: A constant representing the object's type. For this resource it will always be `document`.
          enum:
            - document
          type: string
      required:
        - id
        - category
        - created_at
        - entity_id
        - file_id
        - type
      title: Document
      type: object
      x-tag: Documents
      x-title-plural: Documents
    document_list:
      description: A list of Document objects
      example:
        data:
          - category: form_1099_int
            created_at: 2020-01-31T23:59:59Z
            entity_id: entity_n8y8tnk2p9339ti393yi
            file_id: file_makxrc67oh9l6sg7w9yc
            id: document_qjtqc6s4c14ve2q89izm
            type: document
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/document"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: Document List
      type: object
      x-title-plural: Document Lists
    entity:
      description: Entities are the legal entities that own accounts. They can be people, corporations, partnerships, or trusts.
      example:
        corporation:
          address:
            city: New York
            line1: 33 Liberty Street
            line2: null
            state: NY
            zip: "10045"
          beneficial_owners:
            - company_title: CEO
              individual:
                address:
                  city: New York
                  line1: 33 Liberty Street
                  line2: null
                  state: NY
                  zip: "10045"
                date_of_birth: 1970-01-31
                identification:
                  country: US
                  method: social_security_number
                  number_last4: "1120"
                name: Ian Crease
              prong: control
          incorporation_state: NY
          name: National Phonograph Company
          tax_identifier: "602214076"
          website: https://example.com
        description: null
        id: entity_n8y8tnk2p9339ti393yi
        joint: null
        natural_person: null
        relationship: informational
        structure: corporation
        supplemental_documents:
          - file_id: file_makxrc67oh9l6sg7w9yc
        trust: null
        type: entity
      properties:
        corporation:
          description: Details of the corporation entity. Will be present if `structure` is equal to `corporation`.
          nullable: true
          properties:
            address:
              description: The corporation's address.
              example:
                city: New York
                line1: 33 Liberty Street
                line2: null
                state: NY
                zip: "10045"
              properties:
                city:
                  description: The city of the address.
                  type: string
                line1:
                  description: The first line of the address.
                  type: string
                line2:
                  description: The second line of the address.
                  nullable: true
                  type: string
                state:
                  description: The two-letter United States Postal Service (USPS) abbreviation for the state of the address.
                  type: string
                zip:
                  description: The ZIP code of the address.
                  type: string
              required:
                - line1
                - line2
                - city
                - state
                - zip
              title: Address
              type: object
              x-title-plural: Addresss
            beneficial_owners:
              description: The identifying details of anyone controlling or owning 25% or more of the corporation.
              items:
                properties:
                  company_title:
                    description: This person's role or title within the entity.
                    nullable: true
                    type: string
                  individual:
                    description: Personal details for the beneficial owner.
                    properties:
                      address:
                        description: The person's address.
                        example:
                          city: New York
                          line1: 33 Liberty Street
                          line2: null
                          state: NY
                          zip: "10045"
                        properties:
                          city:
                            description: The city of the address.
                            type: string
                          line1:
                            description: The first line of the address.
                            type: string
                          line2:
                            description: The second line of the address.
                            nullable: true
                            type: string
                          state:
                            description: The two-letter United States Postal Service (USPS) abbreviation for the state of the address.
                            type: string
                          zip:
                            description: The ZIP code of the address.
                            type: string
                        required:
                          - line1
                          - line2
                          - city
                          - state
                          - zip
                        title: Address
                        type: object
                        x-title-plural: Addresss
                      date_of_birth:
                        description: The person's date of birth in YYYY-MM-DD format.
                        format: date
                        type: string
                      identification:
                        description: A means of verifying the person's identity.
                        properties:
                          method:
                            description: A method that can be used to verify the individual's identity.
                            enum:
                              - social_security_number
                              - individual_taxpayer_identification_number
                              - passport
                              - drivers_license
                              - other
                            type: string
                            x-enum-descriptions:
                              - A social security number.
                              - An individual taxpayer identification number (ITIN).
                              - A passport number.
                              - A driver's license number.
                              - Another identifying document.
                          number_last4:
                            description: The last 4 digits of the identification number that can be used to verify the individual's identity.
                            type: string
                        required:
                          - method
                          - number_last4
                        title: Identification
                        type: object
                        x-title-plural: Identifications
                      name:
                        description: The person's legal name.
                        type: string
                    required:
                      - name
                      - date_of_birth
                      - address
                      - identification
                    title: Individual
                    type: object
                    x-title-plural: Individuals
                  prong:
                    description: Why this person is considered a beneficial owner of the entity.
                    enum:
                      - ownership
                      - control
                    type: string
                    x-enum-descriptions:
                      - A person with 25% or greater direct or indirect ownership of the entity.
                      - A person who manages, directs, or has significant control of the entity.
                required:
                  - individual
                  - company_title
                  - prong
                title: Beneficial Owners Element
                type: object
                x-title-plural: Beneficial Owners Elements
              type: array
            incorporation_state:
              description: The two-letter United States Postal Service (USPS) abbreviation for the corporation's state of incorporation.
              nullable: true
              type: string
            name:
              description: The legal name of the corporation.
              type: string
            tax_identifier:
              description: The Employer Identification Number (EIN) for the corporation.
              nullable: true
              type: string
            website:
              description: The website of the corporation.
              nullable: true
              type: string
          required:
            - name
            - website
            - tax_identifier
            - incorporation_state
            - address
            - beneficial_owners
          title: Corporation
          type: object
          x-title-plural: Corporations
        description:
          description: The entity's description for display purposes.
          nullable: true
          type: string
        id:
          description: The entity's identifier.
          type: string
        joint:
          description: Details of the joint entity. Will be present if `structure` is equal to `joint`.
          nullable: true
          properties:
            individuals:
              description: The two individuals that share control of the entity.
              items:
                properties:
                  address:
                    description: The person's address.
                    example:
                      city: New York
                      line1: 33 Liberty Street
                      line2: null
                      state: NY
                      zip: "10045"
                    properties:
                      city:
                        description: The city of the address.
                        type: string
                      line1:
                        description: The first line of the address.
                        type: string
                      line2:
                        description: The second line of the address.
                        nullable: true
                        type: string
                      state:
                        description: The two-letter United States Postal Service (USPS) abbreviation for the state of the address.
                        type: string
                      zip:
                        description: The ZIP code of the address.
                        type: string
                    required:
                      - line1
                      - line2
                      - city
                      - state
                      - zip
                    title: Address
                    type: object
                    x-title-plural: Addresss
                  date_of_birth:
                    description: The person's date of birth in YYYY-MM-DD format.
                    format: date
                    type: string
                  identification:
                    description: A means of verifying the person's identity.
                    properties:
                      method:
                        description: A method that can be used to verify the individual's identity.
                        enum:
                          - social_security_number
                          - individual_taxpayer_identification_number
                          - passport
                          - drivers_license
                          - other
                        type: string
                        x-enum-descriptions:
                          - A social security number.
                          - An individual taxpayer identification number (ITIN).
                          - A passport number.
                          - A driver's license number.
                          - Another identifying document.
                      number_last4:
                        description: The last 4 digits of the identification number that can be used to verify the individual's identity.
                        type: string
                    required:
                      - method
                      - number_last4
                    title: Identification
                    type: object
                    x-title-plural: Identifications
                  name:
                    description: The person's legal name.
                    type: string
                required:
                  - name
                  - date_of_birth
                  - address
                  - identification
                title: Individual
                type: object
                x-title-plural: Individuals
              type: array
            name:
              description: The entity's name.
              type: string
          required:
            - name
            - individuals
          title: Joint
          type: object
          x-title-plural: Joints
        natural_person:
          description: Details of the natural person entity. Will be present if `structure` is equal to `natural_person`.
          nullable: true
          properties:
            address:
              description: The person's address.
              example:
                city: New York
                line1: 33 Liberty Street
                line2: null
                state: NY
                zip: "10045"
              properties:
                city:
                  description: The city of the address.
                  type: string
                line1:
                  description: The first line of the address.
                  type: string
                line2:
                  description: The second line of the address.
                  nullable: true
                  type: string
                state:
                  description: The two-letter United States Postal Service (USPS) abbreviation for the state of the address.
                  type: string
                zip:
                  description: The ZIP code of the address.
                  type: string
              required:
                - line1
                - line2
                - city
                - state
                - zip
              title: Address
              type: object
              x-title-plural: Addresss
            date_of_birth:
              description: The person's date of birth in YYYY-MM-DD format.
              format: date
              type: string
            identification:
              description: A means of verifying the person's identity.
              properties:
                method:
                  description: A method that can be used to verify the individual's identity.
                  enum:
                    - social_security_number
                    - individual_taxpayer_identification_number
                    - passport
                    - drivers_license
                    - other
                  type: string
                  x-enum-descriptions:
                    - A social security number.
                    - An individual taxpayer identification number (ITIN).
                    - A passport number.
                    - A driver's license number.
                    - Another identifying document.
                number_last4:
                  description: The last 4 digits of the identification number that can be used to verify the individual's identity.
                  type: string
              required:
                - method
                - number_last4
              title: Identification
              type: object
              x-title-plural: Identifications
            name:
              description: The person's legal name.
              type: string
          required:
            - name
            - date_of_birth
            - address
            - identification
          title: Individual
          type: object
          x-title-plural: Individuals
        relationship:
          description: The relationship between your group and the entity.
          enum:
            - affiliated
            - informational
            - unaffiliated
          type: string
          x-enum-descriptions:
            - The entity is controlled by your group.
            - The entity is for informational purposes only.
            - The entity is not controlled by your group, but can still directly open accounts.
        structure:
          description: The entity's legal structure.
          enum:
            - corporation
            - natural_person
            - joint
            - trust
          type: string
          x-enum-descriptions:
            - A corporation.
            - An individual person.
            - Multiple individual people.
            - A trust.
        supplemental_documents:
          description: Additional documentation associated with the entity.
          items:
            properties:
              file_id:
                description: The File containing the document.
                type: string
            required:
              - file_id
            title: Supplemental Documents Element
            type: object
            x-title-plural: Supplemental Documents Elements
          type: array
        trust:
          description: Details of the trust entity. Will be present if `structure` is equal to `trust`.
          nullable: true
          properties:
            address:
              description: The trust's address.
              example:
                city: New York
                line1: 33 Liberty Street
                line2: null
                state: NY
                zip: "10045"
              properties:
                city:
                  description: The city of the address.
                  type: string
                line1:
                  description: The first line of the address.
                  type: string
                line2:
                  description: The second line of the address.
                  nullable: true
                  type: string
                state:
                  description: The two-letter United States Postal Service (USPS) abbreviation for the state of the address.
                  type: string
                zip:
                  description: The ZIP code of the address.
                  type: string
              required:
                - line1
                - line2
                - city
                - state
                - zip
              title: Address
              type: object
              x-title-plural: Addresss
            category:
              description: Whether the trust is `revocable` or `irrevocable`.
              enum:
                - revocable
                - irrevocable
              type: string
              x-enum-descriptions:
                - The trust is revocable by the grantor.
                - The trust cannot be revoked.
            formation_document_file_id:
              description: The ID for the File containing the formation document of the trust.
              nullable: true
              type: string
            formation_state:
              description: The two-letter United States Postal Service (USPS) abbreviation for the state in which the trust was formed.
              nullable: true
              type: string
            grantor:
              description: The grantor of the trust. Will be present if the `category` is `revocable`.
              nullable: true
              properties:
                address:
                  description: The person's address.
                  example:
                    city: New York
                    line1: 33 Liberty Street
                    line2: null
                    state: NY
                    zip: "10045"
                  properties:
                    city:
                      description: The city of the address.
                      type: string
                    line1:
                      description: The first line of the address.
                      type: string
                    line2:
                      description: The second line of the address.
                      nullable: true
                      type: string
                    state:
                      description: The two-letter United States Postal Service (USPS) abbreviation for the state of the address.
                      type: string
                    zip:
                      description: The ZIP code of the address.
                      type: string
                  required:
                    - line1
                    - line2
                    - city
                    - state
                    - zip
                  title: Address
                  type: object
                  x-title-plural: Addresss
                date_of_birth:
                  description: The person's date of birth in YYYY-MM-DD format.
                  format: date
                  type: string
                identification:
                  description: A means of verifying the person's identity.
                  properties:
                    method:
                      description: A method that can be used to verify the individual's identity.
                      enum:
                        - social_security_number
                        - individual_taxpayer_identification_number
                        - passport
                        - drivers_license
                        - other
                      type: string
                      x-enum-descriptions:
                        - A social security number.
                        - An individual taxpayer identification number (ITIN).
                        - A passport number.
                        - A driver's license number.
                        - Another identifying document.
                    number_last4:
                      description: The last 4 digits of the identification number that can be used to verify the individual's identity.
                      type: string
                  required:
                    - method
                    - number_last4
                  title: Identification
                  type: object
                  x-title-plural: Identifications
                name:
                  description: The person's legal name.
                  type: string
              required:
                - name
                - date_of_birth
                - address
                - identification
              title: Individual
              type: object
              x-title-plural: Individuals
            name:
              description: The trust's name
              type: string
            tax_identifier:
              description: The Employer Identification Number (EIN) of the trust itself.
              nullable: true
              type: string
            trustees:
              description: The trustees of the trust.
              items:
                properties:
                  individual:
                    description: The individual trustee of the trust. Will be present if the trustee's `structure` is equal to `individual`.
                    nullable: true
                    properties:
                      address:
                        description: The person's address.
                        example:
                          city: New York
                          line1: 33 Liberty Street
                          line2: null
                          state: NY
                          zip: "10045"
                        properties:
                          city:
                            description: The city of the address.
                            type: string
                          line1:
                            description: The first line of the address.
                            type: string
                          line2:
                            description: The second line of the address.
                            nullable: true
                            type: string
                          state:
                            description: The two-letter United States Postal Service (USPS) abbreviation for the state of the address.
                            type: string
                          zip:
                            description: The ZIP code of the address.
                            type: string
                        required:
                          - line1
                          - line2
                          - city
                          - state
                          - zip
                        title: Address
                        type: object
                        x-title-plural: Addresss
                      date_of_birth:
                        description: The person's date of birth in YYYY-MM-DD format.
                        format: date
                        type: string
                      identification:
                        description: A means of verifying the person's identity.
                        properties:
                          method:
                            description: A method that can be used to verify the individual's identity.
                            enum:
                              - social_security_number
                              - individual_taxpayer_identification_number
                              - passport
                              - drivers_license
                              - other
                            type: string
                            x-enum-descriptions:
                              - A social security number.
                              - An individual taxpayer identification number (ITIN).
                              - A passport number.
                              - A driver's license number.
                              - Another identifying document.
                          number_last4:
                            description: The last 4 digits of the identification number that can be used to verify the individual's identity.
                            type: string
                        required:
                          - method
                          - number_last4
                        title: Identification
                        type: object
                        x-title-plural: Identifications
                      name:
                        description: The person's legal name.
                        type: string
                    required:
                      - name
                      - date_of_birth
                      - address
                      - identification
                    title: Individual
                    type: object
                    x-title-plural: Individuals
                  structure:
                    description: The structure of the trustee. Will always be equal to `individual`.
                    enum:
                      - individual
                    type: string
                    x-enum-descriptions:
                      - The trustee is an individual.
                required:
                  - structure
                  - individual
                title: Trustees Element
                type: object
                x-title-plural: Trustees Elements
              type: array
          required:
            - name
            - category
            - address
            - formation_state
            - tax_identifier
            - trustees
            - grantor
            - formation_document_file_id
          title: Trust
          type: object
          x-title-plural: Trusts
        type:
          description: A constant representing the object's type. For this resource it will always be `entity`.
          enum:
            - entity
          type: string
      required:
        - id
        - structure
        - corporation
        - natural_person
        - joint
        - trust
        - type
        - description
        - relationship
        - supplemental_documents
      title: Entity
      type: object
      x-tag: Entities
      x-title-plural: Entities
    entity_list:
      description: A list of Entity objects
      example:
        data:
          - corporation:
              address:
                city: New York
                line1: 33 Liberty Street
                line2: null
                state: NY
                zip: "10045"
              beneficial_owners:
                - company_title: CEO
                  individual:
                    address:
                      city: New York
                      line1: 33 Liberty Street
                      line2: null
                      state: NY
                      zip: "10045"
                    date_of_birth: 1970-01-31
                    identification:
                      country: US
                      method: social_security_number
                      number_last4: "1120"
                    name: Ian Crease
                  prong: control
              incorporation_state: NY
              name: National Phonograph Company
              tax_identifier: "602214076"
              website: https://example.com
            description: null
            id: entity_n8y8tnk2p9339ti393yi
            joint: null
            natural_person: null
            relationship: informational
            structure: corporation
            supplemental_documents:
              - file_id: file_makxrc67oh9l6sg7w9yc
            trust: null
            type: entity
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/entity"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: Entity List
      type: object
      x-title-plural: Entity Lists
    error:
      anyOf:
        - properties:
            detail:
              nullable: true
              type: string
            status:
              enum:
                - 404
              type: integer
            title:
              type: string
            type:
              enum:
                - api_method_not_found_error
              type: string
          required:
            - type
            - title
            - detail
            - status
          type: object
        - properties:
            detail:
              nullable: true
              type: string
            status:
              enum:
                - 403
              type: integer
            title:
              type: string
            type:
              enum:
                - environment_mismatch_error
              type: string
          required:
            - type
            - title
            - detail
            - status
          type: object
        - properties:
            detail:
              nullable: true
              type: string
            status:
              enum:
                - 409
              type: integer
            title:
              type: string
            type:
              enum:
                - idempotency_conflict_error
              type: string
          required:
            - type
            - title
            - detail
            - status
          type: object
        - properties:
            detail:
              nullable: true
              type: string
            status:
              enum:
                - 422
              type: integer
            title:
              type: string
            type:
              enum:
                - idempotency_unprocessable_error
              type: string
          required:
            - type
            - title
            - detail
            - status
          type: object
        - properties:
            detail:
              nullable: true
              type: string
            status:
              enum:
                - 403
              type: integer
            title:
              type: string
            type:
              enum:
                - insufficient_permissions_error
              type: string
          required:
            - type
            - title
            - detail
            - status
          type: object
        - properties:
            detail:
              nullable: true
              type: string
            status:
              enum:
                - 500
              type: integer
            title:
              type: string
            type:
              enum:
                - internal_server_error
              type: string
          required:
            - type
            - title
            - detail
            - status
          type: object
        - properties:
            detail:
              nullable: true
              type: string
            status:
              enum:
                - 401
              type: integer
            title:
              type: string
            type:
              enum:
                - invalid_api_key_error
              type: string
          required:
            - type
            - title
            - detail
            - status
          type: object
        - properties:
            detail:
              nullable: true
              type: string
            status:
              enum:
                - 409
              type: integer
            title:
              type: string
            type:
              enum:
                - invalid_operation_error
              type: string
          required:
            - type
            - title
            - detail
            - status
          type: object
        - properties:
            detail:
              nullable: true
              type: string
            errors:
              description: All errors related to parsing the request parameters.
              items:
                properties: {}
                title: Errors Element
                type: object
                x-title-plural: Errors Elements
              type: array
            status:
              enum:
                - 400
              type: integer
            title:
              type: string
            type:
              enum:
                - invalid_parameters_error
              type: string
          required:
            - type
            - title
            - detail
            - status
            - errors
          type: object
        - properties:
            detail:
              nullable: true
              type: string
            status:
              enum:
                - 400
              type: integer
            title:
              type: string
            type:
              enum:
                - malformed_request_error
              type: string
          required:
            - type
            - title
            - detail
            - status
          type: object
        - properties:
            detail:
              nullable: true
              type: string
            status:
              enum:
                - 404
              type: integer
            title:
              type: string
            type:
              enum:
                - object_not_found_error
              type: string
          required:
            - type
            - title
            - detail
            - status
          type: object
        - properties:
            detail:
              nullable: true
              type: string
            status:
              enum:
                - 403
              type: integer
            title:
              type: string
            type:
              enum:
                - private_feature_error
              type: string
          required:
            - type
            - title
            - detail
            - status
          type: object
        - properties:
            detail:
              nullable: true
              type: string
            retry_after:
              description: ""
              nullable: true
              type: integer
            status:
              enum:
                - 429
              type: integer
            title:
              type: string
            type:
              enum:
                - rate_limited_error
              type: string
          required:
            - type
            - title
            - detail
            - status
          type: object
    event:
      description: Events are records of things that happened to objects in the API. They also result in webhooks being generated.
      example:
        associated_object_id: account_in71c4amph0vgo2qllky
        associated_object_type: account
        category: account.created
        created_at: 2020-01-31T23:59:59Z
        id: event_001dzz0r20rzr4zrhrr1364hy80
        type: event
      properties:
        associated_object_id:
          description: The identifier of the object that generated this Event.
          type: string
        associated_object_type:
          description: The type of the object that generated this Event.
          type: string
        category:
          description: The category of the Event. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
          enum:
            - account.created
            - account.updated
            - account_number.created
            - account_number.updated
            - account_statement.created
            - account_transfer.created
            - account_transfer.updated
            - ach_prenotification.created
            - ach_prenotification.updated
            - ach_transfer.created
            - ach_transfer.updated
            - card.created
            - card.updated
            - card_payment.created
            - card_payment.updated
            - card_dispute.created
            - card_dispute.updated
            - check_deposit.created
            - check_deposit.updated
            - check_transfer.created
            - check_transfer.updated
            - declined_transaction.created
            - digital_wallet_token.created
            - digital_wallet_token.updated
            - document.created
            - entity.created
            - entity.updated
            - external_account.created
            - file.created
            - group.updated
            - group.heartbeat
            - inbound_ach_transfer_return.created
            - inbound_ach_transfer_return.updated
            - inbound_wire_drawdown_request.created
            - oauth_connection.created
            - oauth_connection.deactivated
            - pending_transaction.created
            - pending_transaction.updated
            - real_time_decision.card_authorization_requested
            - real_time_decision.digital_wallet_token_requested
            - real_time_decision.digital_wallet_authentication_requested
            - real_time_payments_transfer.created
            - real_time_payments_transfer.updated
            - real_time_payments_request_for_payment.created
            - real_time_payments_request_for_payment.updated
            - transaction.created
            - wire_drawdown_request.created
            - wire_drawdown_request.updated
            - wire_transfer.created
            - wire_transfer.updated
          type: string
          x-enum-descriptions:
            - Occurs whenever an Account is created.
            - Occurs whenever an Account is updated.
            - Occurs whenever an Account Number is created.
            - Occurs whenever an Account Number is updated.
            - Occurs whenever an Account Statement is created.
            - Occurs whenever an Account Transfer is created.
            - Occurs whenever an Account Transfer is updated.
            - Occurs whenever an ACH Prenotification is created.
            - Occurs whenever an ACH Prenotification is updated.
            - Occurs whenever an ACH Transfer is created.
            - Occurs whenever an ACH Transfer is updated.
            - Occurs whenever a Card is created.
            - Occurs whenever a Card is updated.
            - Occurs whenever a Card Payment is created.
            - Occurs whenever a Card Payment is updated.
            - Occurs whenever a Card Dispute is created.
            - Occurs whenever a Card Dispute is updated.
            - Occurs whenever a Check Deposit is created.
            - Occurs whenever a Check Deposit is updated.
            - Occurs whenever a Check Transfer is created.
            - Occurs whenever a Check Transfer is updated.
            - Occurs whenever a Declined Transaction is created.
            - Occurs whenever a Digital Wallet Token is created.
            - Occurs whenever a Digital Wallet Token is updated.
            - Occurs whenever a Document is created.
            - Occurs whenever an Entity is created.
            - Occurs whenever an Entity is updated.
            - Occurs whenever an External Account is created.
            - Occurs whenever a File is created.
            - Occurs whenever a Group is updated.
            - Increase may send webhooks with this category to see if a webhook endpoint is working properly.
            - Occurs whenever an Inbound ACH Transfer Return is created.
            - Occurs whenever an Inbound ACH Transfer Return is updated.
            - Occurs whenever an Inbound Wire Drawdown Request is created.
            - Occurs whenever an OAuth Connection is created.
            - Occurs whenever an OAuth Connection is deactivated.
            - Occurs whenever a Pending Transaction is created.
            - Occurs whenever a Pending Transaction is updated.
            - Occurs whenever a Real-Time Decision is created in response to a card authorization.
            - Occurs whenever a Real-Time Decision is created in response to a digital wallet provisioning attempt.
            - Occurs whenever a Real-Time Decision is created in response to a digital wallet requiring two-factor authentication.
            - Occurs whenever a Real Time Payments Transfer is created.
            - Occurs whenever a Real Time Payments Transfer is updated.
            - Occurs whenever a Real Time Payments Request for Payment is created.
            - Occurs whenever a Real Time Payments Request for Payment is updated.
            - Occurs whenever a Transaction is updated.
            - Occurs whenever a Wire Drawdown Request is created.
            - Occurs whenever a Wire Drawdown Request is updated.
            - Occurs whenever a Wire Transfer is created.
            - Occurs whenever a Wire Transfer is updated.
        created_at:
          description: The time the Event was created.
          format: date-time
          type: string
        id:
          description: The Event identifier.
          type: string
        type:
          description: A constant representing the object's type. For this resource it will always be `event`.
          enum:
            - event
          type: string
      required:
        - associated_object_id
        - associated_object_type
        - category
        - created_at
        - id
        - type
      title: Event
      type: object
      x-tag: Events
      x-title-plural: Events
    event_list:
      description: A list of Event objects
      example:
        data:
          - associated_object_id: account_in71c4amph0vgo2qllky
            associated_object_type: account
            category: account.created
            created_at: 2020-01-31T23:59:59Z
            id: event_001dzz0r20rzr4zrhrr1364hy80
            type: event
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/event"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: Event List
      type: object
      x-title-plural: Event Lists
    event_subscription:
      description: Webhooks are event notifications we send to you by HTTPS POST requests. Event Subscriptions are how you configure your application to listen for them. You can create an Event Subscription through your [developer dashboard](https://dashboard.increase.com/developers/webhooks) or the API. For more information, see our [webhooks guide](https://increase.com/documentation/webhooks).
      example:
        created_at: 2020-01-31T23:59:59Z
        id: event_subscription_001dzz0r20rcdxgb013zqb8m04g
        selected_event_category: null
        shared_secret: b88l20
        status: active
        type: event_subscription
        url: https://website.com/webhooks
      properties:
        created_at:
          description: The time the event subscription was created.
          format: date-time
          type: string
        id:
          description: The event subscription identifier.
          type: string
        selected_event_category:
          description: If specified, this subscription will only receive webhooks for Events with the specified `category`.
          enum:
            - account.created
            - account.updated
            - account_number.created
            - account_number.updated
            - account_statement.created
            - account_transfer.created
            - account_transfer.updated
            - ach_prenotification.created
            - ach_prenotification.updated
            - ach_transfer.created
            - ach_transfer.updated
            - card.created
            - card.updated
            - card_payment.created
            - card_payment.updated
            - card_dispute.created
            - card_dispute.updated
            - check_deposit.created
            - check_deposit.updated
            - check_transfer.created
            - check_transfer.updated
            - declined_transaction.created
            - digital_wallet_token.created
            - digital_wallet_token.updated
            - document.created
            - entity.created
            - entity.updated
            - external_account.created
            - file.created
            - group.updated
            - group.heartbeat
            - inbound_ach_transfer_return.created
            - inbound_ach_transfer_return.updated
            - inbound_wire_drawdown_request.created
            - oauth_connection.created
            - oauth_connection.deactivated
            - pending_transaction.created
            - pending_transaction.updated
            - real_time_decision.card_authorization_requested
            - real_time_decision.digital_wallet_token_requested
            - real_time_decision.digital_wallet_authentication_requested
            - real_time_payments_transfer.created
            - real_time_payments_transfer.updated
            - real_time_payments_request_for_payment.created
            - real_time_payments_request_for_payment.updated
            - transaction.created
            - wire_drawdown_request.created
            - wire_drawdown_request.updated
            - wire_transfer.created
            - wire_transfer.updated
          nullable: true
          type: string
          x-enum-descriptions:
            - Occurs whenever an Account is created.
            - Occurs whenever an Account is updated.
            - Occurs whenever an Account Number is created.
            - Occurs whenever an Account Number is updated.
            - Occurs whenever an Account Statement is created.
            - Occurs whenever an Account Transfer is created.
            - Occurs whenever an Account Transfer is updated.
            - Occurs whenever an ACH Prenotification is created.
            - Occurs whenever an ACH Prenotification is updated.
            - Occurs whenever an ACH Transfer is created.
            - Occurs whenever an ACH Transfer is updated.
            - Occurs whenever a Card is created.
            - Occurs whenever a Card is updated.
            - Occurs whenever a Card Payment is created.
            - Occurs whenever a Card Payment is updated.
            - Occurs whenever a Card Dispute is created.
            - Occurs whenever a Card Dispute is updated.
            - Occurs whenever a Check Deposit is created.
            - Occurs whenever a Check Deposit is updated.
            - Occurs whenever a Check Transfer is created.
            - Occurs whenever a Check Transfer is updated.
            - Occurs whenever a Declined Transaction is created.
            - Occurs whenever a Digital Wallet Token is created.
            - Occurs whenever a Digital Wallet Token is updated.
            - Occurs whenever a Document is created.
            - Occurs whenever an Entity is created.
            - Occurs whenever an Entity is updated.
            - Occurs whenever an External Account is created.
            - Occurs whenever a File is created.
            - Occurs whenever a Group is updated.
            - Increase may send webhooks with this category to see if a webhook endpoint is working properly.
            - Occurs whenever an Inbound ACH Transfer Return is created.
            - Occurs whenever an Inbound ACH Transfer Return is updated.
            - Occurs whenever an Inbound Wire Drawdown Request is created.
            - Occurs whenever an OAuth Connection is created.
            - Occurs whenever an OAuth Connection is deactivated.
            - Occurs whenever a Pending Transaction is created.
            - Occurs whenever a Pending Transaction is updated.
            - Occurs whenever a Real-Time Decision is created in response to a card authorization.
            - Occurs whenever a Real-Time Decision is created in response to a digital wallet provisioning attempt.
            - Occurs whenever a Real-Time Decision is created in response to a digital wallet requiring two-factor authentication.
            - Occurs whenever a Real Time Payments Transfer is created.
            - Occurs whenever a Real Time Payments Transfer is updated.
            - Occurs whenever a Real Time Payments Request for Payment is created.
            - Occurs whenever a Real Time Payments Request for Payment is updated.
            - Occurs whenever a Transaction is updated.
            - Occurs whenever a Wire Drawdown Request is created.
            - Occurs whenever a Wire Drawdown Request is updated.
            - Occurs whenever a Wire Transfer is created.
            - Occurs whenever a Wire Transfer is updated.
        shared_secret:
          description: The key that will be used to sign webhooks.
          type: string
        status:
          description: This indicates if we'll send notifications to this subscription.
          enum:
            - active
            - disabled
            - deleted
            - requires_attention
          type: string
          x-enum-descriptions:
            - The subscription is active and Events will be delivered normally.
            - The subscription is temporarily disabled and Events will not be delivered.
            - The subscription is permanently disabled and Events will not be delivered.
            - The subscription is temporarily disabled due to delivery errors and Events will not be delivered.
        type:
          description: A constant representing the object's type. For this resource it will always be `event_subscription`.
          enum:
            - event_subscription
          type: string
        url:
          description: The webhook url where we'll send notifications.
          type: string
      required:
        - id
        - created_at
        - status
        - selected_event_category
        - url
        - shared_secret
        - type
      title: Event Subscription
      type: object
      x-tag: Event Subscriptions
      x-title-plural: Event Subscriptions
    event_subscription_list:
      description: A list of Event Subscription objects
      example:
        data:
          - created_at: 2020-01-31T23:59:59Z
            id: event_subscription_001dzz0r20rcdxgb013zqb8m04g
            selected_event_category: null
            shared_secret: b88l20
            status: active
            type: event_subscription
            url: https://website.com/webhooks
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/event_subscription"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: Event Subscription List
      type: object
      x-title-plural: Event Subscription Lists
    export:
      description: Exports are batch summaries of your Increase data. You can make them from the API or dashboard. Since they can take a while, they are generated asynchronously. We send a webhook when they are ready. For more information, please read our [Exports documentation](https://increase.com/documentation/exports).
      example:
        category: transaction_csv
        created_at: 2020-01-31T23:59:59Z
        file_download_url: https://example.com/file
        file_id: file_makxrc67oh9l6sg7w9yc
        id: export_8s4m48qz3bclzje0zwh9
        status: complete
        type: export
      properties:
        category:
          description: The category of the Export. We may add additional possible values for this enum over time; your application should be able to handle that gracefully.
          enum:
            - transaction_csv
            - balance_csv
          type: string
          x-enum-descriptions:
            - Export a CSV of all transactions for a given time range.
            - Export a CSV of account balances for the dates in a given range.
        created_at:
          description: The time the Export was created.
          format: date-time
          type: string
        file_download_url:
          description: A URL at which the Export's file can be downloaded. This will be present when the Export's status transitions to `complete`.
          nullable: true
          type: string
        file_id:
          description: The File containing the contents of the Export. This will be present when the Export's status transitions to `complete`.
          nullable: true
          type: string
        id:
          description: The Export identifier.
          type: string
        status:
          description: The status of the Export.
          enum:
            - pending
            - complete
          type: string
          x-enum-descriptions:
            - Increase is generating the export.
            - The export has been successfully generated.
        type:
          description: A constant representing the object's type. For this resource it will always be `export`.
          enum:
            - export
          type: string
      required:
        - id
        - created_at
        - category
        - status
        - file_id
        - file_download_url
        - type
      title: Export
      type: object
      x-tag: Exports
      x-title-plural: Exports
    export_list:
      description: A list of Export objects
      example:
        data:
          - category: transaction_csv
            created_at: 2020-01-31T23:59:59Z
            file_download_url: https://example.com/file
            file_id: file_makxrc67oh9l6sg7w9yc
            id: export_8s4m48qz3bclzje0zwh9
            status: complete
            type: export
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/export"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: Export List
      type: object
      x-title-plural: Export Lists
    external_account:
      description: External Accounts represent accounts at financial institutions other than Increase. You can use this API to store their details for reuse.
      example:
        account_number: "987654321"
        created_at: 2020-01-31T23:59:59Z
        description: Landlord
        funding: checking
        id: external_account_ukk55lr923a3ac0pp7iv
        routing_number: "101050001"
        status: active
        type: external_account
        verification_status: verified
      properties:
        account_number:
          description: The destination account number.
          type: string
        created_at:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the External Account was created.
          format: date-time
          type: string
        description:
          description: The External Account's description for display purposes.
          type: string
        funding:
          description: The type of the account to which the transfer will be sent.
          enum:
            - checking
            - savings
            - other
          type: string
          x-enum-descriptions:
            - A checking account.
            - A savings account.
            - A different type of account.
        id:
          description: The External Account's identifier.
          type: string
        routing_number:
          description: The American Bankers' Association (ABA) Routing Transit Number (RTN).
          type: string
        status:
          description: The External Account's status.
          enum:
            - active
            - archived
          type: string
          x-enum-descriptions:
            - The External Acccount is active.
            - The External Account is archived and won't appear in the dashboard.
        type:
          description: A constant representing the object's type. For this resource it will always be `external_account`.
          enum:
            - external_account
          type: string
        verification_status:
          description: If you have verified ownership of the External Account.
          enum:
            - unverified
            - pending
            - verified
          type: string
          x-enum-descriptions:
            - The External Account has not been verified.
            - The External Account is in the process of being verified.
            - The External Account is verified.
      required:
        - id
        - created_at
        - description
        - status
        - routing_number
        - account_number
        - funding
        - verification_status
        - type
      title: External Account
      type: object
      x-tag: External Accounts
      x-title-plural: External Accounts
    external_account_list:
      description: A list of External Account objects
      example:
        data:
          - account_number: "987654321"
            created_at: 2020-01-31T23:59:59Z
            description: Landlord
            funding: checking
            id: external_account_ukk55lr923a3ac0pp7iv
            routing_number: "101050001"
            status: active
            type: external_account
            verification_status: verified
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/external_account"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: External Account List
      type: object
      x-title-plural: External Account Lists
    file:
      description: Files are objects that represent a file hosted on Increase's servers. The file may have been uploaded by you (for example, when uploading a check image) or it may have been created by Increase (for example, an autogenerated statement PDF).
      example:
        created_at: 2020-01-31T23:59:59Z
        description: 2022-05 statement for checking account
        direction: from_increase
        download_url: https://api.increase.com/files/file_makxrc67oh9l6sg7w9yc/download
        filename: statement.pdf
        id: file_makxrc67oh9l6sg7w9yc
        purpose: increase_statement
        type: file
      properties:
        created_at:
          description: The time the File was created.
          format: date-time
          type: string
        description:
          description: A description of the File.
          nullable: true
          type: string
        direction:
          description: Whether the File was generated by Increase or by you and sent to Increase.
          enum:
            - to_increase
            - from_increase
          type: string
          x-enum-descriptions:
            - This File was sent by you to Increase.
            - This File was generated by Increase.
        download_url:
          description: A URL from where the File can be downloaded at this point in time. The location of this URL may change over time.
          nullable: true
          type: string
        filename:
          description: The filename that was provided upon upload or generated by Increase.
          nullable: true
          type: string
        id:
          description: The File's identifier.
          type: string
        purpose:
          description: What the File will be used for. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
          enum:
            - check_image_front
            - check_image_back
            - form_1099_int
            - form_ss_4
            - identity_document
            - increase_statement
            - other
            - trust_formation_document
            - digital_wallet_artwork
            - digital_wallet_app_icon
            - document_request
            - entity_supplemental_document
            - export
          type: string
          x-enum-descriptions:
            - An image of the front of a check, used for check deposits.
            - An image of the back of a check, used for check deposits.
            - IRS Form 1099-INT.
            - IRS Form SS-4.
            - An image of a government-issued ID.
            - A statement generated by Increase.
            - A file purpose not covered by any of the other cases.
            - A legal document forming a trust.
            - A card image to be rendered inside digital wallet apps. This must be a 1536x969 pixel PNG.
            - An icon for you app to be rendered inside digital wallet apps. This must be a 100x100 pixel PNG.
            - A document requested by Increase.
            - A supplemental document associated an an Entity.
            - The results of an Export you requested via the dashboard or API.
        type:
          description: A constant representing the object's type. For this resource it will always be `file`.
          enum:
            - file
          type: string
      required:
        - created_at
        - id
        - purpose
        - description
        - direction
        - filename
        - download_url
        - type
      title: File
      type: object
      x-tag: Files
      x-title-plural: Files
    file_list:
      description: A list of File objects
      example:
        data:
          - created_at: 2020-01-31T23:59:59Z
            description: 2022-05 statement for checking account
            direction: from_increase
            download_url: https://api.increase.com/files/file_makxrc67oh9l6sg7w9yc/download
            filename: statement.pdf
            id: file_makxrc67oh9l6sg7w9yc
            purpose: increase_statement
            type: file
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/file"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: File List
      type: object
      x-title-plural: File Lists
    group:
      description: Groups represent organizations using Increase. You can retrieve information about your own organization via the API, or (more commonly) OAuth platforms can retrieve information about the organizations that have granted them access.
      example:
        ach_debit_status: disabled
        activation_status: activated
        created_at: 2020-01-31T23:59:59Z
        id: group_1g4mhziu6kvrs3vz35um
        type: group
      properties:
        ach_debit_status:
          description: If the Group is allowed to create ACH debits.
          enum:
            - disabled
            - enabled
          type: string
          x-enum-descriptions:
            - The Group cannot make ACH debits.
            - The Group can make ACH debits.
        activation_status:
          description: If the Group is activated or not.
          enum:
            - unactivated
            - activated
          type: string
          x-enum-descriptions:
            - The Group is not activated.
            - The Group is activated.
        created_at:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Group was created.
          format: date-time
          type: string
        id:
          description: The Group identifier.
          type: string
        type:
          description: A constant representing the object's type. For this resource it will always be `group`.
          enum:
            - group
          type: string
      required:
        - activation_status
        - ach_debit_status
        - created_at
        - id
        - type
      title: Group
      type: object
      x-tag: Groups
      x-title-plural: Groups
    inbound_ach_transfer_return:
      description: If unauthorized activity occurs via ACH, you can create an Inbound ACH Transfer Return and we'll reverse the transaction. You can create an Inbound ACH Transfer return the first two days after receiving an Inbound ACH Transfer.
      example:
        class_name: inbound_ach_transfer_return
        id: inbound_ach_transfer_return_fhcxk5huskwhmt7iz0gk
        inbound_ach_transfer_transaction_id: transaction_uyrp7fld2ium70oa7oi
        reason: payment_stopped
        status: submitted
        submission:
          submitted_at: 2020-01-31T23:59:59Z
          trace_number: "058349238292834"
        transaction_id: null
        type: inbound_ach_transfer_return
      properties:
        id:
          description: The ID of the Inbound ACH Transfer Return.
          type: string
        inbound_ach_transfer_transaction_id:
          description: The ID for the Transaction that is being returned.
          type: string
        reason:
          description: The reason why this transfer will be returned. This is sent to the initiating bank.
          enum:
            - authorization_revoked_by_customer
            - payment_stopped
            - customer_advised_unauthorized_improper_ineligible_or_incomplete
            - representative_payee_deceased_or_unable_to_continue_in_that_capacity
            - beneficiary_or_account_holder_deceased
            - credit_entry_refused_by_receiver
            - duplicate_entry
            - corporate_customer_advised_not_authorized
          type: string
          x-enum-descriptions:
            - The customer no longer authorizes this transaction. The Nacha return code is R07.
            - The customer asked for the payment to be stopped. This reason is only allowed for debits. The Nacha return code is R08.
            - The customer advises that the debit was unauthorized. The Nacha return code is R10.
            - The payee is deceased. The Nacha return code is R14.
            - The account holder is deceased. The Nacha return code is R15.
            - The customer refused a credit entry. This reason is only allowed for credits. The Nacha return code is R23.
            - The account holder identified this transaction as a duplicate. The Nacha return code is R24.
            - The corporate customer no longer authorizes this transaction. The Nacha return code is R29.
        status:
          description: The lifecycle status of the transfer.
          enum:
            - pending_submitting
            - submitted
          type: string
          x-enum-descriptions:
            - The transfer return is pending submission to the Federal Reserve.
            - The transfer has been submitted to the Federal Reserve.
        submission:
          description: After the return is submitted to FedACH, this will contain supplemental details.
          example:
            submitted_at: 2020-01-31T23:59:59Z
            trace_number: "058349238292834"
          nullable: true
          properties:
            submitted_at:
              description: When the ACH transfer return was sent to FedACH.
              format: date-time
              type: string
            trace_number:
              description: The trace number for the submission.
              type: string
          required:
            - trace_number
            - submitted_at
          title: Inbound ACH Transfer Return Submission
          type: object
          x-title-plural: Inbound ACH Transfer Return Submissions
        transaction_id:
          description: The ID for the transaction refunding the transfer.
          nullable: true
          type: string
        type:
          description: A constant representing the object's type. For this resource it will always be `inbound_ach_transfer_return`.
          enum:
            - inbound_ach_transfer_return
          type: string
      required:
        - id
        - inbound_ach_transfer_transaction_id
        - transaction_id
        - status
        - reason
        - submission
        - type
      title: Inbound ACH Transfer Return
      type: object
      x-tag: Inbound ACH Transfer Returns
      x-title-plural: Inbound ACH Transfer Returns
    inbound_ach_transfer_return_list:
      description: A list of Inbound ACH Transfer Return objects
      example:
        data:
          - class_name: inbound_ach_transfer_return
            id: inbound_ach_transfer_return_fhcxk5huskwhmt7iz0gk
            inbound_ach_transfer_transaction_id: transaction_uyrp7fld2ium70oa7oi
            reason: payment_stopped
            status: submitted
            submission:
              submitted_at: 2020-01-31T23:59:59Z
              trace_number: "058349238292834"
            transaction_id: null
            type: inbound_ach_transfer_return
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/inbound_ach_transfer_return"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: Inbound ACH Transfer Return List
      type: object
      x-title-plural: Inbound ACH Transfer Return Lists
    inbound_ach_transfer_simulation_result:
      description: The results of an inbound ACH Transfer simulation.
      example:
        declined_transaction: null
        transaction:
          account_id: account_in71c4amph0vgo2qllky
          amount: 100
          created_at: 2020-01-31T23:59:59Z
          currency: USD
          description: Frederick S. Holmes
          id: transaction_uyrp7fld2ium70oa7oi
          route_id: account_number_v18nkfqm6afpsrvy82b2
          route_type: account_number
          source:
            category: inbound_ach_transfer
            inbound_ach_transfer:
              amount: 100
              originator_company_descriptive_date: null
              originator_company_discretionary_data: null
              originator_company_entry_description: RESERVE
              originator_company_id: "0987654321"
              originator_company_name: BIG BANK
              receiver_id_number: "12345678900"
              receiver_name: IAN CREASE
              trace_number: "021000038461022"
          type: transaction
        type: inbound_ach_transfer_simulation_result
      properties:
        declined_transaction:
          description: "If the ACH Transfer attempt fails, this will contain the resulting [Declined Transaction](#declined-transactions) object. The Declined Transaction's `source` will be of `category: inbound_ach_transfer`."
          example:
            account_id: account_in71c4amph0vgo2qllky
            amount: 1750
            created_at: 2020-01-31T23:59:59Z
            currency: USD
            description: Frederick S. Holmes
            id: declined_transaction_17jbn0yyhvkt4v4ooym8
            route_id: account_number_v18nkfqm6afpsrvy82b2
            route_type: account_number
            source:
              ach_decline:
                amount: 1750
                originator_company_descriptive_date: null
                originator_company_discretionary_data: null
                originator_company_id: "0987654321"
                originator_company_name: BIG BANK
                reason: insufficient_funds
                receiver_id_number: "12345678900"
                receiver_name: IAN CREASE
                trace_number: "021000038461022"
              category: ach_decline
            type: declined_transaction
          nullable: true
          properties:
            account_id:
              description: The identifier for the Account the Declined Transaction belongs to.
              type: string
            amount:
              description: The Declined Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.
              type: integer
            created_at:
              description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Transaction occured.
              format: date-time
              type: string
            currency:
              description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined Transaction's currency. This will match the currency on the Declined Transcation's Account.
              enum:
                - CAD
                - CHF
                - EUR
                - GBP
                - JPY
                - USD
              type: string
              x-enum-descriptions:
                - Canadian Dollar (CAD)
                - Swiss Franc (CHF)
                - Euro (EUR)
                - British Pound (GBP)
                - Japanese Yen (JPY)
                - US Dollar (USD)
            description:
              description: This is the description the vendor provides.
              type: string
            id:
              description: The Declined Transaction identifier.
              type: string
            route_id:
              description: The identifier for the route this Declined Transaction came through. Routes are things like cards and ACH details.
              nullable: true
              type: string
            route_type:
              description: The type of the route this Declined Transaction came through.
              enum:
                - account_number
                - card
              nullable: true
              type: string
              x-enum-descriptions:
                - An Account Number.
                - A Card.
            source:
              description: This is an object giving more details on the network-level event that caused the Declined Transaction. For example, for a card transaction this lists the merchant's industry and location. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.
              example:
                ach_decline:
                  amount: 1750
                  originator_company_descriptive_date: null
                  originator_company_discretionary_data: null
                  originator_company_id: "0987654321"
                  originator_company_name: BIG BANK
                  reason: insufficient_funds
                  receiver_id_number: "12345678900"
                  receiver_name: IAN CREASE
                  trace_number: "021000038461022"
                category: ach_decline
              properties:
                ach_decline:
                  description: A ACH Decline object. This field will be present in the JSON response if and only if `category` is equal to `ach_decline`.
                  example:
                    amount: 1750
                    originator_company_descriptive_date: null
                    originator_company_discretionary_data: null
                    originator_company_id: "0987654321"
                    originator_company_name: BIG BANK
                    reason: insufficient_funds
                    receiver_id_number: "12345678900"
                    receiver_name: IAN CREASE
                    trace_number: "021000038461022"
                  nullable: true
                  properties:
                    amount:
                      description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    originator_company_descriptive_date:
                      description: ""
                      nullable: true
                      type: string
                    originator_company_discretionary_data:
                      description: ""
                      nullable: true
                      type: string
                    originator_company_id:
                      description: ""
                      type: string
                    originator_company_name:
                      description: ""
                      type: string
                    reason:
                      description: Why the ACH transfer was declined.
                      enum:
                        - ach_route_canceled
                        - ach_route_disabled
                        - breaches_limit
                        - credit_entry_refused_by_receiver
                        - duplicate_return
                        - entity_not_active
                        - group_locked
                        - insufficient_funds
                        - misrouted_return
                        - no_ach_route
                        - originator_request
                        - transaction_not_allowed
                      type: string
                      x-enum-descriptions:
                        - The account number is canceled.
                        - The account number is disabled.
                        - The transaction would cause a limit to be exceeded.
                        - A credit was refused.
                        - Other.
                        - The account's entity is not active.
                        - Your account is inactive.
                        - Your account contains insufficient funds.
                        - Other.
                        - The account number that was debited does not exist.
                        - Other.
                        - The transaction is not allowed per Increase's terms
                    receiver_id_number:
                      description: ""
                      nullable: true
                      type: string
                    receiver_name:
                      description: ""
                      nullable: true
                      type: string
                    trace_number:
                      description: ""
                      type: string
                  required:
                    - amount
                    - originator_company_name
                    - originator_company_descriptive_date
                    - originator_company_discretionary_data
                    - originator_company_id
                    - reason
                    - receiver_id_number
                    - receiver_name
                    - trace_number
                  title: ACH Decline
                  type: object
                  x-title-plural: ACH Declines
                card_decline:
                  description: A Card Decline object. This field will be present in the JSON response if and only if `category` is equal to `card_decline`.
                  example:
                    amount: -1000
                    currency: USD
                    digital_wallet_token_id: null
                    merchant_acceptor_id: "372909060886"
                    merchant_category_code: "5998"
                    merchant_city: "5364086000"
                    merchant_country: USA
                    merchant_descriptor: TENTS R US
                    merchant_state: CA
                    network: visa
                    network_details:
                      visa:
                        electronic_commerce_indicator: secure_electronic_commerce
                        point_of_service_entry_mode: manual
                    real_time_decision_id: null
                    reason: insufficient_funds
                  nullable: true
                  properties:
                    amount:
                      description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    digital_wallet_token_id:
                      description: If the authorization was attempted using a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used.
                      nullable: true
                      type: string
                    merchant_acceptor_id:
                      description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.
                      type: string
                    merchant_category_code:
                      description: The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.
                      nullable: true
                      type: string
                    merchant_city:
                      description: The city the merchant resides in.
                      nullable: true
                      type: string
                    merchant_country:
                      description: The country the merchant resides in.
                      nullable: true
                      type: string
                    merchant_descriptor:
                      description: The merchant descriptor of the merchant the card is transacting with.
                      type: string
                    merchant_state:
                      description: The state the merchant resides in.
                      nullable: true
                      type: string
                    network:
                      description: The payment network used to process this card authorization
                      enum:
                        - visa
                      type: string
                      x-enum-descriptions:
                        - Visa
                    network_details:
                      description: Fields specific to the `network`
                      properties:
                        visa:
                          description: Fields specific to the `visa` network
                          properties:
                            electronic_commerce_indicator:
                              description: For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order.
                              enum:
                                - mail_phone_order
                                - recurring
                                - installment
                                - unknown_mail_phone_order
                                - secure_electronic_commerce
                                - non_authenticated_security_transaction_at_3ds_capable_merchant
                                - non_authenticated_security_transaction
                                - non_secure_transaction
                              nullable: true
                              type: string
                              x-enum-descriptions:
                                - "Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments."
                                - "Recurring transaction: Payment indicator used to indicate a recurring transaction that originates from an acquirer in the US region."
                                - "Installment payment: Payment indicator used to indicate one purchase of goods or services that is billed to the account in multiple charges over a period of time agreed upon by the cardholder and merchant from transactions that originate from an acquirer in the US region."
                                - "Unknown classification: other mail order: Use to indicate that the type of mail/telephone order is unknown."
                                - "Secure electronic commerce transaction: Use to indicate that the electronic commerce transaction has been authenticated using e.g., 3-D Secure"
                                - "Non-authenticated security transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure: Use to identify an electronic commerce transaction where the merchant attempted to authenticate the cardholder using 3-D Secure, but was unable to complete the authentication because the issuer or cardholder does not participate in the 3-D Secure program."
                                - "Non-authenticated security transaction: Use to identify an electronic commerce transaction that uses data encryption for security however , cardholder authentication is not performed using 3-D Secure."
                                - "Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection."
                            point_of_service_entry_mode:
                              description: The method used to enter the cardholder's primary account number and card expiration date
                              enum:
                                - manual
                                - magnetic_stripe_no_cvv
                                - optical_code
                                - integrated_circuit_card
                                - contactless
                                - credential_on_file
                                - magnetic_stripe
                                - contactless_magnetic_stripe
                                - integrated_circuit_card_no_cvv
                              nullable: true
                              type: string
                              x-enum-descriptions:
                                - Manual key entry
                                - Magnetic stripe read, without card verification value
                                - Optical code
                                - Contact chip card
                                - Contactless read of chip card
                                - Transaction iniated using a credential that has previously been stored on file
                                - Magnetic stripe read
                                - Contactless read of magnetic stripe data
                                - Contact chip card, without card verification value
                          required:
                            - electronic_commerce_indicator
                            - point_of_service_entry_mode
                          title: Visa
                          type: object
                          x-title-plural: Visas
                      required:
                        - visa
                      title: Network Details
                      type: object
                      x-title-plural: Network Detailss
                    real_time_decision_id:
                      description: The identifier of the Real-Time Decision sent to approve or decline this transaction.
                      nullable: true
                      type: string
                    reason:
                      description: Why the transaction was declined.
                      enum:
                        - card_not_active
                        - entity_not_active
                        - group_locked
                        - insufficient_funds
                        - cvv2_mismatch
                        - transaction_not_allowed
                        - breaches_limit
                        - webhook_declined
                        - webhook_timed_out
                        - declined_by_stand_in_processing
                        - invalid_physical_card
                        - missing_original_authorization
                      type: string
                      x-enum-descriptions:
                        - The Card was not active.
                        - The account's entity was not active.
                        - The account was inactive.
                        - The Card's Account did not have a sufficient available balance.
                        - The given CVV2 did not match the card's value.
                        - The attempted card transaction is not allowed per Increase's terms.
                        - The transaction was blocked by a Limit.
                        - Your application declined the transaction via webhook.
                        - Your application webhook did not respond without the required timeout.
                        - Declined by stand-in processing.
                        - The card read had an invalid CVV, dCVV, or authorization request cryptogram.
                        - The original card authorization for this incremental authorization does not exist.
                  required:
                    - merchant_acceptor_id
                    - merchant_descriptor
                    - merchant_category_code
                    - merchant_city
                    - merchant_country
                    - network
                    - network_details
                    - amount
                    - currency
                    - reason
                    - merchant_state
                    - real_time_decision_id
                    - digital_wallet_token_id
                  title: Card Decline
                  type: object
                  x-title-plural: Card Declines
                card_route_decline:
                  description: A Deprecated Card Decline object. This field will be present in the JSON response if and only if `category` is equal to `card_route_decline`.
                  example:
                    amount: -1000
                    currency: USD
                    merchant_acceptor_id: "372909060886"
                    merchant_category_code: "5998"
                    merchant_city: "5364086000"
                    merchant_country: USA
                    merchant_descriptor: TENTS R US
                    merchant_state: CA
                  nullable: true
                  properties:
                    amount:
                      description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    merchant_acceptor_id:
                      description: ""
                      type: string
                    merchant_category_code:
                      description: ""
                      nullable: true
                      type: string
                    merchant_city:
                      description: ""
                      nullable: true
                      type: string
                    merchant_country:
                      description: ""
                      type: string
                    merchant_descriptor:
                      description: ""
                      type: string
                    merchant_state:
                      description: ""
                      nullable: true
                      type: string
                  required:
                    - amount
                    - currency
                    - merchant_acceptor_id
                    - merchant_city
                    - merchant_country
                    - merchant_descriptor
                    - merchant_state
                    - merchant_category_code
                  title: Deprecated Card Decline
                  type: object
                  x-title-plural: Deprecated Card Declines
                category:
                  description: The type of decline that took place. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
                  enum:
                    - ach_decline
                    - card_decline
                    - check_decline
                    - inbound_real_time_payments_transfer_decline
                    - international_ach_decline
                    - card_route_decline
                    - other
                  type: string
                  x-enum-descriptions:
                    - The Declined Transaction was created by a ACH Decline object. Details will be under the `ach_decline` object.
                    - The Declined Transaction was created by a Card Decline object. Details will be under the `card_decline` object.
                    - The Declined Transaction was created by a Check Decline object. Details will be under the `check_decline` object.
                    - The Declined Transaction was created by a Inbound Real Time Payments Transfer Decline object. Details will be under the `inbound_real_time_payments_transfer_decline` object.
                    - The Declined Transaction was created by a International ACH Decline object. Details will be under the `international_ach_decline` object.
                    - The Declined Transaction was created by a Deprecated Card Decline object. Details will be under the `card_route_decline` object.
                    - The Declined Transaction was made for an undocumented or deprecated reason.
                check_decline:
                  description: A Check Decline object. This field will be present in the JSON response if and only if `category` is equal to `check_decline`.
                  example:
                    amount: -1000
                    auxiliary_on_us: "99999"
                    reason: insufficient_funds
                  nullable: true
                  properties:
                    amount:
                      description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    auxiliary_on_us:
                      description: ""
                      nullable: true
                      type: string
                    reason:
                      description: Why the check was declined.
                      enum:
                        - ach_route_canceled
                        - ach_route_disabled
                        - breaches_limit
                        - entity_not_active
                        - group_locked
                        - insufficient_funds
                        - unable_to_locate_account
                        - unable_to_process
                        - refer_to_image
                        - stop_payment_requested
                        - returned
                        - duplicate_presentment
                        - not_authorized
                      type: string
                      x-enum-descriptions:
                        - The account number is canceled.
                        - The account number is disabled.
                        - The transaction would cause a limit to be exceeded.
                        - The account's entity is not active.
                        - Your account is inactive.
                        - Your account contains insufficient funds.
                        - Unable to locate account.
                        - Unable to process.
                        - Refer to image.
                        - Stop payment requested for this check.
                        - Check was returned to sender.
                        - The check was a duplicate deposit.
                        - The transaction is not allowed.
                  required:
                    - amount
                    - auxiliary_on_us
                    - reason
                  title: Check Decline
                  type: object
                  x-title-plural: Check Declines
                inbound_real_time_payments_transfer_decline:
                  description: A Inbound Real Time Payments Transfer Decline object. This field will be present in the JSON response if and only if `category` is equal to `inbound_real_time_payments_transfer_decline`.
                  example:
                    amount: 100
                    creditor_name: Ian Crease
                    currency: USD
                    debtor_account_number: "987654321"
                    debtor_name: National Phonograph Company
                    debtor_routing_number: "101050001"
                    reason: account_number_disabled
                    remittance_information: Invoice 29582
                    transaction_identification: 20220501234567891T1BSLZO01745013025
                  nullable: true
                  properties:
                    amount:
                      description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    creditor_name:
                      description: The name the sender of the transfer specified as the recipient of the transfer.
                      type: string
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined transfer's currency. This will always be "USD" for a Real Time Payments transfer.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    debtor_account_number:
                      description: The account number of the account that sent the transfer.
                      type: string
                    debtor_name:
                      description: The name provided by the sender of the transfer.
                      type: string
                    debtor_routing_number:
                      description: The routing number of the account that sent the transfer.
                      type: string
                    reason:
                      description: Why the transfer was declined.
                      enum:
                        - account_number_canceled
                        - account_number_disabled
                        - group_locked
                        - entity_not_active
                        - real_time_payments_not_enabled
                      type: string
                      x-enum-descriptions:
                        - The account number is canceled.
                        - The account number is disabled.
                        - Your account is inactive.
                        - The account's entity is not active.
                        - Your account is not enabled to receive Real Time Payments transfers.
                    remittance_information:
                      description: Additional information included with the transfer.
                      nullable: true
                      type: string
                    transaction_identification:
                      description: The Real Time Payments network identification of the declined transfer.
                      type: string
                  required:
                    - amount
                    - currency
                    - reason
                    - creditor_name
                    - debtor_name
                    - debtor_account_number
                    - debtor_routing_number
                    - transaction_identification
                    - remittance_information
                  title: Inbound Real Time Payments Transfer Decline
                  type: object
                  x-title-plural: Inbound Real Time Payments Transfer Declines
                international_ach_decline:
                  description: A International ACH Decline object. This field will be present in the JSON response if and only if `category` is equal to `international_ach_decline`.
                  example:
                    amount: -1000
                    destination_country_code: US
                    destination_currency_code: USD
                    foreign_exchange_indicator: fixed_to_fixed
                    foreign_exchange_reference: null
                    foreign_exchange_reference_indicator: blank
                    foreign_payment_amount: 199
                    foreign_trace_number: null
                    international_transaction_type_code: internet_initiated
                    originating_currency_code: USD
                    originating_depository_financial_institution_branch_country: US
                    originating_depository_financial_institution_id: "091000019"
                    originating_depository_financial_institution_id_qualifier: national_clearing_system_number
                    originating_depository_financial_institution_name: WELLS FARGO BANK
                    originator_city: BERLIN
                    originator_company_entry_description: RETRY PYMT
                    originator_country: DE
                    originator_identification: 770510487A
                    originator_name: BERGHAIN
                    originator_postal_code: "50825"
                    originator_state_or_province: null
                    originator_street_address: Ruedersdorferstr. 7
                    payment_related_information: null
                    payment_related_information2: null
                    receiver_city: BEVERLY HILLS
                    receiver_country: US
                    receiver_identification_number: "1018790279274"
                    receiver_postal_code: "90210"
                    receiver_state_or_province: CA
                    receiver_street_address: 123 FAKE ST
                    receiving_company_or_individual_name: IAN CREASE
                    receiving_depository_financial_institution_country: US
                    receiving_depository_financial_institution_id: "101050001"
                    receiving_depository_financial_institution_id_qualifier: national_clearing_system_number
                    receiving_depository_financial_institution_name: BLUE RIDGE BANK, NATIONAL ASSOCIATI
                    trace_number: "010202909100090"
                  nullable: true
                  properties:
                    amount:
                      description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    destination_country_code:
                      description: ""
                      type: string
                    destination_currency_code:
                      description: ""
                      type: string
                    foreign_exchange_indicator:
                      description: ""
                      type: string
                    foreign_exchange_reference:
                      description: ""
                      nullable: true
                      type: string
                    foreign_exchange_reference_indicator:
                      description: ""
                      type: string
                    foreign_payment_amount:
                      description: ""
                      type: integer
                    foreign_trace_number:
                      description: ""
                      nullable: true
                      type: string
                    international_transaction_type_code:
                      description: ""
                      type: string
                    originating_currency_code:
                      description: ""
                      type: string
                    originating_depository_financial_institution_branch_country:
                      description: ""
                      type: string
                    originating_depository_financial_institution_id:
                      description: ""
                      type: string
                    originating_depository_financial_institution_id_qualifier:
                      description: ""
                      type: string
                    originating_depository_financial_institution_name:
                      description: ""
                      type: string
                    originator_city:
                      description: ""
                      type: string
                    originator_company_entry_description:
                      description: ""
                      type: string
                    originator_country:
                      description: ""
                      type: string
                    originator_identification:
                      description: ""
                      type: string
                    originator_name:
                      description: ""
                      type: string
                    originator_postal_code:
                      description: ""
                      nullable: true
                      type: string
                    originator_state_or_province:
                      description: ""
                      nullable: true
                      type: string
                    originator_street_address:
                      description: ""
                      type: string
                    payment_related_information:
                      description: ""
                      nullable: true
                      type: string
                    payment_related_information2:
                      description: ""
                      nullable: true
                      type: string
                    receiver_city:
                      description: ""
                      type: string
                    receiver_country:
                      description: ""
                      type: string
                    receiver_identification_number:
                      description: ""
                      nullable: true
                      type: string
                    receiver_postal_code:
                      description: ""
                      nullable: true
                      type: string
                    receiver_state_or_province:
                      description: ""
                      nullable: true
                      type: string
                    receiver_street_address:
                      description: ""
                      type: string
                    receiving_company_or_individual_name:
                      description: ""
                      type: string
                    receiving_depository_financial_institution_country:
                      description: ""
                      type: string
                    receiving_depository_financial_institution_id:
                      description: ""
                      type: string
                    receiving_depository_financial_institution_id_qualifier:
                      description: ""
                      type: string
                    receiving_depository_financial_institution_name:
                      description: ""
                      type: string
                    trace_number:
                      description: ""
                      type: string
                  required:
                    - amount
                    - foreign_exchange_indicator
                    - foreign_exchange_reference_indicator
                    - foreign_exchange_reference
                    - destination_country_code
                    - destination_currency_code
                    - foreign_payment_amount
                    - foreign_trace_number
                    - international_transaction_type_code
                    - originating_currency_code
                    - originating_depository_financial_institution_name
                    - originating_depository_financial_institution_id_qualifier
                    - originating_depository_financial_institution_id
                    - originating_depository_financial_institution_branch_country
                    - originator_city
                    - originator_company_entry_description
                    - originator_country
                    - originator_identification
                    - originator_name
                    - originator_postal_code
                    - originator_street_address
                    - originator_state_or_province
                    - payment_related_information
                    - payment_related_information2
                    - receiver_identification_number
                    - receiver_street_address
                    - receiver_city
                    - receiver_state_or_province
                    - receiver_country
                    - receiver_postal_code
                    - receiving_company_or_individual_name
                    - receiving_depository_financial_institution_name
                    - receiving_depository_financial_institution_id_qualifier
                    - receiving_depository_financial_institution_id
                    - receiving_depository_financial_institution_country
                    - trace_number
                  title: International ACH Decline
                  type: object
                  x-title-plural: International ACH Declines
              required:
                - category
                - ach_decline
                - card_decline
                - check_decline
                - inbound_real_time_payments_transfer_decline
                - international_ach_decline
                - card_route_decline
              title: Declined Transaction Source
              type: object
              x-title-plural: Declined Transaction Sources
            type:
              description: A constant representing the object's type. For this resource it will always be `declined_transaction`.
              enum:
                - declined_transaction
              type: string
          required:
            - account_id
            - amount
            - currency
            - created_at
            - description
            - id
            - route_id
            - route_type
            - source
            - type
          title: Declined Transaction
          type: object
          x-title-plural: Declined Transactions
        transaction:
          description: "If the ACH Transfer attempt succeeds, this will contain the resulting [Transaction](#transactions) object. The Transaction's `source` will be of `category: inbound_ach_transfer`."
          example:
            account_id: account_in71c4amph0vgo2qllky
            amount: 100
            created_at: 2020-01-31T23:59:59Z
            currency: USD
            description: Frederick S. Holmes
            id: transaction_uyrp7fld2ium70oa7oi
            route_id: account_number_v18nkfqm6afpsrvy82b2
            route_type: account_number
            source:
              category: inbound_ach_transfer
              inbound_ach_transfer:
                amount: 100
                originator_company_descriptive_date: null
                originator_company_discretionary_data: null
                originator_company_entry_description: RESERVE
                originator_company_id: "0987654321"
                originator_company_name: BIG BANK
                receiver_id_number: "12345678900"
                receiver_name: IAN CREASE
                trace_number: "021000038461022"
            type: transaction
          nullable: true
          properties:
            account_id:
              description: The identifier for the Account the Transaction belongs to.
              type: string
            amount:
              description: The Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.
              type: integer
            created_at:
              description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Transaction occured.
              format: date-time
              type: string
            currency:
              description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Transaction's currency. This will match the currency on the Transcation's Account.
              enum:
                - CAD
                - CHF
                - EUR
                - GBP
                - JPY
                - USD
              type: string
              x-enum-descriptions:
                - Canadian Dollar (CAD)
                - Swiss Franc (CHF)
                - Euro (EUR)
                - British Pound (GBP)
                - Japanese Yen (JPY)
                - US Dollar (USD)
            description:
              description: For a Transaction related to a transfer, this is the description you provide. For a Transaction related to a payment, this is the description the vendor provides.
              type: string
            id:
              description: The Transaction identifier.
              type: string
            route_id:
              description: The identifier for the route this Transaction came through. Routes are things like cards and ACH details.
              nullable: true
              type: string
            route_type:
              description: The type of the route this Transaction came through.
              enum:
                - account_number
                - card
              nullable: true
              type: string
              x-enum-descriptions:
                - An Account Number.
                - A Card.
            source:
              description: This is an object giving more details on the network-level event that caused the Transaction. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.
              example:
                category: inbound_ach_transfer
                inbound_ach_transfer:
                  amount: 100
                  originator_company_descriptive_date: null
                  originator_company_discretionary_data: null
                  originator_company_entry_description: RESERVE
                  originator_company_id: "0987654321"
                  originator_company_name: BIG BANK
                  receiver_id_number: "12345678900"
                  receiver_name: IAN CREASE
                  trace_number: "021000038461022"
              properties:
                account_transfer_intention:
                  description: A Account Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `account_transfer_intention`.
                  example:
                    amount: 100
                    currency: USD
                    description: Frederick S. Holmes
                    destination_account_id: account_uf16sut2ct5bevmq3eh
                    source_account_id: account_in71c4amph0vgo2qllky
                    transfer_id: account_transfer_7k9qe1ysdgqztnt63l7n
                  nullable: true
                  properties:
                    amount:
                      description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    description:
                      description: The description you chose to give the transfer.
                      type: string
                    destination_account_id:
                      description: The identifier of the Account to where the Account Transfer was sent.
                      type: string
                    source_account_id:
                      description: The identifier of the Account from where the Account Transfer was sent.
                      type: string
                    transfer_id:
                      description: The identifier of the Account Transfer that led to this Pending Transaction.
                      type: string
                  required:
                    - amount
                    - currency
                    - description
                    - destination_account_id
                    - source_account_id
                    - transfer_id
                  title: Account Transfer Intention
                  type: object
                  x-title-plural: Account Transfer Intentions
                ach_check_conversion:
                  description: A ACH Check Conversion object. This field will be present in the JSON response if and only if `category` is equal to `ach_check_conversion`.
                  example:
                    amount: 100
                    file_id: file_makxrc67oh9l6sg7w9yc
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    file_id:
                      description: The identifier of the File containing an image of the returned check.
                      type: string
                  required:
                    - amount
                    - file_id
                  title: ACH Check Conversion
                  type: object
                  x-title-plural: ACH Check Conversions
                ach_check_conversion_return:
                  description: A ACH Check Conversion Return object. This field will be present in the JSON response if and only if `category` is equal to `ach_check_conversion_return`.
                  example:
                    amount: 100
                    return_reason_code: ""
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    return_reason_code:
                      description: Why the transfer was returned.
                      type: string
                  required:
                    - amount
                    - return_reason_code
                  title: ACH Check Conversion Return
                  type: object
                  x-title-plural: ACH Check Conversion Returns
                ach_transfer_intention:
                  description: A ACH Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_intention`.
                  example:
                    account_number: "987654321"
                    amount: 100
                    routing_number: "101050001"
                    statement_descriptor: Frederick S. Holmes
                    transfer_id: account_transfer_7k9qe1ysdgqztnt63l7n
                  nullable: true
                  properties:
                    account_number:
                      description: ""
                      type: string
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    routing_number:
                      description: ""
                      type: string
                    statement_descriptor:
                      description: ""
                      type: string
                    transfer_id:
                      description: The identifier of the ACH Transfer that led to this Transaction.
                      type: string
                  required:
                    - amount
                    - account_number
                    - routing_number
                    - statement_descriptor
                    - transfer_id
                  title: ACH Transfer Intention
                  type: object
                  x-title-plural: ACH Transfer Intentions
                ach_transfer_rejection:
                  description: A ACH Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_rejection`.
                  example:
                    transfer_id: account_transfer_7k9qe1ysdgqztnt63l7n
                  nullable: true
                  properties:
                    transfer_id:
                      description: The identifier of the ACH Transfer that led to this Transaction.
                      type: string
                  required:
                    - transfer_id
                  title: ACH Transfer Rejection
                  type: object
                  x-title-plural: ACH Transfer Rejections
                ach_transfer_return:
                  description: A ACH Transfer Return object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_return`.
                  example:
                    created_at: 2020-01-31T23:59:59Z
                    return_reason_code: insufficient_fund
                    transaction_id: transaction_uyrp7fld2ium70oa7oi
                    transfer_id: ach_transfer_uoxatyh3lt5evrsdvo7q
                  nullable: true
                  properties:
                    created_at:
                      description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.
                      format: date-time
                      type: string
                    return_reason_code:
                      description: Why the ACH Transfer was returned.
                      enum:
                        - insufficient_fund
                        - no_account
                        - account_closed
                        - invalid_account_number_structure
                        - account_frozen_entry_returned_per_ofac_instruction
                        - credit_entry_refused_by_receiver
                        - unauthorized_debit_to_consumer_account_using_corporate_sec_code
                        - corporate_customer_advised_not_authorized
                        - payment_stopped
                        - non_transaction_account
                        - uncollected_funds
                        - routing_number_check_digit_error
                        - customer_advised_unauthorized_improper_ineligible_or_incomplete
                        - amount_field_error
                        - authorization_revoked_by_customer
                        - invalid_ach_routing_number
                        - file_record_edit_criteria
                        - enr_invalid_individual_name
                        - returned_per_odfi_request
                        - addenda_error
                        - limited_participation_dfi
                        - incorrectly_coded_outbound_international_payment
                        - other
                      type: string
                      x-enum-descriptions:
                        - Insufficient funds in the source account.
                        - The account does not exist or the receiving bank was unable to locate it.
                        - The account is closed.
                        - The account number is invalid at the receiving bank.
                        - The account was frozen per the Office of Foreign Assets Control.
                        - The receiving bank account refused a credit transfer.
                        - The receiving bank rejected because of an incorrect Standard Entry Class code.
                        - The corporate customer reversed the transfer.
                        - The receiving bank stopped payment on this transfer.
                        - The receiving bank account does not perform transfers.
                        - The receiving bank account does not have enough available balance for the transfer.
                        - The routing number is incorrect.
                        - The customer reversed the transfer.
                        - The amount field is incorrect or too large.
                        - The customer who initiated the transfer revoked authorization.
                        - The routing number is invalid.
                        - The receiving bank is unable to process a field in the transfer.
                        - The individual name field was invalid.
                        - The originating financial institution reversed the transfer.
                        - The addenda record is incorrect or missing.
                        - The receiving bank's regulatory supervisor has limited their participation.
                        - The outbound international ACH transfer was incorrect.
                        - Any other ACH return reason.
                    transaction_id:
                      description: The identifier of the Tranasaction associated with this return.
                      type: string
                    transfer_id:
                      description: The identifier of the ACH Transfer associated with this return.
                      type: string
                  required:
                    - created_at
                    - return_reason_code
                    - transfer_id
                    - transaction_id
                  title: ACH Transfer Return
                  type: object
                  x-title-plural: ACH Transfer Returns
                card_dispute_acceptance:
                  description: A Card Dispute Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `card_dispute_acceptance`.
                  example:
                    accepted_at: 2020-01-31T23:59:59Z
                    card_dispute_id: card_dispute_h9sc95nbl1cgltpp7men
                    transaction_id: transaction_uyrp7fld2ium70oa7oi
                  nullable: true
                  properties:
                    accepted_at:
                      description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was accepted.
                      format: date-time
                      type: string
                    card_dispute_id:
                      description: The identifier of the Card Dispute that was accepted.
                      type: string
                    transaction_id:
                      description: The identifier of the Transaction that was created to return the disputed funds to your account.
                      type: string
                  required:
                    - accepted_at
                    - card_dispute_id
                    - transaction_id
                  title: Card Dispute Acceptance
                  type: object
                  x-title-plural: Card Dispute Acceptances
                card_refund:
                  description: A Card Refund object. This field will be present in the JSON response if and only if `category` is equal to `card_refund`.
                  example:
                    amount: 100
                    card_settlement_transaction_id: transaction_uyrp7fld2ium70oa7oi
                    currency: USD
                    id: card_refund_imgc2xwplh6t4r3gn16e
                    merchant_acceptor_id: "5665270011000168"
                    merchant_category_code: "5734"
                    merchant_city: New York
                    merchant_country: US
                    merchant_name: AMAZON.COM
                    merchant_state: NY
                    type: card_refund
                  nullable: true
                  properties:
                    amount:
                      description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    card_settlement_transaction_id:
                      description: The identifier for the Transaction this refunds, if any.
                      nullable: true
                      type: string
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    id:
                      description: The Card Refund identifier.
                      type: string
                    merchant_acceptor_id:
                      description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.
                      nullable: true
                      type: string
                    merchant_category_code:
                      description: The 4-digit MCC describing the merchant's business.
                      type: string
                    merchant_city:
                      description: The city the merchant resides in.
                      nullable: true
                      type: string
                    merchant_country:
                      description: The country the merchant resides in.
                      type: string
                    merchant_name:
                      description: The name of the merchant.
                      nullable: true
                      type: string
                    merchant_state:
                      description: The state the merchant resides in.
                      nullable: true
                      type: string
                    type:
                      description: A constant representing the object's type. For this resource it will always be `card_refund`.
                      enum:
                        - card_refund
                      type: string
                  required:
                    - id
                    - amount
                    - currency
                    - card_settlement_transaction_id
                    - merchant_acceptor_id
                    - merchant_city
                    - merchant_state
                    - merchant_country
                    - merchant_name
                    - merchant_category_code
                    - type
                  title: Card Refund
                  type: object
                  x-title-plural: Card Refunds
                card_revenue_payment:
                  description: A Card Revenue Payment object. This field will be present in the JSON response if and only if `category` is equal to `card_revenue_payment`.
                  example:
                    amount: 100
                    currency: USD
                    period_end: 2023-04-30T23:59:59Z
                    period_start: 2023-04-01T00:00:00Z
                    transacted_on_account_id: account_in71c4amph0vgo2qllky
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    period_end:
                      description: The end of the period for which this transaction paid interest.
                      format: date-time
                      type: string
                    period_start:
                      description: The start of the period for which this transaction paid interest.
                      format: date-time
                      type: string
                    transacted_on_account_id:
                      description: The account the card belonged to.
                      nullable: true
                      type: string
                  required:
                    - amount
                    - currency
                    - period_start
                    - period_end
                    - transacted_on_account_id
                  title: Card Revenue Payment
                  type: object
                  x-title-plural: Card Revenue Payments
                card_route_refund:
                  description: A Deprecated Card Refund object. This field will be present in the JSON response if and only if `category` is equal to `card_route_refund`.
                  example:
                    amount: 1000
                    currency: USD
                    merchant_acceptor_id: "372909060886"
                    merchant_category_code: "5998"
                    merchant_city: "5364086000"
                    merchant_country: USA
                    merchant_descriptor: TENTS R US
                    merchant_state: CA
                  nullable: true
                  properties:
                    amount:
                      description: The refunded amount in the minor unit of the refunded currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the refund currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    merchant_acceptor_id:
                      description: ""
                      type: string
                    merchant_category_code:
                      description: ""
                      nullable: true
                      type: string
                    merchant_city:
                      description: ""
                      nullable: true
                      type: string
                    merchant_country:
                      description: ""
                      type: string
                    merchant_descriptor:
                      description: ""
                      type: string
                    merchant_state:
                      description: ""
                      nullable: true
                      type: string
                  required:
                    - amount
                    - currency
                    - merchant_acceptor_id
                    - merchant_city
                    - merchant_country
                    - merchant_descriptor
                    - merchant_state
                    - merchant_category_code
                  title: Deprecated Card Refund
                  type: object
                  x-title-plural: Deprecated Card Refunds
                card_route_settlement:
                  description: A Deprecated Card Settlement object. This field will be present in the JSON response if and only if `category` is equal to `card_route_settlement`.
                  example:
                    amount: 1000
                    currency: USD
                    merchant_acceptor_id: "372909060886"
                    merchant_category_code: "5998"
                    merchant_city: "5364086000"
                    merchant_country: USA
                    merchant_descriptor: TENTS R US
                    merchant_state: CA
                  nullable: true
                  properties:
                    amount:
                      description: The settled amount in the minor unit of the settlement currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the settlement currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    merchant_acceptor_id:
                      description: ""
                      type: string
                    merchant_category_code:
                      description: ""
                      nullable: true
                      type: string
                    merchant_city:
                      description: ""
                      nullable: true
                      type: string
                    merchant_country:
                      description: ""
                      nullable: true
                      type: string
                    merchant_descriptor:
                      description: ""
                      type: string
                    merchant_state:
                      description: ""
                      nullable: true
                      type: string
                  required:
                    - amount
                    - currency
                    - merchant_acceptor_id
                    - merchant_city
                    - merchant_country
                    - merchant_descriptor
                    - merchant_state
                    - merchant_category_code
                  title: Deprecated Card Settlement
                  type: object
                  x-title-plural: Deprecated Card Settlements
                card_settlement:
                  description: A Card Settlement object. This field will be present in the JSON response if and only if `category` is equal to `card_settlement`.
                  example:
                    amount: 100
                    card_authorization: null
                    currency: USD
                    id: card_settlement_khv5kfeu0vndj291omg6
                    merchant_acceptor_id: "5665270011000168"
                    merchant_category_code: "5734"
                    merchant_city: New York
                    merchant_country: US
                    merchant_name: AMAZON.COM
                    merchant_state: NY
                    pending_transaction_id: null
                    presentment_amount: 100
                    presentment_currency: USD
                    type: card_settlement
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's settlement currency. For dollars, for example, this is cents.
                      type: integer
                    card_authorization:
                      description: The Card Authorization that was created prior to this Card Settlement, if on exists.
                      nullable: true
                      type: string
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's settlement currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    id:
                      description: The Card Settlement identifier.
                      type: string
                    merchant_acceptor_id:
                      description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.
                      nullable: true
                      type: string
                    merchant_category_code:
                      description: The 4-digit MCC describing the merchant's business.
                      type: string
                    merchant_city:
                      description: The city the merchant resides in.
                      nullable: true
                      type: string
                    merchant_country:
                      description: The country the merchant resides in.
                      type: string
                    merchant_name:
                      description: The name of the merchant.
                      nullable: true
                      type: string
                    merchant_state:
                      description: The state the merchant resides in.
                      nullable: true
                      type: string
                    pending_transaction_id:
                      description: The identifier of the Pending Transaction associated with this Transaction.
                      nullable: true
                      type: string
                    presentment_amount:
                      description: The amount in the minor unit of the transaction's presentment currency.
                      type: integer
                    presentment_currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's presentment currency.
                      type: string
                    type:
                      description: A constant representing the object's type. For this resource it will always be `card_settlement`.
                      enum:
                        - card_settlement
                      type: string
                  required:
                    - id
                    - card_authorization
                    - amount
                    - currency
                    - presentment_amount
                    - presentment_currency
                    - merchant_acceptor_id
                    - merchant_city
                    - merchant_state
                    - merchant_country
                    - merchant_name
                    - merchant_category_code
                    - pending_transaction_id
                    - type
                  title: Card Settlement
                  type: object
                  x-title-plural: Card Settlements
                category:
                  description: The type of transaction that took place. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
                  enum:
                    - account_transfer_intention
                    - ach_check_conversion_return
                    - ach_check_conversion
                    - ach_transfer_intention
                    - ach_transfer_rejection
                    - ach_transfer_return
                    - card_dispute_acceptance
                    - card_refund
                    - card_settlement
                    - card_revenue_payment
                    - check_deposit_acceptance
                    - check_deposit_return
                    - check_transfer_intention
                    - check_transfer_return
                    - check_transfer_rejection
                    - check_transfer_stop_payment_request
                    - dispute_resolution
                    - empyreal_cash_deposit
                    - fee_payment
                    - inbound_ach_transfer
                    - inbound_ach_transfer_return_intention
                    - inbound_check
                    - inbound_international_ach_transfer
                    - inbound_real_time_payments_transfer_confirmation
                    - inbound_wire_drawdown_payment_reversal
                    - inbound_wire_drawdown_payment
                    - inbound_wire_reversal
                    - inbound_wire_transfer
                    - interest_payment
                    - internal_general_ledger_transaction
                    - internal_source
                    - card_route_refund
                    - card_route_settlement
                    - real_time_payments_transfer_acknowledgement
                    - sample_funds
                    - wire_drawdown_payment_intention
                    - wire_drawdown_payment_rejection
                    - wire_transfer_intention
                    - wire_transfer_rejection
                    - other
                  type: string
                  x-enum-descriptions:
                    - The Transaction was created by a Account Transfer Intention object. Details will be under the `account_transfer_intention` object.
                    - The Transaction was created by a ACH Check Conversion Return object. Details will be under the `ach_check_conversion_return` object.
                    - The Transaction was created by a ACH Check Conversion object. Details will be under the `ach_check_conversion` object.
                    - The Transaction was created by a ACH Transfer Intention object. Details will be under the `ach_transfer_intention` object.
                    - The Transaction was created by a ACH Transfer Rejection object. Details will be under the `ach_transfer_rejection` object.
                    - The Transaction was created by a ACH Transfer Return object. Details will be under the `ach_transfer_return` object.
                    - The Transaction was created by a Card Dispute Acceptance object. Details will be under the `card_dispute_acceptance` object.
                    - The Transaction was created by a Card Refund object. Details will be under the `card_refund` object.
                    - The Transaction was created by a Card Settlement object. Details will be under the `card_settlement` object.
                    - The Transaction was created by a Card Revenue Payment object. Details will be under the `card_revenue_payment` object.
                    - The Transaction was created by a Check Deposit Acceptance object. Details will be under the `check_deposit_acceptance` object.
                    - The Transaction was created by a Check Deposit Return object. Details will be under the `check_deposit_return` object.
                    - The Transaction was created by a Check Transfer Intention object. Details will be under the `check_transfer_intention` object.
                    - The Transaction was created by a Check Transfer Return object. Details will be under the `check_transfer_return` object.
                    - The Transaction was created by a Check Transfer Rejection object. Details will be under the `check_transfer_rejection` object.
                    - The Transaction was created by a Check Transfer Stop Payment Request object. Details will be under the `check_transfer_stop_payment_request` object.
                    - The Transaction was created by a Dispute Resolution object. Details will be under the `dispute_resolution` object.
                    - The Transaction was created by a Empyreal Cash Deposit object. Details will be under the `empyreal_cash_deposit` object.
                    - The Transaction was created by a Fee Payment object. Details will be under the `fee_payment` object.
                    - The Transaction was created by a Inbound ACH Transfer object. Details will be under the `inbound_ach_transfer` object.
                    - The Transaction was created by a Inbound ACH Transfer Return Intention object. Details will be under the `inbound_ach_transfer_return_intention` object.
                    - The Transaction was created by a Inbound Check object. Details will be under the `inbound_check` object.
                    - The Transaction was created by a Inbound International ACH Transfer object. Details will be under the `inbound_international_ach_transfer` object.
                    - The Transaction was created by a Inbound Real Time Payments Transfer Confirmation object. Details will be under the `inbound_real_time_payments_transfer_confirmation` object.
                    - The Transaction was created by a Inbound Wire Drawdown Payment Reversal object. Details will be under the `inbound_wire_drawdown_payment_reversal` object.
                    - The Transaction was created by a Inbound Wire Drawdown Payment object. Details will be under the `inbound_wire_drawdown_payment` object.
                    - The Transaction was created by a Inbound Wire Reversal object. Details will be under the `inbound_wire_reversal` object.
                    - The Transaction was created by a Inbound Wire Transfer object. Details will be under the `inbound_wire_transfer` object.
                    - The Transaction was created by a Interest Payment object. Details will be under the `interest_payment` object.
                    - The Transaction was created by a Internal General Ledger Transaction object. Details will be under the `internal_general_ledger_transaction` object.
                    - The Transaction was created by a Internal Source object. Details will be under the `internal_source` object.
                    - The Transaction was created by a Deprecated Card Refund object. Details will be under the `card_route_refund` object.
                    - The Transaction was created by a Deprecated Card Settlement object. Details will be under the `card_route_settlement` object.
                    - The Transaction was created by a Real Time Payments Transfer Acknowledgement object. Details will be under the `real_time_payments_transfer_acknowledgement` object.
                    - The Transaction was created by a Sample Funds object. Details will be under the `sample_funds` object.
                    - The Transaction was created by a Wire Drawdown Payment Intention object. Details will be under the `wire_drawdown_payment_intention` object.
                    - The Transaction was created by a Wire Drawdown Payment Rejection object. Details will be under the `wire_drawdown_payment_rejection` object.
                    - The Transaction was created by a Wire Transfer Intention object. Details will be under the `wire_transfer_intention` object.
                    - The Transaction was created by a Wire Transfer Rejection object. Details will be under the `wire_transfer_rejection` object.
                    - The Transaction was made for an undocumented or deprecated reason.
                check_deposit_acceptance:
                  description: A Check Deposit Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_acceptance`.
                  example:
                    account_number: "987654321"
                    amount: 100
                    auxiliary_on_us: "101"
                    check_deposit_id: check_deposit_f06n9gpg7sxn8t19lfc1
                    currency: USD
                    routing_number: "101050001"
                    serial_number: null
                  nullable: true
                  properties:
                    account_number:
                      description: The account number printed on the check.
                      type: string
                    amount:
                      description: The amount to be deposited in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    auxiliary_on_us:
                      description: An additional line of metadata printed on the check. This typically includes the check number for business checks.
                      nullable: true
                      type: string
                    check_deposit_id:
                      description: The ID of the Check Deposit that was accepted.
                      type: string
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    routing_number:
                      description: The routing number printed on the check.
                      type: string
                    serial_number:
                      description: The check serial number, if present, for consumer checks. For business checks, the serial number is usually in the `auxiliary_on_us` field.
                      nullable: true
                      type: string
                  required:
                    - amount
                    - currency
                    - account_number
                    - routing_number
                    - auxiliary_on_us
                    - serial_number
                    - check_deposit_id
                  title: Check Deposit Acceptance
                  type: object
                  x-title-plural: Check Deposit Acceptances
                check_deposit_return:
                  description: A Check Deposit Return object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_return`.
                  example:
                    amount: 100
                    check_deposit_id: check_deposit_f06n9gpg7sxn8t19lfc1
                    currency: USD
                    return_reason: insufficient_funds
                    returned_at: 2020-01-31T23:59:59Z
                    transaction_id: transaction_uyrp7fld2ium70oa7oi
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    check_deposit_id:
                      description: The identifier of the Check Deposit that was returned.
                      type: string
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    return_reason:
                      description: ""
                      enum:
                        - ach_conversion_not_supported
                        - closed_account
                        - duplicate_submission
                        - insufficient_funds
                        - no_account
                        - not_authorized
                        - stale_dated
                        - stop_payment
                        - unknown_reason
                        - unmatched_details
                        - unreadable_image
                      type: string
                      x-enum-descriptions:
                        - The check doesn't allow ACH conversion.
                        - The account is closed.
                        - The check has already been deposited.
                        - Insufficient funds
                        - No account was found matching the check details.
                        - The check was not authorized.
                        - The check is too old.
                        - The payment has been stopped by the account holder.
                        - The reason for the return is unknown.
                        - The image doesn't match the details submitted.
                        - The image could not be read.
                    returned_at:
                      description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check deposit was returned.
                      format: date-time
                      type: string
                    transaction_id:
                      description: The identifier of the transaction that reversed the original check deposit transaction.
                      type: string
                  required:
                    - amount
                    - returned_at
                    - currency
                    - check_deposit_id
                    - transaction_id
                    - return_reason
                  title: Check Deposit Return
                  type: object
                  x-title-plural: Check Deposit Returns
                check_transfer_intention:
                  description: A Check Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_intention`.
                  example:
                    address_city: New York
                    address_line1: 33 Liberty Street
                    address_line2: null
                    address_state: NY
                    address_zip: "10045"
                    amount: 1000
                    currency: USD
                    recipient_name: Ian Crease
                    transfer_id: check_transfer_30b43acfu9vw8fyc4f5
                  nullable: true
                  properties:
                    address_city:
                      description: The city of the check's destination.
                      type: string
                    address_line1:
                      description: The street address of the check's destination.
                      type: string
                    address_line2:
                      description: The second line of the address of the check's destination.
                      nullable: true
                      type: string
                    address_state:
                      description: The state of the check's destination.
                      type: string
                    address_zip:
                      description: The postal code of the check's destination.
                      type: string
                    amount:
                      description: The transfer amount in USD cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    recipient_name:
                      description: The name that will be printed on the check.
                      type: string
                    transfer_id:
                      description: The identifier of the Check Transfer with which this is associated.
                      type: string
                  required:
                    - address_line1
                    - address_line2
                    - address_city
                    - address_state
                    - address_zip
                    - amount
                    - currency
                    - recipient_name
                    - transfer_id
                  title: Check Transfer Intention
                  type: object
                  x-title-plural: Check Transfer Intentions
                check_transfer_rejection:
                  description: A Check Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_rejection`.
                  example:
                    transfer_id: check_transfer_30b43acfu9vw8fyc4f5
                  nullable: true
                  properties:
                    transfer_id:
                      description: The identifier of the Check Transfer that led to this Transaction.
                      type: string
                  required:
                    - transfer_id
                  title: Check Transfer Rejection
                  type: object
                  x-title-plural: Check Transfer Rejections
                check_transfer_return:
                  description: A Check Transfer Return object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_return`.
                  example:
                    file_id: null
                    reason: mail_delivery_failure
                    returned_at: 2020-01-31T23:59:59Z
                    transaction_id: transaction_uyrp7fld2ium70oa7oi
                    transfer_id: check_transfer_30b43acfu9vw8fyc4f5
                  nullable: true
                  properties:
                    file_id:
                      description: If available, a document with additional information about the return.
                      nullable: true
                      type: string
                    reason:
                      description: The reason why the check was returned.
                      enum:
                        - mail_delivery_failure
                        - refused_by_recipient
                      type: string
                      x-enum-descriptions:
                        - Mail delivery failed and the check was returned to sender.
                        - The check arrived and the recipient refused to deposit it.
                    returned_at:
                      description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check was returned.
                      format: date-time
                      type: string
                    transaction_id:
                      description: The identifier of the Transaction that was created to credit you for the returned check.
                      nullable: true
                      type: string
                    transfer_id:
                      description: The identifier of the returned Check Transfer.
                      type: string
                  required:
                    - transfer_id
                    - returned_at
                    - file_id
                    - reason
                    - transaction_id
                  title: Check Transfer Return
                  type: object
                  x-title-plural: Check Transfer Returns
                check_transfer_stop_payment_request:
                  description: A Check Transfer Stop Payment Request object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_stop_payment_request`.
                  example:
                    requested_at: 2020-01-31T23:59:59Z
                    transaction_id: transaction_uyrp7fld2ium70oa7oi
                    transfer_id: check_transfer_30b43acfu9vw8fyc4f5
                    type: check_transfer_stop_payment_request
                  nullable: true
                  properties:
                    requested_at:
                      description: The time the stop-payment was requested.
                      format: date-time
                      type: string
                    transaction_id:
                      description: The transaction ID of the corresponding credit transaction.
                      type: string
                    transfer_id:
                      description: The ID of the check transfer that was stopped.
                      type: string
                    type:
                      description: A constant representing the object's type. For this resource it will always be `check_transfer_stop_payment_request`.
                      enum:
                        - check_transfer_stop_payment_request
                      type: string
                  required:
                    - transfer_id
                    - transaction_id
                    - requested_at
                    - type
                  title: Check Transfer Stop Payment Request
                  type: object
                  x-title-plural: Check Transfer Stop Payment Requests
                dispute_resolution:
                  description: A Dispute Resolution object. This field will be present in the JSON response if and only if `category` is equal to `dispute_resolution`.
                  example:
                    amount: 100
                    currency: USD
                    disputed_transaction_id: transaction_uyrp7fld2ium70oa7oi
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    disputed_transaction_id:
                      description: The identifier of the Transaction that was disputed.
                      type: string
                  required:
                    - amount
                    - currency
                    - disputed_transaction_id
                  title: Dispute Resolution
                  type: object
                  x-title-plural: Dispute Resolutions
                empyreal_cash_deposit:
                  description: A Empyreal Cash Deposit object. This field will be present in the JSON response if and only if `category` is equal to `empyreal_cash_deposit`.
                  example:
                    amount: 100
                    bag_id: "12345"
                    deposit_date: 2020-01-31T23:59:59Z
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    bag_id:
                      description: ""
                      type: string
                    deposit_date:
                      description: ""
                      format: date-time
                      type: string
                  required:
                    - amount
                    - bag_id
                    - deposit_date
                  title: Empyreal Cash Deposit
                  type: object
                  x-title-plural: Empyreal Cash Deposits
                fee_payment:
                  description: A Fee Payment object. This field will be present in the JSON response if and only if `category` is equal to `fee_payment`.
                  example:
                    amount: 100
                    currency: USD
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                  required:
                    - amount
                    - currency
                  title: Fee Payment
                  type: object
                  x-title-plural: Fee Payments
                inbound_ach_transfer:
                  description: A Inbound ACH Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_ach_transfer`.
                  example:
                    amount: 100
                    originator_company_descriptive_date: null
                    originator_company_discretionary_data: null
                    originator_company_entry_description: RESERVE
                    originator_company_id: "0987654321"
                    originator_company_name: BIG BANK
                    receiver_id_number: "12345678900"
                    receiver_name: IAN CREASE
                    trace_number: "021000038461022"
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    originator_company_descriptive_date:
                      description: ""
                      nullable: true
                      type: string
                    originator_company_discretionary_data:
                      description: ""
                      nullable: true
                      type: string
                    originator_company_entry_description:
                      description: ""
                      type: string
                    originator_company_id:
                      description: ""
                      type: string
                    originator_company_name:
                      description: ""
                      type: string
                    receiver_id_number:
                      description: ""
                      nullable: true
                      type: string
                    receiver_name:
                      description: ""
                      nullable: true
                      type: string
                    trace_number:
                      description: ""
                      type: string
                  required:
                    - amount
                    - originator_company_name
                    - originator_company_descriptive_date
                    - originator_company_discretionary_data
                    - originator_company_entry_description
                    - originator_company_id
                    - receiver_id_number
                    - receiver_name
                    - trace_number
                  title: Inbound ACH Transfer
                  type: object
                  x-title-plural: Inbound ACH Transfers
                inbound_check:
                  description: A Inbound Check object. This field will be present in the JSON response if and only if `category` is equal to `inbound_check`.
                  example:
                    amount: 100
                    check_front_image_file_id: file_makxrc67oh9l6sg7w9yc
                    check_number: "       00000123"
                    check_rear_image_file_id: file_makxrc67oh9l6sg7w9yc
                    currency: USD
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    check_front_image_file_id:
                      description: ""
                      nullable: true
                      type: string
                    check_number:
                      description: ""
                      nullable: true
                      type: string
                    check_rear_image_file_id:
                      description: ""
                      nullable: true
                      type: string
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                  required:
                    - amount
                    - currency
                    - check_number
                    - check_front_image_file_id
                    - check_rear_image_file_id
                  title: Inbound Check
                  type: object
                  x-title-plural: Inbound Checks
                inbound_international_ach_transfer:
                  description: A Inbound International ACH Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_international_ach_transfer`.
                  example:
                    amount: -1000
                    destination_country_code: US
                    destination_currency_code: USD
                    foreign_exchange_indicator: fixed_to_fixed
                    foreign_exchange_reference: null
                    foreign_exchange_reference_indicator: blank
                    foreign_payment_amount: 199
                    foreign_trace_number: null
                    international_transaction_type_code: internet_initiated
                    originating_currency_code: USD
                    originating_depository_financial_institution_branch_country: US
                    originating_depository_financial_institution_id: "091000019"
                    originating_depository_financial_institution_id_qualifier: national_clearing_system_number
                    originating_depository_financial_institution_name: WELLS FARGO BANK
                    originator_city: BERLIN
                    originator_company_entry_description: RETRY PYMT
                    originator_country: DE
                    originator_identification: 770510487A
                    originator_name: BERGHAIN
                    originator_postal_code: "50825"
                    originator_state_or_province: null
                    originator_street_address: Ruedersdorferstr. 7
                    payment_related_information: null
                    payment_related_information2: null
                    receiver_city: BEVERLY HILLS
                    receiver_country: US
                    receiver_identification_number: "1018790279274"
                    receiver_postal_code: "90210"
                    receiver_state_or_province: CA
                    receiver_street_address: 123 FAKE ST
                    receiving_company_or_individual_name: IAN CREASE
                    receiving_depository_financial_institution_country: US
                    receiving_depository_financial_institution_id: "101050001"
                    receiving_depository_financial_institution_id_qualifier: national_clearing_system_number
                    receiving_depository_financial_institution_name: BLUE RIDGE BANK, NATIONAL ASSOCIATI
                    trace_number: "010202909100090"
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    destination_country_code:
                      description: ""
                      type: string
                    destination_currency_code:
                      description: ""
                      type: string
                    foreign_exchange_indicator:
                      description: ""
                      type: string
                    foreign_exchange_reference:
                      description: ""
                      nullable: true
                      type: string
                    foreign_exchange_reference_indicator:
                      description: ""
                      type: string
                    foreign_payment_amount:
                      description: ""
                      type: integer
                    foreign_trace_number:
                      description: ""
                      nullable: true
                      type: string
                    international_transaction_type_code:
                      description: ""
                      type: string
                    originating_currency_code:
                      description: ""
                      type: string
                    originating_depository_financial_institution_branch_country:
                      description: ""
                      type: string
                    originating_depository_financial_institution_id:
                      description: ""
                      type: string
                    originating_depository_financial_institution_id_qualifier:
                      description: ""
                      type: string
                    originating_depository_financial_institution_name:
                      description: ""
                      type: string
                    originator_city:
                      description: ""
                      type: string
                    originator_company_entry_description:
                      description: ""
                      type: string
                    originator_country:
                      description: ""
                      type: string
                    originator_identification:
                      description: ""
                      type: string
                    originator_name:
                      description: ""
                      type: string
                    originator_postal_code:
                      description: ""
                      nullable: true
                      type: string
                    originator_state_or_province:
                      description: ""
                      nullable: true
                      type: string
                    originator_street_address:
                      description: ""
                      type: string
                    payment_related_information:
                      description: ""
                      nullable: true
                      type: string
                    payment_related_information2:
                      description: ""
                      nullable: true
                      type: string
                    receiver_city:
                      description: ""
                      type: string
                    receiver_country:
                      description: ""
                      type: string
                    receiver_identification_number:
                      description: ""
                      nullable: true
                      type: string
                    receiver_postal_code:
                      description: ""
                      nullable: true
                      type: string
                    receiver_state_or_province:
                      description: ""
                      nullable: true
                      type: string
                    receiver_street_address:
                      description: ""
                      type: string
                    receiving_company_or_individual_name:
                      description: ""
                      type: string
                    receiving_depository_financial_institution_country:
                      description: ""
                      type: string
                    receiving_depository_financial_institution_id:
                      description: ""
                      type: string
                    receiving_depository_financial_institution_id_qualifier:
                      description: ""
                      type: string
                    receiving_depository_financial_institution_name:
                      description: ""
                      type: string
                    trace_number:
                      description: ""
                      type: string
                  required:
                    - amount
                    - foreign_exchange_indicator
                    - foreign_exchange_reference_indicator
                    - foreign_exchange_reference
                    - destination_country_code
                    - destination_currency_code
                    - foreign_payment_amount
                    - foreign_trace_number
                    - international_transaction_type_code
                    - originating_currency_code
                    - originating_depository_financial_institution_name
                    - originating_depository_financial_institution_id_qualifier
                    - originating_depository_financial_institution_id
                    - originating_depository_financial_institution_branch_country
                    - originator_city
                    - originator_company_entry_description
                    - originator_country
                    - originator_identification
                    - originator_name
                    - originator_postal_code
                    - originator_street_address
                    - originator_state_or_province
                    - payment_related_information
                    - payment_related_information2
                    - receiver_identification_number
                    - receiver_street_address
                    - receiver_city
                    - receiver_state_or_province
                    - receiver_country
                    - receiver_postal_code
                    - receiving_company_or_individual_name
                    - receiving_depository_financial_institution_name
                    - receiving_depository_financial_institution_id_qualifier
                    - receiving_depository_financial_institution_id
                    - receiving_depository_financial_institution_country
                    - trace_number
                  title: Inbound International ACH Transfer
                  type: object
                  x-title-plural: Inbound International ACH Transfers
                inbound_real_time_payments_transfer_confirmation:
                  description: A Inbound Real Time Payments Transfer Confirmation object. This field will be present in the JSON response if and only if `category` is equal to `inbound_real_time_payments_transfer_confirmation`.
                  example:
                    amount: 100
                    creditor_name: Ian Crease
                    currency: USD
                    debtor_account_number: "987654321"
                    debtor_name: National Phonograph Company
                    debtor_routing_number: "101050001"
                    remittance_information: Invoice 29582
                    transaction_identification: 20220501234567891T1BSLZO01745013025
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transfer's currency. For dollars, for example, this is cents.
                      type: integer
                    creditor_name:
                      description: The name the sender of the transfer specified as the recipient of the transfer.
                      type: string
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's currency. This will always be "USD" for a Real Time Payments transfer.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    debtor_account_number:
                      description: The account number of the account that sent the transfer.
                      type: string
                    debtor_name:
                      description: The name provided by the sender of the transfer.
                      type: string
                    debtor_routing_number:
                      description: The routing number of the account that sent the transfer.
                      type: string
                    remittance_information:
                      description: Additional information included with the transfer.
                      nullable: true
                      type: string
                    transaction_identification:
                      description: The Real Time Payments network identification of the transfer
                      type: string
                  required:
                    - amount
                    - currency
                    - creditor_name
                    - debtor_name
                    - debtor_account_number
                    - debtor_routing_number
                    - transaction_identification
                    - remittance_information
                  title: Inbound Real Time Payments Transfer Confirmation
                  type: object
                  x-title-plural: Inbound Real Time Payments Transfer Confirmations
                inbound_wire_drawdown_payment:
                  description: A Inbound Wire Drawdown Payment object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
                  example:
                    amount: 100
                    beneficiary_address_line1: null
                    beneficiary_address_line2: null
                    beneficiary_address_line3: null
                    beneficiary_name: null
                    beneficiary_reference: null
                    description: Inbound wire drawdown payment
                    input_message_accountability_data: null
                    originator_address_line1: null
                    originator_address_line2: null
                    originator_address_line3: null
                    originator_name: null
                    originator_to_beneficiary_information: null
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    beneficiary_address_line1:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_address_line2:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_address_line3:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_name:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_reference:
                      description: ""
                      nullable: true
                      type: string
                    description:
                      description: ""
                      type: string
                    input_message_accountability_data:
                      description: ""
                      nullable: true
                      type: string
                    originator_address_line1:
                      description: ""
                      nullable: true
                      type: string
                    originator_address_line2:
                      description: ""
                      nullable: true
                      type: string
                    originator_address_line3:
                      description: ""
                      nullable: true
                      type: string
                    originator_name:
                      description: ""
                      nullable: true
                      type: string
                    originator_to_beneficiary_information:
                      description: ""
                      nullable: true
                      type: string
                  required:
                    - amount
                    - beneficiary_address_line1
                    - beneficiary_address_line2
                    - beneficiary_address_line3
                    - beneficiary_name
                    - beneficiary_reference
                    - description
                    - input_message_accountability_data
                    - originator_address_line1
                    - originator_address_line2
                    - originator_address_line3
                    - originator_name
                    - originator_to_beneficiary_information
                  title: Inbound Wire Drawdown Payment
                  type: object
                  x-title-plural: Inbound Wire Drawdown Payments
                inbound_wire_drawdown_payment_reversal:
                  description: A Inbound Wire Drawdown Payment Reversal object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_drawdown_payment_reversal`.
                  example:
                    amount: 12345
                    description: Inbound wire reversal 2022021100335128
                    input_cycle_date: 2022-02-11
                    input_message_accountability_data: 20220211B6B7HU2R011023
                    input_sequence_number: "11023"
                    input_source: B6B7HU2R
                    previous_message_input_cycle_date: 2022-02-10
                    previous_message_input_message_accountability_data: 20220210MMQFMP0P000007
                    previous_message_input_sequence_number: "3"
                    previous_message_input_source: MMQFMP0P
                  nullable: true
                  properties:
                    amount:
                      description: The amount that was reversed.
                      type: integer
                    description:
                      description: The description on the reversal message from Fedwire.
                      type: string
                    input_cycle_date:
                      description: The Fedwire cycle date for the wire reversal.
                      format: date
                      type: string
                    input_message_accountability_data:
                      description: The Fedwire transaction identifier.
                      type: string
                    input_sequence_number:
                      description: The Fedwire sequence number.
                      type: string
                    input_source:
                      description: The Fedwire input source identifier.
                      type: string
                    previous_message_input_cycle_date:
                      description: The Fedwire cycle date for the wire transfer that was reversed.
                      format: date
                      type: string
                    previous_message_input_message_accountability_data:
                      description: The Fedwire transaction identifier for the wire transfer that was reversed.
                      type: string
                    previous_message_input_sequence_number:
                      description: The Fedwire sequence number for the wire transfer that was reversed.
                      type: string
                    previous_message_input_source:
                      description: The Fedwire input source identifier for the wire transfer that was reversed.
                      type: string
                  required:
                    - amount
                    - description
                    - input_cycle_date
                    - input_sequence_number
                    - input_source
                    - input_message_accountability_data
                    - previous_message_input_message_accountability_data
                    - previous_message_input_cycle_date
                    - previous_message_input_sequence_number
                    - previous_message_input_source
                  title: Inbound Wire Drawdown Payment Reversal
                  type: object
                  x-title-plural: Inbound Wire Drawdown Payment Reversals
                inbound_wire_reversal:
                  description: A Inbound Wire Reversal object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_reversal`.
                  example:
                    amount: 12345
                    created_at: 2020-01-31T23:59:59Z
                    description: Inbound wire reversal 2022021100335128
                    financial_institution_to_financial_institution_information: null
                    input_cycle_date: 2022-02-11
                    input_message_accountability_data: 20220211B6B7HU2R011023
                    input_sequence_number: "11023"
                    input_source: B6B7HU2R
                    previous_message_input_cycle_date: 2022-02-10
                    previous_message_input_message_accountability_data: 20220210MMQFMP0P000007
                    previous_message_input_sequence_number: "3"
                    previous_message_input_source: MMQFMP0P
                    receiver_financial_institution_information: null
                    transaction_id: transaction_uyrp7fld2ium70oa7oi
                  nullable: true
                  properties:
                    amount:
                      description: The amount that was reversed.
                      type: integer
                    created_at:
                      description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the reversal was created.
                      format: date-time
                      type: string
                    description:
                      description: The description on the reversal message from Fedwire.
                      type: string
                    financial_institution_to_financial_institution_information:
                      description: Additional financial institution information included in the wire reversal.
                      nullable: true
                      type: string
                    input_cycle_date:
                      description: The Fedwire cycle date for the wire reversal.
                      format: date
                      type: string
                    input_message_accountability_data:
                      description: The Fedwire transaction identifier.
                      type: string
                    input_sequence_number:
                      description: The Fedwire sequence number.
                      type: string
                    input_source:
                      description: The Fedwire input source identifier.
                      type: string
                    previous_message_input_cycle_date:
                      description: The Fedwire cycle date for the wire transfer that was reversed.
                      format: date
                      type: string
                    previous_message_input_message_accountability_data:
                      description: The Fedwire transaction identifier for the wire transfer that was reversed.
                      type: string
                    previous_message_input_sequence_number:
                      description: The Fedwire sequence number for the wire transfer that was reversed.
                      type: string
                    previous_message_input_source:
                      description: The Fedwire input source identifier for the wire transfer that was reversed.
                      type: string
                    receiver_financial_institution_information:
                      description: Information included in the wire reversal for the receiving financial institution.
                      nullable: true
                      type: string
                    transaction_id:
                      description: The ID for the Transaction associated with the transfer reversal.
                      nullable: true
                      type: string
                  required:
                    - amount
                    - created_at
                    - description
                    - input_cycle_date
                    - input_sequence_number
                    - input_source
                    - input_message_accountability_data
                    - previous_message_input_message_accountability_data
                    - previous_message_input_cycle_date
                    - previous_message_input_sequence_number
                    - previous_message_input_source
                    - receiver_financial_institution_information
                    - financial_institution_to_financial_institution_information
                    - transaction_id
                  title: Inbound Wire Reversal
                  type: object
                  x-title-plural: Inbound Wire Reversals
                inbound_wire_transfer:
                  description: A Inbound Wire Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_transfer`.
                  example:
                    amount: 100
                    beneficiary_address_line1: null
                    beneficiary_address_line2: null
                    beneficiary_address_line3: null
                    beneficiary_name: null
                    beneficiary_reference: null
                    description: Inbound wire transfer
                    input_message_accountability_data: null
                    originator_address_line1: null
                    originator_address_line2: null
                    originator_address_line3: null
                    originator_name: null
                    originator_to_beneficiary_information: null
                    originator_to_beneficiary_information_line1: null
                    originator_to_beneficiary_information_line2: null
                    originator_to_beneficiary_information_line3: null
                    originator_to_beneficiary_information_line4: null
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    beneficiary_address_line1:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_address_line2:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_address_line3:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_name:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_reference:
                      description: ""
                      nullable: true
                      type: string
                    description:
                      description: ""
                      type: string
                    input_message_accountability_data:
                      description: ""
                      nullable: true
                      type: string
                    originator_address_line1:
                      description: ""
                      nullable: true
                      type: string
                    originator_address_line2:
                      description: ""
                      nullable: true
                      type: string
                    originator_address_line3:
                      description: ""
                      nullable: true
                      type: string
                    originator_name:
                      description: ""
                      nullable: true
                      type: string
                    originator_to_beneficiary_information:
                      description: ""
                      nullable: true
                      type: string
                    originator_to_beneficiary_information_line1:
                      description: ""
                      nullable: true
                      type: string
                    originator_to_beneficiary_information_line2:
                      description: ""
                      nullable: true
                      type: string
                    originator_to_beneficiary_information_line3:
                      description: ""
                      nullable: true
                      type: string
                    originator_to_beneficiary_information_line4:
                      description: ""
                      nullable: true
                      type: string
                  required:
                    - amount
                    - beneficiary_address_line1
                    - beneficiary_address_line2
                    - beneficiary_address_line3
                    - beneficiary_name
                    - beneficiary_reference
                    - description
                    - input_message_accountability_data
                    - originator_address_line1
                    - originator_address_line2
                    - originator_address_line3
                    - originator_name
                    - originator_to_beneficiary_information_line1
                    - originator_to_beneficiary_information_line2
                    - originator_to_beneficiary_information_line3
                    - originator_to_beneficiary_information_line4
                    - originator_to_beneficiary_information
                  title: Inbound Wire Transfer
                  type: object
                  x-title-plural: Inbound Wire Transfers
                interest_payment:
                  description: A Interest Payment object. This field will be present in the JSON response if and only if `category` is equal to `interest_payment`.
                  example:
                    accrued_on_account_id: account_in71c4amph0vgo2qllky
                    amount: 100
                    currency: USD
                    period_end: 2023-04-30T23:59:59Z
                    period_start: 2023-04-01T00:00:00Z
                  nullable: true
                  properties:
                    accrued_on_account_id:
                      description: The account on which the interest was accrued.
                      nullable: true
                      type: string
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    period_end:
                      description: The end of the period for which this transaction paid interest.
                      format: date-time
                      type: string
                    period_start:
                      description: The start of the period for which this transaction paid interest.
                      format: date-time
                      type: string
                  required:
                    - amount
                    - currency
                    - period_start
                    - period_end
                    - accrued_on_account_id
                  title: Interest Payment
                  type: object
                  x-title-plural: Interest Payments
                internal_source:
                  description: A Internal Source object. This field will be present in the JSON response if and only if `category` is equal to `internal_source`.
                  example:
                    amount: 100
                    currency: USD
                    reason: sample_funds
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    reason:
                      description: ""
                      enum:
                        - bank_migration
                        - cashback
                        - empyreal_adjustment
                        - error
                        - error_correction
                        - fees
                        - interest
                        - sample_funds
                        - sample_funds_return
                      type: string
                      x-enum-descriptions:
                        - Bank Migration
                        - Cashback
                        - Empyreal adjustment
                        - Error
                        - Error correction
                        - Fees
                        - Interest
                        - Sample funds
                        - Sample funds return
                  required:
                    - amount
                    - currency
                    - reason
                  title: Internal Source
                  type: object
                  x-title-plural: Internal Sources
                real_time_payments_transfer_acknowledgement:
                  description: A Real Time Payments Transfer Acknowledgement object. This field will be present in the JSON response if and only if `category` is equal to `real_time_payments_transfer_acknowledgement`.
                  example:
                    amount: 100
                    destination_account_number: "987654321"
                    destination_routing_number: "101050001"
                    remittance_information: Invoice 29582
                    transfer_id: real_time_payments_transfer_iyuhl5kdn7ssmup83mvq
                  nullable: true
                  properties:
                    amount:
                      description: The transfer amount in USD cents.
                      type: integer
                    destination_account_number:
                      description: The destination account number.
                      type: string
                    destination_routing_number:
                      description: The American Bankers' Association (ABA) Routing Transit Number (RTN).
                      type: string
                    remittance_information:
                      description: Unstructured information that will show on the recipient's bank statement.
                      type: string
                    transfer_id:
                      description: The identifier of the Real Time Payments Transfer that led to this Transaction.
                      type: string
                  required:
                    - amount
                    - destination_account_number
                    - destination_routing_number
                    - remittance_information
                    - transfer_id
                  title: Real Time Payments Transfer Acknowledgement
                  type: object
                  x-title-plural: Real Time Payments Transfer Acknowledgements
                sample_funds:
                  description: A Sample Funds object. This field will be present in the JSON response if and only if `category` is equal to `sample_funds`.
                  example:
                    originator: dashboard
                  nullable: true
                  properties:
                    originator:
                      description: Where the sample funds came from.
                      type: string
                  required:
                    - originator
                  title: Sample Funds
                  type: object
                  x-title-plural: Sample Fundss
                wire_drawdown_payment_intention:
                  description: A Wire Drawdown Payment Intention object. This field will be present in the JSON response if and only if `category` is equal to `wire_drawdown_payment_intention`.
                  example:
                    account_number: "987654321"
                    amount: 100
                    message_to_recipient: HELLO
                    routing_number: "101050001"
                    transfer_id: wire_transfer_5akynk7dqsq25qwk9q2u
                  nullable: true
                  properties:
                    account_number:
                      description: ""
                      type: string
                    amount:
                      description: The transfer amount in USD cents.
                      type: integer
                    message_to_recipient:
                      description: ""
                      type: string
                    routing_number:
                      description: ""
                      type: string
                    transfer_id:
                      description: ""
                      type: string
                  required:
                    - amount
                    - account_number
                    - routing_number
                    - message_to_recipient
                    - transfer_id
                  title: Wire Drawdown Payment Intention
                  type: object
                  x-title-plural: Wire Drawdown Payment Intentions
                wire_drawdown_payment_rejection:
                  description: A Wire Drawdown Payment Rejection object. This field will be present in the JSON response if and only if `category` is equal to `wire_drawdown_payment_rejection`.
                  example:
                    transfer_id: wire_transfer_5akynk7dqsq25qwk9q2u
                  nullable: true
                  properties:
                    transfer_id:
                      description: ""
                      type: string
                  required:
                    - transfer_id
                  title: Wire Drawdown Payment Rejection
                  type: object
                  x-title-plural: Wire Drawdown Payment Rejections
                wire_transfer_intention:
                  description: A Wire Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_intention`.
                  example:
                    account_number: "987654321"
                    amount: 100
                    message_to_recipient: HELLO
                    routing_number: "101050001"
                    transfer_id: wire_transfer_5akynk7dqsq25qwk9q2u
                  nullable: true
                  properties:
                    account_number:
                      description: The destination account number.
                      type: string
                    amount:
                      description: The transfer amount in USD cents.
                      type: integer
                    message_to_recipient:
                      description: The message that will show on the recipient's bank statement.
                      type: string
                    routing_number:
                      description: The American Bankers' Association (ABA) Routing Transit Number (RTN).
                      type: string
                    transfer_id:
                      description: ""
                      type: string
                  required:
                    - amount
                    - account_number
                    - routing_number
                    - message_to_recipient
                    - transfer_id
                  title: Wire Transfer Intention
                  type: object
                  x-title-plural: Wire Transfer Intentions
                wire_transfer_rejection:
                  description: A Wire Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_rejection`.
                  example:
                    transfer_id: wire_transfer_5akynk7dqsq25qwk9q2u
                  nullable: true
                  properties:
                    transfer_id:
                      description: ""
                      type: string
                  required:
                    - transfer_id
                  title: Wire Transfer Rejection
                  type: object
                  x-title-plural: Wire Transfer Rejections
              required:
                - category
                - account_transfer_intention
                - ach_check_conversion_return
                - ach_check_conversion
                - ach_transfer_intention
                - ach_transfer_rejection
                - ach_transfer_return
                - card_dispute_acceptance
                - card_refund
                - card_settlement
                - card_revenue_payment
                - check_deposit_acceptance
                - check_deposit_return
                - check_transfer_intention
                - check_transfer_return
                - check_transfer_rejection
                - check_transfer_stop_payment_request
                - dispute_resolution
                - empyreal_cash_deposit
                - fee_payment
                - inbound_ach_transfer
                - inbound_check
                - inbound_international_ach_transfer
                - inbound_real_time_payments_transfer_confirmation
                - inbound_wire_drawdown_payment_reversal
                - inbound_wire_drawdown_payment
                - inbound_wire_reversal
                - inbound_wire_transfer
                - interest_payment
                - internal_source
                - card_route_refund
                - card_route_settlement
                - real_time_payments_transfer_acknowledgement
                - sample_funds
                - wire_drawdown_payment_intention
                - wire_drawdown_payment_rejection
                - wire_transfer_intention
                - wire_transfer_rejection
              title: Transaction Source
              type: object
              x-title-plural: Transaction Sources
            type:
              description: A constant representing the object's type. For this resource it will always be `transaction`.
              enum:
                - transaction
              type: string
          required:
            - account_id
            - amount
            - currency
            - created_at
            - description
            - id
            - route_id
            - route_type
            - source
            - type
          title: Transaction
          type: object
          x-title-plural: Transactions
        type:
          description: A constant representing the object's type. For this resource it will always be `inbound_ach_transfer_simulation_result`.
          enum:
            - inbound_ach_transfer_simulation_result
          type: string
      required:
        - transaction
        - declined_transaction
        - type
      title: Inbound ACH Transfer Simulation Result
      type: object
      x-title-plural: Inbound ACH Transfer Simulation Results
    inbound_card_authorization_simulation_result:
      description: The results of a Card Authorization simulation.
      example:
        declined_transaction: null
        pending_transaction:
          account_id: account_in71c4amph0vgo2qllky
          amount: 100
          completed_at: null
          created_at: 2020-01-31T23:59:59Z
          currency: USD
          description: Frederick S. Holmes
          id: pending_transaction_k1sfetcau2qbvjbzgju4
          route_id: card_oubs0hwk5rn6knuecxg2
          route_type: card
          source:
            card_authorization:
              amount: 100
              currency: USD
              digital_wallet_token_id: null
              id: card_authorization_6iqxap6ivd0fo5eu3i8x
              merchant_acceptor_id: "5665270011000168"
              merchant_category_code: "5734"
              merchant_city: New York
              merchant_country: US
              merchant_descriptor: AMAZON.COM
              network: visa
              network_details:
                visa:
                  electronic_commerce_indicator: secure_electronic_commerce
                  point_of_service_entry_mode: manual
              real_time_decision_id: null
              type: card_authorization
            category: card_authorization
          status: pending
          type: pending_transaction
        type: inbound_card_authorization_simulation_result
      properties:
        declined_transaction:
          description: "If the authorization attempt fails, this will contain the resulting [Declined Transaction](#declined-transactions) object. The Declined Transaction's `source` will be of `category: card_decline`."
          example:
            account_id: account_in71c4amph0vgo2qllky
            amount: 1750
            created_at: 2020-01-31T23:59:59Z
            currency: USD
            description: Frederick S. Holmes
            id: declined_transaction_17jbn0yyhvkt4v4ooym8
            route_id: account_number_v18nkfqm6afpsrvy82b2
            route_type: account_number
            source:
              ach_decline:
                amount: 1750
                originator_company_descriptive_date: null
                originator_company_discretionary_data: null
                originator_company_id: "0987654321"
                originator_company_name: BIG BANK
                reason: insufficient_funds
                receiver_id_number: "12345678900"
                receiver_name: IAN CREASE
                trace_number: "021000038461022"
              category: ach_decline
            type: declined_transaction
          nullable: true
          properties:
            account_id:
              description: The identifier for the Account the Declined Transaction belongs to.
              type: string
            amount:
              description: The Declined Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.
              type: integer
            created_at:
              description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Transaction occured.
              format: date-time
              type: string
            currency:
              description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined Transaction's currency. This will match the currency on the Declined Transcation's Account.
              enum:
                - CAD
                - CHF
                - EUR
                - GBP
                - JPY
                - USD
              type: string
              x-enum-descriptions:
                - Canadian Dollar (CAD)
                - Swiss Franc (CHF)
                - Euro (EUR)
                - British Pound (GBP)
                - Japanese Yen (JPY)
                - US Dollar (USD)
            description:
              description: This is the description the vendor provides.
              type: string
            id:
              description: The Declined Transaction identifier.
              type: string
            route_id:
              description: The identifier for the route this Declined Transaction came through. Routes are things like cards and ACH details.
              nullable: true
              type: string
            route_type:
              description: The type of the route this Declined Transaction came through.
              enum:
                - account_number
                - card
              nullable: true
              type: string
              x-enum-descriptions:
                - An Account Number.
                - A Card.
            source:
              description: This is an object giving more details on the network-level event that caused the Declined Transaction. For example, for a card transaction this lists the merchant's industry and location. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.
              example:
                ach_decline:
                  amount: 1750
                  originator_company_descriptive_date: null
                  originator_company_discretionary_data: null
                  originator_company_id: "0987654321"
                  originator_company_name: BIG BANK
                  reason: insufficient_funds
                  receiver_id_number: "12345678900"
                  receiver_name: IAN CREASE
                  trace_number: "021000038461022"
                category: ach_decline
              properties:
                ach_decline:
                  description: A ACH Decline object. This field will be present in the JSON response if and only if `category` is equal to `ach_decline`.
                  example:
                    amount: 1750
                    originator_company_descriptive_date: null
                    originator_company_discretionary_data: null
                    originator_company_id: "0987654321"
                    originator_company_name: BIG BANK
                    reason: insufficient_funds
                    receiver_id_number: "12345678900"
                    receiver_name: IAN CREASE
                    trace_number: "021000038461022"
                  nullable: true
                  properties:
                    amount:
                      description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    originator_company_descriptive_date:
                      description: ""
                      nullable: true
                      type: string
                    originator_company_discretionary_data:
                      description: ""
                      nullable: true
                      type: string
                    originator_company_id:
                      description: ""
                      type: string
                    originator_company_name:
                      description: ""
                      type: string
                    reason:
                      description: Why the ACH transfer was declined.
                      enum:
                        - ach_route_canceled
                        - ach_route_disabled
                        - breaches_limit
                        - credit_entry_refused_by_receiver
                        - duplicate_return
                        - entity_not_active
                        - group_locked
                        - insufficient_funds
                        - misrouted_return
                        - no_ach_route
                        - originator_request
                        - transaction_not_allowed
                      type: string
                      x-enum-descriptions:
                        - The account number is canceled.
                        - The account number is disabled.
                        - The transaction would cause a limit to be exceeded.
                        - A credit was refused.
                        - Other.
                        - The account's entity is not active.
                        - Your account is inactive.
                        - Your account contains insufficient funds.
                        - Other.
                        - The account number that was debited does not exist.
                        - Other.
                        - The transaction is not allowed per Increase's terms
                    receiver_id_number:
                      description: ""
                      nullable: true
                      type: string
                    receiver_name:
                      description: ""
                      nullable: true
                      type: string
                    trace_number:
                      description: ""
                      type: string
                  required:
                    - amount
                    - originator_company_name
                    - originator_company_descriptive_date
                    - originator_company_discretionary_data
                    - originator_company_id
                    - reason
                    - receiver_id_number
                    - receiver_name
                    - trace_number
                  title: ACH Decline
                  type: object
                  x-title-plural: ACH Declines
                card_decline:
                  description: A Card Decline object. This field will be present in the JSON response if and only if `category` is equal to `card_decline`.
                  example:
                    amount: -1000
                    currency: USD
                    digital_wallet_token_id: null
                    merchant_acceptor_id: "372909060886"
                    merchant_category_code: "5998"
                    merchant_city: "5364086000"
                    merchant_country: USA
                    merchant_descriptor: TENTS R US
                    merchant_state: CA
                    network: visa
                    network_details:
                      visa:
                        electronic_commerce_indicator: secure_electronic_commerce
                        point_of_service_entry_mode: manual
                    real_time_decision_id: null
                    reason: insufficient_funds
                  nullable: true
                  properties:
                    amount:
                      description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    digital_wallet_token_id:
                      description: If the authorization was attempted using a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used.
                      nullable: true
                      type: string
                    merchant_acceptor_id:
                      description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.
                      type: string
                    merchant_category_code:
                      description: The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.
                      nullable: true
                      type: string
                    merchant_city:
                      description: The city the merchant resides in.
                      nullable: true
                      type: string
                    merchant_country:
                      description: The country the merchant resides in.
                      nullable: true
                      type: string
                    merchant_descriptor:
                      description: The merchant descriptor of the merchant the card is transacting with.
                      type: string
                    merchant_state:
                      description: The state the merchant resides in.
                      nullable: true
                      type: string
                    network:
                      description: The payment network used to process this card authorization
                      enum:
                        - visa
                      type: string
                      x-enum-descriptions:
                        - Visa
                    network_details:
                      description: Fields specific to the `network`
                      properties:
                        visa:
                          description: Fields specific to the `visa` network
                          properties:
                            electronic_commerce_indicator:
                              description: For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order.
                              enum:
                                - mail_phone_order
                                - recurring
                                - installment
                                - unknown_mail_phone_order
                                - secure_electronic_commerce
                                - non_authenticated_security_transaction_at_3ds_capable_merchant
                                - non_authenticated_security_transaction
                                - non_secure_transaction
                              nullable: true
                              type: string
                              x-enum-descriptions:
                                - "Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments."
                                - "Recurring transaction: Payment indicator used to indicate a recurring transaction that originates from an acquirer in the US region."
                                - "Installment payment: Payment indicator used to indicate one purchase of goods or services that is billed to the account in multiple charges over a period of time agreed upon by the cardholder and merchant from transactions that originate from an acquirer in the US region."
                                - "Unknown classification: other mail order: Use to indicate that the type of mail/telephone order is unknown."
                                - "Secure electronic commerce transaction: Use to indicate that the electronic commerce transaction has been authenticated using e.g., 3-D Secure"
                                - "Non-authenticated security transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure: Use to identify an electronic commerce transaction where the merchant attempted to authenticate the cardholder using 3-D Secure, but was unable to complete the authentication because the issuer or cardholder does not participate in the 3-D Secure program."
                                - "Non-authenticated security transaction: Use to identify an electronic commerce transaction that uses data encryption for security however , cardholder authentication is not performed using 3-D Secure."
                                - "Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection."
                            point_of_service_entry_mode:
                              description: The method used to enter the cardholder's primary account number and card expiration date
                              enum:
                                - manual
                                - magnetic_stripe_no_cvv
                                - optical_code
                                - integrated_circuit_card
                                - contactless
                                - credential_on_file
                                - magnetic_stripe
                                - contactless_magnetic_stripe
                                - integrated_circuit_card_no_cvv
                              nullable: true
                              type: string
                              x-enum-descriptions:
                                - Manual key entry
                                - Magnetic stripe read, without card verification value
                                - Optical code
                                - Contact chip card
                                - Contactless read of chip card
                                - Transaction iniated using a credential that has previously been stored on file
                                - Magnetic stripe read
                                - Contactless read of magnetic stripe data
                                - Contact chip card, without card verification value
                          required:
                            - electronic_commerce_indicator
                            - point_of_service_entry_mode
                          title: Visa
                          type: object
                          x-title-plural: Visas
                      required:
                        - visa
                      title: Network Details
                      type: object
                      x-title-plural: Network Detailss
                    real_time_decision_id:
                      description: The identifier of the Real-Time Decision sent to approve or decline this transaction.
                      nullable: true
                      type: string
                    reason:
                      description: Why the transaction was declined.
                      enum:
                        - card_not_active
                        - entity_not_active
                        - group_locked
                        - insufficient_funds
                        - cvv2_mismatch
                        - transaction_not_allowed
                        - breaches_limit
                        - webhook_declined
                        - webhook_timed_out
                        - declined_by_stand_in_processing
                        - invalid_physical_card
                        - missing_original_authorization
                      type: string
                      x-enum-descriptions:
                        - The Card was not active.
                        - The account's entity was not active.
                        - The account was inactive.
                        - The Card's Account did not have a sufficient available balance.
                        - The given CVV2 did not match the card's value.
                        - The attempted card transaction is not allowed per Increase's terms.
                        - The transaction was blocked by a Limit.
                        - Your application declined the transaction via webhook.
                        - Your application webhook did not respond without the required timeout.
                        - Declined by stand-in processing.
                        - The card read had an invalid CVV, dCVV, or authorization request cryptogram.
                        - The original card authorization for this incremental authorization does not exist.
                  required:
                    - merchant_acceptor_id
                    - merchant_descriptor
                    - merchant_category_code
                    - merchant_city
                    - merchant_country
                    - network
                    - network_details
                    - amount
                    - currency
                    - reason
                    - merchant_state
                    - real_time_decision_id
                    - digital_wallet_token_id
                  title: Card Decline
                  type: object
                  x-title-plural: Card Declines
                card_route_decline:
                  description: A Deprecated Card Decline object. This field will be present in the JSON response if and only if `category` is equal to `card_route_decline`.
                  example:
                    amount: -1000
                    currency: USD
                    merchant_acceptor_id: "372909060886"
                    merchant_category_code: "5998"
                    merchant_city: "5364086000"
                    merchant_country: USA
                    merchant_descriptor: TENTS R US
                    merchant_state: CA
                  nullable: true
                  properties:
                    amount:
                      description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    merchant_acceptor_id:
                      description: ""
                      type: string
                    merchant_category_code:
                      description: ""
                      nullable: true
                      type: string
                    merchant_city:
                      description: ""
                      nullable: true
                      type: string
                    merchant_country:
                      description: ""
                      type: string
                    merchant_descriptor:
                      description: ""
                      type: string
                    merchant_state:
                      description: ""
                      nullable: true
                      type: string
                  required:
                    - amount
                    - currency
                    - merchant_acceptor_id
                    - merchant_city
                    - merchant_country
                    - merchant_descriptor
                    - merchant_state
                    - merchant_category_code
                  title: Deprecated Card Decline
                  type: object
                  x-title-plural: Deprecated Card Declines
                category:
                  description: The type of decline that took place. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
                  enum:
                    - ach_decline
                    - card_decline
                    - check_decline
                    - inbound_real_time_payments_transfer_decline
                    - international_ach_decline
                    - card_route_decline
                    - other
                  type: string
                  x-enum-descriptions:
                    - The Declined Transaction was created by a ACH Decline object. Details will be under the `ach_decline` object.
                    - The Declined Transaction was created by a Card Decline object. Details will be under the `card_decline` object.
                    - The Declined Transaction was created by a Check Decline object. Details will be under the `check_decline` object.
                    - The Declined Transaction was created by a Inbound Real Time Payments Transfer Decline object. Details will be under the `inbound_real_time_payments_transfer_decline` object.
                    - The Declined Transaction was created by a International ACH Decline object. Details will be under the `international_ach_decline` object.
                    - The Declined Transaction was created by a Deprecated Card Decline object. Details will be under the `card_route_decline` object.
                    - The Declined Transaction was made for an undocumented or deprecated reason.
                check_decline:
                  description: A Check Decline object. This field will be present in the JSON response if and only if `category` is equal to `check_decline`.
                  example:
                    amount: -1000
                    auxiliary_on_us: "99999"
                    reason: insufficient_funds
                  nullable: true
                  properties:
                    amount:
                      description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    auxiliary_on_us:
                      description: ""
                      nullable: true
                      type: string
                    reason:
                      description: Why the check was declined.
                      enum:
                        - ach_route_canceled
                        - ach_route_disabled
                        - breaches_limit
                        - entity_not_active
                        - group_locked
                        - insufficient_funds
                        - unable_to_locate_account
                        - unable_to_process
                        - refer_to_image
                        - stop_payment_requested
                        - returned
                        - duplicate_presentment
                        - not_authorized
                      type: string
                      x-enum-descriptions:
                        - The account number is canceled.
                        - The account number is disabled.
                        - The transaction would cause a limit to be exceeded.
                        - The account's entity is not active.
                        - Your account is inactive.
                        - Your account contains insufficient funds.
                        - Unable to locate account.
                        - Unable to process.
                        - Refer to image.
                        - Stop payment requested for this check.
                        - Check was returned to sender.
                        - The check was a duplicate deposit.
                        - The transaction is not allowed.
                  required:
                    - amount
                    - auxiliary_on_us
                    - reason
                  title: Check Decline
                  type: object
                  x-title-plural: Check Declines
                inbound_real_time_payments_transfer_decline:
                  description: A Inbound Real Time Payments Transfer Decline object. This field will be present in the JSON response if and only if `category` is equal to `inbound_real_time_payments_transfer_decline`.
                  example:
                    amount: 100
                    creditor_name: Ian Crease
                    currency: USD
                    debtor_account_number: "987654321"
                    debtor_name: National Phonograph Company
                    debtor_routing_number: "101050001"
                    reason: account_number_disabled
                    remittance_information: Invoice 29582
                    transaction_identification: 20220501234567891T1BSLZO01745013025
                  nullable: true
                  properties:
                    amount:
                      description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    creditor_name:
                      description: The name the sender of the transfer specified as the recipient of the transfer.
                      type: string
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined transfer's currency. This will always be "USD" for a Real Time Payments transfer.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    debtor_account_number:
                      description: The account number of the account that sent the transfer.
                      type: string
                    debtor_name:
                      description: The name provided by the sender of the transfer.
                      type: string
                    debtor_routing_number:
                      description: The routing number of the account that sent the transfer.
                      type: string
                    reason:
                      description: Why the transfer was declined.
                      enum:
                        - account_number_canceled
                        - account_number_disabled
                        - group_locked
                        - entity_not_active
                        - real_time_payments_not_enabled
                      type: string
                      x-enum-descriptions:
                        - The account number is canceled.
                        - The account number is disabled.
                        - Your account is inactive.
                        - The account's entity is not active.
                        - Your account is not enabled to receive Real Time Payments transfers.
                    remittance_information:
                      description: Additional information included with the transfer.
                      nullable: true
                      type: string
                    transaction_identification:
                      description: The Real Time Payments network identification of the declined transfer.
                      type: string
                  required:
                    - amount
                    - currency
                    - reason
                    - creditor_name
                    - debtor_name
                    - debtor_account_number
                    - debtor_routing_number
                    - transaction_identification
                    - remittance_information
                  title: Inbound Real Time Payments Transfer Decline
                  type: object
                  x-title-plural: Inbound Real Time Payments Transfer Declines
                international_ach_decline:
                  description: A International ACH Decline object. This field will be present in the JSON response if and only if `category` is equal to `international_ach_decline`.
                  example:
                    amount: -1000
                    destination_country_code: US
                    destination_currency_code: USD
                    foreign_exchange_indicator: fixed_to_fixed
                    foreign_exchange_reference: null
                    foreign_exchange_reference_indicator: blank
                    foreign_payment_amount: 199
                    foreign_trace_number: null
                    international_transaction_type_code: internet_initiated
                    originating_currency_code: USD
                    originating_depository_financial_institution_branch_country: US
                    originating_depository_financial_institution_id: "091000019"
                    originating_depository_financial_institution_id_qualifier: national_clearing_system_number
                    originating_depository_financial_institution_name: WELLS FARGO BANK
                    originator_city: BERLIN
                    originator_company_entry_description: RETRY PYMT
                    originator_country: DE
                    originator_identification: 770510487A
                    originator_name: BERGHAIN
                    originator_postal_code: "50825"
                    originator_state_or_province: null
                    originator_street_address: Ruedersdorferstr. 7
                    payment_related_information: null
                    payment_related_information2: null
                    receiver_city: BEVERLY HILLS
                    receiver_country: US
                    receiver_identification_number: "1018790279274"
                    receiver_postal_code: "90210"
                    receiver_state_or_province: CA
                    receiver_street_address: 123 FAKE ST
                    receiving_company_or_individual_name: IAN CREASE
                    receiving_depository_financial_institution_country: US
                    receiving_depository_financial_institution_id: "101050001"
                    receiving_depository_financial_institution_id_qualifier: national_clearing_system_number
                    receiving_depository_financial_institution_name: BLUE RIDGE BANK, NATIONAL ASSOCIATI
                    trace_number: "010202909100090"
                  nullable: true
                  properties:
                    amount:
                      description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    destination_country_code:
                      description: ""
                      type: string
                    destination_currency_code:
                      description: ""
                      type: string
                    foreign_exchange_indicator:
                      description: ""
                      type: string
                    foreign_exchange_reference:
                      description: ""
                      nullable: true
                      type: string
                    foreign_exchange_reference_indicator:
                      description: ""
                      type: string
                    foreign_payment_amount:
                      description: ""
                      type: integer
                    foreign_trace_number:
                      description: ""
                      nullable: true
                      type: string
                    international_transaction_type_code:
                      description: ""
                      type: string
                    originating_currency_code:
                      description: ""
                      type: string
                    originating_depository_financial_institution_branch_country:
                      description: ""
                      type: string
                    originating_depository_financial_institution_id:
                      description: ""
                      type: string
                    originating_depository_financial_institution_id_qualifier:
                      description: ""
                      type: string
                    originating_depository_financial_institution_name:
                      description: ""
                      type: string
                    originator_city:
                      description: ""
                      type: string
                    originator_company_entry_description:
                      description: ""
                      type: string
                    originator_country:
                      description: ""
                      type: string
                    originator_identification:
                      description: ""
                      type: string
                    originator_name:
                      description: ""
                      type: string
                    originator_postal_code:
                      description: ""
                      nullable: true
                      type: string
                    originator_state_or_province:
                      description: ""
                      nullable: true
                      type: string
                    originator_street_address:
                      description: ""
                      type: string
                    payment_related_information:
                      description: ""
                      nullable: true
                      type: string
                    payment_related_information2:
                      description: ""
                      nullable: true
                      type: string
                    receiver_city:
                      description: ""
                      type: string
                    receiver_country:
                      description: ""
                      type: string
                    receiver_identification_number:
                      description: ""
                      nullable: true
                      type: string
                    receiver_postal_code:
                      description: ""
                      nullable: true
                      type: string
                    receiver_state_or_province:
                      description: ""
                      nullable: true
                      type: string
                    receiver_street_address:
                      description: ""
                      type: string
                    receiving_company_or_individual_name:
                      description: ""
                      type: string
                    receiving_depository_financial_institution_country:
                      description: ""
                      type: string
                    receiving_depository_financial_institution_id:
                      description: ""
                      type: string
                    receiving_depository_financial_institution_id_qualifier:
                      description: ""
                      type: string
                    receiving_depository_financial_institution_name:
                      description: ""
                      type: string
                    trace_number:
                      description: ""
                      type: string
                  required:
                    - amount
                    - foreign_exchange_indicator
                    - foreign_exchange_reference_indicator
                    - foreign_exchange_reference
                    - destination_country_code
                    - destination_currency_code
                    - foreign_payment_amount
                    - foreign_trace_number
                    - international_transaction_type_code
                    - originating_currency_code
                    - originating_depository_financial_institution_name
                    - originating_depository_financial_institution_id_qualifier
                    - originating_depository_financial_institution_id
                    - originating_depository_financial_institution_branch_country
                    - originator_city
                    - originator_company_entry_description
                    - originator_country
                    - originator_identification
                    - originator_name
                    - originator_postal_code
                    - originator_street_address
                    - originator_state_or_province
                    - payment_related_information
                    - payment_related_information2
                    - receiver_identification_number
                    - receiver_street_address
                    - receiver_city
                    - receiver_state_or_province
                    - receiver_country
                    - receiver_postal_code
                    - receiving_company_or_individual_name
                    - receiving_depository_financial_institution_name
                    - receiving_depository_financial_institution_id_qualifier
                    - receiving_depository_financial_institution_id
                    - receiving_depository_financial_institution_country
                    - trace_number
                  title: International ACH Decline
                  type: object
                  x-title-plural: International ACH Declines
              required:
                - category
                - ach_decline
                - card_decline
                - check_decline
                - inbound_real_time_payments_transfer_decline
                - international_ach_decline
                - card_route_decline
              title: Declined Transaction Source
              type: object
              x-title-plural: Declined Transaction Sources
            type:
              description: A constant representing the object's type. For this resource it will always be `declined_transaction`.
              enum:
                - declined_transaction
              type: string
          required:
            - account_id
            - amount
            - currency
            - created_at
            - description
            - id
            - route_id
            - route_type
            - source
            - type
          title: Declined Transaction
          type: object
          x-title-plural: Declined Transactions
        pending_transaction:
          description: "If the authorization attempt succeeds, this will contain the resulting Pending Transaction object. The Pending Transaction's `source` will be of `category: card_authorization`."
          example:
            account_id: account_in71c4amph0vgo2qllky
            amount: 100
            completed_at: null
            created_at: 2020-01-31T23:59:59Z
            currency: USD
            description: Frederick S. Holmes
            id: pending_transaction_k1sfetcau2qbvjbzgju4
            route_id: card_oubs0hwk5rn6knuecxg2
            route_type: card
            source:
              ach_transfer_instruction:
                amount: 100
                transfer_id: ach_transfer_uoxatyh3lt5evrsdvo7q
              category: ach_transfer_instruction
            status: pending
            type: pending_transaction
          nullable: true
          properties:
            account_id:
              description: The identifier for the account this Pending Transaction belongs to.
              type: string
            amount:
              description: The Pending Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.
              type: integer
            completed_at:
              description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending Transaction was completed.
              format: date-time
              nullable: true
              type: string
            created_at:
              description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending Transaction occured.
              format: date-time
              type: string
            currency:
              description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Pending Transaction's currency. This will match the currency on the Pending Transcation's Account.
              enum:
                - CAD
                - CHF
                - EUR
                - GBP
                - JPY
                - USD
              type: string
              x-enum-descriptions:
                - Canadian Dollar (CAD)
                - Swiss Franc (CHF)
                - Euro (EUR)
                - British Pound (GBP)
                - Japanese Yen (JPY)
                - US Dollar (USD)
            description:
              description: For a Pending Transaction related to a transfer, this is the description you provide. For a Pending Transaction related to a payment, this is the description the vendor provides.
              type: string
            id:
              description: The Pending Transaction identifier.
              type: string
            route_id:
              description: The identifier for the route this Pending Transaction came through. Routes are things like cards and ACH details.
              nullable: true
              type: string
            route_type:
              description: The type of the route this Pending Transaction came through.
              enum:
                - account_number
                - card
              nullable: true
              type: string
              x-enum-descriptions:
                - An Account Number.
                - A Card.
            source:
              description: This is an object giving more details on the network-level event that caused the Pending Transaction. For example, for a card transaction this lists the merchant's industry and location.
              example:
                ach_transfer_instruction:
                  amount: 100
                  transfer_id: ach_transfer_uoxatyh3lt5evrsdvo7q
                category: ach_transfer_instruction
              properties:
                account_transfer_instruction:
                  description: A Account Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `account_transfer_instruction`.
                  example:
                    amount: 100
                    currency: USD
                    transfer_id: account_transfer_7k9qe1ysdgqztnt63l7n
                  nullable: true
                  properties:
                    amount:
                      description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    transfer_id:
                      description: The identifier of the Account Transfer that led to this Pending Transaction.
                      type: string
                  required:
                    - amount
                    - currency
                    - transfer_id
                  title: Account Transfer Instruction
                  type: object
                  x-title-plural: Account Transfer Instructions
                ach_transfer_instruction:
                  description: A ACH Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_instruction`.
                  example:
                    amount: 100
                    transfer_id: ach_transfer_uoxatyh3lt5evrsdvo7q
                  nullable: true
                  properties:
                    amount:
                      description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    transfer_id:
                      description: The identifier of the ACH Transfer that led to this Pending Transaction.
                      type: string
                  required:
                    - amount
                    - transfer_id
                  title: ACH Transfer Instruction
                  type: object
                  x-title-plural: ACH Transfer Instructions
                card_authorization:
                  description: A Card Authorization object. This field will be present in the JSON response if and only if `category` is equal to `card_authorization`.
                  example:
                    amount: 100
                    currency: USD
                    digital_wallet_token_id: null
                    id: card_authorization_6iqxap6ivd0fo5eu3i8x
                    merchant_acceptor_id: "5665270011000168"
                    merchant_category_code: "5734"
                    merchant_city: New York
                    merchant_country: US
                    merchant_descriptor: AMAZON.COM
                    network: visa
                    network_details:
                      visa:
                        electronic_commerce_indicator: secure_electronic_commerce
                        point_of_service_entry_mode: manual
                    real_time_decision_id: null
                    type: card_authorization
                  nullable: true
                  properties:
                    amount:
                      description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    digital_wallet_token_id:
                      description: If the authorization was made via a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used.
                      nullable: true
                      type: string
                    id:
                      description: The Card Authorization identifier.
                      type: string
                    merchant_acceptor_id:
                      description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.
                      type: string
                    merchant_category_code:
                      description: The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.
                      nullable: true
                      type: string
                    merchant_city:
                      description: The city the merchant resides in.
                      nullable: true
                      type: string
                    merchant_country:
                      description: The country the merchant resides in.
                      nullable: true
                      type: string
                    merchant_descriptor:
                      description: The merchant descriptor of the merchant the card is transacting with.
                      type: string
                    network:
                      description: The payment network used to process this card authorization
                      enum:
                        - visa
                      type: string
                      x-enum-descriptions:
                        - Visa
                    network_details:
                      description: Fields specific to the `network`
                      properties:
                        visa:
                          description: Fields specific to the `visa` network
                          properties:
                            electronic_commerce_indicator:
                              description: For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order.
                              enum:
                                - mail_phone_order
                                - recurring
                                - installment
                                - unknown_mail_phone_order
                                - secure_electronic_commerce
                                - non_authenticated_security_transaction_at_3ds_capable_merchant
                                - non_authenticated_security_transaction
                                - non_secure_transaction
                              nullable: true
                              type: string
                              x-enum-descriptions:
                                - "Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments."
                                - "Recurring transaction: Payment indicator used to indicate a recurring transaction that originates from an acquirer in the US region."
                                - "Installment payment: Payment indicator used to indicate one purchase of goods or services that is billed to the account in multiple charges over a period of time agreed upon by the cardholder and merchant from transactions that originate from an acquirer in the US region."
                                - "Unknown classification: other mail order: Use to indicate that the type of mail/telephone order is unknown."
                                - "Secure electronic commerce transaction: Use to indicate that the electronic commerce transaction has been authenticated using e.g., 3-D Secure"
                                - "Non-authenticated security transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure: Use to identify an electronic commerce transaction where the merchant attempted to authenticate the cardholder using 3-D Secure, but was unable to complete the authentication because the issuer or cardholder does not participate in the 3-D Secure program."
                                - "Non-authenticated security transaction: Use to identify an electronic commerce transaction that uses data encryption for security however , cardholder authentication is not performed using 3-D Secure."
                                - "Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection."
                            point_of_service_entry_mode:
                              description: The method used to enter the cardholder's primary account number and card expiration date
                              enum:
                                - manual
                                - magnetic_stripe_no_cvv
                                - optical_code
                                - integrated_circuit_card
                                - contactless
                                - credential_on_file
                                - magnetic_stripe
                                - contactless_magnetic_stripe
                                - integrated_circuit_card_no_cvv
                              nullable: true
                              type: string
                              x-enum-descriptions:
                                - Manual key entry
                                - Magnetic stripe read, without card verification value
                                - Optical code
                                - Contact chip card
                                - Contactless read of chip card
                                - Transaction iniated using a credential that has previously been stored on file
                                - Magnetic stripe read
                                - Contactless read of magnetic stripe data
                                - Contact chip card, without card verification value
                          required:
                            - electronic_commerce_indicator
                            - point_of_service_entry_mode
                          title: Visa
                          type: object
                          x-title-plural: Visas
                      required:
                        - visa
                      title: Network Details
                      type: object
                      x-title-plural: Network Detailss
                    real_time_decision_id:
                      description: The identifier of the Real-Time Decision sent to approve or decline this transaction.
                      nullable: true
                      type: string
                    type:
                      description: A constant representing the object's type. For this resource it will always be `card_authorization`.
                      enum:
                        - card_authorization
                      type: string
                  required:
                    - id
                    - merchant_acceptor_id
                    - merchant_descriptor
                    - merchant_category_code
                    - merchant_city
                    - merchant_country
                    - network
                    - network_details
                    - amount
                    - currency
                    - real_time_decision_id
                    - digital_wallet_token_id
                    - type
                  title: Card Authorization
                  type: object
                  x-title-plural: Card Authorizations
                card_route_authorization:
                  description: A Deprecated Card Authorization object. This field will be present in the JSON response if and only if `category` is equal to `card_route_authorization`.
                  example:
                    amount: 100
                    currency: USD
                    merchant_acceptor_id: "6631945550173363"
                    merchant_category_code: "5734"
                    merchant_city: New York
                    merchant_country: US
                    merchant_descriptor: THUMP COFFEE
                    merchant_state: NY
                  nullable: true
                  properties:
                    amount:
                      description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    merchant_acceptor_id:
                      description: ""
                      type: string
                    merchant_category_code:
                      description: ""
                      type: string
                    merchant_city:
                      description: ""
                      nullable: true
                      type: string
                    merchant_country:
                      description: ""
                      type: string
                    merchant_descriptor:
                      description: ""
                      type: string
                    merchant_state:
                      description: ""
                      nullable: true
                      type: string
                  required:
                    - amount
                    - currency
                    - merchant_acceptor_id
                    - merchant_city
                    - merchant_country
                    - merchant_descriptor
                    - merchant_category_code
                    - merchant_state
                  title: Deprecated Card Authorization
                  type: object
                  x-title-plural: Deprecated Card Authorizations
                category:
                  description: The type of transaction that took place. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
                  enum:
                    - account_transfer_instruction
                    - ach_transfer_instruction
                    - card_authorization
                    - check_deposit_instruction
                    - check_transfer_instruction
                    - inbound_funds_hold
                    - card_route_authorization
                    - real_time_payments_transfer_instruction
                    - wire_drawdown_payment_instruction
                    - wire_transfer_instruction
                    - other
                  type: string
                  x-enum-descriptions:
                    - The Pending Transaction was created by a Account Transfer Instruction object. Details will be under the `account_transfer_instruction` object.
                    - The Pending Transaction was created by a ACH Transfer Instruction object. Details will be under the `ach_transfer_instruction` object.
                    - The Pending Transaction was created by a Card Authorization object. Details will be under the `card_authorization` object.
                    - The Pending Transaction was created by a Check Deposit Instruction object. Details will be under the `check_deposit_instruction` object.
                    - The Pending Transaction was created by a Check Transfer Instruction object. Details will be under the `check_transfer_instruction` object.
                    - The Pending Transaction was created by a Inbound Funds Hold object. Details will be under the `inbound_funds_hold` object.
                    - The Pending Transaction was created by a Deprecated Card Authorization object. Details will be under the `card_route_authorization` object.
                    - The Pending Transaction was created by a Real Time Payments Transfer Instruction object. Details will be under the `real_time_payments_transfer_instruction` object.
                    - The Pending Transaction was created by a Wire Drawdown Payment Instruction object. Details will be under the `wire_drawdown_payment_instruction` object.
                    - The Pending Transaction was created by a Wire Transfer Instruction object. Details will be under the `wire_transfer_instruction` object.
                    - The Pending Transaction was made for an undocumented or deprecated reason.
                check_deposit_instruction:
                  description: A Check Deposit Instruction object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_instruction`.
                  example:
                    amount: 100
                    back_image_file_id: file_26khfk98mzfz90a11oqx
                    check_deposit_id: check_deposit_f06n9gpg7sxn8t19lfc1
                    currency: USD
                    front_image_file_id: file_makxrc67oh9l6sg7w9yc
                  nullable: true
                  properties:
                    amount:
                      description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    back_image_file_id:
                      description: The identifier of the File containing the image of the back of the check that was deposited.
                      nullable: true
                      type: string
                    check_deposit_id:
                      description: The identifier of the Check Deposit.
                      nullable: true
                      type: string
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    front_image_file_id:
                      description: The identifier of the File containing the image of the front of the check that was deposited.
                      type: string
                  required:
                    - amount
                    - currency
                    - front_image_file_id
                    - back_image_file_id
                    - check_deposit_id
                  title: Check Deposit Instruction
                  type: object
                  x-title-plural: Check Deposit Instructions
                check_transfer_instruction:
                  description: A Check Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_instruction`.
                  example:
                    amount: 100
                    currency: USD
                    transfer_id: check_transfer_30b43acfu9vw8fyc4f5
                  nullable: true
                  properties:
                    amount:
                      description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    transfer_id:
                      description: The identifier of the Check Transfer that led to this Pending Transaction.
                      type: string
                  required:
                    - amount
                    - currency
                    - transfer_id
                  title: Check Transfer Instruction
                  type: object
                  x-title-plural: Check Transfer Instructions
                inbound_funds_hold:
                  description: A Inbound Funds Hold object. This field will be present in the JSON response if and only if `category` is equal to `inbound_funds_hold`.
                  example:
                    amount: 100
                    automatically_releases_at: 2020-01-31T23:59:59Z
                    created_at: 2020-01-31T23:59:59Z
                    currency: USD
                    held_transaction_id: transaction_uyrp7fld2ium70oa7oi
                    pending_transaction_id: pending_transaction_k1sfetcau2qbvjbzgju4
                    released_at: null
                    status: held
                  nullable: true
                  properties:
                    amount:
                      description: The held amount in the minor unit of the account's currency. For dollars, for example, this is cents.
                      type: integer
                    automatically_releases_at:
                      description: When the hold will be released automatically. Certain conditions may cause it to be released before this time.
                      format: date-time
                      type: string
                    created_at:
                      description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold was created.
                      format: date-time
                      type: string
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    held_transaction_id:
                      description: The ID of the Transaction for which funds were held.
                      nullable: true
                      type: string
                    pending_transaction_id:
                      description: The ID of the Pending Transaction representing the held funds.
                      nullable: true
                      type: string
                    released_at:
                      description: When the hold was released (if it has been released).
                      format: date-time
                      nullable: true
                      type: string
                    status:
                      description: The status of the hold.
                      enum:
                        - held
                        - complete
                      type: string
                      x-enum-descriptions:
                        - Funds are still being held.
                        - Funds have been released.
                  required:
                    - amount
                    - created_at
                    - currency
                    - automatically_releases_at
                    - released_at
                    - status
                    - held_transaction_id
                    - pending_transaction_id
                  title: Inbound Funds Hold
                  type: object
                  x-title-plural: Inbound Funds Holds
                real_time_payments_transfer_instruction:
                  description: A Real Time Payments Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `real_time_payments_transfer_instruction`.
                  example:
                    amount: 100
                    transfer_id: real_time_payments_transfer_iyuhl5kdn7ssmup83mvq
                  nullable: true
                  properties:
                    amount:
                      description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    transfer_id:
                      description: The identifier of the Real Time Payments Transfer that led to this Pending Transaction.
                      type: string
                  required:
                    - amount
                    - transfer_id
                  title: Real Time Payments Transfer Instruction
                  type: object
                  x-title-plural: Real Time Payments Transfer Instructions
                wire_drawdown_payment_instruction:
                  description: A Wire Drawdown Payment Instruction object. This field will be present in the JSON response if and only if `category` is equal to `wire_drawdown_payment_instruction`.
                  example:
                    account_number: "987654321"
                    amount: 100
                    message_to_recipient: HELLO
                    routing_number: "101050001"
                  nullable: true
                  properties:
                    account_number:
                      description: ""
                      type: string
                    amount:
                      description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    message_to_recipient:
                      description: ""
                      type: string
                    routing_number:
                      description: ""
                      type: string
                  required:
                    - amount
                    - account_number
                    - routing_number
                    - message_to_recipient
                  title: Wire Drawdown Payment Instruction
                  type: object
                  x-title-plural: Wire Drawdown Payment Instructions
                wire_transfer_instruction:
                  description: A Wire Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_instruction`.
                  example:
                    account_number: "987654321"
                    amount: 100
                    message_to_recipient: HELLO
                    routing_number: "101050001"
                    transfer_id: wire_transfer_5akynk7dqsq25qwk9q2u
                  nullable: true
                  properties:
                    account_number:
                      description: ""
                      type: string
                    amount:
                      description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    message_to_recipient:
                      description: ""
                      type: string
                    routing_number:
                      description: ""
                      type: string
                    transfer_id:
                      description: ""
                      type: string
                  required:
                    - amount
                    - account_number
                    - routing_number
                    - message_to_recipient
                    - transfer_id
                  title: Wire Transfer Instruction
                  type: object
                  x-title-plural: Wire Transfer Instructions
              required:
                - category
                - account_transfer_instruction
                - ach_transfer_instruction
                - card_authorization
                - check_deposit_instruction
                - check_transfer_instruction
                - inbound_funds_hold
                - card_route_authorization
                - real_time_payments_transfer_instruction
                - wire_drawdown_payment_instruction
                - wire_transfer_instruction
              title: Pending Transaction Source
              type: object
              x-title-plural: Pending Transaction Sources
            status:
              description: Whether the Pending Transaction has been confirmed and has an associated Transaction.
              enum:
                - pending
                - complete
              type: string
              x-enum-descriptions:
                - The Pending Transaction is still awaiting confirmation.
                - The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc.
            type:
              description: A constant representing the object's type. For this resource it will always be `pending_transaction`.
              enum:
                - pending_transaction
              type: string
          required:
            - account_id
            - amount
            - currency
            - completed_at
            - created_at
            - description
            - id
            - route_id
            - route_type
            - source
            - status
            - type
          title: Pending Transaction
          type: object
          x-title-plural: Pending Transactions
        type:
          description: A constant representing the object's type. For this resource it will always be `inbound_card_authorization_simulation_result`.
          enum:
            - inbound_card_authorization_simulation_result
          type: string
      required:
        - pending_transaction
        - declined_transaction
        - type
      title: Inbound Card Authorization Simulation Result
      type: object
      x-title-plural: Inbound Card Authorization Simulation Results
    inbound_digital_wallet_token_request_simulation_result:
      description: The results of a Digital Wallet Token simulation.
      example:
        decline_reason: null
        digital_wallet_token_id: digital_wallet_token_izi62go3h51p369jrie0
        type: inbound_digital_wallet_token_request_simulation_result
      properties:
        decline_reason:
          description: If the simulated tokenization attempt was declined, this field contains details as to why.
          enum:
            - card_not_active
            - no_verification_method
            - webhook_timed_out
            - webhook_declined
          nullable: true
          type: string
          x-enum-descriptions:
            - The card is not active.
            - The card does not have a two-factor authentication method.
            - Your webhook timed out when evaluating the token provisioning attempt.
            - Your webhook declined the token provisioning attempt.
        digital_wallet_token_id:
          description: If the simulated tokenization attempt was accepted, this field contains the id of the Digital Wallet Token that was created.
          nullable: true
          type: string
        type:
          description: A constant representing the object's type. For this resource it will always be `inbound_digital_wallet_token_request_simulation_result`.
          enum:
            - inbound_digital_wallet_token_request_simulation_result
          type: string
      required:
        - decline_reason
        - digital_wallet_token_id
        - type
      title: Inbound Digital Wallet Token Request Simulation Result
      type: object
      x-title-plural: Inbound Digital Wallet Token Request Simulation Results
    inbound_real_time_payments_transfer_simulation_result:
      description: The results of an inbound Real Time Payments Transfer simulation.
      example:
        declined_transaction: null
        transaction:
          account_id: account_in71c4amph0vgo2qllky
          amount: 100
          created_at: 2020-01-31T23:59:59Z
          currency: USD
          description: Frederick S. Holmes
          id: transaction_uyrp7fld2ium70oa7oi
          route_id: account_number_v18nkfqm6afpsrvy82b2
          route_type: account_number
          source:
            category: inbound_real_time_payments_transfer_confirmation
            inbound_real_time_payments_transfer_confirmation:
              amount: 100
              creditor_name: Ian Crease
              currency: USD
              debtor_account_number: "987654321"
              debtor_name: National Phonograph Company
              debtor_routing_number: "101050001"
              remittance_information: Invoice 29582
              transaction_identification: 20220501234567891T1BSLZO01745013025
          type: transaction
        type: inbound_real_time_payments_transfer_simulation_result
      properties:
        declined_transaction:
          description: "If the Real Time Payments Transfer attempt fails, this will contain the resulting [Declined Transaction](#declined-transactions) object. The Declined Transaction's `source` will be of `category: inbound_real_time_payments_transfer_decline`."
          example:
            account_id: account_in71c4amph0vgo2qllky
            amount: 1750
            created_at: 2020-01-31T23:59:59Z
            currency: USD
            description: Frederick S. Holmes
            id: declined_transaction_17jbn0yyhvkt4v4ooym8
            route_id: account_number_v18nkfqm6afpsrvy82b2
            route_type: account_number
            source:
              ach_decline:
                amount: 1750
                originator_company_descriptive_date: null
                originator_company_discretionary_data: null
                originator_company_id: "0987654321"
                originator_company_name: BIG BANK
                reason: insufficient_funds
                receiver_id_number: "12345678900"
                receiver_name: IAN CREASE
                trace_number: "021000038461022"
              category: ach_decline
            type: declined_transaction
          nullable: true
          properties:
            account_id:
              description: The identifier for the Account the Declined Transaction belongs to.
              type: string
            amount:
              description: The Declined Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.
              type: integer
            created_at:
              description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Transaction occured.
              format: date-time
              type: string
            currency:
              description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined Transaction's currency. This will match the currency on the Declined Transcation's Account.
              enum:
                - CAD
                - CHF
                - EUR
                - GBP
                - JPY
                - USD
              type: string
              x-enum-descriptions:
                - Canadian Dollar (CAD)
                - Swiss Franc (CHF)
                - Euro (EUR)
                - British Pound (GBP)
                - Japanese Yen (JPY)
                - US Dollar (USD)
            description:
              description: This is the description the vendor provides.
              type: string
            id:
              description: The Declined Transaction identifier.
              type: string
            route_id:
              description: The identifier for the route this Declined Transaction came through. Routes are things like cards and ACH details.
              nullable: true
              type: string
            route_type:
              description: The type of the route this Declined Transaction came through.
              enum:
                - account_number
                - card
              nullable: true
              type: string
              x-enum-descriptions:
                - An Account Number.
                - A Card.
            source:
              description: This is an object giving more details on the network-level event that caused the Declined Transaction. For example, for a card transaction this lists the merchant's industry and location. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.
              example:
                ach_decline:
                  amount: 1750
                  originator_company_descriptive_date: null
                  originator_company_discretionary_data: null
                  originator_company_id: "0987654321"
                  originator_company_name: BIG BANK
                  reason: insufficient_funds
                  receiver_id_number: "12345678900"
                  receiver_name: IAN CREASE
                  trace_number: "021000038461022"
                category: ach_decline
              properties:
                ach_decline:
                  description: A ACH Decline object. This field will be present in the JSON response if and only if `category` is equal to `ach_decline`.
                  example:
                    amount: 1750
                    originator_company_descriptive_date: null
                    originator_company_discretionary_data: null
                    originator_company_id: "0987654321"
                    originator_company_name: BIG BANK
                    reason: insufficient_funds
                    receiver_id_number: "12345678900"
                    receiver_name: IAN CREASE
                    trace_number: "021000038461022"
                  nullable: true
                  properties:
                    amount:
                      description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    originator_company_descriptive_date:
                      description: ""
                      nullable: true
                      type: string
                    originator_company_discretionary_data:
                      description: ""
                      nullable: true
                      type: string
                    originator_company_id:
                      description: ""
                      type: string
                    originator_company_name:
                      description: ""
                      type: string
                    reason:
                      description: Why the ACH transfer was declined.
                      enum:
                        - ach_route_canceled
                        - ach_route_disabled
                        - breaches_limit
                        - credit_entry_refused_by_receiver
                        - duplicate_return
                        - entity_not_active
                        - group_locked
                        - insufficient_funds
                        - misrouted_return
                        - no_ach_route
                        - originator_request
                        - transaction_not_allowed
                      type: string
                      x-enum-descriptions:
                        - The account number is canceled.
                        - The account number is disabled.
                        - The transaction would cause a limit to be exceeded.
                        - A credit was refused.
                        - Other.
                        - The account's entity is not active.
                        - Your account is inactive.
                        - Your account contains insufficient funds.
                        - Other.
                        - The account number that was debited does not exist.
                        - Other.
                        - The transaction is not allowed per Increase's terms
                    receiver_id_number:
                      description: ""
                      nullable: true
                      type: string
                    receiver_name:
                      description: ""
                      nullable: true
                      type: string
                    trace_number:
                      description: ""
                      type: string
                  required:
                    - amount
                    - originator_company_name
                    - originator_company_descriptive_date
                    - originator_company_discretionary_data
                    - originator_company_id
                    - reason
                    - receiver_id_number
                    - receiver_name
                    - trace_number
                  title: ACH Decline
                  type: object
                  x-title-plural: ACH Declines
                card_decline:
                  description: A Card Decline object. This field will be present in the JSON response if and only if `category` is equal to `card_decline`.
                  example:
                    amount: -1000
                    currency: USD
                    digital_wallet_token_id: null
                    merchant_acceptor_id: "372909060886"
                    merchant_category_code: "5998"
                    merchant_city: "5364086000"
                    merchant_country: USA
                    merchant_descriptor: TENTS R US
                    merchant_state: CA
                    network: visa
                    network_details:
                      visa:
                        electronic_commerce_indicator: secure_electronic_commerce
                        point_of_service_entry_mode: manual
                    real_time_decision_id: null
                    reason: insufficient_funds
                  nullable: true
                  properties:
                    amount:
                      description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    digital_wallet_token_id:
                      description: If the authorization was attempted using a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used.
                      nullable: true
                      type: string
                    merchant_acceptor_id:
                      description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.
                      type: string
                    merchant_category_code:
                      description: The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.
                      nullable: true
                      type: string
                    merchant_city:
                      description: The city the merchant resides in.
                      nullable: true
                      type: string
                    merchant_country:
                      description: The country the merchant resides in.
                      nullable: true
                      type: string
                    merchant_descriptor:
                      description: The merchant descriptor of the merchant the card is transacting with.
                      type: string
                    merchant_state:
                      description: The state the merchant resides in.
                      nullable: true
                      type: string
                    network:
                      description: The payment network used to process this card authorization
                      enum:
                        - visa
                      type: string
                      x-enum-descriptions:
                        - Visa
                    network_details:
                      description: Fields specific to the `network`
                      properties:
                        visa:
                          description: Fields specific to the `visa` network
                          properties:
                            electronic_commerce_indicator:
                              description: For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order.
                              enum:
                                - mail_phone_order
                                - recurring
                                - installment
                                - unknown_mail_phone_order
                                - secure_electronic_commerce
                                - non_authenticated_security_transaction_at_3ds_capable_merchant
                                - non_authenticated_security_transaction
                                - non_secure_transaction
                              nullable: true
                              type: string
                              x-enum-descriptions:
                                - "Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments."
                                - "Recurring transaction: Payment indicator used to indicate a recurring transaction that originates from an acquirer in the US region."
                                - "Installment payment: Payment indicator used to indicate one purchase of goods or services that is billed to the account in multiple charges over a period of time agreed upon by the cardholder and merchant from transactions that originate from an acquirer in the US region."
                                - "Unknown classification: other mail order: Use to indicate that the type of mail/telephone order is unknown."
                                - "Secure electronic commerce transaction: Use to indicate that the electronic commerce transaction has been authenticated using e.g., 3-D Secure"
                                - "Non-authenticated security transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure: Use to identify an electronic commerce transaction where the merchant attempted to authenticate the cardholder using 3-D Secure, but was unable to complete the authentication because the issuer or cardholder does not participate in the 3-D Secure program."
                                - "Non-authenticated security transaction: Use to identify an electronic commerce transaction that uses data encryption for security however , cardholder authentication is not performed using 3-D Secure."
                                - "Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection."
                            point_of_service_entry_mode:
                              description: The method used to enter the cardholder's primary account number and card expiration date
                              enum:
                                - manual
                                - magnetic_stripe_no_cvv
                                - optical_code
                                - integrated_circuit_card
                                - contactless
                                - credential_on_file
                                - magnetic_stripe
                                - contactless_magnetic_stripe
                                - integrated_circuit_card_no_cvv
                              nullable: true
                              type: string
                              x-enum-descriptions:
                                - Manual key entry
                                - Magnetic stripe read, without card verification value
                                - Optical code
                                - Contact chip card
                                - Contactless read of chip card
                                - Transaction iniated using a credential that has previously been stored on file
                                - Magnetic stripe read
                                - Contactless read of magnetic stripe data
                                - Contact chip card, without card verification value
                          required:
                            - electronic_commerce_indicator
                            - point_of_service_entry_mode
                          title: Visa
                          type: object
                          x-title-plural: Visas
                      required:
                        - visa
                      title: Network Details
                      type: object
                      x-title-plural: Network Detailss
                    real_time_decision_id:
                      description: The identifier of the Real-Time Decision sent to approve or decline this transaction.
                      nullable: true
                      type: string
                    reason:
                      description: Why the transaction was declined.
                      enum:
                        - card_not_active
                        - entity_not_active
                        - group_locked
                        - insufficient_funds
                        - cvv2_mismatch
                        - transaction_not_allowed
                        - breaches_limit
                        - webhook_declined
                        - webhook_timed_out
                        - declined_by_stand_in_processing
                        - invalid_physical_card
                        - missing_original_authorization
                      type: string
                      x-enum-descriptions:
                        - The Card was not active.
                        - The account's entity was not active.
                        - The account was inactive.
                        - The Card's Account did not have a sufficient available balance.
                        - The given CVV2 did not match the card's value.
                        - The attempted card transaction is not allowed per Increase's terms.
                        - The transaction was blocked by a Limit.
                        - Your application declined the transaction via webhook.
                        - Your application webhook did not respond without the required timeout.
                        - Declined by stand-in processing.
                        - The card read had an invalid CVV, dCVV, or authorization request cryptogram.
                        - The original card authorization for this incremental authorization does not exist.
                  required:
                    - merchant_acceptor_id
                    - merchant_descriptor
                    - merchant_category_code
                    - merchant_city
                    - merchant_country
                    - network
                    - network_details
                    - amount
                    - currency
                    - reason
                    - merchant_state
                    - real_time_decision_id
                    - digital_wallet_token_id
                  title: Card Decline
                  type: object
                  x-title-plural: Card Declines
                card_route_decline:
                  description: A Deprecated Card Decline object. This field will be present in the JSON response if and only if `category` is equal to `card_route_decline`.
                  example:
                    amount: -1000
                    currency: USD
                    merchant_acceptor_id: "372909060886"
                    merchant_category_code: "5998"
                    merchant_city: "5364086000"
                    merchant_country: USA
                    merchant_descriptor: TENTS R US
                    merchant_state: CA
                  nullable: true
                  properties:
                    amount:
                      description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    merchant_acceptor_id:
                      description: ""
                      type: string
                    merchant_category_code:
                      description: ""
                      nullable: true
                      type: string
                    merchant_city:
                      description: ""
                      nullable: true
                      type: string
                    merchant_country:
                      description: ""
                      type: string
                    merchant_descriptor:
                      description: ""
                      type: string
                    merchant_state:
                      description: ""
                      nullable: true
                      type: string
                  required:
                    - amount
                    - currency
                    - merchant_acceptor_id
                    - merchant_city
                    - merchant_country
                    - merchant_descriptor
                    - merchant_state
                    - merchant_category_code
                  title: Deprecated Card Decline
                  type: object
                  x-title-plural: Deprecated Card Declines
                category:
                  description: The type of decline that took place. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
                  enum:
                    - ach_decline
                    - card_decline
                    - check_decline
                    - inbound_real_time_payments_transfer_decline
                    - international_ach_decline
                    - card_route_decline
                    - other
                  type: string
                  x-enum-descriptions:
                    - The Declined Transaction was created by a ACH Decline object. Details will be under the `ach_decline` object.
                    - The Declined Transaction was created by a Card Decline object. Details will be under the `card_decline` object.
                    - The Declined Transaction was created by a Check Decline object. Details will be under the `check_decline` object.
                    - The Declined Transaction was created by a Inbound Real Time Payments Transfer Decline object. Details will be under the `inbound_real_time_payments_transfer_decline` object.
                    - The Declined Transaction was created by a International ACH Decline object. Details will be under the `international_ach_decline` object.
                    - The Declined Transaction was created by a Deprecated Card Decline object. Details will be under the `card_route_decline` object.
                    - The Declined Transaction was made for an undocumented or deprecated reason.
                check_decline:
                  description: A Check Decline object. This field will be present in the JSON response if and only if `category` is equal to `check_decline`.
                  example:
                    amount: -1000
                    auxiliary_on_us: "99999"
                    reason: insufficient_funds
                  nullable: true
                  properties:
                    amount:
                      description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    auxiliary_on_us:
                      description: ""
                      nullable: true
                      type: string
                    reason:
                      description: Why the check was declined.
                      enum:
                        - ach_route_canceled
                        - ach_route_disabled
                        - breaches_limit
                        - entity_not_active
                        - group_locked
                        - insufficient_funds
                        - unable_to_locate_account
                        - unable_to_process
                        - refer_to_image
                        - stop_payment_requested
                        - returned
                        - duplicate_presentment
                        - not_authorized
                      type: string
                      x-enum-descriptions:
                        - The account number is canceled.
                        - The account number is disabled.
                        - The transaction would cause a limit to be exceeded.
                        - The account's entity is not active.
                        - Your account is inactive.
                        - Your account contains insufficient funds.
                        - Unable to locate account.
                        - Unable to process.
                        - Refer to image.
                        - Stop payment requested for this check.
                        - Check was returned to sender.
                        - The check was a duplicate deposit.
                        - The transaction is not allowed.
                  required:
                    - amount
                    - auxiliary_on_us
                    - reason
                  title: Check Decline
                  type: object
                  x-title-plural: Check Declines
                inbound_real_time_payments_transfer_decline:
                  description: A Inbound Real Time Payments Transfer Decline object. This field will be present in the JSON response if and only if `category` is equal to `inbound_real_time_payments_transfer_decline`.
                  example:
                    amount: 100
                    creditor_name: Ian Crease
                    currency: USD
                    debtor_account_number: "987654321"
                    debtor_name: National Phonograph Company
                    debtor_routing_number: "101050001"
                    reason: account_number_disabled
                    remittance_information: Invoice 29582
                    transaction_identification: 20220501234567891T1BSLZO01745013025
                  nullable: true
                  properties:
                    amount:
                      description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    creditor_name:
                      description: The name the sender of the transfer specified as the recipient of the transfer.
                      type: string
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined transfer's currency. This will always be "USD" for a Real Time Payments transfer.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    debtor_account_number:
                      description: The account number of the account that sent the transfer.
                      type: string
                    debtor_name:
                      description: The name provided by the sender of the transfer.
                      type: string
                    debtor_routing_number:
                      description: The routing number of the account that sent the transfer.
                      type: string
                    reason:
                      description: Why the transfer was declined.
                      enum:
                        - account_number_canceled
                        - account_number_disabled
                        - group_locked
                        - entity_not_active
                        - real_time_payments_not_enabled
                      type: string
                      x-enum-descriptions:
                        - The account number is canceled.
                        - The account number is disabled.
                        - Your account is inactive.
                        - The account's entity is not active.
                        - Your account is not enabled to receive Real Time Payments transfers.
                    remittance_information:
                      description: Additional information included with the transfer.
                      nullable: true
                      type: string
                    transaction_identification:
                      description: The Real Time Payments network identification of the declined transfer.
                      type: string
                  required:
                    - amount
                    - currency
                    - reason
                    - creditor_name
                    - debtor_name
                    - debtor_account_number
                    - debtor_routing_number
                    - transaction_identification
                    - remittance_information
                  title: Inbound Real Time Payments Transfer Decline
                  type: object
                  x-title-plural: Inbound Real Time Payments Transfer Declines
                international_ach_decline:
                  description: A International ACH Decline object. This field will be present in the JSON response if and only if `category` is equal to `international_ach_decline`.
                  example:
                    amount: -1000
                    destination_country_code: US
                    destination_currency_code: USD
                    foreign_exchange_indicator: fixed_to_fixed
                    foreign_exchange_reference: null
                    foreign_exchange_reference_indicator: blank
                    foreign_payment_amount: 199
                    foreign_trace_number: null
                    international_transaction_type_code: internet_initiated
                    originating_currency_code: USD
                    originating_depository_financial_institution_branch_country: US
                    originating_depository_financial_institution_id: "091000019"
                    originating_depository_financial_institution_id_qualifier: national_clearing_system_number
                    originating_depository_financial_institution_name: WELLS FARGO BANK
                    originator_city: BERLIN
                    originator_company_entry_description: RETRY PYMT
                    originator_country: DE
                    originator_identification: 770510487A
                    originator_name: BERGHAIN
                    originator_postal_code: "50825"
                    originator_state_or_province: null
                    originator_street_address: Ruedersdorferstr. 7
                    payment_related_information: null
                    payment_related_information2: null
                    receiver_city: BEVERLY HILLS
                    receiver_country: US
                    receiver_identification_number: "1018790279274"
                    receiver_postal_code: "90210"
                    receiver_state_or_province: CA
                    receiver_street_address: 123 FAKE ST
                    receiving_company_or_individual_name: IAN CREASE
                    receiving_depository_financial_institution_country: US
                    receiving_depository_financial_institution_id: "101050001"
                    receiving_depository_financial_institution_id_qualifier: national_clearing_system_number
                    receiving_depository_financial_institution_name: BLUE RIDGE BANK, NATIONAL ASSOCIATI
                    trace_number: "010202909100090"
                  nullable: true
                  properties:
                    amount:
                      description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    destination_country_code:
                      description: ""
                      type: string
                    destination_currency_code:
                      description: ""
                      type: string
                    foreign_exchange_indicator:
                      description: ""
                      type: string
                    foreign_exchange_reference:
                      description: ""
                      nullable: true
                      type: string
                    foreign_exchange_reference_indicator:
                      description: ""
                      type: string
                    foreign_payment_amount:
                      description: ""
                      type: integer
                    foreign_trace_number:
                      description: ""
                      nullable: true
                      type: string
                    international_transaction_type_code:
                      description: ""
                      type: string
                    originating_currency_code:
                      description: ""
                      type: string
                    originating_depository_financial_institution_branch_country:
                      description: ""
                      type: string
                    originating_depository_financial_institution_id:
                      description: ""
                      type: string
                    originating_depository_financial_institution_id_qualifier:
                      description: ""
                      type: string
                    originating_depository_financial_institution_name:
                      description: ""
                      type: string
                    originator_city:
                      description: ""
                      type: string
                    originator_company_entry_description:
                      description: ""
                      type: string
                    originator_country:
                      description: ""
                      type: string
                    originator_identification:
                      description: ""
                      type: string
                    originator_name:
                      description: ""
                      type: string
                    originator_postal_code:
                      description: ""
                      nullable: true
                      type: string
                    originator_state_or_province:
                      description: ""
                      nullable: true
                      type: string
                    originator_street_address:
                      description: ""
                      type: string
                    payment_related_information:
                      description: ""
                      nullable: true
                      type: string
                    payment_related_information2:
                      description: ""
                      nullable: true
                      type: string
                    receiver_city:
                      description: ""
                      type: string
                    receiver_country:
                      description: ""
                      type: string
                    receiver_identification_number:
                      description: ""
                      nullable: true
                      type: string
                    receiver_postal_code:
                      description: ""
                      nullable: true
                      type: string
                    receiver_state_or_province:
                      description: ""
                      nullable: true
                      type: string
                    receiver_street_address:
                      description: ""
                      type: string
                    receiving_company_or_individual_name:
                      description: ""
                      type: string
                    receiving_depository_financial_institution_country:
                      description: ""
                      type: string
                    receiving_depository_financial_institution_id:
                      description: ""
                      type: string
                    receiving_depository_financial_institution_id_qualifier:
                      description: ""
                      type: string
                    receiving_depository_financial_institution_name:
                      description: ""
                      type: string
                    trace_number:
                      description: ""
                      type: string
                  required:
                    - amount
                    - foreign_exchange_indicator
                    - foreign_exchange_reference_indicator
                    - foreign_exchange_reference
                    - destination_country_code
                    - destination_currency_code
                    - foreign_payment_amount
                    - foreign_trace_number
                    - international_transaction_type_code
                    - originating_currency_code
                    - originating_depository_financial_institution_name
                    - originating_depository_financial_institution_id_qualifier
                    - originating_depository_financial_institution_id
                    - originating_depository_financial_institution_branch_country
                    - originator_city
                    - originator_company_entry_description
                    - originator_country
                    - originator_identification
                    - originator_name
                    - originator_postal_code
                    - originator_street_address
                    - originator_state_or_province
                    - payment_related_information
                    - payment_related_information2
                    - receiver_identification_number
                    - receiver_street_address
                    - receiver_city
                    - receiver_state_or_province
                    - receiver_country
                    - receiver_postal_code
                    - receiving_company_or_individual_name
                    - receiving_depository_financial_institution_name
                    - receiving_depository_financial_institution_id_qualifier
                    - receiving_depository_financial_institution_id
                    - receiving_depository_financial_institution_country
                    - trace_number
                  title: International ACH Decline
                  type: object
                  x-title-plural: International ACH Declines
              required:
                - category
                - ach_decline
                - card_decline
                - check_decline
                - inbound_real_time_payments_transfer_decline
                - international_ach_decline
                - card_route_decline
              title: Declined Transaction Source
              type: object
              x-title-plural: Declined Transaction Sources
            type:
              description: A constant representing the object's type. For this resource it will always be `declined_transaction`.
              enum:
                - declined_transaction
              type: string
          required:
            - account_id
            - amount
            - currency
            - created_at
            - description
            - id
            - route_id
            - route_type
            - source
            - type
          title: Declined Transaction
          type: object
          x-title-plural: Declined Transactions
        transaction:
          description: "If the Real Time Payments Transfer attempt succeeds, this will contain the resulting [Transaction](#transactions) object. The Transaction's `source` will be of `category: inbound_real_time_payments_transfer_confirmation`."
          example:
            account_id: account_in71c4amph0vgo2qllky
            amount: 100
            created_at: 2020-01-31T23:59:59Z
            currency: USD
            description: Frederick S. Holmes
            id: transaction_uyrp7fld2ium70oa7oi
            route_id: account_number_v18nkfqm6afpsrvy82b2
            route_type: account_number
            source:
              category: inbound_ach_transfer
              inbound_ach_transfer:
                amount: 100
                originator_company_descriptive_date: null
                originator_company_discretionary_data: null
                originator_company_entry_description: RESERVE
                originator_company_id: "0987654321"
                originator_company_name: BIG BANK
                receiver_id_number: "12345678900"
                receiver_name: IAN CREASE
                trace_number: "021000038461022"
            type: transaction
          nullable: true
          properties:
            account_id:
              description: The identifier for the Account the Transaction belongs to.
              type: string
            amount:
              description: The Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.
              type: integer
            created_at:
              description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Transaction occured.
              format: date-time
              type: string
            currency:
              description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Transaction's currency. This will match the currency on the Transcation's Account.
              enum:
                - CAD
                - CHF
                - EUR
                - GBP
                - JPY
                - USD
              type: string
              x-enum-descriptions:
                - Canadian Dollar (CAD)
                - Swiss Franc (CHF)
                - Euro (EUR)
                - British Pound (GBP)
                - Japanese Yen (JPY)
                - US Dollar (USD)
            description:
              description: For a Transaction related to a transfer, this is the description you provide. For a Transaction related to a payment, this is the description the vendor provides.
              type: string
            id:
              description: The Transaction identifier.
              type: string
            route_id:
              description: The identifier for the route this Transaction came through. Routes are things like cards and ACH details.
              nullable: true
              type: string
            route_type:
              description: The type of the route this Transaction came through.
              enum:
                - account_number
                - card
              nullable: true
              type: string
              x-enum-descriptions:
                - An Account Number.
                - A Card.
            source:
              description: This is an object giving more details on the network-level event that caused the Transaction. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.
              example:
                category: inbound_ach_transfer
                inbound_ach_transfer:
                  amount: 100
                  originator_company_descriptive_date: null
                  originator_company_discretionary_data: null
                  originator_company_entry_description: RESERVE
                  originator_company_id: "0987654321"
                  originator_company_name: BIG BANK
                  receiver_id_number: "12345678900"
                  receiver_name: IAN CREASE
                  trace_number: "021000038461022"
              properties:
                account_transfer_intention:
                  description: A Account Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `account_transfer_intention`.
                  example:
                    amount: 100
                    currency: USD
                    description: Frederick S. Holmes
                    destination_account_id: account_uf16sut2ct5bevmq3eh
                    source_account_id: account_in71c4amph0vgo2qllky
                    transfer_id: account_transfer_7k9qe1ysdgqztnt63l7n
                  nullable: true
                  properties:
                    amount:
                      description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    description:
                      description: The description you chose to give the transfer.
                      type: string
                    destination_account_id:
                      description: The identifier of the Account to where the Account Transfer was sent.
                      type: string
                    source_account_id:
                      description: The identifier of the Account from where the Account Transfer was sent.
                      type: string
                    transfer_id:
                      description: The identifier of the Account Transfer that led to this Pending Transaction.
                      type: string
                  required:
                    - amount
                    - currency
                    - description
                    - destination_account_id
                    - source_account_id
                    - transfer_id
                  title: Account Transfer Intention
                  type: object
                  x-title-plural: Account Transfer Intentions
                ach_check_conversion:
                  description: A ACH Check Conversion object. This field will be present in the JSON response if and only if `category` is equal to `ach_check_conversion`.
                  example:
                    amount: 100
                    file_id: file_makxrc67oh9l6sg7w9yc
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    file_id:
                      description: The identifier of the File containing an image of the returned check.
                      type: string
                  required:
                    - amount
                    - file_id
                  title: ACH Check Conversion
                  type: object
                  x-title-plural: ACH Check Conversions
                ach_check_conversion_return:
                  description: A ACH Check Conversion Return object. This field will be present in the JSON response if and only if `category` is equal to `ach_check_conversion_return`.
                  example:
                    amount: 100
                    return_reason_code: ""
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    return_reason_code:
                      description: Why the transfer was returned.
                      type: string
                  required:
                    - amount
                    - return_reason_code
                  title: ACH Check Conversion Return
                  type: object
                  x-title-plural: ACH Check Conversion Returns
                ach_transfer_intention:
                  description: A ACH Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_intention`.
                  example:
                    account_number: "987654321"
                    amount: 100
                    routing_number: "101050001"
                    statement_descriptor: Frederick S. Holmes
                    transfer_id: account_transfer_7k9qe1ysdgqztnt63l7n
                  nullable: true
                  properties:
                    account_number:
                      description: ""
                      type: string
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    routing_number:
                      description: ""
                      type: string
                    statement_descriptor:
                      description: ""
                      type: string
                    transfer_id:
                      description: The identifier of the ACH Transfer that led to this Transaction.
                      type: string
                  required:
                    - amount
                    - account_number
                    - routing_number
                    - statement_descriptor
                    - transfer_id
                  title: ACH Transfer Intention
                  type: object
                  x-title-plural: ACH Transfer Intentions
                ach_transfer_rejection:
                  description: A ACH Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_rejection`.
                  example:
                    transfer_id: account_transfer_7k9qe1ysdgqztnt63l7n
                  nullable: true
                  properties:
                    transfer_id:
                      description: The identifier of the ACH Transfer that led to this Transaction.
                      type: string
                  required:
                    - transfer_id
                  title: ACH Transfer Rejection
                  type: object
                  x-title-plural: ACH Transfer Rejections
                ach_transfer_return:
                  description: A ACH Transfer Return object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_return`.
                  example:
                    created_at: 2020-01-31T23:59:59Z
                    return_reason_code: insufficient_fund
                    transaction_id: transaction_uyrp7fld2ium70oa7oi
                    transfer_id: ach_transfer_uoxatyh3lt5evrsdvo7q
                  nullable: true
                  properties:
                    created_at:
                      description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.
                      format: date-time
                      type: string
                    return_reason_code:
                      description: Why the ACH Transfer was returned.
                      enum:
                        - insufficient_fund
                        - no_account
                        - account_closed
                        - invalid_account_number_structure
                        - account_frozen_entry_returned_per_ofac_instruction
                        - credit_entry_refused_by_receiver
                        - unauthorized_debit_to_consumer_account_using_corporate_sec_code
                        - corporate_customer_advised_not_authorized
                        - payment_stopped
                        - non_transaction_account
                        - uncollected_funds
                        - routing_number_check_digit_error
                        - customer_advised_unauthorized_improper_ineligible_or_incomplete
                        - amount_field_error
                        - authorization_revoked_by_customer
                        - invalid_ach_routing_number
                        - file_record_edit_criteria
                        - enr_invalid_individual_name
                        - returned_per_odfi_request
                        - addenda_error
                        - limited_participation_dfi
                        - incorrectly_coded_outbound_international_payment
                        - other
                      type: string
                      x-enum-descriptions:
                        - Insufficient funds in the source account.
                        - The account does not exist or the receiving bank was unable to locate it.
                        - The account is closed.
                        - The account number is invalid at the receiving bank.
                        - The account was frozen per the Office of Foreign Assets Control.
                        - The receiving bank account refused a credit transfer.
                        - The receiving bank rejected because of an incorrect Standard Entry Class code.
                        - The corporate customer reversed the transfer.
                        - The receiving bank stopped payment on this transfer.
                        - The receiving bank account does not perform transfers.
                        - The receiving bank account does not have enough available balance for the transfer.
                        - The routing number is incorrect.
                        - The customer reversed the transfer.
                        - The amount field is incorrect or too large.
                        - The customer who initiated the transfer revoked authorization.
                        - The routing number is invalid.
                        - The receiving bank is unable to process a field in the transfer.
                        - The individual name field was invalid.
                        - The originating financial institution reversed the transfer.
                        - The addenda record is incorrect or missing.
                        - The receiving bank's regulatory supervisor has limited their participation.
                        - The outbound international ACH transfer was incorrect.
                        - Any other ACH return reason.
                    transaction_id:
                      description: The identifier of the Tranasaction associated with this return.
                      type: string
                    transfer_id:
                      description: The identifier of the ACH Transfer associated with this return.
                      type: string
                  required:
                    - created_at
                    - return_reason_code
                    - transfer_id
                    - transaction_id
                  title: ACH Transfer Return
                  type: object
                  x-title-plural: ACH Transfer Returns
                card_dispute_acceptance:
                  description: A Card Dispute Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `card_dispute_acceptance`.
                  example:
                    accepted_at: 2020-01-31T23:59:59Z
                    card_dispute_id: card_dispute_h9sc95nbl1cgltpp7men
                    transaction_id: transaction_uyrp7fld2ium70oa7oi
                  nullable: true
                  properties:
                    accepted_at:
                      description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was accepted.
                      format: date-time
                      type: string
                    card_dispute_id:
                      description: The identifier of the Card Dispute that was accepted.
                      type: string
                    transaction_id:
                      description: The identifier of the Transaction that was created to return the disputed funds to your account.
                      type: string
                  required:
                    - accepted_at
                    - card_dispute_id
                    - transaction_id
                  title: Card Dispute Acceptance
                  type: object
                  x-title-plural: Card Dispute Acceptances
                card_refund:
                  description: A Card Refund object. This field will be present in the JSON response if and only if `category` is equal to `card_refund`.
                  example:
                    amount: 100
                    card_settlement_transaction_id: transaction_uyrp7fld2ium70oa7oi
                    currency: USD
                    id: card_refund_imgc2xwplh6t4r3gn16e
                    merchant_acceptor_id: "5665270011000168"
                    merchant_category_code: "5734"
                    merchant_city: New York
                    merchant_country: US
                    merchant_name: AMAZON.COM
                    merchant_state: NY
                    type: card_refund
                  nullable: true
                  properties:
                    amount:
                      description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    card_settlement_transaction_id:
                      description: The identifier for the Transaction this refunds, if any.
                      nullable: true
                      type: string
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    id:
                      description: The Card Refund identifier.
                      type: string
                    merchant_acceptor_id:
                      description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.
                      nullable: true
                      type: string
                    merchant_category_code:
                      description: The 4-digit MCC describing the merchant's business.
                      type: string
                    merchant_city:
                      description: The city the merchant resides in.
                      nullable: true
                      type: string
                    merchant_country:
                      description: The country the merchant resides in.
                      type: string
                    merchant_name:
                      description: The name of the merchant.
                      nullable: true
                      type: string
                    merchant_state:
                      description: The state the merchant resides in.
                      nullable: true
                      type: string
                    type:
                      description: A constant representing the object's type. For this resource it will always be `card_refund`.
                      enum:
                        - card_refund
                      type: string
                  required:
                    - id
                    - amount
                    - currency
                    - card_settlement_transaction_id
                    - merchant_acceptor_id
                    - merchant_city
                    - merchant_state
                    - merchant_country
                    - merchant_name
                    - merchant_category_code
                    - type
                  title: Card Refund
                  type: object
                  x-title-plural: Card Refunds
                card_revenue_payment:
                  description: A Card Revenue Payment object. This field will be present in the JSON response if and only if `category` is equal to `card_revenue_payment`.
                  example:
                    amount: 100
                    currency: USD
                    period_end: 2023-04-30T23:59:59Z
                    period_start: 2023-04-01T00:00:00Z
                    transacted_on_account_id: account_in71c4amph0vgo2qllky
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    period_end:
                      description: The end of the period for which this transaction paid interest.
                      format: date-time
                      type: string
                    period_start:
                      description: The start of the period for which this transaction paid interest.
                      format: date-time
                      type: string
                    transacted_on_account_id:
                      description: The account the card belonged to.
                      nullable: true
                      type: string
                  required:
                    - amount
                    - currency
                    - period_start
                    - period_end
                    - transacted_on_account_id
                  title: Card Revenue Payment
                  type: object
                  x-title-plural: Card Revenue Payments
                card_route_refund:
                  description: A Deprecated Card Refund object. This field will be present in the JSON response if and only if `category` is equal to `card_route_refund`.
                  example:
                    amount: 1000
                    currency: USD
                    merchant_acceptor_id: "372909060886"
                    merchant_category_code: "5998"
                    merchant_city: "5364086000"
                    merchant_country: USA
                    merchant_descriptor: TENTS R US
                    merchant_state: CA
                  nullable: true
                  properties:
                    amount:
                      description: The refunded amount in the minor unit of the refunded currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the refund currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    merchant_acceptor_id:
                      description: ""
                      type: string
                    merchant_category_code:
                      description: ""
                      nullable: true
                      type: string
                    merchant_city:
                      description: ""
                      nullable: true
                      type: string
                    merchant_country:
                      description: ""
                      type: string
                    merchant_descriptor:
                      description: ""
                      type: string
                    merchant_state:
                      description: ""
                      nullable: true
                      type: string
                  required:
                    - amount
                    - currency
                    - merchant_acceptor_id
                    - merchant_city
                    - merchant_country
                    - merchant_descriptor
                    - merchant_state
                    - merchant_category_code
                  title: Deprecated Card Refund
                  type: object
                  x-title-plural: Deprecated Card Refunds
                card_route_settlement:
                  description: A Deprecated Card Settlement object. This field will be present in the JSON response if and only if `category` is equal to `card_route_settlement`.
                  example:
                    amount: 1000
                    currency: USD
                    merchant_acceptor_id: "372909060886"
                    merchant_category_code: "5998"
                    merchant_city: "5364086000"
                    merchant_country: USA
                    merchant_descriptor: TENTS R US
                    merchant_state: CA
                  nullable: true
                  properties:
                    amount:
                      description: The settled amount in the minor unit of the settlement currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the settlement currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    merchant_acceptor_id:
                      description: ""
                      type: string
                    merchant_category_code:
                      description: ""
                      nullable: true
                      type: string
                    merchant_city:
                      description: ""
                      nullable: true
                      type: string
                    merchant_country:
                      description: ""
                      nullable: true
                      type: string
                    merchant_descriptor:
                      description: ""
                      type: string
                    merchant_state:
                      description: ""
                      nullable: true
                      type: string
                  required:
                    - amount
                    - currency
                    - merchant_acceptor_id
                    - merchant_city
                    - merchant_country
                    - merchant_descriptor
                    - merchant_state
                    - merchant_category_code
                  title: Deprecated Card Settlement
                  type: object
                  x-title-plural: Deprecated Card Settlements
                card_settlement:
                  description: A Card Settlement object. This field will be present in the JSON response if and only if `category` is equal to `card_settlement`.
                  example:
                    amount: 100
                    card_authorization: null
                    currency: USD
                    id: card_settlement_khv5kfeu0vndj291omg6
                    merchant_acceptor_id: "5665270011000168"
                    merchant_category_code: "5734"
                    merchant_city: New York
                    merchant_country: US
                    merchant_name: AMAZON.COM
                    merchant_state: NY
                    pending_transaction_id: null
                    presentment_amount: 100
                    presentment_currency: USD
                    type: card_settlement
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's settlement currency. For dollars, for example, this is cents.
                      type: integer
                    card_authorization:
                      description: The Card Authorization that was created prior to this Card Settlement, if on exists.
                      nullable: true
                      type: string
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's settlement currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    id:
                      description: The Card Settlement identifier.
                      type: string
                    merchant_acceptor_id:
                      description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.
                      nullable: true
                      type: string
                    merchant_category_code:
                      description: The 4-digit MCC describing the merchant's business.
                      type: string
                    merchant_city:
                      description: The city the merchant resides in.
                      nullable: true
                      type: string
                    merchant_country:
                      description: The country the merchant resides in.
                      type: string
                    merchant_name:
                      description: The name of the merchant.
                      nullable: true
                      type: string
                    merchant_state:
                      description: The state the merchant resides in.
                      nullable: true
                      type: string
                    pending_transaction_id:
                      description: The identifier of the Pending Transaction associated with this Transaction.
                      nullable: true
                      type: string
                    presentment_amount:
                      description: The amount in the minor unit of the transaction's presentment currency.
                      type: integer
                    presentment_currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's presentment currency.
                      type: string
                    type:
                      description: A constant representing the object's type. For this resource it will always be `card_settlement`.
                      enum:
                        - card_settlement
                      type: string
                  required:
                    - id
                    - card_authorization
                    - amount
                    - currency
                    - presentment_amount
                    - presentment_currency
                    - merchant_acceptor_id
                    - merchant_city
                    - merchant_state
                    - merchant_country
                    - merchant_name
                    - merchant_category_code
                    - pending_transaction_id
                    - type
                  title: Card Settlement
                  type: object
                  x-title-plural: Card Settlements
                category:
                  description: The type of transaction that took place. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
                  enum:
                    - account_transfer_intention
                    - ach_check_conversion_return
                    - ach_check_conversion
                    - ach_transfer_intention
                    - ach_transfer_rejection
                    - ach_transfer_return
                    - card_dispute_acceptance
                    - card_refund
                    - card_settlement
                    - card_revenue_payment
                    - check_deposit_acceptance
                    - check_deposit_return
                    - check_transfer_intention
                    - check_transfer_return
                    - check_transfer_rejection
                    - check_transfer_stop_payment_request
                    - dispute_resolution
                    - empyreal_cash_deposit
                    - fee_payment
                    - inbound_ach_transfer
                    - inbound_ach_transfer_return_intention
                    - inbound_check
                    - inbound_international_ach_transfer
                    - inbound_real_time_payments_transfer_confirmation
                    - inbound_wire_drawdown_payment_reversal
                    - inbound_wire_drawdown_payment
                    - inbound_wire_reversal
                    - inbound_wire_transfer
                    - interest_payment
                    - internal_general_ledger_transaction
                    - internal_source
                    - card_route_refund
                    - card_route_settlement
                    - real_time_payments_transfer_acknowledgement
                    - sample_funds
                    - wire_drawdown_payment_intention
                    - wire_drawdown_payment_rejection
                    - wire_transfer_intention
                    - wire_transfer_rejection
                    - other
                  type: string
                  x-enum-descriptions:
                    - The Transaction was created by a Account Transfer Intention object. Details will be under the `account_transfer_intention` object.
                    - The Transaction was created by a ACH Check Conversion Return object. Details will be under the `ach_check_conversion_return` object.
                    - The Transaction was created by a ACH Check Conversion object. Details will be under the `ach_check_conversion` object.
                    - The Transaction was created by a ACH Transfer Intention object. Details will be under the `ach_transfer_intention` object.
                    - The Transaction was created by a ACH Transfer Rejection object. Details will be under the `ach_transfer_rejection` object.
                    - The Transaction was created by a ACH Transfer Return object. Details will be under the `ach_transfer_return` object.
                    - The Transaction was created by a Card Dispute Acceptance object. Details will be under the `card_dispute_acceptance` object.
                    - The Transaction was created by a Card Refund object. Details will be under the `card_refund` object.
                    - The Transaction was created by a Card Settlement object. Details will be under the `card_settlement` object.
                    - The Transaction was created by a Card Revenue Payment object. Details will be under the `card_revenue_payment` object.
                    - The Transaction was created by a Check Deposit Acceptance object. Details will be under the `check_deposit_acceptance` object.
                    - The Transaction was created by a Check Deposit Return object. Details will be under the `check_deposit_return` object.
                    - The Transaction was created by a Check Transfer Intention object. Details will be under the `check_transfer_intention` object.
                    - The Transaction was created by a Check Transfer Return object. Details will be under the `check_transfer_return` object.
                    - The Transaction was created by a Check Transfer Rejection object. Details will be under the `check_transfer_rejection` object.
                    - The Transaction was created by a Check Transfer Stop Payment Request object. Details will be under the `check_transfer_stop_payment_request` object.
                    - The Transaction was created by a Dispute Resolution object. Details will be under the `dispute_resolution` object.
                    - The Transaction was created by a Empyreal Cash Deposit object. Details will be under the `empyreal_cash_deposit` object.
                    - The Transaction was created by a Fee Payment object. Details will be under the `fee_payment` object.
                    - The Transaction was created by a Inbound ACH Transfer object. Details will be under the `inbound_ach_transfer` object.
                    - The Transaction was created by a Inbound ACH Transfer Return Intention object. Details will be under the `inbound_ach_transfer_return_intention` object.
                    - The Transaction was created by a Inbound Check object. Details will be under the `inbound_check` object.
                    - The Transaction was created by a Inbound International ACH Transfer object. Details will be under the `inbound_international_ach_transfer` object.
                    - The Transaction was created by a Inbound Real Time Payments Transfer Confirmation object. Details will be under the `inbound_real_time_payments_transfer_confirmation` object.
                    - The Transaction was created by a Inbound Wire Drawdown Payment Reversal object. Details will be under the `inbound_wire_drawdown_payment_reversal` object.
                    - The Transaction was created by a Inbound Wire Drawdown Payment object. Details will be under the `inbound_wire_drawdown_payment` object.
                    - The Transaction was created by a Inbound Wire Reversal object. Details will be under the `inbound_wire_reversal` object.
                    - The Transaction was created by a Inbound Wire Transfer object. Details will be under the `inbound_wire_transfer` object.
                    - The Transaction was created by a Interest Payment object. Details will be under the `interest_payment` object.
                    - The Transaction was created by a Internal General Ledger Transaction object. Details will be under the `internal_general_ledger_transaction` object.
                    - The Transaction was created by a Internal Source object. Details will be under the `internal_source` object.
                    - The Transaction was created by a Deprecated Card Refund object. Details will be under the `card_route_refund` object.
                    - The Transaction was created by a Deprecated Card Settlement object. Details will be under the `card_route_settlement` object.
                    - The Transaction was created by a Real Time Payments Transfer Acknowledgement object. Details will be under the `real_time_payments_transfer_acknowledgement` object.
                    - The Transaction was created by a Sample Funds object. Details will be under the `sample_funds` object.
                    - The Transaction was created by a Wire Drawdown Payment Intention object. Details will be under the `wire_drawdown_payment_intention` object.
                    - The Transaction was created by a Wire Drawdown Payment Rejection object. Details will be under the `wire_drawdown_payment_rejection` object.
                    - The Transaction was created by a Wire Transfer Intention object. Details will be under the `wire_transfer_intention` object.
                    - The Transaction was created by a Wire Transfer Rejection object. Details will be under the `wire_transfer_rejection` object.
                    - The Transaction was made for an undocumented or deprecated reason.
                check_deposit_acceptance:
                  description: A Check Deposit Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_acceptance`.
                  example:
                    account_number: "987654321"
                    amount: 100
                    auxiliary_on_us: "101"
                    check_deposit_id: check_deposit_f06n9gpg7sxn8t19lfc1
                    currency: USD
                    routing_number: "101050001"
                    serial_number: null
                  nullable: true
                  properties:
                    account_number:
                      description: The account number printed on the check.
                      type: string
                    amount:
                      description: The amount to be deposited in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    auxiliary_on_us:
                      description: An additional line of metadata printed on the check. This typically includes the check number for business checks.
                      nullable: true
                      type: string
                    check_deposit_id:
                      description: The ID of the Check Deposit that was accepted.
                      type: string
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    routing_number:
                      description: The routing number printed on the check.
                      type: string
                    serial_number:
                      description: The check serial number, if present, for consumer checks. For business checks, the serial number is usually in the `auxiliary_on_us` field.
                      nullable: true
                      type: string
                  required:
                    - amount
                    - currency
                    - account_number
                    - routing_number
                    - auxiliary_on_us
                    - serial_number
                    - check_deposit_id
                  title: Check Deposit Acceptance
                  type: object
                  x-title-plural: Check Deposit Acceptances
                check_deposit_return:
                  description: A Check Deposit Return object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_return`.
                  example:
                    amount: 100
                    check_deposit_id: check_deposit_f06n9gpg7sxn8t19lfc1
                    currency: USD
                    return_reason: insufficient_funds
                    returned_at: 2020-01-31T23:59:59Z
                    transaction_id: transaction_uyrp7fld2ium70oa7oi
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    check_deposit_id:
                      description: The identifier of the Check Deposit that was returned.
                      type: string
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    return_reason:
                      description: ""
                      enum:
                        - ach_conversion_not_supported
                        - closed_account
                        - duplicate_submission
                        - insufficient_funds
                        - no_account
                        - not_authorized
                        - stale_dated
                        - stop_payment
                        - unknown_reason
                        - unmatched_details
                        - unreadable_image
                      type: string
                      x-enum-descriptions:
                        - The check doesn't allow ACH conversion.
                        - The account is closed.
                        - The check has already been deposited.
                        - Insufficient funds
                        - No account was found matching the check details.
                        - The check was not authorized.
                        - The check is too old.
                        - The payment has been stopped by the account holder.
                        - The reason for the return is unknown.
                        - The image doesn't match the details submitted.
                        - The image could not be read.
                    returned_at:
                      description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check deposit was returned.
                      format: date-time
                      type: string
                    transaction_id:
                      description: The identifier of the transaction that reversed the original check deposit transaction.
                      type: string
                  required:
                    - amount
                    - returned_at
                    - currency
                    - check_deposit_id
                    - transaction_id
                    - return_reason
                  title: Check Deposit Return
                  type: object
                  x-title-plural: Check Deposit Returns
                check_transfer_intention:
                  description: A Check Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_intention`.
                  example:
                    address_city: New York
                    address_line1: 33 Liberty Street
                    address_line2: null
                    address_state: NY
                    address_zip: "10045"
                    amount: 1000
                    currency: USD
                    recipient_name: Ian Crease
                    transfer_id: check_transfer_30b43acfu9vw8fyc4f5
                  nullable: true
                  properties:
                    address_city:
                      description: The city of the check's destination.
                      type: string
                    address_line1:
                      description: The street address of the check's destination.
                      type: string
                    address_line2:
                      description: The second line of the address of the check's destination.
                      nullable: true
                      type: string
                    address_state:
                      description: The state of the check's destination.
                      type: string
                    address_zip:
                      description: The postal code of the check's destination.
                      type: string
                    amount:
                      description: The transfer amount in USD cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    recipient_name:
                      description: The name that will be printed on the check.
                      type: string
                    transfer_id:
                      description: The identifier of the Check Transfer with which this is associated.
                      type: string
                  required:
                    - address_line1
                    - address_line2
                    - address_city
                    - address_state
                    - address_zip
                    - amount
                    - currency
                    - recipient_name
                    - transfer_id
                  title: Check Transfer Intention
                  type: object
                  x-title-plural: Check Transfer Intentions
                check_transfer_rejection:
                  description: A Check Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_rejection`.
                  example:
                    transfer_id: check_transfer_30b43acfu9vw8fyc4f5
                  nullable: true
                  properties:
                    transfer_id:
                      description: The identifier of the Check Transfer that led to this Transaction.
                      type: string
                  required:
                    - transfer_id
                  title: Check Transfer Rejection
                  type: object
                  x-title-plural: Check Transfer Rejections
                check_transfer_return:
                  description: A Check Transfer Return object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_return`.
                  example:
                    file_id: null
                    reason: mail_delivery_failure
                    returned_at: 2020-01-31T23:59:59Z
                    transaction_id: transaction_uyrp7fld2ium70oa7oi
                    transfer_id: check_transfer_30b43acfu9vw8fyc4f5
                  nullable: true
                  properties:
                    file_id:
                      description: If available, a document with additional information about the return.
                      nullable: true
                      type: string
                    reason:
                      description: The reason why the check was returned.
                      enum:
                        - mail_delivery_failure
                        - refused_by_recipient
                      type: string
                      x-enum-descriptions:
                        - Mail delivery failed and the check was returned to sender.
                        - The check arrived and the recipient refused to deposit it.
                    returned_at:
                      description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check was returned.
                      format: date-time
                      type: string
                    transaction_id:
                      description: The identifier of the Transaction that was created to credit you for the returned check.
                      nullable: true
                      type: string
                    transfer_id:
                      description: The identifier of the returned Check Transfer.
                      type: string
                  required:
                    - transfer_id
                    - returned_at
                    - file_id
                    - reason
                    - transaction_id
                  title: Check Transfer Return
                  type: object
                  x-title-plural: Check Transfer Returns
                check_transfer_stop_payment_request:
                  description: A Check Transfer Stop Payment Request object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_stop_payment_request`.
                  example:
                    requested_at: 2020-01-31T23:59:59Z
                    transaction_id: transaction_uyrp7fld2ium70oa7oi
                    transfer_id: check_transfer_30b43acfu9vw8fyc4f5
                    type: check_transfer_stop_payment_request
                  nullable: true
                  properties:
                    requested_at:
                      description: The time the stop-payment was requested.
                      format: date-time
                      type: string
                    transaction_id:
                      description: The transaction ID of the corresponding credit transaction.
                      type: string
                    transfer_id:
                      description: The ID of the check transfer that was stopped.
                      type: string
                    type:
                      description: A constant representing the object's type. For this resource it will always be `check_transfer_stop_payment_request`.
                      enum:
                        - check_transfer_stop_payment_request
                      type: string
                  required:
                    - transfer_id
                    - transaction_id
                    - requested_at
                    - type
                  title: Check Transfer Stop Payment Request
                  type: object
                  x-title-plural: Check Transfer Stop Payment Requests
                dispute_resolution:
                  description: A Dispute Resolution object. This field will be present in the JSON response if and only if `category` is equal to `dispute_resolution`.
                  example:
                    amount: 100
                    currency: USD
                    disputed_transaction_id: transaction_uyrp7fld2ium70oa7oi
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    disputed_transaction_id:
                      description: The identifier of the Transaction that was disputed.
                      type: string
                  required:
                    - amount
                    - currency
                    - disputed_transaction_id
                  title: Dispute Resolution
                  type: object
                  x-title-plural: Dispute Resolutions
                empyreal_cash_deposit:
                  description: A Empyreal Cash Deposit object. This field will be present in the JSON response if and only if `category` is equal to `empyreal_cash_deposit`.
                  example:
                    amount: 100
                    bag_id: "12345"
                    deposit_date: 2020-01-31T23:59:59Z
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    bag_id:
                      description: ""
                      type: string
                    deposit_date:
                      description: ""
                      format: date-time
                      type: string
                  required:
                    - amount
                    - bag_id
                    - deposit_date
                  title: Empyreal Cash Deposit
                  type: object
                  x-title-plural: Empyreal Cash Deposits
                fee_payment:
                  description: A Fee Payment object. This field will be present in the JSON response if and only if `category` is equal to `fee_payment`.
                  example:
                    amount: 100
                    currency: USD
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                  required:
                    - amount
                    - currency
                  title: Fee Payment
                  type: object
                  x-title-plural: Fee Payments
                inbound_ach_transfer:
                  description: A Inbound ACH Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_ach_transfer`.
                  example:
                    amount: 100
                    originator_company_descriptive_date: null
                    originator_company_discretionary_data: null
                    originator_company_entry_description: RESERVE
                    originator_company_id: "0987654321"
                    originator_company_name: BIG BANK
                    receiver_id_number: "12345678900"
                    receiver_name: IAN CREASE
                    trace_number: "021000038461022"
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    originator_company_descriptive_date:
                      description: ""
                      nullable: true
                      type: string
                    originator_company_discretionary_data:
                      description: ""
                      nullable: true
                      type: string
                    originator_company_entry_description:
                      description: ""
                      type: string
                    originator_company_id:
                      description: ""
                      type: string
                    originator_company_name:
                      description: ""
                      type: string
                    receiver_id_number:
                      description: ""
                      nullable: true
                      type: string
                    receiver_name:
                      description: ""
                      nullable: true
                      type: string
                    trace_number:
                      description: ""
                      type: string
                  required:
                    - amount
                    - originator_company_name
                    - originator_company_descriptive_date
                    - originator_company_discretionary_data
                    - originator_company_entry_description
                    - originator_company_id
                    - receiver_id_number
                    - receiver_name
                    - trace_number
                  title: Inbound ACH Transfer
                  type: object
                  x-title-plural: Inbound ACH Transfers
                inbound_check:
                  description: A Inbound Check object. This field will be present in the JSON response if and only if `category` is equal to `inbound_check`.
                  example:
                    amount: 100
                    check_front_image_file_id: file_makxrc67oh9l6sg7w9yc
                    check_number: "       00000123"
                    check_rear_image_file_id: file_makxrc67oh9l6sg7w9yc
                    currency: USD
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    check_front_image_file_id:
                      description: ""
                      nullable: true
                      type: string
                    check_number:
                      description: ""
                      nullable: true
                      type: string
                    check_rear_image_file_id:
                      description: ""
                      nullable: true
                      type: string
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                  required:
                    - amount
                    - currency
                    - check_number
                    - check_front_image_file_id
                    - check_rear_image_file_id
                  title: Inbound Check
                  type: object
                  x-title-plural: Inbound Checks
                inbound_international_ach_transfer:
                  description: A Inbound International ACH Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_international_ach_transfer`.
                  example:
                    amount: -1000
                    destination_country_code: US
                    destination_currency_code: USD
                    foreign_exchange_indicator: fixed_to_fixed
                    foreign_exchange_reference: null
                    foreign_exchange_reference_indicator: blank
                    foreign_payment_amount: 199
                    foreign_trace_number: null
                    international_transaction_type_code: internet_initiated
                    originating_currency_code: USD
                    originating_depository_financial_institution_branch_country: US
                    originating_depository_financial_institution_id: "091000019"
                    originating_depository_financial_institution_id_qualifier: national_clearing_system_number
                    originating_depository_financial_institution_name: WELLS FARGO BANK
                    originator_city: BERLIN
                    originator_company_entry_description: RETRY PYMT
                    originator_country: DE
                    originator_identification: 770510487A
                    originator_name: BERGHAIN
                    originator_postal_code: "50825"
                    originator_state_or_province: null
                    originator_street_address: Ruedersdorferstr. 7
                    payment_related_information: null
                    payment_related_information2: null
                    receiver_city: BEVERLY HILLS
                    receiver_country: US
                    receiver_identification_number: "1018790279274"
                    receiver_postal_code: "90210"
                    receiver_state_or_province: CA
                    receiver_street_address: 123 FAKE ST
                    receiving_company_or_individual_name: IAN CREASE
                    receiving_depository_financial_institution_country: US
                    receiving_depository_financial_institution_id: "101050001"
                    receiving_depository_financial_institution_id_qualifier: national_clearing_system_number
                    receiving_depository_financial_institution_name: BLUE RIDGE BANK, NATIONAL ASSOCIATI
                    trace_number: "010202909100090"
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    destination_country_code:
                      description: ""
                      type: string
                    destination_currency_code:
                      description: ""
                      type: string
                    foreign_exchange_indicator:
                      description: ""
                      type: string
                    foreign_exchange_reference:
                      description: ""
                      nullable: true
                      type: string
                    foreign_exchange_reference_indicator:
                      description: ""
                      type: string
                    foreign_payment_amount:
                      description: ""
                      type: integer
                    foreign_trace_number:
                      description: ""
                      nullable: true
                      type: string
                    international_transaction_type_code:
                      description: ""
                      type: string
                    originating_currency_code:
                      description: ""
                      type: string
                    originating_depository_financial_institution_branch_country:
                      description: ""
                      type: string
                    originating_depository_financial_institution_id:
                      description: ""
                      type: string
                    originating_depository_financial_institution_id_qualifier:
                      description: ""
                      type: string
                    originating_depository_financial_institution_name:
                      description: ""
                      type: string
                    originator_city:
                      description: ""
                      type: string
                    originator_company_entry_description:
                      description: ""
                      type: string
                    originator_country:
                      description: ""
                      type: string
                    originator_identification:
                      description: ""
                      type: string
                    originator_name:
                      description: ""
                      type: string
                    originator_postal_code:
                      description: ""
                      nullable: true
                      type: string
                    originator_state_or_province:
                      description: ""
                      nullable: true
                      type: string
                    originator_street_address:
                      description: ""
                      type: string
                    payment_related_information:
                      description: ""
                      nullable: true
                      type: string
                    payment_related_information2:
                      description: ""
                      nullable: true
                      type: string
                    receiver_city:
                      description: ""
                      type: string
                    receiver_country:
                      description: ""
                      type: string
                    receiver_identification_number:
                      description: ""
                      nullable: true
                      type: string
                    receiver_postal_code:
                      description: ""
                      nullable: true
                      type: string
                    receiver_state_or_province:
                      description: ""
                      nullable: true
                      type: string
                    receiver_street_address:
                      description: ""
                      type: string
                    receiving_company_or_individual_name:
                      description: ""
                      type: string
                    receiving_depository_financial_institution_country:
                      description: ""
                      type: string
                    receiving_depository_financial_institution_id:
                      description: ""
                      type: string
                    receiving_depository_financial_institution_id_qualifier:
                      description: ""
                      type: string
                    receiving_depository_financial_institution_name:
                      description: ""
                      type: string
                    trace_number:
                      description: ""
                      type: string
                  required:
                    - amount
                    - foreign_exchange_indicator
                    - foreign_exchange_reference_indicator
                    - foreign_exchange_reference
                    - destination_country_code
                    - destination_currency_code
                    - foreign_payment_amount
                    - foreign_trace_number
                    - international_transaction_type_code
                    - originating_currency_code
                    - originating_depository_financial_institution_name
                    - originating_depository_financial_institution_id_qualifier
                    - originating_depository_financial_institution_id
                    - originating_depository_financial_institution_branch_country
                    - originator_city
                    - originator_company_entry_description
                    - originator_country
                    - originator_identification
                    - originator_name
                    - originator_postal_code
                    - originator_street_address
                    - originator_state_or_province
                    - payment_related_information
                    - payment_related_information2
                    - receiver_identification_number
                    - receiver_street_address
                    - receiver_city
                    - receiver_state_or_province
                    - receiver_country
                    - receiver_postal_code
                    - receiving_company_or_individual_name
                    - receiving_depository_financial_institution_name
                    - receiving_depository_financial_institution_id_qualifier
                    - receiving_depository_financial_institution_id
                    - receiving_depository_financial_institution_country
                    - trace_number
                  title: Inbound International ACH Transfer
                  type: object
                  x-title-plural: Inbound International ACH Transfers
                inbound_real_time_payments_transfer_confirmation:
                  description: A Inbound Real Time Payments Transfer Confirmation object. This field will be present in the JSON response if and only if `category` is equal to `inbound_real_time_payments_transfer_confirmation`.
                  example:
                    amount: 100
                    creditor_name: Ian Crease
                    currency: USD
                    debtor_account_number: "987654321"
                    debtor_name: National Phonograph Company
                    debtor_routing_number: "101050001"
                    remittance_information: Invoice 29582
                    transaction_identification: 20220501234567891T1BSLZO01745013025
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transfer's currency. For dollars, for example, this is cents.
                      type: integer
                    creditor_name:
                      description: The name the sender of the transfer specified as the recipient of the transfer.
                      type: string
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's currency. This will always be "USD" for a Real Time Payments transfer.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    debtor_account_number:
                      description: The account number of the account that sent the transfer.
                      type: string
                    debtor_name:
                      description: The name provided by the sender of the transfer.
                      type: string
                    debtor_routing_number:
                      description: The routing number of the account that sent the transfer.
                      type: string
                    remittance_information:
                      description: Additional information included with the transfer.
                      nullable: true
                      type: string
                    transaction_identification:
                      description: The Real Time Payments network identification of the transfer
                      type: string
                  required:
                    - amount
                    - currency
                    - creditor_name
                    - debtor_name
                    - debtor_account_number
                    - debtor_routing_number
                    - transaction_identification
                    - remittance_information
                  title: Inbound Real Time Payments Transfer Confirmation
                  type: object
                  x-title-plural: Inbound Real Time Payments Transfer Confirmations
                inbound_wire_drawdown_payment:
                  description: A Inbound Wire Drawdown Payment object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
                  example:
                    amount: 100
                    beneficiary_address_line1: null
                    beneficiary_address_line2: null
                    beneficiary_address_line3: null
                    beneficiary_name: null
                    beneficiary_reference: null
                    description: Inbound wire drawdown payment
                    input_message_accountability_data: null
                    originator_address_line1: null
                    originator_address_line2: null
                    originator_address_line3: null
                    originator_name: null
                    originator_to_beneficiary_information: null
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    beneficiary_address_line1:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_address_line2:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_address_line3:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_name:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_reference:
                      description: ""
                      nullable: true
                      type: string
                    description:
                      description: ""
                      type: string
                    input_message_accountability_data:
                      description: ""
                      nullable: true
                      type: string
                    originator_address_line1:
                      description: ""
                      nullable: true
                      type: string
                    originator_address_line2:
                      description: ""
                      nullable: true
                      type: string
                    originator_address_line3:
                      description: ""
                      nullable: true
                      type: string
                    originator_name:
                      description: ""
                      nullable: true
                      type: string
                    originator_to_beneficiary_information:
                      description: ""
                      nullable: true
                      type: string
                  required:
                    - amount
                    - beneficiary_address_line1
                    - beneficiary_address_line2
                    - beneficiary_address_line3
                    - beneficiary_name
                    - beneficiary_reference
                    - description
                    - input_message_accountability_data
                    - originator_address_line1
                    - originator_address_line2
                    - originator_address_line3
                    - originator_name
                    - originator_to_beneficiary_information
                  title: Inbound Wire Drawdown Payment
                  type: object
                  x-title-plural: Inbound Wire Drawdown Payments
                inbound_wire_drawdown_payment_reversal:
                  description: A Inbound Wire Drawdown Payment Reversal object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_drawdown_payment_reversal`.
                  example:
                    amount: 12345
                    description: Inbound wire reversal 2022021100335128
                    input_cycle_date: 2022-02-11
                    input_message_accountability_data: 20220211B6B7HU2R011023
                    input_sequence_number: "11023"
                    input_source: B6B7HU2R
                    previous_message_input_cycle_date: 2022-02-10
                    previous_message_input_message_accountability_data: 20220210MMQFMP0P000007
                    previous_message_input_sequence_number: "3"
                    previous_message_input_source: MMQFMP0P
                  nullable: true
                  properties:
                    amount:
                      description: The amount that was reversed.
                      type: integer
                    description:
                      description: The description on the reversal message from Fedwire.
                      type: string
                    input_cycle_date:
                      description: The Fedwire cycle date for the wire reversal.
                      format: date
                      type: string
                    input_message_accountability_data:
                      description: The Fedwire transaction identifier.
                      type: string
                    input_sequence_number:
                      description: The Fedwire sequence number.
                      type: string
                    input_source:
                      description: The Fedwire input source identifier.
                      type: string
                    previous_message_input_cycle_date:
                      description: The Fedwire cycle date for the wire transfer that was reversed.
                      format: date
                      type: string
                    previous_message_input_message_accountability_data:
                      description: The Fedwire transaction identifier for the wire transfer that was reversed.
                      type: string
                    previous_message_input_sequence_number:
                      description: The Fedwire sequence number for the wire transfer that was reversed.
                      type: string
                    previous_message_input_source:
                      description: The Fedwire input source identifier for the wire transfer that was reversed.
                      type: string
                  required:
                    - amount
                    - description
                    - input_cycle_date
                    - input_sequence_number
                    - input_source
                    - input_message_accountability_data
                    - previous_message_input_message_accountability_data
                    - previous_message_input_cycle_date
                    - previous_message_input_sequence_number
                    - previous_message_input_source
                  title: Inbound Wire Drawdown Payment Reversal
                  type: object
                  x-title-plural: Inbound Wire Drawdown Payment Reversals
                inbound_wire_reversal:
                  description: A Inbound Wire Reversal object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_reversal`.
                  example:
                    amount: 12345
                    created_at: 2020-01-31T23:59:59Z
                    description: Inbound wire reversal 2022021100335128
                    financial_institution_to_financial_institution_information: null
                    input_cycle_date: 2022-02-11
                    input_message_accountability_data: 20220211B6B7HU2R011023
                    input_sequence_number: "11023"
                    input_source: B6B7HU2R
                    previous_message_input_cycle_date: 2022-02-10
                    previous_message_input_message_accountability_data: 20220210MMQFMP0P000007
                    previous_message_input_sequence_number: "3"
                    previous_message_input_source: MMQFMP0P
                    receiver_financial_institution_information: null
                    transaction_id: transaction_uyrp7fld2ium70oa7oi
                  nullable: true
                  properties:
                    amount:
                      description: The amount that was reversed.
                      type: integer
                    created_at:
                      description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the reversal was created.
                      format: date-time
                      type: string
                    description:
                      description: The description on the reversal message from Fedwire.
                      type: string
                    financial_institution_to_financial_institution_information:
                      description: Additional financial institution information included in the wire reversal.
                      nullable: true
                      type: string
                    input_cycle_date:
                      description: The Fedwire cycle date for the wire reversal.
                      format: date
                      type: string
                    input_message_accountability_data:
                      description: The Fedwire transaction identifier.
                      type: string
                    input_sequence_number:
                      description: The Fedwire sequence number.
                      type: string
                    input_source:
                      description: The Fedwire input source identifier.
                      type: string
                    previous_message_input_cycle_date:
                      description: The Fedwire cycle date for the wire transfer that was reversed.
                      format: date
                      type: string
                    previous_message_input_message_accountability_data:
                      description: The Fedwire transaction identifier for the wire transfer that was reversed.
                      type: string
                    previous_message_input_sequence_number:
                      description: The Fedwire sequence number for the wire transfer that was reversed.
                      type: string
                    previous_message_input_source:
                      description: The Fedwire input source identifier for the wire transfer that was reversed.
                      type: string
                    receiver_financial_institution_information:
                      description: Information included in the wire reversal for the receiving financial institution.
                      nullable: true
                      type: string
                    transaction_id:
                      description: The ID for the Transaction associated with the transfer reversal.
                      nullable: true
                      type: string
                  required:
                    - amount
                    - created_at
                    - description
                    - input_cycle_date
                    - input_sequence_number
                    - input_source
                    - input_message_accountability_data
                    - previous_message_input_message_accountability_data
                    - previous_message_input_cycle_date
                    - previous_message_input_sequence_number
                    - previous_message_input_source
                    - receiver_financial_institution_information
                    - financial_institution_to_financial_institution_information
                    - transaction_id
                  title: Inbound Wire Reversal
                  type: object
                  x-title-plural: Inbound Wire Reversals
                inbound_wire_transfer:
                  description: A Inbound Wire Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_transfer`.
                  example:
                    amount: 100
                    beneficiary_address_line1: null
                    beneficiary_address_line2: null
                    beneficiary_address_line3: null
                    beneficiary_name: null
                    beneficiary_reference: null
                    description: Inbound wire transfer
                    input_message_accountability_data: null
                    originator_address_line1: null
                    originator_address_line2: null
                    originator_address_line3: null
                    originator_name: null
                    originator_to_beneficiary_information: null
                    originator_to_beneficiary_information_line1: null
                    originator_to_beneficiary_information_line2: null
                    originator_to_beneficiary_information_line3: null
                    originator_to_beneficiary_information_line4: null
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    beneficiary_address_line1:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_address_line2:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_address_line3:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_name:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_reference:
                      description: ""
                      nullable: true
                      type: string
                    description:
                      description: ""
                      type: string
                    input_message_accountability_data:
                      description: ""
                      nullable: true
                      type: string
                    originator_address_line1:
                      description: ""
                      nullable: true
                      type: string
                    originator_address_line2:
                      description: ""
                      nullable: true
                      type: string
                    originator_address_line3:
                      description: ""
                      nullable: true
                      type: string
                    originator_name:
                      description: ""
                      nullable: true
                      type: string
                    originator_to_beneficiary_information:
                      description: ""
                      nullable: true
                      type: string
                    originator_to_beneficiary_information_line1:
                      description: ""
                      nullable: true
                      type: string
                    originator_to_beneficiary_information_line2:
                      description: ""
                      nullable: true
                      type: string
                    originator_to_beneficiary_information_line3:
                      description: ""
                      nullable: true
                      type: string
                    originator_to_beneficiary_information_line4:
                      description: ""
                      nullable: true
                      type: string
                  required:
                    - amount
                    - beneficiary_address_line1
                    - beneficiary_address_line2
                    - beneficiary_address_line3
                    - beneficiary_name
                    - beneficiary_reference
                    - description
                    - input_message_accountability_data
                    - originator_address_line1
                    - originator_address_line2
                    - originator_address_line3
                    - originator_name
                    - originator_to_beneficiary_information_line1
                    - originator_to_beneficiary_information_line2
                    - originator_to_beneficiary_information_line3
                    - originator_to_beneficiary_information_line4
                    - originator_to_beneficiary_information
                  title: Inbound Wire Transfer
                  type: object
                  x-title-plural: Inbound Wire Transfers
                interest_payment:
                  description: A Interest Payment object. This field will be present in the JSON response if and only if `category` is equal to `interest_payment`.
                  example:
                    accrued_on_account_id: account_in71c4amph0vgo2qllky
                    amount: 100
                    currency: USD
                    period_end: 2023-04-30T23:59:59Z
                    period_start: 2023-04-01T00:00:00Z
                  nullable: true
                  properties:
                    accrued_on_account_id:
                      description: The account on which the interest was accrued.
                      nullable: true
                      type: string
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    period_end:
                      description: The end of the period for which this transaction paid interest.
                      format: date-time
                      type: string
                    period_start:
                      description: The start of the period for which this transaction paid interest.
                      format: date-time
                      type: string
                  required:
                    - amount
                    - currency
                    - period_start
                    - period_end
                    - accrued_on_account_id
                  title: Interest Payment
                  type: object
                  x-title-plural: Interest Payments
                internal_source:
                  description: A Internal Source object. This field will be present in the JSON response if and only if `category` is equal to `internal_source`.
                  example:
                    amount: 100
                    currency: USD
                    reason: sample_funds
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    reason:
                      description: ""
                      enum:
                        - bank_migration
                        - cashback
                        - empyreal_adjustment
                        - error
                        - error_correction
                        - fees
                        - interest
                        - sample_funds
                        - sample_funds_return
                      type: string
                      x-enum-descriptions:
                        - Bank Migration
                        - Cashback
                        - Empyreal adjustment
                        - Error
                        - Error correction
                        - Fees
                        - Interest
                        - Sample funds
                        - Sample funds return
                  required:
                    - amount
                    - currency
                    - reason
                  title: Internal Source
                  type: object
                  x-title-plural: Internal Sources
                real_time_payments_transfer_acknowledgement:
                  description: A Real Time Payments Transfer Acknowledgement object. This field will be present in the JSON response if and only if `category` is equal to `real_time_payments_transfer_acknowledgement`.
                  example:
                    amount: 100
                    destination_account_number: "987654321"
                    destination_routing_number: "101050001"
                    remittance_information: Invoice 29582
                    transfer_id: real_time_payments_transfer_iyuhl5kdn7ssmup83mvq
                  nullable: true
                  properties:
                    amount:
                      description: The transfer amount in USD cents.
                      type: integer
                    destination_account_number:
                      description: The destination account number.
                      type: string
                    destination_routing_number:
                      description: The American Bankers' Association (ABA) Routing Transit Number (RTN).
                      type: string
                    remittance_information:
                      description: Unstructured information that will show on the recipient's bank statement.
                      type: string
                    transfer_id:
                      description: The identifier of the Real Time Payments Transfer that led to this Transaction.
                      type: string
                  required:
                    - amount
                    - destination_account_number
                    - destination_routing_number
                    - remittance_information
                    - transfer_id
                  title: Real Time Payments Transfer Acknowledgement
                  type: object
                  x-title-plural: Real Time Payments Transfer Acknowledgements
                sample_funds:
                  description: A Sample Funds object. This field will be present in the JSON response if and only if `category` is equal to `sample_funds`.
                  example:
                    originator: dashboard
                  nullable: true
                  properties:
                    originator:
                      description: Where the sample funds came from.
                      type: string
                  required:
                    - originator
                  title: Sample Funds
                  type: object
                  x-title-plural: Sample Fundss
                wire_drawdown_payment_intention:
                  description: A Wire Drawdown Payment Intention object. This field will be present in the JSON response if and only if `category` is equal to `wire_drawdown_payment_intention`.
                  example:
                    account_number: "987654321"
                    amount: 100
                    message_to_recipient: HELLO
                    routing_number: "101050001"
                    transfer_id: wire_transfer_5akynk7dqsq25qwk9q2u
                  nullable: true
                  properties:
                    account_number:
                      description: ""
                      type: string
                    amount:
                      description: The transfer amount in USD cents.
                      type: integer
                    message_to_recipient:
                      description: ""
                      type: string
                    routing_number:
                      description: ""
                      type: string
                    transfer_id:
                      description: ""
                      type: string
                  required:
                    - amount
                    - account_number
                    - routing_number
                    - message_to_recipient
                    - transfer_id
                  title: Wire Drawdown Payment Intention
                  type: object
                  x-title-plural: Wire Drawdown Payment Intentions
                wire_drawdown_payment_rejection:
                  description: A Wire Drawdown Payment Rejection object. This field will be present in the JSON response if and only if `category` is equal to `wire_drawdown_payment_rejection`.
                  example:
                    transfer_id: wire_transfer_5akynk7dqsq25qwk9q2u
                  nullable: true
                  properties:
                    transfer_id:
                      description: ""
                      type: string
                  required:
                    - transfer_id
                  title: Wire Drawdown Payment Rejection
                  type: object
                  x-title-plural: Wire Drawdown Payment Rejections
                wire_transfer_intention:
                  description: A Wire Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_intention`.
                  example:
                    account_number: "987654321"
                    amount: 100
                    message_to_recipient: HELLO
                    routing_number: "101050001"
                    transfer_id: wire_transfer_5akynk7dqsq25qwk9q2u
                  nullable: true
                  properties:
                    account_number:
                      description: The destination account number.
                      type: string
                    amount:
                      description: The transfer amount in USD cents.
                      type: integer
                    message_to_recipient:
                      description: The message that will show on the recipient's bank statement.
                      type: string
                    routing_number:
                      description: The American Bankers' Association (ABA) Routing Transit Number (RTN).
                      type: string
                    transfer_id:
                      description: ""
                      type: string
                  required:
                    - amount
                    - account_number
                    - routing_number
                    - message_to_recipient
                    - transfer_id
                  title: Wire Transfer Intention
                  type: object
                  x-title-plural: Wire Transfer Intentions
                wire_transfer_rejection:
                  description: A Wire Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_rejection`.
                  example:
                    transfer_id: wire_transfer_5akynk7dqsq25qwk9q2u
                  nullable: true
                  properties:
                    transfer_id:
                      description: ""
                      type: string
                  required:
                    - transfer_id
                  title: Wire Transfer Rejection
                  type: object
                  x-title-plural: Wire Transfer Rejections
              required:
                - category
                - account_transfer_intention
                - ach_check_conversion_return
                - ach_check_conversion
                - ach_transfer_intention
                - ach_transfer_rejection
                - ach_transfer_return
                - card_dispute_acceptance
                - card_refund
                - card_settlement
                - card_revenue_payment
                - check_deposit_acceptance
                - check_deposit_return
                - check_transfer_intention
                - check_transfer_return
                - check_transfer_rejection
                - check_transfer_stop_payment_request
                - dispute_resolution
                - empyreal_cash_deposit
                - fee_payment
                - inbound_ach_transfer
                - inbound_check
                - inbound_international_ach_transfer
                - inbound_real_time_payments_transfer_confirmation
                - inbound_wire_drawdown_payment_reversal
                - inbound_wire_drawdown_payment
                - inbound_wire_reversal
                - inbound_wire_transfer
                - interest_payment
                - internal_source
                - card_route_refund
                - card_route_settlement
                - real_time_payments_transfer_acknowledgement
                - sample_funds
                - wire_drawdown_payment_intention
                - wire_drawdown_payment_rejection
                - wire_transfer_intention
                - wire_transfer_rejection
              title: Transaction Source
              type: object
              x-title-plural: Transaction Sources
            type:
              description: A constant representing the object's type. For this resource it will always be `transaction`.
              enum:
                - transaction
              type: string
          required:
            - account_id
            - amount
            - currency
            - created_at
            - description
            - id
            - route_id
            - route_type
            - source
            - type
          title: Transaction
          type: object
          x-title-plural: Transactions
        type:
          description: A constant representing the object's type. For this resource it will always be `inbound_real_time_payments_transfer_simulation_result`.
          enum:
            - inbound_real_time_payments_transfer_simulation_result
          type: string
      required:
        - transaction
        - declined_transaction
        - type
      title: Inbound Real Time Payments Transfer Simulation Result
      type: object
      x-title-plural: Inbound Real Time Payments Transfer Simulation Results
    inbound_wire_drawdown_request:
      description: Inbound wire drawdown requests are requests from someone else to send them a wire. This feature is in beta; reach out to [support@increase.com](mailto:support@increase.com) to learn more.
      example:
        amount: 10000
        beneficiary_account_number: "987654321"
        beneficiary_address_line1: 33 Liberty Street
        beneficiary_address_line2: New York, NY, 10045
        beneficiary_address_line3: null
        beneficiary_name: Ian Crease
        beneficiary_routing_number: "101050001"
        currency: USD
        id: inbound_wire_drawdown_request_u5a92ikqhz1ytphn799e
        message_to_recipient: Invoice 29582
        originator_account_number: "987654321"
        originator_address_line1: 33 Liberty Street
        originator_address_line2: New York, NY, 10045
        originator_address_line3: null
        originator_name: Ian Crease
        originator_routing_number: "101050001"
        originator_to_beneficiary_information_line1: null
        originator_to_beneficiary_information_line2: null
        originator_to_beneficiary_information_line3: null
        originator_to_beneficiary_information_line4: null
        recipient_account_number_id: account_number_v18nkfqm6afpsrvy82b2
        type: inbound_wire_drawdown_request
      properties:
        amount:
          description: The amount being requested in cents.
          type: integer
        beneficiary_account_number:
          description: The drawdown request's beneficiary's account number.
          type: string
        beneficiary_address_line1:
          description: Line 1 of the drawdown request's beneficiary's address.
          nullable: true
          type: string
        beneficiary_address_line2:
          description: Line 2 of the drawdown request's beneficiary's address.
          nullable: true
          type: string
        beneficiary_address_line3:
          description: Line 3 of the drawdown request's beneficiary's address.
          nullable: true
          type: string
        beneficiary_name:
          description: The drawdown request's beneficiary's name.
          nullable: true
          type: string
        beneficiary_routing_number:
          description: The drawdown request's beneficiary's routing number.
          type: string
        currency:
          description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being requested. Will always be "USD".
          type: string
        id:
          description: The Wire drawdown request identifier.
          type: string
        message_to_recipient:
          description: A message from the drawdown request's originator.
          nullable: true
          type: string
        originator_account_number:
          description: The drawdown request's originator's account number.
          type: string
        originator_address_line1:
          description: Line 1 of the drawdown request's originator's address.
          nullable: true
          type: string
        originator_address_line2:
          description: Line 2 of the drawdown request's originator's address.
          nullable: true
          type: string
        originator_address_line3:
          description: Line 3 of the drawdown request's originator's address.
          nullable: true
          type: string
        originator_name:
          description: The drawdown request's originator's name.
          nullable: true
          type: string
        originator_routing_number:
          description: The drawdown request's originator's routing number.
          type: string
        originator_to_beneficiary_information_line1:
          description: Line 1 of the information conveyed from the originator of the message to the beneficiary.
          nullable: true
          type: string
        originator_to_beneficiary_information_line2:
          description: Line 2 of the information conveyed from the originator of the message to the beneficiary.
          nullable: true
          type: string
        originator_to_beneficiary_information_line3:
          description: Line 3 of the information conveyed from the originator of the message to the beneficiary.
          nullable: true
          type: string
        originator_to_beneficiary_information_line4:
          description: Line 4 of the information conveyed from the originator of the message to the beneficiary.
          nullable: true
          type: string
        recipient_account_number_id:
          description: The Account Number from which the recipient of this request is being requested to send funds.
          type: string
        type:
          description: A constant representing the object's type. For this resource it will always be `inbound_wire_drawdown_request`.
          enum:
            - inbound_wire_drawdown_request
          type: string
      required:
        - type
        - id
        - recipient_account_number_id
        - originator_account_number
        - originator_routing_number
        - beneficiary_account_number
        - beneficiary_routing_number
        - amount
        - currency
        - message_to_recipient
        - originator_to_beneficiary_information_line1
        - originator_to_beneficiary_information_line2
        - originator_to_beneficiary_information_line3
        - originator_to_beneficiary_information_line4
        - originator_name
        - originator_address_line1
        - originator_address_line2
        - originator_address_line3
        - beneficiary_name
        - beneficiary_address_line1
        - beneficiary_address_line2
        - beneficiary_address_line3
      title: Inbound Wire Drawdown Request
      type: object
      x-tag: Inbound Wire Drawdown Requests
      x-title-plural: Inbound Wire Drawdown Requests
    inbound_wire_drawdown_request_list:
      description: A list of Inbound Wire Drawdown Request objects
      example:
        data:
          - amount: 10000
            beneficiary_account_number: "987654321"
            beneficiary_address_line1: 33 Liberty Street
            beneficiary_address_line2: New York, NY, 10045
            beneficiary_address_line3: null
            beneficiary_name: Ian Crease
            beneficiary_routing_number: "101050001"
            currency: USD
            id: inbound_wire_drawdown_request_u5a92ikqhz1ytphn799e
            message_to_recipient: Invoice 29582
            originator_account_number: "987654321"
            originator_address_line1: 33 Liberty Street
            originator_address_line2: New York, NY, 10045
            originator_address_line3: null
            originator_name: Ian Crease
            originator_routing_number: "101050001"
            originator_to_beneficiary_information_line1: null
            originator_to_beneficiary_information_line2: null
            originator_to_beneficiary_information_line3: null
            originator_to_beneficiary_information_line4: null
            recipient_account_number_id: account_number_v18nkfqm6afpsrvy82b2
            type: inbound_wire_drawdown_request
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/inbound_wire_drawdown_request"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: Inbound Wire Drawdown Request List
      type: object
      x-title-plural: Inbound Wire Drawdown Request Lists
    inbound_wire_transfer_simulation_result:
      description: The results of an inbound Wire Transfer simulation.
      example:
        transaction:
          account_id: account_in71c4amph0vgo2qllky
          amount: 100
          created_at: 2020-01-31T23:59:59Z
          currency: USD
          description: Frederick S. Holmes
          id: transaction_uyrp7fld2ium70oa7oi
          route_id: account_number_v18nkfqm6afpsrvy82b2
          route_type: account_number
          source:
            category: inbound_wire_transfer
            inbound_wire_transfer:
              amount: 100
              beneficiary_address_line1: null
              beneficiary_address_line2: null
              beneficiary_address_line3: null
              beneficiary_name: null
              beneficiary_reference: null
              description: Inbound wire transfer
              input_message_accountability_data: null
              originator_address_line1: null
              originator_address_line2: null
              originator_address_line3: null
              originator_name: null
              originator_to_beneficiary_information: null
              originator_to_beneficiary_information_line1: null
              originator_to_beneficiary_information_line2: null
              originator_to_beneficiary_information_line3: null
              originator_to_beneficiary_information_line4: null
          type: transaction
        type: inbound_wire_transfer_simulation_result
      properties:
        transaction:
          description: "If the Wire Transfer attempt succeeds, this will contain the resulting [Transaction](#transactions) object. The Transaction's `source` will be of `category: inbound_wire_transfer`."
          example:
            account_id: account_in71c4amph0vgo2qllky
            amount: 100
            created_at: 2020-01-31T23:59:59Z
            currency: USD
            description: Frederick S. Holmes
            id: transaction_uyrp7fld2ium70oa7oi
            route_id: account_number_v18nkfqm6afpsrvy82b2
            route_type: account_number
            source:
              category: inbound_ach_transfer
              inbound_ach_transfer:
                amount: 100
                originator_company_descriptive_date: null
                originator_company_discretionary_data: null
                originator_company_entry_description: RESERVE
                originator_company_id: "0987654321"
                originator_company_name: BIG BANK
                receiver_id_number: "12345678900"
                receiver_name: IAN CREASE
                trace_number: "021000038461022"
            type: transaction
          properties:
            account_id:
              description: The identifier for the Account the Transaction belongs to.
              type: string
            amount:
              description: The Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.
              type: integer
            created_at:
              description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Transaction occured.
              format: date-time
              type: string
            currency:
              description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Transaction's currency. This will match the currency on the Transcation's Account.
              enum:
                - CAD
                - CHF
                - EUR
                - GBP
                - JPY
                - USD
              type: string
              x-enum-descriptions:
                - Canadian Dollar (CAD)
                - Swiss Franc (CHF)
                - Euro (EUR)
                - British Pound (GBP)
                - Japanese Yen (JPY)
                - US Dollar (USD)
            description:
              description: For a Transaction related to a transfer, this is the description you provide. For a Transaction related to a payment, this is the description the vendor provides.
              type: string
            id:
              description: The Transaction identifier.
              type: string
            route_id:
              description: The identifier for the route this Transaction came through. Routes are things like cards and ACH details.
              nullable: true
              type: string
            route_type:
              description: The type of the route this Transaction came through.
              enum:
                - account_number
                - card
              nullable: true
              type: string
              x-enum-descriptions:
                - An Account Number.
                - A Card.
            source:
              description: This is an object giving more details on the network-level event that caused the Transaction. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.
              example:
                category: inbound_ach_transfer
                inbound_ach_transfer:
                  amount: 100
                  originator_company_descriptive_date: null
                  originator_company_discretionary_data: null
                  originator_company_entry_description: RESERVE
                  originator_company_id: "0987654321"
                  originator_company_name: BIG BANK
                  receiver_id_number: "12345678900"
                  receiver_name: IAN CREASE
                  trace_number: "021000038461022"
              properties:
                account_transfer_intention:
                  description: A Account Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `account_transfer_intention`.
                  example:
                    amount: 100
                    currency: USD
                    description: Frederick S. Holmes
                    destination_account_id: account_uf16sut2ct5bevmq3eh
                    source_account_id: account_in71c4amph0vgo2qllky
                    transfer_id: account_transfer_7k9qe1ysdgqztnt63l7n
                  nullable: true
                  properties:
                    amount:
                      description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    description:
                      description: The description you chose to give the transfer.
                      type: string
                    destination_account_id:
                      description: The identifier of the Account to where the Account Transfer was sent.
                      type: string
                    source_account_id:
                      description: The identifier of the Account from where the Account Transfer was sent.
                      type: string
                    transfer_id:
                      description: The identifier of the Account Transfer that led to this Pending Transaction.
                      type: string
                  required:
                    - amount
                    - currency
                    - description
                    - destination_account_id
                    - source_account_id
                    - transfer_id
                  title: Account Transfer Intention
                  type: object
                  x-title-plural: Account Transfer Intentions
                ach_check_conversion:
                  description: A ACH Check Conversion object. This field will be present in the JSON response if and only if `category` is equal to `ach_check_conversion`.
                  example:
                    amount: 100
                    file_id: file_makxrc67oh9l6sg7w9yc
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    file_id:
                      description: The identifier of the File containing an image of the returned check.
                      type: string
                  required:
                    - amount
                    - file_id
                  title: ACH Check Conversion
                  type: object
                  x-title-plural: ACH Check Conversions
                ach_check_conversion_return:
                  description: A ACH Check Conversion Return object. This field will be present in the JSON response if and only if `category` is equal to `ach_check_conversion_return`.
                  example:
                    amount: 100
                    return_reason_code: ""
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    return_reason_code:
                      description: Why the transfer was returned.
                      type: string
                  required:
                    - amount
                    - return_reason_code
                  title: ACH Check Conversion Return
                  type: object
                  x-title-plural: ACH Check Conversion Returns
                ach_transfer_intention:
                  description: A ACH Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_intention`.
                  example:
                    account_number: "987654321"
                    amount: 100
                    routing_number: "101050001"
                    statement_descriptor: Frederick S. Holmes
                    transfer_id: account_transfer_7k9qe1ysdgqztnt63l7n
                  nullable: true
                  properties:
                    account_number:
                      description: ""
                      type: string
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    routing_number:
                      description: ""
                      type: string
                    statement_descriptor:
                      description: ""
                      type: string
                    transfer_id:
                      description: The identifier of the ACH Transfer that led to this Transaction.
                      type: string
                  required:
                    - amount
                    - account_number
                    - routing_number
                    - statement_descriptor
                    - transfer_id
                  title: ACH Transfer Intention
                  type: object
                  x-title-plural: ACH Transfer Intentions
                ach_transfer_rejection:
                  description: A ACH Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_rejection`.
                  example:
                    transfer_id: account_transfer_7k9qe1ysdgqztnt63l7n
                  nullable: true
                  properties:
                    transfer_id:
                      description: The identifier of the ACH Transfer that led to this Transaction.
                      type: string
                  required:
                    - transfer_id
                  title: ACH Transfer Rejection
                  type: object
                  x-title-plural: ACH Transfer Rejections
                ach_transfer_return:
                  description: A ACH Transfer Return object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_return`.
                  example:
                    created_at: 2020-01-31T23:59:59Z
                    return_reason_code: insufficient_fund
                    transaction_id: transaction_uyrp7fld2ium70oa7oi
                    transfer_id: ach_transfer_uoxatyh3lt5evrsdvo7q
                  nullable: true
                  properties:
                    created_at:
                      description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.
                      format: date-time
                      type: string
                    return_reason_code:
                      description: Why the ACH Transfer was returned.
                      enum:
                        - insufficient_fund
                        - no_account
                        - account_closed
                        - invalid_account_number_structure
                        - account_frozen_entry_returned_per_ofac_instruction
                        - credit_entry_refused_by_receiver
                        - unauthorized_debit_to_consumer_account_using_corporate_sec_code
                        - corporate_customer_advised_not_authorized
                        - payment_stopped
                        - non_transaction_account
                        - uncollected_funds
                        - routing_number_check_digit_error
                        - customer_advised_unauthorized_improper_ineligible_or_incomplete
                        - amount_field_error
                        - authorization_revoked_by_customer
                        - invalid_ach_routing_number
                        - file_record_edit_criteria
                        - enr_invalid_individual_name
                        - returned_per_odfi_request
                        - addenda_error
                        - limited_participation_dfi
                        - incorrectly_coded_outbound_international_payment
                        - other
                      type: string
                      x-enum-descriptions:
                        - Insufficient funds in the source account.
                        - The account does not exist or the receiving bank was unable to locate it.
                        - The account is closed.
                        - The account number is invalid at the receiving bank.
                        - The account was frozen per the Office of Foreign Assets Control.
                        - The receiving bank account refused a credit transfer.
                        - The receiving bank rejected because of an incorrect Standard Entry Class code.
                        - The corporate customer reversed the transfer.
                        - The receiving bank stopped payment on this transfer.
                        - The receiving bank account does not perform transfers.
                        - The receiving bank account does not have enough available balance for the transfer.
                        - The routing number is incorrect.
                        - The customer reversed the transfer.
                        - The amount field is incorrect or too large.
                        - The customer who initiated the transfer revoked authorization.
                        - The routing number is invalid.
                        - The receiving bank is unable to process a field in the transfer.
                        - The individual name field was invalid.
                        - The originating financial institution reversed the transfer.
                        - The addenda record is incorrect or missing.
                        - The receiving bank's regulatory supervisor has limited their participation.
                        - The outbound international ACH transfer was incorrect.
                        - Any other ACH return reason.
                    transaction_id:
                      description: The identifier of the Tranasaction associated with this return.
                      type: string
                    transfer_id:
                      description: The identifier of the ACH Transfer associated with this return.
                      type: string
                  required:
                    - created_at
                    - return_reason_code
                    - transfer_id
                    - transaction_id
                  title: ACH Transfer Return
                  type: object
                  x-title-plural: ACH Transfer Returns
                card_dispute_acceptance:
                  description: A Card Dispute Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `card_dispute_acceptance`.
                  example:
                    accepted_at: 2020-01-31T23:59:59Z
                    card_dispute_id: card_dispute_h9sc95nbl1cgltpp7men
                    transaction_id: transaction_uyrp7fld2ium70oa7oi
                  nullable: true
                  properties:
                    accepted_at:
                      description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was accepted.
                      format: date-time
                      type: string
                    card_dispute_id:
                      description: The identifier of the Card Dispute that was accepted.
                      type: string
                    transaction_id:
                      description: The identifier of the Transaction that was created to return the disputed funds to your account.
                      type: string
                  required:
                    - accepted_at
                    - card_dispute_id
                    - transaction_id
                  title: Card Dispute Acceptance
                  type: object
                  x-title-plural: Card Dispute Acceptances
                card_refund:
                  description: A Card Refund object. This field will be present in the JSON response if and only if `category` is equal to `card_refund`.
                  example:
                    amount: 100
                    card_settlement_transaction_id: transaction_uyrp7fld2ium70oa7oi
                    currency: USD
                    id: card_refund_imgc2xwplh6t4r3gn16e
                    merchant_acceptor_id: "5665270011000168"
                    merchant_category_code: "5734"
                    merchant_city: New York
                    merchant_country: US
                    merchant_name: AMAZON.COM
                    merchant_state: NY
                    type: card_refund
                  nullable: true
                  properties:
                    amount:
                      description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    card_settlement_transaction_id:
                      description: The identifier for the Transaction this refunds, if any.
                      nullable: true
                      type: string
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    id:
                      description: The Card Refund identifier.
                      type: string
                    merchant_acceptor_id:
                      description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.
                      nullable: true
                      type: string
                    merchant_category_code:
                      description: The 4-digit MCC describing the merchant's business.
                      type: string
                    merchant_city:
                      description: The city the merchant resides in.
                      nullable: true
                      type: string
                    merchant_country:
                      description: The country the merchant resides in.
                      type: string
                    merchant_name:
                      description: The name of the merchant.
                      nullable: true
                      type: string
                    merchant_state:
                      description: The state the merchant resides in.
                      nullable: true
                      type: string
                    type:
                      description: A constant representing the object's type. For this resource it will always be `card_refund`.
                      enum:
                        - card_refund
                      type: string
                  required:
                    - id
                    - amount
                    - currency
                    - card_settlement_transaction_id
                    - merchant_acceptor_id
                    - merchant_city
                    - merchant_state
                    - merchant_country
                    - merchant_name
                    - merchant_category_code
                    - type
                  title: Card Refund
                  type: object
                  x-title-plural: Card Refunds
                card_revenue_payment:
                  description: A Card Revenue Payment object. This field will be present in the JSON response if and only if `category` is equal to `card_revenue_payment`.
                  example:
                    amount: 100
                    currency: USD
                    period_end: 2023-04-30T23:59:59Z
                    period_start: 2023-04-01T00:00:00Z
                    transacted_on_account_id: account_in71c4amph0vgo2qllky
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    period_end:
                      description: The end of the period for which this transaction paid interest.
                      format: date-time
                      type: string
                    period_start:
                      description: The start of the period for which this transaction paid interest.
                      format: date-time
                      type: string
                    transacted_on_account_id:
                      description: The account the card belonged to.
                      nullable: true
                      type: string
                  required:
                    - amount
                    - currency
                    - period_start
                    - period_end
                    - transacted_on_account_id
                  title: Card Revenue Payment
                  type: object
                  x-title-plural: Card Revenue Payments
                card_route_refund:
                  description: A Deprecated Card Refund object. This field will be present in the JSON response if and only if `category` is equal to `card_route_refund`.
                  example:
                    amount: 1000
                    currency: USD
                    merchant_acceptor_id: "372909060886"
                    merchant_category_code: "5998"
                    merchant_city: "5364086000"
                    merchant_country: USA
                    merchant_descriptor: TENTS R US
                    merchant_state: CA
                  nullable: true
                  properties:
                    amount:
                      description: The refunded amount in the minor unit of the refunded currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the refund currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    merchant_acceptor_id:
                      description: ""
                      type: string
                    merchant_category_code:
                      description: ""
                      nullable: true
                      type: string
                    merchant_city:
                      description: ""
                      nullable: true
                      type: string
                    merchant_country:
                      description: ""
                      type: string
                    merchant_descriptor:
                      description: ""
                      type: string
                    merchant_state:
                      description: ""
                      nullable: true
                      type: string
                  required:
                    - amount
                    - currency
                    - merchant_acceptor_id
                    - merchant_city
                    - merchant_country
                    - merchant_descriptor
                    - merchant_state
                    - merchant_category_code
                  title: Deprecated Card Refund
                  type: object
                  x-title-plural: Deprecated Card Refunds
                card_route_settlement:
                  description: A Deprecated Card Settlement object. This field will be present in the JSON response if and only if `category` is equal to `card_route_settlement`.
                  example:
                    amount: 1000
                    currency: USD
                    merchant_acceptor_id: "372909060886"
                    merchant_category_code: "5998"
                    merchant_city: "5364086000"
                    merchant_country: USA
                    merchant_descriptor: TENTS R US
                    merchant_state: CA
                  nullable: true
                  properties:
                    amount:
                      description: The settled amount in the minor unit of the settlement currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the settlement currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    merchant_acceptor_id:
                      description: ""
                      type: string
                    merchant_category_code:
                      description: ""
                      nullable: true
                      type: string
                    merchant_city:
                      description: ""
                      nullable: true
                      type: string
                    merchant_country:
                      description: ""
                      nullable: true
                      type: string
                    merchant_descriptor:
                      description: ""
                      type: string
                    merchant_state:
                      description: ""
                      nullable: true
                      type: string
                  required:
                    - amount
                    - currency
                    - merchant_acceptor_id
                    - merchant_city
                    - merchant_country
                    - merchant_descriptor
                    - merchant_state
                    - merchant_category_code
                  title: Deprecated Card Settlement
                  type: object
                  x-title-plural: Deprecated Card Settlements
                card_settlement:
                  description: A Card Settlement object. This field will be present in the JSON response if and only if `category` is equal to `card_settlement`.
                  example:
                    amount: 100
                    card_authorization: null
                    currency: USD
                    id: card_settlement_khv5kfeu0vndj291omg6
                    merchant_acceptor_id: "5665270011000168"
                    merchant_category_code: "5734"
                    merchant_city: New York
                    merchant_country: US
                    merchant_name: AMAZON.COM
                    merchant_state: NY
                    pending_transaction_id: null
                    presentment_amount: 100
                    presentment_currency: USD
                    type: card_settlement
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's settlement currency. For dollars, for example, this is cents.
                      type: integer
                    card_authorization:
                      description: The Card Authorization that was created prior to this Card Settlement, if on exists.
                      nullable: true
                      type: string
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's settlement currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    id:
                      description: The Card Settlement identifier.
                      type: string
                    merchant_acceptor_id:
                      description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.
                      nullable: true
                      type: string
                    merchant_category_code:
                      description: The 4-digit MCC describing the merchant's business.
                      type: string
                    merchant_city:
                      description: The city the merchant resides in.
                      nullable: true
                      type: string
                    merchant_country:
                      description: The country the merchant resides in.
                      type: string
                    merchant_name:
                      description: The name of the merchant.
                      nullable: true
                      type: string
                    merchant_state:
                      description: The state the merchant resides in.
                      nullable: true
                      type: string
                    pending_transaction_id:
                      description: The identifier of the Pending Transaction associated with this Transaction.
                      nullable: true
                      type: string
                    presentment_amount:
                      description: The amount in the minor unit of the transaction's presentment currency.
                      type: integer
                    presentment_currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's presentment currency.
                      type: string
                    type:
                      description: A constant representing the object's type. For this resource it will always be `card_settlement`.
                      enum:
                        - card_settlement
                      type: string
                  required:
                    - id
                    - card_authorization
                    - amount
                    - currency
                    - presentment_amount
                    - presentment_currency
                    - merchant_acceptor_id
                    - merchant_city
                    - merchant_state
                    - merchant_country
                    - merchant_name
                    - merchant_category_code
                    - pending_transaction_id
                    - type
                  title: Card Settlement
                  type: object
                  x-title-plural: Card Settlements
                category:
                  description: The type of transaction that took place. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
                  enum:
                    - account_transfer_intention
                    - ach_check_conversion_return
                    - ach_check_conversion
                    - ach_transfer_intention
                    - ach_transfer_rejection
                    - ach_transfer_return
                    - card_dispute_acceptance
                    - card_refund
                    - card_settlement
                    - card_revenue_payment
                    - check_deposit_acceptance
                    - check_deposit_return
                    - check_transfer_intention
                    - check_transfer_return
                    - check_transfer_rejection
                    - check_transfer_stop_payment_request
                    - dispute_resolution
                    - empyreal_cash_deposit
                    - fee_payment
                    - inbound_ach_transfer
                    - inbound_ach_transfer_return_intention
                    - inbound_check
                    - inbound_international_ach_transfer
                    - inbound_real_time_payments_transfer_confirmation
                    - inbound_wire_drawdown_payment_reversal
                    - inbound_wire_drawdown_payment
                    - inbound_wire_reversal
                    - inbound_wire_transfer
                    - interest_payment
                    - internal_general_ledger_transaction
                    - internal_source
                    - card_route_refund
                    - card_route_settlement
                    - real_time_payments_transfer_acknowledgement
                    - sample_funds
                    - wire_drawdown_payment_intention
                    - wire_drawdown_payment_rejection
                    - wire_transfer_intention
                    - wire_transfer_rejection
                    - other
                  type: string
                  x-enum-descriptions:
                    - The Transaction was created by a Account Transfer Intention object. Details will be under the `account_transfer_intention` object.
                    - The Transaction was created by a ACH Check Conversion Return object. Details will be under the `ach_check_conversion_return` object.
                    - The Transaction was created by a ACH Check Conversion object. Details will be under the `ach_check_conversion` object.
                    - The Transaction was created by a ACH Transfer Intention object. Details will be under the `ach_transfer_intention` object.
                    - The Transaction was created by a ACH Transfer Rejection object. Details will be under the `ach_transfer_rejection` object.
                    - The Transaction was created by a ACH Transfer Return object. Details will be under the `ach_transfer_return` object.
                    - The Transaction was created by a Card Dispute Acceptance object. Details will be under the `card_dispute_acceptance` object.
                    - The Transaction was created by a Card Refund object. Details will be under the `card_refund` object.
                    - The Transaction was created by a Card Settlement object. Details will be under the `card_settlement` object.
                    - The Transaction was created by a Card Revenue Payment object. Details will be under the `card_revenue_payment` object.
                    - The Transaction was created by a Check Deposit Acceptance object. Details will be under the `check_deposit_acceptance` object.
                    - The Transaction was created by a Check Deposit Return object. Details will be under the `check_deposit_return` object.
                    - The Transaction was created by a Check Transfer Intention object. Details will be under the `check_transfer_intention` object.
                    - The Transaction was created by a Check Transfer Return object. Details will be under the `check_transfer_return` object.
                    - The Transaction was created by a Check Transfer Rejection object. Details will be under the `check_transfer_rejection` object.
                    - The Transaction was created by a Check Transfer Stop Payment Request object. Details will be under the `check_transfer_stop_payment_request` object.
                    - The Transaction was created by a Dispute Resolution object. Details will be under the `dispute_resolution` object.
                    - The Transaction was created by a Empyreal Cash Deposit object. Details will be under the `empyreal_cash_deposit` object.
                    - The Transaction was created by a Fee Payment object. Details will be under the `fee_payment` object.
                    - The Transaction was created by a Inbound ACH Transfer object. Details will be under the `inbound_ach_transfer` object.
                    - The Transaction was created by a Inbound ACH Transfer Return Intention object. Details will be under the `inbound_ach_transfer_return_intention` object.
                    - The Transaction was created by a Inbound Check object. Details will be under the `inbound_check` object.
                    - The Transaction was created by a Inbound International ACH Transfer object. Details will be under the `inbound_international_ach_transfer` object.
                    - The Transaction was created by a Inbound Real Time Payments Transfer Confirmation object. Details will be under the `inbound_real_time_payments_transfer_confirmation` object.
                    - The Transaction was created by a Inbound Wire Drawdown Payment Reversal object. Details will be under the `inbound_wire_drawdown_payment_reversal` object.
                    - The Transaction was created by a Inbound Wire Drawdown Payment object. Details will be under the `inbound_wire_drawdown_payment` object.
                    - The Transaction was created by a Inbound Wire Reversal object. Details will be under the `inbound_wire_reversal` object.
                    - The Transaction was created by a Inbound Wire Transfer object. Details will be under the `inbound_wire_transfer` object.
                    - The Transaction was created by a Interest Payment object. Details will be under the `interest_payment` object.
                    - The Transaction was created by a Internal General Ledger Transaction object. Details will be under the `internal_general_ledger_transaction` object.
                    - The Transaction was created by a Internal Source object. Details will be under the `internal_source` object.
                    - The Transaction was created by a Deprecated Card Refund object. Details will be under the `card_route_refund` object.
                    - The Transaction was created by a Deprecated Card Settlement object. Details will be under the `card_route_settlement` object.
                    - The Transaction was created by a Real Time Payments Transfer Acknowledgement object. Details will be under the `real_time_payments_transfer_acknowledgement` object.
                    - The Transaction was created by a Sample Funds object. Details will be under the `sample_funds` object.
                    - The Transaction was created by a Wire Drawdown Payment Intention object. Details will be under the `wire_drawdown_payment_intention` object.
                    - The Transaction was created by a Wire Drawdown Payment Rejection object. Details will be under the `wire_drawdown_payment_rejection` object.
                    - The Transaction was created by a Wire Transfer Intention object. Details will be under the `wire_transfer_intention` object.
                    - The Transaction was created by a Wire Transfer Rejection object. Details will be under the `wire_transfer_rejection` object.
                    - The Transaction was made for an undocumented or deprecated reason.
                check_deposit_acceptance:
                  description: A Check Deposit Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_acceptance`.
                  example:
                    account_number: "987654321"
                    amount: 100
                    auxiliary_on_us: "101"
                    check_deposit_id: check_deposit_f06n9gpg7sxn8t19lfc1
                    currency: USD
                    routing_number: "101050001"
                    serial_number: null
                  nullable: true
                  properties:
                    account_number:
                      description: The account number printed on the check.
                      type: string
                    amount:
                      description: The amount to be deposited in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    auxiliary_on_us:
                      description: An additional line of metadata printed on the check. This typically includes the check number for business checks.
                      nullable: true
                      type: string
                    check_deposit_id:
                      description: The ID of the Check Deposit that was accepted.
                      type: string
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    routing_number:
                      description: The routing number printed on the check.
                      type: string
                    serial_number:
                      description: The check serial number, if present, for consumer checks. For business checks, the serial number is usually in the `auxiliary_on_us` field.
                      nullable: true
                      type: string
                  required:
                    - amount
                    - currency
                    - account_number
                    - routing_number
                    - auxiliary_on_us
                    - serial_number
                    - check_deposit_id
                  title: Check Deposit Acceptance
                  type: object
                  x-title-plural: Check Deposit Acceptances
                check_deposit_return:
                  description: A Check Deposit Return object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_return`.
                  example:
                    amount: 100
                    check_deposit_id: check_deposit_f06n9gpg7sxn8t19lfc1
                    currency: USD
                    return_reason: insufficient_funds
                    returned_at: 2020-01-31T23:59:59Z
                    transaction_id: transaction_uyrp7fld2ium70oa7oi
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    check_deposit_id:
                      description: The identifier of the Check Deposit that was returned.
                      type: string
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    return_reason:
                      description: ""
                      enum:
                        - ach_conversion_not_supported
                        - closed_account
                        - duplicate_submission
                        - insufficient_funds
                        - no_account
                        - not_authorized
                        - stale_dated
                        - stop_payment
                        - unknown_reason
                        - unmatched_details
                        - unreadable_image
                      type: string
                      x-enum-descriptions:
                        - The check doesn't allow ACH conversion.
                        - The account is closed.
                        - The check has already been deposited.
                        - Insufficient funds
                        - No account was found matching the check details.
                        - The check was not authorized.
                        - The check is too old.
                        - The payment has been stopped by the account holder.
                        - The reason for the return is unknown.
                        - The image doesn't match the details submitted.
                        - The image could not be read.
                    returned_at:
                      description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check deposit was returned.
                      format: date-time
                      type: string
                    transaction_id:
                      description: The identifier of the transaction that reversed the original check deposit transaction.
                      type: string
                  required:
                    - amount
                    - returned_at
                    - currency
                    - check_deposit_id
                    - transaction_id
                    - return_reason
                  title: Check Deposit Return
                  type: object
                  x-title-plural: Check Deposit Returns
                check_transfer_intention:
                  description: A Check Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_intention`.
                  example:
                    address_city: New York
                    address_line1: 33 Liberty Street
                    address_line2: null
                    address_state: NY
                    address_zip: "10045"
                    amount: 1000
                    currency: USD
                    recipient_name: Ian Crease
                    transfer_id: check_transfer_30b43acfu9vw8fyc4f5
                  nullable: true
                  properties:
                    address_city:
                      description: The city of the check's destination.
                      type: string
                    address_line1:
                      description: The street address of the check's destination.
                      type: string
                    address_line2:
                      description: The second line of the address of the check's destination.
                      nullable: true
                      type: string
                    address_state:
                      description: The state of the check's destination.
                      type: string
                    address_zip:
                      description: The postal code of the check's destination.
                      type: string
                    amount:
                      description: The transfer amount in USD cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    recipient_name:
                      description: The name that will be printed on the check.
                      type: string
                    transfer_id:
                      description: The identifier of the Check Transfer with which this is associated.
                      type: string
                  required:
                    - address_line1
                    - address_line2
                    - address_city
                    - address_state
                    - address_zip
                    - amount
                    - currency
                    - recipient_name
                    - transfer_id
                  title: Check Transfer Intention
                  type: object
                  x-title-plural: Check Transfer Intentions
                check_transfer_rejection:
                  description: A Check Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_rejection`.
                  example:
                    transfer_id: check_transfer_30b43acfu9vw8fyc4f5
                  nullable: true
                  properties:
                    transfer_id:
                      description: The identifier of the Check Transfer that led to this Transaction.
                      type: string
                  required:
                    - transfer_id
                  title: Check Transfer Rejection
                  type: object
                  x-title-plural: Check Transfer Rejections
                check_transfer_return:
                  description: A Check Transfer Return object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_return`.
                  example:
                    file_id: null
                    reason: mail_delivery_failure
                    returned_at: 2020-01-31T23:59:59Z
                    transaction_id: transaction_uyrp7fld2ium70oa7oi
                    transfer_id: check_transfer_30b43acfu9vw8fyc4f5
                  nullable: true
                  properties:
                    file_id:
                      description: If available, a document with additional information about the return.
                      nullable: true
                      type: string
                    reason:
                      description: The reason why the check was returned.
                      enum:
                        - mail_delivery_failure
                        - refused_by_recipient
                      type: string
                      x-enum-descriptions:
                        - Mail delivery failed and the check was returned to sender.
                        - The check arrived and the recipient refused to deposit it.
                    returned_at:
                      description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check was returned.
                      format: date-time
                      type: string
                    transaction_id:
                      description: The identifier of the Transaction that was created to credit you for the returned check.
                      nullable: true
                      type: string
                    transfer_id:
                      description: The identifier of the returned Check Transfer.
                      type: string
                  required:
                    - transfer_id
                    - returned_at
                    - file_id
                    - reason
                    - transaction_id
                  title: Check Transfer Return
                  type: object
                  x-title-plural: Check Transfer Returns
                check_transfer_stop_payment_request:
                  description: A Check Transfer Stop Payment Request object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_stop_payment_request`.
                  example:
                    requested_at: 2020-01-31T23:59:59Z
                    transaction_id: transaction_uyrp7fld2ium70oa7oi
                    transfer_id: check_transfer_30b43acfu9vw8fyc4f5
                    type: check_transfer_stop_payment_request
                  nullable: true
                  properties:
                    requested_at:
                      description: The time the stop-payment was requested.
                      format: date-time
                      type: string
                    transaction_id:
                      description: The transaction ID of the corresponding credit transaction.
                      type: string
                    transfer_id:
                      description: The ID of the check transfer that was stopped.
                      type: string
                    type:
                      description: A constant representing the object's type. For this resource it will always be `check_transfer_stop_payment_request`.
                      enum:
                        - check_transfer_stop_payment_request
                      type: string
                  required:
                    - transfer_id
                    - transaction_id
                    - requested_at
                    - type
                  title: Check Transfer Stop Payment Request
                  type: object
                  x-title-plural: Check Transfer Stop Payment Requests
                dispute_resolution:
                  description: A Dispute Resolution object. This field will be present in the JSON response if and only if `category` is equal to `dispute_resolution`.
                  example:
                    amount: 100
                    currency: USD
                    disputed_transaction_id: transaction_uyrp7fld2ium70oa7oi
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    disputed_transaction_id:
                      description: The identifier of the Transaction that was disputed.
                      type: string
                  required:
                    - amount
                    - currency
                    - disputed_transaction_id
                  title: Dispute Resolution
                  type: object
                  x-title-plural: Dispute Resolutions
                empyreal_cash_deposit:
                  description: A Empyreal Cash Deposit object. This field will be present in the JSON response if and only if `category` is equal to `empyreal_cash_deposit`.
                  example:
                    amount: 100
                    bag_id: "12345"
                    deposit_date: 2020-01-31T23:59:59Z
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    bag_id:
                      description: ""
                      type: string
                    deposit_date:
                      description: ""
                      format: date-time
                      type: string
                  required:
                    - amount
                    - bag_id
                    - deposit_date
                  title: Empyreal Cash Deposit
                  type: object
                  x-title-plural: Empyreal Cash Deposits
                fee_payment:
                  description: A Fee Payment object. This field will be present in the JSON response if and only if `category` is equal to `fee_payment`.
                  example:
                    amount: 100
                    currency: USD
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                  required:
                    - amount
                    - currency
                  title: Fee Payment
                  type: object
                  x-title-plural: Fee Payments
                inbound_ach_transfer:
                  description: A Inbound ACH Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_ach_transfer`.
                  example:
                    amount: 100
                    originator_company_descriptive_date: null
                    originator_company_discretionary_data: null
                    originator_company_entry_description: RESERVE
                    originator_company_id: "0987654321"
                    originator_company_name: BIG BANK
                    receiver_id_number: "12345678900"
                    receiver_name: IAN CREASE
                    trace_number: "021000038461022"
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    originator_company_descriptive_date:
                      description: ""
                      nullable: true
                      type: string
                    originator_company_discretionary_data:
                      description: ""
                      nullable: true
                      type: string
                    originator_company_entry_description:
                      description: ""
                      type: string
                    originator_company_id:
                      description: ""
                      type: string
                    originator_company_name:
                      description: ""
                      type: string
                    receiver_id_number:
                      description: ""
                      nullable: true
                      type: string
                    receiver_name:
                      description: ""
                      nullable: true
                      type: string
                    trace_number:
                      description: ""
                      type: string
                  required:
                    - amount
                    - originator_company_name
                    - originator_company_descriptive_date
                    - originator_company_discretionary_data
                    - originator_company_entry_description
                    - originator_company_id
                    - receiver_id_number
                    - receiver_name
                    - trace_number
                  title: Inbound ACH Transfer
                  type: object
                  x-title-plural: Inbound ACH Transfers
                inbound_check:
                  description: A Inbound Check object. This field will be present in the JSON response if and only if `category` is equal to `inbound_check`.
                  example:
                    amount: 100
                    check_front_image_file_id: file_makxrc67oh9l6sg7w9yc
                    check_number: "       00000123"
                    check_rear_image_file_id: file_makxrc67oh9l6sg7w9yc
                    currency: USD
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    check_front_image_file_id:
                      description: ""
                      nullable: true
                      type: string
                    check_number:
                      description: ""
                      nullable: true
                      type: string
                    check_rear_image_file_id:
                      description: ""
                      nullable: true
                      type: string
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                  required:
                    - amount
                    - currency
                    - check_number
                    - check_front_image_file_id
                    - check_rear_image_file_id
                  title: Inbound Check
                  type: object
                  x-title-plural: Inbound Checks
                inbound_international_ach_transfer:
                  description: A Inbound International ACH Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_international_ach_transfer`.
                  example:
                    amount: -1000
                    destination_country_code: US
                    destination_currency_code: USD
                    foreign_exchange_indicator: fixed_to_fixed
                    foreign_exchange_reference: null
                    foreign_exchange_reference_indicator: blank
                    foreign_payment_amount: 199
                    foreign_trace_number: null
                    international_transaction_type_code: internet_initiated
                    originating_currency_code: USD
                    originating_depository_financial_institution_branch_country: US
                    originating_depository_financial_institution_id: "091000019"
                    originating_depository_financial_institution_id_qualifier: national_clearing_system_number
                    originating_depository_financial_institution_name: WELLS FARGO BANK
                    originator_city: BERLIN
                    originator_company_entry_description: RETRY PYMT
                    originator_country: DE
                    originator_identification: 770510487A
                    originator_name: BERGHAIN
                    originator_postal_code: "50825"
                    originator_state_or_province: null
                    originator_street_address: Ruedersdorferstr. 7
                    payment_related_information: null
                    payment_related_information2: null
                    receiver_city: BEVERLY HILLS
                    receiver_country: US
                    receiver_identification_number: "1018790279274"
                    receiver_postal_code: "90210"
                    receiver_state_or_province: CA
                    receiver_street_address: 123 FAKE ST
                    receiving_company_or_individual_name: IAN CREASE
                    receiving_depository_financial_institution_country: US
                    receiving_depository_financial_institution_id: "101050001"
                    receiving_depository_financial_institution_id_qualifier: national_clearing_system_number
                    receiving_depository_financial_institution_name: BLUE RIDGE BANK, NATIONAL ASSOCIATI
                    trace_number: "010202909100090"
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    destination_country_code:
                      description: ""
                      type: string
                    destination_currency_code:
                      description: ""
                      type: string
                    foreign_exchange_indicator:
                      description: ""
                      type: string
                    foreign_exchange_reference:
                      description: ""
                      nullable: true
                      type: string
                    foreign_exchange_reference_indicator:
                      description: ""
                      type: string
                    foreign_payment_amount:
                      description: ""
                      type: integer
                    foreign_trace_number:
                      description: ""
                      nullable: true
                      type: string
                    international_transaction_type_code:
                      description: ""
                      type: string
                    originating_currency_code:
                      description: ""
                      type: string
                    originating_depository_financial_institution_branch_country:
                      description: ""
                      type: string
                    originating_depository_financial_institution_id:
                      description: ""
                      type: string
                    originating_depository_financial_institution_id_qualifier:
                      description: ""
                      type: string
                    originating_depository_financial_institution_name:
                      description: ""
                      type: string
                    originator_city:
                      description: ""
                      type: string
                    originator_company_entry_description:
                      description: ""
                      type: string
                    originator_country:
                      description: ""
                      type: string
                    originator_identification:
                      description: ""
                      type: string
                    originator_name:
                      description: ""
                      type: string
                    originator_postal_code:
                      description: ""
                      nullable: true
                      type: string
                    originator_state_or_province:
                      description: ""
                      nullable: true
                      type: string
                    originator_street_address:
                      description: ""
                      type: string
                    payment_related_information:
                      description: ""
                      nullable: true
                      type: string
                    payment_related_information2:
                      description: ""
                      nullable: true
                      type: string
                    receiver_city:
                      description: ""
                      type: string
                    receiver_country:
                      description: ""
                      type: string
                    receiver_identification_number:
                      description: ""
                      nullable: true
                      type: string
                    receiver_postal_code:
                      description: ""
                      nullable: true
                      type: string
                    receiver_state_or_province:
                      description: ""
                      nullable: true
                      type: string
                    receiver_street_address:
                      description: ""
                      type: string
                    receiving_company_or_individual_name:
                      description: ""
                      type: string
                    receiving_depository_financial_institution_country:
                      description: ""
                      type: string
                    receiving_depository_financial_institution_id:
                      description: ""
                      type: string
                    receiving_depository_financial_institution_id_qualifier:
                      description: ""
                      type: string
                    receiving_depository_financial_institution_name:
                      description: ""
                      type: string
                    trace_number:
                      description: ""
                      type: string
                  required:
                    - amount
                    - foreign_exchange_indicator
                    - foreign_exchange_reference_indicator
                    - foreign_exchange_reference
                    - destination_country_code
                    - destination_currency_code
                    - foreign_payment_amount
                    - foreign_trace_number
                    - international_transaction_type_code
                    - originating_currency_code
                    - originating_depository_financial_institution_name
                    - originating_depository_financial_institution_id_qualifier
                    - originating_depository_financial_institution_id
                    - originating_depository_financial_institution_branch_country
                    - originator_city
                    - originator_company_entry_description
                    - originator_country
                    - originator_identification
                    - originator_name
                    - originator_postal_code
                    - originator_street_address
                    - originator_state_or_province
                    - payment_related_information
                    - payment_related_information2
                    - receiver_identification_number
                    - receiver_street_address
                    - receiver_city
                    - receiver_state_or_province
                    - receiver_country
                    - receiver_postal_code
                    - receiving_company_or_individual_name
                    - receiving_depository_financial_institution_name
                    - receiving_depository_financial_institution_id_qualifier
                    - receiving_depository_financial_institution_id
                    - receiving_depository_financial_institution_country
                    - trace_number
                  title: Inbound International ACH Transfer
                  type: object
                  x-title-plural: Inbound International ACH Transfers
                inbound_real_time_payments_transfer_confirmation:
                  description: A Inbound Real Time Payments Transfer Confirmation object. This field will be present in the JSON response if and only if `category` is equal to `inbound_real_time_payments_transfer_confirmation`.
                  example:
                    amount: 100
                    creditor_name: Ian Crease
                    currency: USD
                    debtor_account_number: "987654321"
                    debtor_name: National Phonograph Company
                    debtor_routing_number: "101050001"
                    remittance_information: Invoice 29582
                    transaction_identification: 20220501234567891T1BSLZO01745013025
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transfer's currency. For dollars, for example, this is cents.
                      type: integer
                    creditor_name:
                      description: The name the sender of the transfer specified as the recipient of the transfer.
                      type: string
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's currency. This will always be "USD" for a Real Time Payments transfer.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    debtor_account_number:
                      description: The account number of the account that sent the transfer.
                      type: string
                    debtor_name:
                      description: The name provided by the sender of the transfer.
                      type: string
                    debtor_routing_number:
                      description: The routing number of the account that sent the transfer.
                      type: string
                    remittance_information:
                      description: Additional information included with the transfer.
                      nullable: true
                      type: string
                    transaction_identification:
                      description: The Real Time Payments network identification of the transfer
                      type: string
                  required:
                    - amount
                    - currency
                    - creditor_name
                    - debtor_name
                    - debtor_account_number
                    - debtor_routing_number
                    - transaction_identification
                    - remittance_information
                  title: Inbound Real Time Payments Transfer Confirmation
                  type: object
                  x-title-plural: Inbound Real Time Payments Transfer Confirmations
                inbound_wire_drawdown_payment:
                  description: A Inbound Wire Drawdown Payment object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
                  example:
                    amount: 100
                    beneficiary_address_line1: null
                    beneficiary_address_line2: null
                    beneficiary_address_line3: null
                    beneficiary_name: null
                    beneficiary_reference: null
                    description: Inbound wire drawdown payment
                    input_message_accountability_data: null
                    originator_address_line1: null
                    originator_address_line2: null
                    originator_address_line3: null
                    originator_name: null
                    originator_to_beneficiary_information: null
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    beneficiary_address_line1:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_address_line2:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_address_line3:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_name:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_reference:
                      description: ""
                      nullable: true
                      type: string
                    description:
                      description: ""
                      type: string
                    input_message_accountability_data:
                      description: ""
                      nullable: true
                      type: string
                    originator_address_line1:
                      description: ""
                      nullable: true
                      type: string
                    originator_address_line2:
                      description: ""
                      nullable: true
                      type: string
                    originator_address_line3:
                      description: ""
                      nullable: true
                      type: string
                    originator_name:
                      description: ""
                      nullable: true
                      type: string
                    originator_to_beneficiary_information:
                      description: ""
                      nullable: true
                      type: string
                  required:
                    - amount
                    - beneficiary_address_line1
                    - beneficiary_address_line2
                    - beneficiary_address_line3
                    - beneficiary_name
                    - beneficiary_reference
                    - description
                    - input_message_accountability_data
                    - originator_address_line1
                    - originator_address_line2
                    - originator_address_line3
                    - originator_name
                    - originator_to_beneficiary_information
                  title: Inbound Wire Drawdown Payment
                  type: object
                  x-title-plural: Inbound Wire Drawdown Payments
                inbound_wire_drawdown_payment_reversal:
                  description: A Inbound Wire Drawdown Payment Reversal object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_drawdown_payment_reversal`.
                  example:
                    amount: 12345
                    description: Inbound wire reversal 2022021100335128
                    input_cycle_date: 2022-02-11
                    input_message_accountability_data: 20220211B6B7HU2R011023
                    input_sequence_number: "11023"
                    input_source: B6B7HU2R
                    previous_message_input_cycle_date: 2022-02-10
                    previous_message_input_message_accountability_data: 20220210MMQFMP0P000007
                    previous_message_input_sequence_number: "3"
                    previous_message_input_source: MMQFMP0P
                  nullable: true
                  properties:
                    amount:
                      description: The amount that was reversed.
                      type: integer
                    description:
                      description: The description on the reversal message from Fedwire.
                      type: string
                    input_cycle_date:
                      description: The Fedwire cycle date for the wire reversal.
                      format: date
                      type: string
                    input_message_accountability_data:
                      description: The Fedwire transaction identifier.
                      type: string
                    input_sequence_number:
                      description: The Fedwire sequence number.
                      type: string
                    input_source:
                      description: The Fedwire input source identifier.
                      type: string
                    previous_message_input_cycle_date:
                      description: The Fedwire cycle date for the wire transfer that was reversed.
                      format: date
                      type: string
                    previous_message_input_message_accountability_data:
                      description: The Fedwire transaction identifier for the wire transfer that was reversed.
                      type: string
                    previous_message_input_sequence_number:
                      description: The Fedwire sequence number for the wire transfer that was reversed.
                      type: string
                    previous_message_input_source:
                      description: The Fedwire input source identifier for the wire transfer that was reversed.
                      type: string
                  required:
                    - amount
                    - description
                    - input_cycle_date
                    - input_sequence_number
                    - input_source
                    - input_message_accountability_data
                    - previous_message_input_message_accountability_data
                    - previous_message_input_cycle_date
                    - previous_message_input_sequence_number
                    - previous_message_input_source
                  title: Inbound Wire Drawdown Payment Reversal
                  type: object
                  x-title-plural: Inbound Wire Drawdown Payment Reversals
                inbound_wire_reversal:
                  description: A Inbound Wire Reversal object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_reversal`.
                  example:
                    amount: 12345
                    created_at: 2020-01-31T23:59:59Z
                    description: Inbound wire reversal 2022021100335128
                    financial_institution_to_financial_institution_information: null
                    input_cycle_date: 2022-02-11
                    input_message_accountability_data: 20220211B6B7HU2R011023
                    input_sequence_number: "11023"
                    input_source: B6B7HU2R
                    previous_message_input_cycle_date: 2022-02-10
                    previous_message_input_message_accountability_data: 20220210MMQFMP0P000007
                    previous_message_input_sequence_number: "3"
                    previous_message_input_source: MMQFMP0P
                    receiver_financial_institution_information: null
                    transaction_id: transaction_uyrp7fld2ium70oa7oi
                  nullable: true
                  properties:
                    amount:
                      description: The amount that was reversed.
                      type: integer
                    created_at:
                      description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the reversal was created.
                      format: date-time
                      type: string
                    description:
                      description: The description on the reversal message from Fedwire.
                      type: string
                    financial_institution_to_financial_institution_information:
                      description: Additional financial institution information included in the wire reversal.
                      nullable: true
                      type: string
                    input_cycle_date:
                      description: The Fedwire cycle date for the wire reversal.
                      format: date
                      type: string
                    input_message_accountability_data:
                      description: The Fedwire transaction identifier.
                      type: string
                    input_sequence_number:
                      description: The Fedwire sequence number.
                      type: string
                    input_source:
                      description: The Fedwire input source identifier.
                      type: string
                    previous_message_input_cycle_date:
                      description: The Fedwire cycle date for the wire transfer that was reversed.
                      format: date
                      type: string
                    previous_message_input_message_accountability_data:
                      description: The Fedwire transaction identifier for the wire transfer that was reversed.
                      type: string
                    previous_message_input_sequence_number:
                      description: The Fedwire sequence number for the wire transfer that was reversed.
                      type: string
                    previous_message_input_source:
                      description: The Fedwire input source identifier for the wire transfer that was reversed.
                      type: string
                    receiver_financial_institution_information:
                      description: Information included in the wire reversal for the receiving financial institution.
                      nullable: true
                      type: string
                    transaction_id:
                      description: The ID for the Transaction associated with the transfer reversal.
                      nullable: true
                      type: string
                  required:
                    - amount
                    - created_at
                    - description
                    - input_cycle_date
                    - input_sequence_number
                    - input_source
                    - input_message_accountability_data
                    - previous_message_input_message_accountability_data
                    - previous_message_input_cycle_date
                    - previous_message_input_sequence_number
                    - previous_message_input_source
                    - receiver_financial_institution_information
                    - financial_institution_to_financial_institution_information
                    - transaction_id
                  title: Inbound Wire Reversal
                  type: object
                  x-title-plural: Inbound Wire Reversals
                inbound_wire_transfer:
                  description: A Inbound Wire Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_transfer`.
                  example:
                    amount: 100
                    beneficiary_address_line1: null
                    beneficiary_address_line2: null
                    beneficiary_address_line3: null
                    beneficiary_name: null
                    beneficiary_reference: null
                    description: Inbound wire transfer
                    input_message_accountability_data: null
                    originator_address_line1: null
                    originator_address_line2: null
                    originator_address_line3: null
                    originator_name: null
                    originator_to_beneficiary_information: null
                    originator_to_beneficiary_information_line1: null
                    originator_to_beneficiary_information_line2: null
                    originator_to_beneficiary_information_line3: null
                    originator_to_beneficiary_information_line4: null
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    beneficiary_address_line1:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_address_line2:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_address_line3:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_name:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_reference:
                      description: ""
                      nullable: true
                      type: string
                    description:
                      description: ""
                      type: string
                    input_message_accountability_data:
                      description: ""
                      nullable: true
                      type: string
                    originator_address_line1:
                      description: ""
                      nullable: true
                      type: string
                    originator_address_line2:
                      description: ""
                      nullable: true
                      type: string
                    originator_address_line3:
                      description: ""
                      nullable: true
                      type: string
                    originator_name:
                      description: ""
                      nullable: true
                      type: string
                    originator_to_beneficiary_information:
                      description: ""
                      nullable: true
                      type: string
                    originator_to_beneficiary_information_line1:
                      description: ""
                      nullable: true
                      type: string
                    originator_to_beneficiary_information_line2:
                      description: ""
                      nullable: true
                      type: string
                    originator_to_beneficiary_information_line3:
                      description: ""
                      nullable: true
                      type: string
                    originator_to_beneficiary_information_line4:
                      description: ""
                      nullable: true
                      type: string
                  required:
                    - amount
                    - beneficiary_address_line1
                    - beneficiary_address_line2
                    - beneficiary_address_line3
                    - beneficiary_name
                    - beneficiary_reference
                    - description
                    - input_message_accountability_data
                    - originator_address_line1
                    - originator_address_line2
                    - originator_address_line3
                    - originator_name
                    - originator_to_beneficiary_information_line1
                    - originator_to_beneficiary_information_line2
                    - originator_to_beneficiary_information_line3
                    - originator_to_beneficiary_information_line4
                    - originator_to_beneficiary_information
                  title: Inbound Wire Transfer
                  type: object
                  x-title-plural: Inbound Wire Transfers
                interest_payment:
                  description: A Interest Payment object. This field will be present in the JSON response if and only if `category` is equal to `interest_payment`.
                  example:
                    accrued_on_account_id: account_in71c4amph0vgo2qllky
                    amount: 100
                    currency: USD
                    period_end: 2023-04-30T23:59:59Z
                    period_start: 2023-04-01T00:00:00Z
                  nullable: true
                  properties:
                    accrued_on_account_id:
                      description: The account on which the interest was accrued.
                      nullable: true
                      type: string
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    period_end:
                      description: The end of the period for which this transaction paid interest.
                      format: date-time
                      type: string
                    period_start:
                      description: The start of the period for which this transaction paid interest.
                      format: date-time
                      type: string
                  required:
                    - amount
                    - currency
                    - period_start
                    - period_end
                    - accrued_on_account_id
                  title: Interest Payment
                  type: object
                  x-title-plural: Interest Payments
                internal_source:
                  description: A Internal Source object. This field will be present in the JSON response if and only if `category` is equal to `internal_source`.
                  example:
                    amount: 100
                    currency: USD
                    reason: sample_funds
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    reason:
                      description: ""
                      enum:
                        - bank_migration
                        - cashback
                        - empyreal_adjustment
                        - error
                        - error_correction
                        - fees
                        - interest
                        - sample_funds
                        - sample_funds_return
                      type: string
                      x-enum-descriptions:
                        - Bank Migration
                        - Cashback
                        - Empyreal adjustment
                        - Error
                        - Error correction
                        - Fees
                        - Interest
                        - Sample funds
                        - Sample funds return
                  required:
                    - amount
                    - currency
                    - reason
                  title: Internal Source
                  type: object
                  x-title-plural: Internal Sources
                real_time_payments_transfer_acknowledgement:
                  description: A Real Time Payments Transfer Acknowledgement object. This field will be present in the JSON response if and only if `category` is equal to `real_time_payments_transfer_acknowledgement`.
                  example:
                    amount: 100
                    destination_account_number: "987654321"
                    destination_routing_number: "101050001"
                    remittance_information: Invoice 29582
                    transfer_id: real_time_payments_transfer_iyuhl5kdn7ssmup83mvq
                  nullable: true
                  properties:
                    amount:
                      description: The transfer amount in USD cents.
                      type: integer
                    destination_account_number:
                      description: The destination account number.
                      type: string
                    destination_routing_number:
                      description: The American Bankers' Association (ABA) Routing Transit Number (RTN).
                      type: string
                    remittance_information:
                      description: Unstructured information that will show on the recipient's bank statement.
                      type: string
                    transfer_id:
                      description: The identifier of the Real Time Payments Transfer that led to this Transaction.
                      type: string
                  required:
                    - amount
                    - destination_account_number
                    - destination_routing_number
                    - remittance_information
                    - transfer_id
                  title: Real Time Payments Transfer Acknowledgement
                  type: object
                  x-title-plural: Real Time Payments Transfer Acknowledgements
                sample_funds:
                  description: A Sample Funds object. This field will be present in the JSON response if and only if `category` is equal to `sample_funds`.
                  example:
                    originator: dashboard
                  nullable: true
                  properties:
                    originator:
                      description: Where the sample funds came from.
                      type: string
                  required:
                    - originator
                  title: Sample Funds
                  type: object
                  x-title-plural: Sample Fundss
                wire_drawdown_payment_intention:
                  description: A Wire Drawdown Payment Intention object. This field will be present in the JSON response if and only if `category` is equal to `wire_drawdown_payment_intention`.
                  example:
                    account_number: "987654321"
                    amount: 100
                    message_to_recipient: HELLO
                    routing_number: "101050001"
                    transfer_id: wire_transfer_5akynk7dqsq25qwk9q2u
                  nullable: true
                  properties:
                    account_number:
                      description: ""
                      type: string
                    amount:
                      description: The transfer amount in USD cents.
                      type: integer
                    message_to_recipient:
                      description: ""
                      type: string
                    routing_number:
                      description: ""
                      type: string
                    transfer_id:
                      description: ""
                      type: string
                  required:
                    - amount
                    - account_number
                    - routing_number
                    - message_to_recipient
                    - transfer_id
                  title: Wire Drawdown Payment Intention
                  type: object
                  x-title-plural: Wire Drawdown Payment Intentions
                wire_drawdown_payment_rejection:
                  description: A Wire Drawdown Payment Rejection object. This field will be present in the JSON response if and only if `category` is equal to `wire_drawdown_payment_rejection`.
                  example:
                    transfer_id: wire_transfer_5akynk7dqsq25qwk9q2u
                  nullable: true
                  properties:
                    transfer_id:
                      description: ""
                      type: string
                  required:
                    - transfer_id
                  title: Wire Drawdown Payment Rejection
                  type: object
                  x-title-plural: Wire Drawdown Payment Rejections
                wire_transfer_intention:
                  description: A Wire Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_intention`.
                  example:
                    account_number: "987654321"
                    amount: 100
                    message_to_recipient: HELLO
                    routing_number: "101050001"
                    transfer_id: wire_transfer_5akynk7dqsq25qwk9q2u
                  nullable: true
                  properties:
                    account_number:
                      description: The destination account number.
                      type: string
                    amount:
                      description: The transfer amount in USD cents.
                      type: integer
                    message_to_recipient:
                      description: The message that will show on the recipient's bank statement.
                      type: string
                    routing_number:
                      description: The American Bankers' Association (ABA) Routing Transit Number (RTN).
                      type: string
                    transfer_id:
                      description: ""
                      type: string
                  required:
                    - amount
                    - account_number
                    - routing_number
                    - message_to_recipient
                    - transfer_id
                  title: Wire Transfer Intention
                  type: object
                  x-title-plural: Wire Transfer Intentions
                wire_transfer_rejection:
                  description: A Wire Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_rejection`.
                  example:
                    transfer_id: wire_transfer_5akynk7dqsq25qwk9q2u
                  nullable: true
                  properties:
                    transfer_id:
                      description: ""
                      type: string
                  required:
                    - transfer_id
                  title: Wire Transfer Rejection
                  type: object
                  x-title-plural: Wire Transfer Rejections
              required:
                - category
                - account_transfer_intention
                - ach_check_conversion_return
                - ach_check_conversion
                - ach_transfer_intention
                - ach_transfer_rejection
                - ach_transfer_return
                - card_dispute_acceptance
                - card_refund
                - card_settlement
                - card_revenue_payment
                - check_deposit_acceptance
                - check_deposit_return
                - check_transfer_intention
                - check_transfer_return
                - check_transfer_rejection
                - check_transfer_stop_payment_request
                - dispute_resolution
                - empyreal_cash_deposit
                - fee_payment
                - inbound_ach_transfer
                - inbound_check
                - inbound_international_ach_transfer
                - inbound_real_time_payments_transfer_confirmation
                - inbound_wire_drawdown_payment_reversal
                - inbound_wire_drawdown_payment
                - inbound_wire_reversal
                - inbound_wire_transfer
                - interest_payment
                - internal_source
                - card_route_refund
                - card_route_settlement
                - real_time_payments_transfer_acknowledgement
                - sample_funds
                - wire_drawdown_payment_intention
                - wire_drawdown_payment_rejection
                - wire_transfer_intention
                - wire_transfer_rejection
              title: Transaction Source
              type: object
              x-title-plural: Transaction Sources
            type:
              description: A constant representing the object's type. For this resource it will always be `transaction`.
              enum:
                - transaction
              type: string
          required:
            - account_id
            - amount
            - currency
            - created_at
            - description
            - id
            - route_id
            - route_type
            - source
            - type
          title: Transaction
          type: object
          x-title-plural: Transactions
        type:
          description: A constant representing the object's type. For this resource it will always be `inbound_wire_transfer_simulation_result`.
          enum:
            - inbound_wire_transfer_simulation_result
          type: string
      required:
        - transaction
        - type
      title: Inbound Wire Transfer Simulation Result
      type: object
      x-title-plural: Inbound Wire Transfer Simulation Results
    interest_payment_simulation_result:
      description: The results of an Interest Payment simulation.
      example:
        transaction:
          account_id: account_in71c4amph0vgo2qllky
          amount: 100
          created_at: 2020-01-31T23:59:59Z
          currency: USD
          description: Interest Payment 2020-01
          id: transaction_uyrp7fld2ium70oa7oi
          route_id: null
          route_type: null
          source:
            category: interest_payment
            interest_payment:
              accrued_on_account_id: account_in71c4amph0vgo2qllky
              amount: 100
              currency: USD
              period_end: 2023-04-30T23:59:59Z
              period_start: 2023-04-01T00:00:00Z
          type: transaction
        type: interest_payment_simulation_result
      properties:
        transaction:
          description: "This will contain the resulting [Transaction](#transactions) object. The Transaction's `source` will be of `category: interest_payment`."
          example:
            account_id: account_in71c4amph0vgo2qllky
            amount: 100
            created_at: 2020-01-31T23:59:59Z
            currency: USD
            description: Frederick S. Holmes
            id: transaction_uyrp7fld2ium70oa7oi
            route_id: account_number_v18nkfqm6afpsrvy82b2
            route_type: account_number
            source:
              category: inbound_ach_transfer
              inbound_ach_transfer:
                amount: 100
                originator_company_descriptive_date: null
                originator_company_discretionary_data: null
                originator_company_entry_description: RESERVE
                originator_company_id: "0987654321"
                originator_company_name: BIG BANK
                receiver_id_number: "12345678900"
                receiver_name: IAN CREASE
                trace_number: "021000038461022"
            type: transaction
          properties:
            account_id:
              description: The identifier for the Account the Transaction belongs to.
              type: string
            amount:
              description: The Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.
              type: integer
            created_at:
              description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Transaction occured.
              format: date-time
              type: string
            currency:
              description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Transaction's currency. This will match the currency on the Transcation's Account.
              enum:
                - CAD
                - CHF
                - EUR
                - GBP
                - JPY
                - USD
              type: string
              x-enum-descriptions:
                - Canadian Dollar (CAD)
                - Swiss Franc (CHF)
                - Euro (EUR)
                - British Pound (GBP)
                - Japanese Yen (JPY)
                - US Dollar (USD)
            description:
              description: For a Transaction related to a transfer, this is the description you provide. For a Transaction related to a payment, this is the description the vendor provides.
              type: string
            id:
              description: The Transaction identifier.
              type: string
            route_id:
              description: The identifier for the route this Transaction came through. Routes are things like cards and ACH details.
              nullable: true
              type: string
            route_type:
              description: The type of the route this Transaction came through.
              enum:
                - account_number
                - card
              nullable: true
              type: string
              x-enum-descriptions:
                - An Account Number.
                - A Card.
            source:
              description: This is an object giving more details on the network-level event that caused the Transaction. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.
              example:
                category: inbound_ach_transfer
                inbound_ach_transfer:
                  amount: 100
                  originator_company_descriptive_date: null
                  originator_company_discretionary_data: null
                  originator_company_entry_description: RESERVE
                  originator_company_id: "0987654321"
                  originator_company_name: BIG BANK
                  receiver_id_number: "12345678900"
                  receiver_name: IAN CREASE
                  trace_number: "021000038461022"
              properties:
                account_transfer_intention:
                  description: A Account Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `account_transfer_intention`.
                  example:
                    amount: 100
                    currency: USD
                    description: Frederick S. Holmes
                    destination_account_id: account_uf16sut2ct5bevmq3eh
                    source_account_id: account_in71c4amph0vgo2qllky
                    transfer_id: account_transfer_7k9qe1ysdgqztnt63l7n
                  nullable: true
                  properties:
                    amount:
                      description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    description:
                      description: The description you chose to give the transfer.
                      type: string
                    destination_account_id:
                      description: The identifier of the Account to where the Account Transfer was sent.
                      type: string
                    source_account_id:
                      description: The identifier of the Account from where the Account Transfer was sent.
                      type: string
                    transfer_id:
                      description: The identifier of the Account Transfer that led to this Pending Transaction.
                      type: string
                  required:
                    - amount
                    - currency
                    - description
                    - destination_account_id
                    - source_account_id
                    - transfer_id
                  title: Account Transfer Intention
                  type: object
                  x-title-plural: Account Transfer Intentions
                ach_check_conversion:
                  description: A ACH Check Conversion object. This field will be present in the JSON response if and only if `category` is equal to `ach_check_conversion`.
                  example:
                    amount: 100
                    file_id: file_makxrc67oh9l6sg7w9yc
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    file_id:
                      description: The identifier of the File containing an image of the returned check.
                      type: string
                  required:
                    - amount
                    - file_id
                  title: ACH Check Conversion
                  type: object
                  x-title-plural: ACH Check Conversions
                ach_check_conversion_return:
                  description: A ACH Check Conversion Return object. This field will be present in the JSON response if and only if `category` is equal to `ach_check_conversion_return`.
                  example:
                    amount: 100
                    return_reason_code: ""
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    return_reason_code:
                      description: Why the transfer was returned.
                      type: string
                  required:
                    - amount
                    - return_reason_code
                  title: ACH Check Conversion Return
                  type: object
                  x-title-plural: ACH Check Conversion Returns
                ach_transfer_intention:
                  description: A ACH Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_intention`.
                  example:
                    account_number: "987654321"
                    amount: 100
                    routing_number: "101050001"
                    statement_descriptor: Frederick S. Holmes
                    transfer_id: account_transfer_7k9qe1ysdgqztnt63l7n
                  nullable: true
                  properties:
                    account_number:
                      description: ""
                      type: string
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    routing_number:
                      description: ""
                      type: string
                    statement_descriptor:
                      description: ""
                      type: string
                    transfer_id:
                      description: The identifier of the ACH Transfer that led to this Transaction.
                      type: string
                  required:
                    - amount
                    - account_number
                    - routing_number
                    - statement_descriptor
                    - transfer_id
                  title: ACH Transfer Intention
                  type: object
                  x-title-plural: ACH Transfer Intentions
                ach_transfer_rejection:
                  description: A ACH Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_rejection`.
                  example:
                    transfer_id: account_transfer_7k9qe1ysdgqztnt63l7n
                  nullable: true
                  properties:
                    transfer_id:
                      description: The identifier of the ACH Transfer that led to this Transaction.
                      type: string
                  required:
                    - transfer_id
                  title: ACH Transfer Rejection
                  type: object
                  x-title-plural: ACH Transfer Rejections
                ach_transfer_return:
                  description: A ACH Transfer Return object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_return`.
                  example:
                    created_at: 2020-01-31T23:59:59Z
                    return_reason_code: insufficient_fund
                    transaction_id: transaction_uyrp7fld2ium70oa7oi
                    transfer_id: ach_transfer_uoxatyh3lt5evrsdvo7q
                  nullable: true
                  properties:
                    created_at:
                      description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.
                      format: date-time
                      type: string
                    return_reason_code:
                      description: Why the ACH Transfer was returned.
                      enum:
                        - insufficient_fund
                        - no_account
                        - account_closed
                        - invalid_account_number_structure
                        - account_frozen_entry_returned_per_ofac_instruction
                        - credit_entry_refused_by_receiver
                        - unauthorized_debit_to_consumer_account_using_corporate_sec_code
                        - corporate_customer_advised_not_authorized
                        - payment_stopped
                        - non_transaction_account
                        - uncollected_funds
                        - routing_number_check_digit_error
                        - customer_advised_unauthorized_improper_ineligible_or_incomplete
                        - amount_field_error
                        - authorization_revoked_by_customer
                        - invalid_ach_routing_number
                        - file_record_edit_criteria
                        - enr_invalid_individual_name
                        - returned_per_odfi_request
                        - addenda_error
                        - limited_participation_dfi
                        - incorrectly_coded_outbound_international_payment
                        - other
                      type: string
                      x-enum-descriptions:
                        - Insufficient funds in the source account.
                        - The account does not exist or the receiving bank was unable to locate it.
                        - The account is closed.
                        - The account number is invalid at the receiving bank.
                        - The account was frozen per the Office of Foreign Assets Control.
                        - The receiving bank account refused a credit transfer.
                        - The receiving bank rejected because of an incorrect Standard Entry Class code.
                        - The corporate customer reversed the transfer.
                        - The receiving bank stopped payment on this transfer.
                        - The receiving bank account does not perform transfers.
                        - The receiving bank account does not have enough available balance for the transfer.
                        - The routing number is incorrect.
                        - The customer reversed the transfer.
                        - The amount field is incorrect or too large.
                        - The customer who initiated the transfer revoked authorization.
                        - The routing number is invalid.
                        - The receiving bank is unable to process a field in the transfer.
                        - The individual name field was invalid.
                        - The originating financial institution reversed the transfer.
                        - The addenda record is incorrect or missing.
                        - The receiving bank's regulatory supervisor has limited their participation.
                        - The outbound international ACH transfer was incorrect.
                        - Any other ACH return reason.
                    transaction_id:
                      description: The identifier of the Tranasaction associated with this return.
                      type: string
                    transfer_id:
                      description: The identifier of the ACH Transfer associated with this return.
                      type: string
                  required:
                    - created_at
                    - return_reason_code
                    - transfer_id
                    - transaction_id
                  title: ACH Transfer Return
                  type: object
                  x-title-plural: ACH Transfer Returns
                card_dispute_acceptance:
                  description: A Card Dispute Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `card_dispute_acceptance`.
                  example:
                    accepted_at: 2020-01-31T23:59:59Z
                    card_dispute_id: card_dispute_h9sc95nbl1cgltpp7men
                    transaction_id: transaction_uyrp7fld2ium70oa7oi
                  nullable: true
                  properties:
                    accepted_at:
                      description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was accepted.
                      format: date-time
                      type: string
                    card_dispute_id:
                      description: The identifier of the Card Dispute that was accepted.
                      type: string
                    transaction_id:
                      description: The identifier of the Transaction that was created to return the disputed funds to your account.
                      type: string
                  required:
                    - accepted_at
                    - card_dispute_id
                    - transaction_id
                  title: Card Dispute Acceptance
                  type: object
                  x-title-plural: Card Dispute Acceptances
                card_refund:
                  description: A Card Refund object. This field will be present in the JSON response if and only if `category` is equal to `card_refund`.
                  example:
                    amount: 100
                    card_settlement_transaction_id: transaction_uyrp7fld2ium70oa7oi
                    currency: USD
                    id: card_refund_imgc2xwplh6t4r3gn16e
                    merchant_acceptor_id: "5665270011000168"
                    merchant_category_code: "5734"
                    merchant_city: New York
                    merchant_country: US
                    merchant_name: AMAZON.COM
                    merchant_state: NY
                    type: card_refund
                  nullable: true
                  properties:
                    amount:
                      description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    card_settlement_transaction_id:
                      description: The identifier for the Transaction this refunds, if any.
                      nullable: true
                      type: string
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    id:
                      description: The Card Refund identifier.
                      type: string
                    merchant_acceptor_id:
                      description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.
                      nullable: true
                      type: string
                    merchant_category_code:
                      description: The 4-digit MCC describing the merchant's business.
                      type: string
                    merchant_city:
                      description: The city the merchant resides in.
                      nullable: true
                      type: string
                    merchant_country:
                      description: The country the merchant resides in.
                      type: string
                    merchant_name:
                      description: The name of the merchant.
                      nullable: true
                      type: string
                    merchant_state:
                      description: The state the merchant resides in.
                      nullable: true
                      type: string
                    type:
                      description: A constant representing the object's type. For this resource it will always be `card_refund`.
                      enum:
                        - card_refund
                      type: string
                  required:
                    - id
                    - amount
                    - currency
                    - card_settlement_transaction_id
                    - merchant_acceptor_id
                    - merchant_city
                    - merchant_state
                    - merchant_country
                    - merchant_name
                    - merchant_category_code
                    - type
                  title: Card Refund
                  type: object
                  x-title-plural: Card Refunds
                card_revenue_payment:
                  description: A Card Revenue Payment object. This field will be present in the JSON response if and only if `category` is equal to `card_revenue_payment`.
                  example:
                    amount: 100
                    currency: USD
                    period_end: 2023-04-30T23:59:59Z
                    period_start: 2023-04-01T00:00:00Z
                    transacted_on_account_id: account_in71c4amph0vgo2qllky
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    period_end:
                      description: The end of the period for which this transaction paid interest.
                      format: date-time
                      type: string
                    period_start:
                      description: The start of the period for which this transaction paid interest.
                      format: date-time
                      type: string
                    transacted_on_account_id:
                      description: The account the card belonged to.
                      nullable: true
                      type: string
                  required:
                    - amount
                    - currency
                    - period_start
                    - period_end
                    - transacted_on_account_id
                  title: Card Revenue Payment
                  type: object
                  x-title-plural: Card Revenue Payments
                card_route_refund:
                  description: A Deprecated Card Refund object. This field will be present in the JSON response if and only if `category` is equal to `card_route_refund`.
                  example:
                    amount: 1000
                    currency: USD
                    merchant_acceptor_id: "372909060886"
                    merchant_category_code: "5998"
                    merchant_city: "5364086000"
                    merchant_country: USA
                    merchant_descriptor: TENTS R US
                    merchant_state: CA
                  nullable: true
                  properties:
                    amount:
                      description: The refunded amount in the minor unit of the refunded currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the refund currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    merchant_acceptor_id:
                      description: ""
                      type: string
                    merchant_category_code:
                      description: ""
                      nullable: true
                      type: string
                    merchant_city:
                      description: ""
                      nullable: true
                      type: string
                    merchant_country:
                      description: ""
                      type: string
                    merchant_descriptor:
                      description: ""
                      type: string
                    merchant_state:
                      description: ""
                      nullable: true
                      type: string
                  required:
                    - amount
                    - currency
                    - merchant_acceptor_id
                    - merchant_city
                    - merchant_country
                    - merchant_descriptor
                    - merchant_state
                    - merchant_category_code
                  title: Deprecated Card Refund
                  type: object
                  x-title-plural: Deprecated Card Refunds
                card_route_settlement:
                  description: A Deprecated Card Settlement object. This field will be present in the JSON response if and only if `category` is equal to `card_route_settlement`.
                  example:
                    amount: 1000
                    currency: USD
                    merchant_acceptor_id: "372909060886"
                    merchant_category_code: "5998"
                    merchant_city: "5364086000"
                    merchant_country: USA
                    merchant_descriptor: TENTS R US
                    merchant_state: CA
                  nullable: true
                  properties:
                    amount:
                      description: The settled amount in the minor unit of the settlement currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the settlement currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    merchant_acceptor_id:
                      description: ""
                      type: string
                    merchant_category_code:
                      description: ""
                      nullable: true
                      type: string
                    merchant_city:
                      description: ""
                      nullable: true
                      type: string
                    merchant_country:
                      description: ""
                      nullable: true
                      type: string
                    merchant_descriptor:
                      description: ""
                      type: string
                    merchant_state:
                      description: ""
                      nullable: true
                      type: string
                  required:
                    - amount
                    - currency
                    - merchant_acceptor_id
                    - merchant_city
                    - merchant_country
                    - merchant_descriptor
                    - merchant_state
                    - merchant_category_code
                  title: Deprecated Card Settlement
                  type: object
                  x-title-plural: Deprecated Card Settlements
                card_settlement:
                  description: A Card Settlement object. This field will be present in the JSON response if and only if `category` is equal to `card_settlement`.
                  example:
                    amount: 100
                    card_authorization: null
                    currency: USD
                    id: card_settlement_khv5kfeu0vndj291omg6
                    merchant_acceptor_id: "5665270011000168"
                    merchant_category_code: "5734"
                    merchant_city: New York
                    merchant_country: US
                    merchant_name: AMAZON.COM
                    merchant_state: NY
                    pending_transaction_id: null
                    presentment_amount: 100
                    presentment_currency: USD
                    type: card_settlement
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's settlement currency. For dollars, for example, this is cents.
                      type: integer
                    card_authorization:
                      description: The Card Authorization that was created prior to this Card Settlement, if on exists.
                      nullable: true
                      type: string
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's settlement currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    id:
                      description: The Card Settlement identifier.
                      type: string
                    merchant_acceptor_id:
                      description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.
                      nullable: true
                      type: string
                    merchant_category_code:
                      description: The 4-digit MCC describing the merchant's business.
                      type: string
                    merchant_city:
                      description: The city the merchant resides in.
                      nullable: true
                      type: string
                    merchant_country:
                      description: The country the merchant resides in.
                      type: string
                    merchant_name:
                      description: The name of the merchant.
                      nullable: true
                      type: string
                    merchant_state:
                      description: The state the merchant resides in.
                      nullable: true
                      type: string
                    pending_transaction_id:
                      description: The identifier of the Pending Transaction associated with this Transaction.
                      nullable: true
                      type: string
                    presentment_amount:
                      description: The amount in the minor unit of the transaction's presentment currency.
                      type: integer
                    presentment_currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's presentment currency.
                      type: string
                    type:
                      description: A constant representing the object's type. For this resource it will always be `card_settlement`.
                      enum:
                        - card_settlement
                      type: string
                  required:
                    - id
                    - card_authorization
                    - amount
                    - currency
                    - presentment_amount
                    - presentment_currency
                    - merchant_acceptor_id
                    - merchant_city
                    - merchant_state
                    - merchant_country
                    - merchant_name
                    - merchant_category_code
                    - pending_transaction_id
                    - type
                  title: Card Settlement
                  type: object
                  x-title-plural: Card Settlements
                category:
                  description: The type of transaction that took place. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
                  enum:
                    - account_transfer_intention
                    - ach_check_conversion_return
                    - ach_check_conversion
                    - ach_transfer_intention
                    - ach_transfer_rejection
                    - ach_transfer_return
                    - card_dispute_acceptance
                    - card_refund
                    - card_settlement
                    - card_revenue_payment
                    - check_deposit_acceptance
                    - check_deposit_return
                    - check_transfer_intention
                    - check_transfer_return
                    - check_transfer_rejection
                    - check_transfer_stop_payment_request
                    - dispute_resolution
                    - empyreal_cash_deposit
                    - fee_payment
                    - inbound_ach_transfer
                    - inbound_ach_transfer_return_intention
                    - inbound_check
                    - inbound_international_ach_transfer
                    - inbound_real_time_payments_transfer_confirmation
                    - inbound_wire_drawdown_payment_reversal
                    - inbound_wire_drawdown_payment
                    - inbound_wire_reversal
                    - inbound_wire_transfer
                    - interest_payment
                    - internal_general_ledger_transaction
                    - internal_source
                    - card_route_refund
                    - card_route_settlement
                    - real_time_payments_transfer_acknowledgement
                    - sample_funds
                    - wire_drawdown_payment_intention
                    - wire_drawdown_payment_rejection
                    - wire_transfer_intention
                    - wire_transfer_rejection
                    - other
                  type: string
                  x-enum-descriptions:
                    - The Transaction was created by a Account Transfer Intention object. Details will be under the `account_transfer_intention` object.
                    - The Transaction was created by a ACH Check Conversion Return object. Details will be under the `ach_check_conversion_return` object.
                    - The Transaction was created by a ACH Check Conversion object. Details will be under the `ach_check_conversion` object.
                    - The Transaction was created by a ACH Transfer Intention object. Details will be under the `ach_transfer_intention` object.
                    - The Transaction was created by a ACH Transfer Rejection object. Details will be under the `ach_transfer_rejection` object.
                    - The Transaction was created by a ACH Transfer Return object. Details will be under the `ach_transfer_return` object.
                    - The Transaction was created by a Card Dispute Acceptance object. Details will be under the `card_dispute_acceptance` object.
                    - The Transaction was created by a Card Refund object. Details will be under the `card_refund` object.
                    - The Transaction was created by a Card Settlement object. Details will be under the `card_settlement` object.
                    - The Transaction was created by a Card Revenue Payment object. Details will be under the `card_revenue_payment` object.
                    - The Transaction was created by a Check Deposit Acceptance object. Details will be under the `check_deposit_acceptance` object.
                    - The Transaction was created by a Check Deposit Return object. Details will be under the `check_deposit_return` object.
                    - The Transaction was created by a Check Transfer Intention object. Details will be under the `check_transfer_intention` object.
                    - The Transaction was created by a Check Transfer Return object. Details will be under the `check_transfer_return` object.
                    - The Transaction was created by a Check Transfer Rejection object. Details will be under the `check_transfer_rejection` object.
                    - The Transaction was created by a Check Transfer Stop Payment Request object. Details will be under the `check_transfer_stop_payment_request` object.
                    - The Transaction was created by a Dispute Resolution object. Details will be under the `dispute_resolution` object.
                    - The Transaction was created by a Empyreal Cash Deposit object. Details will be under the `empyreal_cash_deposit` object.
                    - The Transaction was created by a Fee Payment object. Details will be under the `fee_payment` object.
                    - The Transaction was created by a Inbound ACH Transfer object. Details will be under the `inbound_ach_transfer` object.
                    - The Transaction was created by a Inbound ACH Transfer Return Intention object. Details will be under the `inbound_ach_transfer_return_intention` object.
                    - The Transaction was created by a Inbound Check object. Details will be under the `inbound_check` object.
                    - The Transaction was created by a Inbound International ACH Transfer object. Details will be under the `inbound_international_ach_transfer` object.
                    - The Transaction was created by a Inbound Real Time Payments Transfer Confirmation object. Details will be under the `inbound_real_time_payments_transfer_confirmation` object.
                    - The Transaction was created by a Inbound Wire Drawdown Payment Reversal object. Details will be under the `inbound_wire_drawdown_payment_reversal` object.
                    - The Transaction was created by a Inbound Wire Drawdown Payment object. Details will be under the `inbound_wire_drawdown_payment` object.
                    - The Transaction was created by a Inbound Wire Reversal object. Details will be under the `inbound_wire_reversal` object.
                    - The Transaction was created by a Inbound Wire Transfer object. Details will be under the `inbound_wire_transfer` object.
                    - The Transaction was created by a Interest Payment object. Details will be under the `interest_payment` object.
                    - The Transaction was created by a Internal General Ledger Transaction object. Details will be under the `internal_general_ledger_transaction` object.
                    - The Transaction was created by a Internal Source object. Details will be under the `internal_source` object.
                    - The Transaction was created by a Deprecated Card Refund object. Details will be under the `card_route_refund` object.
                    - The Transaction was created by a Deprecated Card Settlement object. Details will be under the `card_route_settlement` object.
                    - The Transaction was created by a Real Time Payments Transfer Acknowledgement object. Details will be under the `real_time_payments_transfer_acknowledgement` object.
                    - The Transaction was created by a Sample Funds object. Details will be under the `sample_funds` object.
                    - The Transaction was created by a Wire Drawdown Payment Intention object. Details will be under the `wire_drawdown_payment_intention` object.
                    - The Transaction was created by a Wire Drawdown Payment Rejection object. Details will be under the `wire_drawdown_payment_rejection` object.
                    - The Transaction was created by a Wire Transfer Intention object. Details will be under the `wire_transfer_intention` object.
                    - The Transaction was created by a Wire Transfer Rejection object. Details will be under the `wire_transfer_rejection` object.
                    - The Transaction was made for an undocumented or deprecated reason.
                check_deposit_acceptance:
                  description: A Check Deposit Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_acceptance`.
                  example:
                    account_number: "987654321"
                    amount: 100
                    auxiliary_on_us: "101"
                    check_deposit_id: check_deposit_f06n9gpg7sxn8t19lfc1
                    currency: USD
                    routing_number: "101050001"
                    serial_number: null
                  nullable: true
                  properties:
                    account_number:
                      description: The account number printed on the check.
                      type: string
                    amount:
                      description: The amount to be deposited in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    auxiliary_on_us:
                      description: An additional line of metadata printed on the check. This typically includes the check number for business checks.
                      nullable: true
                      type: string
                    check_deposit_id:
                      description: The ID of the Check Deposit that was accepted.
                      type: string
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    routing_number:
                      description: The routing number printed on the check.
                      type: string
                    serial_number:
                      description: The check serial number, if present, for consumer checks. For business checks, the serial number is usually in the `auxiliary_on_us` field.
                      nullable: true
                      type: string
                  required:
                    - amount
                    - currency
                    - account_number
                    - routing_number
                    - auxiliary_on_us
                    - serial_number
                    - check_deposit_id
                  title: Check Deposit Acceptance
                  type: object
                  x-title-plural: Check Deposit Acceptances
                check_deposit_return:
                  description: A Check Deposit Return object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_return`.
                  example:
                    amount: 100
                    check_deposit_id: check_deposit_f06n9gpg7sxn8t19lfc1
                    currency: USD
                    return_reason: insufficient_funds
                    returned_at: 2020-01-31T23:59:59Z
                    transaction_id: transaction_uyrp7fld2ium70oa7oi
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    check_deposit_id:
                      description: The identifier of the Check Deposit that was returned.
                      type: string
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    return_reason:
                      description: ""
                      enum:
                        - ach_conversion_not_supported
                        - closed_account
                        - duplicate_submission
                        - insufficient_funds
                        - no_account
                        - not_authorized
                        - stale_dated
                        - stop_payment
                        - unknown_reason
                        - unmatched_details
                        - unreadable_image
                      type: string
                      x-enum-descriptions:
                        - The check doesn't allow ACH conversion.
                        - The account is closed.
                        - The check has already been deposited.
                        - Insufficient funds
                        - No account was found matching the check details.
                        - The check was not authorized.
                        - The check is too old.
                        - The payment has been stopped by the account holder.
                        - The reason for the return is unknown.
                        - The image doesn't match the details submitted.
                        - The image could not be read.
                    returned_at:
                      description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check deposit was returned.
                      format: date-time
                      type: string
                    transaction_id:
                      description: The identifier of the transaction that reversed the original check deposit transaction.
                      type: string
                  required:
                    - amount
                    - returned_at
                    - currency
                    - check_deposit_id
                    - transaction_id
                    - return_reason
                  title: Check Deposit Return
                  type: object
                  x-title-plural: Check Deposit Returns
                check_transfer_intention:
                  description: A Check Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_intention`.
                  example:
                    address_city: New York
                    address_line1: 33 Liberty Street
                    address_line2: null
                    address_state: NY
                    address_zip: "10045"
                    amount: 1000
                    currency: USD
                    recipient_name: Ian Crease
                    transfer_id: check_transfer_30b43acfu9vw8fyc4f5
                  nullable: true
                  properties:
                    address_city:
                      description: The city of the check's destination.
                      type: string
                    address_line1:
                      description: The street address of the check's destination.
                      type: string
                    address_line2:
                      description: The second line of the address of the check's destination.
                      nullable: true
                      type: string
                    address_state:
                      description: The state of the check's destination.
                      type: string
                    address_zip:
                      description: The postal code of the check's destination.
                      type: string
                    amount:
                      description: The transfer amount in USD cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    recipient_name:
                      description: The name that will be printed on the check.
                      type: string
                    transfer_id:
                      description: The identifier of the Check Transfer with which this is associated.
                      type: string
                  required:
                    - address_line1
                    - address_line2
                    - address_city
                    - address_state
                    - address_zip
                    - amount
                    - currency
                    - recipient_name
                    - transfer_id
                  title: Check Transfer Intention
                  type: object
                  x-title-plural: Check Transfer Intentions
                check_transfer_rejection:
                  description: A Check Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_rejection`.
                  example:
                    transfer_id: check_transfer_30b43acfu9vw8fyc4f5
                  nullable: true
                  properties:
                    transfer_id:
                      description: The identifier of the Check Transfer that led to this Transaction.
                      type: string
                  required:
                    - transfer_id
                  title: Check Transfer Rejection
                  type: object
                  x-title-plural: Check Transfer Rejections
                check_transfer_return:
                  description: A Check Transfer Return object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_return`.
                  example:
                    file_id: null
                    reason: mail_delivery_failure
                    returned_at: 2020-01-31T23:59:59Z
                    transaction_id: transaction_uyrp7fld2ium70oa7oi
                    transfer_id: check_transfer_30b43acfu9vw8fyc4f5
                  nullable: true
                  properties:
                    file_id:
                      description: If available, a document with additional information about the return.
                      nullable: true
                      type: string
                    reason:
                      description: The reason why the check was returned.
                      enum:
                        - mail_delivery_failure
                        - refused_by_recipient
                      type: string
                      x-enum-descriptions:
                        - Mail delivery failed and the check was returned to sender.
                        - The check arrived and the recipient refused to deposit it.
                    returned_at:
                      description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check was returned.
                      format: date-time
                      type: string
                    transaction_id:
                      description: The identifier of the Transaction that was created to credit you for the returned check.
                      nullable: true
                      type: string
                    transfer_id:
                      description: The identifier of the returned Check Transfer.
                      type: string
                  required:
                    - transfer_id
                    - returned_at
                    - file_id
                    - reason
                    - transaction_id
                  title: Check Transfer Return
                  type: object
                  x-title-plural: Check Transfer Returns
                check_transfer_stop_payment_request:
                  description: A Check Transfer Stop Payment Request object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_stop_payment_request`.
                  example:
                    requested_at: 2020-01-31T23:59:59Z
                    transaction_id: transaction_uyrp7fld2ium70oa7oi
                    transfer_id: check_transfer_30b43acfu9vw8fyc4f5
                    type: check_transfer_stop_payment_request
                  nullable: true
                  properties:
                    requested_at:
                      description: The time the stop-payment was requested.
                      format: date-time
                      type: string
                    transaction_id:
                      description: The transaction ID of the corresponding credit transaction.
                      type: string
                    transfer_id:
                      description: The ID of the check transfer that was stopped.
                      type: string
                    type:
                      description: A constant representing the object's type. For this resource it will always be `check_transfer_stop_payment_request`.
                      enum:
                        - check_transfer_stop_payment_request
                      type: string
                  required:
                    - transfer_id
                    - transaction_id
                    - requested_at
                    - type
                  title: Check Transfer Stop Payment Request
                  type: object
                  x-title-plural: Check Transfer Stop Payment Requests
                dispute_resolution:
                  description: A Dispute Resolution object. This field will be present in the JSON response if and only if `category` is equal to `dispute_resolution`.
                  example:
                    amount: 100
                    currency: USD
                    disputed_transaction_id: transaction_uyrp7fld2ium70oa7oi
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    disputed_transaction_id:
                      description: The identifier of the Transaction that was disputed.
                      type: string
                  required:
                    - amount
                    - currency
                    - disputed_transaction_id
                  title: Dispute Resolution
                  type: object
                  x-title-plural: Dispute Resolutions
                empyreal_cash_deposit:
                  description: A Empyreal Cash Deposit object. This field will be present in the JSON response if and only if `category` is equal to `empyreal_cash_deposit`.
                  example:
                    amount: 100
                    bag_id: "12345"
                    deposit_date: 2020-01-31T23:59:59Z
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    bag_id:
                      description: ""
                      type: string
                    deposit_date:
                      description: ""
                      format: date-time
                      type: string
                  required:
                    - amount
                    - bag_id
                    - deposit_date
                  title: Empyreal Cash Deposit
                  type: object
                  x-title-plural: Empyreal Cash Deposits
                fee_payment:
                  description: A Fee Payment object. This field will be present in the JSON response if and only if `category` is equal to `fee_payment`.
                  example:
                    amount: 100
                    currency: USD
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                  required:
                    - amount
                    - currency
                  title: Fee Payment
                  type: object
                  x-title-plural: Fee Payments
                inbound_ach_transfer:
                  description: A Inbound ACH Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_ach_transfer`.
                  example:
                    amount: 100
                    originator_company_descriptive_date: null
                    originator_company_discretionary_data: null
                    originator_company_entry_description: RESERVE
                    originator_company_id: "0987654321"
                    originator_company_name: BIG BANK
                    receiver_id_number: "12345678900"
                    receiver_name: IAN CREASE
                    trace_number: "021000038461022"
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    originator_company_descriptive_date:
                      description: ""
                      nullable: true
                      type: string
                    originator_company_discretionary_data:
                      description: ""
                      nullable: true
                      type: string
                    originator_company_entry_description:
                      description: ""
                      type: string
                    originator_company_id:
                      description: ""
                      type: string
                    originator_company_name:
                      description: ""
                      type: string
                    receiver_id_number:
                      description: ""
                      nullable: true
                      type: string
                    receiver_name:
                      description: ""
                      nullable: true
                      type: string
                    trace_number:
                      description: ""
                      type: string
                  required:
                    - amount
                    - originator_company_name
                    - originator_company_descriptive_date
                    - originator_company_discretionary_data
                    - originator_company_entry_description
                    - originator_company_id
                    - receiver_id_number
                    - receiver_name
                    - trace_number
                  title: Inbound ACH Transfer
                  type: object
                  x-title-plural: Inbound ACH Transfers
                inbound_check:
                  description: A Inbound Check object. This field will be present in the JSON response if and only if `category` is equal to `inbound_check`.
                  example:
                    amount: 100
                    check_front_image_file_id: file_makxrc67oh9l6sg7w9yc
                    check_number: "       00000123"
                    check_rear_image_file_id: file_makxrc67oh9l6sg7w9yc
                    currency: USD
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    check_front_image_file_id:
                      description: ""
                      nullable: true
                      type: string
                    check_number:
                      description: ""
                      nullable: true
                      type: string
                    check_rear_image_file_id:
                      description: ""
                      nullable: true
                      type: string
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                  required:
                    - amount
                    - currency
                    - check_number
                    - check_front_image_file_id
                    - check_rear_image_file_id
                  title: Inbound Check
                  type: object
                  x-title-plural: Inbound Checks
                inbound_international_ach_transfer:
                  description: A Inbound International ACH Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_international_ach_transfer`.
                  example:
                    amount: -1000
                    destination_country_code: US
                    destination_currency_code: USD
                    foreign_exchange_indicator: fixed_to_fixed
                    foreign_exchange_reference: null
                    foreign_exchange_reference_indicator: blank
                    foreign_payment_amount: 199
                    foreign_trace_number: null
                    international_transaction_type_code: internet_initiated
                    originating_currency_code: USD
                    originating_depository_financial_institution_branch_country: US
                    originating_depository_financial_institution_id: "091000019"
                    originating_depository_financial_institution_id_qualifier: national_clearing_system_number
                    originating_depository_financial_institution_name: WELLS FARGO BANK
                    originator_city: BERLIN
                    originator_company_entry_description: RETRY PYMT
                    originator_country: DE
                    originator_identification: 770510487A
                    originator_name: BERGHAIN
                    originator_postal_code: "50825"
                    originator_state_or_province: null
                    originator_street_address: Ruedersdorferstr. 7
                    payment_related_information: null
                    payment_related_information2: null
                    receiver_city: BEVERLY HILLS
                    receiver_country: US
                    receiver_identification_number: "1018790279274"
                    receiver_postal_code: "90210"
                    receiver_state_or_province: CA
                    receiver_street_address: 123 FAKE ST
                    receiving_company_or_individual_name: IAN CREASE
                    receiving_depository_financial_institution_country: US
                    receiving_depository_financial_institution_id: "101050001"
                    receiving_depository_financial_institution_id_qualifier: national_clearing_system_number
                    receiving_depository_financial_institution_name: BLUE RIDGE BANK, NATIONAL ASSOCIATI
                    trace_number: "010202909100090"
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                      type: integer
                    destination_country_code:
                      description: ""
                      type: string
                    destination_currency_code:
                      description: ""
                      type: string
                    foreign_exchange_indicator:
                      description: ""
                      type: string
                    foreign_exchange_reference:
                      description: ""
                      nullable: true
                      type: string
                    foreign_exchange_reference_indicator:
                      description: ""
                      type: string
                    foreign_payment_amount:
                      description: ""
                      type: integer
                    foreign_trace_number:
                      description: ""
                      nullable: true
                      type: string
                    international_transaction_type_code:
                      description: ""
                      type: string
                    originating_currency_code:
                      description: ""
                      type: string
                    originating_depository_financial_institution_branch_country:
                      description: ""
                      type: string
                    originating_depository_financial_institution_id:
                      description: ""
                      type: string
                    originating_depository_financial_institution_id_qualifier:
                      description: ""
                      type: string
                    originating_depository_financial_institution_name:
                      description: ""
                      type: string
                    originator_city:
                      description: ""
                      type: string
                    originator_company_entry_description:
                      description: ""
                      type: string
                    originator_country:
                      description: ""
                      type: string
                    originator_identification:
                      description: ""
                      type: string
                    originator_name:
                      description: ""
                      type: string
                    originator_postal_code:
                      description: ""
                      nullable: true
                      type: string
                    originator_state_or_province:
                      description: ""
                      nullable: true
                      type: string
                    originator_street_address:
                      description: ""
                      type: string
                    payment_related_information:
                      description: ""
                      nullable: true
                      type: string
                    payment_related_information2:
                      description: ""
                      nullable: true
                      type: string
                    receiver_city:
                      description: ""
                      type: string
                    receiver_country:
                      description: ""
                      type: string
                    receiver_identification_number:
                      description: ""
                      nullable: true
                      type: string
                    receiver_postal_code:
                      description: ""
                      nullable: true
                      type: string
                    receiver_state_or_province:
                      description: ""
                      nullable: true
                      type: string
                    receiver_street_address:
                      description: ""
                      type: string
                    receiving_company_or_individual_name:
                      description: ""
                      type: string
                    receiving_depository_financial_institution_country:
                      description: ""
                      type: string
                    receiving_depository_financial_institution_id:
                      description: ""
                      type: string
                    receiving_depository_financial_institution_id_qualifier:
                      description: ""
                      type: string
                    receiving_depository_financial_institution_name:
                      description: ""
                      type: string
                    trace_number:
                      description: ""
                      type: string
                  required:
                    - amount
                    - foreign_exchange_indicator
                    - foreign_exchange_reference_indicator
                    - foreign_exchange_reference
                    - destination_country_code
                    - destination_currency_code
                    - foreign_payment_amount
                    - foreign_trace_number
                    - international_transaction_type_code
                    - originating_currency_code
                    - originating_depository_financial_institution_name
                    - originating_depository_financial_institution_id_qualifier
                    - originating_depository_financial_institution_id
                    - originating_depository_financial_institution_branch_country
                    - originator_city
                    - originator_company_entry_description
                    - originator_country
                    - originator_identification
                    - originator_name
                    - originator_postal_code
                    - originator_street_address
                    - originator_state_or_province
                    - payment_related_information
                    - payment_related_information2
                    - receiver_identification_number
                    - receiver_street_address
                    - receiver_city
                    - receiver_state_or_province
                    - receiver_country
                    - receiver_postal_code
                    - receiving_company_or_individual_name
                    - receiving_depository_financial_institution_name
                    - receiving_depository_financial_institution_id_qualifier
                    - receiving_depository_financial_institution_id
                    - receiving_depository_financial_institution_country
                    - trace_number
                  title: Inbound International ACH Transfer
                  type: object
                  x-title-plural: Inbound International ACH Transfers
                inbound_real_time_payments_transfer_confirmation:
                  description: A Inbound Real Time Payments Transfer Confirmation object. This field will be present in the JSON response if and only if `category` is equal to `inbound_real_time_payments_transfer_confirmation`.
                  example:
                    amount: 100
                    creditor_name: Ian Crease
                    currency: USD
                    debtor_account_number: "987654321"
                    debtor_name: National Phonograph Company
                    debtor_routing_number: "101050001"
                    remittance_information: Invoice 29582
                    transaction_identification: 20220501234567891T1BSLZO01745013025
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transfer's currency. For dollars, for example, this is cents.
                      type: integer
                    creditor_name:
                      description: The name the sender of the transfer specified as the recipient of the transfer.
                      type: string
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's currency. This will always be "USD" for a Real Time Payments transfer.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    debtor_account_number:
                      description: The account number of the account that sent the transfer.
                      type: string
                    debtor_name:
                      description: The name provided by the sender of the transfer.
                      type: string
                    debtor_routing_number:
                      description: The routing number of the account that sent the transfer.
                      type: string
                    remittance_information:
                      description: Additional information included with the transfer.
                      nullable: true
                      type: string
                    transaction_identification:
                      description: The Real Time Payments network identification of the transfer
                      type: string
                  required:
                    - amount
                    - currency
                    - creditor_name
                    - debtor_name
                    - debtor_account_number
                    - debtor_routing_number
                    - transaction_identification
                    - remittance_information
                  title: Inbound Real Time Payments Transfer Confirmation
                  type: object
                  x-title-plural: Inbound Real Time Payments Transfer Confirmations
                inbound_wire_drawdown_payment:
                  description: A Inbound Wire Drawdown Payment object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
                  example:
                    amount: 100
                    beneficiary_address_line1: null
                    beneficiary_address_line2: null
                    beneficiary_address_line3: null
                    beneficiary_name: null
                    beneficiary_reference: null
                    description: Inbound wire drawdown payment
                    input_message_accountability_data: null
                    originator_address_line1: null
                    originator_address_line2: null
                    originator_address_line3: null
                    originator_name: null
                    originator_to_beneficiary_information: null
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    beneficiary_address_line1:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_address_line2:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_address_line3:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_name:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_reference:
                      description: ""
                      nullable: true
                      type: string
                    description:
                      description: ""
                      type: string
                    input_message_accountability_data:
                      description: ""
                      nullable: true
                      type: string
                    originator_address_line1:
                      description: ""
                      nullable: true
                      type: string
                    originator_address_line2:
                      description: ""
                      nullable: true
                      type: string
                    originator_address_line3:
                      description: ""
                      nullable: true
                      type: string
                    originator_name:
                      description: ""
                      nullable: true
                      type: string
                    originator_to_beneficiary_information:
                      description: ""
                      nullable: true
                      type: string
                  required:
                    - amount
                    - beneficiary_address_line1
                    - beneficiary_address_line2
                    - beneficiary_address_line3
                    - beneficiary_name
                    - beneficiary_reference
                    - description
                    - input_message_accountability_data
                    - originator_address_line1
                    - originator_address_line2
                    - originator_address_line3
                    - originator_name
                    - originator_to_beneficiary_information
                  title: Inbound Wire Drawdown Payment
                  type: object
                  x-title-plural: Inbound Wire Drawdown Payments
                inbound_wire_drawdown_payment_reversal:
                  description: A Inbound Wire Drawdown Payment Reversal object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_drawdown_payment_reversal`.
                  example:
                    amount: 12345
                    description: Inbound wire reversal 2022021100335128
                    input_cycle_date: 2022-02-11
                    input_message_accountability_data: 20220211B6B7HU2R011023
                    input_sequence_number: "11023"
                    input_source: B6B7HU2R
                    previous_message_input_cycle_date: 2022-02-10
                    previous_message_input_message_accountability_data: 20220210MMQFMP0P000007
                    previous_message_input_sequence_number: "3"
                    previous_message_input_source: MMQFMP0P
                  nullable: true
                  properties:
                    amount:
                      description: The amount that was reversed.
                      type: integer
                    description:
                      description: The description on the reversal message from Fedwire.
                      type: string
                    input_cycle_date:
                      description: The Fedwire cycle date for the wire reversal.
                      format: date
                      type: string
                    input_message_accountability_data:
                      description: The Fedwire transaction identifier.
                      type: string
                    input_sequence_number:
                      description: The Fedwire sequence number.
                      type: string
                    input_source:
                      description: The Fedwire input source identifier.
                      type: string
                    previous_message_input_cycle_date:
                      description: The Fedwire cycle date for the wire transfer that was reversed.
                      format: date
                      type: string
                    previous_message_input_message_accountability_data:
                      description: The Fedwire transaction identifier for the wire transfer that was reversed.
                      type: string
                    previous_message_input_sequence_number:
                      description: The Fedwire sequence number for the wire transfer that was reversed.
                      type: string
                    previous_message_input_source:
                      description: The Fedwire input source identifier for the wire transfer that was reversed.
                      type: string
                  required:
                    - amount
                    - description
                    - input_cycle_date
                    - input_sequence_number
                    - input_source
                    - input_message_accountability_data
                    - previous_message_input_message_accountability_data
                    - previous_message_input_cycle_date
                    - previous_message_input_sequence_number
                    - previous_message_input_source
                  title: Inbound Wire Drawdown Payment Reversal
                  type: object
                  x-title-plural: Inbound Wire Drawdown Payment Reversals
                inbound_wire_reversal:
                  description: A Inbound Wire Reversal object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_reversal`.
                  example:
                    amount: 12345
                    created_at: 2020-01-31T23:59:59Z
                    description: Inbound wire reversal 2022021100335128
                    financial_institution_to_financial_institution_information: null
                    input_cycle_date: 2022-02-11
                    input_message_accountability_data: 20220211B6B7HU2R011023
                    input_sequence_number: "11023"
                    input_source: B6B7HU2R
                    previous_message_input_cycle_date: 2022-02-10
                    previous_message_input_message_accountability_data: 20220210MMQFMP0P000007
                    previous_message_input_sequence_number: "3"
                    previous_message_input_source: MMQFMP0P
                    receiver_financial_institution_information: null
                    transaction_id: transaction_uyrp7fld2ium70oa7oi
                  nullable: true
                  properties:
                    amount:
                      description: The amount that was reversed.
                      type: integer
                    created_at:
                      description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the reversal was created.
                      format: date-time
                      type: string
                    description:
                      description: The description on the reversal message from Fedwire.
                      type: string
                    financial_institution_to_financial_institution_information:
                      description: Additional financial institution information included in the wire reversal.
                      nullable: true
                      type: string
                    input_cycle_date:
                      description: The Fedwire cycle date for the wire reversal.
                      format: date
                      type: string
                    input_message_accountability_data:
                      description: The Fedwire transaction identifier.
                      type: string
                    input_sequence_number:
                      description: The Fedwire sequence number.
                      type: string
                    input_source:
                      description: The Fedwire input source identifier.
                      type: string
                    previous_message_input_cycle_date:
                      description: The Fedwire cycle date for the wire transfer that was reversed.
                      format: date
                      type: string
                    previous_message_input_message_accountability_data:
                      description: The Fedwire transaction identifier for the wire transfer that was reversed.
                      type: string
                    previous_message_input_sequence_number:
                      description: The Fedwire sequence number for the wire transfer that was reversed.
                      type: string
                    previous_message_input_source:
                      description: The Fedwire input source identifier for the wire transfer that was reversed.
                      type: string
                    receiver_financial_institution_information:
                      description: Information included in the wire reversal for the receiving financial institution.
                      nullable: true
                      type: string
                    transaction_id:
                      description: The ID for the Transaction associated with the transfer reversal.
                      nullable: true
                      type: string
                  required:
                    - amount
                    - created_at
                    - description
                    - input_cycle_date
                    - input_sequence_number
                    - input_source
                    - input_message_accountability_data
                    - previous_message_input_message_accountability_data
                    - previous_message_input_cycle_date
                    - previous_message_input_sequence_number
                    - previous_message_input_source
                    - receiver_financial_institution_information
                    - financial_institution_to_financial_institution_information
                    - transaction_id
                  title: Inbound Wire Reversal
                  type: object
                  x-title-plural: Inbound Wire Reversals
                inbound_wire_transfer:
                  description: A Inbound Wire Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_transfer`.
                  example:
                    amount: 100
                    beneficiary_address_line1: null
                    beneficiary_address_line2: null
                    beneficiary_address_line3: null
                    beneficiary_name: null
                    beneficiary_reference: null
                    description: Inbound wire transfer
                    input_message_accountability_data: null
                    originator_address_line1: null
                    originator_address_line2: null
                    originator_address_line3: null
                    originator_name: null
                    originator_to_beneficiary_information: null
                    originator_to_beneficiary_information_line1: null
                    originator_to_beneficiary_information_line2: null
                    originator_to_beneficiary_information_line3: null
                    originator_to_beneficiary_information_line4: null
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    beneficiary_address_line1:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_address_line2:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_address_line3:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_name:
                      description: ""
                      nullable: true
                      type: string
                    beneficiary_reference:
                      description: ""
                      nullable: true
                      type: string
                    description:
                      description: ""
                      type: string
                    input_message_accountability_data:
                      description: ""
                      nullable: true
                      type: string
                    originator_address_line1:
                      description: ""
                      nullable: true
                      type: string
                    originator_address_line2:
                      description: ""
                      nullable: true
                      type: string
                    originator_address_line3:
                      description: ""
                      nullable: true
                      type: string
                    originator_name:
                      description: ""
                      nullable: true
                      type: string
                    originator_to_beneficiary_information:
                      description: ""
                      nullable: true
                      type: string
                    originator_to_beneficiary_information_line1:
                      description: ""
                      nullable: true
                      type: string
                    originator_to_beneficiary_information_line2:
                      description: ""
                      nullable: true
                      type: string
                    originator_to_beneficiary_information_line3:
                      description: ""
                      nullable: true
                      type: string
                    originator_to_beneficiary_information_line4:
                      description: ""
                      nullable: true
                      type: string
                  required:
                    - amount
                    - beneficiary_address_line1
                    - beneficiary_address_line2
                    - beneficiary_address_line3
                    - beneficiary_name
                    - beneficiary_reference
                    - description
                    - input_message_accountability_data
                    - originator_address_line1
                    - originator_address_line2
                    - originator_address_line3
                    - originator_name
                    - originator_to_beneficiary_information_line1
                    - originator_to_beneficiary_information_line2
                    - originator_to_beneficiary_information_line3
                    - originator_to_beneficiary_information_line4
                    - originator_to_beneficiary_information
                  title: Inbound Wire Transfer
                  type: object
                  x-title-plural: Inbound Wire Transfers
                interest_payment:
                  description: A Interest Payment object. This field will be present in the JSON response if and only if `category` is equal to `interest_payment`.
                  example:
                    accrued_on_account_id: account_in71c4amph0vgo2qllky
                    amount: 100
                    currency: USD
                    period_end: 2023-04-30T23:59:59Z
                    period_start: 2023-04-01T00:00:00Z
                  nullable: true
                  properties:
                    accrued_on_account_id:
                      description: The account on which the interest was accrued.
                      nullable: true
                      type: string
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    period_end:
                      description: The end of the period for which this transaction paid interest.
                      format: date-time
                      type: string
                    period_start:
                      description: The start of the period for which this transaction paid interest.
                      format: date-time
                      type: string
                  required:
                    - amount
                    - currency
                    - period_start
                    - period_end
                    - accrued_on_account_id
                  title: Interest Payment
                  type: object
                  x-title-plural: Interest Payments
                internal_source:
                  description: A Internal Source object. This field will be present in the JSON response if and only if `category` is equal to `internal_source`.
                  example:
                    amount: 100
                    currency: USD
                    reason: sample_funds
                  nullable: true
                  properties:
                    amount:
                      description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                      type: integer
                    currency:
                      description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
                      enum:
                        - CAD
                        - CHF
                        - EUR
                        - GBP
                        - JPY
                        - USD
                      type: string
                      x-enum-descriptions:
                        - Canadian Dollar (CAD)
                        - Swiss Franc (CHF)
                        - Euro (EUR)
                        - British Pound (GBP)
                        - Japanese Yen (JPY)
                        - US Dollar (USD)
                    reason:
                      description: ""
                      enum:
                        - bank_migration
                        - cashback
                        - empyreal_adjustment
                        - error
                        - error_correction
                        - fees
                        - interest
                        - sample_funds
                        - sample_funds_return
                      type: string
                      x-enum-descriptions:
                        - Bank Migration
                        - Cashback
                        - Empyreal adjustment
                        - Error
                        - Error correction
                        - Fees
                        - Interest
                        - Sample funds
                        - Sample funds return
                  required:
                    - amount
                    - currency
                    - reason
                  title: Internal Source
                  type: object
                  x-title-plural: Internal Sources
                real_time_payments_transfer_acknowledgement:
                  description: A Real Time Payments Transfer Acknowledgement object. This field will be present in the JSON response if and only if `category` is equal to `real_time_payments_transfer_acknowledgement`.
                  example:
                    amount: 100
                    destination_account_number: "987654321"
                    destination_routing_number: "101050001"
                    remittance_information: Invoice 29582
                    transfer_id: real_time_payments_transfer_iyuhl5kdn7ssmup83mvq
                  nullable: true
                  properties:
                    amount:
                      description: The transfer amount in USD cents.
                      type: integer
                    destination_account_number:
                      description: The destination account number.
                      type: string
                    destination_routing_number:
                      description: The American Bankers' Association (ABA) Routing Transit Number (RTN).
                      type: string
                    remittance_information:
                      description: Unstructured information that will show on the recipient's bank statement.
                      type: string
                    transfer_id:
                      description: The identifier of the Real Time Payments Transfer that led to this Transaction.
                      type: string
                  required:
                    - amount
                    - destination_account_number
                    - destination_routing_number
                    - remittance_information
                    - transfer_id
                  title: Real Time Payments Transfer Acknowledgement
                  type: object
                  x-title-plural: Real Time Payments Transfer Acknowledgements
                sample_funds:
                  description: A Sample Funds object. This field will be present in the JSON response if and only if `category` is equal to `sample_funds`.
                  example:
                    originator: dashboard
                  nullable: true
                  properties:
                    originator:
                      description: Where the sample funds came from.
                      type: string
                  required:
                    - originator
                  title: Sample Funds
                  type: object
                  x-title-plural: Sample Fundss
                wire_drawdown_payment_intention:
                  description: A Wire Drawdown Payment Intention object. This field will be present in the JSON response if and only if `category` is equal to `wire_drawdown_payment_intention`.
                  example:
                    account_number: "987654321"
                    amount: 100
                    message_to_recipient: HELLO
                    routing_number: "101050001"
                    transfer_id: wire_transfer_5akynk7dqsq25qwk9q2u
                  nullable: true
                  properties:
                    account_number:
                      description: ""
                      type: string
                    amount:
                      description: The transfer amount in USD cents.
                      type: integer
                    message_to_recipient:
                      description: ""
                      type: string
                    routing_number:
                      description: ""
                      type: string
                    transfer_id:
                      description: ""
                      type: string
                  required:
                    - amount
                    - account_number
                    - routing_number
                    - message_to_recipient
                    - transfer_id
                  title: Wire Drawdown Payment Intention
                  type: object
                  x-title-plural: Wire Drawdown Payment Intentions
                wire_drawdown_payment_rejection:
                  description: A Wire Drawdown Payment Rejection object. This field will be present in the JSON response if and only if `category` is equal to `wire_drawdown_payment_rejection`.
                  example:
                    transfer_id: wire_transfer_5akynk7dqsq25qwk9q2u
                  nullable: true
                  properties:
                    transfer_id:
                      description: ""
                      type: string
                  required:
                    - transfer_id
                  title: Wire Drawdown Payment Rejection
                  type: object
                  x-title-plural: Wire Drawdown Payment Rejections
                wire_transfer_intention:
                  description: A Wire Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_intention`.
                  example:
                    account_number: "987654321"
                    amount: 100
                    message_to_recipient: HELLO
                    routing_number: "101050001"
                    transfer_id: wire_transfer_5akynk7dqsq25qwk9q2u
                  nullable: true
                  properties:
                    account_number:
                      description: The destination account number.
                      type: string
                    amount:
                      description: The transfer amount in USD cents.
                      type: integer
                    message_to_recipient:
                      description: The message that will show on the recipient's bank statement.
                      type: string
                    routing_number:
                      description: The American Bankers' Association (ABA) Routing Transit Number (RTN).
                      type: string
                    transfer_id:
                      description: ""
                      type: string
                  required:
                    - amount
                    - account_number
                    - routing_number
                    - message_to_recipient
                    - transfer_id
                  title: Wire Transfer Intention
                  type: object
                  x-title-plural: Wire Transfer Intentions
                wire_transfer_rejection:
                  description: A Wire Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_rejection`.
                  example:
                    transfer_id: wire_transfer_5akynk7dqsq25qwk9q2u
                  nullable: true
                  properties:
                    transfer_id:
                      description: ""
                      type: string
                  required:
                    - transfer_id
                  title: Wire Transfer Rejection
                  type: object
                  x-title-plural: Wire Transfer Rejections
              required:
                - category
                - account_transfer_intention
                - ach_check_conversion_return
                - ach_check_conversion
                - ach_transfer_intention
                - ach_transfer_rejection
                - ach_transfer_return
                - card_dispute_acceptance
                - card_refund
                - card_settlement
                - card_revenue_payment
                - check_deposit_acceptance
                - check_deposit_return
                - check_transfer_intention
                - check_transfer_return
                - check_transfer_rejection
                - check_transfer_stop_payment_request
                - dispute_resolution
                - empyreal_cash_deposit
                - fee_payment
                - inbound_ach_transfer
                - inbound_check
                - inbound_international_ach_transfer
                - inbound_real_time_payments_transfer_confirmation
                - inbound_wire_drawdown_payment_reversal
                - inbound_wire_drawdown_payment
                - inbound_wire_reversal
                - inbound_wire_transfer
                - interest_payment
                - internal_source
                - card_route_refund
                - card_route_settlement
                - real_time_payments_transfer_acknowledgement
                - sample_funds
                - wire_drawdown_payment_intention
                - wire_drawdown_payment_rejection
                - wire_transfer_intention
                - wire_transfer_rejection
              title: Transaction Source
              type: object
              x-title-plural: Transaction Sources
            type:
              description: A constant representing the object's type. For this resource it will always be `transaction`.
              enum:
                - transaction
              type: string
          required:
            - account_id
            - amount
            - currency
            - created_at
            - description
            - id
            - route_id
            - route_type
            - source
            - type
          title: Transaction
          type: object
          x-title-plural: Transactions
        type:
          description: A constant representing the object's type. For this resource it will always be `interest_payment_simulation_result`.
          enum:
            - interest_payment_simulation_result
          type: string
      required:
        - transaction
        - type
      title: Interest Payment Simulation Result
      type: object
      x-title-plural: Interest Payment Simulation Results
    limit:
      description: You can set limits at the Account, Account Number, or Card level. Limits applied to Accounts will apply to all Account Numbers and Cards in the Account. You can specify any number of Limits and they will all be applied to inbound debits and card authorizations. Volume and count Limits are designed to prevent unauthorized debits.
      example:
        id: limit_fku42k0qtc8ulsuas38q
        interval: month
        metric: volume
        model_id: account_number_v18nkfqm6afpsrvy82b2
        model_type: account_number
        status: active
        type: limit
        value: 0
      properties:
        id:
          description: The Limit identifier.
          type: string
        interval:
          description: The interval for the metric. This is required if `metric` is `count` or `volume`.
          enum:
            - transaction
            - day
            - week
            - month
            - year
            - all_time
          nullable: true
          type: string
          x-enum-descriptions:
            - Enforce the Limit per-transaction.
            - Enforce the Limit based on the trailing 24 hour period.
            - Enforce the Limit based on the trailing seven days.
            - Enforce the Limit based on the trailing month, going back to the current day in the previous month, or as close as possible given month length differences.
            - Enforce the Limit based on the trailing 365 days.
            - Enforce the Limit for all time.
        metric:
          description: The metric for the Limit.
          enum:
            - count
            - volume
          type: string
          x-enum-descriptions:
            - The maximum number of debits allowed.
            - The maximum volume of debits allowed in the minor unit of the model's currency.
        model_id:
          description: The identifier of the Account Number, Account, or Card the Limit applies to.
          type: string
        model_type:
          description: The type of the model you wish to associate the Limit with.
          enum:
            - account
            - account_number
            - card
          type: string
          x-enum-descriptions:
            - Enforce the Limit for the entire account.
            - Enforce the Limit for this specific route.
            - Enforce the Limit for this specific card.
        status:
          description: The current status of the Limit.
          enum:
            - active
            - inactive
          type: string
          x-enum-descriptions:
            - The Limit is active.
            - The Limit is temporarily disabled.
        type:
          description: A constant representing the object's type. For this resource it will always be `limit`.
          enum:
            - limit
          type: string
        value:
          description: The value to evaluate the Limit against.
          type: integer
      required:
        - id
        - interval
        - metric
        - model_id
        - model_type
        - status
        - type
        - value
      title: Limit
      type: object
      x-tag: Limits
      x-title-plural: Limits
    limit_list:
      description: A list of Limit objects
      example:
        data:
          - id: limit_fku42k0qtc8ulsuas38q
            interval: month
            metric: volume
            model_id: account_number_v18nkfqm6afpsrvy82b2
            model_type: account_number
            status: active
            type: limit
            value: 0
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/limit"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: Limit List
      type: object
      x-title-plural: Limit Lists
    look_up_the_balance_for_an_account_parameters:
      example:
        account_id: account_in71c4amph0vgo2qllky
      properties:
        account_id:
          description: The Account to query the balance for.
          type: string
      required:
        - account_id
      type: object
    oauth_connection:
      description: When a user authorizes your OAuth application, an OAuth Connection object is created.
      example:
        created_at: 2020-01-31T23:59:59Z
        group_id: group_1g4mhziu6kvrs3vz35um
        id: connection_dauknoksyr4wilz4e6my
        status: active
        type: oauth_connection
      properties:
        created_at:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the OAuth Connection was created.
          format: date-time
          type: string
        group_id:
          description: The identifier of the Group that has authorized your OAuth application.
          type: string
        id:
          description: The OAuth Connection's identifier.
          type: string
        status:
          description: Whether the connection is active.
          enum:
            - active
            - inactive
          type: string
          x-enum-descriptions:
            - The OAuth connection is active.
            - The OAuth connection is permanently deactivated.
        type:
          description: A constant representing the object's type. For this resource it will always be `oauth_connection`.
          enum:
            - oauth_connection
          type: string
      required:
        - id
        - created_at
        - group_id
        - status
        - type
      title: OAuth Connection
      type: object
      x-tag: OAuth Connections
      x-title-plural: OAuth Connections
    oauth_connection_list:
      description: A list of OAuth Connection objects
      example:
        data:
          - created_at: 2020-01-31T23:59:59Z
            group_id: group_1g4mhziu6kvrs3vz35um
            id: connection_dauknoksyr4wilz4e6my
            status: active
            type: oauth_connection
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/oauth_connection"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: OAuth Connection List
      type: object
      x-title-plural: OAuth Connection Lists
    pending_transaction:
      description: Pending Transactions are potential future additions and removals of money from your bank account.
      example:
        account_id: account_in71c4amph0vgo2qllky
        amount: 100
        completed_at: null
        created_at: 2020-01-31T23:59:59Z
        currency: USD
        description: Frederick S. Holmes
        id: pending_transaction_k1sfetcau2qbvjbzgju4
        route_id: card_oubs0hwk5rn6knuecxg2
        route_type: card
        source:
          ach_transfer_instruction:
            amount: 100
            transfer_id: ach_transfer_uoxatyh3lt5evrsdvo7q
          category: ach_transfer_instruction
        status: pending
        type: pending_transaction
      properties:
        account_id:
          description: The identifier for the account this Pending Transaction belongs to.
          type: string
        amount:
          description: The Pending Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.
          type: integer
        completed_at:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending Transaction was completed.
          format: date-time
          nullable: true
          type: string
        created_at:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending Transaction occured.
          format: date-time
          type: string
        currency:
          description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Pending Transaction's currency. This will match the currency on the Pending Transcation's Account.
          enum:
            - CAD
            - CHF
            - EUR
            - GBP
            - JPY
            - USD
          type: string
          x-enum-descriptions:
            - Canadian Dollar (CAD)
            - Swiss Franc (CHF)
            - Euro (EUR)
            - British Pound (GBP)
            - Japanese Yen (JPY)
            - US Dollar (USD)
        description:
          description: For a Pending Transaction related to a transfer, this is the description you provide. For a Pending Transaction related to a payment, this is the description the vendor provides.
          type: string
        id:
          description: The Pending Transaction identifier.
          type: string
        route_id:
          description: The identifier for the route this Pending Transaction came through. Routes are things like cards and ACH details.
          nullable: true
          type: string
        route_type:
          description: The type of the route this Pending Transaction came through.
          enum:
            - account_number
            - card
          nullable: true
          type: string
          x-enum-descriptions:
            - An Account Number.
            - A Card.
        source:
          description: This is an object giving more details on the network-level event that caused the Pending Transaction. For example, for a card transaction this lists the merchant's industry and location.
          example:
            ach_transfer_instruction:
              amount: 100
              transfer_id: ach_transfer_uoxatyh3lt5evrsdvo7q
            category: ach_transfer_instruction
          properties:
            account_transfer_instruction:
              description: A Account Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `account_transfer_instruction`.
              example:
                amount: 100
                currency: USD
                transfer_id: account_transfer_7k9qe1ysdgqztnt63l7n
              nullable: true
              properties:
                amount:
                  description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                  type: integer
                currency:
                  description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.
                  enum:
                    - CAD
                    - CHF
                    - EUR
                    - GBP
                    - JPY
                    - USD
                  type: string
                  x-enum-descriptions:
                    - Canadian Dollar (CAD)
                    - Swiss Franc (CHF)
                    - Euro (EUR)
                    - British Pound (GBP)
                    - Japanese Yen (JPY)
                    - US Dollar (USD)
                transfer_id:
                  description: The identifier of the Account Transfer that led to this Pending Transaction.
                  type: string
              required:
                - amount
                - currency
                - transfer_id
              title: Account Transfer Instruction
              type: object
              x-title-plural: Account Transfer Instructions
            ach_transfer_instruction:
              description: A ACH Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_instruction`.
              example:
                amount: 100
                transfer_id: ach_transfer_uoxatyh3lt5evrsdvo7q
              nullable: true
              properties:
                amount:
                  description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                  type: integer
                transfer_id:
                  description: The identifier of the ACH Transfer that led to this Pending Transaction.
                  type: string
              required:
                - amount
                - transfer_id
              title: ACH Transfer Instruction
              type: object
              x-title-plural: ACH Transfer Instructions
            card_authorization:
              description: A Card Authorization object. This field will be present in the JSON response if and only if `category` is equal to `card_authorization`.
              example:
                amount: 100
                currency: USD
                digital_wallet_token_id: null
                id: card_authorization_6iqxap6ivd0fo5eu3i8x
                merchant_acceptor_id: "5665270011000168"
                merchant_category_code: "5734"
                merchant_city: New York
                merchant_country: US
                merchant_descriptor: AMAZON.COM
                network: visa
                network_details:
                  visa:
                    electronic_commerce_indicator: secure_electronic_commerce
                    point_of_service_entry_mode: manual
                real_time_decision_id: null
                type: card_authorization
              nullable: true
              properties:
                amount:
                  description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                  type: integer
                currency:
                  description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                  enum:
                    - CAD
                    - CHF
                    - EUR
                    - GBP
                    - JPY
                    - USD
                  type: string
                  x-enum-descriptions:
                    - Canadian Dollar (CAD)
                    - Swiss Franc (CHF)
                    - Euro (EUR)
                    - British Pound (GBP)
                    - Japanese Yen (JPY)
                    - US Dollar (USD)
                digital_wallet_token_id:
                  description: If the authorization was made via a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used.
                  nullable: true
                  type: string
                id:
                  description: The Card Authorization identifier.
                  type: string
                merchant_acceptor_id:
                  description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.
                  type: string
                merchant_category_code:
                  description: The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.
                  nullable: true
                  type: string
                merchant_city:
                  description: The city the merchant resides in.
                  nullable: true
                  type: string
                merchant_country:
                  description: The country the merchant resides in.
                  nullable: true
                  type: string
                merchant_descriptor:
                  description: The merchant descriptor of the merchant the card is transacting with.
                  type: string
                network:
                  description: The payment network used to process this card authorization
                  enum:
                    - visa
                  type: string
                  x-enum-descriptions:
                    - Visa
                network_details:
                  description: Fields specific to the `network`
                  properties:
                    visa:
                      description: Fields specific to the `visa` network
                      properties:
                        electronic_commerce_indicator:
                          description: For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order.
                          enum:
                            - mail_phone_order
                            - recurring
                            - installment
                            - unknown_mail_phone_order
                            - secure_electronic_commerce
                            - non_authenticated_security_transaction_at_3ds_capable_merchant
                            - non_authenticated_security_transaction
                            - non_secure_transaction
                          nullable: true
                          type: string
                          x-enum-descriptions:
                            - "Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments."
                            - "Recurring transaction: Payment indicator used to indicate a recurring transaction that originates from an acquirer in the US region."
                            - "Installment payment: Payment indicator used to indicate one purchase of goods or services that is billed to the account in multiple charges over a period of time agreed upon by the cardholder and merchant from transactions that originate from an acquirer in the US region."
                            - "Unknown classification: other mail order: Use to indicate that the type of mail/telephone order is unknown."
                            - "Secure electronic commerce transaction: Use to indicate that the electronic commerce transaction has been authenticated using e.g., 3-D Secure"
                            - "Non-authenticated security transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure: Use to identify an electronic commerce transaction where the merchant attempted to authenticate the cardholder using 3-D Secure, but was unable to complete the authentication because the issuer or cardholder does not participate in the 3-D Secure program."
                            - "Non-authenticated security transaction: Use to identify an electronic commerce transaction that uses data encryption for security however , cardholder authentication is not performed using 3-D Secure."
                            - "Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection."
                        point_of_service_entry_mode:
                          description: The method used to enter the cardholder's primary account number and card expiration date
                          enum:
                            - manual
                            - magnetic_stripe_no_cvv
                            - optical_code
                            - integrated_circuit_card
                            - contactless
                            - credential_on_file
                            - magnetic_stripe
                            - contactless_magnetic_stripe
                            - integrated_circuit_card_no_cvv
                          nullable: true
                          type: string
                          x-enum-descriptions:
                            - Manual key entry
                            - Magnetic stripe read, without card verification value
                            - Optical code
                            - Contact chip card
                            - Contactless read of chip card
                            - Transaction iniated using a credential that has previously been stored on file
                            - Magnetic stripe read
                            - Contactless read of magnetic stripe data
                            - Contact chip card, without card verification value
                      required:
                        - electronic_commerce_indicator
                        - point_of_service_entry_mode
                      title: Visa
                      type: object
                      x-title-plural: Visas
                  required:
                    - visa
                  title: Network Details
                  type: object
                  x-title-plural: Network Detailss
                real_time_decision_id:
                  description: The identifier of the Real-Time Decision sent to approve or decline this transaction.
                  nullable: true
                  type: string
                type:
                  description: A constant representing the object's type. For this resource it will always be `card_authorization`.
                  enum:
                    - card_authorization
                  type: string
              required:
                - id
                - merchant_acceptor_id
                - merchant_descriptor
                - merchant_category_code
                - merchant_city
                - merchant_country
                - network
                - network_details
                - amount
                - currency
                - real_time_decision_id
                - digital_wallet_token_id
                - type
              title: Card Authorization
              type: object
              x-title-plural: Card Authorizations
            card_route_authorization:
              description: A Deprecated Card Authorization object. This field will be present in the JSON response if and only if `category` is equal to `card_route_authorization`.
              example:
                amount: 100
                currency: USD
                merchant_acceptor_id: "6631945550173363"
                merchant_category_code: "5734"
                merchant_city: New York
                merchant_country: US
                merchant_descriptor: THUMP COFFEE
                merchant_state: NY
              nullable: true
              properties:
                amount:
                  description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                  type: integer
                currency:
                  description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                  enum:
                    - CAD
                    - CHF
                    - EUR
                    - GBP
                    - JPY
                    - USD
                  type: string
                  x-enum-descriptions:
                    - Canadian Dollar (CAD)
                    - Swiss Franc (CHF)
                    - Euro (EUR)
                    - British Pound (GBP)
                    - Japanese Yen (JPY)
                    - US Dollar (USD)
                merchant_acceptor_id:
                  description: ""
                  type: string
                merchant_category_code:
                  description: ""
                  type: string
                merchant_city:
                  description: ""
                  nullable: true
                  type: string
                merchant_country:
                  description: ""
                  type: string
                merchant_descriptor:
                  description: ""
                  type: string
                merchant_state:
                  description: ""
                  nullable: true
                  type: string
              required:
                - amount
                - currency
                - merchant_acceptor_id
                - merchant_city
                - merchant_country
                - merchant_descriptor
                - merchant_category_code
                - merchant_state
              title: Deprecated Card Authorization
              type: object
              x-title-plural: Deprecated Card Authorizations
            category:
              description: The type of transaction that took place. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
              enum:
                - account_transfer_instruction
                - ach_transfer_instruction
                - card_authorization
                - check_deposit_instruction
                - check_transfer_instruction
                - inbound_funds_hold
                - card_route_authorization
                - real_time_payments_transfer_instruction
                - wire_drawdown_payment_instruction
                - wire_transfer_instruction
                - other
              type: string
              x-enum-descriptions:
                - The Pending Transaction was created by a Account Transfer Instruction object. Details will be under the `account_transfer_instruction` object.
                - The Pending Transaction was created by a ACH Transfer Instruction object. Details will be under the `ach_transfer_instruction` object.
                - The Pending Transaction was created by a Card Authorization object. Details will be under the `card_authorization` object.
                - The Pending Transaction was created by a Check Deposit Instruction object. Details will be under the `check_deposit_instruction` object.
                - The Pending Transaction was created by a Check Transfer Instruction object. Details will be under the `check_transfer_instruction` object.
                - The Pending Transaction was created by a Inbound Funds Hold object. Details will be under the `inbound_funds_hold` object.
                - The Pending Transaction was created by a Deprecated Card Authorization object. Details will be under the `card_route_authorization` object.
                - The Pending Transaction was created by a Real Time Payments Transfer Instruction object. Details will be under the `real_time_payments_transfer_instruction` object.
                - The Pending Transaction was created by a Wire Drawdown Payment Instruction object. Details will be under the `wire_drawdown_payment_instruction` object.
                - The Pending Transaction was created by a Wire Transfer Instruction object. Details will be under the `wire_transfer_instruction` object.
                - The Pending Transaction was made for an undocumented or deprecated reason.
            check_deposit_instruction:
              description: A Check Deposit Instruction object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_instruction`.
              example:
                amount: 100
                back_image_file_id: file_26khfk98mzfz90a11oqx
                check_deposit_id: check_deposit_f06n9gpg7sxn8t19lfc1
                currency: USD
                front_image_file_id: file_makxrc67oh9l6sg7w9yc
              nullable: true
              properties:
                amount:
                  description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                  type: integer
                back_image_file_id:
                  description: The identifier of the File containing the image of the back of the check that was deposited.
                  nullable: true
                  type: string
                check_deposit_id:
                  description: The identifier of the Check Deposit.
                  nullable: true
                  type: string
                currency:
                  description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                  enum:
                    - CAD
                    - CHF
                    - EUR
                    - GBP
                    - JPY
                    - USD
                  type: string
                  x-enum-descriptions:
                    - Canadian Dollar (CAD)
                    - Swiss Franc (CHF)
                    - Euro (EUR)
                    - British Pound (GBP)
                    - Japanese Yen (JPY)
                    - US Dollar (USD)
                front_image_file_id:
                  description: The identifier of the File containing the image of the front of the check that was deposited.
                  type: string
              required:
                - amount
                - currency
                - front_image_file_id
                - back_image_file_id
                - check_deposit_id
              title: Check Deposit Instruction
              type: object
              x-title-plural: Check Deposit Instructions
            check_transfer_instruction:
              description: A Check Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_instruction`.
              example:
                amount: 100
                currency: USD
                transfer_id: check_transfer_30b43acfu9vw8fyc4f5
              nullable: true
              properties:
                amount:
                  description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                  type: integer
                currency:
                  description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency.
                  enum:
                    - CAD
                    - CHF
                    - EUR
                    - GBP
                    - JPY
                    - USD
                  type: string
                  x-enum-descriptions:
                    - Canadian Dollar (CAD)
                    - Swiss Franc (CHF)
                    - Euro (EUR)
                    - British Pound (GBP)
                    - Japanese Yen (JPY)
                    - US Dollar (USD)
                transfer_id:
                  description: The identifier of the Check Transfer that led to this Pending Transaction.
                  type: string
              required:
                - amount
                - currency
                - transfer_id
              title: Check Transfer Instruction
              type: object
              x-title-plural: Check Transfer Instructions
            inbound_funds_hold:
              description: A Inbound Funds Hold object. This field will be present in the JSON response if and only if `category` is equal to `inbound_funds_hold`.
              example:
                amount: 100
                automatically_releases_at: 2020-01-31T23:59:59Z
                created_at: 2020-01-31T23:59:59Z
                currency: USD
                held_transaction_id: transaction_uyrp7fld2ium70oa7oi
                pending_transaction_id: pending_transaction_k1sfetcau2qbvjbzgju4
                released_at: null
                status: held
              nullable: true
              properties:
                amount:
                  description: The held amount in the minor unit of the account's currency. For dollars, for example, this is cents.
                  type: integer
                automatically_releases_at:
                  description: When the hold will be released automatically. Certain conditions may cause it to be released before this time.
                  format: date-time
                  type: string
                created_at:
                  description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold was created.
                  format: date-time
                  type: string
                currency:
                  description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the hold's currency.
                  enum:
                    - CAD
                    - CHF
                    - EUR
                    - GBP
                    - JPY
                    - USD
                  type: string
                  x-enum-descriptions:
                    - Canadian Dollar (CAD)
                    - Swiss Franc (CHF)
                    - Euro (EUR)
                    - British Pound (GBP)
                    - Japanese Yen (JPY)
                    - US Dollar (USD)
                held_transaction_id:
                  description: The ID of the Transaction for which funds were held.
                  nullable: true
                  type: string
                pending_transaction_id:
                  description: The ID of the Pending Transaction representing the held funds.
                  nullable: true
                  type: string
                released_at:
                  description: When the hold was released (if it has been released).
                  format: date-time
                  nullable: true
                  type: string
                status:
                  description: The status of the hold.
                  enum:
                    - held
                    - complete
                  type: string
                  x-enum-descriptions:
                    - Funds are still being held.
                    - Funds have been released.
              required:
                - amount
                - created_at
                - currency
                - automatically_releases_at
                - released_at
                - status
                - held_transaction_id
                - pending_transaction_id
              title: Inbound Funds Hold
              type: object
              x-title-plural: Inbound Funds Holds
            real_time_payments_transfer_instruction:
              description: A Real Time Payments Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `real_time_payments_transfer_instruction`.
              example:
                amount: 100
                transfer_id: real_time_payments_transfer_iyuhl5kdn7ssmup83mvq
              nullable: true
              properties:
                amount:
                  description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                  type: integer
                transfer_id:
                  description: The identifier of the Real Time Payments Transfer that led to this Pending Transaction.
                  type: string
              required:
                - amount
                - transfer_id
              title: Real Time Payments Transfer Instruction
              type: object
              x-title-plural: Real Time Payments Transfer Instructions
            wire_drawdown_payment_instruction:
              description: A Wire Drawdown Payment Instruction object. This field will be present in the JSON response if and only if `category` is equal to `wire_drawdown_payment_instruction`.
              example:
                account_number: "987654321"
                amount: 100
                message_to_recipient: HELLO
                routing_number: "101050001"
              nullable: true
              properties:
                account_number:
                  description: ""
                  type: string
                amount:
                  description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                  type: integer
                message_to_recipient:
                  description: ""
                  type: string
                routing_number:
                  description: ""
                  type: string
              required:
                - amount
                - account_number
                - routing_number
                - message_to_recipient
              title: Wire Drawdown Payment Instruction
              type: object
              x-title-plural: Wire Drawdown Payment Instructions
            wire_transfer_instruction:
              description: A Wire Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_instruction`.
              example:
                account_number: "987654321"
                amount: 100
                message_to_recipient: HELLO
                routing_number: "101050001"
                transfer_id: wire_transfer_5akynk7dqsq25qwk9q2u
              nullable: true
              properties:
                account_number:
                  description: ""
                  type: string
                amount:
                  description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                  type: integer
                message_to_recipient:
                  description: ""
                  type: string
                routing_number:
                  description: ""
                  type: string
                transfer_id:
                  description: ""
                  type: string
              required:
                - amount
                - account_number
                - routing_number
                - message_to_recipient
                - transfer_id
              title: Wire Transfer Instruction
              type: object
              x-title-plural: Wire Transfer Instructions
          required:
            - category
            - account_transfer_instruction
            - ach_transfer_instruction
            - card_authorization
            - check_deposit_instruction
            - check_transfer_instruction
            - inbound_funds_hold
            - card_route_authorization
            - real_time_payments_transfer_instruction
            - wire_drawdown_payment_instruction
            - wire_transfer_instruction
          title: Pending Transaction Source
          type: object
          x-title-plural: Pending Transaction Sources
        status:
          description: Whether the Pending Transaction has been confirmed and has an associated Transaction.
          enum:
            - pending
            - complete
          type: string
          x-enum-descriptions:
            - The Pending Transaction is still awaiting confirmation.
            - The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc.
        type:
          description: A constant representing the object's type. For this resource it will always be `pending_transaction`.
          enum:
            - pending_transaction
          type: string
      required:
        - account_id
        - amount
        - currency
        - completed_at
        - created_at
        - description
        - id
        - route_id
        - route_type
        - source
        - status
        - type
      title: Pending Transaction
      type: object
      x-tag: Pending Transactions
      x-title-plural: Pending Transactions
    pending_transaction_list:
      description: A list of Pending Transaction objects
      example:
        data:
          - account_id: account_in71c4amph0vgo2qllky
            amount: 100
            completed_at: null
            created_at: 2020-01-31T23:59:59Z
            currency: USD
            description: Frederick S. Holmes
            id: pending_transaction_k1sfetcau2qbvjbzgju4
            route_id: card_oubs0hwk5rn6knuecxg2
            route_type: card
            source:
              ach_transfer_instruction:
                amount: 100
                transfer_id: ach_transfer_uoxatyh3lt5evrsdvo7q
              category: ach_transfer_instruction
            status: pending
            type: pending_transaction
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/pending_transaction"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: Pending Transaction List
      type: object
      x-title-plural: Pending Transaction Lists
    program:
      description: Programs determine the compliance and commercial terms of Accounts. By default, you have a Commercial Banking program for managing your own funds. If you are lending or managing funds on behalf of your customers, or otherwise engaged in regulated activity, we will work together to create additional Programs for you.
      example:
        created_at: 2020-01-31T23:59:59Z
        id: program_i2v2os4mwza1oetokh9i
        name: Commercial Banking
        type: program
        updated_at: 2020-01-31T23:59:59Z
      properties:
        created_at:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Program was created.
          format: date-time
          type: string
        id:
          description: The Program identifier.
          type: string
        name:
          description: The name of the Program.
          type: string
        type:
          description: A constant representing the object's type. For this resource it will always be `program`.
          enum:
            - program
          type: string
        updated_at:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Program was last updated.
          format: date-time
          type: string
      required:
        - name
        - created_at
        - updated_at
        - id
        - type
      title: Program
      type: object
      x-tag: Programs
      x-title-plural: Programs
    program_list:
      description: A list of Program objects
      example:
        data:
          - created_at: 2020-01-31T23:59:59Z
            id: program_i2v2os4mwza1oetokh9i
            name: Commercial Banking
            type: program
            updated_at: 2020-01-31T23:59:59Z
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/program"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: Program List
      type: object
      x-title-plural: Program Lists
    real_time_decision:
      description: Real Time Decisions are created when your application needs to take action in real-time to some event such as a card authorization. Real time decisions are currently in beta; please contact support@increase.com if you're interested in trying them out!
      example:
        card_authorization:
          account_id: account_in71c4amph0vgo2qllky
          card_id: card_oubs0hwk5rn6knuecxg2
          decision: approve
          merchant_acceptor_id: "5665270011000168"
          merchant_category_code: "5734"
          merchant_city: New York
          merchant_country: US
          merchant_descriptor: AMAZON.COM
          network: visa
          network_details:
            visa:
              electronic_commerce_indicator: secure_electronic_commerce
              point_of_service_entry_mode: manual
          presentment_amount: 100
          presentment_currency: USD
          settlement_amount: 100
          settlement_currency: USD
        category: card_authorization_requested
        created_at: 2020-01-31T23:59:59Z
        digital_wallet_authentication: null
        digital_wallet_token: null
        id: real_time_decision_j76n2e810ezcg3zh5qtn
        status: pending
        timeout_at: 2020-01-31T23:59:59Z
        type: real_time_decision
      properties:
        card_authorization:
          description: Fields related to a card authorization.
          nullable: true
          properties:
            account_id:
              description: The identifier of the Account the authorization will debit.
              type: string
            card_id:
              description: The identifier of the Card that is being authorized.
              type: string
            decision:
              description: Whether or not the authorization was approved.
              enum:
                - approve
                - decline
              nullable: true
              type: string
              x-enum-descriptions:
                - Approve the authorization.
                - Decline the authorization.
            merchant_acceptor_id:
              description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.
              type: string
            merchant_category_code:
              description: The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.
              nullable: true
              type: string
            merchant_city:
              description: The city the merchant resides in.
              nullable: true
              type: string
            merchant_country:
              description: The country the merchant resides in.
              nullable: true
              type: string
            merchant_descriptor:
              description: The merchant descriptor of the merchant the card is transacting with.
              type: string
            network:
              description: The payment network used to process this card authorization
              enum:
                - visa
              type: string
              x-enum-descriptions:
                - Visa
            network_details:
              description: Fields specific to the `network`
              properties:
                visa:
                  description: Fields specific to the `visa` network
                  properties:
                    electronic_commerce_indicator:
                      description: For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order.
                      enum:
                        - mail_phone_order
                        - recurring
                        - installment
                        - unknown_mail_phone_order
                        - secure_electronic_commerce
                        - non_authenticated_security_transaction_at_3ds_capable_merchant
                        - non_authenticated_security_transaction
                        - non_secure_transaction
                      nullable: true
                      type: string
                      x-enum-descriptions:
                        - "Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments."
                        - "Recurring transaction: Payment indicator used to indicate a recurring transaction that originates from an acquirer in the US region."
                        - "Installment payment: Payment indicator used to indicate one purchase of goods or services that is billed to the account in multiple charges over a period of time agreed upon by the cardholder and merchant from transactions that originate from an acquirer in the US region."
                        - "Unknown classification: other mail order: Use to indicate that the type of mail/telephone order is unknown."
                        - "Secure electronic commerce transaction: Use to indicate that the electronic commerce transaction has been authenticated using e.g., 3-D Secure"
                        - "Non-authenticated security transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure: Use to identify an electronic commerce transaction where the merchant attempted to authenticate the cardholder using 3-D Secure, but was unable to complete the authentication because the issuer or cardholder does not participate in the 3-D Secure program."
                        - "Non-authenticated security transaction: Use to identify an electronic commerce transaction that uses data encryption for security however , cardholder authentication is not performed using 3-D Secure."
                        - "Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection."
                    point_of_service_entry_mode:
                      description: The method used to enter the cardholder's primary account number and card expiration date
                      enum:
                        - manual
                        - magnetic_stripe_no_cvv
                        - optical_code
                        - integrated_circuit_card
                        - contactless
                        - credential_on_file
                        - magnetic_stripe
                        - contactless_magnetic_stripe
                        - integrated_circuit_card_no_cvv
                      nullable: true
                      type: string
                      x-enum-descriptions:
                        - Manual key entry
                        - Magnetic stripe read, without card verification value
                        - Optical code
                        - Contact chip card
                        - Contactless read of chip card
                        - Transaction iniated using a credential that has previously been stored on file
                        - Magnetic stripe read
                        - Contactless read of magnetic stripe data
                        - Contact chip card, without card verification value
                  required:
                    - electronic_commerce_indicator
                    - point_of_service_entry_mode
                  title: Visa
                  type: object
                  x-title-plural: Visas
              required:
                - visa
              title: Network Details
              type: object
              x-title-plural: Network Detailss
            presentment_amount:
              description: The amount of the attempted authorization in the currency the card user sees at the time of purchase, in the minor unit of that currency. For dollars, for example, this is cents.
              type: integer
            presentment_currency:
              description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the currency the user sees at the time of purchase.
              type: string
            settlement_amount:
              description: The amount of the attempted authorization in the currency it will be settled in. This currency is the same as that of the Account the card belongs to.
              type: integer
            settlement_currency:
              description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the currency the transaction will be settled in.
              type: string
          required:
            - merchant_acceptor_id
            - merchant_descriptor
            - merchant_category_code
            - merchant_city
            - merchant_country
            - network
            - network_details
            - decision
            - card_id
            - account_id
            - presentment_amount
            - presentment_currency
            - settlement_amount
            - settlement_currency
          title: Card Authorization
          type: object
          x-title-plural: Card Authorizations
        category:
          description: The category of the Real-Time Decision.
          enum:
            - card_authorization_requested
            - digital_wallet_token_requested
            - digital_wallet_authentication_requested
          type: string
          x-enum-descriptions:
            - A card is being authorized.
            - A card is being loaded into a digital wallet.
            - A card is being loaded into a digital wallet and requires cardholder authentication.
        created_at:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Real-Time Decision was created.
          format: date-time
          type: string
        digital_wallet_authentication:
          description: Fields related to a digital wallet authentication attempt.
          nullable: true
          properties:
            card_id:
              description: The identifier of the Card that is being tokenized.
              type: string
            channel:
              description: The channel to send the card user their one-time passcode.
              enum:
                - sms
                - email
              type: string
              x-enum-descriptions:
                - Send one-time passcodes over SMS.
                - Send one-time passcodes over email.
            digital_wallet:
              description: The digital wallet app being used.
              enum:
                - apple_pay
                - google_pay
              type: string
              x-enum-descriptions:
                - Apple Pay
                - Google Pay
            email:
              description: The email to send the one-time passcode to if `channel` is equal to `email`.
              nullable: true
              type: string
            one_time_passcode:
              description: The one-time passcode to send the card user.
              type: string
            phone:
              description: The phone number to send the one-time passcode to if `channel` is equal to `sms`.
              nullable: true
              type: string
            result:
              description: Whether your application successfully delivered the one-time passcode.
              enum:
                - success
                - failure
              nullable: true
              type: string
              x-enum-descriptions:
                - Your application successfully delivered the one-time passcode to the cardholder.
                - Your application failed to deliver the one-time passcode to the cardholder.
          required:
            - result
            - card_id
            - digital_wallet
            - channel
            - one_time_passcode
            - phone
            - email
          title: Digital Wallet Authentication
          type: object
          x-title-plural: Digital Wallet Authentications
        digital_wallet_token:
          description: Fields related to a digital wallet token provisioning attempt.
          nullable: true
          properties:
            card_id:
              description: The identifier of the Card that is being tokenized.
              type: string
            card_profile_id:
              description: The identifier of the Card Profile that was set via the real time decision. This will be null until the real time decision is responded to or if the real time decision did not set a card profile.
              nullable: true
              type: string
            decision:
              description: Whether or not the provisioning request was approved. This will be null until the real time decision is responded to.
              enum:
                - approve
                - decline
              nullable: true
              type: string
              x-enum-descriptions:
                - Approve the provisioning request.
                - Decline the provisioning request.
            digital_wallet:
              description: The digital wallet app being used.
              enum:
                - apple_pay
                - google_pay
              type: string
              x-enum-descriptions:
                - Apple Pay
                - Google Pay
          required:
            - decision
            - card_id
            - digital_wallet
            - card_profile_id
          title: Digital Wallet Token
          type: object
          x-title-plural: Digital Wallet Tokens
        id:
          description: The Real-Time Decision identifier.
          type: string
        status:
          description: The status of the Real-Time Decision.
          enum:
            - pending
            - responded
            - timed_out
          type: string
          x-enum-descriptions:
            - The decision is pending action via real-time webhook.
            - Your webhook actioned the real-time decision.
            - Your webhook failed to respond to the authorization in time.
        timeout_at:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which your application can no longer respond to the Real-Time Decision.
          format: date-time
          type: string
        type:
          description: A constant representing the object's type. For this resource it will always be `real_time_decision`.
          enum:
            - real_time_decision
          type: string
      required:
        - id
        - created_at
        - timeout_at
        - status
        - category
        - card_authorization
        - digital_wallet_token
        - digital_wallet_authentication
        - type
      title: Real-Time Decision
      type: object
      x-tag: Real-Time Decisions
      x-title-plural: Real-Time Decisions
    real_time_payments_transfer:
      description: Real Time Payments transfers move funds, within seconds, between your Increase account and any other account on the Real Time Payments network.
      example:
        account_id: account_in71c4amph0vgo2qllky
        amount: 100
        approval: null
        cancellation: null
        created_at: 2020-01-31T23:59:59Z
        creditor_name: Ian Crease
        currency: USD
        destination_account_number: "987654321"
        destination_routing_number: "101050001"
        external_account_id: null
        id: real_time_payments_transfer_iyuhl5kdn7ssmup83mvq
        rejection: null
        remittance_information: Invoice 29582
        source_account_number_id: account_number_v18nkfqm6afpsrvy82b2
        status: complete
        submission:
          submitted_at: 2020-01-31T23:59:59Z
          transaction_identification: 20220501234567891T1BSLZO01745013025
        transaction_id: transaction_uyrp7fld2ium70oa7oi
        type: real_time_payments_transfer
      properties:
        account_id:
          description: The Account from which the transfer was sent.
          type: string
        amount:
          description: The transfer amount in USD cents.
          type: integer
        approval:
          description: If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
          example:
            approved_at: 2020-01-31T23:59:59Z
            approved_by: null
          nullable: true
          properties:
            approved_at:
              description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was approved.
              format: date-time
              type: string
            approved_by:
              description: If the Transfer was approved by a user in the dashboard, the email address of that user.
              nullable: true
              type: string
          required:
            - approved_at
            - approved_by
          title: Transfer Approval
          type: object
          x-title-plural: Transfer Approvals
        cancellation:
          description: If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
          example:
            canceled_at: 2020-01-31T23:59:59Z
            canceled_by: null
          nullable: true
          properties:
            canceled_at:
              description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Transfer was canceled.
              format: date-time
              type: string
            canceled_by:
              description: If the Transfer was canceled by a user in the dashboard, the email address of that user.
              nullable: true
              type: string
          required:
            - canceled_at
            - canceled_by
          title: Transfer Cancellation
          type: object
          x-title-plural: Transfer Cancellations
        created_at:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.
          format: date-time
          type: string
        creditor_name:
          description: The name of the transfer's recipient as provided by the sender.
          type: string
        currency:
          description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's currency. For real time payments transfers this is always equal to `USD`.
          enum:
            - CAD
            - CHF
            - EUR
            - GBP
            - JPY
            - USD
          type: string
          x-enum-descriptions:
            - Canadian Dollar (CAD)
            - Swiss Franc (CHF)
            - Euro (EUR)
            - British Pound (GBP)
            - Japanese Yen (JPY)
            - US Dollar (USD)
        destination_account_number:
          description: The destination account number.
          type: string
        destination_routing_number:
          description: The destination American Bankers' Association (ABA) Routing Transit Number (RTN).
          type: string
        external_account_id:
          description: The identifier of the External Account the transfer was made to, if any.
          nullable: true
          type: string
        id:
          description: The Real Time Payments Transfer's identifier.
          type: string
        rejection:
          description: If the transfer is rejected by Real Time Payments or the destination financial institution, this will contain supplemental details.
          example:
            reject_reason_additional_information: null
            reject_reason_code: account_closed
            rejected_at: 2020-01-31T23:59:59Z
          nullable: true
          properties:
            reject_reason_additional_information:
              description: Additional information about the rejection provided by the recipient bank when the `reject_reason_code` is `NARRATIVE`.
              nullable: true
              type: string
            reject_reason_code:
              description: The reason the transfer was rejected as provided by the recipient bank or the Real Time Payments network.
              enum:
                - account_closed
                - account_blocked
                - invalid_creditor_account_type
                - invalid_creditor_account_number
                - invalid_creditor_financial_institution_identifier
                - end_customer_deceased
                - narrative
                - transaction_forbidden
                - transaction_type_not_supported
                - unexpected_amount
                - amount_exceeds_bank_limits
                - invalid_creditor_address
                - unknown_end_customer
                - invalid_debtor_address
                - timeout
                - unsupported_message_for_recipient
                - recipient_connection_not_available
                - real_time_payments_suspended
                - instructed_agent_signed_off
                - processing_error
                - other
              type: string
              x-enum-descriptions:
                - The destination account is closed. Corresponds to the Real Time Payments reason code `AC04`.
                - The destination account is currently blocked from receiving transactions. Corresponds to the Real Time Payments reason code `AC06`.
                - The destination account is ineligible to receive Real Time Payments transfers. Corresponds to the Real Time Payments reason code `AC14`.
                - The destination account does not exist. Corresponds to the Real Time Payments reason code `AC03`.
                - The destination routing number is invalid. Corresponds to the Real Time Payments reason code `RC04`.
                - The destination account holder is deceased. Corresponds to the Real Time Payments reason code `MD07`.
                - The reason is provided as narrative information in the additional information field.
                - Real Time Payments transfers are not allowed to the destination account. Corresponds to the Real Time Payments reason code `AG01`.
                - Real Time Payments transfers are not enabled for the destination account. Corresponds to the Real Time Payments reason code `AG03`.
                - The amount of the transfer is different than expected by the recipient. Corresponds to the Real Time Payments reason code `AM09`.
                - The amount is higher than the recipient is authorized to send or receive. Corresponds to the Real Time Payments reason code `AM14`.
                - The creditor's address is required, but missing or invalid. Corresponds to the Real Time Payments reason code `BE04`.
                - The specified creditor is unknown. Corresponds to the Real Time Payments reason code `BE06`.
                - The debtor's address is required, but missing or invalid. Corresponds to the Real Time Payments reason code `BE07`.
                - There was a timeout processing the transfer. Corresponds to the Real Time Payments reason code `DS24`.
                - Real Time Payments transfers are not enabled for the destination account. Corresponds to the Real Time Payments reason code `NOAT`.
                - The destination financial institution is currently not connected to Real Time Payments. Corresponds to the Real Time Payments reason code `9912`.
                - Real Time Payments is currently unavailable. Corresponds to the Real Time Payments reason code `9948`.
                - The destination financial institution is currently signed off of Real Time Payments. Corresponds to the Real Time Payments reason code `9910`.
                - The transfer was rejected due to an internal Increase issue. We have been notified.
                - Some other error or issue has occurred.
            rejected_at:
              description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was rejected.
              format: date-time
              nullable: true
              type: string
          required:
            - rejected_at
            - reject_reason_code
            - reject_reason_additional_information
          title: Real Time Payments Transfer Rejection
          type: object
          x-title-plural: Real Time Payments Transfer Rejections
        remittance_information:
          description: Unstructured information that will show on the recipient's bank statement.
          type: string
        source_account_number_id:
          description: The Account Number the recipient will see as having sent the transfer.
          type: string
        status:
          description: The lifecycle status of the transfer.
          enum:
            - pending_approval
            - canceled
            - pending_submission
            - submitted
            - complete
            - rejected
            - requires_attention
          type: string
          x-enum-descriptions:
            - The transfer is pending approval.
            - The transfer has been canceled.
            - The transfer is queued to be submitted to Real Time Payments.
            - The transfer has been submitted and is pending a response from Real Time Payments.
            - The transfer has been sent successfully and is complete.
            - The transfer was rejected by the network or the recipient's bank.
            - The transfer requires attention by an operator.
        submission:
          description: After the transfer is submitted to Real Time Payments, this will contain supplemental details.
          example:
            submitted_at: 2020-01-31T23:59:59Z
            transaction_identification: 20220501234567891T1BSLZO01745013025
          nullable: true
          properties:
            submitted_at:
              description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was submitted to The Clearing House.
              format: date-time
              nullable: true
              type: string
            transaction_identification:
              description: The Real Time Payments network identification of the transfer.
              type: string
          required:
            - submitted_at
            - transaction_identification
          title: Real Time Payments Transfer Submission
          type: object
          x-title-plural: Real Time Payments Transfer Submissions
        transaction_id:
          description: The Transaction funding the transfer once it is complete.
          nullable: true
          type: string
        type:
          description: A constant representing the object's type. For this resource it will always be `real_time_payments_transfer`.
          enum:
            - real_time_payments_transfer
          type: string
      required:
        - type
        - id
        - approval
        - cancellation
        - status
        - created_at
        - account_id
        - external_account_id
        - source_account_number_id
        - creditor_name
        - remittance_information
        - amount
        - currency
        - destination_account_number
        - destination_routing_number
        - transaction_id
        - submission
        - rejection
      title: Real Time Payments Transfer
      type: object
      x-tag: Real Time Payments Transfers
      x-title-plural: Real Time Payments Transfers
    real_time_payments_transfer_list:
      description: A list of Real Time Payments Transfer objects
      example:
        data:
          - account_id: account_in71c4amph0vgo2qllky
            amount: 100
            approval: null
            cancellation: null
            created_at: 2020-01-31T23:59:59Z
            creditor_name: Ian Crease
            currency: USD
            destination_account_number: "987654321"
            destination_routing_number: "101050001"
            external_account_id: null
            id: real_time_payments_transfer_iyuhl5kdn7ssmup83mvq
            rejection: null
            remittance_information: Invoice 29582
            source_account_number_id: account_number_v18nkfqm6afpsrvy82b2
            status: complete
            submission:
              submitted_at: 2020-01-31T23:59:59Z
              transaction_identification: 20220501234567891T1BSLZO01745013025
            transaction_id: transaction_uyrp7fld2ium70oa7oi
            type: real_time_payments_transfer
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/real_time_payments_transfer"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: Real Time Payments Transfer List
      type: object
      x-title-plural: Real Time Payments Transfer Lists
    return_a_sandbox_ach_transfer_parameters:
      example: {}
      properties:
        reason:
          description: The reason why the Federal Reserve or destination bank returned this transfer. Defaults to `no_account`.
          enum:
            - insufficient_fund
            - no_account
            - account_closed
            - invalid_account_number_structure
            - account_frozen_entry_returned_per_ofac_instruction
            - credit_entry_refused_by_receiver
            - unauthorized_debit_to_consumer_account_using_corporate_sec_code
            - corporate_customer_advised_not_authorized
            - payment_stopped
            - non_transaction_account
            - uncollected_funds
            - routing_number_check_digit_error
            - customer_advised_unauthorized_improper_ineligible_or_incomplete
            - amount_field_error
            - authorization_revoked_by_customer
            - invalid_ach_routing_number
            - file_record_edit_criteria
            - enr_invalid_individual_name
            - returned_per_odfi_request
            - addenda_error
            - limited_participation_dfi
            - incorrectly_coded_outbound_international_payment
            - other
          type: string
          x-enum-descriptions:
            - Insufficient funds in the source account.
            - The account does not exist or the receiving bank was unable to locate it.
            - The account is closed.
            - The account number is invalid at the receiving bank.
            - The account was frozen per the Office of Foreign Assets Control.
            - The receiving bank account refused a credit transfer.
            - The receiving bank rejected because of an incorrect Standard Entry Class code.
            - The corporate customer reversed the transfer.
            - The receiving bank stopped payment on this transfer.
            - The receiving bank account does not perform transfers.
            - The receiving bank account does not have enough available balance for the transfer.
            - The routing number is incorrect.
            - The customer reversed the transfer.
            - The amount field is incorrect or too large.
            - The customer who initiated the transfer revoked authorization.
            - The routing number is invalid.
            - The receiving bank is unable to process a field in the transfer.
            - The individual name field was invalid.
            - The originating financial institution reversed the transfer.
            - The addenda record is incorrect or missing.
            - The receiving bank's regulatory supervisor has limited their participation.
            - The outbound international ACH transfer was incorrect.
            - Any other ACH return reason.
      type: object
    return_a_sandbox_check_transfer_parameters:
      example:
        reason: mail_delivery_failure
      properties:
        reason:
          description: The reason why the Check Transfer was returned to Increase.
          enum:
            - mail_delivery_failure
            - refused_by_recipient
          type: string
          x-enum-descriptions:
            - Mail delivery failed and the check was returned to sender.
            - The check arrived and the recipient refused to deposit it.
      required:
        - reason
      type: object
    routing_number:
      description: Routing numbers are used to identify your bank in a financial transaction.
      example:
        ach_transfers: supported
        name: Chase
        real_time_payments_transfers: supported
        routing_number: "021000021"
        type: routing_number
        wire_transfers: supported
      properties:
        ach_transfers:
          description: This routing number's support for ACH Transfers.
          enum:
            - supported
            - not_supported
          type: string
          x-enum-descriptions:
            - The routing number can receive this transfer type.
            - The routing number cannot receive this transfer type.
        name:
          description: The name of the financial institution belonging to a routing number.
          type: string
        real_time_payments_transfers:
          description: This routing number's support for Real Time Payments Transfers.
          enum:
            - supported
            - not_supported
          type: string
          x-enum-descriptions:
            - The routing number can receive this transfer type.
            - The routing number cannot receive this transfer type.
        routing_number:
          description: The nine digit routing number identifier.
          type: string
        type:
          description: A constant representing the object's type. For this resource it will always be `routing_number`.
          enum:
            - routing_number
          type: string
        wire_transfers:
          description: This routing number's support for Wire Transfers.
          enum:
            - supported
            - not_supported
          type: string
          x-enum-descriptions:
            - The routing number can receive this transfer type.
            - The routing number cannot receive this transfer type.
      required:
        - name
        - routing_number
        - type
        - ach_transfers
        - real_time_payments_transfers
        - wire_transfers
      title: Routing Number
      type: object
      x-tag: Routing Numbers
      x-title-plural: Routing Numbers
    routing_number_list:
      description: A list of Routing Number objects
      example:
        data:
          - ach_transfers: supported
            name: Chase
            real_time_payments_transfers: supported
            routing_number: "021000021"
            type: routing_number
            wire_transfers: supported
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/routing_number"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: Routing Number List
      type: object
      x-title-plural: Routing Number Lists
    simulate_a_real_time_payments_transfer_to_your_account_parameters:
      example:
        account_number_id: account_number_v18nkfqm6afpsrvy82b2
        amount: 1000
        request_for_payment_id: real_time_payments_request_for_payment_28kcliz1oevcnqyn9qp7
      properties:
        account_number_id:
          description: The identifier of the Account Number the inbound Real Time Payments Transfer is for.
          type: string
        amount:
          description: The transfer amount in USD cents. Must be positive.
          minimum: 1
          type: integer
        debtor_account_number:
          description: The account number of the account that sent the transfer.
          maxLength: 200
          minLength: 1
          type: string
        debtor_name:
          description: The name provided by the sender of the transfer.
          maxLength: 200
          minLength: 1
          type: string
        debtor_routing_number:
          description: The routing number of the account that sent the transfer.
          maxLength: 9
          minLength: 9
          type: string
        remittance_information:
          description: Additional information included with the transfer.
          maxLength: 140
          minLength: 1
          type: string
        request_for_payment_id:
          description: The identifier of a pending Request for Payment that this transfer will fulfill.
          type: string
      required:
        - account_number_id
        - amount
      type: object
    simulate_a_refund_on_a_card_parameters:
      example:
        transaction_id: transaction_uyrp7fld2ium70oa7oi
      properties:
        transaction_id:
          description: The identifier for the Transaction to refund. The Transaction's source must have a category of card_settlement.
          type: string
      required:
        - transaction_id
      type: object
    simulate_a_tax_document_being_created_parameters:
      example:
        account_id: account_in71c4amph0vgo2qllky
      properties:
        account_id:
          description: The identifier of the Account the tax document is for.
          type: string
      required:
        - account_id
      type: object
    simulate_a_wire_transfer_to_your_account_parameters:
      example:
        account_number_id: account_number_v18nkfqm6afpsrvy82b2
        amount: 1000
      properties:
        account_number_id:
          description: The identifier of the Account Number the inbound Wire Transfer is for.
          type: string
        amount:
          description: The transfer amount in cents. Must be positive.
          minimum: 1
          type: integer
        beneficiary_address_line1:
          description: The sending bank will set beneficiary_address_line1 in production. You can simulate any value here.
          maxLength: 200
          minLength: 1
          type: string
        beneficiary_address_line2:
          description: The sending bank will set beneficiary_address_line2 in production. You can simulate any value here.
          maxLength: 200
          minLength: 1
          type: string
        beneficiary_address_line3:
          description: The sending bank will set beneficiary_address_line3 in production. You can simulate any value here.
          maxLength: 200
          minLength: 1
          type: string
        beneficiary_name:
          description: The sending bank will set beneficiary_name in production. You can simulate any value here.
          maxLength: 200
          minLength: 1
          type: string
        beneficiary_reference:
          description: The sending bank will set beneficiary_reference in production. You can simulate any value here.
          maxLength: 200
          minLength: 1
          type: string
        originator_address_line1:
          description: The sending bank will set originator_address_line1 in production. You can simulate any value here.
          maxLength: 200
          minLength: 1
          type: string
        originator_address_line2:
          description: The sending bank will set originator_address_line2 in production. You can simulate any value here.
          maxLength: 200
          minLength: 1
          type: string
        originator_address_line3:
          description: The sending bank will set originator_address_line3 in production. You can simulate any value here.
          maxLength: 200
          minLength: 1
          type: string
        originator_name:
          description: The sending bank will set originator_name in production. You can simulate any value here.
          maxLength: 200
          minLength: 1
          type: string
        originator_to_beneficiary_information_line1:
          description: The sending bank will set originator_to_beneficiary_information_line1 in production. You can simulate any value here.
          maxLength: 200
          minLength: 1
          type: string
        originator_to_beneficiary_information_line2:
          description: The sending bank will set originator_to_beneficiary_information_line2 in production. You can simulate any value here.
          maxLength: 200
          minLength: 1
          type: string
        originator_to_beneficiary_information_line3:
          description: The sending bank will set originator_to_beneficiary_information_line3 in production. You can simulate any value here.
          maxLength: 200
          minLength: 1
          type: string
        originator_to_beneficiary_information_line4:
          description: The sending bank will set originator_to_beneficiary_information_line4 in production. You can simulate any value here.
          maxLength: 200
          minLength: 1
          type: string
      required:
        - account_number_id
        - amount
      type: object
    simulate_an_account_statement_being_created_parameters:
      example:
        account_id: account_in71c4amph0vgo2qllky
      properties:
        account_id:
          description: The identifier of the Account the statement is for.
          type: string
      required:
        - account_id
      type: object
    simulate_an_ach_transfer_to_your_account_parameters:
      example:
        account_number_id: account_number_v18nkfqm6afpsrvy82b2
        amount: 1000
      properties:
        account_number_id:
          description: The identifier of the Account Number the inbound ACH Transfer is for.
          type: string
        amount:
          description: The transfer amount in cents. A positive amount originates a credit transfer pushing funds to the receiving account. A negative amount originates a debit transfer pulling funds from the receiving account.
          type: integer
        company_descriptive_date:
          description: The description of the date of the transfer.
          maxLength: 6
          minLength: 1
          type: string
        company_discretionary_data:
          description: Data associated with the transfer set by the sender.
          maxLength: 20
          minLength: 1
          type: string
        company_entry_description:
          description: The description of the transfer set by the sender.
          maxLength: 10
          minLength: 1
          type: string
        company_id:
          description: The sender's company id.
          maxLength: 15
          minLength: 1
          type: string
        company_name:
          description: The name of the sender.
          maxLength: 16
          minLength: 1
          type: string
      required:
        - account_number_id
        - amount
      type: object
    simulate_an_authorization_on_a_card_parameters:
      example:
        amount: 1000
        card_id: card_oubs0hwk5rn6knuecxg2
        event_subscription_id: event_subscription_001dzz0r20rcdxgb013zqb8m04g
      properties:
        amount:
          description: The authorization amount in cents.
          maximum: 1000000000
          minimum: 1
          type: integer
        card_id:
          description: The identifier of the Card to be authorized.
          type: string
        digital_wallet_token_id:
          description: The identifier of the Digital Wallet Token to be authorized.
          type: string
        event_subscription_id:
          description: The identifier of the Event Subscription to use. If provided, will override the default real time event subscription. Because you can only create one real time decision event subscription, you can use this field to route events to any specified event subscription for testing purposes.
          type: string
      required:
        - amount
      type: object
    simulate_an_inbound_wire_drawdown_request_being_created_parameters:
      example:
        amount: 10000
        beneficiary_account_number: "987654321"
        beneficiary_address_line1: 33 Liberty Street
        beneficiary_address_line2: New York, NY, 10045
        beneficiary_name: Ian Crease
        beneficiary_routing_number: "101050001"
        currency: USD
        message_to_recipient: Invoice 29582
        originator_account_number: "987654321"
        originator_address_line1: 33 Liberty Street
        originator_address_line2: New York, NY, 10045
        originator_name: Ian Crease
        originator_routing_number: "101050001"
        recipient_account_number_id: account_number_v18nkfqm6afpsrvy82b2
      properties:
        amount:
          description: The amount being requested in cents.
          minimum: 0
          type: integer
        beneficiary_account_number:
          description: The drawdown request's beneficiary's account number.
          maxLength: 200
          minLength: 1
          type: string
        beneficiary_address_line1:
          description: Line 1 of the drawdown request's beneficiary's address.
          maxLength: 35
          minLength: 1
          type: string
        beneficiary_address_line2:
          description: Line 2 of the drawdown request's beneficiary's address.
          maxLength: 35
          minLength: 1
          type: string
        beneficiary_address_line3:
          description: Line 3 of the drawdown request's beneficiary's address.
          maxLength: 35
          minLength: 1
          type: string
        beneficiary_name:
          description: The drawdown request's beneficiary's name.
          maxLength: 35
          minLength: 1
          type: string
        beneficiary_routing_number:
          description: The drawdown request's beneficiary's routing number.
          maxLength: 200
          minLength: 1
          type: string
        currency:
          description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being requested. Will always be "USD".
          maxLength: 200
          minLength: 1
          type: string
        message_to_recipient:
          description: A message from the drawdown request's originator.
          maxLength: 140
          minLength: 1
          type: string
        originator_account_number:
          description: The drawdown request's originator's account number.
          maxLength: 200
          minLength: 1
          type: string
        originator_address_line1:
          description: Line 1 of the drawdown request's originator's address.
          maxLength: 35
          minLength: 1
          type: string
        originator_address_line2:
          description: Line 2 of the drawdown request's originator's address.
          maxLength: 35
          minLength: 1
          type: string
        originator_address_line3:
          description: Line 3 of the drawdown request's originator's address.
          maxLength: 35
          minLength: 1
          type: string
        originator_name:
          description: The drawdown request's originator's name.
          maxLength: 35
          minLength: 1
          type: string
        originator_routing_number:
          description: The drawdown request's originator's routing number.
          maxLength: 200
          minLength: 1
          type: string
        originator_to_beneficiary_information_line1:
          description: Line 1 of the information conveyed from the originator of the message to the beneficiary.
          maxLength: 35
          minLength: 1
          type: string
        originator_to_beneficiary_information_line2:
          description: Line 2 of the information conveyed from the originator of the message to the beneficiary.
          maxLength: 35
          minLength: 1
          type: string
        originator_to_beneficiary_information_line3:
          description: Line 3 of the information conveyed from the originator of the message to the beneficiary.
          maxLength: 35
          minLength: 1
          type: string
        originator_to_beneficiary_information_line4:
          description: Line 4 of the information conveyed from the originator of the message to the beneficiary.
          maxLength: 35
          minLength: 1
          type: string
        recipient_account_number_id:
          description: The Account Number to which the recipient of this request is being requested to send funds from.
          type: string
      required:
        - recipient_account_number_id
        - originator_account_number
        - originator_routing_number
        - beneficiary_account_number
        - beneficiary_routing_number
        - amount
        - currency
        - message_to_recipient
      type: object
    simulate_an_interest_payment_to_your_account_parameters:
      example:
        account_id: account_in71c4amph0vgo2qllky
        amount: 1000
      properties:
        account_id:
          description: The identifier of the Account Number the Interest Payment is for.
          type: string
        amount:
          description: The interest amount in cents. Must be positive.
          minimum: 1
          type: integer
      required:
        - account_id
        - amount
      type: object
    simulate_digital_wallet_provisioning_for_a_card_parameters:
      example:
        card_id: card_oubs0hwk5rn6knuecxg2
      properties:
        card_id:
          description: The identifier of the Card to be authorized.
          type: string
      required:
        - card_id
      type: object
    simulate_settling_a_card_authorization_parameters:
      example:
        card_id: card_oubs0hwk5rn6knuecxg2
        pending_transaction_id: pending_transaction_k1sfetcau2qbvjbzgju4
      properties:
        amount:
          description: The amount to be settled. This defaults to the amount of the Pending Transaction being settled.
          minimum: 1
          type: integer
        card_id:
          description: The identifier of the Card to create a settlement on.
          type: string
        pending_transaction_id:
          description: The identifier of the Pending Transaction for the Card Authorization you wish to settle.
          type: string
      required:
        - card_id
        - pending_transaction_id
      type: object
    simulates_advancing_the_state_of_a_card_dispute_parameters:
      example:
        explanation: This was a valid recurring transaction
        status: rejected
      properties:
        explanation:
          description: Why the dispute was rejected. Not required for accepting disputes.
          maxLength: 200
          minLength: 1
          type: string
        status:
          description: The status to move the dispute to.
          enum:
            - accepted
            - rejected
          type: string
          x-enum-descriptions:
            - The Card Dispute has been accepted and your funds have been returned.
            - The Card Dispute has been rejected.
      required:
        - status
      type: object
    transaction:
      description: Transactions are the immutable additions and removals of money from your bank account. They're the equivalent of line items on your bank statement.
      example:
        account_id: account_in71c4amph0vgo2qllky
        amount: 100
        created_at: 2020-01-31T23:59:59Z
        currency: USD
        description: Frederick S. Holmes
        id: transaction_uyrp7fld2ium70oa7oi
        route_id: account_number_v18nkfqm6afpsrvy82b2
        route_type: account_number
        source:
          category: inbound_ach_transfer
          inbound_ach_transfer:
            amount: 100
            originator_company_descriptive_date: null
            originator_company_discretionary_data: null
            originator_company_entry_description: RESERVE
            originator_company_id: "0987654321"
            originator_company_name: BIG BANK
            receiver_id_number: "12345678900"
            receiver_name: IAN CREASE
            trace_number: "021000038461022"
        type: transaction
      properties:
        account_id:
          description: The identifier for the Account the Transaction belongs to.
          type: string
        amount:
          description: The Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.
          type: integer
        created_at:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Transaction occured.
          format: date-time
          type: string
        currency:
          description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Transaction's currency. This will match the currency on the Transcation's Account.
          enum:
            - CAD
            - CHF
            - EUR
            - GBP
            - JPY
            - USD
          type: string
          x-enum-descriptions:
            - Canadian Dollar (CAD)
            - Swiss Franc (CHF)
            - Euro (EUR)
            - British Pound (GBP)
            - Japanese Yen (JPY)
            - US Dollar (USD)
        description:
          description: For a Transaction related to a transfer, this is the description you provide. For a Transaction related to a payment, this is the description the vendor provides.
          type: string
        id:
          description: The Transaction identifier.
          type: string
        route_id:
          description: The identifier for the route this Transaction came through. Routes are things like cards and ACH details.
          nullable: true
          type: string
        route_type:
          description: The type of the route this Transaction came through.
          enum:
            - account_number
            - card
          nullable: true
          type: string
          x-enum-descriptions:
            - An Account Number.
            - A Card.
        source:
          description: This is an object giving more details on the network-level event that caused the Transaction. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.
          example:
            category: inbound_ach_transfer
            inbound_ach_transfer:
              amount: 100
              originator_company_descriptive_date: null
              originator_company_discretionary_data: null
              originator_company_entry_description: RESERVE
              originator_company_id: "0987654321"
              originator_company_name: BIG BANK
              receiver_id_number: "12345678900"
              receiver_name: IAN CREASE
              trace_number: "021000038461022"
          properties:
            account_transfer_intention:
              description: A Account Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `account_transfer_intention`.
              example:
                amount: 100
                currency: USD
                description: Frederick S. Holmes
                destination_account_id: account_uf16sut2ct5bevmq3eh
                source_account_id: account_in71c4amph0vgo2qllky
                transfer_id: account_transfer_7k9qe1ysdgqztnt63l7n
              nullable: true
              properties:
                amount:
                  description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                  type: integer
                currency:
                  description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency.
                  enum:
                    - CAD
                    - CHF
                    - EUR
                    - GBP
                    - JPY
                    - USD
                  type: string
                  x-enum-descriptions:
                    - Canadian Dollar (CAD)
                    - Swiss Franc (CHF)
                    - Euro (EUR)
                    - British Pound (GBP)
                    - Japanese Yen (JPY)
                    - US Dollar (USD)
                description:
                  description: The description you chose to give the transfer.
                  type: string
                destination_account_id:
                  description: The identifier of the Account to where the Account Transfer was sent.
                  type: string
                source_account_id:
                  description: The identifier of the Account from where the Account Transfer was sent.
                  type: string
                transfer_id:
                  description: The identifier of the Account Transfer that led to this Pending Transaction.
                  type: string
              required:
                - amount
                - currency
                - description
                - destination_account_id
                - source_account_id
                - transfer_id
              title: Account Transfer Intention
              type: object
              x-title-plural: Account Transfer Intentions
            ach_check_conversion:
              description: A ACH Check Conversion object. This field will be present in the JSON response if and only if `category` is equal to `ach_check_conversion`.
              example:
                amount: 100
                file_id: file_makxrc67oh9l6sg7w9yc
              nullable: true
              properties:
                amount:
                  description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                  type: integer
                file_id:
                  description: The identifier of the File containing an image of the returned check.
                  type: string
              required:
                - amount
                - file_id
              title: ACH Check Conversion
              type: object
              x-title-plural: ACH Check Conversions
            ach_check_conversion_return:
              description: A ACH Check Conversion Return object. This field will be present in the JSON response if and only if `category` is equal to `ach_check_conversion_return`.
              example:
                amount: 100
                return_reason_code: ""
              nullable: true
              properties:
                amount:
                  description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                  type: integer
                return_reason_code:
                  description: Why the transfer was returned.
                  type: string
              required:
                - amount
                - return_reason_code
              title: ACH Check Conversion Return
              type: object
              x-title-plural: ACH Check Conversion Returns
            ach_transfer_intention:
              description: A ACH Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_intention`.
              example:
                account_number: "987654321"
                amount: 100
                routing_number: "101050001"
                statement_descriptor: Frederick S. Holmes
                transfer_id: account_transfer_7k9qe1ysdgqztnt63l7n
              nullable: true
              properties:
                account_number:
                  description: ""
                  type: string
                amount:
                  description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                  type: integer
                routing_number:
                  description: ""
                  type: string
                statement_descriptor:
                  description: ""
                  type: string
                transfer_id:
                  description: The identifier of the ACH Transfer that led to this Transaction.
                  type: string
              required:
                - amount
                - account_number
                - routing_number
                - statement_descriptor
                - transfer_id
              title: ACH Transfer Intention
              type: object
              x-title-plural: ACH Transfer Intentions
            ach_transfer_rejection:
              description: A ACH Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_rejection`.
              example:
                transfer_id: account_transfer_7k9qe1ysdgqztnt63l7n
              nullable: true
              properties:
                transfer_id:
                  description: The identifier of the ACH Transfer that led to this Transaction.
                  type: string
              required:
                - transfer_id
              title: ACH Transfer Rejection
              type: object
              x-title-plural: ACH Transfer Rejections
            ach_transfer_return:
              description: A ACH Transfer Return object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_return`.
              example:
                created_at: 2020-01-31T23:59:59Z
                return_reason_code: insufficient_fund
                transaction_id: transaction_uyrp7fld2ium70oa7oi
                transfer_id: ach_transfer_uoxatyh3lt5evrsdvo7q
              nullable: true
              properties:
                created_at:
                  description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.
                  format: date-time
                  type: string
                return_reason_code:
                  description: Why the ACH Transfer was returned.
                  enum:
                    - insufficient_fund
                    - no_account
                    - account_closed
                    - invalid_account_number_structure
                    - account_frozen_entry_returned_per_ofac_instruction
                    - credit_entry_refused_by_receiver
                    - unauthorized_debit_to_consumer_account_using_corporate_sec_code
                    - corporate_customer_advised_not_authorized
                    - payment_stopped
                    - non_transaction_account
                    - uncollected_funds
                    - routing_number_check_digit_error
                    - customer_advised_unauthorized_improper_ineligible_or_incomplete
                    - amount_field_error
                    - authorization_revoked_by_customer
                    - invalid_ach_routing_number
                    - file_record_edit_criteria
                    - enr_invalid_individual_name
                    - returned_per_odfi_request
                    - addenda_error
                    - limited_participation_dfi
                    - incorrectly_coded_outbound_international_payment
                    - other
                  type: string
                  x-enum-descriptions:
                    - Insufficient funds in the source account.
                    - The account does not exist or the receiving bank was unable to locate it.
                    - The account is closed.
                    - The account number is invalid at the receiving bank.
                    - The account was frozen per the Office of Foreign Assets Control.
                    - The receiving bank account refused a credit transfer.
                    - The receiving bank rejected because of an incorrect Standard Entry Class code.
                    - The corporate customer reversed the transfer.
                    - The receiving bank stopped payment on this transfer.
                    - The receiving bank account does not perform transfers.
                    - The receiving bank account does not have enough available balance for the transfer.
                    - The routing number is incorrect.
                    - The customer reversed the transfer.
                    - The amount field is incorrect or too large.
                    - The customer who initiated the transfer revoked authorization.
                    - The routing number is invalid.
                    - The receiving bank is unable to process a field in the transfer.
                    - The individual name field was invalid.
                    - The originating financial institution reversed the transfer.
                    - The addenda record is incorrect or missing.
                    - The receiving bank's regulatory supervisor has limited their participation.
                    - The outbound international ACH transfer was incorrect.
                    - Any other ACH return reason.
                transaction_id:
                  description: The identifier of the Tranasaction associated with this return.
                  type: string
                transfer_id:
                  description: The identifier of the ACH Transfer associated with this return.
                  type: string
              required:
                - created_at
                - return_reason_code
                - transfer_id
                - transaction_id
              title: ACH Transfer Return
              type: object
              x-title-plural: ACH Transfer Returns
            card_dispute_acceptance:
              description: A Card Dispute Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `card_dispute_acceptance`.
              example:
                accepted_at: 2020-01-31T23:59:59Z
                card_dispute_id: card_dispute_h9sc95nbl1cgltpp7men
                transaction_id: transaction_uyrp7fld2ium70oa7oi
              nullable: true
              properties:
                accepted_at:
                  description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was accepted.
                  format: date-time
                  type: string
                card_dispute_id:
                  description: The identifier of the Card Dispute that was accepted.
                  type: string
                transaction_id:
                  description: The identifier of the Transaction that was created to return the disputed funds to your account.
                  type: string
              required:
                - accepted_at
                - card_dispute_id
                - transaction_id
              title: Card Dispute Acceptance
              type: object
              x-title-plural: Card Dispute Acceptances
            card_refund:
              description: A Card Refund object. This field will be present in the JSON response if and only if `category` is equal to `card_refund`.
              example:
                amount: 100
                card_settlement_transaction_id: transaction_uyrp7fld2ium70oa7oi
                currency: USD
                id: card_refund_imgc2xwplh6t4r3gn16e
                merchant_acceptor_id: "5665270011000168"
                merchant_category_code: "5734"
                merchant_city: New York
                merchant_country: US
                merchant_name: AMAZON.COM
                merchant_state: NY
                type: card_refund
              nullable: true
              properties:
                amount:
                  description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                  type: integer
                card_settlement_transaction_id:
                  description: The identifier for the Transaction this refunds, if any.
                  nullable: true
                  type: string
                currency:
                  description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                  enum:
                    - CAD
                    - CHF
                    - EUR
                    - GBP
                    - JPY
                    - USD
                  type: string
                  x-enum-descriptions:
                    - Canadian Dollar (CAD)
                    - Swiss Franc (CHF)
                    - Euro (EUR)
                    - British Pound (GBP)
                    - Japanese Yen (JPY)
                    - US Dollar (USD)
                id:
                  description: The Card Refund identifier.
                  type: string
                merchant_acceptor_id:
                  description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.
                  nullable: true
                  type: string
                merchant_category_code:
                  description: The 4-digit MCC describing the merchant's business.
                  type: string
                merchant_city:
                  description: The city the merchant resides in.
                  nullable: true
                  type: string
                merchant_country:
                  description: The country the merchant resides in.
                  type: string
                merchant_name:
                  description: The name of the merchant.
                  nullable: true
                  type: string
                merchant_state:
                  description: The state the merchant resides in.
                  nullable: true
                  type: string
                type:
                  description: A constant representing the object's type. For this resource it will always be `card_refund`.
                  enum:
                    - card_refund
                  type: string
              required:
                - id
                - amount
                - currency
                - card_settlement_transaction_id
                - merchant_acceptor_id
                - merchant_city
                - merchant_state
                - merchant_country
                - merchant_name
                - merchant_category_code
                - type
              title: Card Refund
              type: object
              x-title-plural: Card Refunds
            card_revenue_payment:
              description: A Card Revenue Payment object. This field will be present in the JSON response if and only if `category` is equal to `card_revenue_payment`.
              example:
                amount: 100
                currency: USD
                period_end: 2023-04-30T23:59:59Z
                period_start: 2023-04-01T00:00:00Z
                transacted_on_account_id: account_in71c4amph0vgo2qllky
              nullable: true
              properties:
                amount:
                  description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                  type: integer
                currency:
                  description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
                  enum:
                    - CAD
                    - CHF
                    - EUR
                    - GBP
                    - JPY
                    - USD
                  type: string
                  x-enum-descriptions:
                    - Canadian Dollar (CAD)
                    - Swiss Franc (CHF)
                    - Euro (EUR)
                    - British Pound (GBP)
                    - Japanese Yen (JPY)
                    - US Dollar (USD)
                period_end:
                  description: The end of the period for which this transaction paid interest.
                  format: date-time
                  type: string
                period_start:
                  description: The start of the period for which this transaction paid interest.
                  format: date-time
                  type: string
                transacted_on_account_id:
                  description: The account the card belonged to.
                  nullable: true
                  type: string
              required:
                - amount
                - currency
                - period_start
                - period_end
                - transacted_on_account_id
              title: Card Revenue Payment
              type: object
              x-title-plural: Card Revenue Payments
            card_route_refund:
              description: A Deprecated Card Refund object. This field will be present in the JSON response if and only if `category` is equal to `card_route_refund`.
              example:
                amount: 1000
                currency: USD
                merchant_acceptor_id: "372909060886"
                merchant_category_code: "5998"
                merchant_city: "5364086000"
                merchant_country: USA
                merchant_descriptor: TENTS R US
                merchant_state: CA
              nullable: true
              properties:
                amount:
                  description: The refunded amount in the minor unit of the refunded currency. For dollars, for example, this is cents.
                  type: integer
                currency:
                  description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the refund currency.
                  enum:
                    - CAD
                    - CHF
                    - EUR
                    - GBP
                    - JPY
                    - USD
                  type: string
                  x-enum-descriptions:
                    - Canadian Dollar (CAD)
                    - Swiss Franc (CHF)
                    - Euro (EUR)
                    - British Pound (GBP)
                    - Japanese Yen (JPY)
                    - US Dollar (USD)
                merchant_acceptor_id:
                  description: ""
                  type: string
                merchant_category_code:
                  description: ""
                  nullable: true
                  type: string
                merchant_city:
                  description: ""
                  nullable: true
                  type: string
                merchant_country:
                  description: ""
                  type: string
                merchant_descriptor:
                  description: ""
                  type: string
                merchant_state:
                  description: ""
                  nullable: true
                  type: string
              required:
                - amount
                - currency
                - merchant_acceptor_id
                - merchant_city
                - merchant_country
                - merchant_descriptor
                - merchant_state
                - merchant_category_code
              title: Deprecated Card Refund
              type: object
              x-title-plural: Deprecated Card Refunds
            card_route_settlement:
              description: A Deprecated Card Settlement object. This field will be present in the JSON response if and only if `category` is equal to `card_route_settlement`.
              example:
                amount: 1000
                currency: USD
                merchant_acceptor_id: "372909060886"
                merchant_category_code: "5998"
                merchant_city: "5364086000"
                merchant_country: USA
                merchant_descriptor: TENTS R US
                merchant_state: CA
              nullable: true
              properties:
                amount:
                  description: The settled amount in the minor unit of the settlement currency. For dollars, for example, this is cents.
                  type: integer
                currency:
                  description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the settlement currency.
                  enum:
                    - CAD
                    - CHF
                    - EUR
                    - GBP
                    - JPY
                    - USD
                  type: string
                  x-enum-descriptions:
                    - Canadian Dollar (CAD)
                    - Swiss Franc (CHF)
                    - Euro (EUR)
                    - British Pound (GBP)
                    - Japanese Yen (JPY)
                    - US Dollar (USD)
                merchant_acceptor_id:
                  description: ""
                  type: string
                merchant_category_code:
                  description: ""
                  nullable: true
                  type: string
                merchant_city:
                  description: ""
                  nullable: true
                  type: string
                merchant_country:
                  description: ""
                  nullable: true
                  type: string
                merchant_descriptor:
                  description: ""
                  type: string
                merchant_state:
                  description: ""
                  nullable: true
                  type: string
              required:
                - amount
                - currency
                - merchant_acceptor_id
                - merchant_city
                - merchant_country
                - merchant_descriptor
                - merchant_state
                - merchant_category_code
              title: Deprecated Card Settlement
              type: object
              x-title-plural: Deprecated Card Settlements
            card_settlement:
              description: A Card Settlement object. This field will be present in the JSON response if and only if `category` is equal to `card_settlement`.
              example:
                amount: 100
                card_authorization: null
                currency: USD
                id: card_settlement_khv5kfeu0vndj291omg6
                merchant_acceptor_id: "5665270011000168"
                merchant_category_code: "5734"
                merchant_city: New York
                merchant_country: US
                merchant_name: AMAZON.COM
                merchant_state: NY
                pending_transaction_id: null
                presentment_amount: 100
                presentment_currency: USD
                type: card_settlement
              nullable: true
              properties:
                amount:
                  description: The amount in the minor unit of the transaction's settlement currency. For dollars, for example, this is cents.
                  type: integer
                card_authorization:
                  description: The Card Authorization that was created prior to this Card Settlement, if on exists.
                  nullable: true
                  type: string
                currency:
                  description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's settlement currency.
                  enum:
                    - CAD
                    - CHF
                    - EUR
                    - GBP
                    - JPY
                    - USD
                  type: string
                  x-enum-descriptions:
                    - Canadian Dollar (CAD)
                    - Swiss Franc (CHF)
                    - Euro (EUR)
                    - British Pound (GBP)
                    - Japanese Yen (JPY)
                    - US Dollar (USD)
                id:
                  description: The Card Settlement identifier.
                  type: string
                merchant_acceptor_id:
                  description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.
                  nullable: true
                  type: string
                merchant_category_code:
                  description: The 4-digit MCC describing the merchant's business.
                  type: string
                merchant_city:
                  description: The city the merchant resides in.
                  nullable: true
                  type: string
                merchant_country:
                  description: The country the merchant resides in.
                  type: string
                merchant_name:
                  description: The name of the merchant.
                  nullable: true
                  type: string
                merchant_state:
                  description: The state the merchant resides in.
                  nullable: true
                  type: string
                pending_transaction_id:
                  description: The identifier of the Pending Transaction associated with this Transaction.
                  nullable: true
                  type: string
                presentment_amount:
                  description: The amount in the minor unit of the transaction's presentment currency.
                  type: integer
                presentment_currency:
                  description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's presentment currency.
                  type: string
                type:
                  description: A constant representing the object's type. For this resource it will always be `card_settlement`.
                  enum:
                    - card_settlement
                  type: string
              required:
                - id
                - card_authorization
                - amount
                - currency
                - presentment_amount
                - presentment_currency
                - merchant_acceptor_id
                - merchant_city
                - merchant_state
                - merchant_country
                - merchant_name
                - merchant_category_code
                - pending_transaction_id
                - type
              title: Card Settlement
              type: object
              x-title-plural: Card Settlements
            category:
              description: The type of transaction that took place. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.
              enum:
                - account_transfer_intention
                - ach_check_conversion_return
                - ach_check_conversion
                - ach_transfer_intention
                - ach_transfer_rejection
                - ach_transfer_return
                - card_dispute_acceptance
                - card_refund
                - card_settlement
                - card_revenue_payment
                - check_deposit_acceptance
                - check_deposit_return
                - check_transfer_intention
                - check_transfer_return
                - check_transfer_rejection
                - check_transfer_stop_payment_request
                - dispute_resolution
                - empyreal_cash_deposit
                - fee_payment
                - inbound_ach_transfer
                - inbound_ach_transfer_return_intention
                - inbound_check
                - inbound_international_ach_transfer
                - inbound_real_time_payments_transfer_confirmation
                - inbound_wire_drawdown_payment_reversal
                - inbound_wire_drawdown_payment
                - inbound_wire_reversal
                - inbound_wire_transfer
                - interest_payment
                - internal_general_ledger_transaction
                - internal_source
                - card_route_refund
                - card_route_settlement
                - real_time_payments_transfer_acknowledgement
                - sample_funds
                - wire_drawdown_payment_intention
                - wire_drawdown_payment_rejection
                - wire_transfer_intention
                - wire_transfer_rejection
                - other
              type: string
              x-enum-descriptions:
                - The Transaction was created by a Account Transfer Intention object. Details will be under the `account_transfer_intention` object.
                - The Transaction was created by a ACH Check Conversion Return object. Details will be under the `ach_check_conversion_return` object.
                - The Transaction was created by a ACH Check Conversion object. Details will be under the `ach_check_conversion` object.
                - The Transaction was created by a ACH Transfer Intention object. Details will be under the `ach_transfer_intention` object.
                - The Transaction was created by a ACH Transfer Rejection object. Details will be under the `ach_transfer_rejection` object.
                - The Transaction was created by a ACH Transfer Return object. Details will be under the `ach_transfer_return` object.
                - The Transaction was created by a Card Dispute Acceptance object. Details will be under the `card_dispute_acceptance` object.
                - The Transaction was created by a Card Refund object. Details will be under the `card_refund` object.
                - The Transaction was created by a Card Settlement object. Details will be under the `card_settlement` object.
                - The Transaction was created by a Card Revenue Payment object. Details will be under the `card_revenue_payment` object.
                - The Transaction was created by a Check Deposit Acceptance object. Details will be under the `check_deposit_acceptance` object.
                - The Transaction was created by a Check Deposit Return object. Details will be under the `check_deposit_return` object.
                - The Transaction was created by a Check Transfer Intention object. Details will be under the `check_transfer_intention` object.
                - The Transaction was created by a Check Transfer Return object. Details will be under the `check_transfer_return` object.
                - The Transaction was created by a Check Transfer Rejection object. Details will be under the `check_transfer_rejection` object.
                - The Transaction was created by a Check Transfer Stop Payment Request object. Details will be under the `check_transfer_stop_payment_request` object.
                - The Transaction was created by a Dispute Resolution object. Details will be under the `dispute_resolution` object.
                - The Transaction was created by a Empyreal Cash Deposit object. Details will be under the `empyreal_cash_deposit` object.
                - The Transaction was created by a Fee Payment object. Details will be under the `fee_payment` object.
                - The Transaction was created by a Inbound ACH Transfer object. Details will be under the `inbound_ach_transfer` object.
                - The Transaction was created by a Inbound ACH Transfer Return Intention object. Details will be under the `inbound_ach_transfer_return_intention` object.
                - The Transaction was created by a Inbound Check object. Details will be under the `inbound_check` object.
                - The Transaction was created by a Inbound International ACH Transfer object. Details will be under the `inbound_international_ach_transfer` object.
                - The Transaction was created by a Inbound Real Time Payments Transfer Confirmation object. Details will be under the `inbound_real_time_payments_transfer_confirmation` object.
                - The Transaction was created by a Inbound Wire Drawdown Payment Reversal object. Details will be under the `inbound_wire_drawdown_payment_reversal` object.
                - The Transaction was created by a Inbound Wire Drawdown Payment object. Details will be under the `inbound_wire_drawdown_payment` object.
                - The Transaction was created by a Inbound Wire Reversal object. Details will be under the `inbound_wire_reversal` object.
                - The Transaction was created by a Inbound Wire Transfer object. Details will be under the `inbound_wire_transfer` object.
                - The Transaction was created by a Interest Payment object. Details will be under the `interest_payment` object.
                - The Transaction was created by a Internal General Ledger Transaction object. Details will be under the `internal_general_ledger_transaction` object.
                - The Transaction was created by a Internal Source object. Details will be under the `internal_source` object.
                - The Transaction was created by a Deprecated Card Refund object. Details will be under the `card_route_refund` object.
                - The Transaction was created by a Deprecated Card Settlement object. Details will be under the `card_route_settlement` object.
                - The Transaction was created by a Real Time Payments Transfer Acknowledgement object. Details will be under the `real_time_payments_transfer_acknowledgement` object.
                - The Transaction was created by a Sample Funds object. Details will be under the `sample_funds` object.
                - The Transaction was created by a Wire Drawdown Payment Intention object. Details will be under the `wire_drawdown_payment_intention` object.
                - The Transaction was created by a Wire Drawdown Payment Rejection object. Details will be under the `wire_drawdown_payment_rejection` object.
                - The Transaction was created by a Wire Transfer Intention object. Details will be under the `wire_transfer_intention` object.
                - The Transaction was created by a Wire Transfer Rejection object. Details will be under the `wire_transfer_rejection` object.
                - The Transaction was made for an undocumented or deprecated reason.
            check_deposit_acceptance:
              description: A Check Deposit Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_acceptance`.
              example:
                account_number: "987654321"
                amount: 100
                auxiliary_on_us: "101"
                check_deposit_id: check_deposit_f06n9gpg7sxn8t19lfc1
                currency: USD
                routing_number: "101050001"
                serial_number: null
              nullable: true
              properties:
                account_number:
                  description: The account number printed on the check.
                  type: string
                amount:
                  description: The amount to be deposited in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                  type: integer
                auxiliary_on_us:
                  description: An additional line of metadata printed on the check. This typically includes the check number for business checks.
                  nullable: true
                  type: string
                check_deposit_id:
                  description: The ID of the Check Deposit that was accepted.
                  type: string
                currency:
                  description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                  enum:
                    - CAD
                    - CHF
                    - EUR
                    - GBP
                    - JPY
                    - USD
                  type: string
                  x-enum-descriptions:
                    - Canadian Dollar (CAD)
                    - Swiss Franc (CHF)
                    - Euro (EUR)
                    - British Pound (GBP)
                    - Japanese Yen (JPY)
                    - US Dollar (USD)
                routing_number:
                  description: The routing number printed on the check.
                  type: string
                serial_number:
                  description: The check serial number, if present, for consumer checks. For business checks, the serial number is usually in the `auxiliary_on_us` field.
                  nullable: true
                  type: string
              required:
                - amount
                - currency
                - account_number
                - routing_number
                - auxiliary_on_us
                - serial_number
                - check_deposit_id
              title: Check Deposit Acceptance
              type: object
              x-title-plural: Check Deposit Acceptances
            check_deposit_return:
              description: A Check Deposit Return object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_return`.
              example:
                amount: 100
                check_deposit_id: check_deposit_f06n9gpg7sxn8t19lfc1
                currency: USD
                return_reason: insufficient_funds
                returned_at: 2020-01-31T23:59:59Z
                transaction_id: transaction_uyrp7fld2ium70oa7oi
              nullable: true
              properties:
                amount:
                  description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                  type: integer
                check_deposit_id:
                  description: The identifier of the Check Deposit that was returned.
                  type: string
                currency:
                  description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                  enum:
                    - CAD
                    - CHF
                    - EUR
                    - GBP
                    - JPY
                    - USD
                  type: string
                  x-enum-descriptions:
                    - Canadian Dollar (CAD)
                    - Swiss Franc (CHF)
                    - Euro (EUR)
                    - British Pound (GBP)
                    - Japanese Yen (JPY)
                    - US Dollar (USD)
                return_reason:
                  description: ""
                  enum:
                    - ach_conversion_not_supported
                    - closed_account
                    - duplicate_submission
                    - insufficient_funds
                    - no_account
                    - not_authorized
                    - stale_dated
                    - stop_payment
                    - unknown_reason
                    - unmatched_details
                    - unreadable_image
                  type: string
                  x-enum-descriptions:
                    - The check doesn't allow ACH conversion.
                    - The account is closed.
                    - The check has already been deposited.
                    - Insufficient funds
                    - No account was found matching the check details.
                    - The check was not authorized.
                    - The check is too old.
                    - The payment has been stopped by the account holder.
                    - The reason for the return is unknown.
                    - The image doesn't match the details submitted.
                    - The image could not be read.
                returned_at:
                  description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check deposit was returned.
                  format: date-time
                  type: string
                transaction_id:
                  description: The identifier of the transaction that reversed the original check deposit transaction.
                  type: string
              required:
                - amount
                - returned_at
                - currency
                - check_deposit_id
                - transaction_id
                - return_reason
              title: Check Deposit Return
              type: object
              x-title-plural: Check Deposit Returns
            check_transfer_intention:
              description: A Check Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_intention`.
              example:
                address_city: New York
                address_line1: 33 Liberty Street
                address_line2: null
                address_state: NY
                address_zip: "10045"
                amount: 1000
                currency: USD
                recipient_name: Ian Crease
                transfer_id: check_transfer_30b43acfu9vw8fyc4f5
              nullable: true
              properties:
                address_city:
                  description: The city of the check's destination.
                  type: string
                address_line1:
                  description: The street address of the check's destination.
                  type: string
                address_line2:
                  description: The second line of the address of the check's destination.
                  nullable: true
                  type: string
                address_state:
                  description: The state of the check's destination.
                  type: string
                address_zip:
                  description: The postal code of the check's destination.
                  type: string
                amount:
                  description: The transfer amount in USD cents.
                  type: integer
                currency:
                  description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency.
                  enum:
                    - CAD
                    - CHF
                    - EUR
                    - GBP
                    - JPY
                    - USD
                  type: string
                  x-enum-descriptions:
                    - Canadian Dollar (CAD)
                    - Swiss Franc (CHF)
                    - Euro (EUR)
                    - British Pound (GBP)
                    - Japanese Yen (JPY)
                    - US Dollar (USD)
                recipient_name:
                  description: The name that will be printed on the check.
                  type: string
                transfer_id:
                  description: The identifier of the Check Transfer with which this is associated.
                  type: string
              required:
                - address_line1
                - address_line2
                - address_city
                - address_state
                - address_zip
                - amount
                - currency
                - recipient_name
                - transfer_id
              title: Check Transfer Intention
              type: object
              x-title-plural: Check Transfer Intentions
            check_transfer_rejection:
              description: A Check Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_rejection`.
              example:
                transfer_id: check_transfer_30b43acfu9vw8fyc4f5
              nullable: true
              properties:
                transfer_id:
                  description: The identifier of the Check Transfer that led to this Transaction.
                  type: string
              required:
                - transfer_id
              title: Check Transfer Rejection
              type: object
              x-title-plural: Check Transfer Rejections
            check_transfer_return:
              description: A Check Transfer Return object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_return`.
              example:
                file_id: null
                reason: mail_delivery_failure
                returned_at: 2020-01-31T23:59:59Z
                transaction_id: transaction_uyrp7fld2ium70oa7oi
                transfer_id: check_transfer_30b43acfu9vw8fyc4f5
              nullable: true
              properties:
                file_id:
                  description: If available, a document with additional information about the return.
                  nullable: true
                  type: string
                reason:
                  description: The reason why the check was returned.
                  enum:
                    - mail_delivery_failure
                    - refused_by_recipient
                  type: string
                  x-enum-descriptions:
                    - Mail delivery failed and the check was returned to sender.
                    - The check arrived and the recipient refused to deposit it.
                returned_at:
                  description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check was returned.
                  format: date-time
                  type: string
                transaction_id:
                  description: The identifier of the Transaction that was created to credit you for the returned check.
                  nullable: true
                  type: string
                transfer_id:
                  description: The identifier of the returned Check Transfer.
                  type: string
              required:
                - transfer_id
                - returned_at
                - file_id
                - reason
                - transaction_id
              title: Check Transfer Return
              type: object
              x-title-plural: Check Transfer Returns
            check_transfer_stop_payment_request:
              description: A Check Transfer Stop Payment Request object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_stop_payment_request`.
              example:
                requested_at: 2020-01-31T23:59:59Z
                transaction_id: transaction_uyrp7fld2ium70oa7oi
                transfer_id: check_transfer_30b43acfu9vw8fyc4f5
                type: check_transfer_stop_payment_request
              nullable: true
              properties:
                requested_at:
                  description: The time the stop-payment was requested.
                  format: date-time
                  type: string
                transaction_id:
                  description: The transaction ID of the corresponding credit transaction.
                  type: string
                transfer_id:
                  description: The ID of the check transfer that was stopped.
                  type: string
                type:
                  description: A constant representing the object's type. For this resource it will always be `check_transfer_stop_payment_request`.
                  enum:
                    - check_transfer_stop_payment_request
                  type: string
              required:
                - transfer_id
                - transaction_id
                - requested_at
                - type
              title: Check Transfer Stop Payment Request
              type: object
              x-title-plural: Check Transfer Stop Payment Requests
            dispute_resolution:
              description: A Dispute Resolution object. This field will be present in the JSON response if and only if `category` is equal to `dispute_resolution`.
              example:
                amount: 100
                currency: USD
                disputed_transaction_id: transaction_uyrp7fld2ium70oa7oi
              nullable: true
              properties:
                amount:
                  description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                  type: integer
                currency:
                  description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                  enum:
                    - CAD
                    - CHF
                    - EUR
                    - GBP
                    - JPY
                    - USD
                  type: string
                  x-enum-descriptions:
                    - Canadian Dollar (CAD)
                    - Swiss Franc (CHF)
                    - Euro (EUR)
                    - British Pound (GBP)
                    - Japanese Yen (JPY)
                    - US Dollar (USD)
                disputed_transaction_id:
                  description: The identifier of the Transaction that was disputed.
                  type: string
              required:
                - amount
                - currency
                - disputed_transaction_id
              title: Dispute Resolution
              type: object
              x-title-plural: Dispute Resolutions
            empyreal_cash_deposit:
              description: A Empyreal Cash Deposit object. This field will be present in the JSON response if and only if `category` is equal to `empyreal_cash_deposit`.
              example:
                amount: 100
                bag_id: "12345"
                deposit_date: 2020-01-31T23:59:59Z
              nullable: true
              properties:
                amount:
                  description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                  type: integer
                bag_id:
                  description: ""
                  type: string
                deposit_date:
                  description: ""
                  format: date-time
                  type: string
              required:
                - amount
                - bag_id
                - deposit_date
              title: Empyreal Cash Deposit
              type: object
              x-title-plural: Empyreal Cash Deposits
            fee_payment:
              description: A Fee Payment object. This field will be present in the JSON response if and only if `category` is equal to `fee_payment`.
              example:
                amount: 100
                currency: USD
              nullable: true
              properties:
                amount:
                  description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                  type: integer
                currency:
                  description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
                  enum:
                    - CAD
                    - CHF
                    - EUR
                    - GBP
                    - JPY
                    - USD
                  type: string
                  x-enum-descriptions:
                    - Canadian Dollar (CAD)
                    - Swiss Franc (CHF)
                    - Euro (EUR)
                    - British Pound (GBP)
                    - Japanese Yen (JPY)
                    - US Dollar (USD)
              required:
                - amount
                - currency
              title: Fee Payment
              type: object
              x-title-plural: Fee Payments
            inbound_ach_transfer:
              description: A Inbound ACH Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_ach_transfer`.
              example:
                amount: 100
                originator_company_descriptive_date: null
                originator_company_discretionary_data: null
                originator_company_entry_description: RESERVE
                originator_company_id: "0987654321"
                originator_company_name: BIG BANK
                receiver_id_number: "12345678900"
                receiver_name: IAN CREASE
                trace_number: "021000038461022"
              nullable: true
              properties:
                amount:
                  description: The amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                  type: integer
                originator_company_descriptive_date:
                  description: ""
                  nullable: true
                  type: string
                originator_company_discretionary_data:
                  description: ""
                  nullable: true
                  type: string
                originator_company_entry_description:
                  description: ""
                  type: string
                originator_company_id:
                  description: ""
                  type: string
                originator_company_name:
                  description: ""
                  type: string
                receiver_id_number:
                  description: ""
                  nullable: true
                  type: string
                receiver_name:
                  description: ""
                  nullable: true
                  type: string
                trace_number:
                  description: ""
                  type: string
              required:
                - amount
                - originator_company_name
                - originator_company_descriptive_date
                - originator_company_discretionary_data
                - originator_company_entry_description
                - originator_company_id
                - receiver_id_number
                - receiver_name
                - trace_number
              title: Inbound ACH Transfer
              type: object
              x-title-plural: Inbound ACH Transfers
            inbound_check:
              description: A Inbound Check object. This field will be present in the JSON response if and only if `category` is equal to `inbound_check`.
              example:
                amount: 100
                check_front_image_file_id: file_makxrc67oh9l6sg7w9yc
                check_number: "       00000123"
                check_rear_image_file_id: file_makxrc67oh9l6sg7w9yc
                currency: USD
              nullable: true
              properties:
                amount:
                  description: The amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                  type: integer
                check_front_image_file_id:
                  description: ""
                  nullable: true
                  type: string
                check_number:
                  description: ""
                  nullable: true
                  type: string
                check_rear_image_file_id:
                  description: ""
                  nullable: true
                  type: string
                currency:
                  description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's currency.
                  enum:
                    - CAD
                    - CHF
                    - EUR
                    - GBP
                    - JPY
                    - USD
                  type: string
                  x-enum-descriptions:
                    - Canadian Dollar (CAD)
                    - Swiss Franc (CHF)
                    - Euro (EUR)
                    - British Pound (GBP)
                    - Japanese Yen (JPY)
                    - US Dollar (USD)
              required:
                - amount
                - currency
                - check_number
                - check_front_image_file_id
                - check_rear_image_file_id
              title: Inbound Check
              type: object
              x-title-plural: Inbound Checks
            inbound_international_ach_transfer:
              description: A Inbound International ACH Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_international_ach_transfer`.
              example:
                amount: -1000
                destination_country_code: US
                destination_currency_code: USD
                foreign_exchange_indicator: fixed_to_fixed
                foreign_exchange_reference: null
                foreign_exchange_reference_indicator: blank
                foreign_payment_amount: 199
                foreign_trace_number: null
                international_transaction_type_code: internet_initiated
                originating_currency_code: USD
                originating_depository_financial_institution_branch_country: US
                originating_depository_financial_institution_id: "091000019"
                originating_depository_financial_institution_id_qualifier: national_clearing_system_number
                originating_depository_financial_institution_name: WELLS FARGO BANK
                originator_city: BERLIN
                originator_company_entry_description: RETRY PYMT
                originator_country: DE
                originator_identification: 770510487A
                originator_name: BERGHAIN
                originator_postal_code: "50825"
                originator_state_or_province: null
                originator_street_address: Ruedersdorferstr. 7
                payment_related_information: null
                payment_related_information2: null
                receiver_city: BEVERLY HILLS
                receiver_country: US
                receiver_identification_number: "1018790279274"
                receiver_postal_code: "90210"
                receiver_state_or_province: CA
                receiver_street_address: 123 FAKE ST
                receiving_company_or_individual_name: IAN CREASE
                receiving_depository_financial_institution_country: US
                receiving_depository_financial_institution_id: "101050001"
                receiving_depository_financial_institution_id_qualifier: national_clearing_system_number
                receiving_depository_financial_institution_name: BLUE RIDGE BANK, NATIONAL ASSOCIATI
                trace_number: "010202909100090"
              nullable: true
              properties:
                amount:
                  description: The amount in the minor unit of the destination account currency. For dollars, for example, this is cents.
                  type: integer
                destination_country_code:
                  description: ""
                  type: string
                destination_currency_code:
                  description: ""
                  type: string
                foreign_exchange_indicator:
                  description: ""
                  type: string
                foreign_exchange_reference:
                  description: ""
                  nullable: true
                  type: string
                foreign_exchange_reference_indicator:
                  description: ""
                  type: string
                foreign_payment_amount:
                  description: ""
                  type: integer
                foreign_trace_number:
                  description: ""
                  nullable: true
                  type: string
                international_transaction_type_code:
                  description: ""
                  type: string
                originating_currency_code:
                  description: ""
                  type: string
                originating_depository_financial_institution_branch_country:
                  description: ""
                  type: string
                originating_depository_financial_institution_id:
                  description: ""
                  type: string
                originating_depository_financial_institution_id_qualifier:
                  description: ""
                  type: string
                originating_depository_financial_institution_name:
                  description: ""
                  type: string
                originator_city:
                  description: ""
                  type: string
                originator_company_entry_description:
                  description: ""
                  type: string
                originator_country:
                  description: ""
                  type: string
                originator_identification:
                  description: ""
                  type: string
                originator_name:
                  description: ""
                  type: string
                originator_postal_code:
                  description: ""
                  nullable: true
                  type: string
                originator_state_or_province:
                  description: ""
                  nullable: true
                  type: string
                originator_street_address:
                  description: ""
                  type: string
                payment_related_information:
                  description: ""
                  nullable: true
                  type: string
                payment_related_information2:
                  description: ""
                  nullable: true
                  type: string
                receiver_city:
                  description: ""
                  type: string
                receiver_country:
                  description: ""
                  type: string
                receiver_identification_number:
                  description: ""
                  nullable: true
                  type: string
                receiver_postal_code:
                  description: ""
                  nullable: true
                  type: string
                receiver_state_or_province:
                  description: ""
                  nullable: true
                  type: string
                receiver_street_address:
                  description: ""
                  type: string
                receiving_company_or_individual_name:
                  description: ""
                  type: string
                receiving_depository_financial_institution_country:
                  description: ""
                  type: string
                receiving_depository_financial_institution_id:
                  description: ""
                  type: string
                receiving_depository_financial_institution_id_qualifier:
                  description: ""
                  type: string
                receiving_depository_financial_institution_name:
                  description: ""
                  type: string
                trace_number:
                  description: ""
                  type: string
              required:
                - amount
                - foreign_exchange_indicator
                - foreign_exchange_reference_indicator
                - foreign_exchange_reference
                - destination_country_code
                - destination_currency_code
                - foreign_payment_amount
                - foreign_trace_number
                - international_transaction_type_code
                - originating_currency_code
                - originating_depository_financial_institution_name
                - originating_depository_financial_institution_id_qualifier
                - originating_depository_financial_institution_id
                - originating_depository_financial_institution_branch_country
                - originator_city
                - originator_company_entry_description
                - originator_country
                - originator_identification
                - originator_name
                - originator_postal_code
                - originator_street_address
                - originator_state_or_province
                - payment_related_information
                - payment_related_information2
                - receiver_identification_number
                - receiver_street_address
                - receiver_city
                - receiver_state_or_province
                - receiver_country
                - receiver_postal_code
                - receiving_company_or_individual_name
                - receiving_depository_financial_institution_name
                - receiving_depository_financial_institution_id_qualifier
                - receiving_depository_financial_institution_id
                - receiving_depository_financial_institution_country
                - trace_number
              title: Inbound International ACH Transfer
              type: object
              x-title-plural: Inbound International ACH Transfers
            inbound_real_time_payments_transfer_confirmation:
              description: A Inbound Real Time Payments Transfer Confirmation object. This field will be present in the JSON response if and only if `category` is equal to `inbound_real_time_payments_transfer_confirmation`.
              example:
                amount: 100
                creditor_name: Ian Crease
                currency: USD
                debtor_account_number: "987654321"
                debtor_name: National Phonograph Company
                debtor_routing_number: "101050001"
                remittance_information: Invoice 29582
                transaction_identification: 20220501234567891T1BSLZO01745013025
              nullable: true
              properties:
                amount:
                  description: The amount in the minor unit of the transfer's currency. For dollars, for example, this is cents.
                  type: integer
                creditor_name:
                  description: The name the sender of the transfer specified as the recipient of the transfer.
                  type: string
                currency:
                  description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the transfer's currency. This will always be "USD" for a Real Time Payments transfer.
                  enum:
                    - CAD
                    - CHF
                    - EUR
                    - GBP
                    - JPY
                    - USD
                  type: string
                  x-enum-descriptions:
                    - Canadian Dollar (CAD)
                    - Swiss Franc (CHF)
                    - Euro (EUR)
                    - British Pound (GBP)
                    - Japanese Yen (JPY)
                    - US Dollar (USD)
                debtor_account_number:
                  description: The account number of the account that sent the transfer.
                  type: string
                debtor_name:
                  description: The name provided by the sender of the transfer.
                  type: string
                debtor_routing_number:
                  description: The routing number of the account that sent the transfer.
                  type: string
                remittance_information:
                  description: Additional information included with the transfer.
                  nullable: true
                  type: string
                transaction_identification:
                  description: The Real Time Payments network identification of the transfer
                  type: string
              required:
                - amount
                - currency
                - creditor_name
                - debtor_name
                - debtor_account_number
                - debtor_routing_number
                - transaction_identification
                - remittance_information
              title: Inbound Real Time Payments Transfer Confirmation
              type: object
              x-title-plural: Inbound Real Time Payments Transfer Confirmations
            inbound_wire_drawdown_payment:
              description: A Inbound Wire Drawdown Payment object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_drawdown_payment`.
              example:
                amount: 100
                beneficiary_address_line1: null
                beneficiary_address_line2: null
                beneficiary_address_line3: null
                beneficiary_name: null
                beneficiary_reference: null
                description: Inbound wire drawdown payment
                input_message_accountability_data: null
                originator_address_line1: null
                originator_address_line2: null
                originator_address_line3: null
                originator_name: null
                originator_to_beneficiary_information: null
              nullable: true
              properties:
                amount:
                  description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                  type: integer
                beneficiary_address_line1:
                  description: ""
                  nullable: true
                  type: string
                beneficiary_address_line2:
                  description: ""
                  nullable: true
                  type: string
                beneficiary_address_line3:
                  description: ""
                  nullable: true
                  type: string
                beneficiary_name:
                  description: ""
                  nullable: true
                  type: string
                beneficiary_reference:
                  description: ""
                  nullable: true
                  type: string
                description:
                  description: ""
                  type: string
                input_message_accountability_data:
                  description: ""
                  nullable: true
                  type: string
                originator_address_line1:
                  description: ""
                  nullable: true
                  type: string
                originator_address_line2:
                  description: ""
                  nullable: true
                  type: string
                originator_address_line3:
                  description: ""
                  nullable: true
                  type: string
                originator_name:
                  description: ""
                  nullable: true
                  type: string
                originator_to_beneficiary_information:
                  description: ""
                  nullable: true
                  type: string
              required:
                - amount
                - beneficiary_address_line1
                - beneficiary_address_line2
                - beneficiary_address_line3
                - beneficiary_name
                - beneficiary_reference
                - description
                - input_message_accountability_data
                - originator_address_line1
                - originator_address_line2
                - originator_address_line3
                - originator_name
                - originator_to_beneficiary_information
              title: Inbound Wire Drawdown Payment
              type: object
              x-title-plural: Inbound Wire Drawdown Payments
            inbound_wire_drawdown_payment_reversal:
              description: A Inbound Wire Drawdown Payment Reversal object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_drawdown_payment_reversal`.
              example:
                amount: 12345
                description: Inbound wire reversal 2022021100335128
                input_cycle_date: 2022-02-11
                input_message_accountability_data: 20220211B6B7HU2R011023
                input_sequence_number: "11023"
                input_source: B6B7HU2R
                previous_message_input_cycle_date: 2022-02-10
                previous_message_input_message_accountability_data: 20220210MMQFMP0P000007
                previous_message_input_sequence_number: "3"
                previous_message_input_source: MMQFMP0P
              nullable: true
              properties:
                amount:
                  description: The amount that was reversed.
                  type: integer
                description:
                  description: The description on the reversal message from Fedwire.
                  type: string
                input_cycle_date:
                  description: The Fedwire cycle date for the wire reversal.
                  format: date
                  type: string
                input_message_accountability_data:
                  description: The Fedwire transaction identifier.
                  type: string
                input_sequence_number:
                  description: The Fedwire sequence number.
                  type: string
                input_source:
                  description: The Fedwire input source identifier.
                  type: string
                previous_message_input_cycle_date:
                  description: The Fedwire cycle date for the wire transfer that was reversed.
                  format: date
                  type: string
                previous_message_input_message_accountability_data:
                  description: The Fedwire transaction identifier for the wire transfer that was reversed.
                  type: string
                previous_message_input_sequence_number:
                  description: The Fedwire sequence number for the wire transfer that was reversed.
                  type: string
                previous_message_input_source:
                  description: The Fedwire input source identifier for the wire transfer that was reversed.
                  type: string
              required:
                - amount
                - description
                - input_cycle_date
                - input_sequence_number
                - input_source
                - input_message_accountability_data
                - previous_message_input_message_accountability_data
                - previous_message_input_cycle_date
                - previous_message_input_sequence_number
                - previous_message_input_source
              title: Inbound Wire Drawdown Payment Reversal
              type: object
              x-title-plural: Inbound Wire Drawdown Payment Reversals
            inbound_wire_reversal:
              description: A Inbound Wire Reversal object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_reversal`.
              example:
                amount: 12345
                created_at: 2020-01-31T23:59:59Z
                description: Inbound wire reversal 2022021100335128
                financial_institution_to_financial_institution_information: null
                input_cycle_date: 2022-02-11
                input_message_accountability_data: 20220211B6B7HU2R011023
                input_sequence_number: "11023"
                input_source: B6B7HU2R
                previous_message_input_cycle_date: 2022-02-10
                previous_message_input_message_accountability_data: 20220210MMQFMP0P000007
                previous_message_input_sequence_number: "3"
                previous_message_input_source: MMQFMP0P
                receiver_financial_institution_information: null
                transaction_id: transaction_uyrp7fld2ium70oa7oi
              nullable: true
              properties:
                amount:
                  description: The amount that was reversed.
                  type: integer
                created_at:
                  description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the reversal was created.
                  format: date-time
                  type: string
                description:
                  description: The description on the reversal message from Fedwire.
                  type: string
                financial_institution_to_financial_institution_information:
                  description: Additional financial institution information included in the wire reversal.
                  nullable: true
                  type: string
                input_cycle_date:
                  description: The Fedwire cycle date for the wire reversal.
                  format: date
                  type: string
                input_message_accountability_data:
                  description: The Fedwire transaction identifier.
                  type: string
                input_sequence_number:
                  description: The Fedwire sequence number.
                  type: string
                input_source:
                  description: The Fedwire input source identifier.
                  type: string
                previous_message_input_cycle_date:
                  description: The Fedwire cycle date for the wire transfer that was reversed.
                  format: date
                  type: string
                previous_message_input_message_accountability_data:
                  description: The Fedwire transaction identifier for the wire transfer that was reversed.
                  type: string
                previous_message_input_sequence_number:
                  description: The Fedwire sequence number for the wire transfer that was reversed.
                  type: string
                previous_message_input_source:
                  description: The Fedwire input source identifier for the wire transfer that was reversed.
                  type: string
                receiver_financial_institution_information:
                  description: Information included in the wire reversal for the receiving financial institution.
                  nullable: true
                  type: string
                transaction_id:
                  description: The ID for the Transaction associated with the transfer reversal.
                  nullable: true
                  type: string
              required:
                - amount
                - created_at
                - description
                - input_cycle_date
                - input_sequence_number
                - input_source
                - input_message_accountability_data
                - previous_message_input_message_accountability_data
                - previous_message_input_cycle_date
                - previous_message_input_sequence_number
                - previous_message_input_source
                - receiver_financial_institution_information
                - financial_institution_to_financial_institution_information
                - transaction_id
              title: Inbound Wire Reversal
              type: object
              x-title-plural: Inbound Wire Reversals
            inbound_wire_transfer:
              description: A Inbound Wire Transfer object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_transfer`.
              example:
                amount: 100
                beneficiary_address_line1: null
                beneficiary_address_line2: null
                beneficiary_address_line3: null
                beneficiary_name: null
                beneficiary_reference: null
                description: Inbound wire transfer
                input_message_accountability_data: null
                originator_address_line1: null
                originator_address_line2: null
                originator_address_line3: null
                originator_name: null
                originator_to_beneficiary_information: null
                originator_to_beneficiary_information_line1: null
                originator_to_beneficiary_information_line2: null
                originator_to_beneficiary_information_line3: null
                originator_to_beneficiary_information_line4: null
              nullable: true
              properties:
                amount:
                  description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                  type: integer
                beneficiary_address_line1:
                  description: ""
                  nullable: true
                  type: string
                beneficiary_address_line2:
                  description: ""
                  nullable: true
                  type: string
                beneficiary_address_line3:
                  description: ""
                  nullable: true
                  type: string
                beneficiary_name:
                  description: ""
                  nullable: true
                  type: string
                beneficiary_reference:
                  description: ""
                  nullable: true
                  type: string
                description:
                  description: ""
                  type: string
                input_message_accountability_data:
                  description: ""
                  nullable: true
                  type: string
                originator_address_line1:
                  description: ""
                  nullable: true
                  type: string
                originator_address_line2:
                  description: ""
                  nullable: true
                  type: string
                originator_address_line3:
                  description: ""
                  nullable: true
                  type: string
                originator_name:
                  description: ""
                  nullable: true
                  type: string
                originator_to_beneficiary_information:
                  description: ""
                  nullable: true
                  type: string
                originator_to_beneficiary_information_line1:
                  description: ""
                  nullable: true
                  type: string
                originator_to_beneficiary_information_line2:
                  description: ""
                  nullable: true
                  type: string
                originator_to_beneficiary_information_line3:
                  description: ""
                  nullable: true
                  type: string
                originator_to_beneficiary_information_line4:
                  description: ""
                  nullable: true
                  type: string
              required:
                - amount
                - beneficiary_address_line1
                - beneficiary_address_line2
                - beneficiary_address_line3
                - beneficiary_name
                - beneficiary_reference
                - description
                - input_message_accountability_data
                - originator_address_line1
                - originator_address_line2
                - originator_address_line3
                - originator_name
                - originator_to_beneficiary_information_line1
                - originator_to_beneficiary_information_line2
                - originator_to_beneficiary_information_line3
                - originator_to_beneficiary_information_line4
                - originator_to_beneficiary_information
              title: Inbound Wire Transfer
              type: object
              x-title-plural: Inbound Wire Transfers
            interest_payment:
              description: A Interest Payment object. This field will be present in the JSON response if and only if `category` is equal to `interest_payment`.
              example:
                accrued_on_account_id: account_in71c4amph0vgo2qllky
                amount: 100
                currency: USD
                period_end: 2023-04-30T23:59:59Z
                period_start: 2023-04-01T00:00:00Z
              nullable: true
              properties:
                accrued_on_account_id:
                  description: The account on which the interest was accrued.
                  nullable: true
                  type: string
                amount:
                  description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                  type: integer
                currency:
                  description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
                  enum:
                    - CAD
                    - CHF
                    - EUR
                    - GBP
                    - JPY
                    - USD
                  type: string
                  x-enum-descriptions:
                    - Canadian Dollar (CAD)
                    - Swiss Franc (CHF)
                    - Euro (EUR)
                    - British Pound (GBP)
                    - Japanese Yen (JPY)
                    - US Dollar (USD)
                period_end:
                  description: The end of the period for which this transaction paid interest.
                  format: date-time
                  type: string
                period_start:
                  description: The start of the period for which this transaction paid interest.
                  format: date-time
                  type: string
              required:
                - amount
                - currency
                - period_start
                - period_end
                - accrued_on_account_id
              title: Interest Payment
              type: object
              x-title-plural: Interest Payments
            internal_source:
              description: A Internal Source object. This field will be present in the JSON response if and only if `category` is equal to `internal_source`.
              example:
                amount: 100
                currency: USD
                reason: sample_funds
              nullable: true
              properties:
                amount:
                  description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents.
                  type: integer
                currency:
                  description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency.
                  enum:
                    - CAD
                    - CHF
                    - EUR
                    - GBP
                    - JPY
                    - USD
                  type: string
                  x-enum-descriptions:
                    - Canadian Dollar (CAD)
                    - Swiss Franc (CHF)
                    - Euro (EUR)
                    - British Pound (GBP)
                    - Japanese Yen (JPY)
                    - US Dollar (USD)
                reason:
                  description: ""
                  enum:
                    - bank_migration
                    - cashback
                    - empyreal_adjustment
                    - error
                    - error_correction
                    - fees
                    - interest
                    - sample_funds
                    - sample_funds_return
                  type: string
                  x-enum-descriptions:
                    - Bank Migration
                    - Cashback
                    - Empyreal adjustment
                    - Error
                    - Error correction
                    - Fees
                    - Interest
                    - Sample funds
                    - Sample funds return
              required:
                - amount
                - currency
                - reason
              title: Internal Source
              type: object
              x-title-plural: Internal Sources
            real_time_payments_transfer_acknowledgement:
              description: A Real Time Payments Transfer Acknowledgement object. This field will be present in the JSON response if and only if `category` is equal to `real_time_payments_transfer_acknowledgement`.
              example:
                amount: 100
                destination_account_number: "987654321"
                destination_routing_number: "101050001"
                remittance_information: Invoice 29582
                transfer_id: real_time_payments_transfer_iyuhl5kdn7ssmup83mvq
              nullable: true
              properties:
                amount:
                  description: The transfer amount in USD cents.
                  type: integer
                destination_account_number:
                  description: The destination account number.
                  type: string
                destination_routing_number:
                  description: The American Bankers' Association (ABA) Routing Transit Number (RTN).
                  type: string
                remittance_information:
                  description: Unstructured information that will show on the recipient's bank statement.
                  type: string
                transfer_id:
                  description: The identifier of the Real Time Payments Transfer that led to this Transaction.
                  type: string
              required:
                - amount
                - destination_account_number
                - destination_routing_number
                - remittance_information
                - transfer_id
              title: Real Time Payments Transfer Acknowledgement
              type: object
              x-title-plural: Real Time Payments Transfer Acknowledgements
            sample_funds:
              description: A Sample Funds object. This field will be present in the JSON response if and only if `category` is equal to `sample_funds`.
              example:
                originator: dashboard
              nullable: true
              properties:
                originator:
                  description: Where the sample funds came from.
                  type: string
              required:
                - originator
              title: Sample Funds
              type: object
              x-title-plural: Sample Fundss
            wire_drawdown_payment_intention:
              description: A Wire Drawdown Payment Intention object. This field will be present in the JSON response if and only if `category` is equal to `wire_drawdown_payment_intention`.
              example:
                account_number: "987654321"
                amount: 100
                message_to_recipient: HELLO
                routing_number: "101050001"
                transfer_id: wire_transfer_5akynk7dqsq25qwk9q2u
              nullable: true
              properties:
                account_number:
                  description: ""
                  type: string
                amount:
                  description: The transfer amount in USD cents.
                  type: integer
                message_to_recipient:
                  description: ""
                  type: string
                routing_number:
                  description: ""
                  type: string
                transfer_id:
                  description: ""
                  type: string
              required:
                - amount
                - account_number
                - routing_number
                - message_to_recipient
                - transfer_id
              title: Wire Drawdown Payment Intention
              type: object
              x-title-plural: Wire Drawdown Payment Intentions
            wire_drawdown_payment_rejection:
              description: A Wire Drawdown Payment Rejection object. This field will be present in the JSON response if and only if `category` is equal to `wire_drawdown_payment_rejection`.
              example:
                transfer_id: wire_transfer_5akynk7dqsq25qwk9q2u
              nullable: true
              properties:
                transfer_id:
                  description: ""
                  type: string
              required:
                - transfer_id
              title: Wire Drawdown Payment Rejection
              type: object
              x-title-plural: Wire Drawdown Payment Rejections
            wire_transfer_intention:
              description: A Wire Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_intention`.
              example:
                account_number: "987654321"
                amount: 100
                message_to_recipient: HELLO
                routing_number: "101050001"
                transfer_id: wire_transfer_5akynk7dqsq25qwk9q2u
              nullable: true
              properties:
                account_number:
                  description: The destination account number.
                  type: string
                amount:
                  description: The transfer amount in USD cents.
                  type: integer
                message_to_recipient:
                  description: The message that will show on the recipient's bank statement.
                  type: string
                routing_number:
                  description: The American Bankers' Association (ABA) Routing Transit Number (RTN).
                  type: string
                transfer_id:
                  description: ""
                  type: string
              required:
                - amount
                - account_number
                - routing_number
                - message_to_recipient
                - transfer_id
              title: Wire Transfer Intention
              type: object
              x-title-plural: Wire Transfer Intentions
            wire_transfer_rejection:
              description: A Wire Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_rejection`.
              example:
                transfer_id: wire_transfer_5akynk7dqsq25qwk9q2u
              nullable: true
              properties:
                transfer_id:
                  description: ""
                  type: string
              required:
                - transfer_id
              title: Wire Transfer Rejection
              type: object
              x-title-plural: Wire Transfer Rejections
          required:
            - category
            - account_transfer_intention
            - ach_check_conversion_return
            - ach_check_conversion
            - ach_transfer_intention
            - ach_transfer_rejection
            - ach_transfer_return
            - card_dispute_acceptance
            - card_refund
            - card_settlement
            - card_revenue_payment
            - check_deposit_acceptance
            - check_deposit_return
            - check_transfer_intention
            - check_transfer_return
            - check_transfer_rejection
            - check_transfer_stop_payment_request
            - dispute_resolution
            - empyreal_cash_deposit
            - fee_payment
            - inbound_ach_transfer
            - inbound_check
            - inbound_international_ach_transfer
            - inbound_real_time_payments_transfer_confirmation
            - inbound_wire_drawdown_payment_reversal
            - inbound_wire_drawdown_payment
            - inbound_wire_reversal
            - inbound_wire_transfer
            - interest_payment
            - internal_source
            - card_route_refund
            - card_route_settlement
            - real_time_payments_transfer_acknowledgement
            - sample_funds
            - wire_drawdown_payment_intention
            - wire_drawdown_payment_rejection
            - wire_transfer_intention
            - wire_transfer_rejection
          title: Transaction Source
          type: object
          x-title-plural: Transaction Sources
        type:
          description: A constant representing the object's type. For this resource it will always be `transaction`.
          enum:
            - transaction
          type: string
      required:
        - account_id
        - amount
        - currency
        - created_at
        - description
        - id
        - route_id
        - route_type
        - source
        - type
      title: Transaction
      type: object
      x-tag: Transactions
      x-title-plural: Transactions
    transaction_list:
      description: A list of Transaction objects
      example:
        data:
          - account_id: account_in71c4amph0vgo2qllky
            amount: 100
            created_at: 2020-01-31T23:59:59Z
            currency: USD
            description: Frederick S. Holmes
            id: transaction_uyrp7fld2ium70oa7oi
            route_id: account_number_v18nkfqm6afpsrvy82b2
            route_type: account_number
            source:
              category: inbound_ach_transfer
              inbound_ach_transfer:
                amount: 100
                originator_company_descriptive_date: null
                originator_company_discretionary_data: null
                originator_company_entry_description: RESERVE
                originator_company_id: "0987654321"
                originator_company_name: BIG BANK
                receiver_id_number: "12345678900"
                receiver_name: IAN CREASE
                trace_number: "021000038461022"
            type: transaction
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/transaction"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: Transaction List
      type: object
      x-title-plural: Transaction Lists
    update_a_card_parameters:
      example:
        description: New description
      properties:
        billing_address:
          description: The card's updated billing address.
          properties:
            city:
              description: The city of the billing address.
              maxLength: 200
              minLength: 1
              type: string
            line1:
              description: The first line of the billing address.
              maxLength: 200
              minLength: 1
              type: string
            line2:
              description: The second line of the billing address.
              maxLength: 200
              minLength: 1
              type: string
            postal_code:
              description: The postal code of the billing address.
              maxLength: 200
              minLength: 1
              type: string
            state:
              description: The US state of the billing address.
              maxLength: 200
              minLength: 1
              type: string
          required:
            - line1
            - city
            - state
            - postal_code
          type: object
        description:
          description: The description you choose to give the card.
          maxLength: 200
          minLength: 1
          type: string
        digital_wallet:
          description: The contact information used in the two-factor steps for digital wallet card creation. At least one field must be present to complete the digital wallet steps.
          properties:
            card_profile_id:
              description: The card profile assigned to this digital card. Card profiles may also be assigned at the program level.
              type: string
            email:
              description: An email address that can be used to verify the cardholder via one-time passcode over email.
              maxLength: 200
              minLength: 1
              type: string
            phone:
              description: A phone number that can be used to verify the cardholder via one-time passcode over SMS.
              maxLength: 200
              minLength: 1
              type: string
          type: object
        status:
          description: The status to update the Card with.
          enum:
            - active
            - disabled
            - canceled
          type: string
          x-enum-descriptions:
            - The card is active.
            - The card is temporarily disabled.
            - The card is temporarily canceled.
      type: object
    update_a_limit_parameters:
      example:
        status: inactive
      properties:
        status:
          description: The status to update the limit with.
          enum:
            - inactive
            - active
          type: string
          x-enum-descriptions:
            - Disable the limit temporarily.
            - Activate the limit.
      required:
        - status
      type: object
    update_an_account_number_parameters:
      example:
        status: disabled
      properties:
        name:
          description: The name you choose for the Account Number.
          maxLength: 200
          minLength: 1
          type: string
        status:
          description: This indicates if transfers can be made to the Account Number.
          enum:
            - active
            - disabled
            - canceled
          type: string
          x-enum-descriptions:
            - The account number is active.
            - The account number is temporarily disabled.
            - The account number is permanently disabled.
      type: object
    update_an_account_parameters:
      example:
        name: My renamed account
      properties:
        name:
          description: The new name of the Account.
          maxLength: 200
          minLength: 1
          type: string
      type: object
    update_an_event_subscription_parameters:
      example: {}
      properties:
        status:
          description: The status to update the Event Subscription with.
          enum:
            - active
            - disabled
            - deleted
          type: string
          x-enum-descriptions:
            - The subscription is active and Events will be delivered normally.
            - The subscription is temporarily disabled and Events will not be delivered.
            - The subscription is permanently disabled and Events will not be delivered.
      type: object
    update_an_external_account_parameters:
      example:
        description: New description
      properties:
        description:
          description: The description you choose to give the external account.
          maxLength: 200
          minLength: 1
          type: string
        status:
          description: The status of the External Account.
          enum:
            - active
            - archived
          type: string
          x-enum-descriptions:
            - The External Acccount is active.
            - The External Account is archived and won't appear in the dashboard.
      type: object
    wire_drawdown_request:
      description: Wire drawdown requests enable you to request that someone else send you a wire. This feature is in beta; reach out to [support@increase.com](mailto:support@increase.com) to learn more.
      example:
        account_number_id: account_number_v18nkfqm6afpsrvy82b2
        amount: 10000
        currency: USD
        fulfillment_transaction_id: transaction_uyrp7fld2ium70oa7oi
        id: wire_drawdown_request_q6lmocus3glo0lr2bfv3
        message_to_recipient: Invoice 29582
        recipient_account_number: "987654321"
        recipient_address_line1: 33 Liberty Street
        recipient_address_line2: New York, NY, 10045
        recipient_address_line3: null
        recipient_name: Ian Crease
        recipient_routing_number: "101050001"
        status: fulfilled
        submission:
          input_message_accountability_data: 20220118MMQFMP0P000003
        type: wire_drawdown_request
      properties:
        account_number_id:
          description: The Account Number to which the recipient of this request is being requested to send funds.
          type: string
        amount:
          description: The amount being requested in cents.
          type: integer
        currency:
          description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being requested. Will always be "USD".
          type: string
        fulfillment_transaction_id:
          description: If the recipient fulfills the drawdown request by sending funds, then this will be the identifier of the corresponding Transaction.
          nullable: true
          type: string
        id:
          description: The Wire drawdown request identifier.
          type: string
        message_to_recipient:
          description: The message the recipient will see as part of the drawdown request.
          type: string
        recipient_account_number:
          description: The drawdown request's recipient's account number.
          type: string
        recipient_address_line1:
          description: Line 1 of the drawdown request's recipient's address.
          nullable: true
          type: string
        recipient_address_line2:
          description: Line 2 of the drawdown request's recipient's address.
          nullable: true
          type: string
        recipient_address_line3:
          description: Line 3 of the drawdown request's recipient's address.
          nullable: true
          type: string
        recipient_name:
          description: The drawdown request's recipient's name.
          nullable: true
          type: string
        recipient_routing_number:
          description: The drawdown request's recipient's routing number.
          type: string
        status:
          description: The lifecycle status of the drawdown request.
          enum:
            - pending_submission
            - pending_response
            - fulfilled
            - refused
          type: string
          x-enum-descriptions:
            - The drawdown request is queued to be submitted to Fedwire.
            - The drawdown request has been sent and the recipient should respond in some way.
            - The drawdown request has been fulfilled by the recipient.
            - The drawdown request has been refused by the recipient.
        submission:
          description: After the drawdown request is submitted to Fedwire, this will contain supplemental details.
          example:
            input_message_accountability_data: 20220118MMQFMP0P000003
          nullable: true
          properties:
            input_message_accountability_data:
              description: The input message accountability data (IMAD) uniquely identifying the submission with Fedwire.
              type: string
          required:
            - input_message_accountability_data
          title: Wire Drawdown Request Submission
          type: object
          x-title-plural: Wire Drawdown Request Submissions
        type:
          description: A constant representing the object's type. For this resource it will always be `wire_drawdown_request`.
          enum:
            - wire_drawdown_request
          type: string
      required:
        - type
        - id
        - account_number_id
        - recipient_account_number
        - recipient_routing_number
        - amount
        - currency
        - message_to_recipient
        - recipient_name
        - recipient_address_line1
        - recipient_address_line2
        - recipient_address_line3
        - submission
        - fulfillment_transaction_id
        - status
      title: Wire Drawdown Request
      type: object
      x-tag: Wire Drawdown Requests
      x-title-plural: Wire Drawdown Requests
    wire_drawdown_request_list:
      description: A list of Wire Drawdown Request objects
      example:
        data:
          - account_number_id: account_number_v18nkfqm6afpsrvy82b2
            amount: 10000
            currency: USD
            fulfillment_transaction_id: transaction_uyrp7fld2ium70oa7oi
            id: wire_drawdown_request_q6lmocus3glo0lr2bfv3
            message_to_recipient: Invoice 29582
            recipient_account_number: "987654321"
            recipient_address_line1: 33 Liberty Street
            recipient_address_line2: New York, NY, 10045
            recipient_address_line3: null
            recipient_name: Ian Crease
            recipient_routing_number: "101050001"
            status: fulfilled
            submission:
              input_message_accountability_data: 20220118MMQFMP0P000003
            type: wire_drawdown_request
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/wire_drawdown_request"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: Wire Drawdown Request List
      type: object
      x-title-plural: Wire Drawdown Request Lists
    wire_transfer:
      description: Wire transfers move funds between your Increase account and any other account accessible by Fedwire.
      example:
        account_id: account_in71c4amph0vgo2qllky
        account_number: "987654321"
        amount: 100
        approval:
          approved_at: 2020-01-31T23:59:59Z
          approved_by: null
        beneficiary_address_line1: null
        beneficiary_address_line2: null
        beneficiary_address_line3: null
        beneficiary_financial_institution_address_line1: null
        beneficiary_financial_institution_address_line2: null
        beneficiary_financial_institution_address_line3: null
        beneficiary_financial_institution_identifier: null
        beneficiary_financial_institution_identifier_type: null
        beneficiary_financial_institution_name: null
        beneficiary_name: null
        cancellation: null
        created_at: 2020-01-31T23:59:59Z
        currency: USD
        external_account_id: external_account_ukk55lr923a3ac0pp7iv
        id: wire_transfer_5akynk7dqsq25qwk9q2u
        message_to_recipient: Message to recipient
        network: wire
        reversal: null
        routing_number: "101050001"
        status: complete
        submission: null
        transaction_id: transaction_uyrp7fld2ium70oa7oi
        type: wire_transfer
      properties:
        account_id:
          description: The Account to which the transfer belongs.
          type: string
        account_number:
          description: The destination account number.
          type: string
        amount:
          description: The transfer amount in USD cents.
          type: integer
        approval:
          description: If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.
          example:
            approved_at: 2020-01-31T23:59:59Z
            approved_by: null
          nullable: true
          properties:
            approved_at:
              description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was approved.
              format: date-time
              type: string
            approved_by:
              description: If the Transfer was approved by a user in the dashboard, the email address of that user.
              nullable: true
              type: string
          required:
            - approved_at
            - approved_by
          title: Transfer Approval
          type: object
          x-title-plural: Transfer Approvals
        beneficiary_address_line1:
          description: The beneficiary's address line 1.
          nullable: true
          type: string
        beneficiary_address_line2:
          description: The beneficiary's address line 2.
          nullable: true
          type: string
        beneficiary_address_line3:
          description: The beneficiary's address line 3.
          nullable: true
          type: string
        beneficiary_name:
          description: The beneficiary's name.
          nullable: true
          type: string
        cancellation:
          description: If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.
          example:
            canceled_at: 2020-01-31T23:59:59Z
            canceled_by: null
          nullable: true
          properties:
            canceled_at:
              description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Transfer was canceled.
              format: date-time
              type: string
            canceled_by:
              description: If the Transfer was canceled by a user in the dashboard, the email address of that user.
              nullable: true
              type: string
          required:
            - canceled_at
            - canceled_by
          title: Transfer Cancellation
          type: object
          x-title-plural: Transfer Cancellations
        created_at:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.
          format: date-time
          type: string
        currency:
          description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's currency. For wire transfers this is always equal to `usd`.
          enum:
            - CAD
            - CHF
            - EUR
            - GBP
            - JPY
            - USD
          type: string
          x-enum-descriptions:
            - Canadian Dollar (CAD)
            - Swiss Franc (CHF)
            - Euro (EUR)
            - British Pound (GBP)
            - Japanese Yen (JPY)
            - US Dollar (USD)
        external_account_id:
          description: The identifier of the External Account the transfer was made to, if any.
          nullable: true
          type: string
        id:
          description: The wire transfer's identifier.
          type: string
        message_to_recipient:
          description: The message that will show on the recipient's bank statement.
          nullable: true
          type: string
        network:
          description: The transfer's network.
          enum:
            - wire
          type: string
        reversal:
          description: If your transfer is reversed, this will contain details of the reversal.
          example:
            amount: 12345
            created_at: 2020-01-31T23:59:59Z
            description: Inbound wire reversal 2022021100335128
            financial_institution_to_financial_institution_information: null
            input_cycle_date: 2022-02-11
            input_message_accountability_data: 20220211B6B7HU2R011023
            input_sequence_number: "11023"
            input_source: B6B7HU2R
            previous_message_input_cycle_date: 2022-02-10
            previous_message_input_message_accountability_data: 20220210MMQFMP0P000007
            previous_message_input_sequence_number: "3"
            previous_message_input_source: MMQFMP0P
            receiver_financial_institution_information: null
            transaction_id: transaction_uyrp7fld2ium70oa7oi
          nullable: true
          properties:
            amount:
              description: The amount that was reversed.
              type: integer
            created_at:
              description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the reversal was created.
              format: date-time
              type: string
            description:
              description: The description on the reversal message from Fedwire.
              type: string
            financial_institution_to_financial_institution_information:
              description: Additional financial institution information included in the wire reversal.
              nullable: true
              type: string
            input_cycle_date:
              description: The Fedwire cycle date for the wire reversal.
              format: date
              type: string
            input_message_accountability_data:
              description: The Fedwire transaction identifier.
              type: string
            input_sequence_number:
              description: The Fedwire sequence number.
              type: string
            input_source:
              description: The Fedwire input source identifier.
              type: string
            previous_message_input_cycle_date:
              description: The Fedwire cycle date for the wire transfer that was reversed.
              format: date
              type: string
            previous_message_input_message_accountability_data:
              description: The Fedwire transaction identifier for the wire transfer that was reversed.
              type: string
            previous_message_input_sequence_number:
              description: The Fedwire sequence number for the wire transfer that was reversed.
              type: string
            previous_message_input_source:
              description: The Fedwire input source identifier for the wire transfer that was reversed.
              type: string
            receiver_financial_institution_information:
              description: Information included in the wire reversal for the receiving financial institution.
              nullable: true
              type: string
            transaction_id:
              description: The ID for the Transaction associated with the transfer reversal.
              nullable: true
              type: string
          required:
            - amount
            - created_at
            - description
            - input_cycle_date
            - input_sequence_number
            - input_source
            - input_message_accountability_data
            - previous_message_input_message_accountability_data
            - previous_message_input_cycle_date
            - previous_message_input_sequence_number
            - previous_message_input_source
            - receiver_financial_institution_information
            - financial_institution_to_financial_institution_information
            - transaction_id
          title: Inbound Wire Reversal
          type: object
          x-title-plural: Inbound Wire Reversals
        routing_number:
          description: The American Bankers' Association (ABA) Routing Transit Number (RTN).
          type: string
        status:
          description: The lifecycle status of the transfer.
          enum:
            - canceled
            - requires_attention
            - pending_approval
            - rejected
            - reversed
            - complete
            - pending_creating
          type: string
          x-enum-descriptions:
            - The transfer has been canceled.
            - The transfer requires your attention.
            - The transfer is pending approval.
            - The transfer has been rejected.
            - The transfer has been reversed.
            - The transfer is complete.
            - The transfer is pending creation.
        submission:
          description: After the transfer is submitted to Fedwire, this will contain supplemental details.
          example:
            input_message_accountability_data: 20220118MMQFMP0P000002
            submitted_at: 2020-01-31T23:59:59Z
          nullable: true
          properties:
            input_message_accountability_data:
              description: The accountability data for the submission.
              type: string
            submitted_at:
              description: When this wire transfer was submitted to Fedwire.
              format: date-time
              type: string
          required:
            - input_message_accountability_data
            - submitted_at
          title: Wire Transfer Submission
          type: object
          x-title-plural: Wire Transfer Submissions
        transaction_id:
          description: The ID for the transaction funding the transfer.
          nullable: true
          type: string
        type:
          description: A constant representing the object's type. For this resource it will always be `wire_transfer`.
          enum:
            - wire_transfer
          type: string
      required:
        - id
        - message_to_recipient
        - amount
        - currency
        - account_number
        - beneficiary_name
        - beneficiary_address_line1
        - beneficiary_address_line2
        - beneficiary_address_line3
        - account_id
        - external_account_id
        - routing_number
        - approval
        - cancellation
        - reversal
        - created_at
        - network
        - status
        - submission
        - transaction_id
        - type
      title: Wire Transfer
      type: object
      x-tag: Wire Transfers
      x-title-plural: Wire Transfers
    wire_transfer_list:
      description: A list of Wire Transfer objects
      example:
        data:
          - account_id: account_in71c4amph0vgo2qllky
            account_number: "987654321"
            amount: 100
            approval:
              approved_at: 2020-01-31T23:59:59Z
              approved_by: null
            beneficiary_address_line1: null
            beneficiary_address_line2: null
            beneficiary_address_line3: null
            beneficiary_financial_institution_address_line1: null
            beneficiary_financial_institution_address_line2: null
            beneficiary_financial_institution_address_line3: null
            beneficiary_financial_institution_identifier: null
            beneficiary_financial_institution_identifier_type: null
            beneficiary_financial_institution_name: null
            beneficiary_name: null
            cancellation: null
            created_at: 2020-01-31T23:59:59Z
            currency: USD
            external_account_id: external_account_ukk55lr923a3ac0pp7iv
            id: wire_transfer_5akynk7dqsq25qwk9q2u
            message_to_recipient: Message to recipient
            network: wire
            reversal: null
            routing_number: "101050001"
            status: complete
            submission: null
            transaction_id: transaction_uyrp7fld2ium70oa7oi
            type: wire_transfer
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: "#/components/schemas/wire_transfer"
          type: array
        next_cursor:
          description: A pointer to a place in the list.
          nullable: true
          type: string
      required:
        - data
        - next_cursor
      title: Wire Transfer List
      type: object
      x-title-plural: Wire Transfer Lists
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http
