Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ekoindia/eko-sdk-node
Node.js SDK for Eko Fintech APIs
https://github.com/ekoindia/eko-sdk-node
fintech javascript nodejs payments sdk
Last synced: 2 months ago
JSON representation
Node.js SDK for Eko Fintech APIs
- Host: GitHub
- URL: https://github.com/ekoindia/eko-sdk-node
- Owner: ekoindia
- License: mit
- Created: 2022-12-14T11:43:39.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2023-07-19T12:48:49.000Z (about 1 year ago)
- Last Synced: 2024-07-05T16:34:24.449Z (3 months ago)
- Topics: fintech, javascript, nodejs, payments, sdk
- Language: JavaScript
- Homepage:
- Size: 80.1 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-fintech-india - Eko - Aggregator of all financial services APIs into one SDK (FinTech API Aggregators)
README
# eko-sdk-node
Node.js SDK for [Eko APIs](https://developers.eko.in)
[](https://badge.fury.io/js/@ekoindia%2Feko-sdk-node) [](https://github.com/ekoindia/eko-sdk-node/issues)
[](https://www.npmjs.com/package/@ekoindia/eko-sdk-node)
**Warning: This is not yet ready to use in production**
Have any questions/suggestions? Share in the [Discord community](http://dsc.gg/ekodevs)
## Getting started
### Install the package
```
npm install @ekoindia/eko-sdk-node
```
### Initialize the SDK
```
const Eko = require('@ekoindia/eko-sdk-node')
const ekoAPI = Eko.init({
hostname: "eko.in",
port: 443,
developerKey: "becbbce45f79c6f5109f848acd540567",
authKey: "f74c50a1-f705-4634-9cda-30a477df91b7",
initiatorId: "9971771929"
})
```
### Usage for KYC related APIs
```
//How to verify PAN
ekoAPI.verifyPAN({
panNumber: 'pan number',
purpose: 'purpose of verification',
purposeDescription: 'description of the purpose'
}, function(err, result){
console.log(JSON.stringify(result));
})
```
```
//How to verify Bank account
ekoApi.verifyBankAccount({
accountNo: '12313897932',
ifsc: 'SBIN02349D',
customerId: 4315453,
userCode: 12345
}, (err, result) => {
console.log(JSON.stringify(result));
})
```
### Usage for Bill Payments related APIs
**Get list of billing operators**
```
ekoApi.billPayments.getOperators({}, function(err, operatorList){
console.log(JSON.stringify(operatorList))
}
```
**Get list of billing operator categories**
```
ekoApi.billPayments.getOperatorCategories({}, function(err, operatorCategoryList){
console.log(JSON.stringify(operatorCategoryList))
}
```
**Get list of billing operator locations**
```
ekoApi.billPayments.getOperatorLocations({}, function(err, locations){
console.log(JSON.stringify(locations))
}
```
**Get required parameters for a billing operator**
```
ekoApi.billPayments.getOperatorParameters({ operator: 1 }, function(err, parameterList){
console.log(JSON.stringify(parameterList))
}
```
**Get bill**
```
ekoApi.billPayments.getBill({
initiatorId: 9962981729,
"operator_id":"51",
"user_code":"20810200",
"client_ref_id":"202105311125123456",
"utility_acc_no":"151627591",
"confirmation_mobile_no":"9999999999",
"sender_name":"Kaushik",
"source_ip":"121.121.1.1",
"latlong":"77.06794760,77.06794760",
"hc_channel" : 1
}, function(err, billInfo){
console.log(JSON.stringify(billInfo))
}
```
**Pay bill**
```
ekoApi.billPayments.payBill({
initiatorId: 9962981729,
"source_ip":"121.121.1.1",
"user_code":"20810200",
"amount":"50" ,
"client_ref_id":"202105311125123456",
"utility_acc_no":"151627591",
"confirmation_mobile_no":"9999999999",
"sender_name":"Kaushik",
"operator_id":"1",
"latlong":"77.06794760,77.06794760",
"hc_channel" : 1
}, function(err, paymentInfo){
console.log(JSON.stringify(paymentInfo))
}
```
## Resources
- [Eko Developers Community](https://github.com/ekoindia/eko-dev-community)
- [Discord](http://dsc.gg/ekodevs)
- [YouTube](https://www.youtube.com/@ekodevelopers)