SDK Parameter Reference

type

String

M

Fixed value: payment

sessionID

String

M

The sessionID returned by the interaction (LinkPay) API (16-character UUID in current LinkPay URL)

locale

String

O

Language for Drop-in display. Example: en-US. Supports Chinese, Traditional Chinese, English, Japanese, Korean, Thai, Vietnamese, Bahasa Indonesia

environment

String

M

Set the environment for requests, e.g., HKG_prod, BKK_prod, TYO_prod, UAT, TEST

mode

String

M

fullPage or embedded

uiOption

Object

O

card

Object

O

Customize card payment section setting

showCardHolderName

boolean

O

To indicate if user is required to input card holder name when choosing card payment

CVVForSavedCard

boolean

O

To indicate if user is required to input CVV when choosing saved card to proceed payment

TnC

Object

O

Customize TnC section setting

showTnC

boolean

O

To indicate if TnC is displayed.
Value:trueor false
Default value: false

mode

boolean

O

Value for how user accepting TnC.
checkbox: User to tick a checkbox to accept TnC
click2accept: User click payment button to default accepting TnC
Default value: click2accept

url

String

O

Mandatory field whenshowTnC is true.
The url of TnC merchant request to display

appearance

Object

O

Customize Drop-in appearance. For the illustration of the uiOption effect, please refer to Drop-in Customization Reference

colorAction

String

O

Checkbox or clickable button color, hex code (e.g., #5E48FC)

colorBackground

String

O

Drop-in background color, hex code

colorBoxStroke

String

O

Border/line color, hex code

colorDisabled

String

O

Disabled button color, hex code

colorError

String

O

Error border and text color, hex code

colorFormBackground

String

O

Input background color, hex code

colorFormBorder

String

O

Input border color, hex code

colorInverse

String

O

Button text color, hex code

colorBoxFillingOutline

String

O

Input border when selected, hex code

colorPlaceholder

String

O

Input placeholder color, hex code

colorPrimary

String

O

Primary font color, hex code

colorSecondary

String

O

Secondary font color, hex code

button/font

Object

O

Button font style

heading/font

Object

O

Heading font style

subHeading/font

Object

O

Subheading font style

headingPopup/font

Object

O

Popup heading font style

label/font

Object

O

Label font style

labelInfo/font

Object

O

Label info font style

labelPopup/font

Object

O

Popup label font style

inputField/font

Object

O

Input field font style

inputFieldInfo/font

Object

O

Input field info font style

inputFieldPopup/font

Object

O

Input field popup font style

paragraph/font

Object

O

Paragraph font style

placeholder/font

Object

O

Input placeholder font style

borderRadius

Array

O

Page corner radius [radius1, radius2, radius3, radius4]

logoPosition

String

O

Merchant logo position: left, middle, right. Default: left