Transactions
Last updated
Last updated
POST https://api.planbok.io/v1/transactions/transfer/estimate-fee/developer
Calculates the anticipated gas fees for a digital asset transfer based on the transaction amount, blockchain, and token.
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
POST https://api.planbok.io/v1/transactions/transfer/developer
Initiates an on-chain digital asset transfer originating from a designated developer wallet.
POST https://api.planbok.io/v1/transactions/contract-execution/estimate-fee/developer
Calculates the anticipated fee for a transaction involving contract interaction.
POST https://api.planbok.io/v1/transactions/contract-execution/developer
Initiates a transaction to execute a smart contract, requiring the inclusion of ABI function signature and ABI parameters in the request.
POST https://api.planbok.io/v1/transactions/{id}/accelerate/developer
Accelerates a designated on-chain transaction originating from a developer wallet with additional gas fees.
POST https://api.planbok.io/v1/transactions/{id}/cancel/developer
Cancels a designated on-chain transaction originating from a developer wallet.
GET https://api.planbok.io/v1/transactions/developer
Fetches all transactions by a user's wallet ID, but can also be filtered with limit and page.
GET https://api.planbok.io/v1/transactions/{id}/developer
Obtains information for an individual transaction by its unique identifier.
POST https://api.planbok.io/v1/transactions/validate-address
Confirms the validity of a given address on a specific blockchain.
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
PLANBOK-X-API-KEY*
string
destinationAddress*
string
Recipient wallet address
walletId*
string
An identifier generated by the system that is unique to the wallet.
tokenId*
string
The distinct system-generated identifier linked to the token.
amount
number
Transfer amount for native, ERC20, ERC721 and single ERC1155 token transfer.
Note: Decimal number can not be used for ERC721 and ERC1155
nftTokenId
number
The token id of the NFT to be transferred.
Note: Only required for the transfer of ERC721 and single ERC1155 tokens
nftTokenIds
array of numbers
An array of token ids of the NFT to be transferred.
Note: Only required for the batch transfer of ERC1155 tokens
amounts
array of numbers
An array of transfer amounts of the ERC1155 tokens to be transferred.
Note: Only required for the batch transfer of ERC1155 tokens
PLANBOK-X-API-KEY*
string
idempotencyKey*
string
Universally unique identifier (UUID v4) idempotency key. This key is employed to guarantee the execution of mutating requests occurs precisely once. To create a UUIDv4 go to uuidgenerator.net.
destinationAddress*
string
Recipient wallet address
walletId*
string
An identifier generated by the system that is unique to the wallet.
tokenId*
string
The distinct system-generated identifier linked to the token.
amount
number
Transfer amount for native, ERC20, ERC721 and single ERC1155 token transfer.
Note: Decimal number can not be used for ERC721 and ERC1155
feeLevel
string
A flexible blockchain fee level selection (LOW, MEDIUM, or HIGH) employed to calculate the gas costs of the transaction. This calculation is made based on network congestion, the number of validators available, and the demand for transaction verification.
Note: This field is only useful for EOA standard wallets.
nftTokenId
number
The token id of the NFT to be transferred.
Note: Only required for the transfer of ERC721 and single ERC1155 tokens
nftTokenIds
array of numbers
An array of token ids of the NFT to be transferred.
Note: Only required for the batch transfer of ERC1155 tokens
amounts
array of numbers
An array of transfer amounts of the ERC1155 tokens to be transferred.
Note: Only required for the batch transfer of ERC1155 tokens
walletSetSecretCipherText*
string
A base64 string expression of the wallet set secret cipher text generated by the system for the parent wallet set of the wallet.
PLANBOK-X-API-KEY*
string
abiFunctionSignature*
string
The function signature from the contract ABI to interact with in the smart contract. e.g. approve(address,uint256)
abiParameters*
array of strings
The parameters needed for the contract ABI function to execute the contract interaction. Supported data types include string, integer, boolean, and array.
contractAddress*
string
The blockchain address of the contract to be executed.
walletId*
string
An identifier generated by the system that is unique to the wallet.
value
string
The amount of native token to be sent along with this transaction. e.g. "0.1" for 0.1 ETH
PLANBOK-X-API-KEY*
string
idempotencyKey*
string
Universally unique identifier (UUID v4) idempotency key. This key is employed to guarantee the execution of mutating requests occurs precisely once. To create a UUIDv4 go to uuidgenerator.net.
abiFunctionSignature*
string
The function signature from the contract ABI to interact with in the smart contract. e.g. approve(address,uint256)
abiParameters*
array of strings
The parameters needed for the contract ABI function to execute the contract interaction. Supported data types include string, integer, boolean, and array.
contractAddress*
string
The blockchain address of the contract to be executed.
walletId*
string
An identifier generated by the system that is unique to the wallet.
value
string
The amount of native token to be sent along with this transaction. e.g. "0.1" for 0.1 ETH
feeLevel
string
A flexible blockchain fee level selection (LOW, MEDIUM, or HIGH) employed to calculate the gas costs of the transaction. This calculation is made based on network congestion, the number of validators available, and the demand for transaction verification.
Note: This field is only useful for EOA standard wallets.
walletSetSecretCipherText*
string
A base64 string expression of the wallet set secret cipher text generated by the system for the parent wallet set of the wallet.
id*
string
Transaction identifier generated from transaction execution.
PLANBOK-X-API-KEY*
string
idempotencyKey*
string
Universally unique identifier (UUID v4) idempotency key. This key is employed to guarantee the execution of mutating requests occurs precisely once. To create a UUIDv4 go to uuidgenerator.net.
walletSetSecretCipherText*
string
A base64 string expression of the wallet set secret cipher text generated by the system for the parent wallet set of the wallet.
id*
string
Transaction identifier generated from transaction execution.
PLANBOK-X-API-KEY*
string
idempotencyKey*
string
Universally unique identifier (UUID v4) idempotency key. This key is employed to guarantee the execution of mutating requests occurs precisely once. To create a UUIDv4 go to uuidgenerator.net.
walletSetSecretCipherText*
string
A base64 string expression of the wallet set secret cipher text generated by the system for the parent wallet set of the wallet.
walletId*
string
Wallet ID
limit
number
Number of items to return. Must be 1 or greater.
Note: Returns page 1 if page is not given.
page
number
Page number to return for a given limit.
Note: limit is required, in order to use page
PLANBOK-X-API-KEY*
string
id*
string
Transaction ID
walletId*
string
Wallet ID
PLANBOK-X-API-KEY*
string
PLANBOK-X-API-KEY*
string
address*
string
The blockchain address to be validated.
blockchain*
string
Preferred blockchain for validation.