authorize
概述
封装了authorize的EMV交易
authorizeRegister(仅iOS支持)
注册接口
authorizeRegister({params})
params
username:
- 类型:字符串
- 描述:用户名
password:
- 类型:字符串
- 描述:密码
mobileDeviceId:
- 类型:字符串
- 描述:设备ID
示例代码
var authorize = api.require('authorize');
authorize.authorizeRegister({
username: '',
password: '',
mobileDeviceId: ''
});
可用性
iOS系统
可提供的 1.0.0 及更高版本
login
登录接口(仅iOS支持)
login({params})
params
username:
- 类型:字符串
- 描述:用户名
password:
- 类型:字符串
- 描述:密码
mobileDeviceId:
- 类型:字符串
- 描述:设备ID
示例代码
var authorize = api.require('authorize');
authorize.login({
username: '',
password: '',
mobileDeviceId:''
});
可用性
iOS系统
可提供的 1.0.0 及更高版本
logout
退出登录(仅iOS支持)
logout({params})
params
sessionToken:
- 类型:字符串
- 描述:令牌
mobileDeviceId:
- 类型:字符串
- 描述:设备ID
示例代码
var authorize = api.require('authorize');
authorize.logout({
sessionToken: '',
mobileDeviceId: ''
});
可用性
iOS系统
addAuthNetListener
添加authNet监听(仅iOS支持)
addAuthNetListener(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
state: 'emvPaymentSucceeded' //字符串类型;返回事件,取值范围如下:
//emvPaymentSucceeded
//paymentSucceeded
//requestFailed
//connectionFailed
//getBatchStatisticsSucceeded
//getSettledBatchListSucceeded
//getTransactionDetailsSucceeded
//getTransactionListSucceeded
//getUnsettledTransactionListSucceeded
//sendCustomerTransactionReceiptSucceeded
//getMerchantDetailsResponseSucceeded
//mobileDeviceLoginSucceeded
//captchaImageSucceeded
//createCustomerProfileTransactionSucceeded
//updateCustomerProfileSucceeded
//createCustomerPaymentProfileSucceeded
//updateCustomerPaymentProfileSucceeded
//getCustomerProfileSucceeded
//getCustomerPaymentProfileSucceeded
//testAccountRegistrationSucceeded
//mobileDeviceRegistrationSucceeded
//logoutSucceeded
sessionToken:'', //字符串类型:sessionToken,mobileDeviceLoginSucceeded事件返回
}
示例代码
var authorize = api.require('authorize');
authorize.addAuthNetListener(function(ret) {
alert(JSON.stringify(ret));
});
可用性
iOS系统
可提供的1.0.0及更高版本
initAnetEMVManager
初始化EMV交易(仅iOS支持)
initAnetEMVManager({params})
params
currecyCode:
- 类型:字符串
- 描述:三位数的货币代码,如“840”美元
terminalID:
- 类型:字符串
- 描述:商人ternimal ID
skipSignature:
- 类型:布尔
- 描述:(可选项)是否跳过签名
- 默认:true
showReceipt:
- 类型:布尔
- 描述:(可选项)showReceipt
- 默认:是否显示收据
示例代码
var authorize = api.require('authorize');
authorize.initAnetEMVManager({
currecyCode: '',
terminalID: ''
});
可用性
iOS系统
initAnetEMVTransactionRequest
初始化EMV交易请求(仅iOS支持)
initAnetEMVTransactionRequest({params})
params
emvTransactionType:
- 类型:数字
- 描述:(可选项)EMV交易类型
- 取值范围:
- 0:goods
- 1:services
- 2:cashback
- 3:inquiry
- 4:transfer
- 5:payment
- 6:refund
- 默认:0
lineItems:
- 类型:json数组类型
- 描述:lineItems
- 内部字段:
{
[{
itemName:'',
itemTaxable:'',
itemQuantity:'',
itemID:'',
itemDescription:'',
itemPrice:''
}]
}
sessionToken:
- 类型:字符串
- 描述:令牌
mobileDeviceId:
- 类型:字符串
- 描述:设备ID
amount:
- 类型:字符串
- 描述:amount
invoiceNumber:
- 类型:字符串
- 描述:invoiceNumber
orderDescription:
- 类型:字符串
- 描述:orderDescription
marketType:
- 类型:字符串
- 描述:marketType
deviceType:
- 类型:字符串
- 描述:deviceType
employeeId:
- 类型:字符串
- 描述:employeeId
示例代码
var authorize = api.require('authorize');
authorize.initAnetEMVTransactionRequest({
lineItems: [{}],
sessionToken: '',
mobileDeviceId: '',
amount: '',
invoiceNumber: '',
orderDescription: '',
marketType: '',
deviceType: '',
employeeId: ''
});
可用性
iOS系统
setConnectionMode
设置连接模式(仅iOS支持)
setConnectionMode({params})
params
connectionMode:
- 类型:数字
- 描述:连接模式
- 取值范围:
- 0:audio
- 1:bluetooth
示例代码
var authorize = api.require('authorize');
authorize.setConnectionMode({
connectionMode: 0
});
可用性
iOS系统
resetEMVManager
重置EMVManager(仅iOS支持)
resetEMVManager()
示例代码
var authorize = api.require('authorize');
authorize.resetEMVManager();
可用性
iOS系统
getMerchantDetails
获取商家详细信息(仅iOS支持)
getMerchantDetails({params})
params
sessionToken:
- 类型:字符串
- 描述:令牌
mobileDeviceId:
- 类型:字符串
- 描述:设备ID
示例代码
var authorize = api.require('authorize');
authorize.getMerchantDetails({
sessionToken: '',
mobileDeviceId: ''
});
可用性
iOS系统
emvTransaction
EMV 交易(在initAnetEMVTransactionRequest之后调用该接口)(仅iOS支持)
emvTransaction(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, //字符串类型;交易状态,取值范围:
//succeed:成功
//fail:失败
//cancel:取消
sessionToken: //字符串类型;令牌,status == succeed时返回
}
示例代码
var authorize = api.require('authorize');
authorize.emvTransaction(function(ret) {
api.alert({ msg:JSON.stringify(ret)});
});
可用性
iOS系统
可提供的 1.0.0 及更高版本
readQuickChipCard
启动快速卡片交易(仅iOS支持)
readQuickChipCard({params},callback(ret))
params
emvTransactionType:
- 类型:数字
- 描述:(可选项)EMV交易类型
- 取值范围:
- 0:goods
- 1:services
- 2:cashback
- 3:inquiry
- 4:transfer
- 5:payment
- 6:refund
- 默认:0
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, //布尔类型;是否成功,true|false
progress: 0 //数字类型;交易进度,取值范围:
//0:waitingForCard
//1:retryInsertOrSwipe
//2:swipeOrTryAnotherCard
//3:swipe
//4:processingCard
//5:doneWithCard
}
示例代码
var authorize = api.require('authorize');
authorize.readQuickChipCard({
emvTransactionType:0
},function(ret,err){
api.alert({ msg:JSON.stringify(ret)});
});
可用性
iOS系统
可提供的 1.0.0 及更高版本
discardQuickChipCard
丢弃以前处理过的卡片数据(仅iOS支持)
discardQuickChipCard(callback(ret))
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, //布尔类型;是否成功,true|false
}
示例代码
var authorize = api.require('authorize');
authorize.discardQuickChipCard(function(ret,err){
api.alert({ msg:JSON.stringify(ret)});
});
可用性
iOS系统
startQuickChip
开始快速芯片交易(在initAnetEMVTransactionRequest之后调用该接口)(仅iOS支持)
startQuickChip({params},callback(ret))
params
paperReceipt:
- 类型:布尔类型
- 描述:(可选项)是否需要纸质收据
- 默认:true
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, //字符串类型;交易状态,取值范围:
//succeed:成功
//fail:失败
//cancel:取消
sessionToken: //字符串类型;令牌,status == succeed时返回
}
示例代码
var authorize = api.require('authorize');
authorize.startQuickChip({
paperReceipt:true
},function(ret) {
api.alert({ msg:JSON.stringify(ret)});
});
可用性
iOS系统
可提供的 1.0.0 及更高版本
startQuickChipWithTipAmount
带小费金额的快速筹码交易(在initAnetEMVTransactionRequest之后调用该接口)(仅iOS支持)
startQuickChipWithTipAmount({params},callback(ret))
params
tipAmount:
- 类型:字符串
- 描述:tipAmount
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, //字符串类型;交易状态,取值范围:
//succeed:成功
//fail:失败
//cancel:取消
sessionToken: //字符串类型;令牌,status == succeed时返回
}
示例代码
var authorize = api.require('authorize');
authorize.startQuickChipWithTipAmount({
tipAmount:''
},function(ret) {
api.alert({ msg:JSON.stringify(ret)});
});
可用性
iOS系统
可提供的 1.0.0 及更高版本
startQuickChipWithTipOptions
带有提示选项的快速筹码交易(在initAnetEMVTransactionRequest之后调用该接口)(仅iOS支持)
startQuickChipWithTipOptions({params},callback(ret))
params
tipOptions:
- 类型:字符串数组
- 描述:tipOptions
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, //字符串类型;交易状态,取值范围:
//succeed:成功
//fail:失败
//cancel:取消
sessionToken: //字符串类型;令牌,status == succeed时返回
}
示例代码
var authorize = api.require('authorize');
authorize.startQuickChipWithTipOptions({
tipOptions:['']
},function(ret) {
api.alert({ msg:JSON.stringify(ret)});
});
可用性
iOS系统
可提供的 1.0.0 及更高版本
createCustomerProfile
创建客户资料并通过EMV请求启动快速筹码交易(在initAnetEMVTransactionRequest之后调用该接口)(仅iOS支持)
createCustomerProfile({params},callback(ret))
params
paperReceipt:
- 类型:布尔类型
- 描述:(可选项)是否需要纸质收据
- 默认:true
isConsentBefore:
- 类型:布尔类型
- 描述:(可选项)iConsentBefore
- 默认:true
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, //字符串类型;交易状态,取值范围:
//succeed:成功
//fail:失败
//cancel:取消
sessionToken: //字符串类型;令牌,status == succeed时返回
}
示例代码
var authorize = api.require('authorize');
authorize.createCustomerProfile({
paperReceipt:true,
isConsentBefore:true
},function(ret) {
api.alert({ msg:JSON.stringify(ret)});
});
可用性
iOS系统
可提供的 1.0.0 及更高版本
createAdditionalPaymentProfile
创建附加付款资料并通过EMV请求启动快速筹码交易(在initAnetEMVTransactionRequest之后调用该接口)(仅iOS支持)
createAdditionalPaymentProfile({params},callback(ret))
params
paperReceipt:
- 类型:布尔类型
- 描述:(可选项)是否需要纸质收据
- 默认:true
isConsentBefore:
- 类型:布尔类型
- 描述:(可选项)iConsentBefore
- 默认:true
profileID:
- 类型:字符串类型
- 描述:iProfileID
callback(ret)
ret:
- 类型:JSON 对象
- 内部字段:
{
status: true, //字符串类型;交易状态,取值范围:
//succeed:成功
//fail:失败
//cancel:取消
sessionToken: //字符串类型;令牌,status == succeed时返回
}
示例代码
var authorize = api.require('authorize');
authorize.createAdditionalPaymentProfile({
paperReceipt:true,
isConsentBefore:true
},function(ret) {
api.alert({ msg:JSON.stringify(ret)});
});
可用性
iOS系统,Android系统
可提供的 1.0.0 及更高版本
initAcceptClient
初始化AcceptSDK(仅android支持)
initAcceptClient({params},callback(ret, err))
params
environment:
- 类型:数字类型
- 描述:环境;1:沙盒环境,2:线上环境
- 默认值:1
timeOut:
- 类型:数字类型
- 描述:连接超时时间,ms
- 默认:4000
callback(ret, err)
ret:
- 类型:JSON 对象
- 描述:注册结果
- 内部字段:
{
status: true //布尔类型;是否成功,true|false
}
err:
- 类型:JSON 对象
- 描述:注册结果
- 内部字段:
{
msg: '' //字符串类型;错误信息
}
示例代码
var authorize = api.require('authorize');
authorize.initAcceptClient({
},function(ret, err) {
if (ret.status) {
api.alert({ msg:'成功'});
} else {
api.alert({ msg:JSON.stringify(err)});
}
});
可用性
android系统
可提供的 1.0.0 及更高版本
getTokenWithRequest
获取令牌(仅android支持)
getTokenWithRequest({params},callback(ret, err))
params
loginId:
- 类型:字符串类型
- 描述:商户id
clientKey:
- 类型:字符串类型
- 描述:密钥,密钥获取请查看相关资料
cardNumber:
- 类型:字符串类型
- 描述:卡片账号
expirationMonth:
- 类型:字符串类型
- 描述:截至日期-月
expirationYear:
- 类型:字符串类型
- 描述:截至日期-年
cvv:
- 类型:字符串类型
- 描述:(可选项)信用卡验证号码
callback(ret, err)
ret:
- 类型:JSON 对象
- 描述:注册结果
- 内部字段:
{
status: true //布尔类型;是否成功,true|false
describeContents:, //数字类型;
dataDescriptor:'', //字符串类型;描述
dataValue:'', //字符串类型;数据
}
err:
- 类型:JSON 对象
- 描述:注册结果
- 内部字段:
{
describeContents:, //数字类型;
firstErrorMessage: '' //字符串类型;错误信息
}
示例代码
var authorize = api.require('authorize');
authorize.getTokenWithRequest({
},function(ret, err) {
if (ret.status) {
api.alert({ msg:'成功'});
} else {
api.alert({ msg:JSON.stringify(err)});
}
});
可用性
android系统
可提供的 1.0.0 及更高版本