Setting Up Adyen Payment Gateway

Setting Up Adyen Payment Gateway

This guide will walk you through configuring Adyen as a payment method on your PushSales-powered website.

Prerequisites


Before you begin, ensure you have:
- An active Adyen merchant account
- Access to the Adyen Customer Area (https://ca-test.adyen.com for test, https://ca-live.adyen.com for live)
- Admin access to your PushSales website

Step 1: Gather Your Adyen Credentials


1.1 Get Your Merchant Account Name


1. Log into your **Adyen Customer Area**
2. Go to **Account** → **Merchant accounts**
3. Copy your **merchant account name** (e.g., "YourCompanyECOM")
4. Save this for later

1.2 Create API Credentials


1. In the Adyen Customer Area, go to **Developers** → **API credentials**
2. Click **Create new credential** (or use an existing Web Service credential)
3. Give it a descriptive name like "PushSales Integration"
4. Click **Save**

1.3 Generate API Keys


On the credential details page:

1. Scroll to **Authentication** section
2. Click **Generate API key** and copy the key (starts with `AQEy...`)
- **Important:** Save this immediately - you won't be able to see it again
- This is your **API Key (Server-side)**
3. Scroll to **Client Key** section
4. Copy the client key (starts with `test_...` or `live_...`)
- This is your **Client Key (Public)**

1.4 Configure Webhook Security


1. In the Adyen Customer Area, go to **Developers** → **Webhooks**
2. Click **+ Webhook** → **Add** next to **Standard notification**
3. Configure the webhook:
- Replace `yourwebsite.com` with your actual domain
- Make sure to use **HTTPS** (secure connection)
- **Method:** Select **JSON**
- **Active:** Toggle to **ON**
4. Under **Events to listen to**, select:
- ✅ AUTHORISATION
- ✅ CAPTURE
- ✅ REFUND
- ✅ REFUND_FAILED
5. Scroll to **Security** section
6. Click **Generate new HMAC key**
7. Copy the HMAC key and save it securely
8. Click **Save Configuration**

---

Step 2: Configure Adyen in Your PushSales Admin


1. Log into your **Push admin area**
2. Go to **Settings** → **Payment Integrations**
3. Locate the **Adyen** payment card
4. Click on the **Adyen** card to open the configuration modal

Fill in the following fields:

Enable Adyen Payments
- ✅ Check the box to enable Adyen

Merchant Account
- Enter your merchant account name from Step 1.1

API Key (Server-side)
- Paste the API key you generated in Step 1.3
- This field is password-protected for security

Client Key (Public)
- Paste the client key from Step 1.3

Environment
- Select **Test Mode** if you're still testing
- Select **Live Mode** when you're ready to accept real payments

Manual Capture
- Leave **unticked** for automatic capture (recommended)
- Check this box only if you want to manually review and capture payments

HMAC Key
- Paste the HMAC key you generated in Step 1.4
- This is used to verify webhook security

Optional: Custom Branding
- Display Name on Checkout: Customise the payment method label (e.g., "Pay by Card")
- Logo URL: Add a custom logo image URL if desired

5. Click Save Settings

Step 3: Test Your Integration


3.1 Test Mode Setup


Always test first before going live:

1. Make sure **Environment** is set to **Test Mode**
2. Use Adyen test credentials (from https://ca-test.adyen.com)
3. Go to your website's checkout page
4. Add an item to cart and proceed to checkout
5. Select **Adyen** (or your custom name) as the payment method

3.2 Test Cards


Use these Adyen test card numbers:

Successful Payment:
- Card number: `4111 1111 1111 1111`
- Expiry: Any future date (e.g., 03/30)
- CVV: `737`
- Cardholder name: Any name

Refused Payment (for testing failure scenarios):
- Card number: `4000 3000 0000 0003`
- Expiry: Any future date
- CVV: `737`

3D Secure Test:
- Card number: `5212 3456 7890 1234`
- Expiry: Any future date
- CVV: `737`
- 3DS password: `password`

3.3 Verify Test Payment


After completing a test payment:

1. Go to Admin → Orders
2. Find your test order
3. Verify the payment details panel shows:
- ✅ "LIVE" badge next to "Payment Details"
- Adyen logo/name
- PSP Reference number
- Status: "Authorised" or "Settled"
- Card details (last 4 digits)

---

Step 4: Go Live


Once testing is complete:

1. Switch to Live Credentials:
- Log into https://ca-live.adyen.com (live environment)
- Repeat Step 1 to get your **live** API credentials
- Create a new webhook pointing to your live website URL

2. Update Your PushSales Settings:
- Go back to **Settings** → **Payment Integrations** → **Adyen**
- Replace all test credentials with live credentials
- Change **Environment** to **Live Mode**
- Save settings

3. Test One More Time:
- Complete a small real transaction to verify everything works
- Check the order appears correctly in your admin area
- Verify the payment shows in your Adyen Customer Area

4. You're Live! 🎉

---

Common Settings Explained


Automatic vs Manual Capture


Automatic Capture (Recommended):
- Payments are captured immediately when authorized
- Funds are settled automatically
- Best for most e-commerce scenarios

Manual Capture:
- Payments are authorized but not captured
- You must manually capture via the order detail page
- Useful for:
- Pre-orders where you ship later
- High-value items requiring verification
- Drop-shipping scenarios

Pre-Order Support


Adyen automatically supports pre-orders:
- Customers pay a deposit at checkout
- Remaining balance is collected later
- Both transactions are tracked separately
- All references are visible in the admin order view

---

Troubleshooting


 Payment Method Doesn't Show at Checkout


Check:
1. Is "Enable Adyen payments" checked?
2. Did you click "Save Settings"?
3. Clear your browser cache and refresh checkout page
4. Check for any error messages in browser console (F12)

Webhook Not Working / Orders Stuck as Pending


Check:
1. Is your webhook URL correct and using HTTPS?
- You should see a message (not a 404 error)
3. Is the HMAC key correct?
4. Check webhook status in Adyen Customer Area → Developers → Webhooks
- Look for "Last delivery" status
- Check for any error messages

To test webhook manually:
1. Go to Adyen Customer Area → Developers → Webhooks
2. Click your webhook
3. Scroll to **Test configuration**
4. Click **Test** button
5. Check the response - should be `[accepted]`

"Invalid signature" Error


- Your HMAC key is incorrect
- Regenerate the HMAC key in Adyen Customer Area
- Update it in PushSales settings
- Save and test again

Payments Showing as "Test" in Live Mode


- You're using test API credentials in live mode
- Go back to Step 4 and ensure you're using **live** credentials from https://ca-live.adyen.com

---

Advanced Features


Manual Capture


If you enabled manual capture:

1. Go to **Orders** and open any order with Adyen payment
2. Scroll to **Payment Details** panel
3. When status shows "Authorised", click **Capture Payment** button
4. Confirm the capture
5. Order status will update to captured/settled

Refunds


To refund an Adyen payment:

1. Open the order in admin area
2. Scroll to **Payment Details** panel
3. If payment is captured/settled, click **Refund Payment** button
4. Enter refund amount (or leave blank for full refund)
5. Confirm the refund
6. Refund will process within 1-3 business days

---

Need Help?


If you're still having trouble:

1. Check the Adyen Customer Area → Reports → Payments to see if transactions are being received
2. Contact PushSales support with:
- Your merchant account name
- Order number experiencing issues
- Screenshots of any error messages
3. Check Adyen documentation: https://docs.adyen.com

---

Security Best Practices


✅ **Do:**
- Keep your API key secure and private
- Use HTTPS for your website and webhook URL
- Regularly rotate your API credentials
- Enable HMAC signature verification
- Test thoroughly before going live

❌ **Don't:**
- Share your API key or HMAC key with anyone
- Use live credentials in test mode (or vice versa)
- Disable HMAC signature verification
- Skip webhook configuration
- Go live without testing first
    • Related Articles

    • Advanced Mailchimp Marketing Integration

      If you want to use some of the more advanced features of Mailchimp (not the basic plan) you can connect your Push store to your Mailchimp account to enable tight integration between both platforms. This will give Mailchimp information on baskets, ...
    • Create a Voucher on Newsletter Subscription via Mailchimp

      With Push, you have the ability to set up email list monitoring for new subscribers. When a new subscriber is added, Push automatically assigns a unique code to the designated merge field associated with that subscriber. This merge field can then be ...
    • Integrate with Bikmo

      This guide details how to add the Bikmo integration to your website. In your website admin, go to Settings > Business Profile Add your Business Registered Number, Name and Address (this will be populated in the Bikmo T&Cs) Go to Bikmo: ...