Pular para o conteúdo

Create a new XRP Offer Cancel transaction

Requisição

Create a new XRP Offer Cancel transaction

Segurança
TokenAuth
Caminho
vaultIdstringobrigatório

The vault ID

walletIdstringobrigatório

The wallet ID

Corpoapplication/jsonobrigatório
offerSequencestring, (uint64)obrigatório

Sequence of offer to cancel

Exemplo:"2"
sequencestring, (uint64)

The blockchain nonce/sequence to use

Exemplo:"2"
lastLedgerSequencestring, (uint64)

Highest ledger index this transaction can appear in.

Exemplo:"123456"
sourceTagstring, (uint64)

Source tag to use for this transaction

Exemplo:"123456"
curl -i -X POST \
  'https://docs.ripple.com/_mock/pt-br/products/wallet/api-docs/palisade-api/palisade-api/v2/vaults/{vaultId}/wallets/{walletId}/transactions/xrp/offer-cancel' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "offerSequence": "2",
    "sequence": "2",
    "lastLedgerSequence": "123456",
    "sourceTag": "123456"
  }'

Respostas

Corpoapplication/json
idstringobrigatório

The transaction ID

Exemplo:"ce4918bf-a199-4ce2-85a3-d0d296855384"
walletIdstringobrigatório

The wallet ID

Exemplo:"ce4918bf-a199-4ce2-85a3-d0d296855384"
vaultIdstringobrigatório

The vault ID

Exemplo:"ce4918bf-a199-4ce2-85a3-d0d296855384"
createdBystringobrigatório

The ID of the user that created the transaction

Exemplo:"ce4918bf-a199-4ce2-85a3-d0d296855384"
createdAtstring, (date-time)obrigatório

The date and time the transaction was created

Exemplo:"2022-03-29T10:22:22.420Z"
updatedAtstring, (date-time)obrigatório

The date and time the transaction was updated

Exemplo:"2022-03-29T10:22:22.420Z"
attributesobject
statusstring(transactionsv2TransactionStatus)obrigatório

The transaction status

Enum:"REQUESTED""POLICY_CHECK_PENDING""POLICY_CHECK_PASSED""APPROVAL_CHECK_PENDING""APPROVAL_CHECK_PASSED""COMPILATION_PENDING""COMPILED""SIGNATURE_PENDING""SIGNED""PUBLISH_PENDING"
Exemplo:"REQUESTED"
actionstring(transactionsv2TransactionAction)obrigatório

The transaction action

Enum:"DEPOSIT""WITHDRAWAL""WEB3_RAW""WEB3_SIGN""PASSKEY_RAW""PASSKEY_SIGN""PALISADE_TRANSFER""PALISADE_RAW""PALISADE_MANAGED""PALISADE_SIGN_PLAINTEXT"
Exemplo:"DEPOSIT"
externalIdstring

External ID of this transaction, unique to the organization

Exemplo:"ce4918bf-a199-4ce2-85a3-d0d296855384"
correlationIdstring

The correlation ID of the transaction, used to link related transactions

Exemplo:"ce4918bf-a199-4ce2-85a3-d0d296855384"
assetobject(commonv2Asset)obrigatório
feeAssetobject(commonv2Asset)obrigatório
blockchainstring(v2Blockchain)obrigatório
Enum:"AVALANCHE""ETHEREUM""XRP_LEDGER""POLYGON""BNBCHAIN""BASE""HEDERA""ARBITRUM""ONE_MONEY""SOLANA"
destinationAddressstring

Deprecated. Use destination. The destination recorded for the transaction. Once a transaction reaches COMPILED, this is the blockchain execution target address. For a contract-token transfer, this is the token contract rather than the recipient wallet; use destination.address on a TRANSFER entry in proposed_asset_changes or confirmed_asset_changes for the recipient wallet.

Exemplo:"0x55502b9d5a68b0F8a48384352295BeD968aD8AA4"
destinationobject(transactionsv2Address)

The destination recorded for the transaction. Once a transaction reaches COMPILED, this is the blockchain execution target. For a contract-token transfer, this is the token contract rather than the recipient wallet; use destination.address on a TRANSFER entry in proposed_asset_changes or confirmed_asset_changes for the recipient wallet.

originAddressstringobrigatório

The origin address

Exemplo:"0x55502b9d5a68b0F8a48384352295BeD968aD8AA4"
originobject(transactionsv2Address)obrigatório
qtystringobrigatório

The quantity recorded at the top level. Once a contract-token transfer reaches COMPILED, this may be zero because it is the quantity sent to the execution target; use qty on a TRANSFER entry in proposed_asset_changes or confirmed_asset_changes for the token quantity.

Exemplo:"155.672"
feeQtyLimitstring

The maximum network fee to pay for this transaction in base asset units (eg ETH for Ethereum)

Exemplo:"155.672"
sequencestring, (uint64)

The blockchain nonce/sequence to use

Exemplo:"2"
encodedTransactionstring

The encoded transaction. Maximum size is 200KB.

Exemplo:"ed408505d21dba00825208942352d20fc81225c8ecd8f6faa1b37f24fed450c98089736f6d657468696e67808080"
signOnlybooleanobrigatório

Whether to only sign the transaction, or also publish it to the blockchain

Exemplo:"true"
configobject(v2XRPTransactionConfig)
freezeInfoobject(v2FreezeInfo)obrigatório

Comprehensive freeze information including status, reason, and history

historyArray of objects(v2PublicTransactionHistoryEntry)read-only

V1 business view of every accumulated history record, in archive acceptance order. Unrepresented records appear as informational OTHER entries.

snapshotRevisionstring, (uint64)read-only

Archive-authoritative snapshot revision, emitted as a decimal string in ProtoJSON.

Exemplo:"9223372036854775807"
originContextobject(v2PublicTransactionOriginContext)read-only

Optional business origin type. Existing origin address and attributes are retained.

feeQtystring

The actual network fee for this transaction in base asset units (eg ETH for Ethereum)

Exemplo:"155.672"
hashstring

The transaction hash

Exemplo:"0x30674cddb3025f9681839c63d20357f54e914bd7a9ddfe53a6691f4a530a5671"
signaturestring

The transaction signature

Exemplo:"3046022100c60dc1337d69261e7c7e92e4dac78e0c317d444d4690be2b86cc53b1989d1b0602210090c63e3a5cf692c9387292451fada038a0e4d85a2f5c91ee1e7a635df0440b43"
transactionTypestring

The transaction type

Exemplo:"Payment"
reasonsArray of strings

Deprecated. Use problems for structured transaction failure details.

Exemplo:
[
  "unfunded"
]
canonicalSignaturestring

The canonical transaction signature

Exemplo:"3045022100C60DC1337D69261E7C7E92E4DAC78E0C317D444D4690BE2B86CC53B1989D1B0602206F39C1C5A3096D36C78D6DBAE0525FC619CA048C7FEC0E4DA157FB2EDFF235FE"
signedTransactionstring

The signed transaction (multi-sign is not supported). Maximum size is 200KB.

Exemplo:"12000024002A8F37201B002A8F5561400000000098968068400000000000000A732103E0C61B861ADE7AC58D27D65ABCEF4C22FA874DD13D809E02A99609A8CA31892C74473045022100C
proposedAssetChangesArray of objects(v2AssetChange)

Asset changes expected before confirmation. In TRANSFER entries, destination.address is the recipient wallet and qty is the asset quantity.

confirmedAssetChangesArray of objects(v2AssetChange)

Asset changes observed after confirmation. In TRANSFER entries, destination.address is the recipient wallet and qty is the asset quantity.

expiresAtstring, (date-time)read-only

The time after which this transaction will be rejected if not confirmed

Exemplo:"2026-03-16T16:22:22.420Z"
problemsArray of objects(v2Problem)

Structured transaction failure details.

signingPayloadsArray of objects(v2SigningPayload)

Multiple signing payloads for UTXO-based transactions, one per input

Resposta
{
  "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "walletId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdBy": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "createdAt": "2022-03-29T10:22:22.420Z",
  "updatedAt": "2022-03-29T10:22:22.420Z",
  "attributes": {
    "property1": "string",
    "property2": "string"
  },
  "status": "REQUESTED",
  "action": "DEPOSIT",
  "externalId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "correlationId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
  "asset": {
    "id": "5:0xbehbehfb:USDC",
    "standard": "ERC20",
    "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_COINGECKO",
    "sourceMetadata": { … },
    "lastSyncedAt": "2024-08-08T10:22:22.420Z",
    "syncVersion": 1,
    "contractAddressChecksummed": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
    "iconUrl": "https://static.palisade.co/registry/assets/coingecko/production/usd-coin.png",
    "displaySymbol": "weETH"
  },
  "feeAsset": {
    "id": "5:0xbehbehfb:USDC",
    "standard": "ERC20",
    "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_COINGECKO",
    "sourceMetadata": { … },
    "lastSyncedAt": "2024-08-08T10:22:22.420Z",
    "syncVersion": 1,
    "contractAddressChecksummed": "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
    "iconUrl": "https://static.palisade.co/registry/assets/coingecko/production/usd-coin.png",
    "displaySymbol": "weETH"
  },
  "blockchain": "AVALANCHE",
  "destinationAddress": "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4",
  "destination": {
    "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "counterpartyId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "type": "EXTERNAL",
    "address": "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4"
  },
  "originAddress": "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4",
  "origin": {
    "id": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "counterpartyId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "vaultId": "ce4918bf-a199-4ce2-85a3-d0d296855384",
    "type": "EXTERNAL",
    "address": "0x55502b9d5a68b0F8a48384352295BeD968aD8AA4"
  },
  "qty": "155.672",
  "feeQtyLimit": "155.672",
  "sequence": "2",
  "encodedTransaction": "ed408505d21dba00825208942352d20fc81225c8ecd8f6faa1b37f24fed450c98089736f6d657468696e67808080",
  "signOnly": "true",
  "config": {
    "sourceTag": "123456",
    "destinationTag": "123456"
  },
  "freezeInfo": {
    "isFrozen": false,
    "history": [ … ],
    "authority": "FREEZE_AUTHORITY_CUSTOMER_MANUAL",
    "freezeRevision": "1",
    "mutationId": "ce4918bf-a199-4ce2-85a3-d0d296855384"
  },
  "history": [
    { … }
  ],
  "snapshotRevision": "9223372036854775807",
  "originContext": {
    "type": "TYPE_API"
  },
  "feeQty": "155.672",
  "hash": "0x30674cddb3025f9681839c63d20357f54e914bd7a9ddfe53a6691f4a530a5671",
  "signature": "3046022100c60dc1337d69261e7c7e92e4dac78e0c317d444d4690be2b86cc53b1989d1b0602210090c63e3a5cf692c9387292451fada038a0e4d85a2f5c91ee1e7a635df0440b43",
  "transactionType": "Payment",
  "reasons": [
    "unfunded"
  ],
  "canonicalSignature": "3045022100C60DC1337D69261E7C7E92E4DAC78E0C317D444D4690BE2B86CC53B1989D1B0602206F39C1C5A3096D36C78D6DBAE0525FC619CA048C7FEC0E4DA157FB2EDFF235FE",
  "signedTransaction": "12000024002A8F37201B002A8F5561400000000098968068400000000000000A732103E0C61B861ADE7AC58D27D65ABCEF4C22FA874DD13D809E02A99609A8CA31892C74473045022100C60DC1337D69261E7C7E92E4DAC78E0C317D444D4690BE2B86CC53B1989D1B0602206F39C1C5A3096D36C78D6DBAE0525FC619CA048C7FEC0E4DA157FB2EDFF235FE8114EC8E7F9FF5C9B157D55890956376D15740FAE943831451FE87A95FA6CAC3EBEF33387DE8225F7D0352CB",
  "proposedAssetChanges": [
    { … }
  ],
  "confirmedAssetChanges": [
    { … }
  ],
  "expiresAt": "2026-03-16T16:22:22.420Z",
  "problems": [
    { … }
  ],
  "signingPayloads": [
    { … }
  ]
}