Planbok Docs
  • Overview
  • Wallet Types
  • Developer Wallet
    • Create your first developer wallet
    • Create gas sponsored developer wallet set
  • API Reference
    • Developer Wallet Endpoints
      • Wallet Sets
      • Wallets
      • Transactions
      • Tokens
Powered by GitBook
On this page
  • Create new wallet
  • Generates new developer wallet for business user
  • Update a wallet
  • Updates a user's wallet
  • List wallets
  • Lists all wallets
  • Get a wallet
  • Gets a user's wallet
  • Get token balance for a wallet
  • Gets a user's wallet balances
  • Get NFTs for a wallet
  • Gets a user's wallet nfts
  1. API Reference
  2. Developer Wallet Endpoints

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

blockchains*

array of strings

The blockchain(s) where the requested wallets will be generated.

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.

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

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.

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

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

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

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

PreviousWallet SetsNextTransactions

Last updated 9 months ago

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 .

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
uuidgenerator.net