Skip to main content
Glama
Pletopay MCP Server

Pletopay MCP Server

Official
by pletopay

Simulate a customer bank transfer (test mode only)

simulate_transfer

Simulate a customer bank transfer into a test virtual account to verify payment success, webhook events, and rejection rules in sandbox without moving live funds.

Instructions

Simulate a customer bank transfer (test mode only).

Test mode only (403 test_mode_only with a live key). Simulate a transfer into one of your test virtual accounts, as a customer would make it.

The transfer then flows through the same pipeline as live money: the payment moves to succeeded and webhooks are sent. A wrong amount into an exact-amount account is refused (400 simulation_rejected), as a real transfer would be. An account that is not active (for example a one-time account that already received its payment) is refused before anything is sent (409 virtual_account_not_active). A 202 only means the simulation was accepted; watch the payment or its events for the outcome.

Test mode only: needs an sk_test_ key.

Input Schema

NameRequiredDescriptionDefault
amountYesAmount in kobo
sender_nameNoName of the simulated sender
account_numberYesYour virtual account number that should receive the transfer
sender_account_numberNoAccount number of the simulated sender. Refunds go back to the sender, so a test value here (see the sandbox test values) lets you test refund outcomes.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

A4.4/5.0
Behavior5/5

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

Beyond the annotations, it discloses that the simulation flows through the live pipeline (payment reaches `succeeded`, webhooks fire) and enumerates concrete failure modes: 403 test_mode_only, 400 simulation_rejected for wrong amounts on exact-amount accounts, and 409 virtual_account_not_active. It also warns that a 202 only means acceptance and the outcome must be watched via the payment or events.

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

Conciseness4/5

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

The content is front-loaded with the test-mode constraint and the outcome semantics, and each sentence carries substantive information. The 'test mode only' constraint is repeated three times, which is redundant, though the emphasis is defensible for a high-risk-of-misuse tool.

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

Completeness5/5

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

For a simulation tool with no output schema, the description covers the safety constraint, the async nature of the 202 response, how to observe the outcome, and the specific error conditions an agent may hit. Nothing material needed to call it correctly is missing.

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 schema already documents all four parameters including the refund behavior of sender_account_number. The description adds only indirect parameter meaning (amount correctness against exact-amount accounts), which is the baseline expectation when the schema does the heavy lifting.

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?

The description states a specific verb and resource ('Simulate a customer bank transfer') and immediately scopes it to test virtual accounts, which cleanly separates it from the live-money sibling create_transfer. An agent can identify what this does without opening the 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?

It gives a clear usage context: test mode only, requires an sk_test_ key, and the transfer must target one of your test virtual accounts. It does not explicitly name create_transfer as the live-mode alternative, so the when-not-to-use routing is implied rather than stated.

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

Deploy Server

Other Tools