Appendices
Common
Public Class Configuration
Item | Type | Description | Required |
clientId | String | The unique ID that is assigned by Alipay+ to identify an MPP. | M |
envType | String | The type of environment where the SDK is installed. The value of this parameter affects the gateway address of the requests that are initiated from the SDK. Valid values are:
The default value is | O |
siteName | String | The unique name that is assigned by Alipay+ to identify an MPP. | O |
Public Class InquireQuoteParams
Item | Type | Description | Required |
sellCurrency | String | The currency that Alipay+ sells on behalf of the user. The value of this parameter is a 3-character ISO 4217 currency code. | M |
buyCurrency | String | The currency that Alipay+ buys on behalf of the user. The value of this parameter is a 3-character ISO 4217 currency code. | M |
Public Class InquireQuoteResult
Item | Type | Description | Required |
quoteId | String | The unique ID that is assigned by Alipay+ to identify a quote. | M |
quoteCurrencyPair | String | The currency pair that the exchange rate applies to. The value is 2 currencies (in ISO-4217) separated by a slash. For example, Sometimes, the first currency is the order currency and the second currency is the user's payment currency. Sometimes, the sequence is reversed. | M |
quotePrice | String | The quotation of the exchange rate between the currency pair that is specified on the quoteCurrencyPair parameter. Note: The value is not always greater than or equal to 1. | M |
Public Class CommonOAuthServiceParams
Item | Type | Description | Required |
authClientId | String | The unique ID that is assigned by Alipay+ to identify the authorized party (the auth client). | M |
scopes | List<String> | The authorization scopes, which means what resources or capabilities are authorized to the auth client. | M |
Public Class CommonOAuthServiceResult
Item | Type | Description | Required |
authCode | String | The authorization code that is generated by the MPP. | M |
authErrorScopes | Map<String, String> | The authorization scopes that are failed to be granted. The value of this parameter is in the key-value format. The key is the scope and the value is the error code. For example, | O |
authSuccessScopes | List<String> | The authorization scopes that are successfully granted. | O |
User-presented Mode Payment & Merchant-presented Mode Payment
Public Class MPPAcceptanceMarkLogo
Item | Type | Description | Required |
logoUrl | String | The URL of the logo. | M |
logoName | String | The name of the logo. | O |
Merchant-presented Mode Payment
Public Class DecodeServiceParams
Item | Type | Description | Required |
codeValue | String | The code value that is to be decoded so the MPP can obtain the order information. | M |
Public Class DecodeServiceResult
Item | Type | Description | Required |
sdkActionPayload | String | the data from response of userInitiatedPay request | M |
Public Class LaunchParams
Item | Type | Description | Required |
url | String | The code value in the form of the URL of the entry code. | M |
userAgent | String | The User-Agent (UA) information that is returned by the Alipay+ Server SDK. | O |
acDecodeConfig | String | Configurations for the entry code that are designated for specific purposes, for example, to ensure that the Alipay+ Client SDK consistently redirects the user to the merchant page via an HTTPS URL. See acDecodeConfig for details. The value of this parameter is a JSON string. For example, | O |
acDecodeConfig
Item | Type | Description | Required |
routerType | String | Specified on the acDecodeConfig.routerType parameter, which is returned by the Alipay+ Server SDK. This parameter indicates the router type. Valid value is:
| M |
forceHttps | Boolean | Specified on the acDecodeConfig.forceHttps parameter, which is returned by the Alipay+ Server SDK. This parameter indicates whether the Alipay+ Client SDK consistently redirects the user to the merchant page via an HTTPS URL. If the value of this parameter is specified as The default value of this parameter is | O |
userAgent | String | The User-Agent (UA) information that is returned by the Alipay+ Server SDK. | O |
Public Class LaunchResult
This class is reserved for future use. Currently, no result information needs to be returned to the integrator if the decoding is successful.
Public Class ActionParams
Item | Type | Description | Required |
sdkActionPayload | String | Specify the value of this parameter as the actionForm.sdkActionPayload parameter in the userInitiatedPay response. | M |
Auto Debit
Public Class SignContractOAuthServiceParams
Item | Type | Description | Required |
authUrl | String | The URL of the authorization page that is generated by the MPP server and used by the MPP app. | M |
Public Class SignContractOAuthServiceResult
Item | Type | Description | Required |
authCode | String | The authorization code that is generated by the MPP. | M |
authState | String | The authorization statement that is generated by the auth client. The value of this parameter must be appended to the redirection URL to prevent Cross-site request forgery (CSRF) attacks. | O |
authRedirectUrl | String | The first part of the redirection URL that the user is redirected to after the user confirms the authorization. | M |
Public Class SignContractParams
Item | Type | Description | Required |
authUrl | String | The URL of the authorization page that is generated by the MPP server and used by the MPP app. | M |
needCallback | Boolean | This parameter indicates whether the Alipay+ client SDK needs to send the obtained authorization code to the Alipay+ server. The value of this parameter can be obtained from the authUrl. | O |
Public Class SignContractResult
This class is reserved for future use. Currently, no result information needs to be returned to the integrator if the signing is successful.