Lean Tecnhologies NodeJS SDK

NodeJS SDK to interact with the Lean API.

More information leantech.me

Installation

Install from NPM Registry

npm install -S @leantechnologies/node-sdk

Requirements

Make sure you have your App Token, Certificates and Webhook secret set.

To get your App Token and Certificates, please register dev.leantech.me and create and account.

Keep your certificates (certificate, private key, certificate chain) in a secure location.

Getting started

Import Lean package, as well as Environment type

import Lean, { Environment } from '@leantechnologies/node-sdk'

Create the Lean object, referencing the requirements above (App Token, Certificates and Webhook secret)

const lean = new Lean(LEAN_APP_TOKEN, Environment.PRODUCTION, { 
        ca: "static/certs/cachain.crt", 
        cert: "static/certs/cert.crt",
        key: "static/certs/key.pem"
      }, WEBHOOK_SECRET)
    }

You're ready to call Lean API using the NodeJS SDK. Example:

async _getSupportedBanks(): Promise<any>{
  return await this._lean.getSupportedBanks()
}

You should get a list of supported banks in the response.

Reference

new Lean(appToken: string, environment: Environment, mtls?: MTLSSettings, webhookSecret?: string | undefined)

| Param | Type | | --- | --- | | appToken | string | | environment | Environment | | mtls | MTLSSettings | | webhookSecret | string | undefined |

Lean.createCustomer(appUserId)

| Param | Type | | --- | --- | | appUserId | string |

Lean.getIdentity(customerId)

| Param | Type | | --- | --- | | customerId | string |

Lean.getAccounts(customerId)

| Param | Type | | --- | --- | | customerId | string |

Lean.getBalance(customerId, accountId)

| Param | Type | | --- | --- | | customerId | string | | accountId | string |

Lean.getTransactions(customerId, accountId, startDate, endDate, insights)

| Param | Type | | --- | --- | | customerId | string | | accountId | string | | startDate | string | | endDate | string | | insights | boolean |

Lean.getSupportedBanks()

Lean.getAppPaymentDestinations()

Lean.getCustomerPaymentDestinations(customerId)

| Param | Type | | --- | --- | | customerId | string |

Lean.createAppPaymentDestination(displayName, name, bankIdentifier, address, city, country, accountNumber, iban, swiftCode)

| Param | Type | | --- | --- | | displayName | string | | name | string | | bankIdentifier | LeanBankIdentifiers | string | | address | string | | city | string | | country | LeanCountries | string | | accountNumber | string | | iban | string | | swiftCode | string |

Lean.createCustomerPaymentDestination(customerId, displayName, name, bankIdentifier, address, city, country, accountNumber, iban, swiftCode)

| Param | Type | | --- | --- | | customerId | string | | displayName | string | | name | string | | bankIdentifier | LeanBankIdentifiers | string | | address | string | | city | string | | country | LeanCountries | string | | accountNumber | string | | iban | string | | swiftCode | string |

Lean.getCustomerPaymentSources(customerId)

| Param | Type | | --- | --- | | customerId | string |

Lean.createPaymentIntent(amount, currency, description, paymentDestinationId, customerId)

| Param | Type | | --- | --- | | amount | number | | currency | string | | description | string | | paymentDestinationId | string | | customerId | string |

Lean.getPaymentIntent(paymentIntentId)

| Param | Type | | --- | --- | | paymentIntentId | string |

Lean.verifyWebhook(webhookData, webhookSignature)

| Param | Type | | --- | --- | | webhookData | string | | webhookSignature | string |

Last Updated: December 20, 2021