---
Language：Python  
Python version：2.7+  
---

#  SDK Version

global-open-sdk-python==1.4.31


## 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 Reference

## Payment APIs

| API | Description | URL | Python Package Path |
|-----|------|-----|--------|
| consult | Used to initiate a payment consultation request to Antom to obtain payment methods and configuration information. | `/v1/payments/consult` | `from com.alipay.ams.api.request.pay.alipay_pay_consult_request import 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` | `from com.alipay.ams.api.request.pay.alipay_pay_request import 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` | `from com.alipay.ams.api.request.pay.alipay_payment_session_request import 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` | `from com.alipay.ams.api.request.pay.alipay_capture_request import 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) | `from com.alipay.ams.api.request.notify.alipay_pay_result_notify import 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) | `from com.alipay.ams.api.request.notify.alipay_capture_result_notify import AlipayCaptureResultNotify` |
| inquiryPayment | Used to query the transaction status and other information of a previously submitted payment request. | `/v1/payments/inquiryPayment` | `from com.alipay.ams.api.request.pay.alipay_pay_query_request import AlipayPayQueryRequest` |
| cancel | Used to cancel a payment transaction when the payment result is not returned for a long time. | `/v1/payments/cancel` | `from com.alipay.ams.api.request.pay.alipay_pay_cancel_request import AlipayPayCancelRequest` |


## Refund APIs

| API | Description | URL | Python Package Path |
|-----|------|-----|--------|
| refund | Used to initiate a refund for a successful payment. Supports full or partial refund. | `/v1/payments/refund` | `from com.alipay.ams.api.request.pay.alipay_refund_request import 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) | `from com.alipay.ams.api.request.notify.alipay_refund_notify import AlipayRefundNotify` |
| inquiryRefund | Used to query the refund status of a previously submitted refund request. | `/v1/payments/inquiryRefund` | `from com.alipay.ams.api.request.pay.alipay_inquiry_refund_request import AlipayInquiryRefundRequest` |



## Vaulting APIs

| API | Description | URL | Python 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` | `from com.alipay.ams.api.request.pay.alipay_vaulting_session_request import 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` | `from com.alipay.ams.api.request.pay.alipay_vaulting_payment_method_request import AlipayVaultingPaymentMethodRequest` |
| inquireVaulting | Used to query the vaulting status of a payment method. | `/v1/vaults/inquireVaulting` | `from com.alipay.ams.api.request.pay.alipay_vaulting_query_request import 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) | `from com.alipay.ams.api.request.notify.alipay_vaulting_notify import AlipayVaultingNotify` |


# Other Reference Materials
github: https://github.com/alipay/global-open-sdk-python
pipy: https://pypi.org/project/global-open-sdk-python/