Delete sweep configuration

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

List sweep configurations

Request

List sweep configurations

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

Responses

A successful response.

Bodyapplication/json

filterobject(v2FilterResponse)

sweepConfigurationsArray of objects(v2SweepConfiguration)

The list of sweep configurations

Response

application/json

{
  "filter": {
    "previousPageToken": "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA=",
    "nextPageToken": "cGFnZV9zaXplPTEwJnBhZ2VfdG9rZW49MjA=",
    "total": 100
  },
  "sweepConfigurations": [
    { … }
  ]
}

Create sweep configuration

Request

Create a new sweep configuration

Security

TokenAuth

Bodyapplication/jsonrequired

namestringrequired

The sweep configuration name

Example: "Customer deposit sweep"

descriptionstring

The sweep configuration description

Example: "A sweep configuration used to sweep customer deposits"

blockchainstring(Supported blockchains)required

Enum"AVALANCHE""ETHEREUM""XRP_LEDGER""POLYGON""BNBCHAIN""BASE""HEDERA""ARBITRUM""ONE_MONEY""SOLANA"

feeWalletobject(v2VaultWalletIdentifier)required

feeWallet.walletIdstringrequired

The ID of the wallet

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

feeWallet.vaultIdstringrequired

The ID of the vault

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

destinationWalletobject(v2VaultWalletIdentifier)required

destinationWallet.walletIdstringrequired

The ID of the wallet

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

destinationWallet.vaultIdstringrequired

The ID of the vault

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

sweepFrequencystring(v2SweepFrequency)required

Enum"SWEEP_FREQUENCY_HOURLY""SWEEP_FREQUENCY_DAILY"

assetsArray of objects(v2SweepAsset)required

The assets to sweep

assets[].contractstring

The contract/issuing address

Example: "0xdAC17F958D2ee523a2206206994597C13D831ec7"

assets[].symbolstringrequired

The asset symbol

Example: "USD"

assets[].minimumSweepQtystringrequired

The minimum sweep qty

Example: "10.00"

curl -i -X POST \
  https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/workflows/sweep \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Customer deposit sweep",
    "description": "A sweep configuration used to sweep customer deposits",
    "blockchain": "AVALANCHE",
    "feeWallet": {
      "walletId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
      "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384"
    },
    "destinationWallet": {
      "walletId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
      "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384"
    },
    "sweepFrequency": "SWEEP_FREQUENCY_HOURLY",
    "assets": [
      {
        "contract": "0xdAC17F958D2ee523a2206206994597C13D831ec7",
        "symbol": "USD",
        "minimumSweepQty": "10.00"
      }
    ]
  }'

Responses

Bodyapplication/json

idstringrequired

The sweep configuration 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 sweep configuration

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

createdAtstring(date-time)required

The date and time the sweep configuration was created

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

updatedBystringrequired

The ID of the user who updated this sweep configuration

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

updatedAtstring(date-time)required

The date and time the sweep configuration was updated

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

namestringrequired

The sweep configuration name

Example: "Customer deposit sweep"

descriptionstring

The sweep configuration description

Example: "A sweep configuration used to sweep customer deposits"

blockchainstring(Supported blockchains)required

Enum"AVALANCHE""ETHEREUM""XRP_LEDGER""POLYGON""BNBCHAIN""BASE""HEDERA""ARBITRUM""ONE_MONEY""SOLANA"

feeWalletobject(v2VaultWalletIdentifier)required

feeWallet.walletIdstringrequired

The ID of the wallet

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

feeWallet.vaultIdstringrequired

The ID of the vault

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

destinationWalletobject(v2VaultWalletIdentifier)required

destinationWallet.walletIdstringrequired

The ID of the wallet

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

destinationWallet.vaultIdstringrequired

The ID of the vault

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

sweepFrequencystring(v2SweepFrequency)required

Enum"SWEEP_FREQUENCY_HOURLY""SWEEP_FREQUENCY_DAILY"

assetsArray of objects(v2HydratedSweepAsset)required

The assets to sweep

assets[].assetobject(commonv2Asset)required

Asset is any blockchain asset e.g. USDC, XRP etc.

assets[].asset.idstringrequired

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

Example: "5:0xbehbehfb:USDC"

assets[].asset.standardstring(Supported asset types)required

Enum"NATIVE""ERC20""ISSUED_CURRENCY""ERC721""SPL""CUSTOM"

assets[].asset.symbolstringrequired

The currency symbol of the asset

Example: "LINK"

assets[].asset.namestring

The human readable name of the asset

Example: "Chainlink"

assets[].asset.blockchainstring(Supported blockchains)required

Enum"AVALANCHE""ETHEREUM""XRP_LEDGER""POLYGON""BNBCHAIN""BASE""HEDERA""ARBITRUM""ONE_MONEY""SOLANA"

assets[].asset.decimalsinteger(int32)

Count of decimal places for the asset

Example: 18

assets[].asset.vettedboolean

Whether the asset is vetted on the regulated platform

Example: true

assets[].asset.enabledboolean

Whether the asset is currently enabled on the platform

Example: true

assets[].asset.contractstring

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

Example: "0x0b9d5D9136855f6FEc3c0993feE6E9CE8a297846e"

assets[].asset.createdAtstring(date-time)required

The date and time the asset was created

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

assets[].asset.updatedAtstring(date-time)

The date and time the asset was last updated

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

assets[].asset.organizationIdstring

Organization ID for custom assets

assets[].asset.coingeckoIdstring

CoinGecko identifier for price data (optional for testnet assets)

Example: "ethereum"

assets[].asset.sourcestring(AssetSource defines the source of asset data)

ASSET_SOURCE_LEGACY: Legacy entries
ASSET_SOURCE_AUTO: Auto-generated
ASSET_SOURCE_COINGECKO: From CoinGecko sync
ASSET_SOURCE_PALISADE: Admin entries
ASSET_SOURCE_CUSTOMER: Customer entries

Enum"ASSET_SOURCE_LEGACY""ASSET_SOURCE_AUTO""ASSET_SOURCE_COINGECKO""ASSET_SOURCE_PALISADE""ASSET_SOURCE_CUSTOMER"

assets[].asset.sourceMetadataobject(protobufAny)

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

Example 2: Pack and unpack a message in Java.

Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } // or ... if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); }

Example 3: Pack and unpack a message in Python.

foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

JSON ==== The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:

package google.profile; message Person { string first_name = 1; string last_name = 2; }

{ "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]):

{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

assets[].asset.lastSyncedAtstring(date-time)

When this asset was last synchronized

Example: "2024-08-08T10:22:22.420Z"

assets[].asset.syncVersioninteger(int32)

Version counter for sync updates

Example: 1

assets[].asset.contractAddressChecksummedstring

Checksummed version of the contract address

Example: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"

assets[].minimumSweepQtystringrequired

The minimum sweep qty

Example: "10.00"

statusstring(v2SweepStatus)required

Enum"SWEEP_STATUS_ENABLED""SWEEP_STATUS_DISABLED"

lastSweptstring(date-time)

The date and time the sweep configuration was last executed

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

sweepRunningbooleanrequired

Whether the sweep is currently running

Example: true

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": "Customer deposit sweep",
  "description": "A sweep configuration used to sweep customer deposits",
  "blockchain": "AVALANCHE",
  "feeWallet": {
    "walletId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384"
  },
  "destinationWallet": {
    "walletId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384"
  },
  "sweepFrequency": "SWEEP_FREQUENCY_HOURLY",
  "assets": [
    { … }
  ],
  "status": "SWEEP_STATUS_ENABLED",
  "lastSwept": "2022-03-29T10:22:22.420Z",
  "sweepRunning": true
}

Get sweep configuration

Request

Get a single sweep configuration based on its ID

Security

TokenAuth

Path

idstringrequired

The ID of the sweep configuration

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

Responses

Bodyapplication/json

idstringrequired

The sweep configuration 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 sweep configuration

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

createdAtstring(date-time)required

The date and time the sweep configuration was created

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

updatedBystringrequired

The ID of the user who updated this sweep configuration

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

updatedAtstring(date-time)required

The date and time the sweep configuration was updated

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

namestringrequired

The sweep configuration name

Example: "Customer deposit sweep"

descriptionstring

The sweep configuration description

Example: "A sweep configuration used to sweep customer deposits"

blockchainstring(Supported blockchains)required

Enum"AVALANCHE""ETHEREUM""XRP_LEDGER""POLYGON""BNBCHAIN""BASE""HEDERA""ARBITRUM""ONE_MONEY""SOLANA"

feeWalletobject(v2VaultWalletIdentifier)required

feeWallet.walletIdstringrequired

The ID of the wallet

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

feeWallet.vaultIdstringrequired

The ID of the vault

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

destinationWalletobject(v2VaultWalletIdentifier)required

destinationWallet.walletIdstringrequired

The ID of the wallet

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

destinationWallet.vaultIdstringrequired

The ID of the vault

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

sweepFrequencystring(v2SweepFrequency)required

Enum"SWEEP_FREQUENCY_HOURLY""SWEEP_FREQUENCY_DAILY"

assetsArray of objects(v2HydratedSweepAsset)required

The assets to sweep

assets[].assetobject(commonv2Asset)required

Asset is any blockchain asset e.g. USDC, XRP etc.

assets[].asset.idstringrequired

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

Example: "5:0xbehbehfb:USDC"

assets[].asset.standardstring(Supported asset types)required

Enum"NATIVE""ERC20""ISSUED_CURRENCY""ERC721""SPL""CUSTOM"

assets[].asset.symbolstringrequired

The currency symbol of the asset

Example: "LINK"

assets[].asset.namestring

The human readable name of the asset

Example: "Chainlink"

assets[].asset.blockchainstring(Supported blockchains)required

Enum"AVALANCHE""ETHEREUM""XRP_LEDGER""POLYGON""BNBCHAIN""BASE""HEDERA""ARBITRUM""ONE_MONEY""SOLANA"

assets[].asset.decimalsinteger(int32)

Count of decimal places for the asset

Example: 18

assets[].asset.vettedboolean

Whether the asset is vetted on the regulated platform

Example: true

assets[].asset.enabledboolean

Whether the asset is currently enabled on the platform

Example: true

assets[].asset.contractstring

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

Example: "0x0b9d5D9136855f6FEc3c0993feE6E9CE8a297846e"

assets[].asset.createdAtstring(date-time)required

The date and time the asset was created

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

assets[].asset.updatedAtstring(date-time)

The date and time the asset was last updated

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

assets[].asset.organizationIdstring

Organization ID for custom assets

assets[].asset.coingeckoIdstring

CoinGecko identifier for price data (optional for testnet assets)

Example: "ethereum"

assets[].asset.sourcestring(AssetSource defines the source of asset data)

ASSET_SOURCE_LEGACY: Legacy entries
ASSET_SOURCE_AUTO: Auto-generated
ASSET_SOURCE_COINGECKO: From CoinGecko sync
ASSET_SOURCE_PALISADE: Admin entries
ASSET_SOURCE_CUSTOMER: Customer entries

Enum"ASSET_SOURCE_LEGACY""ASSET_SOURCE_AUTO""ASSET_SOURCE_COINGECKO""ASSET_SOURCE_PALISADE""ASSET_SOURCE_CUSTOMER"

assets[].asset.sourceMetadataobject(protobufAny)

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

Example 2: Pack and unpack a message in Java.

Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } // or ... if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); }

Example 3: Pack and unpack a message in Python.

foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

JSON ==== The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:

package google.profile; message Person { string first_name = 1; string last_name = 2; }

{ "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]):

{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

assets[].asset.lastSyncedAtstring(date-time)

When this asset was last synchronized

Example: "2024-08-08T10:22:22.420Z"

assets[].asset.syncVersioninteger(int32)

Version counter for sync updates

Example: 1

assets[].asset.contractAddressChecksummedstring

Checksummed version of the contract address

Example: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"

assets[].minimumSweepQtystringrequired

The minimum sweep qty

Example: "10.00"

statusstring(v2SweepStatus)required

Enum"SWEEP_STATUS_ENABLED""SWEEP_STATUS_DISABLED"

lastSweptstring(date-time)

The date and time the sweep configuration was last executed

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

sweepRunningbooleanrequired

Whether the sweep is currently running

Example: true

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": "Customer deposit sweep",
  "description": "A sweep configuration used to sweep customer deposits",
  "blockchain": "AVALANCHE",
  "feeWallet": {
    "walletId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384"
  },
  "destinationWallet": {
    "walletId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384"
  },
  "sweepFrequency": "SWEEP_FREQUENCY_HOURLY",
  "assets": [
    { … }
  ],
  "status": "SWEEP_STATUS_ENABLED",
  "lastSwept": "2022-03-29T10:22:22.420Z",
  "sweepRunning": true
}

Delete sweep configuration

Request

Delete a single sweep configuration based on its ID

Security

TokenAuth

Path

idstringrequired

The ID of the sweep configuration

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

Responses

A successful response.

Bodyapplication/json

object(v2DeleteSweepConfigurationResponse)

Response

application/json

{}

Update sweep configuration

Request

Update an existing sweep configuration

Security

TokenAuth

Path

idstringrequired

The ID of the sweep configuration to update

Bodyapplication/jsonrequired

namestringrequired

The sweep configuration name

Example: "Updated customer deposit sweep"

descriptionstring

The sweep configuration description

Example: "An updated sweep configuration used to sweep customer deposits"

feeWalletobject(v2VaultWalletIdentifier)required

feeWallet.walletIdstringrequired

The ID of the wallet

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

feeWallet.vaultIdstringrequired

The ID of the vault

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

destinationWalletobject(v2VaultWalletIdentifier)required

destinationWallet.walletIdstringrequired

The ID of the wallet

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

destinationWallet.vaultIdstringrequired

The ID of the vault

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

sweepFrequencystring(v2SweepFrequency)required

Enum"SWEEP_FREQUENCY_HOURLY""SWEEP_FREQUENCY_DAILY"

assetsArray of objects(v2SweepAsset)required

The assets to sweep

assets[].contractstring

The contract/issuing address

Example: "0xdAC17F958D2ee523a2206206994597C13D831ec7"

assets[].symbolstringrequired

The asset symbol

Example: "USD"

assets[].minimumSweepQtystringrequired

The minimum sweep qty

Example: "10.00"

curl -i -X PUT \
  'https://docs.ripple.com/_mock/products/palisade/api-docs/palisade-api/palisade-api-1/v2/workflows/sweep/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Updated customer deposit sweep",
    "description": "An updated sweep configuration used to sweep customer deposits",
    "feeWallet": {
      "walletId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
      "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384"
    },
    "destinationWallet": {
      "walletId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
      "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384"
    },
    "sweepFrequency": "SWEEP_FREQUENCY_HOURLY",
    "assets": [
      {
        "contract": "0xdAC17F958D2ee523a2206206994597C13D831ec7",
        "symbol": "USD",
        "minimumSweepQty": "10.00"
      }
    ]
  }'

Responses

Bodyapplication/json

idstringrequired

The sweep configuration 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 sweep configuration

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

createdAtstring(date-time)required

The date and time the sweep configuration was created

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

updatedBystringrequired

The ID of the user who updated this sweep configuration

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

updatedAtstring(date-time)required

The date and time the sweep configuration was updated

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

namestringrequired

The sweep configuration name

Example: "Customer deposit sweep"

descriptionstring

The sweep configuration description

Example: "A sweep configuration used to sweep customer deposits"

blockchainstring(Supported blockchains)required

Enum"AVALANCHE""ETHEREUM""XRP_LEDGER""POLYGON""BNBCHAIN""BASE""HEDERA""ARBITRUM""ONE_MONEY""SOLANA"

feeWalletobject(v2VaultWalletIdentifier)required

feeWallet.walletIdstringrequired

The ID of the wallet

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

feeWallet.vaultIdstringrequired

The ID of the vault

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

destinationWalletobject(v2VaultWalletIdentifier)required

destinationWallet.walletIdstringrequired

The ID of the wallet

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

destinationWallet.vaultIdstringrequired

The ID of the vault

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

sweepFrequencystring(v2SweepFrequency)required

Enum"SWEEP_FREQUENCY_HOURLY""SWEEP_FREQUENCY_DAILY"

assetsArray of objects(v2HydratedSweepAsset)required

The assets to sweep

assets[].assetobject(commonv2Asset)required

Asset is any blockchain asset e.g. USDC, XRP etc.

assets[].asset.idstringrequired

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

Example: "5:0xbehbehfb:USDC"

assets[].asset.standardstring(Supported asset types)required

Enum"NATIVE""ERC20""ISSUED_CURRENCY""ERC721""SPL""CUSTOM"

assets[].asset.symbolstringrequired

The currency symbol of the asset

Example: "LINK"

assets[].asset.namestring

The human readable name of the asset

Example: "Chainlink"

assets[].asset.blockchainstring(Supported blockchains)required

Enum"AVALANCHE""ETHEREUM""XRP_LEDGER""POLYGON""BNBCHAIN""BASE""HEDERA""ARBITRUM""ONE_MONEY""SOLANA"

assets[].asset.decimalsinteger(int32)

Count of decimal places for the asset

Example: 18

assets[].asset.vettedboolean

Whether the asset is vetted on the regulated platform

Example: true

assets[].asset.enabledboolean

Whether the asset is currently enabled on the platform

Example: true

assets[].asset.contractstring

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

Example: "0x0b9d5D9136855f6FEc3c0993feE6E9CE8a297846e"

assets[].asset.createdAtstring(date-time)required

The date and time the asset was created

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

assets[].asset.updatedAtstring(date-time)

The date and time the asset was last updated

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

assets[].asset.organizationIdstring

Organization ID for custom assets

assets[].asset.coingeckoIdstring

CoinGecko identifier for price data (optional for testnet assets)

Example: "ethereum"

assets[].asset.sourcestring(AssetSource defines the source of asset data)

ASSET_SOURCE_LEGACY: Legacy entries
ASSET_SOURCE_AUTO: Auto-generated
ASSET_SOURCE_COINGECKO: From CoinGecko sync
ASSET_SOURCE_PALISADE: Admin entries
ASSET_SOURCE_CUSTOMER: Customer entries

Enum"ASSET_SOURCE_LEGACY""ASSET_SOURCE_AUTO""ASSET_SOURCE_COINGECKO""ASSET_SOURCE_PALISADE""ASSET_SOURCE_CUSTOMER"

assets[].asset.sourceMetadataobject(protobufAny)

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

Example 2: Pack and unpack a message in Java.

Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } // or ... if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); }

Example 3: Pack and unpack a message in Python.

foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

JSON ==== The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:

package google.profile; message Person { string first_name = 1; string last_name = 2; }

{ "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]):

{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

assets[].asset.lastSyncedAtstring(date-time)

When this asset was last synchronized

Example: "2024-08-08T10:22:22.420Z"

assets[].asset.syncVersioninteger(int32)

Version counter for sync updates

Example: 1

assets[].asset.contractAddressChecksummedstring

Checksummed version of the contract address

Example: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"

assets[].minimumSweepQtystringrequired

The minimum sweep qty

Example: "10.00"

statusstring(v2SweepStatus)required

Enum"SWEEP_STATUS_ENABLED""SWEEP_STATUS_DISABLED"

lastSweptstring(date-time)

The date and time the sweep configuration was last executed

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

sweepRunningbooleanrequired

Whether the sweep is currently running

Example: true

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": "Customer deposit sweep",
  "description": "A sweep configuration used to sweep customer deposits",
  "blockchain": "AVALANCHE",
  "feeWallet": {
    "walletId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384"
  },
  "destinationWallet": {
    "walletId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384"
  },
  "sweepFrequency": "SWEEP_FREQUENCY_HOURLY",
  "assets": [
    { … }
  ],
  "status": "SWEEP_STATUS_ENABLED",
  "lastSwept": "2022-03-29T10:22:22.420Z",
  "sweepRunning": true
}

Disable sweep configuration

Request

Disable a single sweep configuration based on its ID

Security

TokenAuth

Path

idstringrequired

The ID of the sweep configuration

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

Responses

Bodyapplication/json

idstringrequired

The sweep configuration 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 sweep configuration

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

createdAtstring(date-time)required

The date and time the sweep configuration was created

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

updatedBystringrequired

The ID of the user who updated this sweep configuration

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

updatedAtstring(date-time)required

The date and time the sweep configuration was updated

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

namestringrequired

The sweep configuration name

Example: "Customer deposit sweep"

descriptionstring

The sweep configuration description

Example: "A sweep configuration used to sweep customer deposits"

blockchainstring(Supported blockchains)required

Enum"AVALANCHE""ETHEREUM""XRP_LEDGER""POLYGON""BNBCHAIN""BASE""HEDERA""ARBITRUM""ONE_MONEY""SOLANA"

feeWalletobject(v2VaultWalletIdentifier)required

feeWallet.walletIdstringrequired

The ID of the wallet

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

feeWallet.vaultIdstringrequired

The ID of the vault

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

destinationWalletobject(v2VaultWalletIdentifier)required

destinationWallet.walletIdstringrequired

The ID of the wallet

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

destinationWallet.vaultIdstringrequired

The ID of the vault

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

sweepFrequencystring(v2SweepFrequency)required

Enum"SWEEP_FREQUENCY_HOURLY""SWEEP_FREQUENCY_DAILY"

assetsArray of objects(v2HydratedSweepAsset)required

The assets to sweep

assets[].assetobject(commonv2Asset)required

Asset is any blockchain asset e.g. USDC, XRP etc.

assets[].asset.idstringrequired

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

Example: "5:0xbehbehfb:USDC"

assets[].asset.standardstring(Supported asset types)required

Enum"NATIVE""ERC20""ISSUED_CURRENCY""ERC721""SPL""CUSTOM"

assets[].asset.symbolstringrequired

The currency symbol of the asset

Example: "LINK"

assets[].asset.namestring

The human readable name of the asset

Example: "Chainlink"

assets[].asset.blockchainstring(Supported blockchains)required

Enum"AVALANCHE""ETHEREUM""XRP_LEDGER""POLYGON""BNBCHAIN""BASE""HEDERA""ARBITRUM""ONE_MONEY""SOLANA"

assets[].asset.decimalsinteger(int32)

Count of decimal places for the asset

Example: 18

assets[].asset.vettedboolean

Whether the asset is vetted on the regulated platform

Example: true

assets[].asset.enabledboolean

Whether the asset is currently enabled on the platform

Example: true

assets[].asset.contractstring

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

Example: "0x0b9d5D9136855f6FEc3c0993feE6E9CE8a297846e"

assets[].asset.createdAtstring(date-time)required

The date and time the asset was created

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

assets[].asset.updatedAtstring(date-time)

The date and time the asset was last updated

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

assets[].asset.organizationIdstring

Organization ID for custom assets

assets[].asset.coingeckoIdstring

CoinGecko identifier for price data (optional for testnet assets)

Example: "ethereum"

assets[].asset.sourcestring(AssetSource defines the source of asset data)

ASSET_SOURCE_LEGACY: Legacy entries
ASSET_SOURCE_AUTO: Auto-generated
ASSET_SOURCE_COINGECKO: From CoinGecko sync
ASSET_SOURCE_PALISADE: Admin entries
ASSET_SOURCE_CUSTOMER: Customer entries

Enum"ASSET_SOURCE_LEGACY""ASSET_SOURCE_AUTO""ASSET_SOURCE_COINGECKO""ASSET_SOURCE_PALISADE""ASSET_SOURCE_CUSTOMER"

assets[].asset.sourceMetadataobject(protobufAny)

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

Example 2: Pack and unpack a message in Java.

Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } // or ... if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); }

Example 3: Pack and unpack a message in Python.

foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

JSON ==== The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:

package google.profile; message Person { string first_name = 1; string last_name = 2; }

{ "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]):

{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

assets[].asset.lastSyncedAtstring(date-time)

When this asset was last synchronized

Example: "2024-08-08T10:22:22.420Z"

assets[].asset.syncVersioninteger(int32)

Version counter for sync updates

Example: 1

assets[].asset.contractAddressChecksummedstring

Checksummed version of the contract address

Example: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"

assets[].minimumSweepQtystringrequired

The minimum sweep qty

Example: "10.00"

statusstring(v2SweepStatus)required

Enum"SWEEP_STATUS_ENABLED""SWEEP_STATUS_DISABLED"

lastSweptstring(date-time)

The date and time the sweep configuration was last executed

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

sweepRunningbooleanrequired

Whether the sweep is currently running

Example: true

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": "Customer deposit sweep",
  "description": "A sweep configuration used to sweep customer deposits",
  "blockchain": "AVALANCHE",
  "feeWallet": {
    "walletId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384"
  },
  "destinationWallet": {
    "walletId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384"
  },
  "sweepFrequency": "SWEEP_FREQUENCY_HOURLY",
  "assets": [
    { … }
  ],
  "status": "SWEEP_STATUS_ENABLED",
  "lastSwept": "2022-03-29T10:22:22.420Z",
  "sweepRunning": true
}

Enable sweep configuration

Request

Enable a single sweep configuration based on its ID

Security

TokenAuth

Path

idstringrequired

The ID of the sweep configuration

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

Responses

Bodyapplication/json

idstringrequired

The sweep configuration 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 sweep configuration

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

createdAtstring(date-time)required

The date and time the sweep configuration was created

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

updatedBystringrequired

The ID of the user who updated this sweep configuration

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

updatedAtstring(date-time)required

The date and time the sweep configuration was updated

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

namestringrequired

The sweep configuration name

Example: "Customer deposit sweep"

descriptionstring

The sweep configuration description

Example: "A sweep configuration used to sweep customer deposits"

blockchainstring(Supported blockchains)required

Enum"AVALANCHE""ETHEREUM""XRP_LEDGER""POLYGON""BNBCHAIN""BASE""HEDERA""ARBITRUM""ONE_MONEY""SOLANA"

feeWalletobject(v2VaultWalletIdentifier)required

feeWallet.walletIdstringrequired

The ID of the wallet

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

feeWallet.vaultIdstringrequired

The ID of the vault

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

destinationWalletobject(v2VaultWalletIdentifier)required

destinationWallet.walletIdstringrequired

The ID of the wallet

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

destinationWallet.vaultIdstringrequired

The ID of the vault

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

sweepFrequencystring(v2SweepFrequency)required

Enum"SWEEP_FREQUENCY_HOURLY""SWEEP_FREQUENCY_DAILY"

assetsArray of objects(v2HydratedSweepAsset)required

The assets to sweep

assets[].assetobject(commonv2Asset)required

Asset is any blockchain asset e.g. USDC, XRP etc.

assets[].asset.idstringrequired

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

Example: "5:0xbehbehfb:USDC"

assets[].asset.standardstring(Supported asset types)required

Enum"NATIVE""ERC20""ISSUED_CURRENCY""ERC721""SPL""CUSTOM"

assets[].asset.symbolstringrequired

The currency symbol of the asset

Example: "LINK"

assets[].asset.namestring

The human readable name of the asset

Example: "Chainlink"

assets[].asset.blockchainstring(Supported blockchains)required

Enum"AVALANCHE""ETHEREUM""XRP_LEDGER""POLYGON""BNBCHAIN""BASE""HEDERA""ARBITRUM""ONE_MONEY""SOLANA"

assets[].asset.decimalsinteger(int32)

Count of decimal places for the asset

Example: 18

assets[].asset.vettedboolean

Whether the asset is vetted on the regulated platform

Example: true

assets[].asset.enabledboolean

Whether the asset is currently enabled on the platform

Example: true

assets[].asset.contractstring

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

Example: "0x0b9d5D9136855f6FEc3c0993feE6E9CE8a297846e"

assets[].asset.createdAtstring(date-time)required

The date and time the asset was created

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

assets[].asset.updatedAtstring(date-time)

The date and time the asset was last updated

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

assets[].asset.organizationIdstring

Organization ID for custom assets

assets[].asset.coingeckoIdstring

CoinGecko identifier for price data (optional for testnet assets)

Example: "ethereum"

assets[].asset.sourcestring(AssetSource defines the source of asset data)

ASSET_SOURCE_LEGACY: Legacy entries
ASSET_SOURCE_AUTO: Auto-generated
ASSET_SOURCE_COINGECKO: From CoinGecko sync
ASSET_SOURCE_PALISADE: Admin entries
ASSET_SOURCE_CUSTOMER: Customer entries

Enum"ASSET_SOURCE_LEGACY""ASSET_SOURCE_AUTO""ASSET_SOURCE_COINGECKO""ASSET_SOURCE_PALISADE""ASSET_SOURCE_CUSTOMER"

assets[].asset.sourceMetadataobject(protobufAny)

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

Example 1: Pack and unpack a message in C++.

Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }

Example 2: Pack and unpack a message in Java.

Foo foo = ...; Any any = Any.pack(foo); ... if (any.is(Foo.class)) { foo = any.unpack(Foo.class); } // or ... if (any.isSameTypeAs(Foo.getDefaultInstance())) { foo = any.unpack(Foo.getDefaultInstance()); }

Example 3: Pack and unpack a message in Python.

foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...} any, err := anypb.New(foo) if err != nil { ... } ... foo := &pb.Foo{} if err := any.UnmarshalTo(foo); err != nil { ... }

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

JSON ==== The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. Example:

package google.profile; message Person { string first_name = 1; string last_name = 2; }

{ "@type": "type.googleapis.com/google.profile.Person", "firstName": , "lastName": }

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. Example (for message [google.protobuf.Duration][]):

{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }

assets[].asset.lastSyncedAtstring(date-time)

When this asset was last synchronized

Example: "2024-08-08T10:22:22.420Z"

assets[].asset.syncVersioninteger(int32)

Version counter for sync updates

Example: 1

assets[].asset.contractAddressChecksummedstring

Checksummed version of the contract address

Example: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"

assets[].minimumSweepQtystringrequired

The minimum sweep qty

Example: "10.00"

statusstring(v2SweepStatus)required

Enum"SWEEP_STATUS_ENABLED""SWEEP_STATUS_DISABLED"

lastSweptstring(date-time)

The date and time the sweep configuration was last executed

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

sweepRunningbooleanrequired

Whether the sweep is currently running

Example: true

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": "Customer deposit sweep",
  "description": "A sweep configuration used to sweep customer deposits",
  "blockchain": "AVALANCHE",
  "feeWallet": {
    "walletId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384"
  },
  "destinationWallet": {
    "walletId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384"
  },
  "sweepFrequency": "SWEEP_FREQUENCY_HOURLY",
  "assets": [
    { … }
  ],
  "status": "SWEEP_STATUS_ENABLED",
  "lastSwept": "2022-03-29T10:22:22.420Z",
  "sweepRunning": true
}

Trigger a sweep configuration

Request

Manually trigger a single sweep configuration based on its ID

Security

TokenAuth

Path

idstringrequired

The ID of the sweep configuration

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

Responses

A successful response.

Bodyapplication/json

object(v2TriggerSweepConfigurationResponse)

Response

application/json

{}

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

Palisade API (2.0)

Addresses

Allow Addresses (deprecated)

API Credentials

Approvals

Approvers

Audit

Backup

Balances

Compliance

Counterparties

Devices

Information

MPC - Memberships

MPC - Quorums

MPC - Sessions

Organizations

Policies

Rates

Sweep Configurations

List sweep configurations

Request

Responses

Was this page helpful?

Create sweep configuration

RequestExpand all

Responses

Was this page helpful?

Get sweep configuration

Request

Responses

Was this page helpful?

Delete sweep configuration

Request

Responses

Was this page helpful?

Update sweep configuration

RequestExpand all

Responses

Was this page helpful?

Disable sweep configuration

Request

Responses

Was this page helpful?

Enable sweep configuration

Request

Responses

Was this page helpful?

Trigger a sweep configuration

Request

Responses

Was this page helpful?

Tags

Transactions

Transactions - XRP

Users

Vaults

Vault Tags

Wallets

Wallet Tags

Wallet Connect

Webhooks

Registry

Transactions - Sweep

Sweep Instances

Request

Request