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

Get a sweep

Get details on a specific sweep.
GET
/accounts/{accountID}/wallets/{walletID}/sweeps/{sweepID}
cURL Go 
1
2

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

1
2
3
4
5
6

mc, _ := moov.NewClient()

var accountID string
var sweepConfigID string

mc.GetSweepConfig(ctx, accountID, sweepConfigID)
200 429
Details of a sweep.
getSweepAccruingResponse
{
  "accrualStartedOn": "2024-01-23T04:56:07.000Z",
  "accruedAmount": "12.987654321",
  "currency": "USD",
  "pullPaymentMethodID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
  "pushPaymentMethodID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
  "status": "accruing",
  "sweepID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
  "transferAmount": "12.987654321",
  "transferID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43"
}
getSweepPaidResponse
{
  "accrualEndedOn": "2024-01-23T04:56:07.000Z",
  "accrualStartedOn": "2024-01-23T04:56:07.000Z",
  "accruedAmount": "12.987654321",
  "currency": "USD",
  "pullPaymentMethodID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
  "pushPaymentMethodID": "ec7e1848-dc80-4ab0-8827-dd7fc0737b43",
  "residualBalance": "20.987654321",
  "statementDescriptor": "swp_f6g955",
  "status": "paid",
  "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

sweepID

string <uuid> required
ID of the sweep

Response

application/json

accrualStartedOn

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

accruedAmount

string required
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 required Pattern
A 3-letter ISO 4217 currency code.

status

string<enum> required
Current status of the sweep.
Possible values: accruing, action-required, canceled, closed, failed, paid

sweepID

string<uuid> <=36 characters required
UUID

accrualEndedOn

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

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.

transferAmount

string Pattern
Amount that is transferred.

transferID

string<uuid> <=36 characters
UUID