Wallets

Create new wallet

Generates new developer wallet for business user

POST https://api.planbok.io/v1/wallets/developer/create

This endpoint generates developer wallets for your business user.

Headers

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.
blockchains*	array of strings	The blockchain(s) where the requested wallets will be generated. e.g.: "ETH", "BSC", "MATIC", "LISK", "@G", "ETH-SEPOLIA", "BSC-TESTNET", "MATIC-MUMBAI", "LISK-SEPOLIA", "@G-TESTNET"
username*	string	Name of the user associated with the wallet.
userRefId*	string	Reference ID used to identify the user. e.g user account id from your business.
walletSetId*	string	An automatically generated system identifier for the parent wallet set of the wallet.
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.

201: Created

500: Internal Server Error

401: Unauthorized

404: Not Found

403: Forbidden

Update a wallet

Updates a user's wallet

PUT https://api.planbok.io/v1/wallets/{id}/developer/update

This endpoint updates your business user's wallet details.

Path Parameters

Name	Type	Description
id*	string	Wallet ID

Headers

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.
username*	string	Name of the user associated with the wallet.
userRefId*	string	Reference ID used to identify the user. e.g user account id from your business.

200: OK

401: Unauthorized

500: Internal Server Error

404: Not Found

403: Forbidden

List wallets

Lists all wallets

GET https://api.planbok.io/v1/wallets/developer

This endpoint retrieves all wallets created by you or all wallets associated with a given wallet set.

Query Parameters

Name	Type	Description
walletSetId	string	Wallet set ID

Headers

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

200: OK

204: No Content

500: Internal Server Error

403: Forbidden

Get a wallet

Gets a user's wallet

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

This endpoint retrieves a user's wallet with a given wallet ID.

Path Parameters

Name	Type	Description
id*	string	Wallet ID

Headers

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

200: OK

404: Not Found

500: Internal Server Error

403: Forbidden

Get token balance for a wallet

Gets a user's wallet balances

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

This endpoint retrieves a user's wallet balances with a given wallet ID.

Path Parameters

Name	Type	Description
id*	string	Wallet ID

Headers

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

200: OK

500: Internal Server Error

403: Forbidden

204: No Content

Get NFTs for a wallet

Gets a user's wallet nfts

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

This endpoint retrieves a user's wallet nfts with a given wallet ID.

Path Parameters

Name	Type	Description
id*	string	Wallet ID

Headers

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

200: OK

204: No Content

403: Forbidden

500: Internal Server Error