Payment Provider Adyen

Payment Provider Adyen

Connect Adyen to instellix to charge customers, receive payment status updates, and import settlement reports for accounting and payment assignment.

This article covers the Adyen setup in Adyen and in the instellix webportal. For automatic retries after failed charges, see Payment Retry Configuration.

Requirements

  • An Adyen company / merchant account
  • Access to Adyen Developers (API credentials and webhooks) and Reports
  • Permission to configure Integration > Payment Providers in instellix
  • A Merchant Payment Account and Merchant Payment Gateway for Adyen

Setup overview

StepWherePurpose
1Adyen + instellixWeb Service API key for charging (payment intents)
2Adyen + instellixWebhooks for payment and settlement events
3Adyen + instellixReport API key + automated Settlement Details report
4instellixMerchant Payment Account + Gateway
5instellixCustomer Payment Accounts (tokenized payment methods)
6instellixRetry Strategy (optional)

1. Charging credentials (Web Service User)

In Adyen

  1. Go to Developers > API credentials.
  2. Create new credentials of type Web Service User.
  3. Generate and copy the API key.

In instellix

Go to: Integration > Payment Providers > Adyen

  1. Enter the Adyen Web Service User API key.

  2. Enter the Adyen Merchant Account name (the merchant account in Adyen — not a username such as ws@…).

  3. For production, enter the live URL prefix only (not the full URL).
    In Adyen: Developers > API URLs. The checkout URL looks like:

    https://[prefix]-checkout-live.adyenpayments.com/checkout/v{version}/{method}

    Enter only the [prefix] part. On stage/test, leave the live URL prefix empty.

  4. Save.


2. Webhook configuration

Webhooks allow instellix to receive payment intent updates and settlement-related events from Adyen.

In Adyen

  1. Go to Developers > Webhooks.
  2. Create a new webhook (typically Standard webhook).
  3. Under HMAC, generate a new HMAC key and copy it.

In instellix

Go to: Integration > Payment Providers > Adyen

  1. Open Webhook Configuration.
  2. Paste the Adyen HMAC key and save.
  3. instellix shows a username and password.
    Copy the password immediately — it is shown only once (you can regenerate later if needed).

Back in Adyen

  1. Enter the instellix webhook username and password on the Adyen webhook.
  2. Save the webhook.
  3. Optionally use Test Configuration in Adyen to send a test message to instellix.

After this, webhooks are received for payment intents and settlement reports.


3. Settlement reports

So that Adyen settlement data can be processed in instellix, configure reporting in both systems.

In Adyen

  1. Create API credentials of type Report Service User (Developers > API credentials) and copy the API key.
  2. Go to Reports > Settlement Details.
  3. Enable Generate > Automated (typically Daily).

In instellix

Go to: Integration > Payment Providers > Adyen

  1. Enter the Report API key.
  2. Select / enter the related Adyen Merchant Payment Account.
  3. Save.

Journal types processed by instellix

instellix processes the following Adyen settlement journal types from the Settlement Details report:

Adyen typeTypical meaning
SettledSuccessful customer payment
RefundedRefund to the customer
RefundedReversedReversal of a previous refund
ChargebackChargeback / dispute debit
SecondChargebackSecond chargeback
ChargebackReversedChargeback won / reversed (credit back)
FeeProvider fees
MerchantPayoutPayout to your merchant account
MerchantPayinPay-in to the merchant account
InvoiceDeductionInvoice deduction
DepositCorrectionDeposit correction
ReserveAdjustmentReserve adjustment

Balancetransfer rows are ignored (informational only; no settlement item is created).

Chargeback-related fees from the report (e.g. commission on chargeback lines) are mapped into the settlement item fee structure where applicable.


4. Merchant Payment Account and Gateway

  1. Create a Merchant Payment Account with payment provider Adyen:
    Configuration > Payment > Merchant Payment Account
  2. Create a Merchant Payment Gateway and attach that account (per currency as needed):
    Configuration > Payment > Merchant Payment Gateways

Learn more: Merchant Payment Accounts · Merchant Payment Gateways


5. Customer Payment Accounts (CPA)

For charging, each customer needs a Customer Payment Account that references the tokenized payment method in Adyen.

Typical mapping:

instellix CPA fieldAdyen value
Payment method referencetokenization.storedPaymentMethodId
Payment provider referencetokenization.shopperReference

Also select the Adyen Merchant Payment Gateway on the CPA.

Learn more: Customer Payment Accounts

📘

Tokenization is usually created in your checkout / Adyen integration. For test setups, payment methods can be created via the Adyen test APIs and then stored as CPA references in instellix.


6. Retry Strategy

Under Integration > Payment Providers > Adyen, configure the Retry Strategy for recoverable failed charges (Retry Type, Retry Value, Max Retry Attempts).

See Payment Retry Configuration — including the Day-of-month rule.


Related articles


Did this page help you?