Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kamalbuilds/akashfiatgateway


https://github.com/kamalbuilds/akashfiatgateway

akash-network

Last synced: 3 days ago
JSON representation

Awesome Lists containing this project

README

        

# Akashfiatgateway

Implementing Stripe Payments with Akash payments gateway.

![Screenshot 2024-05-18 192653](https://github.com/kamalbuilds/akashfiatgateway/assets/95926324/e30f81ab-d254-4ff4-aee4-210745a2aae9)

An open-source fiat payment system that seamlessly integrates with the Akash Network ecosystem. While decentralized finance (DeFi) has gained significant traction, enabling fiat payments remains a critical bridge between traditional financial systems and blockchain-based networks.

- Contributes to enhancing accessibility, usability, and adoption of the Akash Network.

* Features:

Fiat Payment Gateway Integration: A fiat payment gateway that allows users to purchase and manage Akash Network services using traditional fiat currencies (e.g., USD, EUR, GBP). We have integrated popular payment methods (e.g., credit/debit cards, bank transfers) into the payment system to facilitate seamless transactions.

## Demo

The demo is running in test mode -- use `4242424242424242` as a test card number with any CVC + future expiration date.

Use the `4000002760003184` test card number to trigger a 3D Secure challenge flow.

[Read more](https://stripe.com/docs/testing) about testing on Stripe.

Checkout Donations Demo
A gif of the Checkout payment page.

Elements Donations Demo
A gif of the custom Elements checkout page.

## Included functionality

- Stripe Checkout
- Custom Amount Donation with redirect to Stripe Checkout:
- Server Component: [app/donate-with-checkout/page.tsx](app/donate-with-checkout/page.tsx)
- Server Action: [app/actions/stripe.ts](app/actions/stripe.ts)
- Checkout Session 'success' page fetches the Checkout Session object from Stripe: [donate-with-checkout/result/page.tsx](app/donate-with-checkout/result/page.tsx)
- Stripe Elements
- Custom Amount Donation with Stripe Payment Element & PaymentIntents:
- Server Component: [app/donate-with-elements/page.tsx](app/donate-with-elements/page.tsx)
- Server Action: [app/actions/stripe.ts](app/actions/stripe.ts)
- Payment Intent 'success' page (via `returl_url`) fetches the Payment Intent object from Stripe: [donate-with-elements/result/page.tsx](app/donate-with-elements/result/page.tsx)
- Webhook handling for [post-payment events](https://stripe.com/docs/payments/handling-payment-events)
- Route Handler: [app/api/webhooks/route.ts](app/api/webhooks/route.ts)

### Required configuration

Copy the `.env.local.example` file into a file named `.env.local` in the root directory of this project:

```bash
cp .env.local.example .env.local
```

You will need a Stripe account ([register](https://dashboard.stripe.com/register)) to run this sample. Go to the Stripe [developer dashboard](https://dashboard.stripe.com/apikeys) to find your API keys and replace them in the `.env.local` file.

```bash
NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY=
STRIPE_SECRET_KEY=
```

Now install the dependencies and start the development server.

```bash
npm install
npm run dev
# or
yarn
yarn dev
```

### Forward webhooks to your local dev server

First [install the CLI](https://stripe.com/docs/stripe-cli) and [link your Stripe account](https://stripe.com/docs/stripe-cli#link-account).

Next, start the webhook forwarding:

```bash
stripe listen --forward-to localhost:3000/api/webhooks
```

The CLI will print a webhook secret key to the console. Set `STRIPE_WEBHOOK_SECRET` to this value in your `.env.local` file.

### Setting up a live webhook endpoint

After deploying, copy the deployment URL with the webhook path (`https://your-url.vercel.app/api/webhooks`) and create a live webhook endpoint [in your Stripe dashboard](https://stripe.com/docs/webhooks/setup#configure-webhook-settings).

Once created, you can click to reveal your webhook's signing secret. Copy the webhook secret (`whsec_***`) and add it as a new environment variable in your [Vercel Dashboard](https://vercel.com/dashboard):

- Select your newly created project.
- Navigate to the Settings tab.
- In the general settings scroll to the "Environment Variables" section.

After adding an environment variable you will need to rebuild your project for it to become within your code. Within your project Dashboard, navigate to the "Deployments" tab, select the most recent deployment, click the overflow menu button (next to the "Visit" button) and select "Redeploy".

### Deploy on Vercel

You can deploy this app to the cloud with [Vercel](https://vercel.com?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)).

## Authors

- [@0xkamal7](https://twitter.com/0xkamal7)