PayRetailers API
Agent-ready OpenAPI document · curated by JenticPaymentsPayment Processingbasic, apiKey20 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Process payments and payouts across Latin America using local payment methods, manage customer virtual accounts, and check balances through a single regional gateway.
Use for: I need to process a payment in Latin America, I want to send a payout to a bank account in Brazil, List available payment methods for Mexico, Check my PayRetailers account balance
Not supported: Does not handle card issuing, loyalty programs, or tax calculation - use for Latin American payment acceptance, payouts, and customer management only.
Jentic publishes the only available OpenAPI specification for PayRetailers API, keeping it validated and agent-ready. PayRetailers is a Latin American payment gateway that enables businesses to accept local payment methods, process payouts, manage customers with virtual accounts, and handle paywalls across multiple countries. The API provides 20 endpoints covering payment processing, payout management, customer lifecycle, and balance queries with support for region-specific methods like PIX, OXXO, and bank transfers.
Install Jentic One Beta
Connect the PayRetailers API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the PayRetailers API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fpayretailers.com%2Fpayretailers" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Fpayretailers.com%2Fpayretailers" | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with PayRetailers API.
Accept payments via Latin American local methods including PIX, OXXO, and bank transfers
Process payouts to bank accounts across multiple Latin American countries
Manage customer profiles with activation, deactivation, and virtual account assignment
Create hosted paywalls for payment collection without custom checkout development
Query real-time account balance and payout quote rates
Track transactions and payouts by UID or internal tracking ID
Retrieve available payment methods filtered by country and currency
Use Cases
Patterns agents use PayRetailers API for, with concrete tasks.
★ Latin American Payment Collection
Accept payments from customers across Latin America using their preferred local payment methods. PayRetailers supports country-specific options like PIX in Brazil, OXXO in Mexico, and bank transfers region-wide. The API returns available methods per country and handles the payment flow including customer redirect and status notification.
Retrieve payment methods for Brazil via GET /payment-methods, then create a PIX transaction for R$150.00 via POST /transactions
Cross-Border Payouts
Send payouts to bank accounts across Latin American countries. The API provides payout quote rates before execution, allowing cost estimation. Payouts support multiple corridors and the status can be tracked by payout ID. Balance verification ensures sufficient funds before initiating transfers.
Get a payout quote via POST /payout-quotes, verify balance via GET /balance, then execute a payout of $500 USD to a Mexican bank account via POST /payouts
Customer Virtual Account Management
Create and manage customer profiles with virtual accounts that can receive deposits. Customers can be activated or deactivated, and their virtual accounts support automatic payment matching. This enables recurring collections and marketplace-style payment flows across Latin America.
Create a customer via POST /customers, then assign a virtual account using POST /customers/{customerId}/virtual-accounts and activate it
AI Agent LatAm Payment Orchestration
AI agents use the PayRetailers API through Jentic to process Latin American payments and payouts without managing dual authentication (basic auth plus API key) or country-specific payment method logic. Jentic handles credential isolation and operation discovery across all 20 endpoints.
Search Jentic for 'process a payment in Latin America', load the PayRetailers transaction creation schema, and execute a payment for $100 USD in Colombia
Key Endpoints
20 endpoints — jentic publishes the only available openapi specification for payretailers api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
GET
/payment-methods
List available payment methods by country
POST
/transactions
Create a payment transaction
GET
/transactions/uid/{uid}
Get transaction by UID
POST
/payouts
Send a payout to a bank account
GET
/balance
Check account balance
POST
/customers
Create a customer profile
POST
/payout-quotes
Get a payout rate quote
POST
/paywalls
Create a hosted payment page
GET
/payment-methods
List available payment methods by country
POST
/transactions
Create a payment transaction
GET
/transactions/uid/{uid}
Get transaction by UID
POST
/payouts
Send a payout to a bank account
GET
/balance
Check account balance
POST
/customers
Create a customer profile
POST
/payout-quotes
Get a payout rate quote
POST
/paywalls
Create a hosted payment page
Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring PayRetailers by hand means handling its dual basic auth plus Ocp-Apim-Subscription-Key header, choosing the sandbox or production host, and mapping country-specific Latin American payment parameters yourself. Through Jentic you install once, import PayRetailers from the API Directory, store the credentials once, and your agent calls it.
Permission scoping
PayRetailers routes its transaction and payout targets through the request body rather than the URL path, so scope the agent by the operations it needs, such as listing payment methods or querying a transaction by uid. You choose that set, so write operations like creating payouts or customers are not included unless you add them.
Credential isolation
Your PayRetailers basic auth credentials and subscription key are stored once, encrypted, by your own Jentic One instance and injected at execution time. They never enter the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'accept a PIX payment in Brazil' or 'check a transaction status', and Jentic returns the matching PayRetailers operation with its input schema including country-specific parameters so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
Alternative
Stripe
Global payment processor with some Latin American method support
Choose Stripe when you need a single global API that also serves Latin America, though with fewer local payment method options than PayRetailers.
FAQs
Specific to using PayRetailers API through Jentic.
Why is there no official OpenAPI spec for PayRetailers API?
PayRetailers does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call PayRetailers API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.
What authentication does the PayRetailers API use?
The PayRetailers API uses dual authentication combining HTTP Basic Auth (username and password) and an API key header. Both are required for each request. Through Jentic, both credential types are stored encrypted in your Jentic One instance and agents receive scoped access without handling raw credentials.
Which payment methods are available in Brazil through PayRetailers?
Use GET /payment-methods with a country filter for Brazil to retrieve available options. Common Brazilian methods include PIX (instant bank transfer), Boleto Bancario (bank slip), and local credit card processing. Availability depends on your merchant account configuration.
How do I send a payout through Jentic?
Use Jentic to search for 'send a payout in Latin America', load the schema for POST /payouts, and execute with the destination bank account details, amount, and country. Before executing, you can get a rate quote via POST /payout-quotes and verify funds via GET /balance.
What countries does PayRetailers support?
PayRetailers covers multiple Latin American markets including Brazil, Mexico, Colombia, Argentina, Chile, Peru, and Ecuador. The GET /payment-methods endpoint returns country-specific available methods based on your merchant configuration.
Can I create recurring payment collections with PayRetailers?
Yes. By creating customer profiles via POST /customers and assigning virtual accounts through POST /customers/{customerId}/virtual-accounts, you can set up automated payment matching for recurring collections. Virtual accounts receive deposits that are automatically linked to the correct customer.
Can I limit what my agent is allowed to do with the PayRetailers API?
Yes. Because you run Jentic One yourself, you decide exactly which PayRetailers operations your agent can call and which credentials it may use. Since PayRetailers passes transaction and payout targets through the request body rather than the URL path, you scope by operation, so you can grant read-only calls like listing payment methods with GET /payment-methods or querying a transaction with GET /transactions/uid/{uid} while withholding write operations such as POST /payouts or POST /customers. Your own rules govern the set, so those write endpoints stay unavailable to the agent unless you explicitly add them.
GET STARTED