https://github.com/apimatic/adyen-sample-application
https://github.com/apimatic/adyen-sample-application
Last synced: 11 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/apimatic/adyen-sample-application
- Owner: apimatic
- License: mit
- Created: 2023-02-17T14:44:39.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-02-17T14:45:17.000Z (over 3 years ago)
- Last Synced: 2025-04-05T07:13:43.016Z (about 1 year ago)
- Language: TypeScript
- Size: 3.77 MB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Adyen [online payment](https://docs.adyen.com/checkout) integration demos
## Run this integration in seconds using [Gitpod](https://gitpod.io/)
* Open your [Adyen Test Account](https://ca-test.adyen.com/ca/ca/overview/default.shtml) and create a set of [API keys](https://docs.adyen.com/user-management/how-to-get-the-api-key).
* Go to [gitpod account variables](https://gitpod.io/variables).
* Set the `ADYEN_BASIC_AUTH_USERNAME`,`ADYEN_BASIC_AUTH_PASSWORD`, `ADYEN_CLIENT_KEY`, `ADYEN_HMAC_KEY` and `ADYEN_MERCHANT_ACCOUNT variables`.
* Click the button below!
[](https://gitpod.io/#https://github.com/mehnoorsiddiqui/adyen-sample-app)
_NOTE: To allow the Adyen Drop-In and Components to load, you have to add `https://*.gitpod.io` as allowed origin for your chosen set of [API Credentials](https://ca-test.adyen.com/ca/ca/config/api_credentials_new.shtml)_
## Details
This repository includes examples of PCI-compliant UI integrations for online payments with Adyen. Within this demo app, you'll find a simplified version of an e-commerce website, complete with commented code to highlight key features and concepts of Adyen's API. Check out the underlying code to see how you can integrate Adyen to give your shoppers the option to pay with their preferred payment methods, all in a seamless checkout experience.
## Supported Integrations
**Node.js + Express** demos of the following client-side integrations are currently available in this repository:
- [Drop-in](https://docs.adyen.com/checkout/drop-in-web)
- [Component](https://docs.adyen.com/checkout/components-web)
- ACH
- Alipay
- Boleto Bancário
- Card (3DS2)
- Dotpay
- giropay
- iDEAL
- Klarna (Pay now, Pay later, Slice it)
- SEPA Direct Debit
- SOFORT
Each demo leverages Adyen's API Library for Node.js ([GitHub](https://github.com/Adyen/adyen-node-api-library) | [Docs](https://docs.adyen.com/development-resources/libraries#javascript)).
## Requirements
Node.js 12+
## Installation
1. Clone this repo:
```
git clone https://github.com/mehnoorsiddiqui/adyen-sample-app
```
2. Navigate to the SDK directory( Adyen+Checkout+API) and install dependencies:
```
npm install
```
3. Navigate to the root directory and install dependencies:
```
npm install
```
## Usage
1. Create a `./.env` file with all required configuration
- [Basic Auth username/password](https://docs.adyen.com/development-resources/api-credentials#basic-authentication)
- [Client Key](https://docs.adyen.com/user-management/client-side-authentication)
- [Merchant Account](https://docs.adyen.com/account/account-structure)
- [HMAC Key](https://docs.adyen.com/development-resources/webhooks/verify-hmac-signatures)
Remember to include `http://localhost:8080` in the list of Allowed Origins
```
PORT=8080
ADYEN_BASIC_AUTH_USERNAME="your_API_basic_auth_username_here"
ADYEN_BASIC_AUTH_PASSWORD="your_API_basic_auth_password_here"
ADYEN_MERCHANT_ACCOUNT="your_merchant_account_here"
ADYEN_CLIENT_KEY="your_client_key_here"
ADYEN_HMAC_KEY="your_hmac_key_here"
```
2. Start the server:
```
npm run dev
```
3. Visit [http://localhost:8080/](http://localhost:8080/) to select an integration type.
To try out integrations with test card numbers and payment method details, see [Test card numbers](https://docs.adyen.com/development-resources/test-cards/test-card-numbers).
## Testing webhooks
Webhooks deliver asynchronous notifications and it is important to test them during the setup of your integration. You can find more information about webhooks in [this detailed blog post](https://www.adyen.com/blog/Integrating-webhooks-notifications-with-Adyen-Checkout).
This sample application provides a simple webhook integration exposed at `/api/webhooks/notifications`. For it to work, you need to:
1. Provide a way for the Adyen platform to reach your running application
2. Add a Standard webhook in your Customer Area
### Making your server reachable
Your endpoint that will consume the incoming webhook must be publicly accessible.
There are typically 3 options:
* deploy on your own cloud provider
* deploy on Gitpod
* expose your localhost with tunneling software (i.e. ngrok)
#### Option 1: cloud deployment
If you deploy on your cloud provider (or your own public server) the webhook URL will be the URL of the server
```
https://{cloud-provider}/api/webhooks/notifications
```
#### Option 2: Gitpod
If you use Gitpod the webhook URL will be the host assigned by Gitpod
```
https://myorg-myrepo-y8ad7pso0w5.ws-eu75.gitpod.io/api/webhooks/notifications
```
**Note:** when starting a new Gitpod workspace the host changes, make sure to **update the Webhook URL** in the Customer Area
#### Option 3: localhost via tunneling software
If you use a tunneling service like [ngrok](ngrok) the webhook URL will be the generated URL (ie `https://c991-80-113-16-28.ngrok.io`)
```bash
$ ngrok http 8080
Session Status online
Account ############
Version #########
Region United States (us)
Forwarding http://c991-80-113-16-28.ngrok.io -> http://localhost:8080
Forwarding https://c991-80-113-16-28.ngrok.io -> http://localhost:8080
```
**Note:** when restarting ngrok a new URL is generated, make sure to **update the Webhook URL** in the Customer Area
### Set up a webhook
* In the Customer Area go to Developers -> Webhooks and create a new 'Standard notification' webhook.
* Enter the URL of your application/endpoint (see options [above](#making-your-server-reachable))
* Define username and password for Basic Authentication
* Generate the HMAC Key
* Optionally, in Additional Settings, add the data you want to receive. A good example is 'Payment Account Reference'.
* Make sure the webhook is **Enabled** (therefore it can receive the notifications)
That's it! Every time you perform a new payment, your application will receive a notification from the Adyen platform.
## Contributing
We commit all our new features directly into our GitHub repository. Feel free to request or suggest new features or code changes yourself as well!
Find out more in our [Contributing](https://github.com/adyen-examples/.github/blob/main/CONTRIBUTING.md) guidelines.
## License
MIT license. For more information, see the **LICENSE** file in the root directory.