引言
随着在线支付的普及,越来越多的公司和组织需要为客户提供方便快捷的在线支付服务。GoCardless 是一个适用于收取重复性付款的全球支付平台,它支持多种付款方式,包括直接借记、信用卡等。
GoCardless 提供了一套简洁易用的 API,用于实现与其平台进行交互。本文我们将介绍 npm 包 gocardless-api,它是 GoCardless APIs 的 JavaScript 实现。
在本文中,我们将为读者提供详尽的使用教程,同时带有示例代码和深度的解读,希望能够对想要使用 gocardless-api 包的前端开发者提供有益的帮助和指导。
安装
使用本 npm 包之前,需要先在终端中使用 npm 安装。
$ npm install gocardless-api --save
使用
安装完成后,你可以引入它并使用它来与 GoCardless 平台进行交互。下面我们将详细介绍 gocardless-api 包的语法和使用方法。
初始化
要使用 gocardless-api 包,首先需要创建一个 GoCardless 实例。在创建 GoCardless 实例的时候,你需要设置你自己的 GoCardless API 密钥。
const GoCardless = require('gocardless-api'); const gc = new GoCardless({ accessToken: "your_access_token_here", environment: "sandbox" });
在这里,我们在创建 GoCardless 实例时提供了 API 密钥和环境。如果你需要连接 GoCardless 的开发环境(即使用 GoCardless 测试服务器),则需要将 environment 设置为 "sandbox"。如果你想连接生产环境,则将 environment 设置为 "live"。
创建支付订阅
在创建支付订阅之前,你需要先构建一个客户对象,用于向 GoCardless servers 注册新的客户。
-- -------------------- ---- ------- --------------------- ------- - ------ --------------------- ----------- --------- ------------ ------- - ---------------- -- - ---------------------- ---展开代码
在这里,我们调用了 GoCardless 的 customers.create 方法来创建新的客户。其中,我们提供了客户的姓名、电子邮件地址等信息。该方法返回一个 Promise 对象,我们可以通过 then 方法来读取其返回值。在返回值中,我们将会看到新客户的 ID 和其他属性。
接下来,我们可以根据创建的客户信息构建一个先前确定好的支付金额,并创建新的支付订阅。
-- -------------------- ---- ------- ------------------------- ------- - ------- -------- --------- ------ -------------- ---------- ------------- -- ------ - -------- --------------------- - - ---------------- -- - ---------------------- ---展开代码
在这里,我们使用 subscriptions.create 方法创建了一个新的支付订阅。其中的 day_of_month 属性表示每月发生交易的日期。该方法返回一个 Promise 对象,可以通过 then 方法来读取其返回值。
获取支付订阅信息
在收到客户的订阅后,我们可以使用 subscriptions.read 方法来获取该订阅的详细信息。
gc.subscriptions.read({ subscriptionId: "<subscription_id_here>" }).then(response => { console.log(response); });
在这里,我们使用 subscriptions.read 方法读取订阅的详细信息。这一步需要提供订阅的 ID。
取消支付订阅
当客户不需要支付订阅时,我们可以使用 subscriptions.cancel 方法来取消订阅。
gc.subscriptions.cancel({ subscriptionId: "<subscription_id_here>", data: { "cancel_reason": "Your reason for cancelling the subscription" } }).then(response => { console.log(response); });
在这里,我们使用了 subscriptions.cancel 方法来取消订阅。我们需要提供订阅的 ID 和取消订阅的原因。该方法返回一个 Promise 对象,我们可以通过 then 方法读取其返回值。
结论
本文介绍了使用 gocardless-api 包来实现与 GoCardless 平台进行交互的详细步骤。通过阅读本文,读者可以了解到如何使用 gocardless-api 包来创建新的客户、支付订阅、获取支付订阅信息,并取消支付订阅。同时,我们也提供了示例代码和深度的解读,希望对前端开发者在实际开发应用中有所帮助。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/60055c3a81e8991b448d9d72