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

List currencies

Request

List currencies with advanced filtering. Supports both GET (bookmarkable) and POST (complex filters).

Security
TokenAuth
Query
filter.enabled.eqboolean

Equals

filter.enabled.isNullboolean

Check if field is null

filter.name.eqstring

Exact match

filter.name.notEqstring

Not equal to

filter.name.containsstring

Contains substring (case-insensitive)

filter.name.startsWithstring

Starts with prefix (case-insensitive)

filter.name.endsWithstring

Ends with suffix (case-insensitive)

filter.name.inArray of strings

Value is in the list

filter.name.notInArray of strings

Value is not in the list

filter.name.regexstring

Regular expression match

filter.name.isNullboolean

Check if field is null

filter.name.fuzzy.valuestring

Value to match against

filter.name.fuzzy.minSimilaritynumber(float)

Minimum similarity threshold (0.0-1.0)

filter.code.eqstring

Exact match

filter.code.notEqstring

Not equal to

filter.code.containsstring

Contains substring (case-insensitive)

filter.code.startsWithstring

Starts with prefix (case-insensitive)

filter.code.endsWithstring

Ends with suffix (case-insensitive)

filter.code.inArray of strings

Value is in the list

filter.code.notInArray of strings

Value is not in the list

filter.code.regexstring

Regular expression match

filter.code.isNullboolean

Check if field is null

filter.code.fuzzy.valuestring

Value to match against

filter.code.fuzzy.minSimilaritynumber(float)

Minimum similarity threshold (0.0-1.0)

filter.symbol.eqstring

Exact match

filter.symbol.notEqstring

Not equal to

filter.symbol.containsstring

Contains substring (case-insensitive)

filter.symbol.startsWithstring

Starts with prefix (case-insensitive)

filter.symbol.endsWithstring

Ends with suffix (case-insensitive)

filter.symbol.inArray of strings

Value is in the list

filter.symbol.notInArray of strings

Value is not in the list

filter.symbol.regexstring

Regular expression match

filter.symbol.isNullboolean

Check if field is null

filter.symbol.fuzzy.valuestring

Value to match against

filter.symbol.fuzzy.minSimilaritynumber(float)

Minimum similarity threshold (0.0-1.0)

search.termstring

Search term

search.fieldsArray of strings

Fields to search in

search.typestring

Type of search to perform

  • SEARCH_TYPE_CONTAINS: Default substring search
  • SEARCH_TYPE_STARTS_WITH: Prefix search
  • SEARCH_TYPE_EXACT: Exact match
  • SEARCH_TYPE_FUZZY: Fuzzy/similarity search
  • SEARCH_TYPE_FULLTEXT: Full-text search (future)
Enum"SEARCH_TYPE_CONTAINS""SEARCH_TYPE_STARTS_WITH""SEARCH_TYPE_EXACT""SEARCH_TYPE_FUZZY""SEARCH_TYPE_FULLTEXT"
search.minScorenumber(float)

Minimum relevance score for fuzzy/fulltext search

search.options.caseSensitiveboolean

Enable case-sensitive search (default: false)

search.options.minTermLengthinteger(int32)

Minimum search term length

search.options.maxResultsinteger(int32)

Maximum number of results to return

search.options.multiTermAndboolean

Use AND logic for multiple terms (default: false for OR)

pagination.pageSizeinteger(int32)

Number of results per page (default 50, max 1000)

pagination.pageTokenstring

Token for pagination from previous response

pagination.orderBystring

Field to order results by

pagination.orderstring

Sort order (ASC or DESC)

Enum"SORT_ORDER_ASC""SORT_ORDER_DESC"
curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/currencies?filter.enabled.eq=true&filter.enabled.isNull=true&filter.name.eq=string&filter.name.notEq=string&filter.name.contains=string&filter.name.startsWith=string&filter.name.endsWith=string&filter.name.in=string&filter.name.notIn=string&filter.name.regex=string&filter.name.isNull=true&filter.name.fuzzy.value=string&filter.name.fuzzy.minSimilarity=0.1&filter.code.eq=string&filter.code.notEq=string&filter.code.contains=string&filter.code.startsWith=string&filter.code.endsWith=string&filter.code.in=string&filter.code.notIn=string&filter.code.regex=string&filter.code.isNull=true&filter.code.fuzzy.value=string&filter.code.fuzzy.minSimilarity=0.1&filter.symbol.eq=string&filter.symbol.notEq=string&filter.symbol.contains=string&filter.symbol.startsWith=string&filter.symbol.endsWith=string&filter.symbol.in=string&filter.symbol.notIn=string&filter.symbol.regex=string&filter.symbol.isNull=true&filter.symbol.fuzzy.value=string&filter.symbol.fuzzy.minSimilarity=0.1&search.term=string&search.fields=string&search.type=SEARCH_TYPE_CONTAINS&search.minScore=0.1&search.options.caseSensitive=true&search.options.minTermLength=0&search.options.maxResults=0&search.options.multiTermAnd=true&pagination.pageSize=0&pagination.pageToken=string&pagination.orderBy=string&pagination.order=SORT_ORDER_ASC' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A successful response.

Bodyapplication/json
currenciesArray of objects(Currency uses the ISO 4217 standard)
paginationobject(v2PaginationResponse)
Response
application/json
{
  "currencies": [
    { … }
  ],
  "pagination": {
    "previousPageToken": "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA=",
    "nextPageToken": "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA=",
    "total": 100
  }
}

Create a new currency

Request

Create a new currency in the registry

Security
TokenAuth
Bodyapplication/jsonrequired
codestringrequired

ISO 4217 currency code

Example: "USD"
namestringrequired

Currency name

Example: "United States Dollar"
symbolstringrequired

Currency symbol

Example: "$"
decimalsinteger(int32)

Number of decimal places (default: 2)

Example: 2
enabledboolean

Whether the currency is enabled (default: true)

Example: true
curl -i -X POST \
  https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/currencies \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "code": "USD",
    "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
}

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
}

Transactions - Sweep

Operations

Sweep Instances

Operations