Sign in

v1

latestOpenAPI 3.0.32026-07-24707482.9 KB
Withdrawals

Initiate an L2-to-L1 withdrawal

post/withdrawals

Request body

toNetwork'sepolia' | 'amoy' | 'besu' required

Target L1 network for the withdrawal.

token'QNT' | 'uUSD' | 'uGBP' | 'uEUR' | 'uToken' required
amountstring required

Numeric string (digits with optional decimal); must be greater than zero.

fromAddressstring required
toAddressstring required
isNativeToErc20boolean
l2TxHashstring
l2BlockNumberinteger

Example request

{
  "amount": "100.5",
  "fromAddress": "0xAbCd1234AbCd1234AbCd1234AbCd1234AbCd1234",
  "toAddress": "0xAbCd1234AbCd1234AbCd1234AbCd1234AbCd1234",
  "l2TxHash": "0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890ab"
}

Response

Withdrawal created.

idstring required
userIdstring required
toNetwork'sepolia' | 'amoy' | 'besu' required

Target L1 network for the withdrawal.

token'QNT' | 'uUSD' | 'uGBP' | 'uEUR' | 'uToken' required
amountstring required
fromAddressstring required
toAddressstring required
isNativeToErc20boolean required
l2TxHashstring
l2BlockNumberinteger
withdrawalHashstring
withdrawalTxobject
disputeGameIndexinteger
outputRootProofobject
withdrawalProofstring[]
proveTxHashstring
finalizeTxHashstring
status'initiated' | 'l2_confirmed' | 'awaiting_dispute_game' | 'provable' | 'proven' | 'awaiting_finalization' | 'finalizable' | 'finalized' | 'proof_invalidated' | 'failed' required

Withdrawal lifecycle state (L2 rollup to L1).

provableAtstring date-time
finalizableAtstring date-time
lastStatusCheckAtstring date-time
failureReasonstring
completedAtstring date-time
createdAtstring date-time required
updatedAtstring date-time required

Example response

{
  "fromAddress": "0xAbCd1234AbCd1234AbCd1234AbCd1234AbCd1234",
  "toAddress": "0xAbCd1234AbCd1234AbCd1234AbCd1234AbCd1234",
  "l2TxHash": "0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890ab",
  "proveTxHash": "0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890ab",
  "finalizeTxHash": "0xabcdef1234567890abcdef1234567890abcdef1234567890abcdef1234567890ab"
}