0.3.2 • Published 2 years ago

@leantechnologies/node-sdk v0.3.2

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

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)

ParamType
appUserIdstring

getIdentity(customerId)

ParamType
customerIdstring

getAccounts(customerId)

ParamType
customerIdstring

getBalance(customerId, accountId)

ParamType
customerIdstring
accountIdstring

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

ParamType
customerIdstring
accountIdstring
startDatestring
endDatestring
insightsboolean

getSupportedBanks()

getAppPaymentDestinations()

getCustomerPaymentDestinations(customerId)

ParamType
customerIdstring

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

ParamType
displayNamestring
namestring
bankIdentifierLeanBankIdentifiers | string
addressstring
citystring
countryLeanCountries | string
accountNumberstring
ibanstring
swiftCodestring

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

ParamType
customerIdstring
displayNamestring
namestring
bankIdentifierLeanBankIdentifiers | string
addressstring
citystring
countryLeanCountries | string
accountNumberstring
ibanstring
swiftCodestring

getCustomerPaymentSources(customerId)

ParamType
customerIdstring

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

ParamType
amountnumber
currencystring
descriptionstring
paymentDestinationIdstring
customerIdstring

getPaymentIntent(paymentIntentId)

ParamType
paymentIntentIdstring

verifyWebhook(webhookData, webhookSignature)

ParamType
webhookDatastring
webhookSignaturestring
Last Updated: December 10, 2021
0.3.2

2 years ago

0.3.1

2 years ago

0.3.0

2 years ago

0.2.0

2 years ago