Skip to content

Palisade API (2.0)

The Palisade API enables programmatic interaction with the various features of the Palisade platform

Click here for the API docs
Download OpenAPI description
palisade-api.json
palisade-api.yaml
Languages
Servers
Mock server

https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/

Sandbox server (uses TESTNET data, private keys and accounts)

https://api.sandbox.palisade.co/

Palisade server (uses MAINNET data, private keys and accounts)

https://api.palisade.co/

Addresses

Used to manage addresses

Operations

Allow Addresses (deprecated)

Used to manage legacy allow addresses

API Credentials

Used to manage credentials

Operations

Approvals

Used to manage approvals

Operations

Approvers

Used to manage approvers

Operations

Audit

Used to manage configuration for audit

Operations

Backup

Used to manage backups

Operations

Balances

Used to view balances

Operations

Compliance

Used to manage compliance

Operations

Counterparties

Used to manage counterparties

Operations

Devices

Used to manage devices

Operations

Information

Used to view information about the platform

Operations

MPC - Memberships

Used to manage MPC memberships

Operations

MPC - Quorums

Used to manage MPC quorums

Operations

MPC - Sessions

Used to manage MPC sessions

Operations

Organizations

Used to manage organizations

Operations

Policies

Used to manage connections policies

Operations

Rates

Used to retrieve rates

Operations

Sweep Configurations

Used to manage sweep configurations

Operations

Tags

Used to manage organization tags

Operations

Transactions

Used to manage transactions

Operations

Transactions - XRP

Used to manage XRP specific transactions

Operations

Users

Used to manage users

Operations

Vaults

Used to manage vaults

Operations

Vault Tags

Used to manage vault tags

Operations

Wallets

Used to manage wallets

Operations

List vault wallets

Request

List all wallets within a vault

Security
TokenAuth
Path
vaultIdstringrequired

The vault ID

Query
pageSizeinteger(int32)

The number of results to return per page (default 50, max 1000)

pageTokenstring

The token to retrieve the next page of results

blockchainstring

The blockchain of the wallet

Enum"AVALANCHE""ETHEREUM""XRP_LEDGER""POLYGON""BNBCHAIN""BASE""HEDERA""ARBITRUM""ONE_MONEY""SOLANA"
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/vaults/{vaultId}/wallets?pageSize=0&pageToken=string&blockchain=AVALANCHE' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A successful response.

Bodyapplication/json
filterobject(v2FilterResponse)
walletsArray of objects(vaultv2Wallet)
Response
application/json
{
  "filter": {
    "previousPageToken": "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA=",
    "nextPageToken": "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA=",
    "total": 100
  },
  "wallets": [
    { … }
  ]
}

Create a wallet

Request

Create a new HSM or MPC wallet within a vault

Security
TokenAuth
Path
vaultIdstringrequired

The vault ID

Bodyapplication/jsonrequired
namestringrequired

The name of the wallet

Example: "USD Issuing wallet"
descriptionstring

The description of the wallet

Example: "Main USD issuing account used internally"
quorumIdstring

The quorum ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
blockchainstring(Supported blockchains)required
Enum"AVALANCHE""ETHEREUM""XRP_LEDGER""POLYGON""BNBCHAIN""BASE""HEDERA""ARBITRUM""ONE_MONEY""SOLANA"
keystorestring(v2Keystore)required
Enum"HSM""MPC"
recoveryPublicKeystring

Optional, hex encoded PKCS1 formatted public key of a 4096-bit RSA private key

Example: "30820221300d06092a864886f70d01010105000382020e0030820209028202007b985c289e76fa4d25a72649d9b3381c12ec63e05cee00173e91f94a371a1fc0b95e98ffa0c435a651db17924d9089951f844d00e52fb5ddf3ac0843ea2cdf6ddf54c6926147229722e1cbd8d50a4a62e2d8ae1ffa466e67d23e9de8293dd9698a992a2eb00f9d5588dfacdd86f65c9c2d429da830bfb5b93568159cdece5c1f6424aabbb6058d83261322660ec8acdbe03060ad9fd547aa647fdc96b0b64a56a60070fa64ede58c5c8eb0e3779512e977170c2b7a3e32e375754d5e6e92d65e96d5e3095b455485d70f1ea76a392ff8488a9b93344a440c11e1943fe8dbd6cc98501cd0bac1408e0b47041adfc07b648e6e7feb55ebc1a62ae0cea93adbfd56eee20ffc75395773354927f1d9857050c0aa6a468620885c72a2c46d8274b2e780186743cfae2c04f7f5618df90c1bf31b54634c1b33fa80a68311d7ceb9d392a666bae1a059055a0e26ed1143e21b0ade10f4ef6e5dc8fa653da67f1317fb6f6755ae558f7f198fa1bb0db20e065720fe64f1b7eef91e744bd53df2830ae12960c11e68940f7e7915ff5d46af5e4b65d32f7196ed095a52764c585f75b81d568f101721a18123304b006730fcfb715d53853904995da7e1302a1273ac2559f789bf331dc54c1cd2a523fc665100d6cfad4e4446ff5b239517e577aaf5be1d8a2ed72087432f58d2fdffad377a01c0980efe9e5673ac93d882c64914a2111a9f0203010001"
externalIdstring

External ID of this wallet, unique to the organization

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
correlationIdstring

Correlation ID for tracking correlations with the wallet

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
curl -i -X POST \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/vaults/{vaultId}/wallets' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "USD Issuing wallet",
    "description": "Main USD issuing account used internally",
    "quorumId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "blockchain": "AVALANCHE",
    "keystore": "HSM",
    "recoveryPublicKey": "30820221300d06092a864886f70d01010105000382020e0030820209028202007b985c289e76fa4d25a72649d9b3381c12ec63e05cee00173e91f94a371a1fc0b95e98ffa0c435a651db17924d9089951f844d00e52fb5ddf3ac0843ea2cdf6ddf54c6926147229722e1cbd8d50a4a62e2d8ae1ffa466e67d23e9de8293dd9698a992a2eb00f9d5588dfacdd86f65c9c2d429da830bfb5b93568159cdece5c1f6424aabbb6058d83261322660ec8acdbe03060ad9fd547aa647fdc96b0b64a56a60070fa64ede58c5c8eb0e3779512e977170c2b7a3e32e375754d5e6e92d65e96d5e3095b455485d70f1ea76a392ff8488a9b93344a440c11e1943fe8dbd6cc98501cd0bac1408e0b47041adfc07b648e6e7feb55ebc1a62ae0cea93adbfd56eee20ffc75395773354927f1d9857050c0aa6a468620885c72a2c46d8274b2e780186743cfae2c04f7f5618df90c1bf31b54634c1b33fa80a68311d7ceb9d392a666bae1a059055a0e26ed1143e21b0ade10f4ef6e5dc8fa653da67f1317fb6f6755ae558f7f198fa1bb0db20e065720fe64f1b7eef91e744bd53df2830ae12960c11e68940f7e7915ff5d46af5e4b65d32f7196ed095a52764c585f75b81d568f101721a18123304b006730fcfb715d53853904995da7e1302a1273ac2559f789bf331dc54c1cd2a523fc665100d6cfad4e4446ff5b239517e577aaf5be1d8a2ed72087432f58d2fdffad377a01c0980efe9e5673ac93d882c64914a2111a9f0203010001",
    "externalId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "correlationId": "ce4918bf-a199-4ce2-85a3-d0d296855384"
  }'

Responses

Bodyapplication/json
idstringrequired

The wallet ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
vaultIdstringrequired

The vault ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
organizationIdstringrequired

The organization ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
quorumIdstring

The quorum ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdBystringrequired

The user ID that created the wallet

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdAtstring(date-time)required

The date and time the wallet was created

Example: "2022-03-29T10:22:22.420Z"
updatedAtstring(date-time)required

The date and time the wallet was update

Example: "2022-03-29T10:22:22.420Z"
namestringrequired

The name of the wallet

Example: "USD Issuing wallet"
descriptionstring

The description of the wallet

Example: "Main USD issuing account used internally"
addressstring

The address of the wallet

Example: "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4"
publicKeystring

The public key of the wallet

Example: "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4"
keystorestring(v2Keystore)required
Enum"HSM""MPC"
blockchainstring(Supported blockchains)required
Enum"AVALANCHE""ETHEREUM""XRP_LEDGER""POLYGON""BNBCHAIN""BASE""HEDERA""ARBITRUM""ONE_MONEY""SOLANA"
settingsobject(v2WalletSettings)required
settings.​enabledbooleanrequired

Whether the wallet is enabled or not

Example: "true"
settings.​rawSigningEnabledbooleanrequired

Whether raw signing is enabled for the wallet

Example: "true"
settings.​sweepingEnabledbooleanrequired

Whether sweeping is enabled for the wallet

Example: "true"
settings.​defaultFreezeEnabledbooleanrequired

Whether to freeze inbound transactions by default

Example: "true"
statusstring(vaultv2WalletStatus)required
Enum"CREATED""PROVISIONING""PROVISIONED_WALLET""PROVISIONING_POLICY""PROVISIONING_COMPLIANCE""PROVISIONED_COMPLIANCE""PROVISIONED""PROVISIONING_FAILED"
reasonsArray of strings

The reasons why the wallet may have failed to provision

Example: ["MPC session timed out"]
passkeyPublicstring(byte)
aliasstring

The alias of the wallet

Example: "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4"
externalIdstring

External ID of this wallet, unique to the organization

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
correlationIdstring

Correlation ID for the wallet

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
keyAlgorithmstring(- SECP256K1: used for evm chains and xrp ledger, supported by hsm and mpc - ED25519: used for solana, supported by mpc)required
Enum"SECP256K1""ED25519"
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "quorumId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "name": "USD Issuing wallet",
  "description": "Main USD issuing account used internally",
  "address": "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4",
  "publicKey": "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4",
  "keystore": "HSM",
  "blockchain": "AVALANCHE",
  "settings": {
    "enabled": "true",
    "rawSigningEnabled": "true",
    "sweepingEnabled": "true",
    "defaultFreezeEnabled": "true"
  },
  "status": "CREATED",
  "reasons": [
    "MPC session timed out"
  ],
  "passkeyPublic": "string",
  "alias": "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4",
  "externalId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "correlationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "keyAlgorithm": "SECP256K1"
}

Get a wallet

Request

Get a wallet by ID

Security
TokenAuth
Path
vaultIdstringrequired

The vault ID

walletIdstringrequired

The wallet ID

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/vaults/{vaultId}/wallets/{walletId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idstringrequired

The wallet ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
vaultIdstringrequired

The vault ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
organizationIdstringrequired

The organization ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
quorumIdstring

The quorum ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdBystringrequired

The user ID that created the wallet

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdAtstring(date-time)required

The date and time the wallet was created

Example: "2022-03-29T10:22:22.420Z"
updatedAtstring(date-time)required

The date and time the wallet was update

Example: "2022-03-29T10:22:22.420Z"
namestringrequired

The name of the wallet

Example: "USD Issuing wallet"
descriptionstring

The description of the wallet

Example: "Main USD issuing account used internally"
addressstring

The address of the wallet

Example: "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4"
publicKeystring

The public key of the wallet

Example: "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4"
keystorestring(v2Keystore)required
Enum"HSM""MPC"
blockchainstring(Supported blockchains)required
Enum"AVALANCHE""ETHEREUM""XRP_LEDGER""POLYGON""BNBCHAIN""BASE""HEDERA""ARBITRUM""ONE_MONEY""SOLANA"
settingsobject(v2WalletSettings)required
settings.​enabledbooleanrequired

Whether the wallet is enabled or not

Example: "true"
settings.​rawSigningEnabledbooleanrequired

Whether raw signing is enabled for the wallet

Example: "true"
settings.​sweepingEnabledbooleanrequired

Whether sweeping is enabled for the wallet

Example: "true"
settings.​defaultFreezeEnabledbooleanrequired

Whether to freeze inbound transactions by default

Example: "true"
statusstring(vaultv2WalletStatus)required
Enum"CREATED""PROVISIONING""PROVISIONED_WALLET""PROVISIONING_POLICY""PROVISIONING_COMPLIANCE""PROVISIONED_COMPLIANCE""PROVISIONED""PROVISIONING_FAILED"
reasonsArray of strings

The reasons why the wallet may have failed to provision

Example: ["MPC session timed out"]
passkeyPublicstring(byte)
aliasstring

The alias of the wallet

Example: "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4"
externalIdstring

External ID of this wallet, unique to the organization

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
correlationIdstring

Correlation ID for the wallet

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
keyAlgorithmstring(- SECP256K1: used for evm chains and xrp ledger, supported by hsm and mpc - ED25519: used for solana, supported by mpc)required
Enum"SECP256K1""ED25519"
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "quorumId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "name": "USD Issuing wallet",
  "description": "Main USD issuing account used internally",
  "address": "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4",
  "publicKey": "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4",
  "keystore": "HSM",
  "blockchain": "AVALANCHE",
  "settings": {
    "enabled": "true",
    "rawSigningEnabled": "true",
    "sweepingEnabled": "true",
    "defaultFreezeEnabled": "true"
  },
  "status": "CREATED",
  "reasons": [
    "MPC session timed out"
  ],
  "passkeyPublic": "string",
  "alias": "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4",
  "externalId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "correlationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "keyAlgorithm": "SECP256K1"
}

Delete a wallet

Request

Delete a wallet by ID (A wallet can only be deleted if it is in PROVISIONING_FAILED status)

Security
TokenAuth
Path
vaultIdstringrequired

The vault ID

walletIdstringrequired

The wallet ID

curl -i -X DELETE \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/vaults/{vaultId}/wallets/{walletId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A successful response.

Bodyapplication/json
object(v2DeleteWalletResponse)
Response
application/json
{}

Update a wallet

Request

Update a wallet's name and description by ID

Security
TokenAuth
Path
vaultIdstringrequired

The vault ID

walletIdstringrequired

The wallet ID

Bodyapplication/jsonrequired
namestringrequired

The name of the wallet

Example: "USD Issuing wallet"
descriptionstring

The description of the wallet

Example: "Main USD issuing account used internally"
correlationIdstring

Correlation ID for tracking correlated actions on the wallet

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/vaults/{vaultId}/wallets/{walletId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "USD Issuing wallet",
    "description": "Main USD issuing account used internally",
    "correlationId": "ce4918bf-a199-4ce2-85a3-d0d296855384"
  }'

Responses

Bodyapplication/json
idstringrequired

The wallet ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
vaultIdstringrequired

The vault ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
organizationIdstringrequired

The organization ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
quorumIdstring

The quorum ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdBystringrequired

The user ID that created the wallet

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdAtstring(date-time)required

The date and time the wallet was created

Example: "2022-03-29T10:22:22.420Z"
updatedAtstring(date-time)required

The date and time the wallet was update

Example: "2022-03-29T10:22:22.420Z"
namestringrequired

The name of the wallet

Example: "USD Issuing wallet"
descriptionstring

The description of the wallet

Example: "Main USD issuing account used internally"
addressstring

The address of the wallet

Example: "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4"
publicKeystring

The public key of the wallet

Example: "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4"
keystorestring(v2Keystore)required
Enum"HSM""MPC"
blockchainstring(Supported blockchains)required
Enum"AVALANCHE""ETHEREUM""XRP_LEDGER""POLYGON""BNBCHAIN""BASE""HEDERA""ARBITRUM""ONE_MONEY""SOLANA"
settingsobject(v2WalletSettings)required
settings.​enabledbooleanrequired

Whether the wallet is enabled or not

Example: "true"
settings.​rawSigningEnabledbooleanrequired

Whether raw signing is enabled for the wallet

Example: "true"
settings.​sweepingEnabledbooleanrequired

Whether sweeping is enabled for the wallet

Example: "true"
settings.​defaultFreezeEnabledbooleanrequired

Whether to freeze inbound transactions by default

Example: "true"
statusstring(vaultv2WalletStatus)required
Enum"CREATED""PROVISIONING""PROVISIONED_WALLET""PROVISIONING_POLICY""PROVISIONING_COMPLIANCE""PROVISIONED_COMPLIANCE""PROVISIONED""PROVISIONING_FAILED"
reasonsArray of strings

The reasons why the wallet may have failed to provision

Example: ["MPC session timed out"]
passkeyPublicstring(byte)
aliasstring

The alias of the wallet

Example: "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4"
externalIdstring

External ID of this wallet, unique to the organization

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
correlationIdstring

Correlation ID for the wallet

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
keyAlgorithmstring(- SECP256K1: used for evm chains and xrp ledger, supported by hsm and mpc - ED25519: used for solana, supported by mpc)required
Enum"SECP256K1""ED25519"
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "quorumId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "name": "USD Issuing wallet",
  "description": "Main USD issuing account used internally",
  "address": "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4",
  "publicKey": "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4",
  "keystore": "HSM",
  "blockchain": "AVALANCHE",
  "settings": {
    "enabled": "true",
    "rawSigningEnabled": "true",
    "sweepingEnabled": "true",
    "defaultFreezeEnabled": "true"
  },
  "status": "CREATED",
  "reasons": [
    "MPC session timed out"
  ],
  "passkeyPublic": "string",
  "alias": "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4",
  "externalId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "correlationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "keyAlgorithm": "SECP256K1"
}

Get a wallet nonce/sequence

Request

Get blockchain nonce/sequence of a specific wallet by ID

Security
TokenAuth
Path
vaultIdstringrequired

The vault ID

walletIdstringrequired

The wallet ID

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/vaults/{vaultId}/wallets/{walletId}/sequence' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A successful response.

Bodyapplication/json
sequencestring(uint64)

The wallets nonce/sequence

Example: "2"
Response
application/json
{
  "sequence": "2"
}

Update a wallet's settings

Request

Update a wallet's settings by ID

Security
TokenAuth
Path
vaultIdstringrequired

The vault ID

walletIdstringrequired

The wallet ID

Bodyapplication/jsonrequired
settingsobject(v2WalletSettings)required
settings.​enabledbooleanrequired

Whether the wallet is enabled or not

Example: "true"
settings.​rawSigningEnabledbooleanrequired

Whether raw signing is enabled for the wallet

Example: "true"
settings.​sweepingEnabledbooleanrequired

Whether sweeping is enabled for the wallet

Example: "true"
settings.​defaultFreezeEnabledbooleanrequired

Whether to freeze inbound transactions by default

Example: "true"
curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/vaults/{vaultId}/wallets/{walletId}/settings' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "settings": {
      "enabled": "true",
      "rawSigningEnabled": "true",
      "sweepingEnabled": "true",
      "defaultFreezeEnabled": "true"
    }
  }'

Responses

Bodyapplication/json
idstringrequired

The wallet ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
vaultIdstringrequired

The vault ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
organizationIdstringrequired

The organization ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
quorumIdstring

The quorum ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdBystringrequired

The user ID that created the wallet

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdAtstring(date-time)required

The date and time the wallet was created

Example: "2022-03-29T10:22:22.420Z"
updatedAtstring(date-time)required

The date and time the wallet was update

Example: "2022-03-29T10:22:22.420Z"
namestringrequired

The name of the wallet

Example: "USD Issuing wallet"
descriptionstring

The description of the wallet

Example: "Main USD issuing account used internally"
addressstring

The address of the wallet

Example: "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4"
publicKeystring

The public key of the wallet

Example: "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4"
keystorestring(v2Keystore)required
Enum"HSM""MPC"
blockchainstring(Supported blockchains)required
Enum"AVALANCHE""ETHEREUM""XRP_LEDGER""POLYGON""BNBCHAIN""BASE""HEDERA""ARBITRUM""ONE_MONEY""SOLANA"
settingsobject(v2WalletSettings)required
settings.​enabledbooleanrequired

Whether the wallet is enabled or not

Example: "true"
settings.​rawSigningEnabledbooleanrequired

Whether raw signing is enabled for the wallet

Example: "true"
settings.​sweepingEnabledbooleanrequired

Whether sweeping is enabled for the wallet

Example: "true"
settings.​defaultFreezeEnabledbooleanrequired

Whether to freeze inbound transactions by default

Example: "true"
statusstring(vaultv2WalletStatus)required
Enum"CREATED""PROVISIONING""PROVISIONED_WALLET""PROVISIONING_POLICY""PROVISIONING_COMPLIANCE""PROVISIONED_COMPLIANCE""PROVISIONED""PROVISIONING_FAILED"
reasonsArray of strings

The reasons why the wallet may have failed to provision

Example: ["MPC session timed out"]
passkeyPublicstring(byte)
aliasstring

The alias of the wallet

Example: "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4"
externalIdstring

External ID of this wallet, unique to the organization

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
correlationIdstring

Correlation ID for the wallet

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
keyAlgorithmstring(- SECP256K1: used for evm chains and xrp ledger, supported by hsm and mpc - ED25519: used for solana, supported by mpc)required
Enum"SECP256K1""ED25519"
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "quorumId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "name": "USD Issuing wallet",
  "description": "Main USD issuing account used internally",
  "address": "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4",
  "publicKey": "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4",
  "keystore": "HSM",
  "blockchain": "AVALANCHE",
  "settings": {
    "enabled": "true",
    "rawSigningEnabled": "true",
    "sweepingEnabled": "true",
    "defaultFreezeEnabled": "true"
  },
  "status": "CREATED",
  "reasons": [
    "MPC session timed out"
  ],
  "passkeyPublic": "string",
  "alias": "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4",
  "externalId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "correlationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "keyAlgorithm": "SECP256K1"
}

List organization wallets

Request

List all wallets within the organization

Security
TokenAuth
Query
pageSizeinteger(int32)

The number of results to return per page (default 50, max 1000)

pageTokenstring

The token to retrieve the next page of results

blockchainstring

The blockchain of the wallet

Enum"AVALANCHE""ETHEREUM""XRP_LEDGER""POLYGON""BNBCHAIN""BASE""HEDERA""ARBITRUM""ONE_MONEY""SOLANA"
correlationIdstring

Correlation ID for tracking various actions on the wallet

addressstring

The wallet address to filter by

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/wallets?pageSize=0&pageToken=string&blockchain=AVALANCHE&correlationId=string&address=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A successful response.

Bodyapplication/json
filterobject(v2FilterResponse)
walletsArray of objects(vaultv2Wallet)
Response
application/json
{
  "filter": {
    "previousPageToken": "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA=",
    "nextPageToken": "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA=",
    "total": 100
  },
  "wallets": [
    { … }
  ]
}

Get a wallet by ID

Request

Get a wallet by its unique ID

Security
TokenAuth
Path
idstringrequired

The wallet ID

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/wallets/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/json
idstringrequired

The wallet ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
vaultIdstringrequired

The vault ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
organizationIdstringrequired

The organization ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
quorumIdstring

The quorum ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdBystringrequired

The user ID that created the wallet

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
createdAtstring(date-time)required

The date and time the wallet was created

Example: "2022-03-29T10:22:22.420Z"
updatedAtstring(date-time)required

The date and time the wallet was update

Example: "2022-03-29T10:22:22.420Z"
namestringrequired

The name of the wallet

Example: "USD Issuing wallet"
descriptionstring

The description of the wallet

Example: "Main USD issuing account used internally"
addressstring

The address of the wallet

Example: "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4"
publicKeystring

The public key of the wallet

Example: "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4"
keystorestring(v2Keystore)required
Enum"HSM""MPC"
blockchainstring(Supported blockchains)required
Enum"AVALANCHE""ETHEREUM""XRP_LEDGER""POLYGON""BNBCHAIN""BASE""HEDERA""ARBITRUM""ONE_MONEY""SOLANA"
settingsobject(v2WalletSettings)required
settings.​enabledbooleanrequired

Whether the wallet is enabled or not

Example: "true"
settings.​rawSigningEnabledbooleanrequired

Whether raw signing is enabled for the wallet

Example: "true"
settings.​sweepingEnabledbooleanrequired

Whether sweeping is enabled for the wallet

Example: "true"
settings.​defaultFreezeEnabledbooleanrequired

Whether to freeze inbound transactions by default

Example: "true"
statusstring(vaultv2WalletStatus)required
Enum"CREATED""PROVISIONING""PROVISIONED_WALLET""PROVISIONING_POLICY""PROVISIONING_COMPLIANCE""PROVISIONED_COMPLIANCE""PROVISIONED""PROVISIONING_FAILED"
reasonsArray of strings

The reasons why the wallet may have failed to provision

Example: ["MPC session timed out"]
passkeyPublicstring(byte)
aliasstring

The alias of the wallet

Example: "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4"
externalIdstring

External ID of this wallet, unique to the organization

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
correlationIdstring

Correlation ID for the wallet

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
keyAlgorithmstring(- SECP256K1: used for evm chains and xrp ledger, supported by hsm and mpc - ED25519: used for solana, supported by mpc)required
Enum"SECP256K1""ED25519"
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "quorumId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "name": "USD Issuing wallet",
  "description": "Main USD issuing account used internally",
  "address": "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4",
  "publicKey": "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4",
  "keystore": "HSM",
  "blockchain": "AVALANCHE",
  "settings": {
    "enabled": "true",
    "rawSigningEnabled": "true",
    "sweepingEnabled": "true",
    "defaultFreezeEnabled": "true"
  },
  "status": "CREATED",
  "reasons": [
    "MPC session timed out"
  ],
  "passkeyPublic": "string",
  "alias": "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4",
  "externalId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "correlationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "keyAlgorithm": "SECP256K1"
}

Wallet Tags

Used to manage wallet tags

Operations

Wallet Connect

Used to manage connections

Operations

Webhooks

Used to manage webhooks

Operations

Registry

Operations

Transactions - Sweep

Operations

Sweep Instances

Operations