Skip to main content
Glama

get_payment

Read-only

Retrieve a single payment by ID from your Checkout Page account. Pass livemode: false to read test-mode records.

Use list_payments first if you need to discover a payment ID by customer email, customer name, product title, or order ID. Event bookings are a separate record type — use list_bookings for those.

If the payment ID does not exist for the authenticated seller, returns a 404 error: "Payment not found".

Example uses:

  • "Fetch payment 6812fe6e9f39b6760576f01c"

  • "Show me the full details of this payment"

  • "Was this payment refunded, and how much?"

This tool is read-only. Refunds and cancellations must be performed in the Checkout Page dashboard.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
livemodeNoSet to false to read test-mode records (created while a page was in test mode). Defaults to live records.
paymentIdYesThe ID of the payment to retrieve. Use `list_payments` first if you need to discover the payment ID by email, name, customer, page, product, or date range. Bookings for event pages have their own IDs and are not retrievable here.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
dataYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so safety is covered. The description goes further by disclosing the seller-scoped authorization ('for the authenticated seller'), the exact 404 behavior on a missing ID, and the test-mode-vs-live record distinction, all genuine behavioral context beyond the annotations.

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

Conciseness5/5

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

Front-loaded with the core operation, then routing guidance, then failure/behavior notes, then concrete examples. The read-only statement is partly redundant with readOnlyHint but is a short, high-value reinforcement for a retrieval tool rather than padding.

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?

An output schema exists, so return-value explanation is rightly omitted. For a single-record getter, the description covers purpose, routing to siblings, auth scoping, error behavior, and mode switching — nothing an agent needs 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 both parameters (paymentId, livemode) are already fully documented in the schema, which sets the baseline at 3. The description restates the livemode:false test-mode behavior and the ID-discovery hint, adding reinforcement but no syntax or format details the schema lacks.

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 ('Retrieve a single payment by ID') and immediately scopes it to the Checkout Page account. It explicitly distinguishes itself from the record types an agent might confuse it with (bookings vs. payments), which is exactly the differentiation needed among 50+ siblings.

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

Usage Guidelines5/5

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

It names the alternatives and the conditions selecting them: use `list_payments` first to discover an ID by email/name/product/order, and use `list_bookings` for event bookings. It even states the failure mode (404 'Payment not found') and where mutations must happen instead (the dashboard).

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources