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

List webhooks

Request

List webhooks

Security
TokenAuth
Query
pageSizeinteger(int32)

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

pageTokenstring

The token to retrieve the next page of results

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

Responses

A successful response.

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

Create webhooks

Request

Create a new webhook

Security
TokenAuth
Bodyapplication/jsonrequired
namestringrequired

The webhook name.

Example: "Palisade Transactions"
descriptionstring

The webhook description.

Example: "A webhook used to monitor transactions"
endpointstringrequired

The webhook endpoint to send data to

Example: "https://palisade.co/webhook"
curl -i -X POST \
  https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/webhooks \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Palisade Transactions",
    "description": "A webhook used to monitor transactions",
    "endpoint": "https://palisade.co/webhook"
  }'

Responses

Bodyapplication/json
idstringrequired

The webhook ID.

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

The organization ID

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

The ID of the user who created this webhook

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

The date and time the webhook was created

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

The ID of the user who updated this webhook

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

The date and time the webhook was updated

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

The webhook name

Example: "Palisade Transactions"
descriptionstring

The webhook description

Example: "A webhook used to monitor transactions"
endpointstringrequired

The webhook endpoint to send data to

Example: "https://palisade.co/webhook"
subscriptionCountinteger(int32)required

The number of subscriptions associated with the webhook

Example: 5
publicKeystringrequired

The public key used to verify the webhook signature

Example: "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEpHiEkdd/ba5dU4sNCgsWrMOE6fLakHywl0OgF5aVfxkiqNh22oybRAREev7jvnwH4jqitHx79KGi6CMwiJjmaw=="
lastSuccessstring(date-time)

The timestamp of the last successful webhook delivery

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

The timestamp of the last failed webhook delivery

Example: "2022-03-29T10:22:22.420Z"
successCountinteger(int32)required

The number of successful webhook deliveries in the last hour

Example: 42
failureCountinteger(int32)required

The number of failed webhook deliveries in the last hour

Example: 3
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "name": "Palisade Transactions",
  "description": "A webhook used to monitor transactions",
  "endpoint": "https://palisade.co/webhook",
  "subscriptionCount": 5,
  "publicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEpHiEkdd/ba5dU4sNCgsWrMOE6fLakHywl0OgF5aVfxkiqNh22oybRAREev7jvnwH4jqitHx79KGi6CMwiJjmaw==",
  "lastSuccess": "2022-03-29T10:22:22.420Z",
  "lastFailure": "2022-03-29T10:22:22.420Z",
  "successCount": 42,
  "failureCount": 3
}

Get webhooks

Request

Get a single webhook based on its ID

Security
TokenAuth
Path
idstringrequired

The webhook ID

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

Responses

Bodyapplication/json
idstringrequired

The webhook ID.

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

The organization ID

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

The ID of the user who created this webhook

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

The date and time the webhook was created

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

The ID of the user who updated this webhook

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

The date and time the webhook was updated

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

The webhook name

Example: "Palisade Transactions"
descriptionstring

The webhook description

Example: "A webhook used to monitor transactions"
endpointstringrequired

The webhook endpoint to send data to

Example: "https://palisade.co/webhook"
subscriptionCountinteger(int32)required

The number of subscriptions associated with the webhook

Example: 5
publicKeystringrequired

The public key used to verify the webhook signature

Example: "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEpHiEkdd/ba5dU4sNCgsWrMOE6fLakHywl0OgF5aVfxkiqNh22oybRAREev7jvnwH4jqitHx79KGi6CMwiJjmaw=="
lastSuccessstring(date-time)

The timestamp of the last successful webhook delivery

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

The timestamp of the last failed webhook delivery

Example: "2022-03-29T10:22:22.420Z"
successCountinteger(int32)required

The number of successful webhook deliveries in the last hour

Example: 42
failureCountinteger(int32)required

The number of failed webhook deliveries in the last hour

Example: 3
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "name": "Palisade Transactions",
  "description": "A webhook used to monitor transactions",
  "endpoint": "https://palisade.co/webhook",
  "subscriptionCount": 5,
  "publicKey": "MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAEpHiEkdd/ba5dU4sNCgsWrMOE6fLakHywl0OgF5aVfxkiqNh22oybRAREev7jvnwH4jqitHx79KGi6CMwiJjmaw==",
  "lastSuccess": "2022-03-29T10:22:22.420Z",
  "lastFailure": "2022-03-29T10:22:22.420Z",
  "successCount": 42,
  "failureCount": 3
}

Delete webhooks

Request

Delete a single webhook based on its ID

Security
TokenAuth
Path
idstringrequired

The webhook ID

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

Responses

A successful response.

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

List subscriptions

Request

List subscriptions

Security
TokenAuth
Path
webhookIdstringrequired

The webhook ID

Query
pageSizeinteger(int32)

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

pageTokenstring

The token to retrieve the next page of results

curl -i -X GET \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/webhooks/{webhookId}/subscriptions?pageSize=0&pageToken=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A successful response.

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

Create webhook subscriptions

Request

Create one or more new webhook subscription

Security
TokenAuth
Path
webhookIdstringrequired

The webhook ID

Bodyapplication/jsonrequiredArray [
domainstring(v2SubscriptionDomain)required
Enum"TRANSACTION""WALLET""APPROVAL"
scopestring(v2SubscriptionScope)required
Value"ORG"
]
curl -i -X POST \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/webhooks/{webhookId}/subscriptions' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "domain": "TRANSACTION",
      "scope": "ORG"
    }
  ]'

Responses

Bodyapplication/jsonArray [
idstringrequired

The webhook subscription ID

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

The webhook ID

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

The organization ID

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

The ID of the user who created this webhook

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

The date and time the webhook was created

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

The ID of the user who updated this webhook

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

The date and time the webhook was updated

Example: "2022-03-29T10:22:22.420Z"
configobject(v2SubscriptionConfig)required
config.​domainstring(v2SubscriptionDomain)required
Enum"TRANSACTION""WALLET""APPROVAL"
config.​scopestring(v2SubscriptionScope)required
Value"ORG"
]
Response
application/json
[
  {
    "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "webhookId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "createdAt": "2022-03-29T10:22:22.420Z",
    "updatedBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "updatedAt": "2022-03-29T10:22:22.420Z",
    "config": { … }
  }
]

Get subscriptions

Request

Get a single subscription based on its ID

Security
TokenAuth
Path
webhookIdstringrequired

The webhook ID

subscriptionIdstringrequired

The subscription ID

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

Responses

Bodyapplication/json
idstringrequired

The webhook subscription ID

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

The webhook ID

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

The organization ID

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

The ID of the user who created this webhook

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

The date and time the webhook was created

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

The ID of the user who updated this webhook

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

The date and time the webhook was updated

Example: "2022-03-29T10:22:22.420Z"
configobject(v2SubscriptionConfig)required
config.​domainstring(v2SubscriptionDomain)required
Enum"TRANSACTION""WALLET""APPROVAL"
config.​scopestring(v2SubscriptionScope)required
Value"ORG"
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "webhookId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "organizationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "config": {
    "domain": "TRANSACTION",
    "scope": "ORG"
  }
}

Delete subscriptions

Request

Delete a single subscription based on its ID

Security
TokenAuth
Path
webhookIdstringrequired

The webhook ID

subscriptionIdstringrequired

The subscription ID

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

Responses

A successful response.

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

Registry

Operations

Transactions - Sweep

Operations

Sweep Instances

Operations