List wallets
List the wallets associated with a Moov account.
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
curl -X GET "https://api.moov.io/accounts/{accountID}/wallets" \
-H "Authorization: Bearer {token}" \
-H "x-moov-version: v2024.01.00" \
mc, _ := moov.NewClient()
var accountID string
mc.ListWallets(ctx, accountID)
import { SDK } from "openapi";
const sdk = new SDK({
xMoovVersion: "v2024.01.00",
});
async function run() {
const result = await sdk.wallets.list({
skip: 60,
count: 20,
accountID: "25221c3c-8e3f-40db-8570-66d17b51014d",
});
console.log(result);
}
run();declare(strict_types=1);
require 'vendor/autoload.php';
use OpenAPI\OpenAPI;
use OpenAPI\OpenAPI\Models\Operations;
$sdk = OpenAPI\SDK::builder()
->setXMoovVersion('v2024.01.00')
->build();
$request = new Operations\ListWalletsRequest(
skip: 60,
count: 20,
accountID: '25221c3c-8e3f-40db-8570-66d17b51014d',
);
$response = $sdk->wallets->list(
request: $request
);
if ($response->wallets !== null) {
// handle response
}from openapi import SDK
with SDK(
x_moov_version="v2024.01.00",
) as sdk:
res = sdk.wallets.list(account_id="25221c3c-8e3f-40db-8570-66d17b51014d", skip=60, count=20)
# Handle response
print(res)package hello.world;
import java.lang.Exception;
import org.openapis.openapi.SDK;
import org.openapis.openapi.models.errors.ListWalletsValidationError;
import org.openapis.openapi.models.operations.ListWalletsRequest;
import org.openapis.openapi.models.operations.ListWalletsResponse;
public class Application {
public static void main(String[] args) throws ListWalletsValidationError, Exception {
SDK sdk = SDK.builder()
.xMoovVersion("v2024.01.00")
.build();
ListWalletsRequest req = ListWalletsRequest.builder()
.accountID("25221c3c-8e3f-40db-8570-66d17b51014d")
.skip(60L)
.count(20L)
.build();
ListWalletsResponse res = sdk.wallets().list()
.request(req)
.call();
if (res.wallets().isPresent()) {
// handle response
}
}
}require 'openapi'
Models = ::OpenApiSDK::Models
s = ::OpenApiSDK::SDK.new(
x_moov_version: 'v2024.01.00',
)
req = Models::Operations::ListWalletsRequest.new(
skip: 60,
count: 20,
account_id: '25221c3c-8e3f-40db-8570-66d17b51014d',
)
res = s.wallets.list(request: req)
unless res.wallets.nil?
# handle response
endThe request completed successfully.
[
{
"walletID": "string",
"availableBalance": {
"currency": "USD",
"value": 1204,
"valueDecimal": "string"
},
"partnerAccountID": "string",
"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
required
A unique identifier used to trace requests.
The request contained missing or expired authentication.
Response headers
x-request-id
string
required
A unique identifier used to trace requests.
The user is not authorized to make the request.
Response headers
x-request-id
string
required
A unique identifier used to trace requests.
The request was well-formed, but the contents failed validation. Check the request for missing or invalid fields.
{
"status": "string",
"walletType": "string",
"skip": "string",
"count": "string"
}Response headers
x-request-id
string
required
A unique identifier used to trace requests.
Request was refused due to rate limiting.
Response headers
x-request-id
string
required
A unique identifier used to trace requests.
The request failed due to an unexpected error.
Response headers
x-request-id
string
required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.
Response headers
x-request-id
string
required
A unique identifier used to trace requests.
Headers
X-Moov-Version
string
Specify an API version.
API versioning follows the format vYYYY.QQ.BB, where
YYYYis the yearQQis the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)BBis the build number, starting at.01, for subsequent builds in the same quarter.- For example,
v2024.01.00is the initial release of the first quarter of 2024.
- For example,
The dev version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
When no version is specified, the API defaults to v2024.01.00.
Path parameters
accountID
string
required
Query parameters
status
string
Optional parameter for filtering wallets by status.
Possible values:
active,
closed
walletType
string
Optional parameter for filtering wallets by type.
Possible values:
default,
general
skip
integer
<int64>
count
integer
<int64>
Default:
200Response
availableBalance
object
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
closedOn
string<date-time>
createdOn
string<date-time>
description
string
Description of the wallet
metadata
object
Free-form key-value pair list. Useful for storing information that is not captured elsewhere.
name
string
Name of the wallet
partnerAccountID
string
status
string<enum>
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
walletType
string<enum>
Type of a wallet.
default: The system-generated wallet automatically created when an account is granted the wallet capability.general: An additional, user-defined wallet created via API or Dashboard.
Possible values:
default,
general