Alipay

Alipay is an e-wallet widely used by Chinese consumers. The consumer must have a Chinese bank account, which most often also requires having Chinese residential status. There are no restrictions on the use cases applicable to these accounts, and they are the sole target of PPRO's offering. Learn more about Alipay.

Payment method properties

Markets (consumer)

CN

Processing currencies

AUD CAD CHF CNY EUR GBP HKD JPY NZD SGD USD

Consumer currencies

CNY

Authentication methods

REDIRECT

Authentication timeout

12 hours

Minimum payment amount

0.01 CNY

Maximum payment amount

50,000.00 CNY from a linked bank card (can vary by bank)

300,000.00 CNY from the wallet balance

300,000.00 CNY total daily limit

Payment instrument

PASSTHROUGH_WALLET

Recurring payments

No

Separate captures

No

Refund

Full - Partial - Multiple

Refund validity

360 days

Disputes

No

Settlement risk

No

Make an Alipay payment

Alipay payments follow our standardized REDIRECT payment flow. We recommend including all relevant settings for any authentication methods you support.

To create an Alipay payment, you'll need to provide the following data at minimum when calling our payment charges endpoint:

Field

Description

paymentMethod

ALIPAY

amount.value

The amount to be paid in the smallest units of the currency used.

amount.currency

CNY

consumer.country

The country of residence of the consumer.

authenticationSettings: REDIRECT settings.returnUrl

Specify the URL to which the consumer should be redirected after completing the payment. This is required for the REDIRECT payment flow.

Request

POST /v1/payment-charges

{
  "paymentMethod": "ALIPAY",
  "amount": {
    "value": 1000,
    "currency": "CNY"
  },
  "consumer": {
    "country": "CN"
  },
  "authenticationSettings": [
    {
      "type": "REDIRECT",
      "settings": {
        "returnUrl": "https://www.webshop.com/order-results-page"
      }
    }
  ]
}

Response

You'll receive our standard payment charge response with the available authentication methods:

{
  "id": "charge_Y3JVzvEaJpvG53xd2R2Zt",
  "paymentMethod": "ALIPAY",
  "paymentMedium": "ECOMMERCE",
  "scheduleType": "UNSCHEDULED",
  "instrumentId": "instr_Asu0ig2PXXZSiNrhY44A5",
  "currency": "CNY",
  "country": "CN",
  "status": "AUTHENTICATION_PENDING",
  "consumer": {
    "country": "CN"
  },
  "authenticationMethods": [
    {
      "details": {
        "requestUrl": "https://redirection-target.ppro.com",
        "requestMethod": "GET"
      },
      "type": "REDIRECT"
    }
  ],
  "authorizations": [
    {
      "id": "authz_aPobet0FNZNU1bYqfexFd",
      "amount": 1000,
      "status": "AUTHENTICATION_PENDING",
      "createdAt": "2025-06-21T08:34:20.766Z",
      "updatedAt": "2025-06-21T08:34:20.766Z"
    }
  ],
  "captures": [],
  "refunds": [],
  "discards": [],
  "voids": [],
  "createdAt": "2025-06-21T08:34:20.114Z",
  "updatedAt": "2025-06-21T08:34:20.766Z",
  "_links": {
    "authorizations": {
      "href": "/v1/payment-charges/charge_Y3JVzvEaJpvG53xd2R2Zt/authorizations"
    },
    "captures": {
      "href": "/v1/payment-charges/charge_Y3JVzvEaJpvG53xd2R2Zt/captures"
    },
    "refunds": {
      "href": "/v1/payment-charges/charge_Y3JVzvEaJpvG53xd2R2Zt/refunds"
    },
    "discards": {
      "href": "/v1/payment-charges/charge_Y3JVzvEaJpvG53xd2R2Zt/discards"
    },
    "voids": {
      "href": "/v1/payment-charges/charge_Y3JVzvEaJpvG53xd2R2Zt/voids"
    }
  }
}

Pick the desired authentication method

REDIRECT

  1. Redirect your consumer to the returned $.authenticationMethods[?(@.type == "REDIRECT")].details.requestUrl.
    For example, with the value of https://redirection-target.ppro.com/ using the returned $.authenticationMethods[?(@.type == "REDIRECT")].details.requestMethod HTTP method.
  2. The consumer will be presented with the reference number and instructions to complete the payment.

Handling the payment result

REDIRECT

  1. After the consumer completes the payment, they are redirected to the returnUrl specified in the payment charge creation request.
  2. Upon redirect back to your site, retrieve the latest payment status by performing a GET /v1/payment-charges/{paymentChargeId}. Use the returned status field to determine and display the final payment outcome to the consumer.
  3. Additionally, webhooks are triggered to notify you of the payment result. This ensures you receive the outcome even if the consumer closes their browser or fails to return to your website.

Payment instrument

A PASSTHROUGH_WALLET instrument will be created for Alipay, with no additional data provided.

Request

GET /v1/payment-instruments/{instrument-id}

Response

{
    "id": "instr_Asu0ig2PXXZSiNrhY44A5",
    "type": "PASSTHROUGH_WALLET"
}

Sandbox testing

Alipay uses PPRO's mock authenticator in sandbox. Learn more.