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

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}
cURL Go TypeScript PHP Python Java Ruby (beta) 
1
2
3

curl -X GET "https://api.moov.io/accounts/{accountID}/wallets/{walletID}" \
  -H "Authorization: Bearer {token}" \
  -H "x-moov-version: v2024.01.00" \

1
2
3
4
5
6

mc, _ := moov.NewClient()

var accountID string
var walletID string

mc.GetWallet(ctx, accountID, walletID)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

import { SDK } from "openapi";

const sdk = new SDK({
  xMoovVersion: "v2024.01.00",
});

async function run() {
  const result = await sdk.wallets.get({
    accountID: "d04dfd44-8194-422f-a666-08d30c183f9a",
    walletID: "10a6bc37-8eeb-41c8-bf5f-77b40955542a",
  });

  console.log(result);
}

run();
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21

declare(strict_types=1);

require 'vendor/autoload.php';

use OpenAPI\OpenAPI;

$sdk = OpenAPI\SDK::builder()
    ->setXMoovVersion('v2024.01.00')
    ->build();



$response = $sdk->wallets->get(
    accountID: 'd04dfd44-8194-422f-a666-08d30c183f9a',
    walletID: '10a6bc37-8eeb-41c8-bf5f-77b40955542a'

);

if ($response->wallet !== null) {
    // handle response
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

from openapi import SDK


with SDK(
    x_moov_version="v2024.01.00",
) as sdk:

    res = sdk.wallets.get(account_id="d04dfd44-8194-422f-a666-08d30c183f9a", wallet_id="10a6bc37-8eeb-41c8-bf5f-77b40955542a")

    # Handle response
    print(res)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

package hello.world;

import java.lang.Exception;
import org.openapis.openapi.SDK;
import org.openapis.openapi.models.operations.GetWalletResponse;

public class Application {

    public static void main(String[] args) throws Exception {

        SDK sdk = SDK.builder()
                .xMoovVersion("v2024.01.00")
            .build();

        GetWalletResponse res = sdk.wallets().get()
                .accountID("d04dfd44-8194-422f-a666-08d30c183f9a")
                .walletID("10a6bc37-8eeb-41c8-bf5f-77b40955542a")
                .call();

        if (res.wallet().isPresent()) {
            // handle response
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

require 'openapi'

Models = ::OpenApiSDK::Models
s = ::OpenApiSDK::SDK.new(
      x_moov_version: 'v2024.01.00',
    )

res = s.wallets.get(account_id: 'd04dfd44-8194-422f-a666-08d30c183f9a', wallet_id: '10a6bc37-8eeb-41c8-bf5f-77b40955542a')

unless res.wallet.nil?
  # handle response
end
200 401 403 404 429 500 504
The request completed successfully.
application/json
Example
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 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

Response

application/json
A Moov wallet to store funds for transfers.

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

closedOn

string<date-time>

metadata

object
Free-form key-value pair list. Useful for storing information that is not captured elsewhere.