tokenActivationNotificationAlipay+ → MPP

Alipay+ calls the tokenActivationNotification API to notify the Mobile Payment Provider (MPP) that the token has been successfully activated and is ready for use.

Structure

A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see:

Note:

Set the data type of each parameter (except array) as String. This means that you must use double quotation marks (" ") to enclose the parameter value. Examples:

If the data type of a parameter is Integer and its value is 20, set it as "20".
If the data type of a parameter is Boolean and its value is true , set it as "true".

For optional parameters that are not required in your case, you can take one of the following actions:

Exclude the parameters from the request body.
Set the parameter values as null (without the double quotation marks).

Do NOT leave the optional parameters empty by setting their values as ""; otherwise, an error might occur.

Request parameters

tokenReferenceId String REQUIRED

The unique ID assigned by Alipay+ to identify a token when it is created.

More information:

Maximum length: 64 characters

customerId String

The unique ID that is assigned by the MPP to identify a user.

More information:

Maximum length: 64 characters

walletId String

The unique ID used to identify the wallet provider requesting the token digitization.

More information:

Maximum length: 16 characters

tokenRequestorId String

The unique ID used to identify the token requestor requesting the token digitization.

More information:

Maximum length: 16 characters

secureElementId String

The unique ID used to identify the secure element to be provisioned with the token.

This parameter is only required when the token is provisioned to a secure element and when this parameter is provided by the wallet provider.

More information:

Maximum length: 128 characters

accountSource String

The source of this account information.

Valid values are:

ACCOUNT_ON_FILE: Pre-stored account.
ACCOUNT_ADDED_MANUALLY: Manually entered by the user.
ACCOUNT_ADDED_VIA_APPLICATION: Added via another app (e.g., banking app).
EXISTING_TOKEN_CREDENTIAL: Derived from an existing token.
ACCOUNT_ADDED_VIA_BROWSER: Added via a web browser.
ACCOUNT_ADDED_VIA_CHIP_DATA: Added via chip data, including contactless Mastercard chip data.

serviceRequestTime Datetime REQUIRED

The date and time when the digitization was requested.

More information:

The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".

tokenActivatedTime Datetime REQUIRED

The date and time the token was activated.

More information:

The value follows the ISO 8601 standard format. For example, "2019-11-27T12:01:01+08:00".

tokenData TokenData REQUIRED

The token data generated during the provisioning process.

Show child parameters

Response parameters

result Result REQUIRED

The result of the business processing, including the result code, result status, and result message. For more information about how to return the result in different payment scenarios, see How to return the result in the More information section of this topic.

Show child parameters

API Explorer

Request

Request Body

Response

Response Body

More information

How to return the result

According to the request processing result, the MPP needs to return the corresponding result (specified by the result parameter):

If the business processing succeeds, set the value of result.resultStatus to S and the value of result.resultCode to SUCCESS.
If the business processing fails, set the value of result.resultStatus to F and the value of result.resultCode accordingly.
If the business processing result is unknown, set the value of result.resultStatus to U and the value of result.resultCode accordingly.

For more information about how to define your result codes, see the Result codes section below.

Result/Error codes

Code	Value	Message
SUCCESS	S	Success
ACCESS_DENIED	F	Access is denied.
INVALID_CLIENT	F	The client is invalid.
INVALID_SIGNATURE	F	The signature is invalid.
KEY_NOT_FOUND	F	The key is not found.
MEDIA_TYPE_NOT_ACCEPTABLE	F	The server does not implement the media type that is acceptable to the client.
METHOD_NOT_SUPPORTED	F	The server does not implement the requested HTTP method.
NO_INTERFACE_DEF	F	API is not defined.
PARAM_ILLEGAL	F	Illegal parameters exist. For example, a non-numeric input, or an invalid date.
PROCESS_FAIL	F	A general business failure occurred. Don't retry.
REQUEST_TRAFFIC_EXCEED_LIMIT	U	The request traffic exceeds the limit.
UNKNOWN_EXCEPTION	U	An API calling is failed, which is caused by unknown reasons.