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

Get a sweep

Get details on a specific sweep.

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

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 401 403 404 429 500 504
The request completed successfully.
Accrued sweep
{
  "accrualStartedOn": "2024-05-06T12:20:38.184Z",
  "accruedAmount": "100.00",
  "currency": "USD",
  "status": "accruing",
  "sweepID": "01234567-89ab-cdef-0123-456789abcdef"
}
Paid sweep
{
  "accrualEndedOn": "2024-05-06T12:20:38.184Z",
  "accrualStartedOn": "2024-05-06T12:20:38.184Z",
  "accruedAmount": "100.00",
  "currency": "USD",
  "pushPaymentMethodID": "01234567-89ab-cdef-0123-456789abcdef",
  "residualBalance": "0.00",
  "statementDescriptor": "swp_012345",
  "status": "paid",
  "sweepID": "01234567-89ab-cdef-0123-456789abcdef",
  "transferAmount": "12.98",
  "transferID": "01234567-89ab-cdef-0123-456789abcdef"
}

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.
The requested resource was not found.

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 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.

Default: v2024.01.00

Path parameters

accountID

string <uuid> required

walletID

string <uuid> required

sweepID

string <uuid> required

Response

application/json

accrualStartedOn

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

accruedAmount

string required Pattern
The total net amount of wallet transactions accrued in the sweep.

currency

string required Pattern
A 3-letter ISO 4217 currency code.

status

string<enum> required
Possible values: accruing, action-required, canceled, closed, failed, paid

sweepID

string<uuid> required

accrualEndedOn

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

pullPaymentMethodID

string<uuid>
ID of the payment method.

pushPaymentMethodID

string<uuid>
ID of the payment method.

residualBalance

string Pattern
Amount remaining in the wallet after the sweep transfer completes.

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.

transferAmount

string Pattern
Amount that is transferred.

transferID

string<uuid>