Skip to main content

Installing the AIS SDK

The Account Information Service (AIS) SDK enables secure access to user bank data, including accounts, balances, and transactions, via open banking APIs.

Prerequisites

  • AcountPay Account: You’ll need your Client ID from the merchant dashboard
  • Supported Environment: JavaScript/TypeScript (browser or Node.js), React optional
  • Node.js: 16.x or higher (recommended)
  • Modern Browser: With ES6 support for web apps
  • API Credentials: Client ID and API base URL

Installation

Install the AIS SDK using npm:
npm i @acountpay/ais-sdk
Or using yarn:
yarn add @acountpay/ais-sdk

Package Contents

The SDK includes:
  • Core account linking utilities (no embedded UI/components)
  • TypeScript definitions for editor IntelliSense and types
  • ESM/CJS/UMD builds for broad compatibility

Verify Installation

ESM/CommonJS usage:

// ES module (Vite, Next.js, etc.)
import { Account } from '@acountpay/ais-sdk';

const account = new Account({ clientId: 'your-client-id' });
console.log('AIS SDK loaded:', typeof Account === 'function'); // should be true

UMD (script tag) usage:

<script src="/node_modules/@acountpay/ais-sdk/dist/acount.umd.js"></script>
<script>
  const account = new AcountAIS.Account({ clientId: 'your-client-id' });
  console.log('AIS SDK loaded:', typeof AcountAIS.Account === 'function'); // should be true
</script>
<script src="https://unpkg.com/@acountpay/ais-sdk@latest/dist/acount.umd.js"></script>
<script>
  const account = new AcountAIS.Account({ clientId: 'your-client-id' });
  console.log('AIS SDK loaded:', typeof AcountAIS.Account === 'function'); // should be true
</script>