# Antom Payments for WooCommerce

**[English](docs/en/README.md)** | **[中文](docs/zh/README.md)**

> One click to integrate 300+ payment methods around the globe — from major cards, to global digital wallets, to hundreds of top local payment methods worldwide.

**Plugin Name:** Antom Payments
**Version:** 2.0.8
**Requires at least:** WordPress 5.3
**Tested up to:** WordPress 6.9
**Requires PHP:** 7.2+
**WC tested up to:** 9.0.0
**Requires Plugins:** WooCommerce
**License:** GPLv2 or later

---

## 🌏 About

Antom's AI-powered payment platform helps businesses grow globally with optimized payment experience and digitalization services. This plugin integrates Antom's payment gateway into WooCommerce, supporting 300+ payment methods across US, APAC, Latam, and the Middle East — Alipay, GCash, KakaoPay, PayPay, PIX, and many more.

## 📖 Documentation Index

| Document | Description |
|---|---|
| [Installation Guide](docs/en/installation.md) | Step-by-step installation and setup instructions |
| [Configuration Guide](docs/en/configuration.md) | Core settings, per-method settings, and webhook configuration |
| [Architecture Overview](docs/en/architecture.md) | Code architecture, layers, and data flow |
| [Payment Methods](docs/en/payment-methods.md) | Complete list of supported payment methods and currencies |
| [Webhook & API Reference](docs/en/webhook-api.md) | Webhook handling, payment inquiry, and SDK API reference |
| [Development Guide](docs/en/development.md) | Build tools, linting, and contribution guidelines |
| [FAQ](docs/en/faq.md) | Frequently asked questions |
| [Changelog](docs/en/changelog.md) | Version history |

## ✨ Key Features

- **Dual Checkout Mode** — Supports both WooCommerce Classic Checkout and Block Checkout
- **Antom Elements** — PCI-DSS compliant card payment with embedded card fields (RSA + AES encryption)
- **Hosted Checkout (CKP)** — Cashier Payment page with aggregated local payment methods
- **Sandbox / Live Mode** — Built-in test mode with separate credentials
- **Auto Currency Filtering** — Payment methods display based on store currency
- **Webhook Notification** — Real-time payment result via async notification
- **Payment Inquiry** — Fallback inquiry for edge-case payment status confirmation
- **Refund Support** — Full and partial refunds via Antom API
- **HPOS Compatible** — Supports WooCommerce High-Performance Order Storage

## 🚀 Quick Start

1. Install and activate the plugin via **Plugins → Add New** in WordPress admin
2. Go to **WooCommerce → Settings → Checkout → Antom Payment Gateway**
3. Configure your **Client ID**, **Private Key**, and **Public Key**
4. Set up the **Webhook URL** in your [Antom Merchant Portal](https://dashboard.alipay.com/global-payments/home)

See the [Installation Guide](docs/en/installation.md) for detailed instructions.

## 📞 Support

- **Documentation:** [Antom WooCommerce Integration Guide](https://global.alipay.com/docs/ac/plugins/woocommerce)
- **Antom Dashboard:** [dashboard.alipay.com](https://dashboard.alipay.com/global-payments/home)
- **Register:** [Sign up for Antom](https://dashboard.antom.com/global-payments/account/register?bizMode=ISV&isvBizScene=ISO_COMMON&registrationSource=WooCommerce)
- **Email:** global.service@alipay.com

## 📄 License

GPLv2 or later — [http://www.gnu.org/licenses/gpl-2.0.html](http://www.gnu.org/licenses/gpl-2.0.html)