Increase Wire Transfers API

openapi: 3.1.0
info:
  description: Anything that you can achieve with PDFs, presence, and persistence in a bank branch you can do with our API. We've always wanted a fully programmatic bank so we built one. Our API faithfully exposes the data and capabilities of the Federal Reserve, Visa, The Clearing House, depository networks, and accounting tools. It's lovingly boring and exceptionally powerful. If you have any questions or want to get started, don't hesitate to ping us at sales@increase.com. We can't wait to see what you build!
  title: Increase Account Numbers Wire Transfers API
  version: 0.0.1
servers:
- url: https://api.increase.com
- url: https://sandbox.increase.com
security:
- bearerAuth: []
tags:
- description: Wire transfers move funds between your Increase account and any other account accessible by Fedwire.
  name: Wire Transfers
paths:
  /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
          x-documentation-priority: low
      - 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: 1
          type: integer
          x-documentation-priority: low
      - example: account_in71c4amph0vgo2qllky
        in: query
        name: account_id
        required: false
        schema:
          description: Filter Wire Transfers to those belonging to the specified Account.
          type: string
          x-documentation-priority: default
          x-id-reference-to: Accounts
      - in: query
        name: external_account_id
        required: false
        schema:
          description: Filter Wire Transfers to those made to the specified External Account.
          type: string
          x-documentation-priority: default
          x-id-reference-to: External Accounts
      - in: query
        name: idempotency_key
        required: false
        schema:
          description: Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys).
          maxLength: 200
          minLength: 1
          type: string
          x-documentation-priority: default
      - in: query
        name: status.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:
            - pending_approval
            - canceled
            - pending_reviewing
            - rejected
            - requires_attention
            - pending_creating
            - reversed
            - submitted
            - complete
            type: string
            x-enum-descriptions:
            - The transfer is pending approval.
            - The transfer has been canceled.
            - The transfer is pending review by Increase.
            - The transfer has been rejected by Increase.
            - The transfer requires attention from an Increase operator.
            - The transfer is pending creation.
            - The transfer has been reversed.
            - The transfer has been submitted to Fedwire.
            - The transfer has been acknowledged by Fedwire and can be considered complete.
          type: array
          x-documentation-priority: default
        explode: false
      - 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
          x-documentation-priority: low
      - 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
          x-documentation-priority: low
      - 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
          x-documentation-priority: low
      - 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
          x-documentation-priority: low
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/wire_transfer_list'
          description: Wire Transfer List
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: List Wire Transfers
      x-sandbox-only: false
      x-tag: Wire Transfers
      tags:
      - 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
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: Create a Wire Transfer
      x-sandbox-only: false
      x-tag: Wire Transfers
      tags:
      - 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
          x-documentation-priority: default
          x-id-reference-to: Wire Transfers
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/wire_transfer'
          description: Wire Transfer
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: Retrieve a Wire Transfer
      x-sandbox-only: false
      x-tag: Wire Transfers
      tags:
      - 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
          x-documentation-priority: default
          x-id-reference-to: Wire Transfers
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/wire_transfer'
          description: Wire Transfer
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: Approve a Wire Transfer
      x-sandbox-only: false
      x-tag: Wire Transfers
      tags:
      - 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
          x-documentation-priority: default
          x-id-reference-to: Wire Transfers
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/wire_transfer'
          description: Wire Transfer
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: Cancel a pending Wire Transfer
      x-sandbox-only: false
      x-tag: Wire Transfers
      tags:
      - Wire Transfers
components:
  schemas:
    error:
      anyOf:
      - properties:
          detail:
            anyOf:
            - type: string
            - type: 'null'
          status:
            enum:
            - 404
            type: integer
          title:
            type: string
          type:
            enum:
            - api_method_not_found_error
            type: string
        required:
        - type
        - title
        - detail
        - status
        type: object
        x-event-categories: []
      - properties:
          detail:
            anyOf:
            - type: string
            - type: 'null'
          status:
            enum:
            - 403
            type: integer
          title:
            type: string
          type:
            enum:
            - environment_mismatch_error
            type: string
        required:
        - type
        - title
        - detail
        - status
        type: object
        x-event-categories: []
      - properties:
          detail:
            anyOf:
            - type: string
            - type: 'null'
          resource_id:
            description: ''
            type: string
            x-documentation-priority: default
          status:
            enum:
            - 409
            type: integer
          title:
            type: string
          type:
            enum:
            - idempotency_key_already_used_error
            type: string
        required:
        - type
        - title
        - detail
        - status
        - resource_id
        type: object
        x-event-categories: []
      - properties:
          detail:
            anyOf:
            - type: string
            - type: 'null'
          status:
            enum:
            - 403
            type: integer
          title:
            type: string
          type:
            enum:
            - insufficient_permissions_error
            type: string
        required:
        - type
        - title
        - detail
        - status
        type: object
        x-event-categories: []
      - properties:
          detail:
            anyOf:
            - type: string
            - type: 'null'
          status:
            enum:
            - 500
            type: integer
          title:
            type: string
          type:
            enum:
            - internal_server_error
            type: string
        required:
        - type
        - title
        - detail
        - status
        type: object
        x-event-categories: []
      - properties:
          detail:
            anyOf:
            - type: string
            - type: 'null'
          reason:
            description: ''
            enum:
            - deleted_credential
            - expired_credential
            - ip_not_allowed
            - no_credential
            - no_header
            - no_api_access
            - wrong_environment
            type: string
            x-documentation-priority: default
            x-enum-descriptions:
            - deleted_credential
            - expired_credential
            - ip_not_allowed
            - no_credential
            - no_header
            - no_api_access
            - wrong_environment
          status:
            enum:
            - 401
            type: integer
          title:
            type: string
          type:
            enum:
            - invalid_api_key_error
            type: string
        required:
        - type
        - title
        - detail
        - status
        - reason
        type: object
        x-event-categories: []
      - properties:
          detail:
            anyOf:
            - type: string
            - type: 'null'
          status:
            enum:
            - 409
            type: integer
          title:
            type: string
          type:
            enum:
            - invalid_operation_error
            type: string
        required:
        - type
        - title
        - detail
        - status
        type: object
        x-event-categories: []
      - properties:
          detail:
            anyOf:
            - type: string
            - type: 'null'
          errors:
            description: All errors related to parsing the request parameters.
            items:
              additionalProperties: true
              properties: {}
              title: ErrorsElement
              type: object
              x-event-categories: []
              x-stainless-empty-object: false
              x-title-plural: ErrorsElements
            type: array
            x-documentation-priority: default
          status:
            enum:
            - 400
            type: integer
          title:
            type: string
          type:
            enum:
            - invalid_parameters_error
            type: string
        required:
        - type
        - title
        - detail
        - status
        - errors
        type: object
        x-event-categories: []
      - properties:
          detail:
            anyOf:
            - type: string
            - type: 'null'
          status:
            enum:
            - 400
            type: integer
          title:
            type: string
          type:
            enum:
            - malformed_request_error
            type: string
        required:
        - type
        - title
        - detail
        - status
        type: object
        x-event-categories: []
      - properties:
          detail:
            anyOf:
            - type: string
            - type: 'null'
          status:
            enum:
            - 404
            type: integer
          title:
            type: string
          type:
            enum:
            - object_not_found_error
            type: string
        required:
        - type
        - title
        - detail
        - status
        type: object
        x-event-categories: []
      - properties:
          detail:
            anyOf:
            - type: string
            - type: 'null'
          status:
            enum:
            - 403
            type: integer
          title:
            type: string
          type:
            enum:
            - private_feature_error
            type: string
        required:
        - type
        - title
        - detail
        - status
        type: object
        x-event-categories: []
      - properties:
          detail:
            anyOf:
            - type: string
            - type: 'null'
          retry_after:
            anyOf:
            - description: ''
              type: integer
              x-documentation-priority: default
            - type: 'null'
          status:
            enum:
            - 429
            type: integer
          title:
            type: string
          type:
            enum:
            - rate_limited_error
            type: string
        required:
        - type
        - title
        - detail
        - status
        type: object
        x-event-categories: []
    wire_transfer_list:
      additionalProperties: true
      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
          cancellation: null
          created_at: '2020-01-31T23:59:59Z'
          created_by:
            category: user
            user:
              email: user@example.com
          creditor:
            address:
              unstructured:
                line1: 33 Liberty Street
                line2: null
                line3: null
            name: National Phonograph Company
          currency: USD
          debtor: null
          external_account_id: external_account_ukk55lr923a3ac0pp7iv
          id: wire_transfer_5akynk7dqsq25qwk9q2u
          idempotency_key: null
          inbound_wire_drawdown_request_id: null
          network: wire
          pending_transaction_id: null
          remittance:
            category: unstructured
            unstructured:
              message: Invoice 29582
          reversal: null
          routing_number: '101050001'
          source_account_number_id: null
          status: complete
          submission: null
          transaction_id: transaction_uyrp7fld2ium70oa7oi
          type: wire_transfer
          unique_end_to_end_transaction_reference: null
        next_cursor: v57w5d
      properties:
        data:
          description: The contents of the list.
          items:
            $ref: '#/components/schemas/wire_transfer'
          type: array
          x-documentation-priority: default
        next_cursor:
          anyOf:
          - description: A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`.
            type: string
            x-documentation-priority: default
          - type: 'null'
      required:
      - data
      - next_cursor
      title: Wire Transfer List
      type: object
      x-event-categories: []
      x-stainless-empty-object: false
      x-title-plural: Wire Transfer Lists
    wire_transfer:
      additionalProperties: true
      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
        cancellation: null
        created_at: '2020-01-31T23:59:59Z'
        created_by:
          category: user
          user:
            email: user@example.com
        creditor:
          address:
            unstructured:
              line1: 33 Liberty Street
              line2: null
              line3: null
          name: National Phonograph Company
        currency: USD
        debtor: null
        external_account_id: external_account_ukk55lr923a3ac0pp7iv
        id: wire_transfer_5akynk7dqsq25qwk9q2u
        idempotency_key: null
        inbound_wire_drawdown_request_id: null
        network: wire
        pending_transaction_id: null
        remittance:
          category: unstructured
          unstructured:
            message: Invoice 29582
        reversal: null
        routing_number: '101050001'
        source_account_number_id: null
        status: complete
        submission: null
        transaction_id: transaction_uyrp7fld2ium70oa7oi
        type: wire_transfer
        unique_end_to_end_transaction_reference: null
      properties:
        account_id:
          description: The Account to which the transfer belongs.
          type: string
          x-documentation-priority: default
          x-id-reference-to: Accounts
        account_number:
          description: The destination account number.
          type: string
          x-documentation-priority: default
        amount:
          description: The transfer amount in USD cents.
          type: integer
          x-documentation-priority: default
        approval:
          anyOf:
          - additionalProperties: false
            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
            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
                x-documentation-priority: default
              approved_by:
                anyOf:
                - description: If the Transfer was approved by a user in the dashboard, the email address of that user.
                  type: string
                  x-documentation-priority: default
                - type: 'null'
            required:
            - approved_at
            - approved_by
            title: Wire Transfer Transfer Approval
            type: object
            x-documentation-priority: default
            x-event-categories: []
            x-stainless-empty-object: false
            x-title-plural: Transfer Approvals
          - type: 'null'
        cancellation:
          anyOf:
          - additionalProperties: false
            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
            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
                x-documentation-priority: default
              canceled_by:
                anyOf:
                - description: If the Transfer was canceled by a user in the dashboard, the email address of that user.
                  type: string
                  x-documentation-priority: default
                - type: 'null'
            required:
            - canceled_at
            - canceled_by
            title: Wire Transfer Transfer Cancellation
            type: object
            x-documentation-priority: default
            x-event-categories: []
            x-stainless-empty-object: false
            x-title-plural: Transfer Cancellations
          - type: 'null'
        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
          x-documentation-priority: default
        created_by:
          anyOf:
          - additionalProperties: false
            description: What object created the transfer, either via the API or the dashboard.
            example:
              category: user
              user:
                email: user@example.com
            properties:
              api_key:
                anyOf:
                - additionalProperties: false
                  description: If present, details about the API key that created the transfer.
                  properties:
                    description:
                      anyOf:
                      - description: The description set for the API key when it was created.
                        type: string
                        x-documentation-priority: default
                      - type: 'null'
                  required:
                  - description
                  title: Wire Transfer Transfer Creator ApiKey
                  type: object
                  x-documentation-priority: default
                  x-event-categories: []
                  x-stainless-empty-object: false
                  x-title-plural: ApiKeys
                - type: 'null'
              category:
                description: The type of object that created this transfer.
                enum:
                - api_key
                - oauth_application
                - user
                type: string
                x-documentation-priority: default
                x-enum-descriptions:
                - An API key. Details will be under the `api_key` object.
                - An OAuth application you connected to Increase. Details will be under the `oauth_application` object.
                - A User in the Increase dashboard. Details will be under the `user` object.
              oauth_application:
                anyOf:
                - additionalProperties: false
                  description: If present, details about the OAuth Application that created the transfer.
                  properties:
                    name:
                      description: The name of the OAuth Application.
                      type: string
                      x-documentation-priority: default
                  required:
                  - name
                  title: Wire Transfer Transfer Creator OAuthApplication
                  type: object
                  x-documentation-priority: default
                  x-event-categories: []
                  x-stainless-empty-object: false
                  x-title-plural: OAuthApplications
                - type: 'null'
              user:
                anyOf:
                - additionalProperties: false
                  description: If present, details about the User that created the transfer.
                  properties:
                    email:
                      description: The email address of the User.
                      type: string
                      x-documentation-priority: default
                  required:
                  - email
                  title: Wire Transfer Transfer Creator User
                  type: object
                  x-documentation-priority: default
                  x-event-categories: []
                  x-stainless-empty-object: false
                  x-title-plural: Users
                - type: 'null'
            required:
            - category
            title: Wire Transfer Transfer Creator
            type: object
            x-documentation-priority: default
            x-event-categories: []
            x-stainless-empty-object: false
            x-title-plural: Transfer Creators
          - type: 'null'
        creditor:
          anyOf:
          - additionalProperties: false
            description: The person or business that is receiving the funds from the transfer.
            properties:
              address:
                anyOf:
                - additionalProperties: false
                  description: The person or business's address.
                  properties:
                    unstructured:
                      anyOf:
                      - additionalProperties: false
                        description: Unstructured address lines.
                        properties:
                          line1:
                            anyOf:
                            - description: The first line.
                              type: string
                              x-documentation-priority: default
                            - type: 'null'
                          line2:
                            anyOf:
                            - description: The second line.
                              type: string
                              x-documentation-priority: default
                            - type: 'null'
                          line3:
                            anyOf:
                            - description: The third line.
                              type: string
                              x-documentation-priority: default
                            - type: 'null'
                        required:
                        - line1
                        - line2
                        - line3
                        title: Wire Transfer Party Address Unstructured
                        type: object
                        x-documentation-priority: default
                        x-event-categories: []
                        x-stainless-empty-object: false
                        x-title-plural: Unstructureds
                      - type: 'null'
                  required:
                  - unstructured
                  title: Wire Transfer Party Address
                  type: object
                  x-documentation-priority: default
                  x-event-categories: []
                  x-stainless-empty-object: false
                  x-title-plural: Addresses
                - type: 'null'
              name:
                anyOf:
                - description: The person or business's name.
                  type: string
                  x-documentation-priority: default
                - type: 'null'
            required:
            - name
            - address
            title: Wire Transfer Party
            type: object
            x-documentation-priority: default
            x-event-categories: []
            x-stainless-empty-object: false
            x-title-plural: Parties
          - type: 'null'
        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:
          - USD
          type: string
          x-documentation-priority: default
          x-enum-descriptions:
          - US Dollar (USD)
        debtor:
          anyOf:
          - additionalProperties: false
            description: The person or business whose funds are being transferred.
            properties:
              address:
                anyOf:
                - additionalProperties: false
                  description: The person or business's address.
                  properties:
                    unstructured:
                      anyOf:
                      - additionalProperties: false
                        description: Unstructured address lines.
                        properties:
                          line1:
                            anyOf:
                            - description: The first line.
                              type: string
                              x-documentation-priority: default
                            - type: 'null'
                          line2:
                            anyOf:
                            - description: The second line.
                              type: string
                              x-documentation-priority: default
                            - type: 'null'
                          line3:
                            anyOf:
                            - description: The third line.
                              type: string
                              x-documentation-priority: default
                            - type: 'null'
                        required:
                        - line1
                        - line2
                        - line3
                        title: Wire Transfer Party Address Unstructured
                        type: object
                        x-documentation-priority: default
                        x-event-categories: []
                        x-stainless-empty-object: false
                        x-title-plural: Unstructureds
                      - type: 'null'
                  required:
                  - unstructured
                  title: Wire Transfer Party Address
                  type: object
                  x-documentation-priority: default
                  x-event-categories: []
                  x-stainless-empty-object: false
                  x-title-plural: Addresses
                - type: 'null'
              name:
                anyOf:
                - description: The person or business's name.
                  type: string
                  x-documentation-priority: default
                - type: 'null'
            required:
            - name
            - address
            title: Wire Transfer Party
            type: object
            x-documentation-priority: default
            x-event-categories: []
            x-stainless-empty-object: false
            x-title-plural: Parties
          - type: 'null'
        external_account_id:
          anyOf:
          - description: The identifier of the External Account the transfer was made to, if any.
            type: string
            x-documentation-priority: default
            x-id-reference-to: External Accounts
          - type: 'null'
        id:
      

# --- truncated at 32 KB (57 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/increase/refs/heads/main/openapi/increase-wire-transfers-api-openapi.yml