alipay.intl.oauth.auth.prepareForRedirect

No

Name

Description

Type

Length

Required

Remarks

Sample

1

version

API version

string

8

Y

As per the respective API reference

2.0.0

2

function

API interface

string

128

Y

According to specifications defined by each business domain

alipay.intl.function

3

clientId

Client ID

string

32

Y

Provided by AlipayHK, used to identify partner and application system

4Q5XPV2N361Y0600

4

reqTime

Request time

datetime

/

Y

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

Y

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

1234567asdfasdf1123fda

6

reserve

Reserved for future implementation

string

256

N

Key/Value

{}

No

Name

Description

Type

Length

Required

Remarks

Sample

1

authMerchantId

Auth merchant ID. The auth merchant can be authorized by the user  to access user resources.

string

64

Y

2160400000002012

2

authSite

The site which can authorize the user.

enum<SiteEnum>

64

Y

➹

ALIPAY_HK

3

scopes

The scopes of the authorization. The scope vaule please refer to OAuthScopeEnum

list<string>

256

Y

➹

["AUTH_AGREEMENTPAY"]

4

terminalType

Terminal type

enum<TerminalTypeEnum>

32

Y

Indicates the source terminal type and how the redirect will happen

WEB

5

merchantRedirectUrl

Merchant redirect url.  It can be passed in each call, or configure it once on AlipayHK side.

Note: This parameter is requiredwhen

merchantRedirectUrlisPassedInEachCall = true

string

512

N

https://www.alipay.com/

6

state

When provided, this parameter would be posted back in the redirection to the redirectUrl. This is a mechanism to prevent the CRSF attack. Merchant is suggested to generate a dynamic value for the state, so that it could be used to authenticate a redirection from the auth site.

string

256

N

4657DDUER323DK

7

agreementPayAuthInfo

Agreement pay authorization information. If scope is AUTH_AGREEMENTPAY, agreementPayAuthInfo is mandatary.

Note:

This parameter is required when scopes[?] = AUTH_AGREEMENTPAY

AgreementPayAuthInfo

/

N

{
    "merchantAgreementId":"e8qdwl9casxor13"
}

8

extendInfo

Reserved for extended info

string

2048

N

Key/Value

{"agreementMark":"137352934538"}

9

riskInfo

Risk information. Highly recommend to provide.

RiskInfo

/

N

{
    "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":"merchant xxx",
        "wirelessCarrier":"merchant xxx",
        "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":"{}"
}

No

Name

Description

Type

Length

Required

Remarks

Sample

1

version

API version

string

8

Y

As per the respective API reference

2.0.0

2

function

API interface

string

128

Y

According to specifications defined by each business domain

alipay.intl.function

3

clientId

Client ID

string

32

Y

Provided by AlipayHK, used to identify partner and application system

4Q5XPV2N361Y0600

4

respTime

Response time

datetime

/

Y

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

Y

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

1234567asdfasdf1123fda

6

reserve

Reserved for future implementation

string

256

N

Key/Value

{}

No

Name

Description

Type

Length

Required

Remarks

Sample

1

resultInfo

Result info

ResultInfo

/

Y

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

2

authSiteUrl

Auth site URL

Note:

This parameter is required when resultInfo. resultCode= SUCCESS

string

1024

N

http://render-dev.site.alipay.net/p/h5_dev/hk-gka-sign-S901285058/www/index.html/#/cod/sign?merchantRedirectUrl=https%3A%2F%2Fwww.alipay.com%2F&merchantId=2160400000002012&merchantProductCode=MC400401000000000024&productCode=UR400401000000000025&eventCode=40130004&sceneCode=SIGN_AGREEMENT&externalAgreementNo=e8qdwl9casxor13&agreementMark=137352934538&clientId=4Q5XPV2N361Y0600&scopes=AUTH_AGREEMENTPAY&authSite=ALIPAY_HK&state=4657DDUER323DK&bizId=cff506f055a95e5fd4980226b0edbc4c

No

ResultCodeId

ResultCode

ResultStatus

Remarks

1

00000013

NO_INTERFACE_DEF

F

API is not defined

2

00000901

UNKNOWN_EXCEPTION

U

Unknown exception

3

00000004

PARAM_ILLEGAL

F

Illegal parameters