Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lansarbac2020/payments-with-stripe
https://github.com/lansarbac2020/payments-with-stripe
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/lansarbac2020/payments-with-stripe
- Owner: Lansarbac2020
- Created: 2024-01-27T15:28:54.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-07-19T17:30:19.000Z (6 months ago)
- Last Synced: 2024-07-19T22:37:51.727Z (6 months ago)
- Language: JavaScript
- Size: 19.5 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 💳 Node.js Stripe Payments Function
Receive card payments and store paid orders.
## 🧰 Usage
### `POST /checkout`
This endpoint initiates a Stripe checkout session. The user ID is fetched from the headers of the request. If the user ID is not found or a Stripe checkout session could not be created, the request will be redirected to a cancel URL.
**Parameters**
| Name | Description | Location | Type | Sample Value |
| ------------------ | --------------------------------------------------------- | -------- | ------------------ | --------------------------- |
| x-appwrite-user-id | User ID from Appwrite. | Header | String | 642...7cd |
| Content-Type | The content type of the request body | Header | `application/json` | N/A |
| successUrl | The URL to redirect to after a successful payment. | Body | String | https://example.com/success |
| failureUrl | The URL to redirect to after a cancelled payment attempt. | Body | String | https://example.com/failure |
**Response**
Sample `303` Response:
The response is a redirect to the Stripe checkout session URL or to the cancel URL if an error occurs
```text
Location: https://checkout.stripe.com/pay/cs_test_...#fidkdWxOYHwnP
```
```text
Location: https://mywebapp.com/cancel
```
### `POST /webhook`
This endpoint is a webhook that handles Stripe event `checkout.session.completed`. It validates the incoming request using the Stripe's validateWebhook method. If the validation fails, a `401` response is sent.
**Parameters**
| Name | Description | Location | Type | Sample Value |
| ---- | ---------------------------- | -------- | ------ | --------------------------------------------------------------------- |
| None | Webhook payload from Stripe. | Body | Object | [See Stripe documentation](https://stripe.com/docs/api/events/object) |
**Response**
Sample `200` Response:
In case of `checkout.session.completed` event, document for the order is created in Appwrite Database.
```json
{ "success": true }
```
Sample `401` Response:
```json
{ "success": false }
```
## ⚙️ Configuration
| Setting | Value |
| ----------------- | ------------------------------ |
| Runtime | Node (18.0) |
| Entrypoint | `src/main.js` |
| Build Commands | `npm install && npm run setup` |
| Permissions | `any` |
| Timeout (Seconds) | 15 |
> If using a demo web app to create order, make sure to add your function domain as a web platform to your Appwrite project. Doing this fixes CORS errors and allows proper functionality.
## 🔒 Environment Variables
### APPWRITE_API_KEY
Your Appwrite project's API key.
| Question | Answer |
| ------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| Required | Yes |
| Sample Value | `083d341ee48..` |
| Documentation | [Appwrite: Create an API key](https://appwrite.io/docs/advanced/platform/api-keys#:~:text=To%20create%20a%20new%20API,scope%20to%20grant%20your%20application.) |
### APPWRITE_ENDPOINT
The endpoint where your Appwrite server is located. If not provided, it defaults to the Appwrite Cloud server: `https://cloud.appwrite.io/v1`.
| Question | Answer |
| ------------ | ------------------------------ |
| Required | No |
| Sample Value | `https://cloud.appwrite.io/v1` |
### APPWRITE_DATABASE_ID
The ID of the database to store the orders.
| Question | Answer |
| ------------ | ------ |
| Required | No |
| Sample Value | `main` |
### APPWRITE_COLLECTION_ID
The ID of the collection to store the orders.
| Question | Answer |
| ------------ | -------- |
| Required | No |
| Sample Value | `orders` |
### STRIPE_SECRET_KEY
Secret for sending requests to the Stripe API.
| Question | Answer |
| ------------- | ------------------------------------------------ |
| Required | Yes |
| Sample Value | `sk_test_51J...` |
| Documentation | [Stripe: API Keys](https://stripe.com/docs/keys) |
### STRIPE_WEBHOOK_SECRET
Secret used to validate the Stripe Webhook signature.
| Question | Answer |
| ------------- | ---------------------------------------------------- |
| Required | Yes |
| Sample Value | `whsec_...` |
| Documentation | [Stripe: Webhooks](https://stripe.com/docs/webhooks) |