Overview

Alipay online payments and in-store payments products offer a set of Application Programming Interfaces (APIs) that provides the ability to integrate with Alipay. You can use POST method to send HTTPS requests and receive responses accordingly.

The following section introduces the message structure and the end-to-end message transmission workflow.

Versioning

The current API version is v1. The version is specified in the URL. For example, https://{domain name}/ams/api/v1/payments/pay.

Environment

The domain name for each environment are listed in the following table.

Location

Domain name

North America

https://open-na.alipay.com

Asia

https://open-sea.alipay.com

Europe

https://open-eu.alipay.com (Only for in-store payments)

Table 1. Domain name

Message structure

Before you make any payments, it is important to understand how Alipay APIs works and how requests and responses are structured. This section presents general information (such as message structure and message transmission workflow) of online messages between your system and Alipay. A message refers to the request message or the response message. 

Request structure

The following figure illustrates the request message structure:

request.png

Figure 1. Request structure 

URL

The request URL is https://{domain name}/ams/api/{version}/{endpoint}, which has the following structure:

  • domain name: is the standard domain name assigned by the wallet backend.
  • version: is the API version, for example, v1 or v2.
  • endpoint: is the endpoint to the interface, for example, /{version}/payments/pay.

An interface can be uniquely identified its endpoint. For example, the /v1/payments/pay is different from /v2/payments/pay.

HTTPS method

POST

Request header

The request header mainly contains the following fields.
Note: Field names are case-insensitive.

Header field

Required

Code sample 

Signature

Yes

Signature: algorithm=RSA256, keyVersion=1, signature=****

Content-Type

No

Content-Type: application/json; charset=UTF-8

Client-Id

Yes

Client-Id: ****

Request-Time

Yes

Request-Time: 2019-04-04T12:08:56.253+05:30

Table 2. Request header 

For details of each header field, see the following descriptions.

Signature Required

Signature contains key-value pairs that are separated by comma (,). Each key-value pair is an equation, which is a key joined with its value with an equal sign (=). For details about how to generate a signature, see the Generate a signature section. 

The following keys can be configured: 

  • algorithm: Specifies the digital signature algorithm that is used to generate the signature. The value is not case-sensitive. RSA256 and ECC224 are supported, and RSA256 by default. 
  • keyVersion: Specifies the key version that is used to generate or validate the signature. By default, the value is the latest version of the key associated with Client-Id
  • signature: Contains the signature value of the request. 

Example:

copy
Signature: algorithm=RSA256, keyVersion=1,
signature=KEhXthj4bJ801Hqw8kaLvEKc0Rii8KsNUazw7kZgjxyGSPuOZ48058UVJUkkR21iD9JkHBGR
rWiHPae8ZRPuBagh2H3qu7fxY5GxVDWayJUhUYkr9m%2FOW4UQVmXaQ9yn%2Fw2dCtzwAW0htPHYrKMyrT
pMk%2BfDDmRflA%2FAMJhQ71yeyhufIA2PCJV8%2FCMOa46303A0WHhH0YPJ9%2FI0UeLVMWlJ1XcBo3Jr
bRFvcowQwt0lP1XkoPmSLGpBevDE8%2FQ9WnxjPNDfrHnKgV2fp0hpMKVXNM%2BrLHNyMv3MkHg9iTMOD%
2FFYDAwSd%2B6%2FEOFo9UbdlKcmodJwjKlQoxZZIzmF8w%3D%3D

Content-Type Optional

Optional. Content-Type indicates the media type of the body of the request, as defined by RFC2616. In which, charset is used for generating/validating a signature. 

For example:

copy
Content-Type: application/json; charset=UTF-8

Client-Id Required

Client-Id is used to identify a client, and is associated with the keys that are used for signature. For details about how to obtain a client ID, see Alipay Developers Center user guide

Request-Time Required

Specifies the time when the request is sent, as defined by ISO 8601.

Note: This field must be accurate to milliseconds.

copy
Request-Time: 2019-04-04T12:08:56.253+05:30

Request body

The request body contains the detailed request information in JSON format. Fields enclosed in the request body section vary depending on services. For more information, see instructions on the specific API specification.

Response structure

The following figures illustrate the response structure:

response.png

Figure 2. Response structure 

Response header

The response header carries the information about the response, mainly containing the following fields.

Note: Field names are case-insensitive.

Header field

Required

Code sample   

Signature

Yes

Signature: algorithm=RSA256, keyVersion=1, signature=****

Content-Type

No

Content-Type: application/json; charset=UTF-8

Client-Id

Yes

Client-Id: ****

Response-Time

Yes

Response-Time: 2019-04-04T12:08:56.253+05:30

Table 3. Response header

For details of each header field, see the following descriptions.

Signature Required

Signature contains key-value pairs that are separated by comma (,). Each key-value pair is an equation, which is a key joined with its value with an equal sign (=). For details about how to generate a signature, see the Generate a signature section. 

The following keys can be configured: 

  • algorithm: Specifies the digital signature algorithm that is used to generate the signature. The value is not case-sensitive. RSA256 and ECC224 are supported, and RSA256 by default. 
  • keyVersion: Specifies the key version that is used to generate or validate the signature. By default, the value is the latest version of the key associated with Client-Id
  • signature: Contains the signature value of the request. 

Example:

copy
Signature: algorithm=RSA256, keyVersion=1,
signature=KEhXthj4bJ801Hqw8kaLvEKc0Rii8KsNUazw7kZgjxyGSPuOZ48058UVJUkkR21iD9JkHBGR
rWiHPae8ZRPuBagh2H3qu7fxY5GxVDWayJUhUYkr9m%2FOW4UQVmXaQ9yn%2Fw2dCtzwAW0htPHYrKMyrT
pMk%2BfDDmRflA%2FAMJhQ71yeyhufIA2PCJV8%2FCMOa46303A0WHhH0YPJ9%2FI0UeLVMWlJ1XcBo3Jr
bRFvcowQwt0lP1XkoPmSLGpBevDE8%2FQ9WnxjPNDfrHnKgV2fp0hpMKVXNM%2BrLHNyMv3MkHg9iTMOD%
2FFYDAwSd%2B6%2FEOFo9UbdlKcmodJwjKlQoxZZIzmF8w%3D%3D

Content-Type Optional

Optional. Content-Type indicates the media type of the body of the request, as defined by RFC2616. In which, charset is used for generating/validating a signature. 

For example:

copy
Content-Type: application/json; charset=UTF-8

Client-Id Required

Client-Id is used to identify a client, and is associated with the keys that are used for signature. For details about how to obtain a client ID, see Alipay Developers Center user guide

Response-Time Required

Specifies the time when the response is sent, as defined by ISO 8601.

Note: This field must be accurate to milliseconds.

copy
Response-Time: 2019-04-04T14:08:56.253+05:30

Response body

The response body contains the information responding to the client. Fields in this section vary depending on services. However, the result field, which indicates the result of an API call, is always contained.

When the result status (resultStatus) is failed, the result code (resultCode) is an error code and the result message (resultMessage) means an error message, which is used for troubleshooting. For more information about how to resolve errors, see Error codes.

Field

Data type

Required

Description

resultStatus

String

No

Result status. Valid values are:

  • S : Successful
  • F : Failed
  • U : Unknown

resultCode

String (64)

No

Result code

resultMessage

String (256)

No

Result message that describes the result code and status in details

Table 4. Response body

Message transmission workflow

The whole interacting sequence is illustrated below:

Message transmission workflow.png

Figure 3. Message transmission workflow 

Overall procedure

Follow the overall procedure to call an API.

Preparations

To prevent some potential errors that you might get in the response, consider the following factors:

  • To prevent potential errors that you might get in the response, understand API idempontency.
  • Encode a request to process special characters enclosed in a request

1. Construct a request

Construct a request by complying with the request structure, for example, by adding the Client-Id, Request-Time, Signature, and other fields to the request header.

To ensure the message transmission security, perform the following security measures when constructing a request:

  • Must sign the request message. Message signing and signature validation are required for all requests and responses. For more information, see sign a request and validate the signature.
  • Encode the request to prevent errors or ambiguity that might be caused by special characters enclosed in a request. For details, see the Message encoding chapter.

2. Send a request

You can send a request with your preferred platform or tool, for example, via Postman or cURL command. 

3. Check the response

The response is returned usually in JSON or XML format. For details about the response, see the Response structure section. After you receive the response, validate the signature of the response.

4. Check the status code

The response data vary depending on the services. However, the result field, which indicates the result of an API call, is always contained. If an error occurs, an error response is returned, where the result object indicates the error code and error message for you to troubleshoot issues. For more information, see the Error codes chapter.