# fidor-sync

> Sends, monitors, tracks, and quotes payments on the Fidor network

Latest version **0.1.1** (published 2015-01-20) · ISC license · 0 weekly downloads

## Install

```sh
npm install fidor-sync
pnpm add fidor-sync
yarn add fidor-sync
bun add fidor-sync
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2015-01-20 |
| First published | 2015-01-20 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 16 |
| Known vulnerabilities | 0 (+9 in 4 direct dependencies) |
| Install scripts | no |
| GitHub stars | 2 |
| Maintainers | stevenzeiler, yongsoo |

## Links

- npm: https://www.npmjs.com/package/fidor-sync
- Repository: https://github.com/yongsoo/fidor-sync
- Issues: https://github.com/yongsoo/fidor-sync/issues
- npm.io page: https://npm.io/package/fidor-sync

## Dependencies (16)

- [pg](https://npm.io/package/pg.md) ^4.1.0
- [gulp](https://npm.io/package/gulp.md) ^3.8.10
- [knex](https://npm.io/package/knex.md) ^0.7.3
- [nconf](https://npm.io/package/nconf.md) ^0.7.1
- [lodash](https://npm.io/package/lodash.md) ^2.4.1
- [bridges](https://npm.io/package/bridges.md) 0.3.0
- [express](https://npm.io/package/express.md) ^4.10.5
- [promise](https://npm.io/package/promise.md) ^6.0.1
- [sqlite3](https://npm.io/package/sqlite3.md) ^3.0.4
- [winston](https://npm.io/package/winston.md) ^0.8.3
- [bluebird](https://npm.io/package/bluebird.md) ^2.8.0
- [passport](https://npm.io/package/passport.md) ^0.2.1
- [bookshelf](https://npm.io/package/bookshelf.md) ^0.7.9
- [body-parser](https://npm.io/package/body-parser.md) ^1.10.0
- [bridges-express](https://npm.io/package/bridges-express.md) ^0.3.0
- [bridges-application](https://npm.io/package/bridges-application.md) ^0.2.1

## Recent versions

- 0.1.1 (latest) — 2015-01-20
- 0.1.0 — 2015-01-20

## README

# fidor-sync
ALPHA SOFTWARE

Sends, monitors, tracks, and quotes payments on the Fidor network.

## Installation

````
npm install -g fidor-sync
````

Alternatively, you can build from source:
````
git clone https://github.com/yongsoo/fidor-sync
cd fidor-sync
npm install
npm link
````

## Usage
Fidor-sync runs in the foreground and can be daemonized by the system's process manager. Logs are written directly to stdout.

````
fidor-sync start
````
All interactions with Fidor Sync is done via its REST interface.

## Dependencies
- Git
- Node.js
- Postgres

## Configuration
All config settings are set via environment variables.

The following environment variables must be set to run Fidor Sync:

- PORT
- SSL_CERTIFICATE_PATH
- SSL_KEY_PATH
- DATABASE_DIALECT
- DATABASE_HOST
- DATABASE_NAME
- DATABASE_USER
- DATABASE_PASSWORD
- DATABASE_PORT
- FIDOR_API_URL
- FIDOR_OAUTH_URL
- FIDOR_CLIENT_ID
- FIDOR_CLIENT_SECRET

## Processes
Fidor-sync has several types of processes.

- HTTP server for REST interface
- Initiating incoming payments on Fidor (OAuth)
- Initiating outgoing payments on Fidor

## REST API
### Quotes
Ask for the price of a quote for a Fidor payment

````
POST /quotes
````

Check status of quote including expiration, signature
````
GET /quotes/:id
````

### Payments
Initialize a payment to or from Fidor Sync's Fidor account
````
POST /payments
````

Check status of payment
````
GET /payments/:id
````

Cancel a payment before it is sent
````
DELETE /payments/:id
````

### Notifications
List notifications of successful and failed payments
````
GET /notifications
````

Clear payment notification
````
DELETE /notifications/:id
````

---
_Source: https://npm.io/package/fidor-sync · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._