MCP tool

get_topup_status

Check whether a live Stripe Checkout session has produced a webhook-backed wallet credit. A browser return is not payment evidence: pending means keep checking later; only credited includes trusted creditedMinor. Sandbox top-ups credit synchronously and do not need this tool.

Input

Pass fields from this schema as the tool arguments. Runtime ownership, product scope and readiness checks still apply.

Input JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "sessionId": {
      "type": "string",
      "maxLength": 255,
      "pattern": "^cs_[A-Za-z0-9_]+$",
      "description": "Stripe Checkout session id returned by top_up_wallet"
    }
  },
  "required": [
    "sessionId"
  ]
}

REST mapping and authority

The tool wraps this REST endpoint. The mapping identifies path/query/body transformations and approval or idempotency headers.

Request contract

{
  "method": "GET",
  "path": "/api/v1/billing/topup/status",
  "pathFields": [],
  "pathSchema": {
    "type": "object",
    "properties": {},
    "additionalProperties": false
  },
  "pathEncoding": "encodeURIComponent for each path field",
  "governedAction": null,
  "headers": {},
  "querySchema": {
    "type": "object",
    "properties": {
      "sessionId": {
        "type": "string",
        "maxLength": 255,
        "pattern": "^cs_[A-Za-z0-9_]+$",
        "description": "Stripe Checkout session id returned by top_up_wallet"
      }
    },
    "additionalProperties": false,
    "required": [
      "sessionId"
    ]
  },
  "queryEncoding": "URLSearchParams; omit undefined fields, stringify supplied values",
  "responseMapping": "REST JSON is returned as MCP structuredContent and a compatibility text block; privacy-sensitive tools validate their output schema."
}

Output

This is the registered MCP output envelope. Nested fields are only modeled where the schema explicitly defines them.

Output JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "credited"
      ]
    },
    "creditedMinor": {
      "type": "integer",
      "minimum": -9007199254740991,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "status"
  ],
  "additionalProperties": {}
}

Safety annotations

MCP annotations

{
  "readOnlyHint": true,
  "destructiveHint": false,
  "idempotentHint": false,
  "openWorldHint": false
}

Annotations help a client present the tool. The API independently enforces authorization and exact action approvals. Error and retry guidance →