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

List sweeps

List sweeps associated with a wallet.
GET
/accounts/{accountID}/wallets/{walletID}/sweeps
cURL Go 
1
2

curl -X GET "https://api.moov.io/accounts/{accountID}/wallets/{walletID}/sweeps" \
  -H "Authorization: Bearer {token}" \

1
2
3
4
5
6

mc, _ := moov.NewClient()

var accountID string
var walletID string

mc.ListSweeps(ctx, accountID, walletID)
200 429
List of sweeps.
[
  {
    "accrualEndedOn": "2019-08-24T14:15:22Z",
    "accrualStartedOn": "2019-08-24T14:15:22Z",
    "accruedAmount": "12.987654321",
    "currency": "USD",
    "pullPaymentMethodID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
    "pushPaymentMethodID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
    "residualBalance": "12.987654321",
    "statementDescriptor": "swp_f6g955",
    "status": "accruing",
    "sweepID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
    "transferAmount": "12.987654321",
    "transferID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43"
  }
]
Request was refused due to rate limiting.

Response headers

Retry-After

number

Path parameters

accountID

string <uuid> required
ID of the account.

walletID

string <uuid> required
ID of the wallet

Query parameters

status

string
Optional parameter to filter by sweep status.
Possible values: accruing, action-required, canceled, closed, failed, paid

statementDescriptor

string
Optional string to filter by statement descriptor.

count

integer
Optional parameter to limit the number of results in the query.
Default: 200

skip

integer
The number of items to offset before starting to collect the result set.

Response

application/json

accrualEndedOn

string<date-time> <=24 characters
The date-time the sweep stopped accruing transactions.

accrualStartedOn

string<date-time> <=24 characters
The date-time the sweep began accruing transactions.

accruedAmount

string
The total net Amount of wallet transactions accrued in the sweep.
A decimal-formatted numerical string that represents up to 9 decimal place precision.

currency

string <=3 characters Pattern
A 3-letter ISO 4217 currency code.

pullPaymentMethodID

string<uuid> <=36 characters
UUID

pushPaymentMethodID

string<uuid> <=36 characters
UUID

residualBalance

string
Amount remaining in the wallet after the sweep transfer completes.
A decimal-formatted numerical string that represents up to 9 decimal place precision.

statementDescriptor

string
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>
Current status of the sweep.
Possible values: accruing, action-required, canceled, closed, failed, paid

sweepID

string<uuid> <=36 characters
UUID

transferAmount

string Pattern
Amount that is transferred.

transferID

string<uuid> <=36 characters
UUID