Get a sweep
GET
/accounts/{accountID}/wallets/{walletID}/sweeps/{sweepID}
Details of a sweep.
{
"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",
"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
X-Retry-In
string
<duration>
How long (in milliseconds) to wait until able to retry the request.
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
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
Pattern
UUID v4
pushPaymentMethodID
string<uuid>
<=36 characters
Pattern
UUID v4
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.
status
string<enum>
Current status of the sweep.
Possible values:
accruing,
action-required,
canceled,
closed,
failed,
paid
sweepID
string<uuid>
<=36 characters
Pattern
UUID v4
transferAmount
string
Pattern
Amount that is transferred.
transferID
string<uuid>
<=36 characters
Pattern
UUID v4