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

List counterparties

Request

List counterparties

Security
TokenAuth
Query
pageSizeinteger(int32)

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

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/counterparties?pageSize=0&pageToken=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

A successful response.

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

Create counterparties

Request

Create a new counterparty

Security
TokenAuth
Bodyapplication/jsonrequired
namestringrequired

The counterparty name

Example: "Palisade"
descriptionstring

The counterparty description

Example: "A counterparty used by the treasury department"
detailsobject(v2CounterpartyDetails)required
details.​typestring(v2CounterpartyType)required
Enum"ORGANIZATION""INDIVIDUAL""DAPP"
details.​individualobject(v2Individual)
details.​organizationobject(counterpartyv2Organization)
details.​dAppobject(v2DApp)
curl -i -X POST \
  https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/counterparties \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Palisade",
    "description": "A counterparty used by the treasury department",
    "details": {
      "type": "ORGANIZATION",
      "individual": {
        "firstName": "Joe",
        "lastName": "Bloggs",
        "address": {
          "address1": "Flat B",
          "address2": "10 Mayo Road",
          "city": "London",
          "state": "Greater London",
          "postCode": "W1 1AA",
          "country": "United Kingdom"
        }
      },
      "organization": {
        "legalName": "Palisade Financial",
        "address": {
          "address1": "Flat B",
          "address2": "10 Mayo Road",
          "city": "London",
          "state": "Greater London",
          "postCode": "W1 1AA",
          "country": "United Kingdom"
        }
      },
      "dApp": {}
    }
  }'

Responses

Bodyapplication/json
idstringrequired

The counterparty 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 counterparty

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

The date and time the counterparty was created

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

The ID of the user who updated this counterparty

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

The date and time the counterparty was updated

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

The counterparty name

Example: "Palisade"
descriptionstring

The counterparty description

Example: "A counterparty used by the treasury department"
detailsobject(v2CounterpartyDetails)required
details.​typestring(v2CounterpartyType)required
Enum"ORGANIZATION""INDIVIDUAL""DAPP"
details.​individualobject(v2Individual)
details.​organizationobject(counterpartyv2Organization)
details.​dAppobject(v2DApp)
addressCountinteger(int32)required

The number of addresses associated with the counterparty

Example: 5
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",
  "description": "A counterparty used by the treasury department",
  "details": {
    "type": "ORGANIZATION",
    "individual": { … },
    "organization": { … },
    "dApp": {}
  },
  "addressCount": 5
}

Get counterparties

Request

Get a counterparty

Security
TokenAuth
Path
idstringrequired

The counterparty ID

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

Responses

Bodyapplication/json
idstringrequired

The counterparty 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 counterparty

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

The date and time the counterparty was created

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

The ID of the user who updated this counterparty

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

The date and time the counterparty was updated

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

The counterparty name

Example: "Palisade"
descriptionstring

The counterparty description

Example: "A counterparty used by the treasury department"
detailsobject(v2CounterpartyDetails)required
details.​typestring(v2CounterpartyType)required
Enum"ORGANIZATION""INDIVIDUAL""DAPP"
details.​individualobject(v2Individual)
details.​organizationobject(counterpartyv2Organization)
details.​dAppobject(v2DApp)
addressCountinteger(int32)required

The number of addresses associated with the counterparty

Example: 5
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",
  "description": "A counterparty used by the treasury department",
  "details": {
    "type": "ORGANIZATION",
    "individual": { … },
    "organization": { … },
    "dApp": {}
  },
  "addressCount": 5
}

Delete counterparties

Request

Delete a counterparty

Security
TokenAuth
Path
idstringrequired

The counterparty ID

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

Responses

A successful response.

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

Update counterparties

Request

Update a counterparty

Security
TokenAuth
Path
idstringrequired

The counterparty ID

Bodyapplication/jsonrequired
namestringrequired

The counterparty name

Example: "Palisade"
descriptionstring

The counterparty description

Example: "A counterparty used by the treasury department"
curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/counterparties/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Palisade",
    "description": "A counterparty used by the treasury department"
  }'

Responses

Bodyapplication/json
idstringrequired

The counterparty 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 counterparty

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

The date and time the counterparty was created

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

The ID of the user who updated this counterparty

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

The date and time the counterparty was updated

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

The counterparty name

Example: "Palisade"
descriptionstring

The counterparty description

Example: "A counterparty used by the treasury department"
detailsobject(v2CounterpartyDetails)required
details.​typestring(v2CounterpartyType)required
Enum"ORGANIZATION""INDIVIDUAL""DAPP"
details.​individualobject(v2Individual)
details.​organizationobject(counterpartyv2Organization)
details.​dAppobject(v2DApp)
addressCountinteger(int32)required

The number of addresses associated with the counterparty

Example: 5
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",
  "description": "A counterparty used by the treasury department",
  "details": {
    "type": "ORGANIZATION",
    "individual": { … },
    "organization": { … },
    "dApp": {}
  },
  "addressCount": 5
}

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