Skip to content

Create wallets inside a vault, find and view them, enable outgoing transactions, and configure wallet-level settings and tags in the Ripple Custody (Wallet) console. For background on wallets and keystore types, see Wallets overview. To create the vault that holds a wallet, see Manage vaults. To manage wallets programmatically, see Manage wallets via the API.

Wallet actions

ActionConsole roleConsole procedureAPI procedure
Create a walletOwner, Administrator, ProposerCreate a walletCreate a wallet
View wallet detailsAll rolesGeneral settingsGet a wallet
List walletsAll rolesList walletsList wallets
Update wallet detailsOwner, Administrator, ProposerDetails settingsUpdate a wallet
Enable outgoing transactionsOwner, Administrator, ProposerEnable outgoing transactions from a walletUpdate wallet settings
Turn on raw signingOwner, Administrator, ProposerRaw signingUpdate wallet settings
Freeze deposits by defaultOwner, Administrator, ProposerFreeze transactions by defaultUpdate wallet settings
Enable sweepingOwner, Administrator, ProposerSweeping settingsUpdate wallet settings
Get a wallet's sequence--Get a wallet's sequence
Tag a walletOwner, Administrator, ProposerTag a walletTag a wallet
Check organization balancesAll rolesList vaultsGet organization balances
Check vault balancesAll rolesViewing balancesGet vault balances
Check wallet balancesAll rolesViewing balancesGet wallet balances
Refresh wallet balancesOwner, Administrator, ProposerRefreshing balancesRefresh wallet balances
Delete a failed walletOwner, AdministratorDelete a walletDelete a wallet

Permissions: In the console, owners, administrators, and proposers can create wallets and update wallet settings, and every role can view wallets. See User roles and permissions. The API procedures need an API credential of type WALLETS. See Prerequisites.

Create a wallet via the console

Required role: Owner, Administrator, or Proposer.

The Create wallet form has four steps: Details, Settings, Advanced, and Confirm.

  1. Open the vault where you want the wallet, and select Create wallet.

  2. On the Details step, select the Blockchain that you want to provision the wallet on. Ripple Custody (Wallet) currently supports wallet creation on the following blockchains:

    • Arbitrum
    • Avalanche
    • Base
    • BNB Chain
    • Bitcoin
    • Ethereum
    • Polygon
    • Solana
    • Tron
    • XRP Ledger
    • 1money

    For feature availability on each chain, see Blockchains and tokens. To request a chain that isn't listed, contact Ripple Support.

    Activation fees

    Some blockchains such as the XRP ledger require you to pay an activation fee before sending or receiving transactions.

  3. Under Select keystore, select the keystore type. You can't change it after you create the wallet.

    • HSM — available in sandbox only, and not for Solana wallets. The console selects HSM by default when it's available.
    • MPC — select the Quorum that signs for the wallet.
    MPC prerequisite

    To create an MPC wallet, you first need an MPC quorum, which you create in the Controls section of the Ripple Custody (Wallet) console. See MPC quorums.

  4. Enter the wallet Name (5 to 50 characters). The name should help identify the wallet.

  5. Optionally, enter the wallet Description (5 to 100 characters). The description should make the purpose of the wallet clear. Then select Next.

    The Details step of the Create wallet form, with a blockchain selected and the HSM and MPC keystore options

  6. On the Settings step, optionally turn on Outgoing, Raw signing, or Freeze transactions by default, and add up to 10 Tags. All three settings are off by default, and you can change them later. Select Next.

  7. On the Advanced step, optionally enter a Correlation ID and an External ID. Select Next.

  8. On the Confirm step, review the summary and select Create wallet.

  9. Transfer funds into your wallet (for example, from an exchange).

Ripple Custody (Wallet) places the wallet in a CREATED state and moves it to PROVISIONED after generating the wallet address. For MPC wallets, quorum members must approve the key generation before the wallet becomes provisioned.

For a guided first run, see Create your first wallet.

New wallets are deposit-only

Ripple Custody (Wallet) operates a zero-trust security model. Every new wallet blocks outgoing transactions by default. Before a wallet can send, you must create a transaction policy, register destination addresses, and enable outgoing transactions. See Enable outgoing transactions from a wallet.

The Settings step of the Create wallet form, with the Outgoing, Raw signing, and Freeze transactions by default switches and the Tags field

List wallets via the console

The console lists wallets per vault. To list every wallet in your organization at once, use the API. See List wallets.

  1. Go to Vaults in the console sidebar, and select the vault's name.

    The vault page shows cards for up to three of the vault's wallets, followed by a table of all its wallets with each wallet's Name, Balance, Address, ID, Storage (keystore), and Status.

  2. Optionally, to find a wallet, enter text in the Search wallets box. The search matches wallet ID, name, address, alias, external ID, and correlation ID.

  3. Optionally, to narrow the list, select Filters, and then select a category under Filter by:

    • Blockchain: select the blockchains to show.
    • Status: select Failed, Provisioned, or Provisioning.

    Each active filter appears as a chip above the table. To remove one filter, remove its chip. To remove them all, select Clear filters.

  4. Optionally, to sort the list, select the Name, Address, or Status column heading.

  5. To open a wallet, select its name.

A vault's wallet table filtered by part of a wallet address in the Search wallets box, with the Filters menu open on Blockchain and the Status category beside it

Enable outgoing transactions from a wallet via the console

Required role: Owner, Administrator, or Proposer.

A new wallet stays in a deposit-only state until it meets the following three conditions:

  1. At least one transaction policy exists for the asset you want to send. You can add a policy from the Policy tab within the wallet.
  2. At least one address book entry exists for the destination. You don't need one for internal wallet-to-wallet transfers within Ripple Custody (Wallet).
  3. Outgoing transactions are explicitly enabled on the wallet.

To enable outgoing transactions:

  1. Open the wallet.
  2. Select Enable transactions.
  3. In the Enable transactions dialog, select Enable.

A new wallet with the Disabled status, the DEPOSITS ONLY label, and the Enable transactions button

The console doesn't check the other two conditions when you enable outgoing transactions, but the wallet can't send until it meets them.

You can disable outgoing transactions at any time with the Outgoing toggle on the Transactions tab of the wallet settings.

For the full walkthrough, see Unlock outgoing transactions.

Wallet settings

To open wallet settings, open a wallet and select the Settings gear icon. The settings page has the following tabs. Every role can see the General tab. Only owners, administrators, and proposers see the Details, Transactions, Sweeping, and Tags tabs and can change wallet settings.

General settings

View wallet metadata. You can copy every value:

  • Wallet ID
  • Wallet address
  • Wallet public key
  • Vault ID and other vault information
  • Correlation ID
  • External ID

Details settings via the console

Change the wallet's name (5 to 50 characters), description (5 to 100 characters), or correlation ID, then select Save changes.

The Details tab of Wallet settings with the Name, Description, and Correlation ID fields

You can also change these details through the API. See Manage wallets via the API.

Transactions settings via the console

Configure transaction behavior for the wallet.

The Transactions tab of Wallet settings, with the Outgoing, Raw signing, and Freeze transactions by default switches

Outgoing transactions via the console

Use the Outgoing toggle to enable or disable the ability to transfer digital assets out of the wallet, then confirm in the dialog. To send from the wallet, it must also meet the conditions in Enable outgoing transactions from a wallet.

Raw signing via the console

Raw signing lets the wallet sign arbitrary data payloads and any transaction type available on a given blockchain, not just standard transfer transactions. Enable it only if your integration requires it. See Raw signing for important information about this feature.

  1. Open the wallet, select the Settings gear icon, and go to the Transactions tab.
  2. Turn on Raw signing.
  3. In the Enable raw signing dialog, select Enable.
Use with caution

Raw signing permits signing any data payload. Enable it only on wallets that need it, and pair it with strict transaction policies and approval groups.

Freeze transactions by default via the console

Automatic freeze places all incoming deposits into a frozen state until you manually review and unfreeze them. Funds don't become available until you unfreeze them. Use this for compliance-sensitive wallets that require manual review of every deposit.

  1. Open the wallet, select the Settings gear icon, and go to the Transactions tab.
  2. Turn on Freeze transactions by default.
  3. In the Freeze by default dialog, select Enable.

For full details, see Configure transaction freeze controls.

Sweeping settings via the console

Use the Enable sweeping toggle to enable or disable asset sweeping for the wallet, then confirm in the dialog. See Configure asset sweeping for setup instructions.

The Sweeping tab of Wallet settings, with the Enable sweeping switch

Tag a wallet via the console

Required role: Owner, Administrator, or Proposer. Only owners and administrators can remove a tag.

Tags are free-form labels you can use to group and find wallets. A wallet can have up to 10 tags, and each tag can be up to 64 characters long. You can also add tags on the Settings step when you create a wallet.

  1. Open the wallet, select the Settings gear icon, and go to the Tags tab.

  2. Add a tag in one of these ways:

    • To create a tag, enter it in Create a new tag and select Add.
    • To reuse a tag that's already on another wallet in the vault, select it under Add from existing.

    The tag appears under Selected tags.

  3. To remove a tag from the wallet, select the × on the tag under Selected tags.

The console saves each tag change as soon as you make it. You don't need to select Save changes.

The Tags tab of Wallet settings with two selected tags, the Create a new tag field, and an empty Add from existing list

Delete a wallet via the console

Owner or Administrator role required

Only users with the Owner or Administrator role can delete a wallet. Other roles don't see Delete wallet. If you don't see it, ask an owner or administrator in your organization.

You can delete a wallet only if it failed to provision (status PROVISIONING_FAILED). You can't delete a provisioned wallet.

To delete a wallet that failed to provision, open the wallet and select Delete wallet, or use the API.

Best practices

  • Use descriptive names — include the purpose, blockchain, and environment in wallet names (for example, "Treasury - ETH - Production").
  • Start with deposit-only — leave outgoing transactions disabled until you have configured policies, addresses, and approval groups.
  • Minimize raw signing — only enable raw signing on wallets that specifically need it.
  • Enable automatic freeze on compliance-sensitive wallets — use default freeze for wallets that handle funds subject to AML or sanctions screening.
API documentation

To manage wallets programmatically, see Manage wallets via the API.