Moov

Moov Sweeps API

Configure automatic daily transfers from a Moov wallet to an external bank account on a set schedule using ACH or RTP rails.

GitHub OpenAPI

Operations 6

POST /accounts/{accountID}/sweep-configs Create a sweep config #
GET /accounts/{accountID}/sweep-configs List sweep configs #
GET /accounts/{accountID}/sweep-configs/{sweepConfigID} Get a sweep config #
PATCH /accounts/{accountID}/sweep-configs/{sweepConfigID} Update a sweep config #
GET /accounts/{accountID}/wallets/{walletID}/sweeps List sweeps #
GET /accounts/{accountID}/wallets/{walletID}/sweeps/{sweepID} Get a sweep #

Documentation

📖
Documentation
https://docs.moov.io/api/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/moov/refs/heads/main/openapi/moov-sweeps-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/moov/refs/heads/main/asyncapi/moov-webhooks-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/moov/refs/heads/main/json-schema/moov-account-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/moov/refs/heads/main/json-schema/moov-transfer-schema.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/moov/refs/heads/main/json-ld/moov-context.jsonld

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/moov-sweeps-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

moov-sweeps-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Moov Sweeps API
  termsOfService: https://moov.io/legal/platform-agreement/
  version: '1.0'
  description: 'Operations tagged Sweeps across 2 of this provider''s published API definitions: moov-api-openapi.yml, moov-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.moov.io
  description: Production Server
security:
- bearerAuth: []
tags:
- name: Sweeps
  description: Configure automatic daily transfers from a Moov wallet to an external bank account on a set schedule using ACH or RTP rails.
paths:
  /accounts/{accountID}/sweep-configs:
    post:
      operationId: createSweepConfig
      summary: Create a sweep config
      description: Configure automatic daily transfers from a Moov wallet to a linked bank account. Choose from standard ACH, same-day ACH, or RTP rails with varying settlement times from instant to next business day.
      tags:
      - Sweeps
      parameters:
      - $ref: '#/components/parameters/AccountIDParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSweepConfigRequest'
      responses:
        '200':
          description: Sweep config created successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SweepConfig'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
    get:
      operationId: listSweepConfigs
      summary: List sweep configs
      description: Retrieve all sweep configurations for a Moov account.
      tags:
      - Sweeps
      parameters:
      - $ref: '#/components/parameters/AccountIDParam'
      responses:
        '200':
          description: Sweep configs returned successfully.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/SweepConfig'
        '401':
          $ref: '#/components/responses/Unauthorized'
    parameters:
    - $ref: '#/components/parameters/accountID'
    servers:
    - url: https://api.moov.io
      description: Production Server
  /accounts/{accountID}/sweep-configs/{sweepConfigID}:
    get:
      operationId: getSweepConfig
      summary: Get a sweep config
      description: Retrieve the details of a specific sweep configuration for a Moov account.
      tags:
      - Sweeps
      parameters:
      - $ref: '#/components/parameters/AccountIDParam'
      - $ref: '#/components/parameters/SweepConfigIDParam'
      responses:
        '200':
          description: Sweep config returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SweepConfig'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    patch:
      operationId: updateSweepConfig
      summary: Update a sweep config
      description: Modify an existing sweep configuration, such as changing the target bank account, transfer rail, or schedule parameters.
      tags:
      - Sweeps
      parameters:
      - $ref: '#/components/parameters/AccountIDParam'
      - $ref: '#/components/parameters/SweepConfigIDParam'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateSweepConfigRequest'
      responses:
        '200':
          description: Sweep config updated successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SweepConfig'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    parameters:
    - $ref: '#/components/parameters/accountID'
    - name: sweepConfigID
      in: path
      required: true
      schema:
        type: string
    servers:
    - url: https://api.moov.io
      description: Production Server
  /accounts/{accountID}/wallets/{walletID}/sweeps:
    get:
      operationId: listSweeps
      summary: List sweeps
      description: Retrieve a list of sweep executions for a wallet, showing each automatic transfer that has been triggered by a sweep configuration.
      tags:
      - Sweeps
      parameters:
      - $ref: '#/components/parameters/AccountIDParam'
      - $ref: '#/components/parameters/WalletIDParam'
      responses:
        '200':
          description: Sweeps returned successfully.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Sweep'
        '401':
          $ref: '#/components/responses/Unauthorized'
    parameters:
    - $ref: '#/components/parameters/accountID'
    - $ref: '#/components/parameters/walletID'
    servers:
    - url: https://api.moov.io
      description: Production Server
  /accounts/{accountID}/wallets/{walletID}/sweeps/{sweepID}:
    get:
      operationId: getSweep
      summary: Get a sweep
      description: Fetch the details of a specific sweep execution, including its transfer amount, status, and associated transfer ID.
      tags:
      - Sweeps
      parameters:
      - $ref: '#/components/parameters/AccountIDParam'
      - $ref: '#/components/parameters/WalletIDParam'
      - name: sweepID
        in: path
        required: true
        description: Unique identifier for the sweep execution.
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Sweep details returned successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Sweep'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
    parameters:
    - $ref: '#/components/parameters/accountID'
    - $ref: '#/components/parameters/walletID'
    - name: sweepID
      in: path
      required: true
      schema:
        type: string
    servers:
    - url: https://api.moov.io
      description: Production Server
components:
  schemas:
    UpdateSweepConfigRequest:
      type: object
      description: Request body for updating a sweep configuration.
      properties:
        status:
          type: string
          description: Enable or disable the sweep configuration.
          enum:
          - enabled
          - disabled
        statementDescriptor:
          type: string
          description: Updated statement descriptor for sweep transfers.
          maxLength: 10
        minimumBalance:
          $ref: '#/components/schemas/Amount'
    Error:
      type: object
      description: Standard error response returned by the Moov API.
      properties:
        error:
          type: string
          description: Human-readable description of the error.
        code:
          type: string
          description: Machine-readable error code.
    Amount:
      type: object
      description: A monetary amount with currency denomination.
      properties:
        currency:
          type: string
          description: ISO 4217 three-letter currency code.
          default: USD
          minLength: 3
          maxLength: 3
        value:
          type: integer
          description: Amount in the smallest currency unit (e.g., cents for USD).
          minimum: 0
    Sweep:
      type: object
      description: A single execution of a sweep transfer triggered by a sweep configuration.
      properties:
        sweepID:
          type: string
          format: uuid
          description: Unique identifier for this sweep execution.
        sweepConfigID:
          type: string
          format: uuid
          description: The sweep configuration that triggered this sweep.
        walletID:
          type: string
          format: uuid
          description: The wallet from which funds were swept.
        transferID:
          type: string
          format: uuid
          description: The transfer created to move the swept funds.
        status:
          type: string
          description: Execution status of the sweep.
          enum:
          - scheduled
          - pending
          - completed
          - failed
        amount:
          $ref: '#/components/schemas/Amount'
        createdOn:
          type: string
          format: date-time
          description: ISO 8601 timestamp when the sweep was created.
    CreateSweepConfigRequest:
      type: object
      description: Request body for creating a sweep configuration.
      required:
      - walletID
      - paymentMethodID
      properties:
        walletID:
          type: string
          format: uuid
          description: The wallet from which funds will be swept.
        paymentMethodID:
          type: string
          format: uuid
          description: The bank account payment method to sweep funds to.
        statementDescriptor:
          type: string
          description: Descriptor that appears on bank statements for sweep transfers.
          maxLength: 10
        minimumBalance:
          $ref: '#/components/schemas/Amount'
    SweepConfig:
      type: object
      description: Configuration for automatic scheduled transfers from a Moov wallet to an external bank account. Sweeps execute daily based on the configured payment rail.
      properties:
        sweepConfigID:
          type: string
          format: uuid
          description: Unique identifier for the sweep configuration.
        walletID:
          type: string
          format: uuid
          description: The wallet from which funds will be swept.
        paymentMethodID:
          type: string
          format: uuid
          description: The destination bank account payment method for the sweep.
        status:
          type: string
          description: Whether the sweep configuration is active.
          enum:
          - enabled
          - disabled
        statementDescriptor:
          type: string
          description: Description that appears on bank statements for sweep transfers.
        minimumBalance:
          $ref: '#/components/schemas/Amount'
        createdOn:
          type: string
          format: date-time
          description: ISO 8601 timestamp when the sweep config was created.
        updatedOn:
          type: string
          format: date-time
          description: ISO 8601 timestamp when the sweep config was last updated.
  parameters:
    SweepConfigIDParam:
      name: sweepConfigID
      in: path
      required: true
      description: Unique identifier for the sweep configuration.
      schema:
        type: string
        format: uuid
    WalletIDParam:
      name: walletID
      in: path
      required: true
      description: Unique identifier for the wallet.
      schema:
        type: string
        format: uuid
    AccountIDParam:
      name: accountID
      in: path
      required: true
      description: Unique identifier for the Moov account.
      schema:
        type: string
        format: uuid
    walletID:
      name: walletID
      in: path
      required: true
      schema:
        type: string
        format: uuid
    accountID:
      name: accountID
      in: path
      required: true
      schema:
        type: string
        format: uuid
      description: The Moov account identifier.
  responses:
    BadRequest:
      description: The request was malformed or contained invalid parameters.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: The requested resource was not found.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication failed. Ensure a valid Bearer token is provided with the required scopes for this operation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: OAuth2 bearer token obtained from the /oauth2/token endpoint. Include in the Authorization header as "Bearer {token}".
x-refined-from:
- moov-api-openapi.yml
- moov-openapi.yml