@ 薪金/ 薪金

通过Ariari API为马达加斯加移动货币支付SDK.

仅服务器侧 -  secret 绝对不能在客户端代码中曝光.

安装

yarn add @ariary/pay

拿你的证件

1. 签名于 ariari.mg (意大利语)
2. 创建工程
3. 你会得到一个 secret

设置

import Ariari from '@ariary/pay'

Ariari.config({
  secret: 'your-secret',
})

如何运作

1. 您的服务器创建 付款 数额(以阿里亚斯为单位)
2. 你把终端用户引向返回的 payment.url - ariari.mg上的主页
3. 最终用户通过移动货币将钱寄给阿里耶数字并收到 票号
4. 最终用户在付款页上输入其票号(或你收集票并打电话) .pay() 从后端)
5. 可在 多个步骤 ——应用的每个出票码都是部分付款
6. 全部支付后, 便会呼叫和/ 或重定向用户

创建付款

Ariari.create() 接受以下字段:

// with amount only
const payment = await Ariari.create({ amount: 5000 })
console.log(payment.url) // https://pay.ariari.mg/abc123encrypted

// with product (amount, name, imgUrl resolved automatically)
const payment = await Ariari.create({ productId: product.id })

// with product + override amount
const payment = await Ariari.create({ productId: product.id, amount: 3000 })

// with hooks
const payment = await Ariari.create({
  amount: 10000,
  name: 'T-shirt bleu',
  imgUrl: 'https://example.com/img.png',
  hooks: {
    redirectSuccess: 'https://yoursite.com/payment/success',
    redirectFailure: 'https://yoursite.com/payment/failure',
    silentSuccess: 'https://yoursite.com/api/webhook/payment-success',
    silentProgress: 'https://yoursite.com/api/webhook/payment-progress',
    silentFailure: 'https://yoursite.com/api/webhook/payment-failure',
  },
})

钩子

redirect* 钩子是浏览器-侧重定向. 在用户完成或失败支付页面后,他们的浏览器会浏览给定的URL. 当支付页面取代当前页面(同为tab导航)时最合适. 如果您在新标签中打开支付页面( N)target="_blank"),重定向钩对母页没有任何影响——取而代之的是使用无声钩.

silent* 钩子是服务器对服务器的webhooks由Ariari后端直接调用. 它们必须是具有有效域名(例如. https://yoursite.com/api/webhook) (中文(简体) ). localhost 或当地实施伙伴将不起作用——使用ngrok这样的隧道服务促进发展.

两者可以一起使用——例如重定向用户并同时通知您的服务器.

跟踪支付

Ariari.create() 返回 a Payment 具有两种方法的对象:

• payment.status() ——从服务器获取全额支付细节(见下表)
• payment.pay(ticketCode) ——应用后端的出票码(付款页的替代)

const payment = await Ariari.create({ amount: 5000 })

// fetch payment details
const info = await payment.status()
// info.status → the payment's current state (see below)
// info.rest   → remaining amount to pay
// info.parts  → list of partial payments applied so far

// apply a ticket code from your backend
const result = await payment.pay('Y-1234')

这个 status 字段

这个 info.status 字段(不与 .status() )表示付款的当前状态:

import { Status } from '@ariary/pay'

if (info.status === Status.PAID) { ... }

获取现有付款

存储 payment.id 待会再拿回来 .getPayment()调用 .status() 返回全额支付细节 :

const payment = await Ariari.create({ amount: 5000 })
const paymentId = payment.id // save this

// later
const payment = Ariari.getPayment(paymentId)
const info = await payment.status()

产品

产品是一个可重复使用的模板,所以你不必发送同样的 name, (中文(简体) ), price,以及 imgUrl 每次你创造报酬。 当你通过一个 productId 改为 Ariari.create(),产品的数据自动应用于支付.

// create
const product = await Ariari.products.create({ name: 'Forfait Premium', price: 5000, imgUrl: 'https://example.com/img.png' })

// list all
const products = await Ariari.products.list()

// update
const updated = await Ariari.products.update(product.id, { name: 'Forfait Gold', price: 8000 })

// delete
await Ariari.products.delete(product.id)

多个实例

使用 name 管理不同证书的 Ariari 实例. Ariari.config() 直接返回实例.

const shop = Ariari.config({
  name: 'shop',
  secret: 'secret-a',
})

const billing = Ariari.config({
  name: 'billing',
  secret: 'secret-b',
})

await shop.create({ amount: 5000 })
await billing.create({ productId: 'prod-123' })

您也可以稍后检索一个命名实例 Ariari.get()。 。 。 .

const shop = Ariari.get('shop')

无 name,实例默认为 "main" 并采用静态方法(Ariari.create, (中文(简体) ), Ariari.products, (中文(简体) ), Ariari.getPayment) (中文(简体) ).