@acid-tango/arcus-js 中文文档教程

发布于 3年前 浏览 17 项目主页 更新于 3年前

arcus-js

NPM 版本CI

Arcus 的 Arcus TypeScript 客户端库API v3.x

Installation

npm install --save @acid-tango/arcus-js
# or
yarn add @acid-tango/arcus-js

Usage

Authentication

import { Arcus } from '@acid-tango/arcus-js';

const arcusClient = Arcus.create(
    process.env.ARCUS_API_KEY as string,
    process.env.ARCUS_SECRET_KEY as string,
  );

Get account info

返回有关您帐户的所有信息。

const account = await arcusClient.getAccount()

Billers methods

返回所有出票人:

const allBillers = await arcusClient.getBillers()

按类型返回出票人:

const utilities = await arcusClient.getBillersUtilities()
const topUps = await arcusClient.getBillersTopUps()
const giftCards = await arcusClient.getBillersGiftCards()

Payment

// Creates a single payment and returns the created transaction
const singlePayParams: ArcusSinglePayParams = {...}

const transaction = await arcusClient.singlePay(singlePayParams)

Transactions

按 id 获取交易:按 id

const transaction = await arcusClient.getTransaction(transactionId)

取消交易:

await arcusClient.cancelTransaction(transactionId)

How to do a release

  1. Update the changelog yarn release
  2. Delete the tag created by the release script
  3. Create a PR
  4. Merge to main with rebase and merge button to avoid merge commit.
  5. Create a tag starting with "v". example v0.0.6
  6. Push the tag
  7. Create a release
  8. Wait for ci to automatically publish.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'feat: Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Contact

该项目主要由 Abel García 开发,Aarón PérezDaniel RamosDaniel Gak 来自 Acid Tango 与 ❤️ 和 兔子

License

麻省理工学院

arcus-js

NPM versionCI

Arcus TypeScript client library for Arcus API v3.x

Installation

npm install --save @acid-tango/arcus-js
# or
yarn add @acid-tango/arcus-js

Usage

Authentication

import { Arcus } from '@acid-tango/arcus-js';

const arcusClient = Arcus.create(
    process.env.ARCUS_API_KEY as string,
    process.env.ARCUS_SECRET_KEY as string,
  );

Get account info

Returns all the info about your account.

const account = await arcusClient.getAccount()

Billers methods

Return all billers:

const allBillers = await arcusClient.getBillers()

Return billers by type:

const utilities = await arcusClient.getBillersUtilities()
const topUps = await arcusClient.getBillersTopUps()
const giftCards = await arcusClient.getBillersGiftCards()

Payment

// Creates a single payment and returns the created transaction
const singlePayParams: ArcusSinglePayParams = {...}

const transaction = await arcusClient.singlePay(singlePayParams)

Transactions

Get a transaction by id:

const transaction = await arcusClient.getTransaction(transactionId)

Cancel a transaction by id:

await arcusClient.cancelTransaction(transactionId)

How to do a release

  1. Update the changelog yarn release
  2. Delete the tag created by the release script
  3. Create a PR
  4. Merge to main with rebase and merge button to avoid merge commit.
  5. Create a tag starting with "v". example v0.0.6
  6. Push the tag
  7. Create a release
  8. Wait for ci to automatically publish.

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'feat: Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

???? Contact

The project was mainly developed by Abel García, Aarón Pérez, Daniel Ramos and Daniel Gak from Acid Tango with ❤️ and ???? for Rabbit.

License

MIT

    我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
    原文