# Alipay CN for Payment Setup API

To accept Alipay CN payments, you must:

1. Create a payment setup.
2. Confirm the payment.
3. Redirect the customer to Alipay CN.

---

## Create a payment setup

Call the [Create a payment setup](https://api-reference.checkout.com/tag/Payment-Setups/#operation/createAPaymentSetup) endpoint.

> **Information**
>
> Your base URL's `{prefix}` value is unique to your account and environment. To learn how to retrieve your base URLs for the sandbox and production environments, see [API endpoints](https://www.checkout.com/docs/developer-resources/api/api-endpoints.md).

**Production**

`POST` `https://{prefix}.api.checkout.com/payments/setups`

**Sandbox**

`POST` `https://{prefix}.api.sandbox.checkout.com/payments/setups`

### Request example

```json
{
  "amount": 1000,
  "currency": "CNY",
  "customer": {
    "name": "Jia Tsang",
    "email": {
      "address": "jia.tsang@example.com"
    }
  },
  "payment_methods": {
    "alipay_cn": {
      "terminal_type": "web"
    }
  },
  "settings": {
    "success_url": "https://example.com/payments/success",
    "failure_url": "https://example.com/payments/failure"
  },
  "reference": "ORD-5023-4E89"
}
```

In the request body, provide the following:

| Field | Description |
| --- | --- |
| `amount`<br>`number` | The payment amount, in the [minor currency unit](https://www.checkout.com/docs/payments/accept-payments/format-the-amount-value). <br><br>Minimum: 1 <br><br>**Required** |
| `currency`<br>`string` | Three-letter ISO 4217 [currency code](https://www.checkout.com/docs/developer-resources/codes/currency-codes.md). <br><br>Supported value: `CNY` <br><br>**Required** |
| `customer.email.address`<br>`string` | The customer's email address. <br><br>Format: email <br><br>**Required** |
| `customer.name`<br>`string` | The customer's name. <br><br>Max length: 255 <br><br>**Required** |
| `payment_methods.alipay_cn.terminal_type`<br>`string` | The terminal type for the Alipay CN payment. <br><br>Supported values:<br><br>- `app`<br><br>- `wap`<br><br>- `web` <br><br>**Required** |
| `settings.failure_url`<br>`string` | The URL to redirect the customer to if the payment fails. <br><br>Format: URI <br><br>Max length: 1024 <br><br>**Required** |
| `settings.success_url`<br>`string` | The URL to redirect the customer to if the payment is successful. <br><br>Format: URI <br><br>Max length: 1024 <br><br>**Required** |
| `description`<br>`string` | A description of the payment. <br><br>Max length: 100 |
| `order.items`<br>`array[object]` | The list of items in the order. <br><br>Max items: 1000 |
| `order.items[].discount_amount`<br>`number` | The discount amount for the item. <br><br>Minimum: 1 |
| `order.items[].image_url`<br>`string` | The URL of the item image. <br><br>Format: URI <br><br>Max length: 1024 |
| `order.items[].quantity`<br>`integer` | The quantity of the item. <br><br>Minimum: 1 |
| `order.items[].reference`<br>`string` | A reference for the item. <br><br>Max length: 255 |
| `order.items[].unit_price`<br>`number` | The unit price of the item. <br><br>Minimum: 1 |
| `order.items[].url`<br>`string` | The URL of the item page. <br><br>Format: URI <br><br>Max length: 1024 |
| `payment_methods.alipay_cn.os_type`<br>`string` | The operating system of the customer's device. <br><br>Required if `terminal_type` is `wap` or `app`. <br><br>Supported values:<br><br>- `android`<br><br>- `ios` |
| `reference`<br>`string` | A reference you can use to identify the payment. <br><br>Max length: 80 |

### Response example

```json
{
  "id": "set_rcmepwrchqab2wsergcafvijfy",
  "processing_channel_id": "pc_wzjki6hw5puepb5fnvqlizj2e4",
  "amount": 1000,
  "currency": "CNY",
  "payment_type": "Regular",
  "reference": "ORD-5023-4E89",
  "description": "Alipay CN payment",
  "payment_methods": {
    "alipay_cn": {
      "status": "ready",
      "flags": []
    }
  },
  "available_payment_methods": [
    "alipay_cn"
  ],
  "settings": {
    "success_url": "https://example.com/payments/success",
    "failure_url": "https://example.com/payments/failure"
  }
}
```

The response returns a `payment_methods` object, which contains the payment methods enabled on your account.

When all required fields are present, the `payment_methods.alipay_cn` object shows a `ready` [status](https://www.checkout.com/docs/payments/accept-payments/accept-a-payment-using-the-payment-setup-api.md#Payment_method_status).

---

## Confirm the payment

Checkout.com confirms the payment by calling the [Confirm a payment setup](https://api-reference.checkout.com/tag/Payment-Setups/#operation/confirmAPaymentSetup) endpoint and providing:

- The payment setup `id` as the `{id}` path parameter.
- `alipay_cn` as the `{payment_method_name}` path parameter.

### Request example

**Production**

`POST` `https://{prefix}.api.checkout.com/payments/setups/{id}/confirm/alipay_cn`

**Sandbox**

`POST` `https://{prefix}.api.sandbox.checkout.com/payments/setups/{id}/confirm/alipay_cn`

### Response example

```json
{
  "id": "pay_bsrduhejxiuerlh32hb5n6dvae",
  "status": "Pending",
  "reference": "ORD-5023-4E89",
  "customer": {
    "id": "cus_2g4ehcpm6phexgkzahlwxvbgne",
    "email": "jia.tsang@example.com",
    "name": "Jia Tsang"
  },
  "_links": {
    "self": {
      "href": "https://{prefix}.api.checkout.com/payments/pay_bsrduhejxiuerlh32hb5n6dvae"
    },
    "redirect": {
      "href": "https://psp.ac.alipay.com/page/simulation-wallet/acwallet/alipayconnectcode.html?code=281666040099gDeR9hatc6IPfQ0bstyv3kOD&pspName=ALIPAY_CN&loadMode=2"
    }
  }
}
```

---

## Redirect the customer

Redirect the customer to the `redirect.href` URL from the response. The customer completes the payment on the Alipay CN page and is then redirected back to your `settings.success_url` or `settings.failure_url`.