Skip to content

Alipay

Last updated: 13th January 2022

Start accepting payments using Alipay, a favorite payment method in China.

Alipay provides a method to make purchases online through quick and easy bank transfers that are not only secure but guaranteed.

To start accepting Alipay payments, please contact your Customer Success Manager.

Model

Collecting

Payment flow

Redirect

Payment method type

Wallet

One-step payment

Authorization

Capture

Refund

Partial refund

Chargeback

Recurring payment


Overview

Alipay payments follow a two-step process:


Request a payment

Endpoints

For the full API specification, see the API reference.

    post

    https://api.checkout.com/payments

    Request example

    1
    2
    3
    4
    5
    6
    7
    {
    "source": {
    "type": "alipay"
    },
    "amount": 2000,
    "currency": "USD"
    }

    If a customer ID or email is not provided in the request, then we automatically create a customer profile and return the customer id in the response.

    Response example

    If a payment id is returned, then your request was successful.

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    {
    "id": "pay_wu2hdjkzookuji3i2xai2ienlm",
    "status": "Pending",
    "customer": {
    "id": "cus_j4o4tigv4vaebednks3gafrwk4"
    },
    "_links": {
    "self": {
    "href": "https://sandbox.checkout.com/api2/payments/pay_wu2hdjkzookuji3i2xai2ienlm"
    },
    "redirect": {
    "href": "https://sandbox.checkout.com/LP.Core/api/payment/108674"
    }
    }
    }

    Redirect the customer

    Redirect your customer to the redirect link’s href in the response. The redirect transfers the customer to their bank's website where they are required to enter their authorization details; if successful, the payment can be approved.

    Once completed, the customer is transferred to your predefined success or failure URL. Confirmation of an Alipay payment is communicated only through webhooks. When you receive a payment_captured webhook notification, the transaction has been completed successfully. Until the payment_captured webhook is received (response code 10000), all payments are labeled as Pending.


    Get details about a payment

    You can retrieve details about an existing Alipay payment.

    Use the details below to set up your request.

    Endpoints

    For the full API specification, see the API reference.

      get

      https://api.checkout.com/payments/{payment_id}

      Response example

      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      12
      13
      14
      15
      16
      17
      18
      19
      20
      21
      22
      {
      "id": "pay_wu2hdjkzookuji3i2xai2ienlm",
      "requested_on": "2018-11-22T15:02:13Z",
      "source": {
      "type": "alipay"
      },
      "amount": 1,
      "currency": "USD",
      "payment_type": "Regular",
      "status": "Pending",
      "risk": {
      "flagged": false
      },
      "customer": {
      "id": "cus_j4o4tigv4vaebednks3gafrwk4"
      },
      "_links": {
      "self": {
      "href": "https://api.sandbox.checkout.com/payments/pay_wu2hdjkzookuji3i2xai2ienlm"
      }
      }
      }

      Refund a payment

      Alipay supports both partial and full refunds. You can refund a payment through the Hub or using the refund API.


      Cancel a payment

      If the customer cancels or fails to complete the transaction at any point after the payment is created, it will automatically be voided, and we'll send you a payment_voided webhook.


      Testing Alipay

      To start testing, you'll need to:

      • create a test account, and
      • contact your Customer Success Manager or Integrations engineer to activate Alipay payments in the sandbox environment.
      1. Create an Alipay transaction as above, following the redirect link in the response to Alipay's website.
      2. Select the button on the right and log in with the following details:
      • Username: alipaytest20091@gmail.com
      • Password: 111111
      1. Solve the captcha and then select the blue button at the bottom of the form to continue.
      2. Enter 111111 into the box and then select the blue button to complete the payment. You should then be redirected to your predefined success URL.