Skip to main content
Glama

Stage payment batch for simulation and approval

stage_payment_batch

Stage ISO 20022 payment batches in memory to validate, score risk, fingerprint XML, and issue a commit token; no funds move.

Instructions

Stage a payment batch for simulation and a confirmed commit.

Creates an in-memory staged payment order with zero fund movement and
a 1-hour expiration window. Computes:

1. Schema validation against the message type's JSON Schema.
2. Optional scheme compliance verification (SEPA, BACS, etc.).
3. Multi-currency control sums and fee estimation.
4. Multi-factor risk scoring (detecting duplicates, high transaction
   amounts, and generic remittance narratives).
5. In-memory XML compilation and SHA-256 fingerprinting.
6. A confirmation token that commit_payment_batch requires.

Args:
    message_type: A supported ISO 20022 pain message type.
    records: One or more flat payment records to stage.
    scheme: Optional payment scheme profile to validate against.

Returns:
    StagedBatchResult with staging metadata, risk assessment, fingerprint,
    and confirmation token, or {"error": ...}.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "message_type": "<message_type>",
      "records": "<records>"
    },
    "name": "stage_payment_batch"
  }
}

Input Schema

NameRequiredDescriptionDefault
schemeNoOptional payment-scheme rulebook profile to enforce, or several joined by commas. One of 'ae-uaefts', 'anti-duplicate', 'cbpr-cross-border', 'ch-domestic', 'ch-sepa', 'de-axz', 'de-ccu', 'hk-fps', 'my-duitnow', 'purpose-mandate-ae', 'purpose-mandate-gb', 'purpose-mandate-hk', 'purpose-mandate-my', 'purpose-mandate-qa', 'qa-qatch', 'se-bankgiro', 'sepa-b2b', 'sepa-inst', 'sepa-sct', 'sepa-sdd', 'sg-fast', 'uk-bacs', 'uk-bacs-dd', 'uk-chaps', 'uk-fps', 'us-ach', 'us-rtp', 'us-wire', 'xborder-ct'. Omit to skip scheme-specific rulebook validation.
recordsYesFlat payment records to stage (zero fund movement). One or more flat payment records (dicts of field name → value). Key fields (see get_input_schema for the full contract): id, date (payment-initiation timestamp; 'YYYY-MM-DD' is accepted and rendered as midnight), initiator_name, payment_id, requested_execution_date ('YYYY-MM-DD'), debtor_name, debtor_account_IBAN, debtor_agent_BIC, creditor_name, creditor_account_IBAN, creditor_agent_BIC, payment_amount (alias: 'amount'; max two decimals), currency (alias: 'payment_currency'; ISO 4217, e.g. 'EUR'), remittance_information. batch_booking accepts JSON true/false. nb_of_txs and ctrl_sum are computed automatically from the records and may be omitted. payment_method defaults to 'TRF' and charge_bearer to 'SLEV'. IBAN and BIC values are strictly validated and never coerced.
message_typeYesA supported ISO 20022 pain message type. Must be exactly one of: 'pain.001.001.03', 'pain.001.001.04', 'pain.001.001.05', 'pain.001.001.06', 'pain.001.001.07', 'pain.001.001.08', 'pain.001.001.09', 'pain.001.001.10', 'pain.001.001.11', 'pain.001.001.12', 'pain.001.001.13', 'pain.008.001.02', 'pain.008.001.08', 'pain.001', 'pain.008' (see list_message_types). The bare family names 'pain.001' and 'pain.008' are accepted as aliases for 'pain.001.001.09' and 'pain.008.001.02'.

Output Schema

NameRequiredDescriptionDefault
errorNo
statusNo
stage_idNo
expires_atNo
risk_levelNo
risk_scoreNo
risk_factorsNo
estimated_feesNo
confirmation_tokenNo
sha256_fingerprintNo
total_transactionsNo
control_sum_by_currencyNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.0.84
    • changedInput schema / properties / scheme / anyOf
      Previous value: -[
      -  {
      -    "type": "string"
      -  },
      -  {
      -    "type": "null"
      -  }
      -]New value: +[
      +  {
      +    "enum": [
      +      "ae-uaefts",
      +      "anti-duplicate",
      +      "cbpr-cross-border",
      +      "ch-domestic",
      +      "ch-sepa",
      +      "de-axz",
      +      "de-ccu",
      +      "hk-fps",
      +      "my-duitnow",
      +      "purpose-mandate-ae",
      +      "purpose-mandate-gb",
      +      "purpose-mandate-hk",
      +      "purpose-mandate-my",
      +      "purpose-mandate-qa",
      +      "qa-qatch",
      +      "se-bankgiro",
      +      "sepa-b2b",
      +      "sepa-inst",
      +      "sepa-sct",
      +      "sepa-sdd",
      +      "sg-fast",
      +      "uk-bacs",
      +      "uk-bacs-dd",
      +      "uk-chaps",
      +      "uk-fps",
      +      "us-ach",
      +      "us-rtp",
      +      "us-wire",
      +      "xborder-ct"
      +    ],
      +    "type": "string"
      +  },
      +  {
      +    "pattern": "^(?:\\s*,)*\\s*(?:ae-uaefts|anti-duplicate|cbpr-cross-border|ch-domestic|ch-sepa|de-axz|de-ccu|hk-fps|my-duitnow|purpose-mandate-ae|purpose-mandate-gb|purpose-mandate-hk|purpose-mandate-my|purpose-mandate-qa|qa-qatch|se-bankgiro|sepa-b2b|sepa-inst|sepa-sct|sepa-sdd|sg-fast|uk-bacs|uk-bacs-dd|uk-chaps|uk-fps|us-ach|us-rtp|us-wire|xborder-ct)\\s*(?:,\\s*(?:(?:ae-uaefts|anti-duplicate|cbpr-cross-border|ch-domestic|ch-sepa|de-axz|de-ccu|hk-fps|my-duitnow|purpose-mandate-ae|purpose-mandate-gb|purpose-mandate-hk|purpose-mandate-my|purpose-mandate-qa|qa-qatch|se-bankgiro|sepa-b2b|sepa-inst|sepa-sct|sepa-sdd|sg-fast|uk-bacs|uk-bacs-dd|uk-chaps|uk-fps|us-ach|us-rtp|us-wire|xborder-ct)\\s*)?)*$",
      +    "type": "string"
      +  },
      +  {
      +    "type": "null"
      +  }
      +]
    • changedInput schema / properties / scheme / description
      Previous value: -"Optional payment scheme profile to validate against, e.g. 'sepa-sct', 'sepa-instant', 'bacs', or 'cbpr-plus'."New value: +"Optional payment-scheme rulebook profile to enforce, or several joined by commas. One of 'ae-uaefts', 'anti-duplicate', 'cbpr-cross-border', 'ch-domestic', 'ch-sepa', 'de-axz', 'de-ccu', 'hk-fps', 'my-duitnow', 'purpose-mandate-ae', 'purpose-mandate-gb', 'purpose-mandate-hk', 'purpose-mandate-my', 'purpose-mandate-qa', 'qa-qatch', 'se-bankgiro', 'sepa-b2b', 'sepa-inst', 'sepa-sct', 'sepa-sdd', 'sg-fast', 'uk-bacs', 'uk-bacs-dd', 'uk-chaps', 'uk-fps', 'us-ach', 'us-rtp', 'us-wire', 'xborder-ct'. Omit to skip scheme-specific rulebook validation."
  2. Addedv0.0.72

TDQS

A4.2/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations only declare readOnly=false, destructive=false, idempotent=false, and openWorld=false; the description adds real behavioral context beyond that: no funds move, the staged order lives in memory, it expires after 1 hour, and it performs schema validation, scheme checks, risk scoring, and SHA-256 fingerprinting. It also notes the error return shape and confirms the tool is a precondition for commit_payment_batch.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The opening sentence and the expiry/fund-movement facts are well front-loaded, but the six-item numbered computation list plus the Args and Returns blocks largely duplicate the input schema and the existing output schema. The Args lines in particular add nothing over the 100%-covered schema and could be dropped.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With an output schema present and full schema coverage, the description needs to carry the workflow and side-effect story, which it does (staging, expiry, token, no fund movement, error case). The only shortfall is that it never says what happens if the same records are staged twice or whether a staged batch can be discarded, which matters given idempotentHint=false.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the parameter baseline is 3; the Args section simply restates the schema text for message_type, records, and scheme without adding format, ordering, or sizing guidance. The one-hour expiry and token semantics sit in the prose body rather than being tied to specific parameters.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Stage a payment batch') plus the two purposes it serves (simulation and a confirmed commit). It also distinguishes the stage step from the commit step by noting it returns a confirmation token that commit_payment_batch requires, so an agent can tell the two apart without opening either schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The definition makes the workflow explicit: stage first, then commit using the returned token, and 'zero fund movement' signals the safe exploratory path. It never names simulate_payment_batch, validate_records, or validate_payment_scheme directly, so an agent must infer why it would call this rather than those siblings.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.