Our Android Drop-in renders Sofort in your payment form, and redirects the shopper to Sofort to complete the payment.
Requirements
Requirement | Description |
---|---|
Integration type | Make sure that you have built your integration. |
Setup steps | Before you begin, add Sofort in your test Customer Area. |
Show Sofort in your payment form
Drop-in uses the countryCode
and the amount.currency
from your /paymentMethods request to show the available payment methods to your shopper.
To have Drop-in render Sofort in your payment form, 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 |
Make a payment
When the shopper proceeds to pay, Drop-in returns the paymentComponentData.paymentMethod
.
-
Pass the
paymentComponentData.paymentMethod
to your server. -
From your server, make a /payments request, specifying:
Parameter Required Description paymentMethod
The paymentComponentData.paymentMethod
from your client app.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/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="[{"language":"json","tabTitle":"","content":"{\n \"resultCode\":\"RedirectShopper\",\n \"action\":{\n \"paymentMethodType\":\"directEbanking\",\n \"method\":\"GET\",\n \"url\":\"https:\/\/checkoutshopper-test.adyen.com\/checkoutshopper\/checkoutPaymentRedirect?redirectData=...\",\n \"type\":\"redirect\"\n }\n}"}]"
:enable-copy-link-to-code-block="true"
:code-sample-card-size="'fullsize'"
></code-sample>
If your integration is set up correctly, the action
object is passed from your server to the client.
Check the payment result
Drop-in redirects the shopper to complete the payment. When the shopper returns back to your app, Drop-in provides the actionComponentData
object.
From your server, make a POST /payments/details request providing:
details
: TheactionComponentData.details
object from Drop-in.
You receive a response containing:
resultCode
: Use this to present the payment 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:
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_CONTRACToriginalReference
: ThepspReference
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
: ThepspReference
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.
- Set the
paymentMethod
type
to directEbanking. This redirects you to the Sofort page. - Under Bank name, select Demo Bank, then Next.
- Enter any test login details for Account number and PIN, and select Next.
- Select an account, then Next.
- Enter any test TAN and select Next.
- To check the status of your test payment, go to your test Customer Area > Transactions > Payments.
Test a cancelled payment
- Set the
paymentMethod
type
to directEbanking. This redirects you to the Sofort page. - Under Bank name, select Demo Bank.
- Select Next.
- Select the icon.
- Select Cancel payment.
- 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.