SDK Parameter Reference
Options
| Option | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | 挂载的 DOM 元素 ID |
| sessionID | string | Yes | 取 LinkPay 接口返回的 sessionID |
| locale | string | No | Drop-in 显示的语言 例： en-US |
| environment | string | Yes | 设置 Drop-in 应指向并发送请求的环境 枚举值： HKG_prod BKK_prod TYO_prod UAT TEST |
| mode | string | Yes | 设置 Drop-in UI 展示模式 枚举值： fullPage embedded |
| uiOption | object | No | 接入方可以通过本字段定义 Drop-in 页面中的元素展示 |
| appearance | object | No | 接入方可以通过本字段定义 Drop-in 的 UI 样式 |
uiOption object
| Option | Type | Required | Description |
|---|---|---|---|
| card | object | No | 卡支付相关元素的控制 |
| TnC | object | No | TnC 相关元素的控制 |
| showSaveImage | boolean | No | 控制 Drop-in 页面上是否展示 save 支付方式（便利店支付等）详情的按钮 如果不传，默认为 false 表示不展示 |
| hidePaymentButton | boolean | No | 控制 Drop-in 页面上是否隐藏支付按钮 如果不传，默认为 false 表示不展示。在传 ture 的情况下，则会默认隐藏 Google Pay 支付方式。 当隐藏支付按钮后，商户页面需要自行构建支付按钮，并通过 sdk.pay() 方法触发支付流程 |
| paging | boolean | No | 控制 Drop-in 中 personal details 和 purchase summary 是否在同一页展示 如果不传，默认为 false 表示不分页 |
card object
| Option | Type | Required | Description |
|---|---|---|---|
| showCardHolderName | boolean | No | 控制页面上是否收集持卡人姓名输入框，不传默认为 false，表示不展示持卡人姓名输入框 |
| CVVForSavedCard | boolean | No | 控制页面上是否在使用 Saved card 支付时是否还需要输入 CVV，不传默认为 false，表示不需要输入 CVV |
TnC object
| Option | Type | Required | Description |
|---|---|---|---|
| showTnC | boolean | No | 控制页面上是否展示 TnC 如果不传，默认为 false 不展示 TnC |
| mode | boolean | No | 控制页面上如何展示 TnC 枚举值： checkbox：TnC 前展示 checkboxclick2accept：TnC 前没有 checkbox，点击 Pay 按钮即表示接受 TnC默认值： click2accept |
| url | string | conditional | 商户提供的 TnC 的页面地址，当 displayTnC = true 时必填 |
appearance object
| Option | Type | Required | Description |
|---|---|---|---|
| colorAction | string | No | Checkbox选中或按钮可点击的状态的颜色，具体关联的 UI 见设计图 十六进制颜色码，例如：#5E48FC |
| colorBackground | string | No | 整个 Drop-in 的背景颜色，具体关联的 UI 见设计图 十六进制颜色码，例如：#5E48FC |
| colorBoxStroke | string | No | 边框、分割线颜色，具体关联的 UI 见设计图 十六进制颜色码，例如：#5E48FC |
| colorDisabled | string | No | 按钮不可点击时的颜色颜色，具体关联的 UI 见设计图 十六进制颜色码，例如：#5E48FC |
| colorError | string | No | Checkbox, 输入框报错的时边框以及 error 提示文字的颜色，具体关联的 UI 见设计图 十六进制颜色码，例如：#5E48FC |
| colorFormBackground | string | No | Checkbox, 输入框的背景色，具体关联的 UI 见设计图 十六进制颜色码，例如：#5E48FC |
| colorFormBorder | string | No | 输入框的边框颜色，具体关联的 UI 见设计图 十六进制颜色码，例如：#5E48FC |
| colorInverse | string | No | 按钮中文字的颜色，具体关联的 UI 见设计图 十六进制颜色码，例如：#5E48FC |
| colorBoxFillingOutline | string | No | 输入框的边框选状态下的颜色，具体关联的 UI 见设计图 十六进制颜色码，例如：#5E48FC |
| colorPlaceholder | string | No | 输入框占位符的颜色，具体关联的 UI 见设计图 十六进制颜色码，例如：#5E48FC |
| colorPrimary | string | No | 主字体颜色，具体关联的 UI 见设计图 十六进制颜色码，例如：#5E48FC |
| colorSecondary | string | No | 副字体颜色，具体关联的 UI 见设计图 十六进制颜色码，例如：#5E48FC |
| button | font object | No | 控制按钮样式，具体关联的 UI 见设计图 |
| heading | font object | No | 控制标题样式，具体关联的 UI 见设计图 |
| subHeading | font object | No | 控制父标题样式，具体关联的 UI 见设计图 |
| headingPopup | font object | No | 控制弹出窗口的标题样式，具体关联的 UI 见设计图 |
| label | font object | No | 控制标签样式，具体关联的 UI 见设计图 |
| labelInfo | font object | No | 控制文字标题样式，具体关联的 UI 见设计图 |
| labelPopup | font object | No | 控制弹窗中文字标题样式，具体关联的 UI 见设计图 |
| inputField | font object | No | 控制文本框中文字样式，具体关联的 UI 见设计图 |
| inputFieldInfo | font object | No | 控制文字样式，具体关联的 UI 见设计图 |
| inputFieldPopup | font object | No | 控制弹窗中文字样式，具体关联的 UI 见设计图 |
| paragraph | font object | No | 控制注脚样式，具体关联的 UI 见设计图 |
| placeholder | font object | No | 控制文本框中占位符样式，具体关联的 UI 见设计图 |
| borderRadius | array | No | 控制页面圆角大小，具体关联的 UI 见设计图 ["4px", "8px", "10px", "8px"] 以上四个数据分别表示 borderRadius 1 borderRadius 2 borderRadius 3 borderRadius 4 |
| logoPosition | string | No | 控制商户logo位置，具体关联的 UI 见设计图 枚举值： left middle right |
font Object
| Option | Type | Required | Description |
|---|---|---|---|
| fontFamily | string | Yes | 字体 例： -apple-system, BlinkMacSystemFont, 'Segoe UI', Arial, sans-serif |
| fontSize | string | Yes | 字体大小 例： 16px |
| fontWeight | string | Yes | 字体粗细 例： 400 |
| letterSpacing | string | Yes | 字间距 例： 0.3px |
| lineHeight | string | Yes | 行高 例： 1.5 |
Event
Drop-in 通过向接入方页面发送事件消息来响应命令。发出命令的客户端监听事件消息。
payment_completed
当用户在 Drop-in 中完成支付并且支付结果为成功时返回此 event
| Option | Type | Required | Description |
|---|---|---|---|
| type | string | Yes | 固定值 payment_completed |
| sessionID | string | Yes | 同调用 Drop-in 时的 sessionID |
| merchantTransID | string | Yes | 交易订单号，可以使用 GET Payment API 查询详情 |
| econtext | object | No | Coming Soon |
payment_failed
当用户在 Drop-in 中完成支付但是支付结果为失败时返回此 event
| Option | Type | Required | Description |
|---|---|---|---|
| type | string | Yes | 固定值 payment_failed |
| sessionID | string | Yes | 同调用 Drop-in 时的 sessionID |
| merchantTransID | string | Yes | 交易订单号，可以使用 GET Payment API 查询详情 |
| code | string | No | 支付失败是联机返回的应答码 |
| message | string | No | 支付失败是联机返回的应答内容 |
payment_not_preformed
在商户页面调用 Drop-in 时发生错误返回此 event。例如 payment command 中 sessionID 不存在或错误。
| Option | Type | Required | Description |
|---|---|---|---|
| type | string | Yes | 固定值 payment_failed |
| sessionID | string | Yes | 同调用 Drop-in 时的 sessionID |
| code | string | No | 应答码见下方表格 |
| message | string | No | 应答码见下方表格 |
Response Codes
| 错误场景 | 应答码 | message |
|---|---|---|
| 字段长度格式错误 | V0000 | field {} invalid format |
| 必送字段没传 | V0001 | field {} absent or empty |
| 字段枚举值错误 | V0002 | field {} invalid value |
| Session ID 不存在 | B2001 | Session ID not found |
| Session ID 存在但是订单已经支付成功 | B2002 | Order has been paid |
| Session ID 存在但是订单已经过期 | B2003 | Order closed |
| 其他错误 | B2004 | Payment error |
| 当前订单没有可用的支付方式 | B2005 | No available payment method |
| 支付失败 | B2006 | Payment failed |
payment_cancelled
当用户在 Drop-in 中主动终止支付流程退出 Drop-in 时返回此 event
| Option | Type | Required | Description |
|---|---|---|---|
| type | string | Yes | 固定值 payment_cancelled |
| sessionID | string | Yes | 同调用 Drop-in 时的 sessionID |
order_created
需要注意的是，order_created 事件并不代表这支付成功，只表示下单成功。
当用户选择了需要异步完成支付的支付方式后（例如便利店支付），并在支付信息展示页中点击 “完成” 按钮后，Drop-in 将向商户页面返回 order_created 事件，同时将 econtext（便利店支付信息）一并返回给商户页面，此时商户可以选择关闭 Drop-in 然后将支付信息展示在自己的页面中，并使用 GET Payment 查询用户支付结果。
如果商户在收到 order_created 事件后没有选择关闭 Drop-in，Drop-in 将持续查询当前订单的支付结果，当查询到最终的结果后，将向商户页面返回 payment_failed 或 payment_completed 事件。
| Option | Type | Required | Description |
|---|---|---|---|
| type | string | Yes | 固定值 order_created |
| sessionID | string | Yes | 同 payment command 中的 sessionID |
| merchantTransID | string | Yes | 交易订单号，用户后续查询订单详情 |
| econtext | object | Yes | 需要展示支付信息独立支付的支付方式时返回 |
econtext
| Option | Type | Required | Description |
|---|---|---|---|
| paymentBrand | string | Yes | 支付品牌 |
| confirmationCode | string(32) | No | The confirmation number that merchant needs to diplay on payment page for user to complete the subsequent payment process at convenience stores. |
| paymentCode | string(32) | No | A number customers that merchant needs to diplay on payment page for user to complete the follow-up payment process at convenience stores. |
| customerFee | string(32) | No | Additional fee charged to users for specific payment brands. |
| orderID | string(24) | No | Remitters/payers name that merchant needs to display on payment page for user to send money as. |
| bankName | string(300) | No | The name of the bank of receving account that merchant needs to display on payment page for user to wire funds. |
| accountBranchName | string(300) | No | The account branch name of receving account that merchant needs to display on payment page for user to wire funds. |
| accountBranchCode | string(24) | No | The account branch code of receving account that merchant needs to display on payment page for user to wire funds. |
| accountNumber | string(32) | No | The account number of receving account that merchant needs to display on payment page for user to wire funds. |
| accountType | string(12) | No | The account type of receving account that merchant needs to display on payment page for user to wire funds. |
| accountName | string(300) | No | The account name of receving account that merchant needs to display on payment page for user to wire funds. |
| bankID | string(32) | No | The institution of receving account that merchant needs to display on payment page for user to complete the follow-up payment process via PayEasy. |
| customerID | string(32) | No | The customer number of receving account that merchant needs to display on payment page for user to complete the follow-up payment process via PayEasy. |
| expiryDate | datetime | No | The payment due date by which user must complete the follow-up payment process. Format: ISO 8601 YYYY-MM-DDThh:mm:ssTZD |
| instructionURL | string(300) | No | A URL for an instructions page that merchant needs to display it on payment page to guide users. |
