braspag 是一个基于 Node.js 的支付网关 API 。它提供了一个简单易用的 API ,让开发者可以轻松地与 Brasil Por Pagamentos S.A. 交互。
安装
braspag 可以通过 npm 安装:
npm install braspag --save
使用
在您的文件中引入 braspag :
const braspag = require('braspag');
创建 API 实例
创建一个 braspag API 实例:
const api = new braspag.API({ clientId: 'MY_CLIENT_ID', clientSecret: 'MY_CLIENT_SECRET', merchantId: 'MY_MERCHANT_ID', environment: braspag.ENVIRONMENT.SANDBOX, });
clientId
(String): 给您分配的 API 客户端 IDclientSecret
(String): 给您分配的 API 客户端密钥merchantId
(String): 给您分配的商户 IDenvironment
(String): 指定 API 环境。可选值包括 braspag.ENVIRONMENT.SANDBOX 和 braspag.ENVIRONMENT.PRODUCTION。
创建 Token
在调用任何其他 API 方法之前,您需要获得一个访问令牌。以下是如何使用 getToken()
方法创建访问令牌:
api .getToken() .then((response) => { // Access Token is in response.access_token }) .catch((error) => { // Handle error });
创建支付订单
使用 createSale(data)
方法创建支付订单,data
是一个包含订单信息的对象:
-- -------------------- ---- ------- ----- ---- - - ---------------- ----------- --------- - ----- ---------------- --------- -------------- ------------- ------ ------ ----------------- ---------- --------------------- ------ ----------------- -- -------- - --------- ----------- ----- ------------- ------- ------ --------- ------ ------------- -- -------- ------ ----------- - ----------- ------------------- ------- ------------------- --------------- ---------- ------------- ------ ------ ------- -- -- -- ------------------------------------ -- - ----------------- ---------- ---------- ---
createSale()
方法将返回订单数据。除非您的 Sale 不再是待定的,否则我们建议在您的系统中跟踪 Order Id 以进行后续查询。
查询支付订单
使用 getSale(orderId)
方法查询支付订单:
api.getSale('ORDER_ID').then((response) => { console.log('Sale details:', response); });
如果订单尚未被处理,您会收到一个 pending
状态。如果订单已经成功处理,您会收到表示订单状态的字符串。
取消支付订单
使用 cancelSale(orderId)
取消支付订单:
api.cancelSale('ORDER_ID').then((response) => { console.log('Sale cancelled:', response); });
总结
braspag 是支付网关 API 的第一个版本。希望本文对你学习与使用 braspag 有所帮助。如需更多信息,请参见 braspag 文档。
完整示例代码:
-- -------------------- ---- ------- ----- ------- - ------------------- ----- --- - --- ------------- --------- --------------- ------------- ------------------- ----------- ----------------- ------------ ---------------------------- --- --- ----------- ---------------- -- - ------------------- -------- ----------------------- ----- ---- - - ---------------- ----------- --------- - ----- ---------------- --------- -------------- ------------- ------ ------ ----------------- ---------- --------------------- ------ ----------------- -- -------- - --------- ----------- ----- ------------- ------- ------ --------- ------ ------------- -- -------- ------ ----------- - ----------- ------------------- ------- ------------------- --------------- ---------- ------------- ------ ------ ------- -- -- -- ------------------------------------ -- - ----------------- ---------- ---------- --------------------------------------- -- - ----------------- ---------- ---------- ------------------------------------------ -- - ----------------- ------------ ---------- --- --- --- -- -------------- -- - --------------------- ---
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60066c85ccdc64669dde4ee4