MassRelay
GuidesAPI referenceRun it yourselfChangelogopenapi.json

Home / Docs / API reference

/api/me/wallets

GET /api/me/wallets

Authentication signed-in session; roles: admin, cfo_viewer, fde, hr_ops, manager, member, operator

Response

FieldTypeDescription
wallets requiredarray of object
wallets[].id requiredstringThe answer's id.
wallets[].tenantIdstring
wallets[].ownerKindstring
wallets[].ownerIdstring
wallets[].kind requiredstring
wallets[].balanceMu requiredinteger
wallets[].heldMu requiredinteger
wallets[].currencyHintstring or null
wallets[].expiresAtstring or null
wallets[].spendPriorityinteger
wallets[].sourceKindstring or null
wallets[].sourceRefstring or null
wallets[].periodStartstring or null
wallets[].periodEndstring or null
wallets[].rolloverCapMuinteger or null
wallets[].createdAtstring
wallets[].closedAtstring or null
Example response (shape)
{
  "wallets": [
    {
      "id": "<id>",
      "tenantId": "<tenantId>",
      "ownerKind": "<ownerKind>",
      "ownerId": "<ownerId>",
      "kind": "<kind>",
      "balanceMu": 0,
      "heldMu": 0,
      "currencyHint": "<currencyHint>",
      "expiresAt": "<expiresAt>",
      "spendPriority": 0,
      "sourceKind": "<sourceKind>",
      "sourceRef": "<sourceRef>",
      "periodStart": "<periodStart>",
      "periodEnd": "<periodEnd>",
      "rolloverCapMu": "<rolloverCapMu>",
      "createdAt": "<createdAt>",
      "closedAt": "<closedAt>"
    }
  ]
}

Common errors

  • 401 not signed in

Every error has the same JSON shape; see Errors and Limits.

Full schema (JSON)

Response schema

{
  "description": "A session credential. A person with no personal workspace yet gets an empty list, not an error. Amounts are in mu (the unit of account).",
  "type": "object",
  "required": [
    "wallets"
  ],
  "properties": {
    "wallets": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "kind",
          "balanceMu",
          "heldMu"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "tenantId": {
            "type": "string"
          },
          "ownerKind": {
            "type": "string"
          },
          "ownerId": {
            "type": "string"
          },
          "kind": {
            "type": "string"
          },
          "balanceMu": {
            "type": "integer"
          },
          "heldMu": {
            "type": "integer"
          },
          "currencyHint": {
            "type": [
              "string",
              "null"
            ]
          },
          "expiresAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "spendPriority": {
            "type": "integer"
          },
          "sourceKind": {
            "type": [
              "string",
              "null"
            ]
          },
          "sourceRef": {
            "type": [
              "string",
              "null"
            ]
          },
          "periodStart": {
            "type": [
              "string",
              "null"
            ]
          },
          "periodEnd": {
            "type": [
              "string",
              "null"
            ]
          },
          "rolloverCapMu": {
            "type": [
              "integer",
              "null"
            ]
          },
          "createdAt": {
            "type": "string"
          },
          "closedAt": {
            "type": [
              "string",
              "null"
            ]
          }
        }
      }
    }
  }
}