Ask Moov Beta
Generative AI is experimental and can make mistakes.
Guides Use cases API Changelog
  1. API reference
  2. Latest (beta)
  3. Money movement
  4. Sweeps

Create a sweep config

Create a sweep config for a wallet.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/wallets.write scope.

POST
/accounts/{accountID}/sweep-configs
cURL Go .NET Java Ruby TypeScript PHP Python 
curl -X POST "https://api.moov.io/accounts/{accountID}/sweep-configs" \
  -H 'Authorization: Bearer {token}' \
  --data-raw '{
    "walletID": "string",
    "status": "enabled",
    "pushPaymentMethodID": "string",
    "pullPaymentMethodID":"string",
    "minimumBalance": "150.00"
  }'\

mc, _ := moov.NewClient()

minBalance := "150.00"
mc.CreateSweepConfig(ctx, moov.CreateSweepConfig{
  AccountID:           "string",
  WalletID:            "string",
  Status:              moov.SweepConfigStatus_Enabled,
  PushPaymentMethodID: "string",
  PullPaymentMethodID: "string",
  MinimumBalance:      &minBalance,
})

using Moov.Sdk;
using Moov.Sdk.Models.Components;

var sdk = new MoovClient(xMoovVersion: "<value>");

var res = await sdk.Sweeps.CreateConfigAsync(
    accountID: "02c3d1d1-d847-4eb3-bef3-8caa32a5610b",
    body: new CreateSweepConfig() {
        WalletID = "01234567-89ab-cdef-0123-456789abcdef",
        Status = SweepConfigStatus.Enabled,
        PushPaymentMethodID = "01234567-89ab-cdef-0123-456789abcdef",
        PullPaymentMethodID = "01234567-89ab-cdef-0123-456789abcdef",
    }
);

// handle response
package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.*;
import io.moov.sdk.models.errors.CreateSweepConfigError;
import io.moov.sdk.models.errors.GenericError;
import io.moov.sdk.models.operations.CreateSweepConfigResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws GenericError, CreateSweepConfigError, Exception {

        Moov sdk = Moov.builder()
                .xMoovVersion("v2024.01.00")
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        CreateSweepConfigResponse res = sdk.sweeps().createConfig()
                .accountID("cd0ec32e-bd84-418c-90d3-fffbc5465f8b")
                .createSweepConfig(CreateSweepConfig.builder()
                    .walletID("01234567-89ab-cdef-0123-456789abcdef")
                    .status(SweepConfigStatus.ENABLED)
                    .pushPaymentMethodID("01234567-89ab-cdef-0123-456789abcdef")
                    .pullPaymentMethodID("01234567-89ab-cdef-0123-456789abcdef")
                    .build())
                .call();

        if (res.sweepConfig().isPresent()) {
            // handle response
        }
    }
}
require 'moov_ruby'

Models = ::Moov::Models
s = ::Moov::Client.new(
      x_moov_version: 'v2024.01.00',
    )

res = s.sweeps.create_config(account_id: '02c3d1d1-d847-4eb3-bef3-8caa32a5610b', create_sweep_config: Models::Components::CreateSweepConfig.new(
  wallet_id: '01234567-89ab-cdef-0123-456789abcdef',
  status: Models::Components::SweepConfigStatus::ENABLED,
  push_payment_method_id: '01234567-89ab-cdef-0123-456789abcdef',
  pull_payment_method_id: '01234567-89ab-cdef-0123-456789abcdef',
))

unless res.sweep_config.nil?
  # handle response
end
import { Moov } from "@moovio/sdk";

const moov = new Moov({
  xMoovVersion: "v2024.01.00",
  security: {
    username: "",
    password: "",
  },
});

async function run() {
  const result = await moov.sweeps.createConfig({
    accountID: "cd0ec32e-bd84-418c-90d3-fffbc5465f8b",
    createSweepConfig: {
      walletID: "01234567-89ab-cdef-0123-456789abcdef",
      status: "enabled",
      pushPaymentMethodID: "01234567-89ab-cdef-0123-456789abcdef",
      pullPaymentMethodID: "01234567-89ab-cdef-0123-456789abcdef",
    },
  });

  console.log(result);
}

run();
declare(strict_types=1);

require 'vendor/autoload.php';

use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;

$sdk = MoovPhp\Moov::builder()
    ->setXMoovVersion('v2024.01.00')
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$createSweepConfig = new Components\CreateSweepConfig(
    walletID: '01234567-89ab-cdef-0123-456789abcdef',
    status: Components\SweepConfigStatus::Enabled,
    pushPaymentMethodID: '01234567-89ab-cdef-0123-456789abcdef',
    pullPaymentMethodID: '01234567-89ab-cdef-0123-456789abcdef',
);

$response = $sdk->sweeps->createConfig(
    accountID: 'cd0ec32e-bd84-418c-90d3-fffbc5465f8b',
    createSweepConfig: $createSweepConfig

);

if ($response->sweepConfig !== null) {
    // handle response
}
from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    x_moov_version="v2024.01.00",
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.sweeps.create_config(account_id="cd0ec32e-bd84-418c-90d3-fffbc5465f8b", wallet_id="01234567-89ab-cdef-0123-456789abcdef", status=components.SweepConfigStatus.ENABLED, push_payment_method_id="01234567-89ab-cdef-0123-456789abcdef", pull_payment_method_id="01234567-89ab-cdef-0123-456789abcdef")

    # Handle response
    print(res)
200 400 401 403 404 409 422 429 500 504
The request completed successfully.
application/json
Example
{
  "sweepConfigID": "string",
  "walletID": "string",
  "status": "enabled",
  "pushPaymentMethod": {
    "paymentMethodID": "string",
    "disabledOn": "2019-08-24T14:15:22Z"
  },
  "pullPaymentMethod": {
    "paymentMethodID": "string",
    "disabledOn": "2019-08-24T14:15:22Z"
  },
  "minimumBalance": "string",
  "statementDescriptor": "string",
  "lockedFields": [
    "string"
  ],
  "createdOn": "2019-08-24T14:15:22Z",
  "updatedOn": "2019-08-24T14:15:22Z"
}

Response headers

x-request-id

string required
A unique identifier used to trace requests.
The server could not understand the request due to invalid syntax.
application/json
Example
{
  "error": "string"
}

Response headers

x-request-id

string required
A unique identifier used to trace requests.
The request contained missing or expired authentication.

Response headers

x-request-id

string required
A unique identifier used to trace requests.
The user is not authorized to make the request.

Response headers

x-request-id

string required
A unique identifier used to trace requests.
The requested resource was not found.

Response headers

x-request-id

string required
A unique identifier used to trace requests.
The request conflicted with the current state of the target resource.
application/json
Example
{
  "error": "string"
}

Response headers

x-request-id

string required
A unique identifier used to trace requests.
The request was well-formed, but the contents failed validation. Check the request for missing or invalid fields.
application/json
Example
{
  "walletID": "string",
  "status": "string",
  "pushPaymentMethodID": "string",
  "pullPaymentMethodID": "string",
  "statementDescriptor": "string",
  "minimumBalance": "string"
}

Response headers

x-request-id

string required
A unique identifier used to trace requests.
Request was refused due to rate limiting.

Response headers

x-request-id

string required
A unique identifier used to trace requests.
The request failed due to an unexpected error.

Response headers

x-request-id

string required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.

Response headers

x-request-id

string required
A unique identifier used to trace requests.

Headers

X-Moov-Version

string

Specify an API version.

API versioning follows the format vYYYY.QQ.BB, where

  • YYYY is the year
  • QQ is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
  • BB is the build number, starting at .01, for subsequent builds in the same quarter.
    • For example, v2024.01.00 is the initial release of the first quarter of 2024.

The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release. When no version is specified, the API defaults to v2024.01.00.

Path parameters

accountID

string required

Body

application/json

pullPaymentMethodID

string required
ID of the payment method.

pushPaymentMethodID

string required
ID of the payment method.

status

string<enum> required
Possible values: enabled, disabled

walletID

string required

minimumBalance

string Pattern

statementDescriptor

string [4 to 10] characters
The text that appears on the banking statement. The default descriptor is a 10 character ID if an override is not set in the sweep configs statementDescriptor.

Response

application/json

createdOn

string<date-time> required

pullPaymentMethod

object required
The payment method used to push or pull funds to a bank account. The push payment method can only be ach-credit-standard, ach-credit-same-day, or rtp-credit. The pull payment method can only be ach-debit-fund.
Show child attributes

pushPaymentMethod

object required
The payment method used to push or pull funds to a bank account. The push payment method can only be ach-credit-standard, ach-credit-same-day, or rtp-credit. The pull payment method can only be ach-debit-fund.
Show child attributes

paymentMethodID

string required
ID of the payment method.

disabledOn

string<date-time>

status

string<enum> required
Possible values: enabled, disabled

sweepConfigID

string required

updatedOn

string<date-time> required

walletID

string required

lockedFields

array<string>
An array of fields that are locked. To request updates, please contact Moov support.

minimumBalance

string Pattern
An optional field to specify an amount to maintain in the wallet. This is a decimal-formatted numerical string that represents up to 2 decimal place precision. In USD for example, 12.34 is $12.34 and 0.99 is $0.99. If not supplied, the default is 0.00.

statementDescriptor

string [4 to 10] characters
The text that appears on the banking statement. The default descriptor is a 10 character ID if an override is not set in the sweep configs statementDescriptor.