Alipay, China's leading third-party online payment solutionAlipay, China's leading third-party online payment solution

alipay.intl.acquiring.cashier.wap.pay

The merchant uses this interface to make an in-app payment.

Request

Request parameters

Header

No

Name

Description

Type

Length

Required

Remarks

Sample

1

version

API version

string

8

ME

As per the respective API reference.

2.0.0

2

function

API interface

string

128

ME

According to specifications defined by each business domain.

alipay.intl.function

3

clientId

Client ID

string

32

ME

Provided by Alipay, used to identify partner and application system.

211020000000000000044

4

reqTime

Request time

datetime

/

M

DateTime with timezone, which follows the ISO-8601 standard.
Refer to: RFC 3339 Section 5.6

2001-07-04T12:08:56+05:30

5

reqMsgId

Request message ID

string

64

ME

Each request will be assigned with a unique ID (uuid).
The reqMsgId identifies a unique system request, it is not used to identify a unique business request.

1234567asdfasdf1123fda

6

reserve

Reserved for future implementation

string

256

O

Key/Value

{}

Body

No

Name

Description

Type

Length

Required

Remarks

Sample

1

merchantId

Merchant ID, which identifies the settlement target that Alipay would settle to.

string 

64

M

218820000000000000023

2

productCode

The product code

enums<productcode

>

64

M

AUTO_DEBIT

3

merchantTransId 

Unique merchant transaction ID

string

64

ME

51051001000000000002

4

order

The order information

Order

/

M

The orderAmount should be provided in the smallest common currency unit. For example, to create a charge for $1.00, you would set orderAmount.value as 100 (100 cents).

{
   "orderAmount":{
       "currency":"THB",
       "value":"239"
   },
   "orderTitle":"Women Summer Dress",
   "orderDetail":"New White Lace Sleeveless Cute Casual Summer Dresses Vestidos roupas femininas WQW10",
   "seller":{
       "sellerId":"2188205006167080",
       "mcc":"5691",
       "sellerName":"Zara"
   }
}

5

settleContractId

The settlement contract ID.
The merchant might want to be settled in different ways for different situations, each of which could be defined by a settlement contract. For example, a merchant could have a settlement contract for USD settlement while has another settlement contract for CAD settlement. 
If not provided, the default settlement contract will be used.

string

64

O

USD-1

6

riskInfo

Risk information. Highly recommend providing.

RiskInfo

/

O

{
   "deviceInfo":{
       "sessionId":"26daf780047938bf8d5b7ea8906003e9",
       "serialNo":"f0c0ec9a",
       "clientIp":"121.0.29.220",
       "latitudeLongitude":"39.9151190000,116.4039630000",
       "idfa":"5D08BADB6-B7D1-46DE-BDAB-B66468A1EFCC",
       "terminalType":"APP",
       "deviceName":"Mike's iPhone",
       "deviceBrand":"APPLE",
       "deviceModel":"iPhone 7 Plus",
       "imei":"863360020885012",
       "osName":"ios",
       "osVersion":"9.1.1",
       "wirelessNetwork":"china unicom",
       "wirelessCarrier":"china unicom",
       "flightMode":"enabled",
       "fingerPrintEnabled":"enabled",
       "deviceBootTime":"2001-07-04T12:08:56+05:30",
       "lastUnlockTime":"2001-07-04T12:08:56+05:30",
       "screenResolution":"1024*768",
       "isJailbreaked":"true",
       "macAddress":"8c:be:be:71:1f:34",
       "systemLanguage":"EN",
       "timeZone":"UTC+11"
   },
   "userInfo":{
       "signupTime":"2001-07-04T12:08:56+05:30",
       "lastLoginTime":"2001-07-04T12:08:56+05:30",
       "merchantUserId":"user0001"
   },
   "orderInfos":[
       {
           "productName":"iPhone 7",
           "productCategory":"Phone",
           "productSubCategory":"smart phone",
           "itemPrice":{
               "currency":"USD",
               "value":"239"
           }
       }
   ],
   "riskExtendInfo":"{}"
}

7

extendInfo

Reserved for extended information

string

2048

O

Key/Value
Note the type of extendInfo is a string. See the example in the request sample.

{"productScene":"Prepay/Paybill"}

8

notifyUrl

The notification address when the payment completed.

string

512

O

https://www.merchant.com/payNotify.html

9

returnUrl

Redirect URL after the payment finished.

string

512

O

https://www.merchant.com/payresult.html

Request sample

copy
{
    "request":{
        "head":{
            "version":"2.0.0",
            "function":"alipay.intl.acquiring.cashier.wap.pay",
            "clientId":"211020000000000000044",
            "reqTime":"2001-07-04T12:08:56+05:30",
            "reqMsgId":"1234567asdfasdf1123fda",
            "reserve":"{}"
        },
        "body":{
            "merchantId":"218820000000000000023",
            "productCode":"AUTO_DEBIT",
            "merchantTransId":"51051001000000000002",
            "order":{
                "orderAmount":{
                    "currency":"USD",
                    "value":"239"
                },
                "orderTitle":"Women Summer Dress",
                "orderDetail":"New White Lace Sleeveless Cute Casual Summer Dresses Vestidos roupas femininas WQW10"
            },
            "settleContractId":"USD-1",
            "riskInfo":{
                "deviceInfo":{
                    "sessionId":"26daf780047938bf8d5b7ea8906003e9",
                    "serialNo":"f0c0ec9a",
                    "clientIp":"121.0.29.220",
                    "latitudeLongitude":"39.9151190000,116.4039630000",
                    "idfa":"5D08BADB6-B7D1-46DE-BDAB-B66468A1EFCC",
                    "terminalType":"APP",
                    "deviceName":"Mike's iPhone",
                    "deviceBrand":"APPLE",
                    "deviceModel":"iPhone 7 Plus",
                    "imei":"863360020885012",
                    "osName":"ios",
                    "osVersion":"9.1.1",
                    "wirelessNetwork":"china unicom",
                    "wirelessCarrier":"china unicom",
                    "flightMode":"enabled",
                    "fingerPrintEnabled":"enabled",
                    "deviceBootTime":"2001-07-04T12:08:56+05:30",
                    "lastUnlockTime":"2001-07-04T12:08:56+05:30",
                    "screenResolution":"1024*768",
                    "isJailbreaked":true,
                    "macAddress":"8c:be:be:71:1f:34",
                    "systemLanguage":"EN",
                    "timeZone":"UTC+11"
                },
                "userInfo":{
                    "signupTime":"2001-07-04T12:08:56+05:30",
                    "lastLoginTime":"2001-07-04T12:08:56+05:30",
                    "merchantUserId":"user0001"
                },
                "orderInfos":[
                    {
                        "productName":"iPhone 7",
                        "productCategory":"Phone",
                        "productSubCategory":"smart phone",
                        "itemPrice":{
                            "currency":"USD",
                            "value":"239"
                        }
                    }
                ],
                "riskExtendInfo":"{}"
            },
            "extendInfo":"{\"productScene\":\"Prepay/Paybill\"}",
            "notifyUrl":"https://www.merchant.com/payNotify.html",
            "returnUrl":"https://www.merchant.com/payresult.html"
        }
    },
    "signature":"signature string"
}

Response

Response parameters

Header

No

Name

Description

Type

Length

Required

Remarks

Sample

1

version

API version

string

8

ME

As per the respective API reference.

2.0.0

2

function

API interface

string

128

ME

According to specifications defined by each business domain.

alipay.intl.function

3

clientId

Client ID

string

32

ME

Provided by Alipay, used to identify partner and application system.

211020000000000000044

4

respTime

Response time

datetime

/

M

DateTime with timezone, which follows the ISO-8601 standard. 
Refer to: RFC 3339 Section 5.6

2001-07-04T12:08:56+05:30

5

reqMsgId

Request message ID

string

64

ME

Each request will be assigned with a unique ID (uuid).

1234567asdfasdf1123fda

6

reserve

Reserved for future implementation

string

256

O

Key/Value

{}

Body

No

Name

Description

Type

Length

Required

Sample

1

resultInfo

Result info

ResultInfo

/

M

{
"resultStatus": "S",
"resultCodeId": "00000000",
"resultCode":"SUCCESS",
"resultMsg": "result message"
}

Response sample

copy
{
    "response":{
        "head":{
            "version":"2.0.0",
            "function":"alipay.intl.acquiring.cashier.wap.pay",
            "clientId":"211020000000000000044",
            "respTime":"2001-07-04T12:08:56+05:30",
            "reqMsgId":"1234567asdfasdf1123fda",
            "reserve":"{}"
        },
        "body":{
            "resultInfo":{
                "resultStatus":"S",
                "resultCodeId":"00000000",
                "resultCode":"SUCCESS",
                "resultMsg":"success"
            }
        }
    },
    "signature":"signature string"
}