Data dictionary

2022-01-21 09:17

Model

1. Address

No.	Field	Description
1	region	MANDATORY String (2) The two-character ISO 3166 country/region code
2	state	OPTIONAL String (8) State, country, or province
3	city	OPTIONAL String (32) City, district, suburb, town, or village
4	address1	OPTIONAL String (256) Address line 1 (such as street, PO Box, or company name )
5	address2	OPTIONAL String (256) Address line 2 (such as apartment, suite, unit, or building)
6	zipCode	OPTIONAL String (32) ZIP or postal code

2. Amount

No.

Field

Description

currency

MANDATORY String (3)

The three-character ISO-4217 currency code.

value

MANDATORY Integer (16)

0 or a positive integer. The value is in the smallest currency unit (for example, if the value is 100, the amount is $1.00 when currency is USD, or ￥100 when currency is JPY).

3. Attachment

No.	Field	Description
1	attachmentType	MANDATORY AttachmentType The attachment type.
2	file	MANDATORY String (1024) The attachment file.
3	attachmentName	OPTIONAL String (128) The name of the attachment.

4. AuthorizationInfo

No.	Field	Description
1	referenceAgreementId	MANDATORY String (64) The unique ID that is assigned by AuthClient to identify an authorization
2	authClientId	MANDATORY String (64) The unique identifier for AuthClient
3	authState	OPTIONAL String (256) Authorization statement that is generated by the AuthClient

5. Buyer

No.	Field	Description
1	buyerId	OPTIONAL String (64) The unique ID that is assigned by AlipayHK to identify a buyer
2	buyerName	OPTIONAL UserName Buyer name. See UserName for more details.
3	buyerPhoneNo	OPTIONAL String (24) Contact number of the buyer
4	buyerEmail	OPTIONAL Email Email address of the buyer

6. Certificate

No.	Field	Description
1	certificateType	OPTIONAL CertificateType Identification type. Valid values are: ID_CARD PASSPORT
2	certificateNo	MANDATORY String (64) Identification Number
3	holderName	OPTIONAL UserName Holder name
4	effecticveDate	OPTIONAL Date The date when the ID card or passport is effective
5	expireDate	OPTIONAL Date The date when the ID card or passport expires

7. ContactInfo

No.

Field

Description

contactNo

MANDATORY String (64)

Contact number, such as mobile phone number. Email address can also be used.

contactType

MANDATORY String

Contact type. Possible values are:

MOBILE_PHONE
TELEPOHONE

8. DeviceInfoDetail

No.	Field	Description
1	apdidToken	MANDATORY String (128) The input apdidToken from the upstream system.
2	deviceId	MANDATORY String (128) The unique identifier of the device. If you use A+ device fingerprint system, the device ID is generated by this system. Otherwise, use the unique device ID in your own system.
3	isRoot	MANDATORY Boolean The device is rooted/jailbreak. Access permission to the device system administrator is compromised.
4	isHook	MANDATORY Boolean Hook attack risk exists in the device while the attack target is confirmed as apps that are SDK integrated.
5	isSimulator	MANDATORY Boolean The device is a simulator, which means that the app is running on a simulator instead of a physical device.
6	isReset	MANDATORY Boolean The device is reset.
7	isVirtual	MANDATORY Boolean The app is running in virtualization mode/environment. For example, VMware.
8	isRepack	MANDATORY Boolean The app installed on the device is repacked. High potential risk that the app on the device is compromised.
9	isMemoryplugin	MANDATORY Boolean The device contains tools that search for sensitive data within the device memory stack.
10	isHardreset	MANDATORY Boolean The device is reset. (Hard tag)
11	isHardvirtual	MANDATORY Boolean The app is running in virtualization mode/environment. For example, VMware. (Hard tag)
12	isHardsimulator	MANDATORY Boolean The device is a simulator, which means that the app is running on a simulator instead of a physical device. (Hard tag)
13	isWiredlan	MANDATORY Boolean The device uses wired LAN.
14	isHardabnormal	MANDATORY Boolean The device is abnormal. (Hard tag)
15	passThroughInfo	OPTIONAL String (2048) Passthrough information in the set of key-value pairs that is transmitted between AlipayHK and participants

Note:

Hard tag is an Ant special detect method. If you do not use A+ device fingerprint system, use the same value as the normal tag. For example, use isReset for isHardReset.

9. EndUserInformation

No.	Field	Description
1	userName	MANDATORY UserName User name
2	nationality	OPTIONAL String (2) The two-character ISO 3166 country/region code
3	userAddress	OPTIONAL Address User address
4	userEmail	OPTIONAL String (67) User email
5	userPhoneNo	OPTIONAL String (31) The contact number of the user.
6	birthDate	OPTIONAL Datetime Date of birth

10. Env

No.	Field	Description
1	terminalType	OPTIONAL TerminalType Terminal type. Valid values are: WEB WAP APP MINI_APP
2	osType	OPTIONAL OsType Operation system type. Valid values are: IOS ANDROID This field is mandatory when productCodeType is CASHIER_PAYMENT and terminalType is not WEB.
3	deviceTokenId	OPTIONAL String (64) Token ID of the device
4	deviceClientIp	OPTIONAL String (32) IP address of the client device
5	cookieId	OPTIONAL String (64) User cookie ID
6	userAgent	OPTIONAL String (1024) User agent

11. Goods

No.	Field	Description
1	referenceGoodsId	MANDATORY String (64) The unique ID assigned by the merchant that directly provides services or goods to users to identify goods
2	goodsName	MANDATORY String (256) Goods name
3	goodsCategory	OPTIONAL String (64) A categorization of the goods type
4	goodsBrand	OPTIONAL String (32) Goods brand
5	goodsUnitAmount	OPTIONAL Amount Goods price
6	goodsQuantity	OPTIONAL String (32) Goods quantity

12. Kyc

No.	Field	Description
1	kycLevel	MANDATORY KycLevelType KYC level. Valid values are: LEVEL_0 LEVEL_1 LEVEL_2
2	kycMethod	OPTIONAL String (128) Method that is used for KYC
3	kycTime	OPTIONAL Datetime Time when the KYC procedure is finished

13. Logo

No.

Field

Description

logoName

MANDATORY String (128)

The logo name

logoUrl

OPTIONAL String (2048)

The logo URL

14. Merchant

No.	Field	Description
1	referenceMerchantId	MANDATORY String (32) The unique ID of the merchant that directly provides services or goods to users
2	merchantMCC	MANDATORY String (32) Merchant category code, which represents the categorization of the merchant's business type.
3	merchantName	MANDATORY String (256) Merchant name.
4	merchantAddress	MANDATORY Address The address where the merchant is located.
5	merchantDisplayName	OPTIONAL String (64) The display name of the merchant.
6	merchantRegisterDate	OPTIONAL Date The date when the merchant completes the registration.
7	store	OPTIONAL Store Store information. The field is required for offline payment scenarios because of regulatory requirements.

15. MerchantRegistrationInfo

No.	Field	Description
1	referenceMerchantId	MANDATORY String (64) The unique identifier allocated for a merchant.
2	merchantDisplayName	OPTIONAL String (64) The display name of the merchant.
3	merchantMCC	MANDATORY String (32) Merchant category code, which represents the categorization of the merchant's business type.
4	logo	OPTIONAL Logo Merchant logo.
5	websites	OPTIONAL List<WebSite> Merchant websites.
6	merchantAddress	OPTIONAL Address The address where the merchant business is registered.
7	registrationDetail	MANDATORY RegistrationDetail Detailed registration information.

16. MerchantInformation

No.

Field

Description

merchant

MANDATORY Merchant

Merchant information

17. Order

No.	Field	Description
1	referenceOrderId	MANDATORY String (64) The unique ID assigned by the merchant that directly provides services or goods to users to identify an order. The ID is used to display user's purchase record and to track follow-up operations, such as customer complaints and disputes.
2	orderDescription	MANDATORY String (256) Description of items the user is purchasing
3	orderAmount	MANDATORY Amount Sum of cost of all items in the order that is displayed on the payment result page
4	merchant	MANDATORY Merchant Merchant information. See Merchant for more details.
5	goods	OPTIONAL Array<Goods> Goods information. See Goods for more details.
6	shipping	OPTIONAL Shipping Shipping information. See Shipping for more details.
7	buyer	OPTIONAL Buyer Buyer information, which is used for risk control. The field is highly recommended to be provided. See Buyer for more details.
8	env	OPTIONAL Env Order environment information, such as device information. See Env for more details.

18. OtpVerification

No.

Field

Description

verifyRequestId

MANDATORY String (64)

The unique ID that is assigned by ISS Participant to identify an OTP

otpCode

MANDATORY String (32)

OTP code

19. PaymentMethod

No.	Field	Description
1	paymentMethodType	MANDATORY String (32) A list of the types of payment methods. Valid values are: TRUEMONEY ALIPAY_HK TNG ALIPAY_CN GCASH DANA KAKAOPAY CONNECT_WALLET See website for updated list of payment methods.
2	paymentMethodId	OPTIONAL String (128) The unique ID that is assigned by AlipayHK to identify a payment method
3	customerId	OPTIONAL String (64) The unique ID that is assigned by ISS Participant to identify a customer
4	paymentMethodMetaData	OPTIONAL PaymentMethodMetaData The payment method metadata

20. PaymentMethodMetaData

No.

Field

Description

authClientId

OPTIONAL String (64)

The unique identifier for AuthClient

21. PaymentDetail

No.

Field

Description

paymentAmount

MANDATORY Amount

The amount that is collected by the payment executor. See Amount for details.

paymentMethod

MANDATORY PaymentMethod

The payment method that is used to collect the payment by the payment executor. See PaymentMethod for details.

22. PaymentFactor

No.	Field	Description
1	isInStorePayment	OPTIONAL Boolean An indicator of whether the payment scenario is an in-store payment
2	needSurcharge	OPTIONAL Boolean An indicator of the surcharge, which appears in the request from AlipayHK to ISS Participant. If the value is TRUE, the fields surchargeAmount and surchargeQuote must be specified. The default value is FALSE.
3	isPaymentEvaluation	OPTIONAL Boolean 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.
4	isCashierPayment	OPTIONAL Boolean An indicator of whether the payment is a cashier payment
5	isAgreementPayment	OPTIONAL Boolean An indicator of whether the payment is an agreement payment
6	isAuthorizationAndPay	OPTIONAL Boolean An indicator of whether to do authorization for the agreement payment during the payment
7	isAuthorizationPayment	OPTIONAL Boolean An indicator of whether the payment is an authorization payment
8	isDeferredPayment	OPTIONAL Boolean An indicator of whether the payment is a deferred payment, in which scenario the user uses the product or service in advance.
9	needCheckCompliance	OPTIONAL Boolean An indicator of whether the payment information must be validated before the payment is processed
10	needOtpVerification	OPTIONAL Boolean An indicator of whether the payment needs to verify OTP
11	isCrossborderSettlement	OPTIONAL Boolean An indicator of whether the payment requires cross-border settlement

23. PaymentPromoDetail

No.	Field	Description
1	promoId	MANDATORY String (128) Promotion ID
2	promoType	MANDATORY PromoType Promotion type
3	promoName	MANDATORY String (128) Promotion name
4	savingsAmount	MANDATORY Amount The total amount that is saved

24. PaymentPromoInfo

No.

Field

Description

paymentPromoDetails

OPTIONAL List<PaymentPromoDetail>

Payment promotion details

25. ProofOfDelivery

No.

Field

Description

deliveryTrackingNo

MANDATORY String (128)

The tracking number of the delivery.

shipping

MANDATORY Shipping

Shipping information

26. PSPRegistrationResult

No.

Field

Description

pspName

MANDATORY PSPNameType

PSP name

registrationResult

OPTIONAL RegistrationResult

The registration result from the PSP (also known as Issuing Participant).

27. Quote

No.	Field	Description
1	quoteId	MANDATORY String (64) The unique ID that is assigned by AlipayHK to identify a quote
2	quoteCurrencyPair	MANDATORY String (8) Exchange rate between a pair of currencies. Two currencies are separated with a slash and use the three-letter ISO-4217 currency code.
3	quotePrice	MANDATORY Decimal (20) The exchange rate used when a currency conversion occurs
4	quoteStartTime	OPTIONAL Datetime The date and time when quotePrice is effective
5	quoteExpiryTime	OPTIONAL Datetime The date and time when quotePrice expires
6	baseCurrency	OPTIONAL String (3) The first currency in quoteCurrencyPair that is specified by the three-character ISO 4217 currency code.
7	quoteUnit	OPTIONAL String (12) The amount in baseCurrency

28. RegistrationDetail

No.	Field	Description
1	legalName	MANDATORY String (256) The legal name that is used in the registration.
2	attachments	OPTIONAL List<Attachment> The attachments submitted.
3	contactInfo	OPTIONAL List<ContactInfo> The contact information of the company.
4	registrationType	MANDATORY RegistrationType The registration type.
5	registrationNo	MANDATORY String (64) The registration number.
6	registrationAddress	MANDATORY Address Business registration address specified on the registration document. Use postal address format.
7	businessType	MANDATORY BusinessType The business type of the merchant.
8	registrationEffectiveDate	OPTIONAL Date The date when the business registration is in effective.
9	registrationExpireDate	OPTIONAL Date The date when the business registration expires.

29. RegistrationResult

No.

Field

Description

registrationStatus

MANDATORY RegistrationStatusType

The status of merchant registration.

rejectReasons

OPTIONAL List<RegistrationRejectReasonCodeType>

The reason why the registration is rejected.

30. Result

No.	Field	Description
1	resultCode	MANDATORY String (16) Result code
2	resultStatus	MANDATORY ResultStatusType Result status. Valid values are: S: Successful F: Failed U: Unknown
3	resultMessage	OPTIONAL String (64) Result message that describes resultCode in detail

31. RiskScoreDetail

No.

Field

Description

riskInfoCode

MANDATORY String (32)

Risk score information code. Valid values are:

ACCOUNT_TENURE: Account registration time
TOTAL_PURCHASE: Total number of purchases in the past 90 days

NEGATIVE_LIST: An indicator of whether the account is in the blocklist
BATCH_REGISTRATION: An indicator of whether the account is registered from collective devices, IP, MAC, or others

MALICIOUS_REGISTRATION: An indicator of whether the account is in a suspicious registration pattern
KYC_STATUS: An indicator of whether the user KYC information is complete

riskInfoCodeResult

MANDATORY String (16)

Corresponding assessment results for each risk score information code.

For ACCOUNT_TENURE, valid values are:

1: Less than 10 days
2: 10 - 30 days

3: 31 - 90 days
4: 91 days - 1 year

5: More than 1 year

For TOTAL_PURCHASE, valid values are:

1: The total number is 0
2: The total number is in the range of 1 - 3

3: The total number is in the range of 4 - 10
4: The total number is greater than 10

For NEGATIVE_LIST, valid values are:

0: True
1: False

For BATCH_REGISTRATION, valid values are:

0: True
1: False

For MALICIOUS_REGISTRATION, valid values are:

0: True
1: False

For KYC_STATUS, valid values are:

0: No KYC information
1: Partial KYC information

2: Full KYC information

32. RiskScoreResult

No.	Field	Description
1	riskScoreType	MANDATORY RiskScoreType Risk score type
2	riskScore	MANDATORY Decimal Evaluation of the riskiness of the payment
3	riskScoreDetails	OPTIONAL Array<RiskScoreDetail> Detailed information about the factors that affect the risk score. See RiskScoreDetail for more details.

33. RefundPromoInfo

No.

Field

Description

refundPromoDetails

OPTIONAL List<RefundPromoDetail>

Promotion refund details

34. RefundPromoDetail

No.	Field	Description
1	promoId	MANDATORY String (128) Promotion ID
2	promoType	MANDATORY PromoType Promotion type
3	refundAmount	MANDATORY Amount Refund amount
4	promoName	MANDATORY String (128) Promotion name

35. Shipping

No.	Field	Description
1	shippingName	MANDATORY UserName (128) Recipient name
2	shippingAddress	MANDATORY Address Recipient shipping address
3	shippingCarrier	OPTIONAL String (128) Name of the carrier, such as FedEx, UPS, USPS, and so on
4	shippingPhoneNo	OPTIONAL String (16) Recipient phone (including extension)

36. Store

No.	Field	Description
1	referenceStoreId	MANDATORY String (32) The unique ID that is assigned by the merchant to identify a store.
2	storeName	MANDATORY String (256) Store name
3	storeMCC	MANDATORY String (32) The merchant category code for the store
4	storeDisplayName	OPTIONAL String (64) The display name of the store
5	storeTerminalId	OPTIONAL String (64) The unique ID that is assigned by the merchant to identify a store terminal
6	storeOperatorId	OPTIONAL String (64) The unique ID that is assigned by the merchant to identify a store operator
7	storePhoneNo	OPTIONAL String (16) Store's phone number
8	storeAddress	OPTIONAL Address The address where the store is located

37. StoreContact

No.	Field	Description
1	identificationId	MANDATORY String (64) The ID that is used to identify the store contact. The ID can be employee ID, contractor ID, operation ID, and so on.
2	fullName	MANDATORY String (128) The full name of the store contact.
3	contactNo	OPTIONAL String (64) The phone number of the store contact.

38. StoreRegistrationInfo

No.	Field	Description
1	referenceStoreId	MANDATORY String (32) The unique ID that is assigned by the merchant to identify a store.
2	storeName	MANDATORY String (256) Store name.
3	storeMCC	MANDATORY String (32) The merchant category code for the store.
4	storeAddress	MANDARORY Address The address where the store is located.
5	feeTier	OPTIONAL String (32) The fee tier assigned for this store. The possible feeTier value: `01`, `02`, `03`, `04`, `05`.
6	storeContacts	OPTIONAL List<StoreContact> The contact information of the store.

39. SubOrder

No.	Field	Description
1	merchant	MANDATORY Merchant Merchant information. See Merchant for more details.
2	goods	OPTIONAL Array<Goods> Goods information. See Goods for more details.
3	shipping	OPTIONAL Shipping Shipping information. See Shipping for more details.

40. SurchargeInfo

No.

Field

Description

surchargeAmount

MANDATORY Amount

The surcharge amount that is collected by the payment executor. See Amount for details.

surchargeQuote

MANDATORY Quote

The exchange rate between paymentAmount and surchargeAmount. See Quote for details.

41. TransactionReceipt

No.	Field	Description
1	referenceOrderId	MANDATORY String (64) The unique ID assigned by merchant that directly provides services or goods to users to identify an order. The ID is used to retrieve user's purchase record and to track follow-up operations, such as customer complaints and disputes.
2	orderAmount	MANDATORY Amount Sum of cost of all items in the order that is displayed on the payment result page. See Amount for details.
3	goods	MANDATORY Goods Goods information. See Goods for details.

42. User

No.	Field	Description
1	userId	MANDATORY String (64) The unique ID that is assigned by ISS Participant to identify a user
2	userLoginId	OPTIONAL String (64) The unique user's login ID that is assigned by ISS Participant
3	userName	OPTIONAL UserName User name. See UserName for details.
4	nationality	OPTIONAL String (2) The two-character ISO 3166 country/region code
5	userAddress	OPTIONAL Address User's address. See Address for details.
6	certificate	OPTIONAL Certificate Certificate information. See Certificate for details.
7	userKyc	OPTIONAL Kyc User's KYC information. See Kyc for details.
8	userEmail	OPTIONAL Email User's email
9	userPhoneNo	OPTIONAL String (31) User's contact number
10	birthDate	OPTIONAL Date Date of birth
11	hashLoginId	OPTIONAL String (64) Hash that uses MD5 to describe the user's login ID

43. UserName

No.	Field	Description
1	firstName	OPTIONAL String (32) User's first name
2	middleName	OPTIONAL String (32) User's middle name
3	lastName	OPTIONAL String (32) User's last name
4	fullName	MANDATORY String (128) User's full name

44. Website

No.	Field	Description
1	name	OPTIONAL String (256) The name of the website.
2	url	MANDATORY String (2048) The URL of the website.
3	desc	OPTIONAL String (512) The description of the website.

Type

1. AttchmentType

No.	Key	Description
1	ARTICLES_OF_ASSOCIATION	Articles of association
2	ENTERPRISES_ANNUAL_INSPECTION_REPORT	Enterprise annual inspection report
3	PROOF_OF_ADDRESS	The proof of address
4	OTHER_MATERIAL	Other material
5	REGISTRATION_CERTIFICATE	Registration certificate

2. AuthorizationNotifyType

No.	Key	Description
1	TOKEN_CREATED	Token is created.
2	TOKEN_CANCELED	Token is cancelled.

3. BusinessType

No.	Key	Description
1	ENTERPRISE	The business type is enterprise.
2	INDIVIDUAL	The business type is individual.

4. CertificateType

No.	Key	Description
1	ID_CARD	Identification card
2	PASSPORT	Passport

5. CodeType

No.	Key	Description
1	ORDER_CODE	Order code
2	STORE_CODE	Store code

6. CustomerIdType

No.	Key	Description
1	EMAIL	Email
2	USER_ID	User ID
3	MOBILE_NO	Mobile No.

7. DisputeReasonCodeType

No.	Key	Description
1	7801	Fraudulent disputes
2	7802	Non-fraudulent disputes

8. FeeType

No.	Key	Description
1	INTERCHARGE_FEE	Intercharge fee
2	SERVICE_FEE	Service fee

9. FundDirectionType

No.	Key	Description
1	CREDIT	Credit
2	DEBIT	Debit

10. GrantType

No.	Key	Description
1	AUTHORIZATION_CODE	Authorization code that is used to exchange for an access token
2	REFRESH_TOKEN	Refresh token that is used to obtain a new access token without the authorization from the user again when the access token is expired

11. KycLevelType

No.	Key	Description
1	LEVEL_0	No verification is done.
2	LEVEL_1	Verification is done by using the bank card.
3	LEVEL_2	Strong verification is done by using the face and identity card verification.

12. OsType

No.	Key	Description
1	IOS	iOS
2	ANDROID	Android

13. PaymentActionType

No.	Key	Description
1	QUERY	Use the Payment Inquiry interface to fetch the payment result.
2	REDIRECT	Redirect to ISS Participant page to confirm the payment.

14. PaymentMethodSubType

No.	Key	Description
1	PAYMENT_TOEKN	Payment token
2	PAYMENT_CODE	Payment code

15. ProductCodeType

No.	Key	Description
1	CASHIER_PAYMENT	Cashier Payment
2	AGREEMENT_PAYMENT	Multi-use agreement for Auto Debit product. The agreement stays valid until it is explicitly cancelled.
3	IN_STORE_PAYMENT	Offline in-store payment

16. PromoStatusType

No.	Key	Description
1	ENABLE	Enabled
2	USED	Used

17. PromoType

No.	Key	Description
1	INSTANT_DISCOUNT	Instant discount
2	COUPON	Coupon

18. PSPNameType

No.	Key	Description
1	ALIPAY_CN	ALIPAY_CN
2	EASYPAISA	EASYPAISA
3	ALIPAY_HK	ALIPAY_HK
4	KAKAOPAY	KAKAOPAY
5	DANA	DANA
6	GCASH	GCASH
7	ALIPAY_MO	ALIPAY_MO
8	PAYPAY	PAYPAY
9	TNG	TNG
10	EZLINK	EZLINK
11	BKASH	BKASH
12	TRUEMONEY	TRUEMONEY

19. RegistrationRejectReasonCodeType

No.	Key	Description
1	RISK_REJECT_BUSINESS_1_1	For offline merchants, the registered country/region, registration number, legal name of entity or business entity type is inconsistent. Provide correct information and register again or contact merchant service support to leave a feedback.
2	RISK_REJECT_HIGHRISK_2_1	For offline merchants, please provide modify the information and register again or contact merchant service support to leave a feedback.
3	RISK_REJECT_BUSINESS_1_2	Registered country/region, registration number, legal name of entity or business entity type is inconsistent. Provide correct information and register again or contact merchant service support to leave a feedback.
4	RISK_LACK_WEBSITE_1_2	The website URL is required. Provide the valid website URL and register again or contact merchant service support to leave a feedback.
5	RISK_WEBSITE_ILLEGAL_1_2	The website URL is invalid. Contact merchant service support to leave a feedback and register again.
6	RISK_WEBSITE_INCOMPLETE_1_2	The website URL is incomplete. Provide the complete website URL and register again or contact merchant service support to leave a feedback.
7	RISK_WEBSITE_NEED_LOGIN_1_2	The username and password are required to login. Remove the password restriction or provide password to merchant service support for assistance.
8	RISK_WEBSITE_NOPAY_1_2	No payment activity under the business. Please provide detailed business information to merchant service support.
9	RISK_REJECT_HIGHRISK_1_2	Please take off the forbidden goods and resubmit your request.
10	RISK_REJECT_HIGHRISK_2_2	For online merchants, please modify the information and register again, or contact merchant service support to leave a feedback.
11	RISK_AML_REJECT	Failed to pass the review. Contact merchant service support to leave a feedback and register again.

20. RegistrationStatusType

No.	Key	Description
1	COMPLETED	All wallets have returned registration result.
2	PENDING	Await for registration result. PSPRegistrationResultList shows the registration status of wallets that have returned result so far.
3	CANCELLED	The new merchant registration information overwrites the last registration request which is in PENDING status. Only displayed in the PSPRegistrationResultList filed.
4	APPROVED	The registration is approved by the wallet. Only displayed in the PSPRegistrationResultList filed.
5	REJECTED	The registration request is rejected by wallet or ipay.

21. RegistrationType

No.	Key	Description
1	US_FEDERAL_EIN	(Employer Identification Number) EIN of US merchant.
2	ENTERPRISE_REGISTRATION_NO	Merchant registration ID.
3	INDEPENDENT_CONTRACTOR_LICENSE_NO	The license number of ride-share driver or taxi driver.
4	OTHER_IDENTIFICATION_NO	Other registration type.

22. RequestInformationType

No.	Key	Description
1	TRANSACTION_RECEIPT	Transaction receipt
2	PROVE_OF_DELIVERY	Proof of delivery
3	MERCHANT_INFORMATION	More merchant information is required. Select this type only when disputeReasonCode is 7801.
4	END_USER_INFORMATION	More user information is required.
5	OTHER_DOCUMENTATION	Other documentation is required.

23. ResponseCodeType

No.	Key	Description
1	001	Materials are provided
2	002	Materials can not be provided

24. RiskInfoCodeType

No.	Key	Description
1	NSF_SCORE	Account risk scoring service
2	FRAUD_SCORE	Fraud risk scoring service

25. RiskScoreType

No.	Key	Description
1	NSF_SCORE	Account risk scoring service
2	FRAUD_SCORE	Fraud risk scoring service

26. ScopeType

No.	Key	Description
1	BASE_USER_INFO	Authorized to obtain the unique user ID
2	AGREEMENT_PAY	Authorized to use token to withhold user's assets
3	USER_LOGIN_ID	Authorized to obtain the user login ID
4	HASH_LOGIN_ID	Authorized to obtain the hash user login ID
5	SEND_OTP	Authorized to send OTP to the user

27. SettlementType

No.	Key	Description
1	DOMESTIC_SETTLEMENT	Domestic settlement
2	CROSS_BORDER_SETTLEMENT	Cross-border settlement

28. TerminalType

No.	Key	Description
1	APP	Mobile terminal
2	WEB	Web
3	WAP	Wap
4	MINI_APP	Mini program

29. TransactionStatusType

No.	Key	Description
1	SUCCESS	Transaction is successful.
2	FAIL	Transaction is failed.
3	PROCESSING	Transaction is under processing.

30. TransactionType

No.	Key	Description
1	PAYMENT	Payment
2	REFUND	Refund
3	CHARGEBACK	Chargeback
4	CREDIE_ADJUESTMENT	Credit adjustment
5	DEBIT_ADJUESTMENT	Debit adjustment

31. VerifyType

No.	Key	Description
1	MOBILE	Mobile
2	EMAIL	Email

32. ValidationErrorType

No.	Key	Description
1	MERCHANT_ID_IS_BLANK	Merchant ID is required
2	MERCHANT_LEGAL_NAME_IS_BLANK	Legal name of merchant is required
3	LEGAL_ENTITY_TYPE_IS_BLANK	Type of legal entity is required
5	LEGAL_ENTITY_TYPE_ILLEGAL	Type of legal entity is invalid
5	REGISTRATION_REGION_IS_BLANK	Registration country/region is required
6	REGISTRATION_REGION_ILLEGAL	Registration country/region is invalid
7	REGISTRATION_NO_IS_BLANK	Registration number is required
9	REGISTRATION_ADDRESS_IS_BLANK	Registration address is required
9	MERCHANT_MCC_IS_BLANK	Merchant MCC is required
10	MERCHANT_MCC_ILLEGAL	Merchant MCC is invalid
11	WEBSITE_IS_BLANK	URL is required
12	WEBSITE_TYPE_ILLEGAL	Website URL type is invalid
13	WEBSITE_ILLEGAL	Website URL format is invalid
14	REGISTER_ADDRESS_IS_BLANK	Store Address is required
15	STORE_NAME_IS_BLANK	Store name is required
16	STORE_REGION_IS_BLANK	Country/region of the store is required
17	STORE_REGION_IS_ILLEGAL	Country/region of the store is invalid
18	STORE_ADDRESS_IS_BLANK	Store address is required
19	STORE_MCC_IS_BLANK	MCC of the store is required
20	STORE_MCC_ILLEGAL	MCC of the store is invalid
21	SHAREHOLDER_NAME_IS_BLANK	Full legal name of the company owner or shareholder is required
22	SHAREHOLDER_ID_IS_BLANK	The company owner or shareholder ID is required
23	SHAREHOLDER_REGION_IS_BLANK	Nationality of the company owner or shareholder is required
24	SHAREHOLDER_REGION_ILLEGAL	Nationality of the company owner or shareholder is invalid
25	LEGAL_PERSON_NAME_IS_BLANK	Name of legal person is required
26	LEGAL_PERSON_ID_IS_BLANK	ID of legal person is required
27	LEGAL_PERSON_REGION_IS_BLANK	Nationality of legal person is required
28	LEGAL_PERSON_REGION_ILLEGAL	Nationality of legal person is invalid
29	STORE_ID_IS_BLANK	Store ID is required
30	MERCHANT_COUNT_EXCEEDS_LIMIT	Only one acquirer can be registered at a time. Multiple acquirers need to be registered several times.
31	MERCHANT_NOT_EXIST	The acquirer doesn't exist.
32	MERCHANT_EXIST_MULTI_REGION	Multiple data centers exist for the merchant.
33	MERCHANT_ROLE_IS_NOT_ACQUIRE	The merchant isn't an acquirer
34	REGISTRATION_TYPE_IS_BLANK	Registration type is required
35	FEE_TIER_ILLEGAL	Fee tier of the store is invalid.
36	STORE_CONTACT_SIZE_ILLEGAL	The number of store contact info is invalid
37	STORE_CONTACT_SIZE_ILLEGAL	The store contact info is invalid