Skip to main content
Glama

Create checkout

create_checkout

Generate a Pix checkout with a hosted payment page to collect payments. Specify amount in BRL cents and payer CPF/CNPJ.

Instructions

Create a Pix charge (checkout) with a hosted payment page. Requires scope merchant_write. Amount is BRL cents.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
amountNoAmount in BRL cents (R$5.00–R$3000.00). Wire field is `amount`.
metadataNoOptional arbitrary key/value bag echoed back on reads/webhooks.
image_urlNoOptional image on the hosted payment page.
expires_inNoQR lifetime in seconds (300–1200, default 1200).
descriptionNoDescription shown to the payer.
amount_centsNoAlias of `amount` (BRL cents). Provide either `amount` or `amount_cents`.
callback_urlNoOptional per-checkout webhook URL.
redirect_urlNoOptional post-payment redirect URL.
idempotency_keyNoOptional. If omitted, the server generates one. Reuse to safely retry.
payer_tax_numberYesPayer CPF/CNPJ (digits). Required in all modes, including sandbox, while the platform tax-number gate is on.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesCheckout id (chk_…).
pixYesPIX payload; present while pending.
amountYesCharge amount in BRL cents.
statusYesAlways `pending` at creation.
is_liveYesfalse when created with sk_test_.
replayedNotrue when the API replayed a prior response for the same Idempotency-Key.
image_urlYes
expires_atYesQR expiry timestamp (UTC).
descriptionYes
payment_urlYesHosted payment page URL to hand to the payer.
Behavior3/5

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

Annotations indicate readOnlyHint=false (mutation) and openWorldHint=true (potential side effects). The description adds the scope requirement but does not elaborate on other behavioral traits like idempotency handling or payment page behavior beyond creation. It does not contradict 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?

Two sentences, front-loaded with the primary purpose, no wasted words. Efficient and clear.

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

Completeness3/5

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

Given the complexity (10 parameters, nested objects, output schema), the description is minimal but sufficient for a creation tool. It covers core purpose and scope, but omits details like idempotency behavior or payment page flow, which are partially covered by schema. Adequate but not comprehensive.

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 parameters are already well-documented. The description adds no new meaning beyond the schema; the mention of 'BRL cents' is redundant with the param descriptions. Baseline of 3 is appropriate.

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 clearly states the action ('Create') and resource ('Pix charge (checkout) with a hosted payment page'), distinguishing it from sibling tools like get_checkout and list_checkouts.

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

Usage Guidelines3/5

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

The description mentions required scope and currency unit, but lacks explicit guidance on when to use vs. alternatives such as get_checkout or simulate_checkout_payment. The context of sibling tools implies usage, but no direct comparisons are given.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/depixapp/depix-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server