Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prabapro/payhere-with-netlify-functions
A Jamstack demo app using payhere.lk payment gateway with Netlify Functions & Fauna DB
https://github.com/prabapro/payhere-with-netlify-functions
faunadb jamstack netlify-functions payhere-javascript-sdk payherelk
Last synced: about 1 month ago
JSON representation
A Jamstack demo app using payhere.lk payment gateway with Netlify Functions & Fauna DB
- Host: GitHub
- URL: https://github.com/prabapro/payhere-with-netlify-functions
- Owner: prabapro
- Created: 2024-02-01T12:20:31.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-02-05T04:19:17.000Z (11 months ago)
- Last Synced: 2024-09-29T14:01:27.065Z (3 months ago)
- Topics: faunadb, jamstack, netlify-functions, payhere-javascript-sdk, payherelk
- Language: JavaScript
- Homepage: https://payhere-with-netlify-functions.nfapps.prabapro.me
- Size: 139 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Payhere Payment Gateway with Netlify Functions & Fauna DB
[](https://app.netlify.com/sites/praba-payhere-with-netlify-functions/deploys)
A Node.js app to integrate Payhere.lk payment gateway using Netlify Functions & Fauna DB.
- [Payhere JavaScript SDK](https://support.payhere.lk/api-&-mobile-sdk/javascript-sdk)
- [Payhere Test Cards](https://support.payhere.lk/sandbox-and-testing)
## 🚀 Getting started
1. Clone the repo & run `npm install` to install the dependencies.
2. Setup the [Fauna DB](#fauna-db) connection & create the collection & index.
3. Add [Environment Variables](#environment-variables) to `.env` file.
## 👨💻 Development Environment
To ensure the seamless functioning of the entire funnel, follow these steps:
- Execute both `netlify dev` and set up `ngrok` to examine the complete process. This is necessary as Payhere requires a public-facing URL for the `notify_url`.
- If the repository is already linked to a Netlify site, simply run `netlify dev --live` without the need for ngrok. You can use `netlify link` to connect the repository and the Netlify site efficiently.
### Fauna DB
- Create a Database in US Region Group.
- Go to the Database > Security > Create a secret key with the server role.
- Add the key to the `.env` file as `FAUNA_SECRET_KEY`
- Run below to create the collection `payhere-demo-orders` & index `orders_by_order_id`
```shell
node faunadb/faunaSetup.js
```
### Environment Variables
- Generate `.env` file from `.env.example` and add your env variables.
```shell
cp .env.example .env
```
- If new keys are added to the `.env` file, run below command to update the example file with new keys.
```shell
sed 's/=.*/=/' .env > .env.example
```
## FAQ
**1. Why Netlify Functions?**
- 🔐 **Security**: The Payhere Merchant Secret is required for generating the hash. Performing this operation on the front-end poses security risks. Netlify Functions act as a secure backend for handling the hash generation process.
- 📡 **Server Callback**: Netlify Functions listen to payment notifications from PayHere, facilitating the passing of relevant information to the front-end.
**2. Why Fauna DB?**
- 🏦 **Payment Status Handling**: Since PayHere doesn't provide payment status parameters to the `return_url` during customer redirection, updating the database upon fetching payment status via your `notify_url` script is crucial.
- 🏢 **Modern Database Solution**: Fauna DB is a cloud-native database with a flexible document data model. It seamlessly integrates semi-structured data with powerful relational features, including foreign keys, views, and joins.
- 🔁 **Efficient Data Retrieval:** Integration with Fauna DB allows you to efficiently retrieve payment status & display to customers on the `return_url` page.