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

Options: Selling, Purchasing

idstring · min: 1 · max: 250required

The id of the wallet to query

includeSecretstring · default: "false"optional

Whether to include the decrypted secret in the response

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url './../api/v1//wallet/?walletType=Selling&id=text' \
  --header 'token: YOUR_API_KEY'

200

200

{
  "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"
    }
  }
}

Wallet status

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

Options: Preprod, Mainnet

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url './../api/v1//wallet/' \
  --header 'token: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "network": "Preprod"
  }'

200

200

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

Wallet created