UseePay Open API
UseePay PortalMechant Dashboard
Product Docs
Product Docs
  • V2.0
  • V1.0
UseePay PortalMechant Dashboard
Product Docs
Product Docs
  • V2.0
  • V1.0
  1. alipay
  • Integration
    • Welcome to the UseePay Demo Page
    • Payment Product Overview
      • Hosted Checkout Integration Guide
      • Embedded Checkout Integration Guide
      • Express Checkout Integration Guide
      • Server to Server Integration Guide
    • About Payment Methods
      • Affirm
      • AfterPay_ClearPay
      • Bank Transfer
      • Blik
      • Boost
      • Card
      • Cashapp
      • Dana
      • GCash
      • iDEAL
      • Kakao Pay
      • Klarna
      • Konbini
      • Korean Card
      • Maya
      • Naver pay
      • Payco
      • Pay with Link
      • Pix
      • Pse
      • Samsung Pay
      • Servipag
      • SPEI
      • Tmoney
      • Toss Pay
      • Trustly
      • TrueMoney
      • Webpay
      • RSA-Encrypted Card Payments
      • ApplePay
        • Apple Pay
        • Apple Pay Web Integration (API Integration)
      • GooglePay
        • Google Pay
        • Google Pay Web Integration (API Integration)
      • common
        • _shared-client-os-type
      • alipay
        • Alipay CN
        • Alipay HK
        • Alipay+
    • Subscription
      • Get started with Subscription
    • Online payment
      • Get started with online payments
    • Payment Capabilities
      • Adaptive Price
      • Supported Payment Methods for Checkout
    • Checkout session
      • Checkout Session Guide
  • Developer
    • Introduction
    • Authentication
    • Integrate Local Payment Methods
    • Error code
      • last_payment_error documentation
      • Errors
    • Best Integration
      • Quickly create a paymentIntent for a subscription
      • Auto-Charge Subscription Guide
    • Payment Intents
      • Payment Intent Overview
      • Quickly create a paymentIntent
      • Create a PaymentIntent
      • Retrieve a PaymentIntent
      • Update a PaymentIntent
      • Confirm a PaymentIntent
      • Cancel a PaymentIntent
      • Capture a PaymentIntent
      • List all payment intents
    • Customers
      • Create a customer
      • Retrieves a customer
      • Update a customer
      • List all customers
    • Subscriptions
      • Create a subscription
      • Retrieves a subscription
      • Update a subscription
      • List all subscriptions
      • Cancel a subscription
    • Invoices
      • Create a invoice
      • Retrieves a invoice
      • List all invoices
      • Pay a invoice
    • Payment Methods
      • Retieve Payment Method Session
    • Mandates
      • Create a mandate
      • Retrieves a mandate
      • List all mandates
    • Refunds
      • Create a refund
      • Retrieves a refund
      • List all refunds
    • Webhooks
      • Webhook Integration Guide(version 2026-04)
      • Integration details
        • Supported Webhook Events
        • Webhook Activation/Signature Verification Steps
        • Webhook events for example
        • Dispute Webhook Integration Document
        • Difference between version 2026-04 and 2024-10-10
      • archive
        • 2024-10-10
          • Webhook Integration Guide(version 2024-10-10)
      • Create a webhook
      • Retrieves a webhook
      • Update a webhook
      • List all webhooks
    • Embedded Checkout
      • UseePay Elements Appearance
      • Payment Element
      • Payment Element (Deferred Intent)
      • Express Checkout Element
      • Checkout Session Element
    • Payment Method Configuration
      • Retieve Payment Method Configuration
    • Checkout Session
      • Create Checkout Session
      • Retrieve Checkout Session
    • Trackers
      • upload trackers
      • Retrieve a tracker
    • Capture
      • Capture Overview
      • List captures by intent id
    • Payement Attempt
      • ECI Indicator (3-D Secure) Reference
      • Retrieve PaymentAttempt
    • Schemas
      • CheckoutSessionCreateRequest
      • PaymentMethod
      • CreatePaymentIntentRequest
      • LineItem
      • Customer
      • Address
      • ProductData
      • Shipping
      • SubscriptionData
      • Error
      • DiscountPeriodConfig
      • DeviceData
      • CheckoutSessionResponse
      • ErrorResponse
      • Order
      • Product
      • PaymentMethodOptions
      • RiskControlOptions
      • Mandate
      • PaymentIntent
      • Billing
      • Card
      • AliPay
      • Wallet
      • Klarna
      • WechatPay
      • Refund
      • Subscription
      • Recurring
      • PriceData
      • SubscriptionItem
      • Invoice
      • NextAction
      • Webhook
      • CollectableOptions
      • PaymentLink
      • last_payment_error
      • discount_period_config
      • Capture
      • three_ds
      • PaymentAttempt
      • konbini
      • client_pm_options
      • pse
      • trial_period_config
      • Seller
  • Message
    • Messaging Element
  • About Testing
    • Test Cards
    • ApplePay&GooglePay
  • Reconciliation
    • SFTP Access for Reconciliation
  • FAQ
    • Unable to receive Webhook notifications
    • FAQ
    • Introduction
  1. alipay

Alipay CN

Type: Digital Wallet / Redirect Payment Method (Mainland China)
Payment Flow:
1.
Customer selects Alipay CN at checkout.
2.
Customer is redirected to the Alipay CN payment page to authorize the payment.
3.
After payment, the customer is returned to the merchant site and the merchant receives the payment result.
Refunds: Supports full, partial, and multiple refunds within 365 days.
Notes:
Available to customers in Mainland China.
Supported currencies are CNY, USD, and HKD.
The authentication timeout is 10 minutes.
The minimum and maximum payment amounts are not restricted.
Does not support recurring payments or separate captures.
Supported Transaction Types
Product Support
Supported Countries
One-time Payment

When to use Alipay CN#

Use Alipay CN when the customer intends to pay with the Alipay app and Alipay wallet for the Chinese mainland. The customer must have access to that wallet and be able to complete authorization in the Alipay app or its web payment page.
Alipay CN is a good choice when:
The checkout is intended for customers who use the Chinese mainland Alipay wallet.
The merchant wants to show Alipay as a dedicated wallet option instead of sending the customer to a wallet-selection page.
The customer recognizes and expects the Chinese mainland Alipay checkout experience.

Difference from AlipayHK and Alipay+#

Payment methodCustomer requirementCheckout experienceRecommended scenario
Alipay CNUses the Chinese mainland Alipay app/walletOpens a dedicated Alipay payment flowThe customer explicitly chooses Chinese mainland Alipay
AlipayHKHas installed and registered the AlipayHK appOpens a dedicated AlipayHK payment flowThe customer explicitly chooses AlipayHK
Alipay+Uses one of the wallets made available by Alipay+ for the transactionOpens the Alipay+ cashier and lets the customer select an available walletThe merchant wants one aggregated option for multiple regional wallets

Integration Guide#

Checkout example#

Alipay CN checkout example
Set billing.address.country to CN when creating the PaymentIntent.

Response example — client=web#

Use next_action.redirect.url to redirect the customer in the browser.
{
  "id": "1012609011050163683",
  "amount": 100.23,
  "currency": "USD",
  "status": "requires_customer_action",
  "next_action": {
    "type": "redirect",
    "redirect": {
      "method": "GET",
      "url": "https://checkout.alipayplus.example/alipay-cn/web?code=example_web_token",
      "content_type": null,
      "app_url": null,
      "package_name": "com.iap.linker_portal"
    }
  }
}

Response example — client=wap#

Use next_action.redirect.url for mobile web redirection. If the integration needs to launch the Alipay app directly, use next_action.redirect.app_url when populated.
{
  "id": "1012609011052163685",
  "amount": 100.23,
  "currency": "USD",
  "status": "requires_customer_action",
  "next_action": {
    "type": "redirect",
    "redirect": {
      "method": "GET",
      "url": "https://checkout.alipayplus.example/alipay-cn/wap?code=example_wap_token",
      "content_type": null,
      "app_url": "alipayconnect://platformapi/alipayconnectcode.html?code=example_app_token&pspName=ALIPAY_CN&loadMode=2",
      "package_name": "com.iap.linker_portal"
    }
  }
}
Other procedures will proceed as usual.
Use payment_method_options.alipay_cn to specify the client environment when initiating an Alipay CN payment.
For the full parameter reference, value descriptions, client scenario table, and request examples, see Client and OS Type Options.
Previous
_shared-client-os-type
Next
Alipay HK
Built with