发起付款(账户绑定)
与发起支付请求相同的 Init 合约,外加 saved-card 和 off-session-reuse 字段。
Content-Type: application/json. 初始化身份验证是apiKeyJSON 正文中的字段(不是 Token Charge 标头)。
initRequest参数
参数
类型
是否必须
介绍
country
number
是
ISO 3166 数字国家代码。参见国家和货币代码。
payType
number
是
支付渠道 ID。请使用您分配的卡渠道。0/1渠道选择 / DCB 页面 — 不属于此流程。
apiKey
string
是
来自 Coda 的 API 密钥(入门指南/发布商门户)。
projectId
number
是
仅限 v2.0 版本。项目(标题)ID 来自 Coda。
orderId
string
是
您的唯一订单 ID,4-64 个字符。
currency
number
是
ISO 4217 数字货币代码。
isTaxInclusiveAmount
boolean
不是
v2.0,美国市场,Coda 为 MoR 时适用。是否items[].price已包含税费。默认值false。
items
array
是
分项列出。美国和加拿大:一项。
items[].code
string
不是
您的商品代码。部分渠道(例如台湾Line Pay)必须填写。
items[].price
number
是
价格单位为currency
items[].name
string
是
物品名称。拉丁字母。
items[].skuImageUrl
string
不是
用于结账的公开图片 URL。
profile
object
是
键值对配置文件。
profile.entry
array
是
列表{ key, value }。
enableSavePaymentMethod
boolean
是,用于绑定
显示保存卡并持久化仪器。
displaySavedPaymentMethodList
boolean
可选
在 HPP 上显示之前保存的卡片。通常首次保存时会显示:true或者根据您的用户体验要求省略。
userInitiated
boolean
是,用于绑定
必须true(顾客在场)。
offSessionReuse
boolean
是,用于绑定
必须允许true该卡稍后通过令牌充值方式重复使用。省略或false用于一次性 CIT,该 CIT 不得作为 MIT 重复使用。
offSessionType
string
是,用于绑定
Unscheduled,Subscriptions,Installments
shopper
object
是,用于绑定
用于存储商品的购物者身份信息。请参见下表。
profile.entry键(初始化)
参数
是否必须
介绍
user_id
是
您的用户唯一标识符。
in_frame_redirect
不是
true/ false— iframe 关闭行为
return_url
不是
动态返回 URL。占位符{transactionId},{orderId}。
need_mno_id
不是
如果您需要返回所选频道 ID,请提供任何非空值。
email
不是
如果 Coda 已为您的项目启用收据功能,您将收到收据电子邮件。
client_ip
不是
如果频道需要,则提供购物者 IPv4 地址。
lang_code
不是
语言,例如en_US。参照集成指南
shopper.entry 键(初始化)
id
不是
如果id存在,Coda 会查找该购物者。如果不存在,Coda 会创建一个与该购物者关联的购物者partnerShopperId。
partnerShopperId
是
您的稳定用户 ID(区分大小写)。每次初始化时都使用相同的值。Token Charge 不会发送购物者 ID;Coda 会从中解析购物者paymentMethodId。
email
有条件
通常需要创建购物者。
phoneNumber
不
billingFirstName
有条件
某些市场/购物者创建需要。
billingLastName
有条件
billingDocumentType
有条件
例如 CPF。
billingDocumentId
有条件
与文档类型配对。
billingAddress
不
billingCity
不
billingRegion
不
billingCountry
不
ISO alpha-2,例如US。
billingZipCode
不
如果id存在,Coda 会查找该购物者。如果不存在,Coda 会创建一个与该购物者关联的购物者partnerShopperId。
初始化响应( initResult)
值
类型
介绍
resultCode
integer
0初始化成功。其他值:错误目录。
resultDesc
string
当resultCode不存在时出现0。
txnId
integer
Coda 交易 ID。0如果初始化失败。
redirectUrl
string
托管支付页面 URL。请将客户引导至此页面。
示例 — 首次保存 (CIT-for-MIT)
示例初始化成功
你如何获得paymentMethod.id
保存成功后,Coda 会向您配置的端点发送一个 JSON Webhook。保存paymentMethod.id——即paymentMethodId令牌支付。购物者身份由 Coda 根据支付方式解析;您无需在令牌收费上发送shopper。
PAYMENT_METHOD_ADDED
值
介绍
eventType
PAYMENT_METHOD_ADDED
timestamp
方法保存时
shopper.id
Coda 购物者 ID(保留用于 HPP 返回购物者初始化)
shopper.partner_shopper_id
Your partnerShopperId你的
paymentMethod.id
已保存的卡号 — 令牌收费paymentMethodId
paymentMethod.type
例如 card
paymentMethod.card.lastFour
最后四位数字
paymentMethod.card.expirationMonth
MM
paymentMethod.card.expirationYear
YYYY
返回 HTTP 2xx 响应。非 2xx 响应将重试。请按照已保存卡片通知的文档说明验证通知校验和。
eventType您应该处理的相关值: PAYMENT_METHOD_ADDED,PAYMENT_METHOD_REMOVED。请参阅“保存卡片详细信息”。
回调通知
回调协议与 回调通知详情 相同。当属于账户绑定流程(用于未来离线支付的用户发起交易/CIT)时,将额外包含 PaymentMethodId 字段。
最后更新于
这有帮助吗?