Wallet Sets
Creating a new wallet set
Generates a developer wallet set.
POST https://api.planbok.io/v1/wallet-sets/developer/create
This endpoint generates a developer wallet set for your business.
Headers
PLANBOK-X-API-KEY*
string
Request Body
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.
name*
string
isGasSponsored
boolean
By default it's set to false. Set to true if you'd like to sponsor your business users' transaction fees.
sponsorOnlyTranfersToWalletSetAddresses
boolean
By default it's set to true. Set to false to sponsor all your business users' transaction fees including digital asset transfers to address outside of your business.
Update a wallet set
Updates a wallet set
PUT https://api.planbok.io/v1/wallet-sets/{id}/developer/update
This endpoint updates details of the wallet set associated with the given wallet set ID.
Path Parameters
id*
string
Wallet set ID
Headers
PLANBOK-X-API-KEY*
string
Request Body
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.
name*
string
List all wallet sets
Lists wallet sets
GET https://api.planbok.io/v1/wallet-sets/developer
This endpoint retrieves a list of all your wallet sets.
Headers
PLANBOK-X-API-KEY*
string
Get wallet set by id
Get details of a given wallet set
GET https://api.planbok.io/v1/wallet-sets/{id}/developer
This endpoint retrieves details of a single wallet set for a given wallet ID.
Path Parameters
id*
string
Wallet set ID
Headers
PLANBOK-X-API-KEY
string
Get wallet set sponsor address and balance
Retrieves wallet set sponsor address and balance
GET https://api.planbok.io/v1/wallet-sets/{id}/sponsor/{blockchain}/developer
This endpoint gets the sponsor wallet address and balance of a wallet set, only works with gas sponsored wallet sets. Learn more!
Path Parameters
id*
string
Wallet set ID
blockchain*
string
Blockchain to get address balance. e.g.: "ETH", "BSC", "MATIC", "LISK", "@G", "ETH-SEPOLIA", "BSC-TESTNET", "MATIC-MUMBAI", "LISK-SEPOLIA", "@G-TESTNET"
Headers
PLANBOK-X-API-KEY*
string
Last updated