List sweep configs
List sweep configs associated with an account.
To access this endpoint using an access token
you’ll need to specify the /accounts/{accountID}/wallets.read
scope.
GET
/accounts/{accountID}/sweep-configs
|
|
|
|
The request completed successfully.
[
{
"createdOn": "2019-08-24T14:15:22Z",
"disabledOn": "2019-08-24T14:15:22Z",
"lockedFields": [
"string"
],
"minimumBalance": "string",
"pullPaymentMethod": {
"disabledOn": "2019-08-24T14:15:22Z",
"paymentMethodID": "b7a60692-ab86-4eb0-b961-3bb4a714aa42"
},
"pushPaymentMethod": {
"disabledOn": "2019-08-24T14:15:22Z",
"paymentMethodID": "b7a60692-ab86-4eb0-b961-3bb4a714aa42"
},
"statementDescriptor": "string",
"status": "enabled",
"sweepConfigID": "057a9333-63c0-4907-bbc0-22e056aa6725",
"updatedOn": "2019-08-24T14:15:22Z",
"walletID": "0eb7d670-c252-422a-892d-002136c358e0"
}
]
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The request contained missing or expired authentication.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The user is not authorized to make the request.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
Request was refused due to rate limiting.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The request failed due to an unexpected error.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
Headers
x-moov-version
string
API version
Specify an API version.
API versioning follows the format vYYYY.QQ.BB
, where
YYYY
is the yearQQ
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.
- For example,
The latest
version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
Default:
v2024.01.00
Path parameters
accountID
string
<uuid>
required
Response
application/json
createdOn
string<date-time>
disabledOn
string<date-time>
lockedFields
array
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.
pullPaymentMethod
object
The payment method used to push or pull funds to a bank account.
The push payment method can only be ach-credit-standard or ach-credit-same-day. The pull payment method can only be ach-debit-fund.
Show child attributes
paymentMethodID
string<uuid>
required
ID of the payment method.
disabledOn
string<date-time>
pushPaymentMethod
object
The payment method used to push or pull funds to a bank account.
The push payment method can only be ach-credit-standard or ach-credit-same-day. The pull payment method can only be ach-debit-fund.
Show child attributes
paymentMethodID
string<uuid>
required
ID of the payment method.
disabledOn
string<date-time>
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.
status
string<enum>
Possible values:
enabled
,
disabled
sweepConfigID
string<uuid>
updatedOn
string<date-time>
walletID
string<uuid>