https://github.com/yapily/yapily-sdk-nodejs
Javascript SDK compatible with Node JS generated against the Yapily API. This SDK can be used to connect to Open Banking entities.
https://github.com/yapily/yapily-sdk-nodejs
banking-applications connectivitymanager financial-institutions fintech javascript nodejs oauth2 openapi openapi-generator openbanking openbanking-api openbanking-sdk payments payments-sdk psd2 sdk sdk-nodejs yapily yapily-api yapily-sdk
Last synced: 1 day ago
JSON representation
Javascript SDK compatible with Node JS generated against the Yapily API. This SDK can be used to connect to Open Banking entities.
- Host: GitHub
- URL: https://github.com/yapily/yapily-sdk-nodejs
- Owner: yapily
- License: mit
- Created: 2018-05-15T15:45:55.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-06-30T15:16:34.000Z (7 months ago)
- Last Synced: 2025-10-25T18:46:30.881Z (3 months ago)
- Topics: banking-applications, connectivitymanager, financial-institutions, fintech, javascript, nodejs, oauth2, openapi, openapi-generator, openbanking, openbanking-api, openbanking-sdk, payments, payments-sdk, psd2, sdk, sdk-nodejs, yapily, yapily-api, yapily-sdk
- Language: JavaScript
- Homepage: https://yapily.com
- Size: 24.9 MB
- Stars: 13
- Watchers: 1
- Forks: 9
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Yapily Node.js SDK
[](http://badge.fury.io/gh/boennemann%2Fbadges)
This SDK library was generated using [OpenApi Generator](https://github.com/OpenAPITools/openapi-generator). The SDK can be used as a module in your code and the examples demonstrate how to connect to financial institutions integrated with Yapily.
## Requirements
To connect to the Yapily API, you will need to register your
application at [https://dashboard.yapily.com]().
These application credentials will be used to authorise all
your API requests.
## Installation
The SDK can be installed from [npm](https://www.npmjs.com/package/@yapily/yapily-api) and can be included in your
project by adding it to your dependencies
#### npm
```bash
npm install @yapily/yapily-api
```
## Usage
Sample usage of the SDK can be seen in the `examples` folder. To run any of the examples, follow the steps below:
### Configure the application credentials
Go to constants.js and fill in the following credentials. The more complex exmples will require you to define all of these
variables and will not work unless they are set.
```javascript
module.exports = {
"APPLICATION_ID" : "{{APPLICATION_ID}}",
"APPLICATION_SECRET" : "{{APPLICATION_SECRET}}",
"APPLICATION_USER_ID": "node-sdk@yapily.com",
"INSTITUTION_ID": "{{INSTITUTION_ID}}",
"CALLBACK_URL": "{{CALLBACK_URL}}"
}
```
### Choose the example you wish to run
All of the examples can be found in one of the following subdirectories in the `examples` folder:
- Accounts
- Application
- Consents
- Institutions
- Users
You must first install the dependencies for each example in the parents directory by running `npm install`
e.g. to run one of the `accounts` demos, first run:
```
cd examples/accounts && npm install
```
### Run the example
Finally, run the example e.g. to run the `GetAccountDetailsWithNewConsent.js` demo, run:
```
node GetAccountDetailsWithNewConsent.js
```
## Further information
For more information on how to get connected, visit the [Yapily Knowledge Base](https://kb.yapily.com).
###### [Website](https://yapily.com) | [Legal](https://yapily.com/legal-policies) | [Contact Us](mailto:info@yapily.com)