Skip to content

    Alipay

    Overview - Alipay

    Alipay is the most important e-wallet in China and has a potential reach to over 520 million registerd users.

    A customer can place his cards or bank account behind the Alipay wallet as the prefered payment instruments. A payment can either be executed in the web via a login into the Alipay account or via the Alipay mobile app which is most commonly used by the Alipay users. With the mobile app the user can either scan a QR-code referencing the order or the app will be automatically opened in case the user shops with the mobile device.

    There are no chargebacks and there is a very high consumer trust due to the strong brand awareness. Therefore Alipay is a must-have payment method for any businesses that want to reach out to Chinese shoppers.

    Customer Experience - Alipay

    Alipay customer experience overview

    Optionally a user could also scan a QR-code with his mobile app (step 3) and authorize and execute the payment via the app.

    PayEngine Details - Alipay

    General

    NameDetails
    ProductAlipay
    ChannelsECOM
    CurrenciesAUD, CAD, EUR, GBP, HKD, SGD, USD
    CountriesCrossborder (outside of China)
    Technical FlowAsynchronous
    RecurringNo
    ChargebacksNo

    Supported Features and Services

    NameDetails
    Debit
    Yes
    PreauthorizationNo
    CancelationNo
    CancelationNo
    Refunds
    Yes
    NotificationsYes (webhook and email)
    Settlement ReportingYes (Unified Settlement Reporting)

    Integration Types

    NameDetails
    API
    Yes
    Widget
    Yes
    BridgeNo
    Shop PluginNo

    Integration via API - Alipay

    Technical Flow

    Alipay IntegrationviaAPI technicalflow

    Webhook notifications

    As it is not ensured at the time of the redirect to the shop that the payment was 100% successful the Payengine waits for the final asynchronous notification from the bank before a status is moved from PENDING into SUCCESS or FAILURE.

    A merchant should register for the Payengine webhook notifications in order to receive this final status update. A GET on the order or DEBIT transaction would also work, but it is not ensured that the final status will be available immediately after the redirect and a merchant might have to query the GET multiple times. Therefore it is strongly recommended that the asynchronous notifications from the Payengine are used insted.

    The notifications could be subscribed:

    The following events have to be subscribed for in order to receive the Alipay notifications, depending on the preferred source of notification.

    SourceEvent
    APInotificationState = UPDATED
    Merchant Centerevent type = order update success
    event type = order update failure

    Specifications - Alipay

    Alipay input parameters

    The following input parameters are required for initiating an Alipay payment via direct API integration.

    ParameterMandatory/Optional (M/O)DescriptionExample
    payment.accountHolderOName of the bank account holderJohn Doe
    async.successUrlMRedirect URL for successful paymenthttp://my.shop.com/success
    async.failureUrlMRedirect URL for unsuccessful paymenthttp://my.shop.com/fail
    async.cancelUrlМRedirect URL when payment is canceledhttp://my.shop.com/cancel
    meta.mobileViewOSet to “true” for the mobile enabled variant of Alipaytrue
    meta.preferredLanguageOpreferredLanguageen

    Samples

    Debit transaction

    POST /orders/debit

    Alipay Debit Request

    {
                    "product" : "alipay",
                    "terms": 1468590412476,
                    "privacy": 1468590412476,

    Alipay Debit Response

    {
                    "createdAt": 1554964122158,
                    "modifiedAt": 1554964122173,
                    "merchantId": "merchant_pwtmsdg1wt",

    Refund transaction

    POST /orders/{{orderId}}/transactions/{{transactionId}}/refund

    Alipay Refund Request

    {
                    "initialAmount": 10,
                    "currency": "EUR",
                    "description": "string",

    Alipay Refund Response

    {
                    "createdAt": 1554966733820,
                    "modifiedAt": 1554966733821,
                    "type": "REFUND",

    Settlements

    All settlement information will be provided in the Unified Settlement Report. The format and mappings can be found in the corresponding documentation (see Unified Settlement Report).

    Was this helpful?

    What was your feeling about it?