Skip to main content
Glama

Server Configuration

Describes the environment variables required to run the server.

NameRequiredDescriptionDefault
PAYRETAILERS_ENVNoEnvironment: 'sandbox' or 'production'. Defaults to 'sandbox'.
PAYRETAILERS_SHOP_IDNoYour Shop ID from the merchant portal.
PAYRETAILERS_SECRET_KEYNoYour Secret Key for HTTP Basic Auth.
PAYRETAILERS_SUBSCRIPTION_KEYNoValue 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

CapabilityDetails
tools
{
  "listChanged": true
}
prompts
{
  "listChanged": true
}
resources
{
  "listChanged": true
}

Tools

Functions exposed to the LLM to take actions

NameDescription
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

NameDescription
integrate-pix-payinGenerate 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-fxGenerate 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-checkoutScaffold 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-authDiagnose 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-graphqlGenerate 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-handlerGenerate 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-subscriptionsGenerate 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

NameDescription
Build a CheckoutEnd-to-end integration guide: Build a Checkout
Build a Subscription PlatformEnd-to-end integration guide: Build a Subscription Platform
Going LiveEnd-to-end integration guide: Going Live
Integrate Card PaymentsEnd-to-end integration guide: Integrate Card Payments
Integrate PayoutsEnd-to-end integration guide: Integrate Payouts
Integrate PIXEnd-to-end integration guide: Integrate PIX
Migrate from another PSPEnd-to-end integration guide: Migrate from another PSP
Testing in SandboxEnd-to-end integration guide: Testing in Sandbox
Argentina Alias/CVU — Transaction MatchingTask-focused workflow: Argentina Alias/CVU — Transaction Matching
Argentina Alias/CVU — Push PaymentTask-focused workflow: Argentina Alias/CVU — Push Payment
Brazil PIX PayinTask-focused workflow: Brazil PIX Payin
Brazil PIX Payout and Account ValidationTask-focused workflow: Brazil PIX Payout and Account Validation
Colombia Bre-B Payin and PayoutTask-focused workflow: Colombia Bre-B Payin and Payout
Customer Module — Onboarding and Virtual AccountsTask-focused workflow: Customer Module — Onboarding and Virtual Accounts
Direct API Payin LifecycleTask-focused workflow: Direct API Payin Lifecycle
Embedded Checkout with Landing InfoTask-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 ReconciliationTask-focused workflow: Merchant Data API — Reporting and Reconciliation
Mexico Credit Card — Backend + JavaScript LibraryTask-focused workflow: Mexico Credit Card — Backend + JavaScript Library
Mexico SPEI — CLABE per CustomerTask-focused workflow: Mexico SPEI — CLABE per Customer
Payin FX ControlTask-focused workflow: Payin FX Control
Payin Webhooks and ReconciliationTask-focused workflow: Payin Webhooks and Reconciliation
Payout with FX QuoteTask-focused workflow: Payout with FX Quote
Payout LifecycleTask-focused workflow: Payout Lifecycle
Paywall CheckoutTask-focused workflow: Paywall Checkout
PIX Automático SubscriptionTask-focused workflow: PIX Automático Subscription
First Payin in SandboxTask-focused workflow: First Payin in Sandbox
Subscription Payments — Automatic and ManualTask-focused workflow: Subscription Payments — Automatic and Manual
Subscription Product LifecycleTask-focused workflow: Subscription Product Lifecycle
Subscription WebhooksTask-focused workflow: Subscription Webhooks
Activate CustomerAPI reference page: Activate Customer
Activate Virtual AccountAPI reference page: Activate Virtual Account
African CountriesAPI reference page: African Countries
AuthenticationAPI reference page: Authentication
Create CustomerAPI reference page: Create Customer
Create PayoutAPI reference page: Create Payout
Create PaywallAPI reference page: Create Paywall
Create TransactionAPI reference page: Create Transaction
Create Payout QuoteAPI reference page: Create Payout Quote
Deactivate CustomerAPI reference page: Deactivate Customer
Deactivate Virtual AccountAPI reference page: Deactivate Virtual Account
Cancel a subscription paymentAPI reference page: Cancel a subscription payment
Cancel a subscriptionAPI reference page: Cancel a subscription
Execute a GraphQL queryAPI reference page: Execute a GraphQL query
Get subscription payment detailsAPI reference page: Get subscription payment details
List subscription productsAPI reference page: List subscription products
Get subscription product detailsAPI reference page: Get subscription product details
Get subscription detailsAPI reference page: Get subscription details
Get CustomerAPI reference page: Get Customer
Get Customer's Virtual AccountsAPI reference page: Get Customer's Virtual Accounts
Get Landing InfoAPI reference page: Get Landing Info
Get Merchant BalanceAPI reference page: Get Merchant Balance
Get Payment MethodsAPI reference page: Get Payment Methods
Get Payout DetailsAPI reference page: Get Payout Details
Get Paywall by trackingIDAPI reference page: Get Paywall by trackingID
Get Paywall by UIDAPI reference page: Get Paywall by UID
Get Transaction by TrackingAPI reference page: Get Transaction by Tracking
Get Transaction by UIDAPI reference page: Get Transaction by UID
GraphQLAPI reference page: GraphQL
IntroductionAPI reference page: Introduction
Landing Info ResponseAPI reference page: Landing Info Response
NotificationsAPI reference page: Notifications
Payout Error MessagesAPI reference page: Payout Error Messages
Payout Flow OverviewAPI reference page: Payout Flow Overview
Payout ParametersAPI reference page: Payout Parameters
paywall-integrationAPI reference page: paywall-integration
Paywall ParametersAPI reference page: Paywall Parameters
Paywall ResponseAPI reference page: Paywall Response
Subscription webhook endpointAPI reference page: Subscription webhook endpoint
Create a manual subscription paymentAPI reference page: Create a manual subscription payment
Create a subscription productAPI reference page: Create a subscription product
Activate a subscription productAPI reference page: Activate a subscription product
Deactivate a subscription productAPI reference page: Deactivate a subscription product
Create a new subscriptionAPI reference page: Create a new subscription
Update a subscription productAPI reference page: Update a subscription product
Sandbox EnvironmentAPI reference page: Sandbox Environment
Test ModeAPI reference page: Test Mode
Transaction Error MessagesAPI reference page: Transaction Error Messages
Transaction ParametersAPI reference page: Transaction Parameters
Transaction ResponseAPI reference page: Transaction Response
Transaction Flow OverviewAPI reference page: Transaction Flow Overview
Update CustomerAPI reference page: Update Customer
Create PayoutCode recipe: Create Payout
Create PaywallCode recipe: Create Paywall
Create TransactionCode recipe: Create Transaction
Get Payment MethodsCode recipe: Get Payment Methods
Get Payout DetailsCode recipe: Get Payout Details
Get Transaction by UIDCode recipe: Get Transaction by UID
List recent payins with date filterCode recipe: List recent payins with date filter
Argentina - Alias (CVU) Bank Transfer PayinsConcept page: Argentina - Alias (CVU) Bank Transfer Payins
API Key RotationConcept page: API Key Rotation
ArgentinaConcept page: Argentina
AuthenticationConcept page: Authentication
AuthenticationConcept page: Authentication
Automatic SchedulingConcept page: Automatic Scheduling
Back Office Two-Factor Authentication(2FA)Concept page: Back Office Two-Factor Authentication(2FA)
Balance SectionConcept page: Balance Section
Bank TransfersConcept page: Bank Transfers
BrazilConcept page: Brazil
BrazilConcept page: Brazil
CardsConcept page: Cards
CashConcept page: Cash
ChileConcept page: Chile
SPEI CLABE per CustomerConcept page: SPEI CLABE per Customer
ColombiaConcept page: Colombia
Colombia - Bre-BConcept page: Colombia - Bre-B
Coverage and MethodsConcept page: Coverage and Methods
Customer Management ModuleConcept page: Customer Management Module
Data Model ReferenceConcept page: Data Model Reference
Hosted Payment PagesConcept page: Hosted Payment Pages
Error HandlingConcept page: Error Handling
Getting StartedConcept page: Getting Started
Getting Started with SubscriptionsConcept page: Getting Started with Subscriptions
Getting Started with the Merchant Data APIConcept page: Getting Started with the Merchant Data API
Help & SupportConcept page: Help & Support
Direct APIConcept page: Direct API
Direct API JavaScript LibraryConcept page: Direct API JavaScript Library
Optimizing Conversion with our PaywallConcept page: Optimizing Conversion with our Paywall
Integration TypesConcept page: Integration Types
Landing Info CustomisationConcept page: Landing Info Customisation
Payins FX ControlConcept page: Payins FX Control
Merchant FX ControlConcept page: Merchant FX Control
Merchant Portal OverviewConcept page: Merchant Portal Overview
MexicoConcept page: Mexico
MexicoConcept page: Mexico
notificationsConcept page: notifications
Optimizing Conversion with our Direct APIConcept page: Optimizing Conversion with our Direct API
Optimizing Conversion with our Hosted Payment PagesConcept page: Optimizing Conversion with our Hosted Payment Pages
Pagination, Filtering, and SortingConcept page: Pagination, Filtering, and Sorting
Password ResetConcept page: Password Reset
PayinsConcept page: Payins
Payment ButtonsConcept page: Payment Buttons
Payment EmailsConcept page: Payment Emails
Payment LinksConcept page: Payment Links
Payment Method TypesConcept page: Payment Method Types
Payment SubscriptionsConcept page: Payment Subscriptions
Payment Tools SectionConcept page: Payment Tools Section
Payouts FX ControlConcept page: Payouts FX Control
PayoutsConcept page: Payouts
Payouts SectionConcept page: Payouts Section
Paywall IntegrationConcept page: Paywall Integration
PeruConcept page: Peru
Pix Automatic (Subscription Service)Concept page: Pix Automatic (Subscription Service)
PIX Integration PayinsConcept page: PIX Integration Payins
PIX Integration PayoutsConcept page: PIX Integration Payouts
PIX new account validation serviceConcept page: PIX new account validation service
Push Payment ModeConcept page: Push Payment Mode
Retry PoliciesConcept page: Retry Policies
Service Status PageConcept page: Service Status Page
Subscription ConceptsConcept page: Subscription Concepts
Subscription Payment MethodsConcept page: Subscription Payment Methods
Subscription ProductsConcept page: Subscription Products
Transaction Matching ModeConcept page: Transaction Matching Mode
Transaction TypesConcept page: Transaction Types
Transactions SectionConcept page: Transactions Section
SolutionsConcept page: Solutions
Webhooks and NotificationsConcept page: Webhooks and Notifications
Welcome to PayRetailers!Concept page: Welcome to PayRetailers!

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/payretailers-dev/payretailers-mcp'

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