createTransactionNode.js,latest
Go to NPMInitiates an on-chain digital asset transfer from a specified developer-controlled wallet.
Parameters
input
object
Required
Defines the parameters for creating a new transfer transaction.
option 1:
tokenId
string
Required
System generated identifier of the token. Excluded with tokenAddress and tokenBlockchain.
amount
array of strings
Required
Specifies the transfer amount in decimal format.
destinationAddress
string
Required
The recipient's blockchain address.
fee
object
Required
Represents the configuration for setting fees. It can be either FeeLevelInput, GasInput, or FeeInput.
option 1:
config
object
Required
gasLimit
string
Required
The maximum gas units for the transaction, required if feeLevel isn't provided. Use the Estimate Fee methods for this limit's estimation.
maxFee
string
Required
The maximum price per gas unit (see gasLimit), in gwei. Requires priorityFee, and gasLimit, but incompatible with feeLevel or gasPrice. Use the Estimate Fee methods to get this fee's estimates.
priorityFee
string
Required
Requires maxFee, and gasLimit but incompatible with feeLevel or gasPrice. Use the Estimate Fee methods for fee estimates.
type
string
Allowed valuesabsolute
option 2:
config
object
Required
gasLimit
string
Required
The maximum gas units for the transaction, required if feeLevel is not provided. Use the Estimate Fee methods for this limit's estimation.
gasPrice
string
Required
For EIP-1559 supported blockchains, it's the max gas price per gas unit (see gasLimit), in gwei. Requires gasLimit and incompatible with feeLevel, priorityFee, or maxFee. Use the Estimate Fee methods for fee estimates.
type
string
Allowed valuesgas
option 3:
config
object
Required
feeLevel
string
Required
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.
Allowed valuesHIGHLOWMEDIUM
type
string
Allowed valueslevel
nftTokenIds
array of strings
The list of NFT IDs to be transferred/batchTransferred for NFT withdrawal. Note: Only erc1155 supports safeBatchTransferFrom.
refId
string
An optional client-provided reference or description for the transaction.
walletId
string
Required
Identifier for the originating wallet.
idempotencyKey
string
The optional idempotency key. An idempotency key is a unique identifier used to identify and handle duplicate requests in order to ensure idempotent behavior, where multiple identical requests have the same effect as a single request.
We will generate one if you do not provide it.
option 2:
blockchain
string
Blockchain of the transferred token. Required if tokenId is not provided. The blockchain and tokenId fields are mutually exclusive.
Allowed valuesARBARB-SEPOLIAAVAXAVAX-FUJIBASEBASE-SEPOLIAETHETH-SEPOLIAMATICMATIC-AMOYOPOP-SEPOLIASOLSOL-DEVNETUNIUNI-SEPOLIA
tokenAddress
string
Required
Blockchain address of the transferred token. Empty for native tokens. Excluded with tokenId.
amount
array of strings
Required
Specifies the transfer amount in decimal format.
destinationAddress
string
Required
The recipient's blockchain address.
fee
object
Required
Represents the configuration for setting fees. It can be either FeeLevelInput, GasInput, or FeeInput.
option 1:
config
object
Required
gasLimit
string
Required
The maximum gas units for the transaction, required if feeLevel isn't provided. Use the Estimate Fee methods for this limit's estimation.
maxFee
string
Required
The maximum price per gas unit (see gasLimit), in gwei. Requires priorityFee, and gasLimit, but incompatible with feeLevel or gasPrice. Use the Estimate Fee methods to get this fee's estimates.
priorityFee
string
Required
Requires maxFee, and gasLimit but incompatible with feeLevel or gasPrice. Use the Estimate Fee methods for fee estimates.
type
string
Allowed valuesabsolute
option 2:
config
object
Required
gasLimit
string
Required
The maximum gas units for the transaction, required if feeLevel is not provided. Use the Estimate Fee methods for this limit's estimation.
gasPrice
string
Required
For EIP-1559 supported blockchains, it's the max gas price per gas unit (see gasLimit), in gwei. Requires gasLimit and incompatible with feeLevel, priorityFee, or maxFee. Use the Estimate Fee methods for fee estimates.
type
string
Allowed valuesgas
option 3:
config
object
Required
feeLevel
string
Required
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.
Allowed valuesHIGHLOWMEDIUM
type
string
Allowed valueslevel
nftTokenIds
array of strings
The list of NFT IDs to be transferred/batchTransferred for NFT withdrawal. Note: Only erc1155 supports safeBatchTransferFrom.
refId
string
An optional client-provided reference or description for the transaction.
walletId
string
Required
Identifier for the originating wallet.
idempotencyKey
string
The optional idempotency key. An idempotency key is a unique identifier used to identify and handle duplicate requests in order to ensure idempotent behavior, where multiple identical requests have the same effect as a single request.
We will generate one if you do not provide it.
Responses
Example
1const response = await client.createTransaction({
2 amount: ['0.01'],
3 destinationAddress: '0xa51c9c604b79a0fadbfed35dd576ca1bce71da0a',
4 tokenId: '738c8a6d-8896-46d1-b2cb-083600c1c69b',
5 walletId: 'a635d679-4207-4e37-b12e-766afb9b3892',
6 fee: {
7 type: 'level',
8 config: {
9 feeLevel: 'HIGH',
10 },
11 },
12})
13console.log(response.data)ResponseChoose an example
1{
2 "data": {
3 "id": "c4d1da72-111e-4d52-bdbf-2e74a2d803d5",
4 "state": "CANCELLED"
5 }
6}Did this page help you?
© 2023-2025 Circle Technology Services, LLC. All rights reserved.
