We refreshed our doc site!
Bookmarked links may have changed
Read release notesPOSThttps://api.circle.com/v1/w3s/developer/transactions/transfer
Initiates an on-chain digital asset transfer from a specified developer-controlled wallet.
Unique system generated identifier of the wallet. Required when source Address and blockchain is not provided. Mutually exclusive. For contract deploys this wallet ID will be used as the source.
A base64 string expression of the entity secret ciphertext. The entity secret should be encrypted by the entity public key. Circle mandates that the entity secret ciphertext is unique for each API request.
The destination blockchain address for the transaction.
Universally unique identifier (UUID v4) idempotency key. This key is utilized to ensure exactly-once execution of mutating requests. To create a UUIDv4 go to uuidgenerator.net. If the same key is reused, it will be treated as the same request and the original response will be returned.
Transfer amounts in decimal number format, at least one element is required for transfer. For ERC721 token transfer, the amounts field is required to be ["1"] (array with "1" as the only element).
A dynamic blockchain fee level setting (LOW
, MEDIUM
, or HIGH
) that will be used to pay gas for the transaction. Calculated based on network traffic, supply of validators, and demand for transaction verification. Cannot be used with gasPrice
, priorityFee
, or maxFee
.
Estimates for each fee level can be obtained through the POST /transactions/transfer/estimateFee
API.
The maximum units of gas to use for the transaction. Required if feeLevel
is not provided.
Estimates for this limit can be obtained through the POST /transactions/transfer/estimateFee
API.
GasLimit override (only supported for EOA wallets): Using gasLimit
together with feeLevel
, the provided gasLimit
is required to be greater or equal to feeLevel
estimation and will override the estimation's gasLimit.
For blockchains without EIP-1559 support, the maximum price of gas, in gwei, to use per each unit of gas (see gasLimit
). Requires gasLimit
. Cannot be used with feeLevel
, priorityFee
, or maxFee
.
Estimates for this fee can be obtained through the POST /transactions/transfer/estimateFee
API.
For blockchains with EIP-1559 support, the maximum price per unit of gas (see gasLimit
), in gwei. Requires priorityFee
, and gasLimit
to be present. Cannot be used with feeLevel
or gasPrice
.
Estimates for this fee can be obtained through the POST /transactions/transfer/estimateFee
API.
For blockchains with EIP-1559 support, the “tip”, in gwei, to add to the base fee as an incentive for validators.
Please note that the maxFee
and gasLimit
parameters are required alongside the priorityFee
. The feeLevel
and gasPrice
parameters cannot be used with the priorityFee
.
Estimations for this fee can be obtained through the POST /transactions/transfer/estimateFee
API.
NftTokenIDs specify the nft ID list to be transferred/batchTransferred for NFT withdrawal. Note. Only erc1155 supports safeBatchTransferFrom.
Optional reference or description used to identify the transaction.
System generated identifier of the token. Excluded with tokenAddress
and tokenBlockchain
.
Blockchain address of the transferred token. Empty for native tokens. Excluded with tokenId
.
Blockchain of the transferred token. Required if tokenId is not provided. Excluded with tokenId
.
1{
2 "data": {
3 "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
4 "state": "INITIATED"
5 }
6}