Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/woovibr/node-backend-integration
OpenPix Backend Integration
https://github.com/woovibr/node-backend-integration
Last synced: 5 days ago
JSON representation
OpenPix Backend Integration
- Host: GitHub
- URL: https://github.com/woovibr/node-backend-integration
- Owner: woovibr
- Created: 2021-03-02T20:02:05.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-16T20:55:01.000Z (over 1 year ago)
- Last Synced: 2024-08-01T22:01:58.809Z (3 months ago)
- Language: TypeScript
- Size: 164 KB
- Stars: 48
- Watchers: 8
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# OpenPix Backend Integration Example
Pix Example Using the [OpenPix](https://openpix.com.br/) Platform. [OpenPix Developers](https://developers.openpix.com.br/)
Basic OpenPix Backend Integration Example
This is a sample of how to integrate OpenPix Api in your backend
```jsx
POST /donation - crete a new donation
GET /donation/id - get donation info
POST /webhook - webhook that will be called by OpenPix API
```## Setup
Generate a [App ID](https://developers.openpix.com.br/docs/plugin/app-id) in your OpenPix AccountCreate a .env file with the following data
```jsx
PORT=5666
OPENPIX_API=https://api.openpix.com.br/
APP_ID=
MONGO_URI=mongodb://localhost/donation
HMAC_SECRET_KEY=
```## How to run
```jsx
yarn start
```