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

Wallet Tags

Used to manage wallet tags

Operations

Wallet Connect

Used to manage connections

Operations

Webhooks

Used to manage webhooks

Operations

Registry

Operations

Get a currency

Request

Get currency configuration by code

Security
TokenAuth
Path
codestringrequired

ISO 4217 currency code

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

Responses

Bodyapplication/json
namestringrequired

The human readable name of the currency

Example: "United States Dollar"
codestringrequired

The unique currency code

Example: "USD"
symbolstringrequired

The currency symbol

Example: "$"
decimalsinteger(int32)read-only

The number of decimal places for the currency

Example: 2
enabledbooleanread-only

Whether the currency is enabled for use

Example: true
Response
application/json
{
  "name": "United States Dollar",
  "code": "USD",
  "symbol": "$",
  "decimals": 2,
  "enabled": true
}

Delete a currency

Request

Soft delete a currency from the registry

Security
TokenAuth
Path
codestringrequired

Currency code to delete

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

Responses

A successful response.

Bodyapplication/json
object(Empty response for successful deletion)
Response
application/json
{}

Update a currency

Request

Update an existing currency in the registry

Security
TokenAuth
Path
codestringrequired

Currency code to update

Bodyapplication/jsonrequired
namestring

Updated currency name

Example: "United States Dollar"
symbolstring

Updated currency symbol

Example: "$"
decimalsinteger(int32)

Updated decimal places

Example: 2
enabledboolean

Updated enabled status

Example: true
curl -i -X PATCH \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/currencies/{code}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "United States Dollar",
    "symbol": "$",
    "decimals": 2,
    "enabled": true
  }'

Responses

Bodyapplication/json
namestringrequired

The human readable name of the currency

Example: "United States Dollar"
codestringrequired

The unique currency code

Example: "USD"
symbolstringrequired

The currency symbol

Example: "$"
decimalsinteger(int32)read-only

The number of decimal places for the currency

Example: 2
enabledbooleanread-only

Whether the currency is enabled for use

Example: true
Response
application/json
{
  "name": "United States Dollar",
  "code": "USD",
  "symbol": "$",
  "decimals": 2,
  "enabled": true
}

Transactions - Sweep

Operations

Sweep Instances

Operations