List sweeps
List sweeps associated with a wallet.
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
|
|
|
|
|
|
|
|
|
|
|
|
The request completed successfully.
[
{
"sweepID": "23e0361a-ef0e-4fa5-8f73-7ca3157a2f85",
"status": "accruing",
"accruedAmount": "string",
"residualBalance": "string",
"currency": "USD",
"accrualStartedOn": "2019-08-24T14:15:22Z",
"accrualEndedOn": "2019-08-24T14:15:22Z",
"pushPaymentMethodID": "0162987f-ffaa-4b2f-8249-19dd9270db97",
"pullPaymentMethodID": "33cb3f3a-5c5a-42c8-afdc-a2cb11921ec3",
"transferID": "e23de6dd-5168-4e1d-894d-807fa691dc80",
"transferAmount": "string",
"statementDescriptor": "string",
"subtotals": [
{
"type": "account-funding",
"count": 0,
"amount": {
"currency": "USD",
"valueDecimal": "12.987654321"
}
}
]
}
]
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
walletID
string
<uuid>
required
Query parameters
skip
integer
<int64>
count
integer
<int64>
Default:
200
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.
Response
application/json
accrualEndedOn
string<date-time>
The date-time the sweep stopped accruing transactions.
accrualStartedOn
string<date-time>
The date-time the sweep began accruing transactions.
accruedAmount
string
Pattern
The total net amount of wallet transactions accrued in the sweep.
currency
string
Pattern
A 3-letter ISO 4217 currency code.
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.
status
string<enum>
Possible values:
accruing
,
action-required
,
canceled
,
closed
,
failed
,
paid
subtotals
array
The subtotal of each transaction type contributing to the sweep's accrued amount.
Show child attributes
amount
object
The value of transactions of this type accrued in the sweep.
Show child attributes
currency
string
required
Pattern
A 3-letter ISO 4217 currency code.
valueDecimal
string
required
Pattern
A decimal-formatted numerical string that represents up to 9 decimal place precision.
For example, $12.987654321 is '12.987654321'.
count
integer<int32>
The number of transactions of this type accrued in the sweep.
type
string
The type of wallet transaction the subtotal is for.
Possible values:
account-funding
,
ach-reversal
,
auto-sweep
,
card-payment
,
card-decline
,
card-reversal
,
cash-out
,
dispute
,
dispute-reversal
,
facilitator-fee
,
issuing-refund
,
issuing-transaction
,
issuing-transaction-adjustment
,
issuing-auth-hold
,
issuing-auth-release
,
issuing-decline
,
moov-fee
,
payment
,
payout
,
refund
,
refund-failure
,
rtp-failure
,
top-up
,
wallet-transfer
,
adjustment
sweepID
string<uuid>
transferAmount
string
Pattern
Amount that is transferred.
transferID
string<uuid>