Transactions

Estimate transaction fee digital asset transfer

Calculates the anticipated gas fees for a transfer transaction

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.

Headers

Name	Type	Description
PLANBOK-X-API-KEY*	string

Name

Type

Description

PLANBOK-X-API-KEY*

string

Request Body

Name	Type	Description
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

Name

Type

Description

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

Transfer digital asset

Initiates an on-chain digital asset transfer

POST https://api.planbok.io/v1/transactions/transfer/developer

Initiates an on-chain digital asset transfer originating from a designated developer wallet.

Headers

Name	Type	Description
PLANBOK-X-API-KEY*	string

Name

Type

Description

PLANBOK-X-API-KEY*

string

Request Body

Name Type Description

Name	Type	Description
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.

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.

Estimate transaction fee for contract execution

Calculates the anticipated fee for contract execution.

POST https://api.planbok.io/v1/transactions/contract-execution/estimate-fee/developer

Calculates the anticipated fee for a transaction involving contract interaction.

Headers

Name	Type	Description
PLANBOK-X-API-KEY*	string

Name

Type

Description

PLANBOK-X-API-KEY*

string

Request Body

Name Type Description

Name	Type	Description
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`

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

Initiate contract execution

Initiates a transaction to execute a smart contract

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.

Headers

Name	Type	Description
PLANBOK-X-API-KEY*	string

Name

Type

Description

PLANBOK-X-API-KEY*

string

Request Body

Name Type Description

Name	Type	Description
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.

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

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.

Accelerate a transaction

Accelerates an on-chain transaction

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.

Path Parameters

Name	Type	Description
id*	string	Transaction identifier generated from transaction execution.

Name

Type

Description

id*

string

Transaction identifier generated from transaction execution.

Headers

Name	Type	Description
PLANBOK-X-API-KEY*	string

Name

Type

Description

PLANBOK-X-API-KEY*

string

Request Body

Name	Type	Description
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.

Name

Type

Description

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.

Cancel a transaction

Cancels an on-chain transaction

POST https://api.planbok.io/v1/transactions/{id}/cancel/developer

Cancels a designated on-chain transaction originating from a developer wallet.

Path Parameters

Name	Type	Description
id*	string	Transaction identifier generated from transaction execution.

Name

Type

Description

id*

string

Transaction identifier generated from transaction execution.

Headers

Name	Type	Description
PLANBOK-X-API-KEY*	string

Name

Type

Description

PLANBOK-X-API-KEY*

string

Request Body

Name	Type	Description
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.

Name

Type

Description

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.

List Transactions

Fetches all transactions

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.

Query Parameters

Name Type Description

Name	Type	Description
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`

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

Headers

Name	Type	Description
PLANBOK-X-API-KEY*	string

Name

Type

Description

PLANBOK-X-API-KEY*

string

Get a transaction

Obtains information for an individual transaction

GET https://api.planbok.io/v1/transactions/{id}/developer

Obtains information for an individual transaction by its unique identifier.

Path Parameters

Name	Type	Description
id*	string	Transaction ID

Name

Type

Description

id*

string

Transaction ID

Query Parameters

Name	Type	Description
walletId*	string	Wallet ID

Name

Type

Description

walletId*

string

Wallet ID

Headers

Name	Type	Description
PLANBOK-X-API-KEY*	string

Name

Type

Description

PLANBOK-X-API-KEY*

string

Validate an address

Confirms the validity of a given address

POST https://api.planbok.io/v1/transactions/validate-address

Confirms the validity of a given address on a specific blockchain.

Headers

Name	Type	Description
PLANBOK-X-API-KEY*	string

Name

Type

Description

PLANBOK-X-API-KEY*

string

Request Body

Name	Type	Description
address*	string	The blockchain address to be validated.
blockchain*	string	Preferred blockchain for validation.

Name

Type

Description

address*

string

The blockchain address to be validated.

blockchain*

string

Preferred blockchain for validation.

PreviousWallets NextTokens

Last updated 4 months ago