Skip to content

Palisade API (2.0)

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

Download OpenAPI description
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
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Used to view information about the platform

Operations
Operations
Operations
Operations
Operations
Operations
Operations

Used to manage sweep configurations

Operations
Operations
Operations

Used to manage XRP specific transactions

Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Request

Create a new asset in the registry

Security
TokenAuth
Bodyapplication/jsonrequired
blockchainIdstring(v2Blockchain)required
Enum"AVALANCHE""ETHEREUM""XRP_LEDGER""POLYGON""BNBCHAIN""BASE""HEDERA""ARBITRUM""ONE_MONEY""SOLANA"
contractAddressstring

Contract address (empty for native assets)

Example: "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48"
symbolstringrequired

Asset symbol

Example: "USDC"
namestring

Asset name

Example: "USD Coin"
decimalsinteger(int32)

Number of decimal places

Example: 6
coingeckoIdstring

CoinGecko identifier for price data

Example: "usd-coin"
enabledboolean

Whether the asset is enabled (default: true)

Example: true
curl -i -X POST \
  https://docs.ripple.com/_mock/products/wallet/api-docs/palisade-api/palisade-api/v2/assets \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "blockchainId": "AVALANCHE",
    "contractAddress": "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
    "symbol": "USDC",
    "name": "USD Coin",
    "decimals": 6,
    "coingeckoId": "usd-coin",
    "enabled": true
  }'

Responses

Bodyapplication/json
idstringrequired

ID is unique across all blockchains and created by combining the blockchain ID, contract address, and symbol

Example: "5:0xbehbehfb:USDC"
standardstring(v2Standard)required
Enum"NATIVE""ERC20""ISSUED_CURRENCY""ERC721""SPL""CUSTOM"
symbolstringrequired

The currency symbol of the asset

Example: "LINK"
namestring

The human readable name of the asset

Example: "Chainlink"
blockchainstring(v2Blockchain)required
Enum"AVALANCHE""ETHEREUM""XRP_LEDGER""POLYGON""BNBCHAIN""BASE""HEDERA""ARBITRUM""ONE_MONEY""SOLANA"
decimalsinteger(int32)

Count of decimal places for the asset

Example: 18
vettedboolean

Whether the asset is vetted on the regulated platform

Example: true
enabledboolean

Whether the asset is currently enabled on the platform

Example: true
contractstring

The token contract address. This field will be empty if the asset is the native coin of the blockchain

Example: "0x0b9d5D9136855f6FEc3c0993feE6E9CE8a297846e"
createdAtstring(date-time)required

The date and time the asset was created

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

The date and time the asset was last updated

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

Organization ID for custom assets

coingeckoIdstring

CoinGecko identifier for price data (optional for testnet assets)

Example: "ethereum"
sourcestring(v2AssetSource)
Enum"ASSET_SOURCE_LEGACY""ASSET_SOURCE_AUTO""ASSET_SOURCE_COINGECKO""ASSET_SOURCE_PALISADE""ASSET_SOURCE_CUSTOMER"
sourceMetadataobject(protobufAny)
lastSyncedAtstring(date-time)

When this asset was last synchronized

Example: "2024-08-08T10:22:22.420Z"
syncVersioninteger(int32)

Version counter for sync updates

Example: 1
contractAddressChecksummedstring

Checksummed version of the contract address

Example: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
Response
application/json
{ "id": "5:0xbehbehfb:USDC", "standard": "NATIVE", "symbol": "LINK", "name": "Chainlink", "blockchain": "AVALANCHE", "decimals": 18, "vetted": true, "enabled": true, "contract": "0x0b9d5D9136855f6FEc3c0993feE6E9CE8a297846e", "createdAt": "2022-03-29T10:22:22.420Z", "updatedAt": "2022-03-29T10:22:22.420Z", "organizationId": "string", "coingeckoId": "ethereum", "source": "ASSET_SOURCE_LEGACY", "sourceMetadata": { "@type": "string", "property1": null, "property2": null }, "lastSyncedAt": "2024-08-08T10:22:22.420Z", "syncVersion": 1, "contractAddressChecksummed": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" }

Request

Get asset configuration by ID

Security
TokenAuth
Path
idstringrequired

Asset ID in format blockchain:contract:symbol

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

Responses

Bodyapplication/json
idstringrequired

ID is unique across all blockchains and created by combining the blockchain ID, contract address, and symbol

Example: "5:0xbehbehfb:USDC"
standardstring(v2Standard)required
Enum"NATIVE""ERC20""ISSUED_CURRENCY""ERC721""SPL""CUSTOM"
symbolstringrequired

The currency symbol of the asset

Example: "LINK"
namestring

The human readable name of the asset

Example: "Chainlink"
blockchainstring(v2Blockchain)required
Enum"AVALANCHE""ETHEREUM""XRP_LEDGER""POLYGON""BNBCHAIN""BASE""HEDERA""ARBITRUM""ONE_MONEY""SOLANA"
decimalsinteger(int32)

Count of decimal places for the asset

Example: 18
vettedboolean

Whether the asset is vetted on the regulated platform

Example: true
enabledboolean

Whether the asset is currently enabled on the platform

Example: true
contractstring

The token contract address. This field will be empty if the asset is the native coin of the blockchain

Example: "0x0b9d5D9136855f6FEc3c0993feE6E9CE8a297846e"
createdAtstring(date-time)required

The date and time the asset was created

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

The date and time the asset was last updated

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

Organization ID for custom assets

coingeckoIdstring

CoinGecko identifier for price data (optional for testnet assets)

Example: "ethereum"
sourcestring(v2AssetSource)
Enum"ASSET_SOURCE_LEGACY""ASSET_SOURCE_AUTO""ASSET_SOURCE_COINGECKO""ASSET_SOURCE_PALISADE""ASSET_SOURCE_CUSTOMER"
sourceMetadataobject(protobufAny)
lastSyncedAtstring(date-time)

When this asset was last synchronized

Example: "2024-08-08T10:22:22.420Z"
syncVersioninteger(int32)

Version counter for sync updates

Example: 1
contractAddressChecksummedstring

Checksummed version of the contract address

Example: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"
Response
application/json
{ "id": "5:0xbehbehfb:USDC", "standard": "NATIVE", "symbol": "LINK", "name": "Chainlink", "blockchain": "AVALANCHE", "decimals": 18, "vetted": true, "enabled": true, "contract": "0x0b9d5D9136855f6FEc3c0993feE6E9CE8a297846e", "createdAt": "2022-03-29T10:22:22.420Z", "updatedAt": "2022-03-29T10:22:22.420Z", "organizationId": "string", "coingeckoId": "ethereum", "source": "ASSET_SOURCE_LEGACY", "sourceMetadata": { "@type": "string", "property1": null, "property2": null }, "lastSyncedAt": "2024-08-08T10:22:22.420Z", "syncVersion": 1, "contractAddressChecksummed": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48" }

Request

Soft delete an asset from the registry

Security
TokenAuth
Path
idstringrequired

Asset ID to delete

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

Responses

A successful response.

Bodyapplication/json
object(v2ManagementDeleteAssetResponse)
Response
application/json
{}
Operations
Operations