Adyen
Takes payments online through the workspace's own Adyen merchant account. Customers pay invoices, shop orders, event tickets and course places on an Adyen payment link page with the methods your account offers, the money settles straight into your account, and refunds go back the same way.
| At a glance | |
|---|---|
| Type | Add-on module |
| Group | Bill |
| Price | Free (Adyen charges its own fees on your account) |
| Provides | Take payments online, Generate payment links |
| Needs | The Payments module |
| Offered to | Every industry pack |
| Permission | Manage add-ons (addons.manage) to switch it on; Manage settings to connect the account |
What it does
Adyen is a payment gateway add-on module of Payments. While it is on and connected, Payments can:
- take payment online on an invoice's pay page (the shared receipt link and the customer portal), at the online shop's checkout, for event tickets, for course places and at the self-order kiosk. Each payment opens an Adyen payment link for exactly what is owed, valid for 24 hours, and the customer pays there with the methods your Adyen account offers;
- let staff Collect online on an invoice, with the Adyen page to send the customer;
- send money back through Adyen when a payment is refunded;
- make pay-now links, sent by text or WhatsApp (they need an SMS or WhatsApp add-on module as well).
Currencies. Almost every currency. Four are left out because Adyen counts their decimals differently from the way the workspace records money: CLP, ISK, CVE and IDR.
Switching it on
- Switch on Payments first (Workspace → Modules). Adyen needs it, so the switch is refused while Payments is off.
- Set the filter to Add-on modules. Adyen is under Bill.
- Open its ⋮ menu, choose Enable, and press Enable in the dialog. There is nothing to fill in there.
- Choose Connect under Settings → Payments on its ⋮ menu and connect your account (below).
Connecting your Adyen account
Settings → Payments, provider Adyen:
| Field | What to enter |
|---|---|
| API key | The API key of an API credential (Customer Area → Developers → API credentials). Write-only. |
| Merchant account | The merchant account that takes the payments, exactly as the Customer Area shows it. |
| Live URL prefix | For Live only: live Customer Area → Developers → API URLs → Prefix, e.g. 1797a841fbb37ca7-AdyenDemo. |
| Webhook HMAC key | The key generated for the webhook you add (below). Write-only. |
| Environment | Test (no real money) or Live. Adyen's keys do not say which. |
| Accept payments through this gateway | Tick it to take payments. Needs the API key and the merchant account (and the prefix for Live). |
The webhook. Copy the Webhook address from the card. In the Customer Area (Developers → Webhooks → Add webhook → Standard webhook) add that address for the merchant account, generate an HMAC key, paste it into Webhook HMAC key and Save. Every notification is checked with that key, and only notifications for your merchant account are taken.
The webhook matters more for Adyen than for other gateways. Adyen's own payment reference arrives only in its notification, and a refund needs that reference. Without the webhook, a payment is still recorded when Adyen's payment link says it is paid, but it cannot be refunded from here (refund it in the Customer Area and record the refund here). Adyen also tells us how a refund ended only by its notification.
One gateway takes payments at a time. To move to another, switch this one's Accept payments off first.
Turning it off
Turn off on the ⋮ menu asks first. New online payments through Adyen stop at once, and Adyen leaves Settings → Payments. Payments already under way are still recorded when Adyen confirms them, refunds of earlier payments still go back through it, and the keys stay saved for when it is switched on again. While Adyen is on, Payments cannot be switched off.
Ready-made automations
None of its own. The moments around a payment (one that fails, a pay-now link to send) are the Payments module's ready-made automations.
In the desktop and mobile apps
Not carried. The apps take payment at the counter.