To use the Adyen payment module, register in the payment system and configure the module on the BILLmanager side.
Configuring BILLmanager
To create a payment module, enter Provider → Payment methods → click Add. The payment module adding wizard consists of the following steps:
- Select a payment methods: "Adyen".
- Integration settings. Specify the data for integration:
- Test mode — select the checkbox to activate a test mode for this payment method. The system won't charge the client but will process the payments correctly;
- String and company name — a unique name of your company that is used for requests to Adyen. Learn more under Live endpoints.
- Merchant account — the name of the Adyen merchant account. For more information please refer to the article Manage your account structure
- Checkout API key — a unique key for connecting to the Adyen API system. To get the key, go to the Developers → API credentials section on the payment system side and select the required credential entry. For more information on obtaining the key, see the Adyen documentation.
- Username — the value specified on the Adyen side. To find it, go to Developers → API credentials, open the required credential entry and copy the Username value.
- Password — the value specified on the Adyen side. To find it, go to Developers → API credentials and open the required credential entry. The password is displayed when creating a new entry or after regenerating it using the Generate password button.
- HMAC key — a unique combination for encryption. To get it, go to Developers → Webhooks on the Adyen side. The key is only visible when creating a new webhook.
- HMAC generation date in Adyen — the date when the HMAC signature was configured in Adyen. Leave the field empty to verify the signature for all notification messages regardless of when they were created.
- Client groups and risk profiles — a setting for risk evaluation rules for the payment session. Select client groups and assign a risk profile from the available list to them. Specify the default profile for clients outside these groups.
- Recurring payments — an option to enable recurring payments through this module. Recurring payments in BILLmanager are used for automatic replenishment of the client area account.
- Allow refunds — an option to allow refunds through this module.
- Payment method settings. Configure internal (within BILLmanager) parameters of the service payment module. For more details, see How to add a payment gateway module.
Configuration on the payment system side
To configure automatic synchronization of payment statuses in Adyen and BILLmanager:
- Log in to the Adyen client area.
- Go to Developers → Webhooks.
-
In the URL field, specify the address for receiving notifications from the payment system: billmgrURL/mancgi/adyennotify
.Explanation - In the Encryption protocol field, select a value depending on the SSL certificate version:
TLSv1.3orTLSv1.2. - Enable the Accept expired, Accept self-signed, and Accept untrusted Root Certificates options for the synchronization to work correctly.
-
Specify User Name and Password in the Authentication block.
The specified combination is needed for configuration on the BILLmanager side. -
To encrypt notifications when they are sent, in the Addition Settings block click Generate new HMAC key.
The resulting key is needed for configuration on the BILLmanager side. - In the BILLmanager web interface:
- Go to Provider → Payment methods → click Edit.
- Enable the Accept notifications from Adyen option.
Additional information
Refunds
To refund payments, enable the option in the payment method settings: Provider → Payment methods → click Edit → Allow payment refunds option. Refunds are supported for payments with the “Credited” status.
Logging
Adyen has the following log files:
- /usr/local/mgr5/var/pmadyen.log — configuration details of the payment method and refunds;
- /usr/local/mgr5/var/adyenpayment.log — payment log;
- /usr/local/mgr5/var/adyenresult.log — responses from the payment gateway. The file is not present if no responses were received from the payment gateway;
- /usr/local/mgr5/var/adyenrecurring.log — recurring payments log. The file is not present if recurring payments are not enabled;
- /usr/local/mgr5/var/adyenrecresult.log — responses from the payment gateway when recurring payments are activated. The file is not present if recurring payments are not enabled;
- /usr/local/mgr5/var/adyennotify.log — Adyen payment status notification log. The file is not present if no notifications were sent from the payment gateway.
Request parameters
The platform sends additional data in requests to Adyen:
shopperIP— client's IP address;shopperEmail— client's email address;accountInfo.accountCreationDate— client's registration date in the platform.
Related topics:
En
Es