# Antom SDK Overview

This document summarizes all server-side SDKs supported by Antom and their supported products/APIs, helping developers quickly choose the appropriate SDK.

## SDK List

| Language | Version Requirement | SDK Version | Package Manager | GitHub |
|----------|---------------------|-------------|-----------------|--------|
| **Java** | JDK 1.6+ | 2.1.17 | Maven | [global-open-sdk-java](https://github.com/alipay/global-open-sdk-java) |
| **Python** | 2.7+ | 1.4.31 | PyPI | [global-open-sdk-python](https://github.com/alipay/global-open-sdk-python) |
| **PHP** | 7.4+ | 1.4.30 | Composer | [global-open-sdk-php](https://github.com/alipay/global-open-sdk-php) |
| **Go** | 1.22.5+ | latest | go get | [global-open-sdk-go](https://github.com/alipay/global-open-sdk-go) |
| **.NET (C#)** | .NET 8.0+ | 2.1.20 | NuGet | [global-open-sdk-dotnet](https://github.com/alipay/global-open-sdk-dotnet) |

## Gateway URL

| Region | Gateway URL |
|--------|-------------|
| **NA - US** | `https://open.antglobal-us.com` |
| **NA - Non-US** | `https://open-na-global.alipay.com` |
| **Asia** | `https://open-sea-global.alipay.com` |
| **Europe** | `https://open-de-global.alipay.com` |

---

## Supported Products/APIs

### 1. Payment APIs

| API | Description | URL |
|-----|-------------|-----|
| **consult** | Initiate payment consultation request, obtain payment methods and configuration information | `/v1/payments/consult` |
| **pay** | One-time payment, obtain cashier page URL, redirect to payment | `/v1/payments/pay` |
| **createPaymentSession** | Create payment session for client SDK integration, reduce intermediate page redirects | `/v1/payments/createPaymentSession` |
| **capture** | Capture after card payment authorization, supports full or partial capture | `/v1/payments/capture` |
| **inquiryPayment** | Query payment transaction status and information | `/v1/payments/inquiryPayment` |
| **cancel** | Cancel payment transaction when payment result is not returned | `/v1/payments/cancel` |
| **notifyPayment** | Payment final state (success/failure) callback notification | Callback |
| **notifyCapture** | Capture final state (success/failure) callback notification | Callback |

### 2. Refund APIs

| API | Description | URL |
|-----|-------------|-----|
| **refund** | Initiate refund, supports full or partial refund | `/v1/payments/refund` |
| **inquiryRefund** | Query refund request status | `/v1/payments/inquiryRefund` |
| **notifyRefund** | Refund final state (success/failure) callback notification | Callback |

### 3. Vaulting APIs (Payment Method Binding)

| API | Description | URL |
|-----|-------------|-----|
| **createVaultingSession** | Create Vaulting session for client SDK card binding integration | `/v1/vaults/createVaultingSession` |
| **vaultPaymentMethod** | Bind payment method, return card token for subsequent transactions | `/v1/vaults/vaultPaymentMethod` |
| **inquireVaulting** | Query payment method binding status | `/v1/vaults/inquireVaulting` |
| **notifyVaulting** | Binding final state (success/failure) callback notification | Callback |

### 4. Subscription APIs

| API | Description | URL |
|-----|-------------|-----|
| **createSubscription** | Create subscription, initiate recurring billing subscription request | `/v1/subscriptions/create` |
| **changeSubscription** | Change subscription, modify subscription amount, cycle and other information | `/v1/subscriptions/change` |
| **cancelSubscription** | Cancel subscription, supports CANCEL (cancel after cycle ends) or TERMINATE (terminate immediately) | `/v1/subscriptions/cancel` |
| **updateSubscription** | Update subscription information | `/v1/subscriptions/update` |
| **inquireSubscription** | Query single subscription details | `/v1/subscriptions/inquireSubscription` |
| **inquireSubscriptionList** | Query subscription list, supports filtering by status, payment method, currency, etc. | `/v1/subscriptions/inquireSubscriptionList` |
| **inquireSubscriptionPayment** | Query payment transaction records under subscription | `/v1/subscriptions/inquireSubscriptionPayment` |
| **notifySubscription** | Subscription status change callback notification (creation/change success or failure) | Callback |
| **notifySubscriptionPayment** | Subscription deduction result callback notification | Callback |
| **notifySubscriptionCancel** | Subscription cancellation result callback notification | Callback |

---

## SDK Installation Methods

### Java (Maven)

```xml
<dependency>
    <groupId>com.alipay.global.sdk</groupId>
    <artifactId>global-open-sdk-java</artifactId>
    <version>2.1.17</version>
</dependency>
```

### Python (pip)

```bash
pip install global-open-sdk-python==1.4.31
```

### PHP (Composer)

```json
{
    "require": {
        "antom/global-open-sdk-php": "^1.4.30"
    }
}
```

### Go

```bash
go get github.com/alipay/global-open-sdk-go
```

```go
import "github.com/alipay/global-open-sdk-go/com/alipay/api"
```

### .NET (NuGet)

```xml
<PackageReference Include="global-open-sdk-dotnet" Version="2.1.20" />
```

---