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)

get

Gets wallet status

Authorizations

Query parameters

walletTypestring · enumRequired

The type of wallet to query

Available options:

idstring · min: 1 · max: 250Required

The id of the wallet to query

includeSecretstringOptional

Whether to include the decrypted secret in the response

Default: false

Responses

application/json

objectOptionalExample: {"status":"success","data":{"walletVkey":"wallet_vkey","note":"note","PendingTransaction":null,"walletAddress":"wallet_address","Secret":{"createdAt":"1970-01-20T20:00:36.260Z","updatedAt":"1970-01-20T20:00:36.260Z","mnemonic":"decoded_secret"}}}

get

HTTPcURLJavaScriptPython

GET /?walletType=Selling&id=text HTTP/1.1
Host: wallet
token: YOUR_API_KEY
Accept: */*

200

Wallet status

{
  "status": "success",
  "data": {
    "walletVkey": "wallet_vkey",
    "note": "note",
    "PendingTransaction": null,
    "walletAddress": "wallet_address",
    "Secret": {
      "createdAt": "1970-01-20T20:00:36.260Z",
      "updatedAt": "1970-01-20T20:00:36.260Z",
      "mnemonic": "decoded_secret"
    }
  }
}

REQUIRES API KEY Authentication (+ADMIN)

post

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

Authorizations

Body

networkstring · enumRequired

The network the Cardano wallet will be used on

Available options:

Responses

application/json

objectOptionalExample: {"walletMnemonic":"wallet_mnemonic","walletAddress":"wallet_address","walletVkey":"wallet_vkey"}

post

HTTPcURLJavaScriptPython

POST / HTTP/1.1
Host: wallet
token: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 21

{
  "network": "Preprod"
}

200

Wallet created

{
  "walletMnemonic": "wallet_mnemonic",
  "walletAddress": "wallet_address",
  "walletVkey": "wallet_vkey"
}