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

Transactions - Sweep

Operations

Sweep Instances

Operations

Get sweep instance by ID

Request

Get a single sweep instance by its ID

Security
TokenAuth
Path
idstringrequired

The ID of the sweep instance

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

Responses

Bodyapplication/json
idstringrequired

The sweep instance ID

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

The sweep configuration ID

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

The date and time the sweep instance was started

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

The date and time the sweep instance was completed

Example: "2022-03-29T10:22:22.420Z"
totalWalletsSweptstring(uint64)required

The total number of wallets swept in the sweep instance

Example: "5"
totalSuccessfulWalletsstring(uint64)required

The number of wallets successfully swept in the sweep instance

Example: "5"
totalFailedWalletsstring(uint64)required

The number of wallets that failed to sweep in the sweep instance

Example: "2"
totalAmountSweptobjectrequired

A map of blockchain asset to total amount swept in the sweep instance

Example: {"BTC":"100.00","ETH":"50.00"}
totalAmountSwept.​property name*stringadditional property
incomingFeestringrequired

the incoming estimated fee from the funder wallets

Example: "1.00"
statusstring(v2SweepingInstanceStatus)required
Enum"STATUS_COMPLETED""STATUS_FAILED""STATUS_RUNNING"
errorMessagestring

Error message in case the sweep failed

Example: "Insufficient funds for transaction"
outgoingFeestring

The actual outgoing fee for the sweep instance

Example: "0.01"
Response
application/json
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "sweepConfigurationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "startedAt": "2022-03-29T10:22:22.420Z",
  "completedAt": "2022-03-29T10:22:22.420Z",
  "totalWalletsSwept": "5",
  "totalSuccessfulWallets": "5",
  "totalFailedWallets": "2",
  "totalAmountSwept": {
    "BTC": "100.00",
    "ETH": "50.00"
  },
  "incomingFee": "1.00",
  "status": "STATUS_COMPLETED",
  "errorMessage": "Insufficient funds for transaction",
  "outgoingFee": "0.01"
}

List sweep instances

Request

List sweep instances for a sweep configuration

Security
TokenAuth
Path
sweepConfigurationIdstringrequired

The ID of the sweep configuration to list instances for

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/workflows/sweep/{sweepConfigurationId}/instances?pageSize=0&pageToken=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A successful response.

Bodyapplication/json
filterobject(v2FilterResponse)
sweepInstancesArray of objects(v2SweepInstance)

The list of sweep instances with metadata

Response
application/json
{
  "filter": {
    "previousPageToken": "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA=",
    "nextPageToken": "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA=",
    "total": 100
  },
  "sweepInstances": [
    { … }
  ]
}