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/wallet/api-docs/palisade-api/palisade-api
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

API Credentials

Used to manage credentials

Operations

Balances

Used to view balances

Operations

Counterparties

Used to manage counterparties

Operations

Policies

Used to manage connections policies

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

Vaults

Used to manage vaults

Operations

Vault Tags

Used to manage vault tags

Operations

List all vault tags for the organization

Request

List all vault tags for the organization

Security
TokenAuth
curl -i -X GET \
  https://docs.ripple.com/_mock/products/wallet/api-docs/palisade-api/palisade-api/v2/vaults/tags \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Bodyapplication/jsonArray [
vaultIdstringrequired

The vault ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
tagsArray of strings

The tags belonging to the vault

Example: ["Treasury vault"]
]
Response
application/json
[
  {
    "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "tags": [ … ]
  }
]

List tags for the vault

Request

List all tags for the vault

Security
TokenAuth
Path
vaultIdstringrequired

The vault ID

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

Responses

Bodyapplication/jsonArray [
vaultIdstringrequired

The vault ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
tagsArray of strings

The tags belonging to the vault

Example: ["Treasury vault"]
]
Response
application/json
[
  {
    "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "tags": [ … ]
  }
]

Delete a vault tag

Request

Delete a vault tag from a vault

Security
TokenAuth
Path
vaultIdstringrequired

The vault ID

Query
tagstringrequired

The tag

curl -i -X DELETE \
  'https://docs.ripple.com/_mock/products/wallet/api-docs/palisade-api/palisade-api/v2/vaults/{vaultId}/tags?tag=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A successful response.

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

Add a new vault tag

Request

Add a new vault tag to a vault

Security
TokenAuth
Path
vaultIdstringrequired

The vault ID

Bodyapplication/jsonrequired
tagstringrequired

The tag

Example: "Treasury vault"
curl -i -X POST \
  'https://docs.ripple.com/_mock/products/wallet/api-docs/palisade-api/palisade-api/v2/vaults/{vaultId}/tags' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "tag": "Treasury vault"
  }'

Responses

Bodyapplication/jsonArray [
vaultIdstringrequired

The vault ID

Example: "ce4918bf-a199-4ce2-85a3-d0d296855384"
tagsArray of strings

The tags belonging to the vault

Example: ["Treasury vault"]
]
Response
application/json
[
  {
    "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "tags": [ … ]
  }
]

Wallets

Used to manage wallets

Operations

Wallet Tags

Used to manage wallet tags

Operations

Webhooks

Used to manage webhooks

Operations

Transactions - Sweep

Operations