IAP 3.0

isEnvReadyReq

json

Yes

Checks whether requests from IAP are supported. For details, please refer to isEnvReadyReq parameter description.

success

function

No

Callback upon success.

fail

function

No

Callback upon failure.

complete

function

No

Callback upon completion.

applicationID

string

Yes

Unique ID allocated to a quick app created by the vendor alliance. For details about how to obtain the ID, please refer to Obtaining the App ID.

returnCode

number

Result code. The value 0 indicates success.

data

string

Error description. Check the error type before obtaining the error code.

code

number

Error code.

isSandboxActivatedReq

json

Yes

Indicates whether the signed-in HUAWEI ID meets the sandbox testing requirements. For details, please refer to isSandboxActivatedReq parameters.

success

function

No

Callback upon success.

fail

function

No

Callback upon failure.

complete

function

No

Callback upon completion.

applicationID

string

Yes

Unique ID allocated to a quick app created by the vendor alliance. For details about how to obtain the ID, please refer to Obtaining the App ID.

returnCode

number

Result code.

errMsg

string

Result code description.

isSandboxUser

boolean

Indicates whether a sandbox account is used.

isSandboxApk

boolean

Indicates whether Quick App Center meets the sandbox testing requirements. The value true is always returned.

versionInApk

string

Version information of Quick App Center.

versionFrMarket

string

Information about the latest app version on Quick App Center.

data

string

Error description. Check the error type before obtaining the error code.

code

number

Error code.

ownedPurchasesReq

json

Yes

Queries information about all subscribed products that are not used. For details, please refer to ownedPurchasesReq parameters.

success

function

No

Callback upon success.

fail

function

No

Callback upon failure.

complete

function

No

Callback upon completion.

applicationID

string

Yes

Unique ID allocated to a quick app created by the vendor alliance. For details about how to obtain the ID, please refer to Obtaining the App ID.

priceType

number

Yes

Product type.

• 0: consumable
• 1: non-consumable
• 2: subscription

publicKey

string

Yes

Payment public key obtained when Payment Service is enabled. For details about how to obtain the key, please refer to Obtaining the Payment Public Key.

continuationToken

string

No

Data location flag for a query in pagination mode. This parameter does not need to be passed during the first query. If the data needs to be queried in batches, pass the value of continuationToken returned by success in the last query.

returnCode

number

Result code.

errMsg

string

Result code description.

itemList

array

ID list of purchased products returned as a string array.

inAppPurchaseDataList

array

Purchased in-app product information returned as a string array. Each string element in the array is in JSON format.

inAppSignature

array

Signature string that contains the purchase data (inAppPurchaseDataList) signed using the payment private key. The signature algorithm is SHA256withRSA. Each signature string maps a product in inAppPurchaseDataList. That is, the first signature string in inAppSignature maps the first product record in inAppPurchaseDataList; the second string maps the second product record, and so on. Signature verification is required for each JSON string in inAppPurchaseDataList. If the verification fails, the app needs to obtain the product information again. For details about signature verification, please refer to Verifying the Signature in the Result.

continuationToken

string

Data locating flag. If a user has a large number of products and the response contains continuationToken, the app must initiate another call on the current method and pass the currently received continuationToken. If product query is still incomplete, the app needs to call the method again until no continuationToken is returned, indicating that all products are returned.

placedInappPurchaseDataList

array

Subscription relationship information about a user who has performed subscription switchover. The value is a JSON string array. For details about the parameters contained in each JSON string, please refer to InAppPurchaseData. Subscription switchover refers to the switch from one product in one period to another product in the same subscription group in the next period. In this case, the relationship between the first product and the user is canceled, and another relationship between the second product and the user is established. In this case, the method returns the subscription relationship information about the second product. The value of this parameter is returned only when priceType is set to 2 and the user has performed a subscription switchover.

placedInappSignatureList

array

This parameter matches the signature string of the subscription relationship in placedInappPurchaseDataList. Signature verification is required for each JSON string in placedInappPurchaseDataList. If the verification fails, the app needs to obtain the subscription relationship again. For details about signature verification, please refer to Verifying the Signature in the Result. The value of this parameter is returned only when priceType is set to 2 and the user has performed a subscription switchover.

data

string

Error description. Check the error type before obtaining the error code.

code

number

Error code.

productInfoReq

json

Yes

Request for obtaining product details. For details, please refer to productInfoReq parameters.

success

function

No

Callback upon success.

fail

function

No

Callback upon failure.

complete

function

No

Callback upon completion.

applicationID

string

Yes

Unique ID allocated to a quick app created by the vendor alliance. For details about how to obtain the ID, please refer to Obtaining the App ID.

priceType

number

Yes

Product type.

• 0: consumable
• 1: non-consumable
• 2: subscription

productIds

array

Yes

Product ID.

returnCode

number

Result code.

errMsg

string

Result code description.

productInfoList

array

List of products that are queried successfully. The value is an array containing the productInfo object.

productId

string

Yes

Product ID.

priceType

number

Yes

Product type.

• 0: consumable
• 1: non-consumable
• 2: subscription

price

string

Yes

Displayed price of a product.

microsPrice

number

Yes

Product price in micro unit, which equals the actual product price multiplied by 1,000,000.

For example, if the actual price of a product is USD1.99, the product price in micro unit is 1,990,000 (1.99 x 1,000,000).

currency

string

Yes

Currency used to pay for a product. The value must comply with the ISO 4217 standard, for example, USD, CNY, and MYR.

productName

string

Yes

Product name, which is set during product information configuration and displayed on the checkout page.

productDesc

string

Yes

Product description, which is set during product information configuration.

subPeriod

string

No

Unit of a subscription period, which complies with the ISO 8601 standard. For example, P1W indicates 1 week, P1M indicates 1 month, P2M indicates 2 months, P6M indicates 6 months, and P1Y indicates 1 year.

subSpecialPrice

string

No

Promotional price of a subscription, including the currency unit and actual price of the product. The value is in the Currency unit Price format. The currency unit and price are separated using a space character, for example, CNY 0.15. The price does not include the tax.

subSpecialPriceMicros

number

No

Subscription price in micro unit.

subSpecialPeriod

string

No

Promotional period unit of a subscription, which complies with the ISO 8601 standard. For example, P1W indicates 1 week, P1M indicates 1 month, P2M indicates 2 months, P6M indicates 6 months, and P1Y indicates 1 year.

subSpecialPeriodCycles

string

No

Number of promotional periods of a subscription. It is set when you set the promotional price of a subscription in AppGallery Connect. For details, please refer to Setting Promotional Prices.

subsFreeTrialPeriod

string

No

Free trial period of a subscription. It is set when you set the promotional price of a subscription in AppGallery Connect. For details, please refer to Setting Promotional Prices.

subsGroupId

string

No

ID of the subscription group to which a subscription belongs.

subsGroupTitle

string

No

Description of the subscription group to which a subscription belongs.

subsProductLevel

string

No

Level of a subscription in its subscription group.

originalMicroPrice

string

No

Obtains the original price in micro unit of a product. The price equals the original product price multiplied by 1,000,000.

originalLocalPrice

string

No

Original price of a product, including the currency unit and actual price of the product. The value is in the Currency symbolPrice format, for example, ¥0.15. The price includes the tax.

status

int

No

Obtains the product status.

• 0: valid.
• 1: deleted. Products in this state cannot be renewed or subscribed to.
• 3: removed. New subscriptions are not allowed, but users who have subscribed to it can still renew the subscription.
  NOTE

  This parameter is not required for querying non-subscriptions.

data

string

Error description. Check the error type before obtaining the error code.

code

number

Error code.

purchaseIntentReq

json

Yes

Purchase request. For details, please refer to purchaseIntentReq parameters.

success

function

No

Callback upon success.

fail

function

No

Callback upon failure.

complete

function

No

Callback upon completion.

applicationID

string

Yes

Unique ID allocated to a quick app created by the vendor alliance. For details about how to obtain the ID, please refer to Obtaining the App ID.

publicKey

string

Yes

Payment public key obtained when Payment Service is enabled. For details about how to obtain the key, please refer to Obtaining the Payment Public Key.

productId

string

Yes

ID of a product to be paid. The product ID is the same as that you configure in the product information in AppGallery Connect.

priceType

string

Yes

Product type.

• 0: consumable
• 1: non-consumable
• 2: subscription

developerPayload

string

No

Information stored on the merchant side. If a value exists, the value will be returned in the callback result to the app after successful payment.

returnCode

number

Result code.

errMsg

string

Result code description.

inAppDataSignature

string

Signature string that contains the purchase data (inAppPurchaseData) signed using the app private key. The signature algorithm is SHA256withRSA. After the payment is successful, the app needs to verify the JSON string of inAppPurchaseData using the payment public key. For details, please refer to Verifying the Signature in the Result.

inAppPurchaseData

string

JSON string of purchase order details. For details, please refer to inAppPurchaseData parameters.

applicationId

string

Yes

App ID.

autoRenewing

boolean

Yes

• For consumables or non-consumables, the value is always false.
• For subscriptions, the value true indicates that the subscription is in active state and will be automatically renewed on the next renewal date.
• For subscriptions, the value false indicates that the user has canceled the subscription. The user can access the subscribed content only before the next renewal date, unless automatic renewal is enabled.

If a grace period is applicable, this value remains true for the subscription during the grace period. The next settlement date is automatically postponed every day until the grace period ends or the user changes the payment method.

orderId

string

No

Obtains the order ID from Huawei IAP server, which uniquely identifies a transaction and is generated by IAP server during payment.

kind

number

Yes

Product type.

• 0: consumable
• 1: non-consumable
• 2: subscription

packageName

string

No

Package name on Quick App Center.

productId

string

Yes

Product ID. Each product must have a unique ID, which is maintained in PMS.

productName

string

No

Product name.

purchaseTime

string

No

Timestamp of the purchase time, which is the number of milliseconds from 00:00:00 on January 1, 1970 to the purchase time.

purchaseState

string

Yes

Transaction status. The options are as follows:

• -1: initialized
• 0: purchased
• 1: canceled
• 2: refunded

developerPayload

string

No

Information stored on the merchant side, which is passed by the app when the payment API is called.

developerChallenge

string

No

Challenge defined when an app initiates a consumption request, which uniquely identifies the consumption request.

consumptionState

string

No

Consumption status.

• 0: not consumed
• 1: consumed

purchaseToken

string

No

Obtains the purchase token, which uniquely identifies the mapping between a product and a user. It is generated by Huawei IAP server when the payment is complete.

purchaseType

number

No

Purchase type. This parameter is not returned during normal purchases.

• 0: in the sandbox
• 1: in the promotional period (currently unsupported)

currency

string

No

Currency. The value must comply with the ISO 4217 standard.

price

number

No

Obtains the value that is equal to the actual price of a product multiplied by 100.

country

string

Yes

Country or region code, which is used to identify a country or region. The value must comply with the ISO 3166 standard.

payType

string

No

Payment method.

• 0: HUAWEI Points
• 3: credit card
• 4: Alipay
• 6: DCB
• 13: PayPal
• 16: debit card
• 17: WeChat Pay
• 19: gift card
• 20: balance
• 21: HUAWEI Point card
• 24: Worldpay
• 31: Huawei Pay
• 32: Ant Credit Pay
• 200: M-Pesa

The following parameters are returned only for query of subscriptions.

lastOrderId

string

Yes

ID of the last renewal order, which is generated by IAP server during fee deduction. The parameter value is the same as that of orderId when a subscription is purchased for the first time.

productGroup

string

No

ID of the subscription group to which a subscription belongs.

purchaseTime

number

No

Timestamp of the purchase time, which is the number of milliseconds from 00:00:00 on January 1, 1970 to the purchase time. If the purchase is not complete, this parameter is left empty.

oriPurchaseTime

number

No

Timestamp of the first fee deduction time, which is the number of milliseconds from 00:00:00 on January 1, 1970 to the first successful fee deduction time.

subscriptionId

string

Yes

Subscription ID.

oriSubscriptionId

string

No

Original subscription ID. If a value exists, the current subscription is switched from another one. The value can be associated with the information about the original subscription.

quantity

number

No

Purchase quantity.

daysLasted

number

No

Days of a paid subscription, excluding the free trial period and promotional period.

numOfPeriods

number

No

Number of successful standard renewal periods (that is, renewal periods without promotion). If the value is 0 or does not exist, no renewal has been performed successfully.

numOfDiscount

number

No

Number of periods for successful renewal after promotion.

expirationDate

number

No

Timestamp of the subscription expiration time. For an automatic renewal receipt where the fee has been deducted successfully, this parameter indicates the renewal or expiration time. If the value is a past time, the subscription has expired.

expirationIntent

number

No

Reason why a subscription expires. The options are as follows:

• 1: canceled by a user
• 2: product unavailable
• 3: abnormal user signing information
• 4: billing error
• 5: price increase disagreed with by a user
• 6: unknown error

If multiple exceptions occur at the same time, the exception with the highest priority is returned (the highest priority is 1 and the lowest is 6).

retryFlag

number

No

Indicates whether the system still tries to renew an expired subscription.

• 0: no
• 1: yes

introductoryFlag

number

No

Indicates whether a subscription is in the renewal period after promotion. The options are as follows:

• 0: no
• 1: yes

trialFlag

number

No

Indicates whether a subscription is in the free trial period. The options are as follows:

• 0: no
• 1: yes

cancelTime

number

No

Timestamp of the subscription cancellation time. A value is returned when a user: (1) makes a complaint and cancels a subscription through the customer service personnel; (2) performs subscription upgrade or crossgrade that immediately takes effect and cancels the previous receipt of the original subscription.

cancelReason

number

No

Cause of subscription cancellation. The options are as follows:

• 2: A user performs subscription upgrade or crossgrade.
• 1: A user encounters a problem within the app and cancels the subscription.
• 0: other causes. For example, a user mistakenly purchases a subscription and has to cancel it.
  NOTE

  If this parameter is left empty but the cancelTime parameter has a value, the cancellation is caused by an operation such as upgrade.

renewStatus

number

No

Renewal status. The options are as follows:

• 1: The subscription will automatically renew at the end of the current subscription period.
• 0: The user has canceled subscription renewal. For auto-renewable subscriptions, this parameter is valid for both valid and expired subscriptions. However, it does not represent users' subscription status.

Generally, when the value is 0, the app can provide other subscription options for the user, for example, recommending another subscription at a lower level in the same group. The value 0 indicates that a user proactively cancels the subscription.

priceConsentStatus

number

Optional

User opinion on the price increase of a product.

• 1: The user has agreed with the price increase.
• 0: The user does not respond to the price increase. After the subscription expires, it becomes invalid.

renewPrice

number

No

Price used upon the next renewal. It is provided as a reference for users when the priceConsentStatus parameter is returned.

subIsvalid

boolean

No

• true: A user has been charged for a product, the product has not expired, and no refund has been made. In this case, you can provide services for the user.
• false: The purchase of a product is not finished, the product has expired, or a refund has been made for the product after its purchase.
  NOTE

  If a user has canceled a subscription, the value of subIsvalid remains true until the subscription expires.

cancelledSubKeepDays

number

No

Number of days for retaining a subscription relationship after the subscription is canceled. (In these days, the user can resume the subscription anytime as needed.)

resumeTime

number

No

Time when a paused subscription is resumed.

data

string

Error description. Check the error type before obtaining the error code.

code

number

Error code.

consumeOwnedPurchaseReq

json

Yes

Request for consuming a product. For details, please refer to consumeOwnedPurchaseReq parameters.

success

function

No

Callback upon success.

fail

function

No

Callback upon failure.

complete

function

No

Callback upon completion.

applicationID

json

Yes

Unique ID allocated to a quick app created by the vendor alliance. For details about how to obtain the ID, please refer to Obtaining the App ID.

developerChallenge

string

No

Custom challenge, which uniquely identifies a consumption request. After the consumption is successful, the challenge is recorded in the purchase information and returned. The value length is within (0, 64).

purchaseToken

string

No

Purchase token, which is generated by Huawei IAP server during payment and returned to the app through InAppPurchaseData. The app passes this parameter for Huawei IAP server to update the order status and then deliver the product.

publicKey

string

Yes

Payment public key obtained when Payment Service is enabled. For details about how to obtain the key, please refer to Obtaining the Payment Public Key.

returnCode

Number

Result code.

errMsg

string

Result code description.

consumePurchaseData

string

JSON string that contains consumption result data.

dataSignature

string

Signature string for consumePurchaseData based on the payment private key.

applicationId

string

Yes

Unique ID allocated to a quick app created by the vendor alliance. For details about how to obtain the ID, please refer to Obtaining the App ID.

autoRenewing

boolean

Yes

Indicates whether a subscription is automatically renewed.

• true: yes
• false: no

orderId

string

Yes

Obtains the order ID from Huawei IAP server, which uniquely identifies a transaction and is generated by IAP server during payment.

packageName

string

Yes

Package name on Quick App Center.

productId

string

Yes

Product ID.

purchaseTime

number

Yes

Timestamp of the purchase time, which is the number of milliseconds from 00:00:00 on January 1, 1970 to the purchase time.

purchaseState

number

Yes

Order status. The options are as follows:

• -1: initialized and invisible
• 0: purchased
• 1: canceled
• 2: refunded

developerPayload

string

No

Information stored on the merchant side, which is passed by the app during payment.

purchaseToken

string

Yes

Obtains the purchase token, which uniquely identifies the mapping between a product and a user. It is generated by Huawei IAP server when the payment is complete.

developerChallenge

string

No

Challenge defined when an app initiates a consumption request, which uniquely identifies the consumption request.

consumptionState

number

Yes

Consumption status.

• 0: not consumed
• 1: consumed

currency

string

Yes

Currency. The value must comply with the ISO 4217 standard, for example, USD, CNY, and MYR.

price

number

Yes

100 times of the actual product price (accurate to two decimal places). For example, if the actual product price is 5.00, the value of this parameter is 500 (5.00 x 100).

country

string

Yes

Country or region code of a user service area. The value must comply with the ISO 3166 standard. For example, US is used for the United States of America, CN for the Chinese mainland, and MY for Malaysia.

responseCode

string

Yes

Result code. The value 0 indicates success.

responseMessage

string

No

Response.

data

string

Error description. Check the error type before obtaining the error code.

code

number

Error code.

ownedPurchasesRecordReq

json

Yes

Request for querying subscribed products. For details, please refer to ownedPurchasesRecordReq parameters.

success

function

No

Callback upon success.

fail

function

No

Callback upon failure.

complete

function

No

Callback upon completion.

applicationID

string

Yes

Unique ID allocated to a quick app created by the vendor alliance. For details about how to obtain the ID, please refer to Obtaining the App ID.

priceType

number

Yes

Product type.

• 0: consumable
• 1: non-consumable
• 2: auto-renewable subscription

publicKey

string

Yes

Payment public key obtained when Payment Service is enabled. For details about how to obtain the key, please refer to Obtaining the Payment Public Key.

continuationToken

string

No

Data location flag for a query in pagination mode. This parameter does not need to be passed during the first query. If the number of records queried for the first time exceeds 200, this parameter is returned after the query and needs be contained in the second query.

returnCode

number

Result code.

errMsg

string

Result code description.

itemList

array

ID list of purchased products returned as a string array.

inAppPurchaseDataList

array

Purchased in-app product information returned as a string array. Each string element in the array is in JSON format.

inAppSignature

array

Signature string that contains the purchase data (inAppPurchaseDataList) signed using the payment private key. The signature algorithm is SHA256withRSA. Each signature string maps a product in inAppPurchaseDataList. That is, the first signature string in inAppSignature maps the first product record in inAppPurchaseDataList; the second string maps the second product record, and so on. Signature verification is required for each JSON string in inAppPurchaseDataList. If the verification fails, the app needs to obtain the product information again. For details about signature verification, please refer to Verifying the Signature in the Result.

continuationToken

string

Data locating flag. If a user has a large number of products and the response contains continuationToken, the app must initiate another call on the current method and pass the currently received continuationToken. If product query is still incomplete, the app needs to call the method again until no continuationToken is returned, indicating that all products are returned.

placedInappPurchaseDataList

array

Subscription relationship information about a user who has performed subscription switchover. The value is a JSON string array. For details about the parameters contained in each JSON string, please refer to InAppPurchaseData. Subscription switchover refers to the switch from one product in one period to another product in the same subscription group in the next period. In this case, the relationship between the first product and the user is canceled, and another relationship between the second product and the user is established. In this case, the method returns the subscription relationship information about the second product. The value of this parameter is returned only when priceType is set to 2 and the user has performed a subscription switchover.

placedInappSignatureList

array

This parameter matches the signature string of the subscription relationship in placedInappPurchaseDataList. Signature verification is required for each JSON string in placedInappPurchaseDataList. If the verification fails, the app needs to obtain the subscription relationship again. For details about signature verification, please refer to Verifying the Signature in the Result. The value of this parameter is returned only when priceType is set to 2 and the user has performed a subscription switchover.

data

string

Error description. Check the error type before obtaining the error code.

code

number

Error code.

startIapActivityReq

json

Yes

Request for jumping to the subscription page. For details, please refer to startIapActivityReq parameters.

success

function

No

Callback upon success.

fail

function

No

Callback upon failure.

complete

function

No

Callback upon completion.

applicationID

string

Yes

Unique ID allocated to a quick app created by the vendor alliance. For details about how to obtain the ID, please refer to Obtaining the App ID.

type

number

Yes

Redirection page. The options are as follows:

• 2: subscription management page
• 3: subscription editing page

subscribeProductId

string

No

ID of a subscribed subscription. This parameter is required when type is set to 3, while it is not required when type is set to 2.

data

string

Error description. Check the error type before obtaining the error code.

code

number

Error code.