Retrieve a wallet
Get information on a specific wallet (e.g., the available balance).
Read our Moov wallets guide to learn more.
To access this endpoint using an access token
you'll need to specify the /accounts/{accountID}/wallets.read
scope.
GET
/accounts/{accountID}/wallets/{walletID}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The request completed successfully.
A Moov wallet to store funds for transfers.
{
"walletID": "0eb7d670-c252-422a-892d-002136c358e0",
"availableBalance": {
"currency": "USD",
"value": 1204,
"valueDecimal": "string"
},
"partnerAccountID": "c197cd40-7745-4413-8f3b-ec962d1b5225",
"name": "string",
"status": "active",
"walletType": "default",
"description": "string",
"metadata": {
"optional": "metadata"
},
"createdOn": "2019-08-24T14:15:22Z",
"closedOn": "2019-08-24T14:15:22Z"
}
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 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
Response
availableBalance
object
required
Show child attributes
currency
string
required
Pattern
A 3-letter ISO 4217 currency code.
value
integer<int64>
required
Quantity in the smallest unit of the specified currency.
In USD this is cents, for example, $12.04 is 1204 and $0.99 is 99.
valueDecimal
string
required
Pattern
createdOn
string<date-time>
required
description
string
required
Description of the wallet
name
string
required
Name of the wallet
partnerAccountID
string<uuid>
required
status
string<enum>
required
Status of a wallet.
active
: The wallet is available for use and has an enabled payment method.closed
: The wallet is no longer active and the corresponding payment method has been disabled.
Possible values:
active
,
closed
walletID
string<uuid>
required
walletType
string<enum>
required
Type of a wallet.
default
: The primary system-generated wallet automatically created by Moov when an account is granted the wallet capability. This generates a moov-wallet payment method that is available for use immediately. Only one default wallet exists per account.general
: A user-defined wallet created via the API to segment funds for specific use cases. Users can create multiple general wallets per account to support internal business models or financial reporting needs.
Possible values:
default
,
general
closedOn
string<date-time>
metadata
object
Free-form key-value pair list. Useful for storing information that is not captured elsewhere.