Arcus TypeScript client library for Arcus API v3.x
npm install --save @acid-tango/arcus-js
# or
yarn add @acid-tango/arcus-js
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,
);
Returns all the info about your account.
const account = await arcusClient.getAccount()
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()
// Creates a single payment and returns the created transaction
const singlePayParams: ArcusSinglePayParams = {...}
const transaction = await arcusClient.singlePay(singlePayParams)
Get a transaction by id:
const transaction = await arcusClient.getTransaction(transactionId)
Cancel a transaction by id:
await arcusClient.cancelTransaction(transactionId)
- Update the changelog
yarn release
- Delete the tag created by the release script
- Create a PR
- Merge to main with
rebase and merge
button to avoid merge commit. - Create a tag starting with "v". example
v0.0.6
- Push the tag
- Create a release
- Wait for ci to automatically publish.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'feat: Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
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.