alipay.intl.oauth.auth.prepareForRedirect

No

Name

Description

Type

Required

Remarks

Sample

1

state

Merchant dynamic value for the state from api request to authenticate a redirection from the auth site.

string

Y

4657DDUER323DK

2

auth_site

The site which can authorize the user.

string

Y

Fixed value

ALIPAY_HK

3

merchantAgreementId

Merchant aggreement Id provide from api request.

string

Y

e8qdwl9casxor13

4

authCode

One time passcode return from Alipay

string

Y

Use for alipay.intl.oauth.auth.applyToken Api

28100413kpBklrvUk33YgGgC9yS2o679

5

client_id

Auth merchant ID.

string

Y

2160400000002012

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.oauth.auth.prepareForRedirect

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

Object with Key/Value

Cannot be null 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

64

Y

Fixed value

ALIPAY_HK

3

scopes

The scopes of the authorization.

list<string>

256

Y

Fixed value

["AUTH_AGREEMENTPAY"]

4

terminalType

Terminal type

enum

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.

string

512

Y

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

Y

4657DDUER323DK

7

agreementPayAuthInfo

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

AgreementPayAuthInfo

/

Y

{
"merchantAgreementId":"e8qdwl9casxor13"
}

8

extendInfo

Reserved for extended info

string

2048

Y

Object with Key/Value

Object must contain agreementMark object

{"agreementMark":"137352934538","billNo":"A1234"}

No

Name

Description

Type

Length

Required

Remarks

Sample

1

merchantAgreementId

The external agreement id from the merchant.

string

32

M

e8qdwl9casxor13

2

merchantUserId

The user id in merchant system.

string

64

O

userId001

3

validPeriod

The current agreement signing validation period, calculated from the sign request time.
This parameter is composed by integer number and time period unit. Time period unit supported:
d: days
m: months

string

8

O

15m

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

O

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

Y

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

Name

Description

Type

Length

Required

Remarks

Sample

1

resultStatus

Result status

string

2

Y

S

2

resultCodeId

Result code id

string

8

Y

00000000

3

resultCode

Result code

string

64

Y

SUCCESS

4

resultMsg

Result message

string

256

O

Success

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

4

00000007

INVALID_SIGNATURE

F

Signature is invalid