The canonical payman_money_task tool definition

The exact object a developer pastes into their agent’s tools array, plus the four documented result shapes and the wire conditions that produce them.

GET /connect/tool-definition

The canonical payman_money_task tool definition

cURL

curl --request GET \
  --url https://api.paygent.payman.ai/connect/tool-definition

200

{
  "version": "2026-08-09",
  "tool": {
    "name": "payman_money_task",
    "description": "<string>",
    "input_schema": {}
  },
  "resultStatuses": [
    "success"
  ],
  "results": [
    {
      "status": "success",
      "when": "<string>",
      "fields": {},
      "appAction": "<string>",
      "example": {}
    }
  ],
  "wireMapping": [
    {
      "observed": "<string>",
      "status": "success",
      "note": "<string>"
    }
  ],
  "approvalSignal": {
    "transport": "<string>",
    "fields": {},
    "example": {},
    "verify": [
      "<string>"
    ],
    "handshake": {
      "why": "<string>",
      "transport": "<string>",
      "fields": {},
      "example": {},
      "send": [
        "<string>"
      ],
      "accepted": "<string>",
      "withoutAWindowHandle": "<string>"
    },
    "fallback": "<string>"
  },
  "notes": [
    "<string>"
  ]
}

Response

200 - application/json

The tool definition and its result shapes

The canonical payman_money_task contract: the tool object to paste, the result shapes to switch on, the wire conditions that produce them, and the standing rules for the app.

version · string · required

The date this contract was settled. Deliberately not the server's version — the tool is older and slower-moving than the build that happens to be serving it, and tying the two would announce a change on every unrelated release.

Example:

"2026-08-09"

tool · object · required

The paste-ready object, in the shape a tool-calling API wants: name, description, input_schema. snake_case here is not a slip — these are the wire names of the target API, and renaming them to match this server's camelCase would break the copy-paste this endpoint exists for.

Show child attributes

resultStatuses · enum<string>[] · required

The discriminator's domain, listed once so a consumer can switch on it.

The four result shapes, and the domain of the result envelope's discriminator.

Available options: success, needs_connection, approval_required, error

results · object[] · required

Show child attributes

wireMapping · object[] · required

Show child attributes

approvalSignal · object · required

The postMessage the hosted approval page sends back to the window that opened it — payload, checks and fallbacks.

Show child attributes

notes · string[] · required

Standing rules for the app, none of which the model ever sees — where the credentials live, why sessionId is app-owned, and which identifiers stay in the HTTP layer.