42分基数
节点.js API抽象支付网关.
由列表中支持的网关使用 42美分(42%)。 。 。 .
语义版本
需要注意的是,BaseGateway API将遵循语义版本规则,这样:
- 已定义属性的任何更改将定义一个新的 API, 从而导致 BaseGateway 版本的首位数不同
- 新的支持参数/方法将定义一个新的功能,因此将得出BaseGateway版本的第二位数
- Bug 修正/ patches 不应影响网关执行, 并将导致 BaseGateway 版本的第三个位数
BaseGateway API 页面存档备份,存于互联网档案馆
basegateway()basegateway#submitTransaction()basegateway#authorizeTransaction()basegateway#getSettledBatchList()basegateway#refundTransaction()basegateway#voidTransaction()basegateway#createSubscription()basegateway#createCustomerProfile()basegateway#getCustomerProfile()basegateway#chargeCustomer()
基门道( 选项)
basegateway# 提交交易( 订单、 信用卡、 前景 [, 其他])
授权并获取交易.
parameters
order (标 题)
'amount'(弦声):交易金额.
'creditCard' (标 题)
'creditCardNumber'(弦声):信用卡(PAN)号码.'expirationMonth'(弦声):信用卡到期月份.'expirationYear'(弦声):信用卡到期年份(2或4位数字).'cvv'(弦声):信用卡安全码(3或4位数字).
prospect (标 题)
'customerFirstName'(弦声):客户名(也用于计费).'customerLastName'(弦声):客户的姓氏(也用于记帐).'customerEmail'(弦声):客户的电子邮件.'billingAddress'(弦声):账单地址.'billingCity'(弦声): 比林市'billingState'(弦声): 计费州'billingZip'(弦声): 计费'billingCountry'(弦声): 计费国'shippingFirstName'(弦声)数字 :'shippingLastName'(弦声)数字 :'shippingAddress'(弦声)数字 :'shippingCity'(弦声)数字 :'shippingState'(弦声)数字 :'shippingZip'(弦声)数字 :'shippingCountry'(弦声)数字 :
other (标 题)
网关 SDK 执行中特有的其它字段.
详情请参考具体的SDK.
return value
回返a Promise 因而也带有下列对象:
'transactionId'(弦声):交易的独特标识符.'authCode'(弦声): 银行机构的授权代码.'_original':来自网关的原始回应.
如果承诺因为网关而被拒绝, 原因是 object gatewayError 有下列属性的例子 :
'message'(弦声): 来自网关的错误消息 .'_original': Sdk具体执行的原始回应.
否则,这将是一个例子 Error。 。 。 .
basegateway# 授权交易( 订单、 信用卡、 前景[, 其他])
收买一笔交易.
parameters
见 basegateway#submitTransaction()。 。 。 .
basegateway# getsSettledBatchList(从,到)
获取时间窗口内已结算交易的批次列表
parameters
from (日期): 下限.
to (日期, 默认值 : Date.now()(中文(简体) ): 上限.
return value
回返a Promise 因而也带有下列对象:
'batchList'(箭头): 一组批次,其中批次有以下字段.'batchId':批次的id通过网关内部系统引用.'settlementDate'(弦声): 结算日期时间(UTC)的字符串.'chargeAmount'(弦声): 时间窗口内收取的交易总额.'chargeCount'(弦声): 时间窗口内收费交易的总计分.'refundAmount'(弦声): 时间窗口内退款交易的总额.'refundCount'(弦声): 时间之窗内退款交易总数.'voidCount'(弦声): 时间窗口内已作废的交易总数.'declineCount'(弦声): 时间窗口内已作废的交易总数.'errorCount'(弦声): 时间窗口内已作废的交易总数.
basegateway# 退款交易( 交易集, 选项)
退款(或信贷)一项已结算的交易.
parameters
transactionId (弦声): ID 引用交易在网关退款.
options (标 题): 一组可选字段.
'amount':应退还的金额(用于部分退款).
return value
回返a Promise 因而也带有下列对象:
'_original':来自网关的原始回应.
如果承诺因为网关而被拒绝, 原因是 object gatewayError 有下列属性的例子 :
'message'(弦声): 来自网关的错误消息 .'_original': Sdk具体执行的原始回应.
否则,这将是一个例子 Error。 。 。 .
basegateway#void 交易( 交易集 [, 选项])
进行非固定交易.
parameters
transactionId (弦声): id引用交易在网关上无效.
options (标 题): 一组可选字段.
return value
回返a Promise 因而也带有下列对象:
'_original':来自网关的原始回应.
如果承诺因为网关而被拒绝, 原因是 object gatewayError 有下列属性的例子 :
'message'(弦声): 来自网关的错误消息 .'_original': Sdk具体执行的原始回应.
否则,这将是一个例子 Error。 。 。 .
basegateway# 创建订阅(信用卡、 前景、 订阅) 计划[,其他]
创建一个经常性的付款.
parameters
信用卡: CreditCard QQ对象,与支付相关的信用卡
前景: Prospect QQ对象,与订阅相关的前景/客户
订阅计划: 订阅计划 QQ对象,订阅计划 注意:Tuple[周期单位],周期Length]必须产生一个有网关执行支持的时期,否则,单位应优先使用
其他项目: Object, 一组供特定执行使用的选项
return value
回返a Promise 因而也带有下列对象:
'subscriptionId': 网关上的订阅标识.'_original':来自网关的原始回应.
basegateway# createCustomer Profile(付款、计费、航运、其他)
在网关中创建客户简介,对客户收取费用有用,而无需再次提供其支付方法信息.
parameters
付款: 信用卡QQ对象,支付信息与客户关联
账单: 对象,与客户联系的账单信息
航运: 与客户有联系的物品、运输信息
其他项目: 对象, 与特定网关执行相关的可选信息
return value
回返a Promise 因而也带有下列对象:
'profileId': 客户简介的参考ID.'_original':来自支付网关的原始回应.
基础门道# getCustomeProfile( profileId)
获取先前保存的客户简介 .
parameters
profileId (弦声): ID在网关中引用客户简介.
return value
回返a Promise 因而也带有下列对象:
如果解决了这个承诺,那么这个字段与前景实例加字段相同 payment 持有信用卡
基口道# 充电库( 顺序, 前景 [, 其他])
使用客户简介提交交易(授权和抓取).
parameters
顺序: 对象,命令信息
前景: 前景简介,要收费的前景简介,注意前景必须有外地简介Id设定
其他项目: 对象, 与特定网关执行相关的可选信息
return value
见 basegateway#submitTransaction()。 。 。 .