Sender-initiated withdraw of a pending Canton transfer that is still awaiting receiver acceptance,
identified by the on-ledger transfer instruction contract id directly
(for Canton, the TransferInstruction contract id). account_id is required (and
specific_from_address may be supplied, like a normal transaction) to determine the source.
Use only when the transfer is not tracked locally (no parked row / TransactionToken). No local
withdrawability check — wrong account, address, coin, or terminal instruction fails on-ledger or
during tx creation. Call getWithdrawableTransfers first when possible;
if the transaction was created by the current system, prefer withdrawCantonTransferByToken.
************** Request example **********************
withdrawCantonTransferByInstructionId(
coin_type="CC",
transfer_instruction_id="00e66afbe3caec238f0e08e4a92c3926cc2c6c4ca9de0366a18f8227458ed1fe5ca1212201f37ff80520986751e271076b2994604b6d6f28d454fa68c1c9ea4383633775f",
account_id=1,
specific_from_address="3a121d::12206c13a4f7b080554dc243e5912e1fe690161dd75ad41c5d5456a645a462a4279d",
user_description="Withdraw by instruction id"
)
************** Response example *********************
{
"FunctionData": {
"ApprovalRequestStatus": 0,
"CoinType": "CC",
"Token": "a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456",
"Transactions": [
{
"AmountToTransfer": "0",
"DestinationAddress": "3a121d::12206c13a4f7b080554dc243e5912e1fe690161dd75ad41c5d5456a645a462a4279d"
}
]
},
"Meta": {
"AccessToken": "58f08df6e369fa4d126e1ba5c7f66cf85c9c79df32d05fee8f3c542121c87cf5",
"Destination": "044fd7dc60304b8aceeb662ce41bf9d9cc132278c0871c0a72fb4f3cecbabb25a86e43ae28dab21a95c64e2db76abdcfffb9bfdeec67a21399cfa5f555f01d054b",
"Source": "be1f60e490b8ccabcc02a4595817b8edf45905d24944e87b8e3cae27f158df63843bfc4b09d37a5e752017b74ea2d136af272bea210f059e768e1ea8777aaf21e9",
"Time": "2025-10-19 15:04:13.129"
}
}
coin_typestringThe Canton token symbol of the transfer
transfer_instruction_idstring<p>On-ledger TransferInstruction contract ID to withdraw</p>
account_idintegerAccount initiating the withdrawal
specific_from_addressstring<p>Optional explicit source address, like a normal transaction</p>
user_descriptionstring<p>Optional free-text description to attach to the withdrawal transaction</p>