Wallets

Manage and generate new wallets using the Masumi Payment Service API

Wallets are a key component in the Masumi Payment Service, so understanding their concepts is crucial to securely using Masumi. Click here to learn more about how Masumi utilizes different kinds of wallets.

/wallet

REQUIRES API KEY Authentication (+ADMIN)

Gets wallet status

GET./../api/v1//wallet/
Authorization
Query parameters
Response

Wallet status

Body
status*string
data*object
Request
const response = await fetch('./../api/v1//wallet/?walletType=Selling&id=text', {
    method: 'GET',
    headers: {
      "token": "API-Key <apiKey>"
    },
});
const data = await response.json();
Response
{
  "status": "success",
  "data": {
    "walletVkey": "wallet_vkey",
    "note": "note",
    "PendingTransaction": null,
    "walletAddress": "wallet_address",
    "WalletSecret": {
      "createdAt": "2025-02-03T18:33:09.376Z",
      "updatedAt": "2025-02-03T18:33:09.376Z",
      "secret": "decoded_secret"
    }
  }
}

REQUIRES API KEY Authentication (+ADMIN)

Creates a wallet, it will not be saved in the database, please ensure to remember the mnemonic

POST./../api/v1//wallet/
Authorization
Body
network*enum

The network the Cardano wallet will be used on

PREPRODMAINNET
Response

Wallet created

Body
walletMnemonic*string
walletAddress*string
walletVkey*string
Request
const response = await fetch('./../api/v1//wallet/', {
    method: 'POST',
    headers: {
      "token": "API-Key <apiKey>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "network": "PREPROD"
    }),
});
const data = await response.json();
Response
{
  "walletMnemonic": "wallet_mnemonic",
  "walletAddress": "wallet_address",
  "walletVkey": "wallet_vkey"
}

Last updated