Data dictionary - SuperApp - Alibaba Cloud Documentation Center

User

Parameter	Type	Required	Description
openId	String	No	The user ID that is encrypted. The encrypted ID of each user for a miniapp is unique. For different miniapps, a user has multiple encrypted IDs. The value can be up to 64 characters in length.
status	String	No	The state of the user. Examples: ACTIVE, FROZEN, and INACTIVE. The value can be up to 32 characters in length.
nickName	String	No	The nickname of the user. The value can be up to 256 characters in length.
userName	UserName	No	The username of the user. You cannot leave the following parameters empty at the same time: userName, fullName, firstName, middleName, and lastName.
userAddresses	Array<Address>	No	The address of the user.
avatar	String	No	The URL of the profile picture of the user. The value can be up to 256 characters in length.
gender	String	No	The gender of the user. Valid values: F and M. F specifies female and M specifies male. The value can be up to 32 characters in length.
birthDate	String/Datetime	No	The date of birth of the user. The date must follow the ISO 8601 standard. The value can be up to 32 characters in length.
nationality	String	No	The nationality of the user. The value must be a two-letter code from the ISO 3166 standard. Examples: JP and US. The value can be up to 32 characters in length.
loginIdInfos	Array<LoginIdInfo>	No	The logon IDs of the user.
contactInfos	Array<ContactInfo>	No	The contacts of the user.
extendInfo	String	No	The extended information to be added, such as the information about wallets and vendors. The value can be up to 4,096 characters in length.

UserName

Parameter	Type	Required	Description
fullName	String	No	The full name of the user. The value can be up to 128 characters in length.
firstName	String	No	The first name of the user. The value can be up to 32 characters in length.
middleName	String	No	The middle name of the user. The value can be up to 32 characters in length.
lastName	String	No	The last name of the user. The value can be up to 32 characters in length.

Address

Parameter	Type	Required	Description
region	String	Yes	The region. The value must be a two-letter code from the ISO 3166 standard. Examples: JP and US. The value can be up to two characters in length.
state	String	No	The state, county, or province. The value can be up to eight characters in length.
city	String	No	The city, district, suburb, town, or village. The value can be up to 32 characters in length.
address1	String	No	The primary address that is specified in Address Line 1, such as the street, post office box, or company name. The value can be up to 256 characters in length.
address2	String	No	The secondary address that is specified in Address Line 2, such as the apartment, suite, unit, or building. The value can be up to 256 characters in length.
label	String	No	The tag of the address. Examples: Family and Company. The value can be up to 64 characters in length.
zipCode	String	No	The postal code. The value can be up to 32 characters in length.
extendInfo	String	No	The extended information about the commodity. The value can be up to 4,096 characters in length.

LoginIdInfo

Parameter	Type	Required	Description
loginIdType	String	Yes	The type of the logon ID. Valid values: MOBILE_PHONE EMAIL OTHERMax The value can be up to 64 characters in length.
loginId	String	No	The unique logon ID that is used by the user to connect to the wallet. The logon ID can be a mobile phone number or an email address. A user can connect to a wallet by using a logon ID that does not contain hidden bits. The value can be up to 64 characters in length.
maskLoginId	String	No	The logon ID that is masked to hide bits, such as phone number bits, to ensure privacy. The value can be up to 64 characters in length.
extendInfo	String	No	The extended information to be added, such as the information about wallets and vendors. The value can be up to 4,096 characters in length.

ContactInfo

Parameter	Type	Required	Description
contactType	String	Yes	The contact method of the user. The following contact methods are available to all users: MOBILE_PHONE TELEPHONE EMAIL Note: If you are a developer, you can add new contact methods that are compatible with your system. The value can be up to 32 characters in length.
contactNo	String	Yes	The value that corresponds to the contact method specified by the contactType parameter. For example, the value can be a mobile phone number or an email address. The value can be up to 64 characters in length.
extendInfo	String	No	The extended information to be added, such as the information about wallets and vendors. The value can be up to 4,096 characters in length.

Amount

Parameter

Type

Required

Description

currency

String

Yes

The three-character ISO-4217 currency code.

Maximum length: 3 characters.

value

String/Integer

Yes

A string that encloses apositive integer representing how much to charge in the smallest currency unit(e.g., 100 cents to charge $1.00 or 100 to charge $100, a zero-decimal currency).

Maximum length: 16 characters.

PaymentMethod

Parameter	Type	Required	Description
paymentMethodType	String	Yes	Payment method type, used to identifier a payment method. Maximum length: 32 characters.
paymentMethodId	String	No	The uniqueID of a customer belong to a paymentMethod. Maximum length: 128 characters.
extendMetaData	String	No	Extended information. Maximum length: 2048 characters.

PaymentFactor

Parameter	Type	Required	Description
isPaymentEvaluation	Boolean	No	An indicator of the payment evaluation. If the value is TRUE, the payment is only to evaluate whether the payment can be successful and no actual funds deduction occurs. The default value is FALSE.
isOrderCode	Boolean	No	If the payment senario is the user scan the code presented by merchant and identify the order, and make payment. The default value is FALSE.
isPaymentCode	Boolean	No	An indicator of whether the payment scenario is the merchant scan the user payment code. The default value is FALSE.
isAgreementPay	Boolean	No	An indicator of whether the payment is an agreement payment.The default value is FALSE.
isCashierPayment	Boolean	No	An indicator of whether the payment is a cashier payment.The default value is FALSE.
isAuthorizationAndPay	Boolean	No	An indicator of whether to do agreementPay authorization during the payment.The default value is FALSE.
isAuthorizationPayment	Boolean	No	An indicator of whether the payment is an authorization payment.The default value is FALSE.

EnvInfo

Parameter	Type	Required	Description
terminalType	String	No	The terminal type of this request. Valid values are: MINI_APP APP WEB WAP SYSTEM
osType	String	No	OS type. Valid values are: IOS ANDROID
osVersion	String	No	OS version
userAgent	String	No	User agent. Maximum length: 1024 characters.
deviceTokenId	String	No	Token ID of the device. Maximum length: 128 characters.
clientIp	String	No	IP address of the client device. Maximum length: 64 characters.
cookieId	String	No	User cookie ID. Maximum length: 128 characters.
manufacturer	String	No	sample: Apple
clientVersion	String	No	Version of APP client, sample:1.0.0
extendInfo	String	No	Extend information. Maximum length: 4096 characters.

ActionForm

Parameter	Type	Required	Description
actionFormType	String	No	The action form type. Valid values are: `ORDER_CODE` `REDIRECTION`
orderCode	String	No	The order code value.
redirectionUrl	String	No	The URL of redirect.