Prepare a withdrawal request

curl --request POST \
  --url https://xreserve-api-testnet.circle.com/v1/prepare-withdrawal \
  --header 'Content-Type: application/json' \
  --data '
{
  "batches": [
    {
      "remoteDomain": 2,
      "remoteDepositor": "<string>",
      "finalDestinationDomain": 1,
      "finalDestinationRecipient": "<string>",
      "useCircleForwarding": true,
      "valueExcludingFees": "10.00",
      "valueIncludingFees": "10.00",
      "finalDestinationCaller": "<string>",
      "salt": "<string>",
      "forwardingOptions": {
        "maxFee": "<string>",
        "hookData": "<string>",
        "usesFastFinality": true
      }
    }
  ]
}
'

{
  "batches": [
    {
      "burnIntents": [
        {
          "maxBlockHeight": "1000000",
          "maxFee": "100000",
          "spec": {
            "version": 1,
            "sourceDomain": 0,
            "destinationDomain": 1,
            "sourceContract": "0x000000000000000000000000a0b86a33e6b6b6b6b6b6b6b6b6b6b6b6b6b6b6b6",
            "destinationContract": "0x000000000000000000000000b1c97a44e7b7b7b7b7b7b7b7b7b7b7b7b7b7b7b7",
            "sourceToken": "0x000000000000000000000000c2d8b55f8c8c8c8c8c8c8c8c8c8c8c8c8c8c8c8c",
            "destinationToken": "0x000000000000000000000000d3e9c66f9d9d9d9d9d9d9d9d9d9d9d9d9d9d9d9d",
            "sourceDepositor": "0x000000000000000000000000e4fad77fadadadadadadadadadadadadadadadad",
            "destinationRecipient": "0x000000000000000000000000f5abc88abebebebebebebebebebebebebebebebe",
            "sourceSigner": "0x000000000000000000000000a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0",
            "destinationCaller": "0x000000000000000000000000b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1",
            "value": "1000000",
            "salt": "0xc3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2c3d4",
            "hookData": {
              "remoteDomain": 10001,
              "remoteDepositor": "0x000000000000000000000000a0b86a33e6b6b6b6b6b6b6b6b6b6b6b6b6b6b6b6",
              "remoteToken": "0x000000000000000000000000b1c97a44e7b7b7b7b7b7b7b7b7b7b7b7b7b7b7b7",
              "forwardingContractAddress": "0x0000000000000000000000000000000000000000",
              "forwardingCalldata": "0x"
            }
          }
        }
      ],
      "encoded": "<string>",
      "messageHashToSign": "<string>"
    }
  ]
}

Prepare a withdrawal request

Turns the user’s burn transaction data on the remote chain into fully encoded burn intents to send to the /withdraw endpoint. This endpoint performs the following:

Resolves contract and token addresses across networks.
Determines the optimal forwarding strategy, such as redepositing to another xReserve remote domain or forwarding to a CCTP domain.
Calculates transfer amounts and fees.
Encodes forwarding call data with the calculated transfer amounts.
Generates maxBlockHeight and maxFee values with safety buffers.
Returns data in the structure expected by the withdraw endpoint.

Note: The /withdraw endpoint requires signatures and the remote chain burnTxId in addition to the burn intent prepared by this endpoint.

POST

prepare-withdrawal

Prepare a withdrawal request

curl --request POST \
  --url https://xreserve-api-testnet.circle.com/v1/prepare-withdrawal \
  --header 'Content-Type: application/json' \
  --data '
{
  "batches": [
    {
      "remoteDomain": 2,
      "remoteDepositor": "<string>",
      "finalDestinationDomain": 1,
      "finalDestinationRecipient": "<string>",
      "useCircleForwarding": true,
      "valueExcludingFees": "10.00",
      "valueIncludingFees": "10.00",
      "finalDestinationCaller": "<string>",
      "salt": "<string>",
      "forwardingOptions": {
        "maxFee": "<string>",
        "hookData": "<string>",
        "usesFastFinality": true
      }
    }
  ]
}
'

{
  "batches": [
    {
      "burnIntents": [
        {
          "maxBlockHeight": "1000000",
          "maxFee": "100000",
          "spec": {
            "version": 1,
            "sourceDomain": 0,
            "destinationDomain": 1,
            "sourceContract": "0x000000000000000000000000a0b86a33e6b6b6b6b6b6b6b6b6b6b6b6b6b6b6b6",
            "destinationContract": "0x000000000000000000000000b1c97a44e7b7b7b7b7b7b7b7b7b7b7b7b7b7b7b7",
            "sourceToken": "0x000000000000000000000000c2d8b55f8c8c8c8c8c8c8c8c8c8c8c8c8c8c8c8c",
            "destinationToken": "0x000000000000000000000000d3e9c66f9d9d9d9d9d9d9d9d9d9d9d9d9d9d9d9d",
            "sourceDepositor": "0x000000000000000000000000e4fad77fadadadadadadadadadadadadadadadad",
            "destinationRecipient": "0x000000000000000000000000f5abc88abebebebebebebebebebebebebebebebe",
            "sourceSigner": "0x000000000000000000000000a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0",
            "destinationCaller": "0x000000000000000000000000b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1",
            "value": "1000000",
            "salt": "0xc3d4e5f6a7b8c9d0e1f2a3b4c5d6e7f8a9b0c1d2e3f4a5b6c7d8e9f0a1b2c3d4",
            "hookData": {
              "remoteDomain": 10001,
              "remoteDepositor": "0x000000000000000000000000a0b86a33e6b6b6b6b6b6b6b6b6b6b6b6b6b6b6b6",
              "remoteToken": "0x000000000000000000000000b1c97a44e7b7b7b7b7b7b7b7b7b7b7b7b7b7b7b7",
              "forwardingContractAddress": "0x0000000000000000000000000000000000000000",
              "forwardingCalldata": "0x"
            }
          }
        }
      ],
      "encoded": "<string>",
      "messageHashToSign": "<string>"
    }
  ]
}

Body

application/json

Contains data that prepares burn intents for withdrawal.

batches

object[]

required

Array of burn intent batches.

Show child attributes

Response

Successfully prepared burn intents ready for withdrawal.

Contains prepared burn intents.

batches

object[]

required

List of prepared burn intents.

Show child attributes

Get domain information

Submit signed burn intents for withdrawal

⌘I