@payretailers/mcp
OfficialServer Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| PAYRETAILERS_ENV | No | Environment: 'sandbox' or 'production'. Defaults to 'sandbox'. | |
| PAYRETAILERS_SHOP_ID | No | Your Shop ID from the merchant portal. | |
| PAYRETAILERS_SECRET_KEY | No | Your Secret Key for HTTP Basic Auth. | |
| PAYRETAILERS_SUBSCRIPTION_KEY | No | Value of the Ocp-Apim-Subscription-Key header. |
Instructions
Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.
This server publishes no instructions, or was last inspected before Glama recorded them.
Capabilities
Features and capabilities supported by this server
Protocol revision2025-11-25
| Capability | Details |
|---|---|
| tools | {
"listChanged": true
} |
| prompts | {
"listChanged": true
} |
| resources | {
"listChanged": true
} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| search_docsA | Search across PayRetailers Guides and Skills. Returns top matches with a short snippet. Use this before answering any integration question to ground your response in the official documentation. |
| get_country_rulesA | Return the country-specific rules for a PayRetailers integration: accepted currencies, personalId format (CPF, DNI, CLABE, RUT, ...), payment method constraints, and regulatory notes. Call this before emitting any country-specific payload. |
| get_test_dataA | Return official-shaped sandbox test data for a country: sample customers (name, email, personalId in correct format, address), test cards (approved/declined), and PIX/Bre-B keys where applicable. Use this to populate sandbox requests with realistic values instead of inventing them. |
| get_endpoint_specA | Return the full reference page (parameters, response, error codes) for a specific PayRetailers endpoint. Use this to ground your generated code against the exact request/response schema before emitting it. |
| validate_payloadA | REQUIRED whenever the user shows or you are about to emit a JSON body for POST /transactions, POST /payouts, POST /customers, POST /v1/subscription-products, POST /v1/subscriptions, or POST /v1/subscription-payments — even if the payload looks correct. Runs the same checks a senior PayRetailers integrator would run in code review: country-specific document checksum (CPF, CNPJ, RUT, DNI, RUC, CC, NIT, CURP, RFC, CLABE), minor-units-as-string amount format, currency/country match, HTTPS notificationUrl, method/country compatibility (PIX only BR, BRE_B only CO, SPEI only MX, etc.), idempotency key length, trackingId ≤ 50 chars, customer required fields matrix (customer.ip / customer.country always; city+address in CO or card in EC/MX; zip on cards in EC/MX; phone on Boleto/Efecty/PagoEfectivo/Yape/Plin/WesternUnion-PA/African methods). For subscriptions: enforces billingCycle shape, Bacen PIX_SPECIFIC contract (maxRetries=3 / retryIntervalDays=7 fixed for BR PIX Automático), FIXED_RETRY config completeness, and authorisationJourney vocabulary (BACKGROUND / USER_INTERACTION). Returns machine-readable {errors, warnings, info} with code, path, severity, hint and often a suggestion — pipe those back into the corrected payload before you show any curl / SDK call to the user. Do not skip: a payload that 'looks fine' but hits the API returns generic 4xx errors that are far harder to interpret than the codes this tool emits. |
| get_webhook_playbookA | REQUIRED before implementing any webhook receiver or reconciliation flow. Returns the canonical PayRetailers webhook contract: envelope schema, complete event vocabulary (transaction lifecycle: PENDING/IN_PROGRESS/APPROVED/REJECTED/CANCELLED/EXPIRED/REFUNDED/CHARGEBACK; payout lifecycle; subscription and subscription_payment events with retry semantics), HTTP response contract (200 fast / 400 no-retry / 500 retried), idempotency by eventId, replay protection, signature verification, retry policies (PIX_SPECIFIC / FIXED_RETRY / NOT_ALLOWED), and the top 6 wrong-way patterns integrators hit. Filter by category or eventType for a focused answer. Do not attempt to design a webhook handler from memory — call this tool first. |
| validate_webhook_handlerA | REQUIRED whenever the user is designing, describing, or about to code a webhook receiver for PayRetailers — even if the design looks fine. Analyses a declarative description of the handler (URL, processing mode, ack strategy, idempotency, signature verification, replay protection, error mapping, ordering assumptions) against the PayRetailers contract and returns {errors, warnings, info} with actionable codes. Catches the top failure modes: acknowledging AFTER processing (times out and gets retried), returning 500 on business errors (infinite retries), missing eventId de-duplication (double-fulfilment), assuming wall-clock order (state corruption), HTTPS missing, signature disabled in production, replay window absent. Pair with get_webhook_playbook when designing from scratch. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
| integrate-pix-payin | Generate a complete, sandbox-ready Brazil PIX payin integration for the specified language. Includes Basic Auth, Ocp-Apim-Subscription-Key header, minor-units amount, CPF-formatted personalId, and notificationUrl. |
| integrate-payout-fx | Generate a full LATAM cross-currency payout integration using PayRetailers: request an FX quote, honor the 5-minute quote TTL, execute the payout with idempotent externalReference, and handle webhook confirmations. |
| build-checkout | Scaffold a full checkout: a frontend method picker that captures customer data, a backend endpoint that creates a PayRetailers transaction, a webhook receiver for final status, and a redirect/render for hosted payment methods. |
| debug-401-auth | Diagnose an HTTP 401/403 response from the PayRetailers API. Walks through the four common root causes (missing subscription-key header, wrong shopId/secret, IP whitelist, sandbox-vs-production mix-up) and produces a checklist. |
| reconcile-with-graphql | Generate a reconciliation script that queries the PayRetailers merchant-data GraphQL endpoint, compares the results against the merchant's internal ledger, and produces a delta report with missed webhooks flagged. |
| implement-webhook-handler | Generate a production-grade PayRetailers webhook receiver for the requested stack. Enforces the four non-negotiables: return 200 within 3 s, de-duplicate by eventId, verify signature strictly, and never confirm before APPROVED/PAID. Includes dispatcher, idempotency store, signature verifier, and dead-letter queue plumbing. |
| integrate-subscriptions | Generate a full PayRetailers subscription integration for the given country and channel: product creation, subscription creation with authorisation, retry handling, cancellation, and webhook stubs. Enforces the actual OpenAPI shape (frequency enum, AmountModel, authorizationType American spelling, no /v1/subscriptions/{id}/activate endpoint) and BR PIX Automático rules. |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
| Build a Checkout | End-to-end integration guide: Build a Checkout |
| Build a Subscription Platform | End-to-end integration guide: Build a Subscription Platform |
| Going Live | End-to-end integration guide: Going Live |
| Integrate Card Payments | End-to-end integration guide: Integrate Card Payments |
| Integrate Payouts | End-to-end integration guide: Integrate Payouts |
| Integrate PIX | End-to-end integration guide: Integrate PIX |
| Migrate from another PSP | End-to-end integration guide: Migrate from another PSP |
| Testing in Sandbox | End-to-end integration guide: Testing in Sandbox |
| Argentina Alias/CVU — Transaction Matching | Task-focused workflow: Argentina Alias/CVU — Transaction Matching |
| Argentina Alias/CVU — Push Payment | Task-focused workflow: Argentina Alias/CVU — Push Payment |
| Brazil PIX Payin | Task-focused workflow: Brazil PIX Payin |
| Brazil PIX Payout and Account Validation | Task-focused workflow: Brazil PIX Payout and Account Validation |
| Colombia Bre-B Payin and Payout | Task-focused workflow: Colombia Bre-B Payin and Payout |
| Customer Module — Onboarding and Virtual Accounts | Task-focused workflow: Customer Module — Onboarding and Virtual Accounts |
| Direct API Payin Lifecycle | Task-focused workflow: Direct API Payin Lifecycle |
| Embedded Checkout with Landing Info | Task-focused workflow: Embedded Checkout with Landing Info |
| Hosted Payment Pages (Dynamic Checkout) | Task-focused workflow: Hosted Payment Pages (Dynamic Checkout) |
| Merchant Data API — Reporting and Reconciliation | Task-focused workflow: Merchant Data API — Reporting and Reconciliation |
| Mexico Credit Card — Backend + JavaScript Library | Task-focused workflow: Mexico Credit Card — Backend + JavaScript Library |
| Mexico SPEI — CLABE per Customer | Task-focused workflow: Mexico SPEI — CLABE per Customer |
| Payin FX Control | Task-focused workflow: Payin FX Control |
| Payin Webhooks and Reconciliation | Task-focused workflow: Payin Webhooks and Reconciliation |
| Payout with FX Quote | Task-focused workflow: Payout with FX Quote |
| Payout Lifecycle | Task-focused workflow: Payout Lifecycle |
| Paywall Checkout | Task-focused workflow: Paywall Checkout |
| PIX Automático Subscription | Task-focused workflow: PIX Automático Subscription |
| First Payin in Sandbox | Task-focused workflow: First Payin in Sandbox |
| Subscription Payments — Automatic and Manual | Task-focused workflow: Subscription Payments — Automatic and Manual |
| Subscription Product Lifecycle | Task-focused workflow: Subscription Product Lifecycle |
| Subscription Webhooks | Task-focused workflow: Subscription Webhooks |
| Activate Customer | API reference page: Activate Customer |
| Activate Virtual Account | API reference page: Activate Virtual Account |
| African Countries | API reference page: African Countries |
| Authentication | API reference page: Authentication |
| Create Customer | API reference page: Create Customer |
| Create Payout | API reference page: Create Payout |
| Create Paywall | API reference page: Create Paywall |
| Create Transaction | API reference page: Create Transaction |
| Create Payout Quote | API reference page: Create Payout Quote |
| Deactivate Customer | API reference page: Deactivate Customer |
| Deactivate Virtual Account | API reference page: Deactivate Virtual Account |
| Cancel a subscription payment | API reference page: Cancel a subscription payment |
| Cancel a subscription | API reference page: Cancel a subscription |
| Execute a GraphQL query | API reference page: Execute a GraphQL query |
| Get subscription payment details | API reference page: Get subscription payment details |
| List subscription products | API reference page: List subscription products |
| Get subscription product details | API reference page: Get subscription product details |
| Get subscription details | API reference page: Get subscription details |
| Get Customer | API reference page: Get Customer |
| Get Customer's Virtual Accounts | API reference page: Get Customer's Virtual Accounts |
| Get Landing Info | API reference page: Get Landing Info |
| Get Merchant Balance | API reference page: Get Merchant Balance |
| Get Payment Methods | API reference page: Get Payment Methods |
| Get Payout Details | API reference page: Get Payout Details |
| Get Paywall by trackingID | API reference page: Get Paywall by trackingID |
| Get Paywall by UID | API reference page: Get Paywall by UID |
| Get Transaction by Tracking | API reference page: Get Transaction by Tracking |
| Get Transaction by UID | API reference page: Get Transaction by UID |
| GraphQL | API reference page: GraphQL |
| Introduction | API reference page: Introduction |
| Landing Info Response | API reference page: Landing Info Response |
| Notifications | API reference page: Notifications |
| Payout Error Messages | API reference page: Payout Error Messages |
| Payout Flow Overview | API reference page: Payout Flow Overview |
| Payout Parameters | API reference page: Payout Parameters |
| paywall-integration | API reference page: paywall-integration |
| Paywall Parameters | API reference page: Paywall Parameters |
| Paywall Response | API reference page: Paywall Response |
| Subscription webhook endpoint | API reference page: Subscription webhook endpoint |
| Create a manual subscription payment | API reference page: Create a manual subscription payment |
| Create a subscription product | API reference page: Create a subscription product |
| Activate a subscription product | API reference page: Activate a subscription product |
| Deactivate a subscription product | API reference page: Deactivate a subscription product |
| Create a new subscription | API reference page: Create a new subscription |
| Update a subscription product | API reference page: Update a subscription product |
| Sandbox Environment | API reference page: Sandbox Environment |
| Test Mode | API reference page: Test Mode |
| Transaction Error Messages | API reference page: Transaction Error Messages |
| Transaction Parameters | API reference page: Transaction Parameters |
| Transaction Response | API reference page: Transaction Response |
| Transaction Flow Overview | API reference page: Transaction Flow Overview |
| Update Customer | API reference page: Update Customer |
| Create Payout | Code recipe: Create Payout |
| Create Paywall | Code recipe: Create Paywall |
| Create Transaction | Code recipe: Create Transaction |
| Get Payment Methods | Code recipe: Get Payment Methods |
| Get Payout Details | Code recipe: Get Payout Details |
| Get Transaction by UID | Code recipe: Get Transaction by UID |
| List recent payins with date filter | Code recipe: List recent payins with date filter |
| Argentina - Alias (CVU) Bank Transfer Payins | Concept page: Argentina - Alias (CVU) Bank Transfer Payins |
| API Key Rotation | Concept page: API Key Rotation |
| Argentina | Concept page: Argentina |
| Authentication | Concept page: Authentication |
| Authentication | Concept page: Authentication |
| Automatic Scheduling | Concept page: Automatic Scheduling |
| Back Office Two-Factor Authentication(2FA) | Concept page: Back Office Two-Factor Authentication(2FA) |
| Balance Section | Concept page: Balance Section |
| Bank Transfers | Concept page: Bank Transfers |
| Brazil | Concept page: Brazil |
| Brazil | Concept page: Brazil |
| Cards | Concept page: Cards |
| Cash | Concept page: Cash |
| Chile | Concept page: Chile |
| SPEI CLABE per Customer | Concept page: SPEI CLABE per Customer |
| Colombia | Concept page: Colombia |
| Colombia - Bre-B | Concept page: Colombia - Bre-B |
| Coverage and Methods | Concept page: Coverage and Methods |
| Customer Management Module | Concept page: Customer Management Module |
| Data Model Reference | Concept page: Data Model Reference |
| Hosted Payment Pages | Concept page: Hosted Payment Pages |
| Error Handling | Concept page: Error Handling |
| Getting Started | Concept page: Getting Started |
| Getting Started with Subscriptions | Concept page: Getting Started with Subscriptions |
| Getting Started with the Merchant Data API | Concept page: Getting Started with the Merchant Data API |
| Help & Support | Concept page: Help & Support |
| Direct API | Concept page: Direct API |
| Direct API JavaScript Library | Concept page: Direct API JavaScript Library |
| Optimizing Conversion with our Paywall | Concept page: Optimizing Conversion with our Paywall |
| Integration Types | Concept page: Integration Types |
| Landing Info Customisation | Concept page: Landing Info Customisation |
| Payins FX Control | Concept page: Payins FX Control |
| Merchant FX Control | Concept page: Merchant FX Control |
| Merchant Portal Overview | Concept page: Merchant Portal Overview |
| Mexico | Concept page: Mexico |
| Mexico | Concept page: Mexico |
| notifications | Concept page: notifications |
| Optimizing Conversion with our Direct API | Concept page: Optimizing Conversion with our Direct API |
| Optimizing Conversion with our Hosted Payment Pages | Concept page: Optimizing Conversion with our Hosted Payment Pages |
| Pagination, Filtering, and Sorting | Concept page: Pagination, Filtering, and Sorting |
| Password Reset | Concept page: Password Reset |
| Payins | Concept page: Payins |
| Payment Buttons | Concept page: Payment Buttons |
| Payment Emails | Concept page: Payment Emails |
| Payment Links | Concept page: Payment Links |
| Payment Method Types | Concept page: Payment Method Types |
| Payment Subscriptions | Concept page: Payment Subscriptions |
| Payment Tools Section | Concept page: Payment Tools Section |
| Payouts FX Control | Concept page: Payouts FX Control |
| Payouts | Concept page: Payouts |
| Payouts Section | Concept page: Payouts Section |
| Paywall Integration | Concept page: Paywall Integration |
| Peru | Concept page: Peru |
| Pix Automatic (Subscription Service) | Concept page: Pix Automatic (Subscription Service) |
| PIX Integration Payins | Concept page: PIX Integration Payins |
| PIX Integration Payouts | Concept page: PIX Integration Payouts |
| PIX new account validation service | Concept page: PIX new account validation service |
| Push Payment Mode | Concept page: Push Payment Mode |
| Retry Policies | Concept page: Retry Policies |
| Service Status Page | Concept page: Service Status Page |
| Subscription Concepts | Concept page: Subscription Concepts |
| Subscription Payment Methods | Concept page: Subscription Payment Methods |
| Subscription Products | Concept page: Subscription Products |
| Transaction Matching Mode | Concept page: Transaction Matching Mode |
| Transaction Types | Concept page: Transaction Types |
| Transactions Section | Concept page: Transactions Section |
| Solutions | Concept page: Solutions |
| Webhooks and Notifications | Concept page: Webhooks and Notifications |
| Welcome to PayRetailers! | Concept page: Welcome to PayRetailers! |
Latest Blog Posts
- Who's Calling? MCP Hosts Are an Identity Blind Spot (And the Spec Knows It)By Om-Shree-0709 on .mcpAgent IdentityOAuth 2.1
- Your AI Chatbot Just Exposed Your CEO's Salary to an InternBy Om-Shree-0709 on .Agent IdentityMCP SecurityOAuth Delegation
- Why MCP Servers Need Execution Sandboxing (And Why Your Current Stack Isn't Enough)By Om-Shree-0709 on .Agentic AiPrompt InjectionWebAssembly
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/payretailers-dev/payretailers-mcp'
If you have feedback or need assistance with the MCP directory API, please join our Discord server