@adit-financial/adit-client

Adit API Client

This codebase provides a client interface to access the Adit Api.

Installing

Using npm:

$ npm install @adit-financial/adit-client

Using the API Client

Authentication

The Adit Client uses API keys to authenticate requests. Your API keys carry many privileges, so be sure to keep them secure.

Use your API keys by passing them to the client on initialization as the first argument. The client will then automatically send this key in each request.

Credentials:

• apiKeyId
• apiPrivateKey

Base Url

Choose which environment you want your requests to hit by passing the correct base url to the client on initialization.

• Testing: https://api.dev.aditfinancial.dev
• Production: TBD

Example

import AditClient from 'adit-client'  

const aditClient = new AditClient(
  {
    apiKeyId: <YOUR_API_KEY_ID>,
    apiPrivateKey: <YOUR_API_PRIVATE_KEY>,
  },
  <ADIT_BASE_URL>,
  // Optional
  { 
    retries: 3, // Number of request attempts. Default 5. 
    minTimeout: 100, // Default 100
    maxTimeout: 1000, // Default 1000
  },
)
const requestData = {
  idempotencyKey: '7ba7h811-9ase-11d1-80b4-00c04fd784c8'
  name: 'Joe Smith',
  email: '[e-mail]',
  phone: '4151110000',
  identity: {
    idType: 'DL',
    idNumber: '123-456-789',
    issuedState: 'NY',
    issuedCountry: 'US',
    expirationDate: '10-31-2021',
    birthDate: '10-31-1988',
  },
}
await aditClient.addWallet(requestData).catch((e) => {
  console.log(e.message)
})
///

note: CommonJS usage

In order to gain the TypeScript typings (for intellisense / autocomplete) while using CommonJS imports with require() use the following approach:

const AditClient = require('@adit-financial/adit-client').default

Idempotency Keys

Payment related calls (authorize, charge, cancel, and refund) require a unique uuid to be passed in the idempotencyKey field. This is used to recognize subsequent retries of the same request.