Alipay
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.
Overview
Alipay payments follow a two-step process:
Request a payment
The POST request
Endpoints
POSThttps://api.checkout.com/payments
POSThttps://api.sandbox.checkout.com/payments
Header parameters
Header | Value |
---|---|
REQUIRED |
|
REQUIRED | application/json |
Body parameters
The table below describes the minimum recommended fields. You can find the full list, as well as complete request and response examples, in our API reference.
Field name | Description |
---|---|
STRING REQUIRED | Details about the payment source. |
STRING REQUIRED | The type of payment source. Set this to alipay . |
INTEGER OPTIONAL | The payment amount. |
STRING REQUIRED | The currency in which the payment is being made (three-letter ISO 4217 code). Currently, we only support USD. |
Request example
{
"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.
The POST response
If a payment id
is returned, then your request was successful.
Response example
{
"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.
The GET request
Use the details below to set up your request.
Endpoints
GEThttps://api.checkout.com/payments/{payment_id}
GEThttps://api.sandbox.checkout.com/payments/{payment_id}
Header and path parameters
Header | Value |
---|---|
REQUIRED |
|
REQUIRED | application/json |
Path | Value |
---|---|
REQUIRED | The payment ID found in the response of the initial response. |
The GET response
Response example
{
"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 Cuccess manager or Integrations engineer to activate Alipay payments in the sandbox environment.
- Create an Alipay transaction as above, following the redirect link in the response to Alipay's website.
- Click the button on the right and log in with the following details:
- Username:
alipaytest20091@gmail.com
- Password:
111111
- Username:
- Solve the captcha and then click the blue button at the bottom of the form to continue.
- Enter
111111
into the box and then click the blue button to complete the payment. You should then be redirected to your predefined success URL.
Can we help?
Thanks for using Checkout.com. If you need help or have a question, message our Support team at support@checkout.com.