Payment-method icon

Sofort for API only

Add Sofort to an existing API-only integration.

Accept Sofort payments using our APIs, and build your own payment form to have full control over the look and feel of your checkout page.

Requirements

Requirement Description
Integration type Make sure that you have built an API-only integration.
Setup steps Before you begin, add Sofort in your test Customer Area.

Build your payment form for Sofort

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

We provide logos for Sofort which you can use on your payment form. For more information, refer to Downloading logos.

If you are using the /paymentMethods request to show available payment methods to the shopper, specify in your request one of the following combinations of countryCode and amount.currency:

Country/region countryCode amount.currency
Austria AT EUR
Belgium BE EUR
Germany DE EUR
Spain ES EUR
Switzerland CH CHF
The Netherlands NL EUR

The /paymentMethods response contains paymentMethod.type: directEbanking.

We provide logos for Sofort which you can use on your payment form. For more information, refer to Downloading logos.

Make a payment

In your /payments request, specify:

Parameter Required Description
paymentMethod.type -white_check_mark- Set this to directEbanking.
returnUrl -white_check_mark- URL to where the shopper should be redirected back to after they complete the payment.
countryCode The shopper's country/region.
Format: the two-letter ISO-3166-1 alpha-2 country code. Exception: QZ (Kosovo). Include this in the request for a better shopper experience. When the shopper is redirected to Sofort's website, the country/region will be automatically selected from the dropdown list.
shopperLocale The language that the Sofort page should be rendered in. The page can be the local language (for example, nl-NL for the Netherlands) or in en-US.

The following example shows how to make a payment request for 10 EUR for a shopper in the Netherlands, with the Sofort page rendered in US English.

In the  /payments response, note the `action` object. This contains the information needed to redirect the shopper.

<div data-component-wrapper="code-sample">
<code-sample
    :title="'/payments response'"
    :id="''"
    :code-data="[{&quot;language&quot;:&quot;json&quot;,&quot;tabTitle&quot;:&quot;&quot;,&quot;content&quot;:&quot;{\n   \&quot;resultCode\&quot;:\&quot;RedirectShopper\&quot;,\n   \&quot;action\&quot;:{\n      \&quot;paymentMethodType\&quot;:\&quot;directEbanking\&quot;,\n      \&quot;method\&quot;:\&quot;GET\&quot;,\n      \&quot;url\&quot;:\&quot;https:\/\/checkoutshopper-test.adyen.com\/checkoutshopper\/checkoutPaymentRedirect?redirectData=...\&quot;,\n      \&quot;type\&quot;:\&quot;redirect\&quot;\n   }\n}&quot;}]"
    :enable-copy-link-to-code-block="true"
    :code-sample-card-size="'fullsize'"
></code-sample>

Handle the redirect

  1. To complete the payment, redirect the shopper to the action.url returned in the /payments response, taking into account the following recommendations:

    • When using the HTTP GET method:
      For security reasons, when showing the redirect in the app, we recommend that you use SFSafariViewController for iOS or Chrome Custom Tabs for Android, instead of WebView objects. Also refer to the security best practices for WebView.

    • Redirection for mobile integrations:
      For mobile integrations, we strongly recommended that you redirect the shopper to the default browser of their device. Redirecting to the default browser ensures the best compatibility, handling of multi-factor authentication, app-to-app redirection, and error handling.

  2. After the shopper is redirected back to your website, check the payment result by making a POST /payments/details request, specifying:

    • details: object that contains the URL-decoded redirectResult returned when the shopper was redirected back to your site.

  3. In the response note the following:

    • resultCode: use this to present the result to your shopper.
    • pspReference: our unique identifier for the transaction.

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:

resultCode Description Action to take
Authorised The shopper completed their payment, and it has been sent to the bank for processing. In most cases, this means that you will receive the funds.
For information on exceptions, refer to Chargebacks.		 Inform the shopper that the payment has been successful.
Cancelled The shopper cancelled the payment while on their bank's website. Ask the shopper whether they want to continue with the order, or ask them to select a different payment method.
Error There was an error when the payment was being processed. Inform the shopper that there was an error processing their payment. The response contains a refusalReason, indicating the cause of the error.
Pending or
Received		 The shopper has completed the payment but the final result is not yet known. Inform the shopper that you have received their order, and are waiting for the payment to be completed.
You will receive the final result of the payment in an AUTHORISATION webhook.
Refused The payment was refused by the shopper's bank. Ask the shopper to try the payment again using a different payment method.

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

eventCode success field Description Action to take
AUTHORISATION false The transaction failed. Cancel the order and inform the shopper that the payment failed.
AUTHORISATION true The shopper successfully completed the payment. Inform the shopper that the payment has been successful and proceed with the order.

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

We strongly recommend that you request explicit permission from the shopper if you intend to make recurring SEPA payments. Being transparent about the payment schedule and the charged amount reduces the risk of chargebacks.

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 sure that your server is able to receive RECURRING_CONTRACT as part of your standard webhooks. You can enable the RECURRING_CONTRACT event code in the webhook settings page.

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.

You can also get this value using the /listRecurringDetails endpoint.

  • 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 Tokenization.

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: 

Bank Name Account Number Country/region PIN TAN
DemoBank Use any value DE Use any value Follow the instructions

Using a different bank name (live data) will initiate a real payment. This payment will not be transferred to your account, and is therefore lost. It is not possible to reverse or refund this payment.

  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