Data dictionary (for v1 )
Model
Amount
Property | Data type | Required | Description |
currency | String | Yes | The three-character ISO-4217 currency code. Max. length: 3 characters. |
value | String | Yes | A string that encloses a positive 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). Max. length: 16 characters. |
ActionForm
Property | Data type | Required | Description |
actionFormType | String | No | The action form type. Enum: ORDER_CODE, REDIRECTION. |
| orderCode | String | No | The order code value. Max. length: 2048 characters. |
| redirectionUrl | String | No | The url of redirect. Max. length: 4096 characters. |
EnvInfo
Property | Data type | Required | Description |
terminalType | String | No | The terminal type of this request. Enum: [ MINI_APP, APP, WEB, WAP, SYSTEM ]. |
osType | String | No | OS type. Enum: [ IOS, ANDROID ] |
| userAgent | String | No | User agent. Max. length: 1024 characters. |
deviceTokenId | String | No | Token ID of the device. Max. length: 128 characters. |
clientIp | String | No | IP address of the client device. Max. length: 64 characters. |
cookieId | String | No | User cookie ID. Max. length: 128 characters. |
| extendInfo | String | No | Extend info. Max. length: 4096 characters. |
PaymentFactor
Property | Data 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. |
OpenLoginIdInfo
Property | Data type | Required | Description |
| loginId | String | No | Login Id is a identification for an user, which can be mobile number or email. User can use login Id to login Wallet. Max. length: 64 characters. |
| loginIdType | String | Yes | Login id type, Enum: "MOBILE_PHONE", "EMAIL". Max. length: 64 characters. |
| maskLoginId | String | No | Mask Login id, several bits of the phone number will be hidden to protect users' privacy. Max. length: 64 characters. |
| hashLoginId | String | No | Hash login id. The login id hashed by hash algorithm. The external system can use it to compare it's login id hashed by the same hash algorithm to see if the login id is the same. Max. length: 256 characters. |
| extendInfo | String | No | The extend information,wallet and merchant can put extend info here. Max. length: 4096 characters. |
ContactInfo
Property | Data type | Required | Description |
| contactNo | String | Yes | Contact No. e.g mobile-phone No, e-mail address. Max. length: 64 characters. |
| contactType | String | Yes | Contact type, there are agreed types(MOBILE_PHONE, TELEPHONE, EMAIL) that should be available to all users, developer can add new type, but developer should consider the compatibility. Max. length: 32 characters. |
| extendInfo | String | No | The extend information,wallet and merchant can put extend info here. Max. length: 4096 characters. |
OpenUserInfo
Property | Data type | Required | Description |
| userId | String | No | The hashed unique identifier allocated for user. Max. length: 64 characters. |
status | String | No | User status, Enum: "ACTIVE", "FROZEN", "INACTIVE". Max. length: 32 characters. |
| nickName | String | No | Nick name. Max. length: 256 characters. |
userName | No | User name, fullName and (firstName,middleName,lastName) can not both empty. | |
userAddresses | Array<Address> | No | The user's address information. |
| avatar | String | No | Avatar url. Max. length: 256 characters. |
| gender | String | No | F: female; M: Male. Max. length: 32 characters. |
birthday | String/Datetime | No | Birthday which follows the ISO 8601 standard. Max. length: 32 characters. |
nationality | String | No | Nationality, alpha-2 code according to ISO3166. e.g. JP, US. Max. length: 32 characters. |
loginIdInfos | Array<OpenLoginIdInfo> | No | User login id info list. |
| contactInfos | Array<ContactInfo> | No | Contact info list. |
| extendInfo | String | No | The extend information,wallet and merchant can put extend info here. Max. length: 4096 characters. |
PaymentMethod
Property | Data type | Required | Description |
| paymentMethodType | String | Yes | Payment method type, used to identifier a payment method. Max. length: 32 characters. |
| paymentMethodId | String | No | The uniqueId of a customer belong to a paymentMethod. Max. length: 128 characters. |
| extendMetaData | String | No | Extended information. Max. length: 2048 characters. |
Result
Property | Data type | Required | Description |
resultStatus | String | No | Result status. Valid values are:
|
resultCode | String | No | Result code. Max. length: 64 characters. |
resultMessage | String | No | Result message that describes resultCode in detail. Max. length: 256 characters. |
UserName
Property | Data type | Required | Description |
fullName | String | No | Full Name. Max. length: 128 characters. |
firstName | String | No | First Name. Max. length: 32 characters. |
middleName | String | No | Middle Name. Max. length: 32 characters. |
lastName | String | No | Last Name. Max. length: 32 characters. |
Order
Property | Data type | Required | Description |
| referenceOrderId | String | Yes | The unique identification of the order on the merchant side. It is used for the display of user consumption records, and the subsequent payment operations such as customer complaints and disputes track. Max. length: 64 characters. |
| orderDescription | String | No | Description of the order used to display user consumption records, etc. Max. length: 256 characters. |
| orderAmount | Yes | The amount of an order, like how much to charge in the specified currency unit for an order. | |
| orderCreateTime | String/Datetime | No | Order create time from merchant which follows the ISO 8601 standard. Max. length: 32 characters. |
| referenceMerchant | No | Merchant information. | |
| goods | No | Goods information. | |
| shipping | Shipping | No | Shipping information. |
| buyer | Buyer | No | Buyer information. |
| extendInfo | String | No | Extended infomation data, this field includes information that are not common but needed for special use cases. Max. length: 2048 characters. |
Merchant
Property | Data type | Required | Description |
| referenceMerchantId | String | Yes | Merchant ID. |
| merchantMCC | String | Yes | Merchant MCC. |
| merchantName | String | Yes | Name of Merchant. |
| merchantDisplayName | String | No | Display name of merchant. |
| merchantAddress | No | The address of merchant. | |
| merchantRegisterDate | String/Datetime | No | Merchant register time from merchant which follows the ISO 8601 standard. Max. length: 32 characters. |
| store | No | Merchant store. |
Address
Property | Data type | Required | Description |
| region | String | Yes | Alpha-2 code according to ISO3166. e.g. JP, US. Max. length: 2 characters. |
| state | String | No | State/County/Province. Max. length: 8 characters. |
| city | String | No | City/District/Suburb/Town/Village. Max. length: 32 characters. |
address1 | String | No | Address line 1(Street address/PO Box/Company name). Max. length: 256 characters. |
| address2 | String | No | Address line 2(Apartment/Suite/Unit/Building). Max. length: 256 characters. |
| zipCode | String | No | ZIP or postal code. Max. length: 32 characters. |
Store
Property | Data type | Required | Description |
| referenceStoreId | String | Yes | The store belongs to a merchant, and the ID assigned by the corresponding merchant to the store is unique under the merchant. Max. length: 64 characters. |
| storeName | String | No | Name of store. Max. length: 256 characters. |
| storeMCC | String | No | Store business category code. Max. length: 32 characters. |
| storeDisplayName | String | No | Display name of store. Max. length: 64 characters. |
| storeTerminalId | String | No | Unique identifier of store's terminal. Max. length: 64 characters. |
| storeOperatorId | String | No | Unique identifier of store's terminal operator. Max. length: 64 characters. |
storeAddress | No | The address of the store. | |
| storePhoneNo | String | No | Phone number of Store. Max. length: 16 characters. |
Goods
Property | Data type | Required | Description |
| referenceGoodsId | String | Yes | Unique ID of goods. Max. length: 64 characters. |
| goodsName | String | Yes | Name of goods. Max. length: 256 characters. |
| goodsCategory | String | No | Category of goods. Max. length: 256 characters. |
| goodsBrand | String | No | Brand of goods. Max. length: 32 characters. |
| goodsUnitAmount | No | Order amount for display of user consumption records, payment results page. | |
| goodsQuantity | String | No | Quantity of goods. Max. length: 32 characters. |
| goodsUrl | String | No | Goods url. Max. length: 1024 characters. |
| extendInfo | String | No | The extend information of goods. Max. length: 2048 characters. |
Shipping
Property | Data type | Required | Description |
| shippingName | Yes | Shipping name. | |
| shippingAddress | Yes | Shipping address. | |
| shippingCarrier | String | No | The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc. Max. length: 128 characters. |
| shippingPhoneNo | String | No | Recipient PhoneNo(including extension). Max. length: 16 characters. |
| shippingFee | No | Shipping fee. |
Buyer
Property | Data type | Required | Description |
| referenceBuyerId | String | No | Unique Identification of buyer. Max. length: 64 characters. |
| buyerName | No | Buyer name. | |
| buyerPhoneNo | String | No | Mobile phone number of buyer. Max. length: 24 characters. |
Enum
OsType
| Key | Description |
| IOS | iOS. |
| ANDROID | Android. |
PaymentMethodType
| Key | Description |
BALANCE | Balance. |
COUPON | Coupon. |
CREDIT_CARD | Credit Card. |
DEBIT_CARD | Debit Card. |
TerminalType
| Key | Description |
MINI_APP | Mini program. |
APP | Mobile Application. |
WEB | Broswer Web. |
| WAP | Mobile Wap. |
| SYSTEM | System Call. |