Use the Vault

Keep reserves in the Vault, a wallet (wal_*) with walletType vault that any agent can fund but none can spend from. For wallet basics, read the Wallets overview.

What the Vault is

Every wallet has a walletType of standard or vault. A standard wallet is the everyday, spendable one. The Vault is the locked-down reserve. List your wallets with GET /wallets to see the field. The Vault sits alongside your standard wallets, set apart only by its walletType.

from naturalpay import Natural

client = Natural()
wallets = client.wallets.list()
for wallet in wallets.data:
    print(wallet.id, wallet.attributes.display_name, wallet.attributes.wallet_type)

import Natural from "@naturalpay/sdk";

const client = new Natural();
const wallets = await client.wallets.list();
for (const wallet of wallets.data) {
  console.log(wallet.id, wallet.attributes.displayName, wallet.attributes.walletType);
}

natural wallets list

List my Natural wallets and show each one's type and balance.

curl https://api.natural.com/wallets \
  -H "Authorization: Bearer $NATURAL_API_KEY"

The response carries each wallet with its walletType:

How the Vault differs

The Vault behaves differently from a standard wallet in three ways. 1. You cannot create one through the API. The Vault is provisioned once after onboarding. 2. Agents cannot be attached to the Vault or move money out of it. Attaching an agent to the Vault returns vault_not_allowed. Agents can still fund the Vault by transferring in from a standard wallet. 3. It cannot be your default wallet. Keep a standard wallet as your default so calls that omit walletId resolve somewhere spendable.

Overview

Common use cases

Products

Guides

What the Vault is

How the Vault differs

​What the Vault is

​How the Vault differs

What the Vault is

How the Vault differs