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

0.3.2 • Public • Published

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 from '@leantechnologies/node-sdk'
import { Environment } from '@leantechnologies/node-sdk/dist/types/LeanSettings'

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

this._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

createCustomer(appUserId)

Param Type
appUserId string

getIdentity(customerId)

Param Type
customerId string

getAccounts(customerId)

Param Type
customerId string

getBalance(customerId, accountId)

Param Type
customerId string
accountId string

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

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

getSupportedBanks()

getAppPaymentDestinations()

getCustomerPaymentDestinations(customerId)

Param Type
customerId string

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

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

getCustomerPaymentSources(customerId)

Param Type
customerId string

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

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

getPaymentIntent(paymentIntentId)

Param Type
paymentIntentId string

verifyWebhook(webhookData, webhookSignature)

Param Type
webhookData string
webhookSignature string
Last Updated: December 10, 2021

Readme

Keywords

none

Package Sidebar

Install

npm i @leantechnologies/node-sdk

Weekly Downloads

2

Version

0.3.2

License

MIT

Unpacked Size

47 kB

Total Files

30

Last publish

Collaborators

  • lean-root