@appmax-api/sdk
TypeScript icon, indicating that this package has built-in type declarations

0.2.1 • Public • Published

@appmax-api/sdk

Unofficial NodeJS SDK for consuming the Appmax API.

Installation

npm install @appmax-api/sdk
// or
yarn add @appmax-api/sdk
// or
pnpm add @appmax-api/sdk

Getting Started

import { AppmaxAPI } from "@appmax-api/sdk"
// const { AppmaxAPI } = require("@appmax-api/sdk")

const api = new AppmaxAPI("Access Token")

Features

  • Testing mode (use homolog.sandboxappmax url)

      new AppmaxAPI("Access Token", { testMode: true })
  • Create customers (/customer)

      api.customers.create()
  • Create orders (/order)

      api.orders.create()
  • Initiate payments (/payment/*)

      api.payments.create()
  • Tokenize cards (/tokenize/card)

      api.payments.tokenize()
  • Refund orders (/refund)

      api.orders.refund()

API Documentation

Check the official API documentation for more information about their service.

Contributing

Feel free to contribute with suggestions or bug reports at our GitHub repository.

Authors

Package Sidebar

Install

npm i @appmax-api/sdk

Weekly Downloads

13

Version

0.2.1

License

MIT

Unpacked Size

307 kB

Total Files

196

Last publish

Collaborators

  • joaotonaco