---

Language：JAVA  
JDK version：1.6+  
---


##  SDK Version


```XML

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

```


## Antom Gateway URLs

| 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` |


## API

### Payment APIs

| API | Description | URL | Package Path |
|-----|------|-----|--------|
| consult | Used to initiate a payment consultation request to Antom to obtain payment methods and configuration information. | `/v1/payments/consult` | com.alipay.global.api.request.ams.pay.AlipayPayConsultRequest |
| pay (One-time Payment) | Used to obtain the cashier page URL. After obtaining it, users can be redirected to the cashier page for payment. | `/v1/payments/pay` | com.alipay.global.api.request.ams.pay.AlipayPayRequest |
| createPaymentSession | Used to create a payment session for client SDK integration. Antom returns encrypted session data to help complete the payment process and reduce intermediate page redirects. | `/v1/payments/createPaymentSession` | com.alipay.global.api.request.ams.pay.AlipayPaymentSessionRequest |
| capture | After merchants integrate card payment, they need to capture the authorized funds from the user's account and transfer the payment amount to the merchant's account. Supports full or partial capture. | `/v1/payments/capture` | com.alipay.global.api.request.ams.pay.AlipayCaptureRequest |
| notifyPayment | When a payment reaches a final state (success or failure), Antom sends the payment result to the merchant via HTTP request. | Callback (Antom to merchant endpoint) | com.alipay.global.api.request.ams.notify.AlipayPayResultNotify |
| notifyCapture | When a capture reaches a final state (success or failure), Antom sends the capture result to the merchant via HTTP request. | Callback (Antom to merchant endpoint) | com.alipay.global.api.request.ams.notify.AlipayCaptureResultNotify |
| inquiryPayment | Used to query the transaction status and other information of a previously submitted payment request. | `/v1/payments/inquiryPayment` | com.alipay.global.api.request.ams.pay.AlipayPayQueryRequest |
| cancel | Used to cancel a payment transaction when the payment result is not returned for a long time. | `/v1/payments/cancel` | com.alipay.global.api.request.ams.pay.AlipayPayCancelRequest |


### Refund APIs

| API | Description | URL | Package Path |
|-----|------|-----|--------|
| refund | Used to initiate a refund for a successful payment. Supports full or partial refund. | `/v1/payments/refund` | com.alipay.global.api.request.ams.pay.AlipayRefundRequest |
| notifyRefund | When a refund reaches a final state (success or failure), Antom sends the refund result to the merchant via HTTP request. | Callback (Antom to merchant endpoint) | com.alipay.global.api.request.ams.notify.AlipayRefundNotify |
| inquiryRefund | Used to query the refund status of a previously submitted refund request. | `/v1/payments/inquiryRefund` | com.alipay.global.api.request.ams.pay.AlipayInquiryRefundRequest |



### Vaulting APIs

| API | Description | URL | Package Path |
|-----|------|-----|--------|
| createVaultingSession | Used to create a vaulting session for client SDK integration. Returns encrypted session data to help complete card vaulting before payment initiation. | `/v1/vaults/createVaultingSession` | com.alipay.global.api.request.ams.pay.AlipayVaultingSessionRequest |
| vaultPaymentMethod | Used to vault a payment method before initiating payment. Returns a card token for future transactions, or returns a URL to guide the user to complete the vaulting process. | `/v1/vaults/vaultPaymentMethod` | com.alipay.global.api.request.ams.pay.AlipayVaultingPaymentMethodRequest |
| inquireVaulting | Used to query the vaulting status of a payment method. | `/v1/vaults/inquireVaulting` | com.alipay.global.api.request.ams.pay.AlipayVaultingQueryRequest |
| notifyVaulting | When vaulting reaches a final state (success or failure), Antom sends the vaulting result to the merchant via HTTP request. | Callback (Antom to merchant endpoint) | com.alipay.global.api.request.ams.notify.AlipayVaultingNotify |




## Other Reference Materials
github： https://github.com/alipay/global-open-sdk-java
maven：https://central.sonatype.com/artifact/com.alipay.global.sdk/global-open-sdk-java