建議使用 Node.js 套件管理工具 npm 安裝。
$ npm install allpay
安裝完畢後,你可以使用 require
載入套件:
var Allpay = require('allpay');
var allpay = new Allpay({
merchantID: 'YOUR_MERCHANT_ID',
hashKey: 'YOUR_HASH_KEY',
hashIV: 'YOUR_HASH_IV',
debug: false
});
merchantID
:必填,廠商編號(由 AllPay 提供)。
hashKey
:必填,全方位金流介接的 HashKey。
hashIV
:必填,全方位金流介接的 HashIV。
debug
:選填,設為 true 可查看除錯訊息(預設為 false)。
allpay.setHost({
baseUrl: 'payment-stage.allpay.com.tw',
port: 80,
useSSL: false
});
baseUrl
:選填,介接網址(預設為 payment.allpay.com.tw)。
port
:選填,連接埠(預設為 443)。
useSSL
:選填,使用 SSL 連線(預設為 true)。
- allpay.queryTradeInfo(
options
,callback
)
- allpay.queryPeriodCreditCardTradeInfo(
options
,callback
)
- allpay.creditDetailDoAction(
options
,callback
)
- allpay.aioChargeback(
options
,callback
)
allpay.queryTradeInfo(options, callback)
options.
MerchantTradeNo
:必填,廠商交易編號,如:Allpay20141209001
。options.
PlatformID
:選填,特約合作平台商代號(由 AllPay 提供)。options.
CheckMacValue
: 選填,交易檢查碼,未填寫則由程式自動產生。
allpay.queryPeriodCreditCardTradeInfo(options, callback)
options.
MerchantTradeNo
:必填,廠商交易編號,如:Allpay20141209001
。options.
CheckMacValue
: 選填,交易檢查碼,未填寫則由程式自動產生。
allpay.queryPeriodCreditCardTradeInfo(options, callback)
options.
MerchantTradeNo
:必填,廠商交易編號,如:Allpay20141209001
。options.
TradeNo
: 必填,AllPay 的交易編號,如:1234567890
。options.
Action
: 必填,執行動作,如:C
。options.
TotalAmount
: 必填,金額,如:1500
。options.
PlatformID
:選填,特約合作平台商代號(由 AllPay 提供)。options.
CheckMacValue
: 選填,交易檢查碼,未填寫則由程式自動產生。
allpay.aioChargeback(options, callback)
options.
MerchantTradeNo
:必填,廠商交易編號,如:Allpay20141209001
。options.
TradeNo
: 必填,AllPay 的交易編號,如:1234567890
。options.
ChargeBackTotalAmount
: 必填,退款金額,如:150
。options.
Remark
: 選填,備註欄位。options.
PlatformID
:選填,特約合作平台商代號(由 AllPay 提供)。options.
CheckMacValue
: 選填,交易檢查碼,未填寫則由程式自動產生。
Callback 會返回 2 個參數,分別為 error 和一個 JSON 物件。
以下為範例 callback 函數:
function callback (err, response) {
if (err) {
console.log(err);
} else {
console.dir(response);
}
}
詳細參數說明請參閱全方位金流介接技術文件。
MIT