Skip to main content

​
Setup

Please follow the common Adyen instructions to get set up with Adyen.

​
Features

After setting up an Adyen account it is recommended to configure the following things in the developer area so all features can be used. Go to Developers -> Additional data in the Adyen dashboard and then make sure the following fields are selected.
  • Recurring Details
  • Raw acquirer result
  • Payment account reference

​
Auto-rescue

Adyen’s auto-rescue feature is supported by this connector. This feature automatically retries customer-not-present card transactions when they are declined on the first request. To enable this feature, pass in the following connection options for Adyen when making a subsequent payment request. 
POST /transactions

{
    "amount": 1299,
    "country": "US",
    "currency": "USD",
    "intent": "capture",
    "payment_method": {
        "method": "id",
        "id": "7f6fb9ca-eb1c-42c6-9b65-8f1c699b84bd"
    },
    "connection_options": {
        "adyen-card": {
            "autoRescue": true,
            "maxDaysToRescue": 5
        }
    },
    "payment_source": "card_on_file",
    "is_subsequent_payment": true,
    "merchant_initiated": true
}
Please note that this feature only works for customer-not-present transaction where is_subsequent_payment is set to true.
The following fields need to be set.
  • autoRescue - A boolean value that enables the feature. This defaults to false.
  • maxDaysToRescue - The rescue window, in days. Can specify between 1 and 48 days. Adyen recommends using a rescue window of one calendar month (30 days).
  • autoRescueScenario - This is one of the test scenarios as defined by Adyen. This only works in sandbox. Please be aware that the webhooks from Adyen in these test scenarios may take a few minutes to arrive.
A transaction is marked as processing when a transaction has been accepted for automatic retries using this feature. When a webhook for a successful payment or an eventual rejection is received, the status is updated accordingly.
For auto-rescue to work it’s important to ensure Adyen has been setup to send webhooks in a JSON format.

​
Canceling auto-rescue

While a payment is in the rescue process, the buyer may provide a new payment method or reach out to cancel their subscription. In these scenarios, the rescue process can be canceled. To cancel the auto-rescue process, perform a cancel request on the transaction. Once Adyen has processed the cancellation and confirmation via webhook has been received, the transaction is marked as canceled.

​
Balance splits

Adyen’s balance splits feature is supported by this connector. This feature allows determining where to book the funds at transaction time. Please note the users’ stores can be configured to automatically split all transactions. This means that it is not necessary to send these split instructions in every payment or capture request. To enable this feature, pass in the following connection options for Adyen when making a payment request. 
POST /transactions

{
    "amount": 4000,
    "country": "US",
    "currency": "USD",
    "intent": "capture",
    "payment_method": {
        ...
    },
    "connection_options": {
        "adyen-card": {
            "splits": {
                "authorization": [
                    {
                        "account": "MARKETPLACE_ACCOUNT1",
                        "amount": {
                            "currency": "USD",
                            "value": 200
                        },
                        "description": "Marketplace fee",
                        "reference": "YOUR_UNIQUE_REFERENCE1",
                        "type": "BalanceAccount"
                    },
                    {
                        "account": "MARKETPLACE_ACCOUNT2",
                        "amount": {
                            "currency": "USD",
                            "value": 200
                        },
                        "description": "Remainder",
                        "reference": "YOUR_UNIQUE_REFERENCE2",
                        "type": "Remainder"
                    },
                ],
                "capture": [...],
                "refund": [...]
            }
        }
    }
}
The split information can be defined to be set at time of authorization, capture, or even for refunds. Please note the PUT /transactions/{id} API can be used to update connection options (and therefore splits) before making a capture or refund. Please refer to Adyen’s balance splits documentation for exact details on each of the split objects.

​
Payouts / original credit transactions

Adyen Transfers API is supported by this connector to enable Payouts/Original Credit Transactions. This feature needs to be enabled in the Adyen “account” for it to work. A balance account id also needs to be provided in the configuration of the Adyen connection in the dashboard. Payouts are funded from this balance account.