canonical: https://jentic.com/apis/payphone.app/payphone # Payphone App PayPhone API The PayPhone API is the card-payment interface for PayPhone, a payment gateway used across Ecuador. It lets a merchant charge a card and then track that charge to settlement: one operation submits a sale, and two read operations return the sale by PayPhone's transaction id or by the merchant's own client transaction id. Requests carry a bearer token and are sent to the pay.payphonetodoesposible.com host. It suits online stores and billing flows that need to take card payments and reconcile them against their own order records. ## For AI agents Charge cards and reconcile the resulting sales through PayPhone's payment gateway, looking transactions up by PayPhone's id or your own client transaction id. ## Scope Handles card sales and their status lookups through PayPhone. Does not cover payouts, refunds beyond the documented operations, invoicing, accounting, or tax filing. ## Capabilities - Submit a card sale to PayPhone by posting the transaction to the Sale endpoint - Retrieve a sale by PayPhone's transaction id to confirm whether it settled - Retrieve a sale by your own client transaction id to reconcile it against an order - Drive a checkout that takes a card payment and then verifies the outcome before fulfilment - Reconcile settled sales against internal records using the client transaction id you supplied ## Use cases ### Card checkout in an Ecuadorian store Take a card payment at checkout through PayPhone and confirm the result before completing the order. The agent submits the sale with the amount and the buyer's card details captured by the storefront, then reads the transaction back to check that it was approved so the order is only fulfilled on a settled payment. Example prompt: Submit a sale for the cart amount to PayPhone, capture the returned transaction id, then read the transaction back and proceed only when its status shows the payment approved. ### Order reconciliation by client transaction id Match PayPhone sales to internal orders using the merchant's own client transaction id. The agent supplies its order reference when charging, then later looks the sale up by that same reference to reconcile payments without storing PayPhone's ids everywhere in the order system. Example prompt: Read a sale by the client transaction id that was sent when charging, and compare its status and amount against the matching internal order. ### Payment status verification for support Answer a customer's payment question by checking the live status of a sale. The agent takes the PayPhone transaction id from the order and returns the current status so a support flow can tell the buyer whether the charge went through. Example prompt: Look up the sale by its PayPhone transaction id and return the current status so a support agent can respond to the customer. ## Key endpoints | Method | Path | Description | | --- | --- | --- | | POST | `/api/Sale` | Submit a card sale to PayPhone for processing | | GET | `/api/Sale/{transactionId}` | Retrieve a sale by PayPhone's transaction id to check its status | | GET | `/api/Sale/client/{clientTransactionId}` | Retrieve a sale by the merchant's own client transaction id | ## Key resources - **Sale** — A card transaction submitted to PayPhone for processing, then read back to confirm its settlement status. - **Client transaction id** — The merchant's own reference for a sale, used to look the transaction up and reconcile it against internal orders. ## AI readiness This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use. - **Score:** 69 / 100 - **Maturity:** AI-Aware - **Dimensions:** - Foundational Compliance: 100 / 100 - Developer Experience & Jentic Compatibility: 63 / 100 - AI-Readiness & Agent Experience: 49 / 100 - Agent Usability: 94 / 100 - Security: 60 / 100 - AI Discoverability: 100 / 100 - **View full report:** https://jentic.com/apis/payphone.app/payphone/scorecard - **How the score is calculated:** https://docs.jentic.com/reference/api-readiness-framework/overview/ - **More about the dimensions:** https://docs.jentic.com/reference/api-readiness-framework/specification/#dimensional-model-overview ### Score it yourself Every API in the directory is allowlisted, so you can re-score it with no key required. - **Score your own API:** https://jentic.com/scorecard.md - **Scoring CLI agent skill:** https://github.com/jentic/jentic-api-scorecard/blob/main/skills/jentic-api-scorecard/SKILL.md ```sh npx @jentic/api-scorecard-cli score ``` ## Why Jentic - **Setup:** Wiring PayPhone by hand means provisioning a bearer token, pointing requests at the pay.payphonetodoesposible.com host, and learning how the sale and lookup operations fit together. Through Jentic you install once, import the PayPhone API from the Jentic API Directory, save your token, and your agent calls it. - **Permission scoping:** PayPhone exposes a small set of operations, and because Jentic One is self-hosted, your own rules decide which the agent may call. You can allow submitting a sale while leaving the transaction lookups out until a task needs them, so every operation the agent can reach is one you chose. - **Credential handling:** Your PayPhone bearer token is held encrypted by your own Jentic One instance and attached to each request only at execution time. It never enters the agent's prompt, logs, or context. - **Discovery method:** Agents search Jentic by intent, such as charging a card or checking a payment, and Jentic returns the matching PayPhone operation with typed inputs so the agent calls the right one without reading the raw specification. ## Related APIs - **Stripe API** — Charge cards and manage payments with a broad international payment platform - **Braintree GraphQL API** — Accept cards, PayPal, and wallets through a single payment endpoint - **Adyen Payment API** — Authorize, capture, and settle card payments across many markets - **Reloadly Topups API** — Send mobile airtime and data top-ups alongside PayPhone card collections ## FAQ ### What authentication does the PayPhone API use? Requests are authorized with an HTTP bearer token sent in the Authorization header. Through Jentic, that token is held encrypted by your own Jentic One instance and attached to each request at execution time, so it never appears in an agent's prompt or logs. ### Can I check whether a PayPhone sale was approved? Yes. After submitting a sale you receive PayPhone's transaction id, and you can read the sale back by that id, or by the client transaction id you supplied, to see its current status before fulfilling an order. ### What are the rate limits for the PayPhone API? The OpenAPI description does not specify rate limits. Check PayPhone's developer documentation for the limits that apply to your merchant account before running high-volume payment workloads. ### Is there an MCP server for the PayPhone API? You don't need an MCP server to use the PayPhone API with your agent. Through Jentic, your agent discovers the payment operations by intent and calls them directly, with your bearer token injected at run time by your own Jentic One instance. ### How do I connect the PayPhone API to my agent through Jentic? To run it on your own infrastructure, install Jentic One from its GitHub repo, then import the PayPhone API from the Jentic API Directory and save your bearer token. Your agent can then submit and read sales with credentials injected at execution time. ### Can I limit what my agent is allowed to do with the PayPhone API? Yes. Because Jentic One is self-hosted, your own rules decide which PayPhone operations the agent may call, so you can allow only submitting a sale, for example, while leaving the read operations out unless a task needs them. Your bearer token stays encrypted on your own instance and is attached only when a permitted request runs.