Sofort Redirect Component

If you have an existing Android Components integration, you can use our Redirect Component to redirect the shopper to the Sofort app or website where they can complete the payment.

When making a Sofort payment, you need to:

• Include Sofort in the list of available payment methods.
• Handle the redirect.

Before you begin

This page explains how to add Sofort to your existing Android Components integration. The Android Components integration works the same way for all payment methods. If you haven't done this integration yet, refer to our Components integration guide.

Before starting your Sofort integration:

1. Make sure that you have set up your back end implementation for making API requests.
2. Add Sofort in your test Customer Area.

Show Sofort in your payment form

Include Sofort in the list of available payment methods. You don't need to collect any information from the shopper in your payment form.

1. Specify in your /paymentMethods request one of the following combinations of countryCode and amount.currency:

   Country	countryCode	amount.currency
   Austria	AT	EUR
   Belgium	BE	EUR
   Finland	FI	EUR
   France	FR	EUR
   Germany	DE	EUR
   Italy	IT	EUR
   Spain	ES	EUR
   Switzerland	CH	CHF
   The Netherlands	NL	EUR
   United Kingdom	GB	GBP

The /paymentMethods response contains paymentMethod.type: directEbanking.

Make a payment

When the shopper proceeds to pay, you need to:

1. From your server, make a /payments request, specifying:

   Parameter	Required	Description
   paymentMethod.type		Set this to directEbanking.
   returnUrl		URL to where the shopper should be redirected back to after they complete the payment. Get this URL from the Component in the RedirectComponent.getReturnUrl(context).
   countryCode		The shopper's country in a two-letter country code format. Include this in the request for a better shopper experience. When the shopper is redirected to Sofort's website, the country will be automatically selected from the dropdown list.
   shopperLocale		The language that the Sofort page should be rendered in. The page can be the country's language (for example, nl-NL for the Netherlands) or in en-US.

   Here is how you would make a payment request for 10 EUR for a shopper in the Netherlands, with the Sofort page rendered in US English.

   curl Ruby Java PHP Python C# NodeJS

   curl Ruby Java PHP Python C# NodeJS

   curl https://checkout-test.adyen.com/v68/payments \
   -H "x-API-key: YOUR_X-API-KEY" \
   -H "content-type: application/json" \
   -d '{
     "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
     "reference":"YOUR_ORDER_NUMBER",
     "amount":{
       "currency":"EUR",
       "value":1000
     },
     "{hint:paymentComponentState.data.paymentMethod from app}paymentMethod{/hint}":{
       "type":"directEbanking""
     },
     "{hint:Optional}countryCode{/hint}": "NL",
     "{hint:Optional}shopperLocale{/hint}": "en-US",
     "returnUrl":"adyencheckout://your.package.name"
   }'

   # Set your X-API-KEY with the API key from the Customer Area.
   adyen = Adyen::Client.new
   adyen.api_key = "YOUR_X-API-KEY"
    
   response = adyen.checkout.payments({
     :amount => {
       :currency => "EUR",
       :value => 1000
     },
     :reference => "YOUR_ORDER_NUMBER",
     :paymentMethod => {
       :type => "directEbanking"
     },
     :countryCode => "NL",
     :returnUrl => "adyencheckout://your.package.name",
     :merchantAccount => "YOUR_MERCHANT_ACCOUNT"
   })

   // Set YOUR_X-API-KEY with the API key from the Customer Area.
   // Change to Environment.LIVE and add the Live URL prefix when you're ready to accept live payments.
       Client client = new Client("YOUR_X-API-KEY", Environment.TEST);
       Checkout checkout = new Checkout(client);
   
       PaymentsRequest paymentsRequest = new PaymentsRequest();
   
       String merchantAccount = "YOUR_MERCHANT_ACCOUNT";
       paymentsRequest.setMerchantAccount(merchantAccount);
   
       Amount amount = new Amount();
       amount.setCurrency("EUR");
       amount.setValue(15000L);
       paymentsRequest.setAmount(amount);
   
       DefaultPaymentMethodDetails paymentMethodDetails = new DefaultPaymentMethodDetails();
       paymentMethodDetails.setType("directEbanking");
       paymentsRequest.setPaymentMethod(paymentMethodDetails);
   
       paymentsRequest.setReference("YOUR_ORDER_NUMBER");
       paymentsRequest.setReturnUrl("adyencheckout://your.package.name");
       paymentsRequest.setCountryCode("NL");
       paymentsRequest.setCountryCode("NL");
       paymentsRequest.setShopperLocale("en-US");
   
       PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);

   // Set your X-API-KEY with the API key from the Customer Area.
   $client = new \Adyen\Client();
   $client->setXApiKey("YOUR_X-API-KEY");
   $service = new \Adyen\Service\Checkout($client);
   
   $params = array(
     "amount" => array(
       "currency" => "EUR",
       "value" => 1000
     ),
     "reference" => "YOUR_ORDER_NUMBER",
     "paymentMethod" => array(
       "type" => "directEbanking"
     ),
     "countryCode" => "NL",
     "shopperLocale" => "en-US",
     "returnUrl" => "adyencheckout://your.package.name",
     "merchantAccount" => "YOUR_MERCHANT_ACCOUNT"
   );
   $result = $service->payments($params);

   #Set your X-API-KEY with the API key from the Customer Area.
   adyen = Adyen.Adyen()
   adyen.client.xapikey = 'YOUR_X-API-KEY'
   
   result = adyen.checkout.payments({
      'amount': {
         'value': 1000,
         'currency': 'EUR'
      },
      'reference': 'YOUR_ORDER_NUMBER',
      'paymentMethod': {
         'type': 'directEbanking'
      },
      'countryCode': 'NL',
      'shopperLocale': 'en-US',
      'returnUrl': 'adyencheckout://your.package.name',
      'merchantAccount': 'YOUR_MERCHANT_ACCOUNT'
   })

   // Set your X-API-KEY with the API key from the Customer Area.
   var client = new Client ("YOUR_X-API-KEY", Environment.Test);
   var checkout = new Checkout(client);
   
   var amount = new Adyen.Model.Checkout.Amount("EUR", 1000);
   var details = new Adyen.Model.Checkout.DefaultPaymentMethodDetails{
     Type = "directEbanking"
   };
   var paymentsRequest = new Adyen.Model.Checkout.PaymentRequest
   {
     Reference = "YOUR_ORDER_NUMBER",
     Amount = amount,
     ReturnUrl = @"adyencheckout://your.package.name",
     MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
     PaymentMethod = details,
     CountryCode = "NL",
     ShopperLocale = "en-US"
   };
   
   var paymentResponse = checkout.Payments(paymentsRequest);

   // Set your X-API-KEY with the API key from the Customer Area.
   const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
   const config = new Config();
   // Set your X-API-KEY with the API key from the Customer Area.
   config.apiKey = '[API_KEY]';
   config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]';
   const client = new Client({ config });
   client.setEnvironment("TEST");
   const checkout = new CheckoutAPI(client);
   checkout.payments({
       amount: { currency: "EUR", value: 1000 },
       paymentMethod: {
           type: 'directEbanking'
       },
       reference: "YOUR_ORDER_NUMBER",
       merchantAccount: config.merchantAccount,
       countryCode: "NL",
       shopperLocale: "en-US",
       returnUrl: "adyencheckout://your.package.name"
   }).then(res => res);

   https://docs.adyen.com/payment-methods/sofort/android-component#android-payments

   The /payments response contains an action object with the information needed to redirect the shopper.

{
   "resultCode":"RedirectShopper",
   "action":{
      "paymentMethodType":"directEbanking",
      "method":"GET",
      "url":"https://checkoutshopper-test.adyen.com/checkoutshopper/checkoutPaymentRedirect?redirectData=...",
      "type":"redirect"
   }
}

2. Pass the action object to your client app.

Handle the redirect

1. Use the Redirect Component to redirect the shopper to Sofort.

2. After the shopper returns to your app, make a POST /payments/details request from your server, providing:

   • details: The actionComponentData.details object from the Redirect Component.

curl https://checkout-test.adyen.com/v68/payments/details \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
     "details": {
       "redirectResult": "eyJ0cmFuc1N0YXR1cyI6IlkifQ=="
   }
}'

You receive a response containing:

• resultCode: Use this to present the payment result to your shopper.
• pspReference: Our unique identifier for the transaction.

{
      "resultCode": "Authorised",
      "pspReference": "PPKFQ89R6QRXGN82"
}

Present the payment result

Use the  resultCode that you received in the /payments/details response to present the payment result to your shopper.

The resultCode values you can receive for Sofort are:

If the shopper failed to return to your website or app, wait for webhooks to know the outcome of the payment:

Recurring payments

We support recurring transactions for Sofort through SEPA Direct Debit. To make recurring payments, you need to:

1. Create a shopper token.
2. Use the token to make future payments for the shopper.

Create a token

To create a token, include in your /payments request:

• storePaymentMethod: true
• shopperReference: Your unique identifier for the shopper (minimum length three characters).

When the payment has been settled, you receive a webhook containing:

• eventCode: RECURRING_CONTRACT
• originalReference: The pspReference of the initial payment.
• pspReference: This is the token that you need to make recurring payments for this shopper.

Make a payment with a token

To make a payment with the token, include in your /payments request:

• paymentMethod.storedPaymentMethodId: The pspReference from the RECURRING_CONTRACT.

• shopperReference: The unique shopper identifier that you specified when creating the token.
• shopperInteraction: ContAuth.
• recurringProcessingModel: Subscription or UnscheduledCardOnFile.

For more information about the shopperInteraction and recurringProcessingModel fields, refer to Recurring transaction types.

curl https://checkout-test.adyen.com/v68/payments \
-H "x-API-key: YOUR_X-API-KEY" \
-H "content-type: application/json" \
-d '{
       "amount":{
          "value":1000,
          "currency":"EUR"
       },
       "paymentMethod":{
          "type":"sepadirectdebit",
          "storedPaymentMethodId":"7219687191761347"
       },
       "reference":"YOUR_ORDER_NUMBER",
       "merchantAccount":"YOUR_MERCHANT_ACCOUNT",
       "shopperReference":"YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
       "shopperInteraction":"ContAuth",
       "recurringProcessingModel": "Subscription"
}'

# Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen::Client.new
adyen.api_key = "YOUR_X-API-KEY"
 
response = adyen.checkout.payments({
  :amount => {
    :currency => "EUR",
    :value => 1000
  },
  :reference => "YOUR_ORDER_NUMBER",
  :paymentMethod => {
    :type => "sepadirectdebit",
    :storedPaymentMethodId => "7219687191761347"
  },
  :returnUrl => "https://your-company.com/checkout?shopperOrder=12xy..",
  :shopperReference => "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
  :merchantAccount => "YOUR_MERCHANT_ACCOUNT",
  :shopperInteraction => "ContAuth",
  :recurringProcessingModel => "Subscription"
})

// Set YOUR_X-API-KEY with the API key from the Customer Area.
// Change to Environment.LIVE and add the Live URL prefix when you're ready to accept live payments.
Client client = new Client("YOUR_X-API-KEY", Environment.TEST);
Checkout checkout = new Checkout(client);

PaymentsRequest paymentsRequest = new PaymentsRequest();

String merchantAccount = "YOUR_MERCHANT_ACCOUNT";
paymentsRequest.setMerchantAccount(merchantAccount);

Amount amount = new Amount();
amount.setCurrency("EUR");
amount.setValue(15000L);
paymentsRequest.setAmount(amount);

SepaDirectDebitDetails paymentMethodDetails = new SepaDirectDebitDetails();
paymentMethodDetails.setStoredPaymentMethodId("7219687191761347");
paymentMethodDetails.setType("sepadirectdebit");
paymentsRequest.setPaymentMethod(paymentMethodDetails);

paymentsRequest.setReference("YOUR_ORDER_NUMBER");
paymentsRequest.setReturnUrl("https://your-company.com/checkout?shopperOrder=12xy..");
paymentsRequest.setShopperInteraction(PaymentsRequest.ShopperInteractionEnum.CONTAUTH);
paymentsRequest.setRecurringProcessingModel(PaymentsRequest.RecurringProcessingModelEnum.SUBSCRIPTION);

PaymentsResponse paymentsResponse = checkout.payments(paymentsRequest);

// Set your X-API-KEY with the API key from the Customer Area.
$client = new \Adyen\Client();
$client->setXApiKey("YOUR_X-API-KEY");
$service = new \Adyen\Service\Checkout($client);

$params = array(
  "amount" => array(
    "currency" => "EUR",
    "value" => 1000
  ),
  "reference" => "YOUR_ORDER_NUMBER",
  "paymentMethod" => array(
    "type" => "sepadirectdebit",
    "storedPaymentMethodId" => "7219687191761347"
  ),
  "returnUrl" => "https://your-company.com/checkout?shopperOrder=12xy..",
  "shopperReference" => "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
  "recurringProcessingModel" => "Subscription",
  "shopperInteraction" => "ContAuth",
  "merchantAccount" => "YOUR_MERCHANT_ACCOUNT"
);
$result = $service->payments($params);

#Set your X-API-KEY with the API key from the Customer Area.
adyen = Adyen.Adyen()
adyen.client.xapikey = 'YOUR_X-API-KEY'

result = adyen.checkout.payments({
   'amount': {
      'value': 1000,
      'currency': 'EUR'
   },
   'reference': 'YOUR_ORDER_NUMBER',
   'paymentMethod': {
      'type': 'sepadirectdebit',
      'storedPaymentMethodId': '7219687191761347'
   },
   'returnUrl': 'https://your-company.com/checkout?shopperOrder=12xy..',
   'shopperReference': 'YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j'
   'merchantAccount': 'YOUR_MERCHANT_ACCOUNT',
   'shopperInteraction':'ContAuth',
   'recurringProcessingModel': 'Subscription'
})

// Set your X-API-KEY with the API key from the Customer Area.
var client = new Client ("YOUR_X-API-KEY", Environment.Test);
var checkout = new Checkout(client);

var amount = new Adyen.Model.Checkout.Amount("EUR", 1000);
var details = new Adyen.Model.Checkout.DefaultPaymentMethodDetails{
  Type = "sepadirectdebit",
  StoredPaymentMethodId = "7219687191761347"
};
var paymentsRequest = new Adyen.Model.Checkout.PaymentRequest
{
  Reference = "YOUR_ORDER_NUMBER",
  Amount = amount,
  ReturnUrl = @"https://your-company.com/checkout?shopperOrder=12xy..",
  MerchantAccount = "YOUR_MERCHANT_ACCOUNT",
  ShopperReference = "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
  RecurringProcessingModel = Adyen.Model.Checkout.PaymentRequest.RecurringProcessingModelEnum.Subscription,
  ShopperInteraction = Adyen.Model.Checkout.PaymentRequest.ShopperInteractionEnum.ContAuth,
  PaymentMethod = details
};

var paymentResponse = checkout.Payments(paymentsRequest);

// Set your X-API-KEY with the API key from the Customer Area.
const {Client, Config, CheckoutAPI} = require('@adyen/api-library');
const config = new Config();
// Set your X-API-KEY with the API key from the Customer Area.
config.apiKey = '[API_KEY]';
config.merchantAccount = '[YOUR_MERCHANT_ACCOUNT]';
const client = new Client({ config });
client.setEnvironment("TEST");
const checkout = new CheckoutAPI(client);
checkout.payments({
    amount: { currency: "EUR", value: 1000 },
    paymentMethod: {
        type: 'sepadirectdebit',
        storedPaymentMethodId: "7219687191761347"
    },
    reference: "YOUR_ORDER_NUMBER",
    merchantAccount: config.merchantAccount,
    shopperReference: "YOUR_UNIQUE_SHOPPER_ID_IOfW3k9G2PvXFu2j",
    returnUrl: "https://your-company.com/checkout?shopperOrder=12xy..",
    shopperInteraction: "ContAuth",
    recurringProcessingModel: "Subscription"
}).then(res => res);

Chargebacks

In extremely rare scenarios (around 0.2% of all cases), it can happen that you will not receive the funds, even after receiving a successful AUTHORISATION webhook. The successful AUTHORISATION webhook means that the payment has passed the verifications that Sofort runs on the shopper account, and that the bank transfer was initiated successfully. The payment could still fail at this point, for example because:  

• The shopper cancelled the transaction.  A number of German banks offer shoppers the possibility to cancel bank transfers until midnight of the day of the transaction. In Switzerland, banks are required by law to allow shoppers to reverse bank transfers for 48 hours. 
• Some banks process transactions with a delay. For example, if the shopper completes a Sofort payment on a Saturday, the bank might only process it on Monday. If the shopper has withdrawn sufficient funds in the meantime, the payment will fail. 

In case of the above scenarios, Adyen is not informed about the transaction having failed. This means that we do not know whether the transaction has failed, or whether the bank might still process it later. 

On our side, the status of the payment is SentForSettle until we receive the funds. You can check the status of the payment in your Customer Area.

If we have not received the funds after 8 business days, the status of the payment becomes Settled, then Chargeback, and you will receive a CHARGEBACK webhook.

In case we receive the money after this point, you will receive a CHARGEBACK_REVERSED webhook. 

Test and go live

Sofort does not have a specialized test environment. This means that you are redirected to the Sofort live environment even when making a payment from the Adyen test environment.

You can test successful and cancelled payments in EUR for Sofort. For other scenarios, use real payment details and small amounts in your live environment.

Test a successful payment

To test your integration, use the following details: 

1. Set the paymentMethod type to directEbanking. This redirects you to the Sofort page.
2. Under Bank name, select Demo Bank, then Next.
3. Enter any test login details for Account number and PIN, and select Next.
4. Select an account, then Next.
5. Enter any test TAN and select Next.
6. To check the status of your test payment, go to your test Customer Area > Transactions > Payments.

Test a cancelled payment

1. Set the paymentMethod type to directEbanking. This redirects you to the Sofort page.
2. Under Bank name, select Demo Bank.
3. Select Next.
4. Select the icon.
5. Select Cancel payment.
6. To check the status of your test payment, go to your test Customer Area > Transactions > Payments.

Go live

To accept live Sofort payments, you must submit a request for Sofort in your live Customer Area.

See also