Amos API Docs
Build PCI-compliant checkout with Amos: your server creates a payment or setup intent, the browser mounts Amos-hosted iframes, and sensitive payment data never enters your DOM.
What you can do here
- Follow Getting started for keys, hosts, and your first API call.
- Integrate Embedded checkout with
@amos.com/amos-jsor@amos.com/react-amos-js. - Confirm outcomes with Webhooks — not the client confirm result alone.
- Use the interactive Pay API reference (sidebar) to inspect every operation.
Integration in one page
Your page Amos
──────── ────
@amos.com/amos-js ──postMessage──► embed*.amos.com iframe
or react-amos-js (card / bank / Google Pay / Apple Pay)
Your server
───────────
@amos.com/node or HTTP ──X-Api-Key──► api*.amos.com
POST /payment_intents | /setup_intents → { token, ttl }
- Issue a render token from a dashboard render template (client-safe).
- Mount the iframe with that token.
- On Pay / Save / wallet tap, your server creates an intent and returns only
token. - Await
confirmPaymentorconfirmSetup. - Fulfill from a webhook or a server retrieve.
Packages
| Package | Use |
|---|---|
@amos.com/react-amos-js |
React checkout |
@amos.com/amos-js |
Vanilla JS / any other framework |
@amos.com/node |
Server SDK + OpenAPI types (peer of the client SDKs) |
Current clients (August 2026): @amos.com/amos-js 0.11.11, @amos.com/react-amos-js 0.11.9, peer @amos.com/node >=0.1.57. Pre-1.0 packages can break on minor bumps — pin and read the changelog.
Do not use the archived amos/pay-js-sdk.
Environments
| Sandbox | Production | |
|---|---|---|
| Dashboard | https://dashboard-sandbox.amos.com |
https://dashboard.amos.com |
| Pay API | https://api-sandbox.amos.com |
https://api.amos.com |
| Embed | https://embed-sandbox.amos.com |
https://embed.amos.com |
Never mix a sandbox key with a production render token (or the reverse). @amos.com/node exports AMOS_API_BASE_URL_SANDBOX, AMOS_API_BASE_URL_PRODUCTION, and AMOS_API_VERSION.