Create an idempotent native collateral-withdrawal quote.

Error

A valid request URL is required to generate request examples

{
  "quoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "collateral": {
    "tokenId": "<string>",
    "symbol": "USDT",
    "decimals": 18
  },
  "amountBaseUnits": "<string>",
  "destinationAddress": "<string>",
  "balanceSnapshot": {
    "rawConfirmedBaseUnits": "<string>",
    "spendableBaseUnits": "<string>",
    "reservedBaseUnits": "<string>",
    "activeBuyHoldsBaseUnits": "<string>",
    "matchedBuyObligationsBaseUnits": "<string>",
    "pendingJitDepositsBaseUnits": "<string>",
    "pendingOutflowsBaseUnits": "<string>",
    "custodyOperationActive": true,
    "openSellHoldsBaseUnits": "<string>",
    "matchedSellObligationsBaseUnits": "<string>",
    "sequencerObligationHoldBaseUnits": "<string>",
    "pendingSettlementCount": 4503599627370495,
    "sequencerAccountVersion": "<string>",
    "sequencerEvaluatedAt": "2023-11-07T05:31:56Z",
    "sequencerRiskTruncated": true,
    "evaluatedAt": "2023-11-07T05:31:56Z"
  },
  "feeAssumptions": {
    "gasAmount": "<string>",
    "gasPriceAttoAlph": "<string>",
    "networkFeeAttoAlph": "<string>",
    "tokenOutputDustAttoAlph": "<string>",
    "totalRequiredAttoAlph": "<string>",
    "availableAttoAlph": "<string>",
    "transactionCount": 8
  },
  "idempotency": {
    "key": "<string>",
    "scope": "wallet_owner",
    "behavior": "same owner and key returns the same quote terms; a different request conflicts"
  },
  "submission": {
    "mode": "wallet_signer_exact_byte_custody",
    "developerKeyIsAuthority": false,
    "tradingAuthorizationIsAuthority": false,
    "freshStepUpRequired": true
  }
}

{
  "quoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "collateral": {
    "tokenId": "<string>",
    "symbol": "USDT",
    "decimals": 18
  },
  "amountBaseUnits": "<string>",
  "destinationAddress": "<string>",
  "balanceSnapshot": {
    "rawConfirmedBaseUnits": "<string>",
    "spendableBaseUnits": "<string>",
    "reservedBaseUnits": "<string>",
    "activeBuyHoldsBaseUnits": "<string>",
    "matchedBuyObligationsBaseUnits": "<string>",
    "pendingJitDepositsBaseUnits": "<string>",
    "pendingOutflowsBaseUnits": "<string>",
    "custodyOperationActive": true,
    "openSellHoldsBaseUnits": "<string>",
    "matchedSellObligationsBaseUnits": "<string>",
    "sequencerObligationHoldBaseUnits": "<string>",
    "pendingSettlementCount": 4503599627370495,
    "sequencerAccountVersion": "<string>",
    "sequencerEvaluatedAt": "2023-11-07T05:31:56Z",
    "sequencerRiskTruncated": true,
    "evaluatedAt": "2023-11-07T05:31:56Z"
  },
  "feeAssumptions": {
    "gasAmount": "<string>",
    "gasPriceAttoAlph": "<string>",
    "networkFeeAttoAlph": "<string>",
    "tokenOutputDustAttoAlph": "<string>",
    "totalRequiredAttoAlph": "<string>",
    "availableAttoAlph": "<string>",
    "transactionCount": 8
  },
  "idempotency": {
    "key": "<string>",
    "scope": "wallet_owner",
    "behavior": "same owner and key returns the same quote terms; a different request conflicts"
  },
  "submission": {
    "mode": "wallet_signer_exact_byte_custody",
    "developerKeyIsAuthority": false,
    "tradingAuthorizationIsAuthority": false,
    "freshStepUpRequired": true
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

POST

funding

withdrawals

quote

Error

A valid request URL is required to generate request examples

{
  "quoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "collateral": {
    "tokenId": "<string>",
    "symbol": "USDT",
    "decimals": 18
  },
  "amountBaseUnits": "<string>",
  "destinationAddress": "<string>",
  "balanceSnapshot": {
    "rawConfirmedBaseUnits": "<string>",
    "spendableBaseUnits": "<string>",
    "reservedBaseUnits": "<string>",
    "activeBuyHoldsBaseUnits": "<string>",
    "matchedBuyObligationsBaseUnits": "<string>",
    "pendingJitDepositsBaseUnits": "<string>",
    "pendingOutflowsBaseUnits": "<string>",
    "custodyOperationActive": true,
    "openSellHoldsBaseUnits": "<string>",
    "matchedSellObligationsBaseUnits": "<string>",
    "sequencerObligationHoldBaseUnits": "<string>",
    "pendingSettlementCount": 4503599627370495,
    "sequencerAccountVersion": "<string>",
    "sequencerEvaluatedAt": "2023-11-07T05:31:56Z",
    "sequencerRiskTruncated": true,
    "evaluatedAt": "2023-11-07T05:31:56Z"
  },
  "feeAssumptions": {
    "gasAmount": "<string>",
    "gasPriceAttoAlph": "<string>",
    "networkFeeAttoAlph": "<string>",
    "tokenOutputDustAttoAlph": "<string>",
    "totalRequiredAttoAlph": "<string>",
    "availableAttoAlph": "<string>",
    "transactionCount": 8
  },
  "idempotency": {
    "key": "<string>",
    "scope": "wallet_owner",
    "behavior": "same owner and key returns the same quote terms; a different request conflicts"
  },
  "submission": {
    "mode": "wallet_signer_exact_byte_custody",
    "developerKeyIsAuthority": false,
    "tradingAuthorizationIsAuthority": false,
    "freshStepUpRequired": true
  }
}

{
  "quoteId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "account": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "expiresAt": "2023-11-07T05:31:56Z",
  "collateral": {
    "tokenId": "<string>",
    "symbol": "USDT",
    "decimals": 18
  },
  "amountBaseUnits": "<string>",
  "destinationAddress": "<string>",
  "balanceSnapshot": {
    "rawConfirmedBaseUnits": "<string>",
    "spendableBaseUnits": "<string>",
    "reservedBaseUnits": "<string>",
    "activeBuyHoldsBaseUnits": "<string>",
    "matchedBuyObligationsBaseUnits": "<string>",
    "pendingJitDepositsBaseUnits": "<string>",
    "pendingOutflowsBaseUnits": "<string>",
    "custodyOperationActive": true,
    "openSellHoldsBaseUnits": "<string>",
    "matchedSellObligationsBaseUnits": "<string>",
    "sequencerObligationHoldBaseUnits": "<string>",
    "pendingSettlementCount": 4503599627370495,
    "sequencerAccountVersion": "<string>",
    "sequencerEvaluatedAt": "2023-11-07T05:31:56Z",
    "sequencerRiskTruncated": true,
    "evaluatedAt": "2023-11-07T05:31:56Z"
  },
  "feeAssumptions": {
    "gasAmount": "<string>",
    "gasPriceAttoAlph": "<string>",
    "networkFeeAttoAlph": "<string>",
    "tokenOutputDustAttoAlph": "<string>",
    "totalRequiredAttoAlph": "<string>",
    "availableAttoAlph": "<string>",
    "transactionCount": 8
  },
  "idempotency": {
    "key": "<string>",
    "scope": "wallet_owner",
    "behavior": "same owner and key returns the same quote terms; a different request conflicts"
  },
  "submission": {
    "mode": "wallet_signer_exact_byte_custody",
    "developerKeyIsAuthority": false,
    "tradingAuthorizationIsAuthority": false,
    "freshStepUpRequired": true
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "requestId": "<string>",
    "details": "<unknown>"
  }
}

Authorizations

aura_session

string

required

HttpOnly session cookie set by POST /v1/auth/session. Mutating requests must also send the CSRF token (returned by that call) in the x-csrf-token header.

Body

application/json

idempotencyKey

string

required

Required string length: 16 - 128

Pattern: ^[A-Za-z0-9][A-Za-z0-9._:-]*$

network

enum<string>

required

Available options:

mainnet,

testnet,

devnet

tokenId

string

required

Pattern: ^[0-9a-f]{64}$

amountBaseUnits

string

required

Exact token base-unit quantity encoded as canonical JSON string.

Pattern: ^(0|[1-9][0-9]*)$

destinationAddress

string

required

Alephium address (base58, optional :N group suffix).

Required string length: 30 - 80

Pattern: ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz:]+$

signerPublicKey

string

required

Pattern: ^[0-9a-fA-F]{66}$

signerKeyType

enum<string>

required

Available options:

default,

gl-secp256k1

Response

Default Response

quoteId

string<uuid>

required

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

account

string

required

Alephium address (base58, optional :N group suffix).

Required string length: 30 - 80

Pattern: ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz:]+$

createdAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

expiresAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

network

enum<string>

required

Available options:

mainnet,

testnet,

devnet

collateral

object

required

Show child attributes

amountBaseUnits

string

required

Exact token base-unit quantity encoded as canonical JSON string.

Pattern: ^(0|[1-9][0-9]*)$

destinationAddress

string

required

Alephium address (base58, optional :N group suffix).

Required string length: 30 - 80

Pattern: ^[123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz:]+$

balanceSnapshot

object

required

Show child attributes

feeAssumptions

object

required

Show child attributes

idempotency

object

required

Show child attributes

submission

object

required

Show child attributes

Last modified on August 11, 2026

Get Started

Guides

Reference

Endpoints

Realtime Stream

Create an idempotent native collateral-withdrawal quote.

Authorizations

Body

Response