Developer Guide

Create/Manage Wallets

Overview

The following use cases are covered for the creation and management of wallets:

  1. View Wallets and Providers (Supported Blockchains)
  2. Generate an Initial Wallet
  3. Review Initial Wallet Details
  4. Add new wallet
  5. Delete Wallet
  6. Import a Wallet
  7. Wallets Page
  8. Wallets Exports, Receive Payment, Rename, Transfer funds
  9. Open Wallet Page
  10. Export Wallet
  11. Rename Wallet
  12. Remove Wallet
  13. Import Ethereum Wallet

Use Cases

Combinations of the following end points will be required to execute above use cases:

  • 1
    get

    {bkg-baseUrl}/v1/data/providers

    Retrieves a list of support blockchains

  • 2
    get

    {bkg-baseUrl}/v1/wallets

    Retrieves a list of wallets on the platform

  • 3
    post

    {bkg-baseUrl}/v2/wallets/initial/generate

    Generates a users initial or first wallet used by the system

  • 4
    get

    {bkg-baseUrl}/v1/async-operations/{idempotencyKey}

    [missing description]

  • 5
    get

    {bkg-baseUrl}/v1/wallets/{walletId}

    Retrieves a wallets unique wallet id

  • 6
    get

    {bkg-baseURL}/v1/wallets/{walletId}/short-grand-total

    [missing description]

  • 7
    get

    {bkg-baseURL}/v1/wallets/{walletId}/transactions

    Retrieves a list of transactions associated with a wallet

  • 8
    get

    {bkg-baseUrl}/v1/wallets/{walletId}/balances

    Retrieves the balances for all the tokens in a wallet

  • 9
    get

    {bkg-baseUrl}/v1/{itemType}/{itemId}/attributes

    [missing description]

  • 10
    get

    {bkg-baseUrl}/v1/data/tokens

    [missing description]

  • 11
    get

    {bkg-baseUrl}/v1/wallet-custody/supported-providers

    [missing description]

  • 12
    post

    {bkg-baseUrl}/v2/wallets/generate

    [missing description]

  • 13
    del

    {bkg-baseUrl}/v2/wallets/{walletId}

    [missing description]

  • 14
    post

    {bkg-baseUrl}/v2/wallets/link

    [missing description]

  • 15
    post

    {bkg-baseUrl}/v1/wallets/{walletId}/export

    [missing description]

  • 16
    post

    {bkg-baseUrl}/v1/wallets/{walletId}

    [missing description]

View Wallets and Providers

User Interface & Actions


End Points

  • 1
    get

    {bkg-baseUrl}/v1/data/providers

  • 2
    get

    {bkg-baseUrl}/v1/wallets

Generate an Initial Wallet

User Interface & Actions

Click the "Create New" button



End Points

  • 1
    post

    {bkg-baseUrl}/v2/wallets/initial/generate

  • 2
    get

    {bkg-baseUrl}/v1/async-operations/{idempotencyKey}

Review Initial Wallet Details

User Interface & Actions

Click the "View Details" Button


End Points

  • 1
    get

    GET {bkg-baseUrl}/v1/wallets/{walletId}

  • 2
    get

    GET {bkg-baseURL}/v1/wallets/{walletId}/short-grand-total

  • 3
    get

    {bkg-baseURL}/v1/wallets/{walletId}/transactions

  • 4
    get

    {bkg-baseUrl}/v1/wallets/{walletId}/balances

  • 5
    get

    {bkg-baseUrl}/v1/{itemType}/{itemId}/attributes

  • 6
    get

    {bkg-baseUrl}/v1/data/tokens

  • 7
    get

    {bkg-baseUrl}/v1/wallet-custody/supported-providers

Add new wallet

User Interface & Actions

Click the "Add Wallet" button and add wallet name


End Points

  • 1
    get

    {bkg-baseUrl}/v1/data/providers

  • 2
    get

    {bkg-baseUrl}/v1/wallet-custody/supported-providers

  • 3
    post

    {bkg-baseUrl}/v2/wallets/generate

  • 4
    get

    {bkg-baseUrl}/v1/async-operations/{idempotencyKey}

Delete Wallet

User Interface & Actions

Click the 3-dot "More" menu, select "Remove"



Check the box, "I am ready to remove this wallet", then select "Remove" button


End Points

  • 1
    del

    {bkg-baseUrl}/v2/wallets/{walletId}


  • 2
    get

    {bkg-baseUrl}/v1/async-operations/{idempotencyKey}

Import a Wallet

User Interface & Action

Click the "Add Wallet" button and select "Link an existing wallet" and enter the wallet name



Click the "Manually Enter Code" button and enter the wallet address in the "Wallet to Link" field


End Points

  • 1
    get

    {bkg-baseURL}/v1/wallet-custody/supported-providers

  • 2
    get

    {bkg-baseUrl}/v1/data/providers

  • 3
    post

    {bkg-baseUrl}/v2/wallets/link

  • 4
    get

    {bkg-baseUrl}/v1/async-operations/{idempotencyKey}

  • 5
    get

    {bkg-baseUrl}/v1/wallets/{walletId}

Wallets Page

User Interface & Actions

Click the "Add Wallet" button



Enter the wallet name, then select the Wallet Provider and the Wallet Custody Provider. Then click "Next" to begin wallet creation



Expand the selected Wallet Provider to view the wallet



Click on the wallet name to review its details


End Points

  • 1
    get

    {bkg-baseUrl}/v1/data/providers

  • 2
    get

    {bkg-baseUrl}/v1/wallets


  • 3
    get

    {bkg-baseUrl}/v1/data/providers

  • 4
    get

    {bkg-baseUrl}/v1/wallet-custody/supported-providers

  • 5
    post

    {bkg-baseUrl}/v2/wallets/generate

  • 6
    get

    {bkg-baseUrl}/v1/async-operations/{idempotencyKey}

  • 7
    get

    {bkg-baseUrl}/v1/wallets?provider=EthereumSepolia

  • 8
    get

    {bkg-baseUrl}/v1/wallets/{walletId}/short-grand-total

  • 9
    get

    {bkg-baseUrl} /v1/wallets/{walletId}

  • 10
    get

    {bkg-baseUrl}/v1/wallets/{walletId}/short-grand-total

  • 11
    get

    {bkg-baseUrl}/v1/wallets/{walletId}/transactions?Completed=false

  • 12
    get

    {bkg-baseUrl}/v1/wallets/{walletId}/balances

  • 13
    get

    {bkg-baseUrl}/v1/wallet/42584bb6-8903-4114-af74-ce07af706de9/attributes

  • 14
    get

    {bkg-baseUrl}v1/data/tokens?referenceIds=EthereumSepolia:Token:ETH

Wallet Actions

User Interface & Actions

On the wallets page, expand a provider to view wallets



Click the 3-dot "More" menu to view additional actions


End Points

  • 1
    get

    {bkg-baseUrl}/v1/data/providers

Open Wallet Page

End Points

  • 1
    get

    {bkg-baseUrl}/v1/data/providers

  • 2
    get

    {bkg-baseUrl}/v1/wallets

  • 3
    get

    GET {bkg-baseUrl}/v1/wallets/42584bb6-8903-4114-af74-ce07af706de9/short-grand-total

Export Wallet

User Interface & Actions

Select the "Export" option in the additional actions menu




Click the "QR Code" button to generate a QR code (recommended)



Or click the "Display Secret" button to see the ID and Secret Key


End Points

  • 1
    get

    {bkg-baseUrl}/v1/wallets/42584bb6-8903-4114-af74-ce07af706de9/short-grand-total

  • 2
    post

    {bkg-baseUrl}/v1/wallets/42584bb6-8903-4114-af74-ce07af706de9/export

Rename Wallet

User Interface & Actions

Select the "Rename" option in the additional actions menu



Edit the wallet name and press the "Enter" button on the keyboard


End Points

  • 1
    put

    {bkg-baseUrl}/v1/wallets/42584bb6-8903-4114-af74-ce07af706de9

Remove Wallet

User Interface & Actions

Select the "Remove" option in the additional actions menu



Check the box "I am ready to remove this wallet" then select "Remove" button


End Points

  • 1
    get

    {bkg-baseUrl}/v1/wallets/42584bb6-8903-4114-af74-ce07af706de9/short-grand-total

  • 2
    post

    {bkg-baseUrl}/v1/wallets/42584bb6-8903-4114-af74-ce07af706de9/export

  • 3
    del

    {bkg-baseUrl}/v2/wallets/42584bb6-8903-4114-af74-ce07af706de9

  • 4
    get

    /v1/async-operations/e31d4d8e-52c2-28b4-1168-a91b6d4c315d

Import Ethereum Wallet

User Interface & Actions

Click the "Add Wallet" button



Enter the wallet name and hit the "Manually Enter Code" button. Enter the wallet address and secret. Then, select the wallet provider. Hit the "Next" button


End Points

  • 1
    get

    {bkg-baseUrl}/v1/data/providers

  • 2
    get

    {bkg-baseUrl}/v1/wallet-custody/supported-providers


  • 3
    post

    {bkg-baseUrl}/v2/wallets/link

  • 4
    get

    {bkg-baseUrl}/v1/async-operations/14d9e1e9-3e7e-6619-574f-1044cdf7b5d2

  • 5
    get

    {bkg-baseUrl}/v1/wallets/0c068cc4-9458-47bf-aef8-2243b1f5ccc1

Search