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.

Property

Data type

Required

Description

userId

String

No

The hashed unique identifier allocated for user.

Max. length: 64 characters.

scope: User_Base_Info/User_Customer_Info/User_Customer_KYC_Info

phoneNumber

String

No

User's phone number

scope: User_Customer_Info/User_Customer_KYC_Info

email

String

No

User's email

scope: User_Customer_Info/User_Customer_KYC_Info

documentType

String

No

User's kyc document type

scope: User_Customer_KYC_Info

documentNo

String

No

User's kyc document No

scope: User_Customer_KYC_Info

name

String

No

scope: User_Customer_KYC_Info

surname

String

No

scope: User_Customer_KYC_Info

deliveryAddress

List<DeliveryAddress>

No

user's delivery address managed on super app

scope: User_Customer_Info/User_Customer_KYC_Info

extendInfo

ExtendInfo

No

Extended infomation data, this field includes information that are not common but needed for special use cases.

Max. length: 4096 characters.

deviceName

String

No

User's device name

scope: User_Customer_KYC_Info

brand

String

No

User's brand (Iphone/Huawei)

scope: User_Customer_KYC_Info

os

String

No

User's os(IOS/Android)

scope: User_Customer_KYC_Info

osVersion

String

No

User's os version

scope: User_Customer_KYC_Info

claroPay

ClaroPay

No

Property

Data type

Required

Description

cpAccessToken

String

No

Claro pay access token

availableBalance

String

No

Claro pay available balance

Property

Data type

Required

Description

name

String

Yes

address's name

phoneNumber

String

Yes

mobile phone number, format TBC

fixPhoneNumber

String

No

fix phone number, fotmat TBC

province

String

Yes

province

city

String

Yes

city

address

String

No

neighborhood

detail

String

No

isDefault

String

Yes

detail address

Property

Data type

Required

Description

access_token

String

No

Access token for authentication against identity digital services

scope: User_Customer_KYC_Info

id_token

String

No

Encrypted JWT obtained after the authentication flow and with the origin of the information against identity digital services.

scope: User_Customer_KYC_Info

Property

Data type

Required

Description

resultStatus

Result status. Valid values are:

• S : Successful
• F : Failed
• U : Unknown
• A : accepted, not yet succeed, but can proceed with some actions.

resultCode

String

No

Result code.

Max. length: 64 characters.

resultMessage

String

No

Result message that describes the result code in details.

Max. length: 256 characters.

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

Yes

Description of the order used to display user consumption records, etc.

Max. length: 256 characters.