Node SDK Installation

Requirements

Node.js 18 or later is required. The SDK uses native BigInt literals for amounts and ships as ES modules.

npm install @accrupay/node

ES modules (recommended)

import AccruPay, {
  TRANSACTION_PROVIDER,
  CURRENCY,
  COUNTRY_ISO_2,
} from '@accrupay/node';

CommonJS

const { default: AccruPay, CURRENCY, COUNTRY_ISO_2 } = require('@accrupay/node');

note

The package ships with dual CJS/ESM output. TypeScript users should set "moduleResolution": "bundler" or "node16" in tsconfig.json.

Symbol	Kind	Description
`AccruPay`	`class` (default export)	Main SDK client. Instantiate once per process.
`TRANSACTION_PROVIDER`	`enum`	Payment provider identifiers.
`CURRENCY`	`enum`	ISO 4217 currency codes (e.g. `CURRENCY.USD`).
`COUNTRY_ISO_2`	`enum`	ISO 3166-1 alpha-2 country codes (e.g. `COUNTRY_ISO_2.US`).
`AccruPayConfig`	`type`	Constructor options type.
`BillingDataSchema`	`type`	Billing address and contact fields.
`ShippingDataSchema`	`type`	Shipping address fields.
`UserDataSchema`	`type`	End-user identity fields.
`DeviceDataSchema`	`type`	Device fingerprint fields.
`MerchantTransaction`	`type`	Resolved transaction object (returned by `verify()`).
`ClientSession`	`type`	Session object (returned by `start()`).