If you are using Android Components v5.0.0 or later:
This payment method requires no additional configuration.
Follow the Components integration guide and use the following module and Component names:
- To import the module: sepa
- To launch and show the Component: SepaComponent
Our SEPA Direct Debit Component renders SEPA Direct Debit in your payment form, where shoppers provide their account holder name and IBAN, and then review and confirm the payment.
Requirements
Requirement | Description |
---|---|
Integration type | Make sure that you have an existing Advanced flow Android Components integration. |
Setup steps | Before you begin, contact our Support Team to add SEPA Direct Debit in your Customer Area. |
Show SEPA Direct Debit in your payment form
To show SEPA Direct Debit Component in your payment form, you need to:
- Specify in your /paymentMethods request:
- countryCode: Countries/regions where SEPA Direct Debit is supported. For example, NL.
- amount.currency: EUR
- Deserialize the response from the /paymentMethods call and get the object with
type
: sepadirectdebit. -
Add the SEPA Direct Debit Component:
a. Import the SEPA Direct Debit Component to your
build.gradle
file.implementation "com.adyen.checkout:sepa:<latest-version>"
Check the latest version on GitHub.
b. Create an
sepaConfiguration
object:val sepaConfiguration = SepaConfiguration.Builder(context, "YOUR_CLIENT_KEY") // When you are ready to accept live payments, change the value to one of our live environments. .setEnvironment(Environment.TEST) .build()
c. Initialize the SEPA Direct Debit Component. Pass the payment method object and the
sepaConfiguration
object.val sepaComponent = SepaComponent.PROVIDER.get(this@YourActivity, paymentMethod, sepaConfiguration)
d. Add the SEPA Direct Debit Component view to your layout.
<com.adyen.checkout.sepa.SepaView android:layout_width="wrap_content" android:layout_height="wrap_content"/>
e. Attach the Component to the view to start getting your shopper's payment details.
sepaView.attach(sepaComponent, this@YourActivity)
f. When shoppers enter their payment details, you start receiving updates. If
isValid
is true and the shopper proceeds to pay, pass thepaymentComponentState.data.paymentMethod
to your server and make a payment request.sepaComponent.observe(this) { paymentComponentState -> if (paymentComponentState?.isValid == true) { // When the shopper proceeds to pay, pass the `paymentComponentState.data` to your server to send a /payments request sendPayment(paymentComponentState.data) } }
Make a payment
When the shopper proceeds to pay, the Component returns the paymentComponentState.data.paymentMethod
.
- Pass the
paymentComponentState.data.paymentMethod
to your server. - From your server, make a /payments request, specifying:
paymentMethod.type
: ThepaymentComponentState.data.paymentMethod
from your client app.
The /payments response contains:
resultCode
: Received.pspReference
: Adyen's unique reference number for the payment.
Present the payment result
Use the resultCode that you received in the /payments response to present the payment result to your shopper.
The resultCode
values you can receive for SEPA Direct Debit are:
resultCode | Description | Action to take |
---|---|---|
Received | The payment was successfully received. | You will receive a AUTHORISATION webhook when the status of the payment has been updated. If successful, you will receive the funds in 2 days. |
Authorised | The payment was successfully completed. | Inform the shopper that the payment was successful. |
Error | There was an error when the payment was being processed. For more information, check the resultCode field. | Inform the shopper that there was an error processing their payment. |
Refused | There was an error when the payment was being processed. For more information, check the resultCode field. | Ask the shopper to try the payment again using a different payment method. |
Capture the payment
If you do not use automatic capture, you must capture the payment in one of the following ways:
- Use delayed automatic capture. This means that the payment is captured automatically after a delay that you can set yourself.
- Manually capture the payment by making a /payments/{paymentPspReference}/captures request.
SEPA Direct Debit authorizations do not expire, so you can capture a payment any time after it is authorized.
Contact our Support Team to enable multiple partial captures for SEPA Direct Debit.
Recurring payments
If you have a recurring or subscription business model we recommend tokenizing the shopper's payment details. When you create a shopper token from a SEPA payment, we store their payment details with the token. The token can be used to make recurring payments for the shopper.
You can create a shopper token and then make subsequent recurring payments with the token using the /payments endpoint.
Create shopper 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:
- amount: The transaction must have a minimum value of EUR 0.01.
- storePaymentMethod: true
- shopperReference: your unique identifier for the shopper (minimum length three characters). Do not include personally identifiable information (PII), such as name or email address.
- recurringProcessingModel: Subscription or UnscheduledCardOnFile
From Checkout v70,
recurringProcessingModel
is a required parameter when creating or using a token.
When the payment is settled, you receive a RECURRING_CONTRACT 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 recurring payment
For each recurring payment for this shopper, make a SEPA payment to the /payments endpoint, specifying:
- paymentMethod.type: sepadirectdebit
- paymentMethod.storedPaymentMethodId: The
pspReference
from the RECURRING_CONTRACT webhook. You can also get this value using the /listRecurringDetails endpoint. - shopperReference: The shopper ID you provided when you created the shopper token.
- shopperInteraction: ContAuth.
-
recurringProcessingModel: Subscription or UnscheduledCardOnFile.
From Checkout v70,
recurringProcessingModel
is a required parameter when creating or using a token.
For more information about the shopperInteraction
and recurringProcessingModel
fields, refer to Tokenization.
If the payment was successfully received, the response will contain a Received resultCode
and a pspReference
, which is our unique identifier for this transaction. You can track whether the payment was successful using webhooks.
Test and go live
Before making live SEPA payments, use the following Account Names and IBANs to test your integration.
Account Name | IBAN | Country/region |
---|---|---|
A. Klaassen |
NL13TEST0123456789 |
NL |
B. Klaassen |
NL36TEST0236169114 |
NL |
C. Klaassen |
NL26TEST0336169116 |
NL |
D. Klaassen |
NL16TEST0436169118 |
NL |
E. Klaassen |
NL81TEST0536169128 |
NL |
F. Klaassen |
NL27TEST0636169146 |
NL |
G. Klaassen |
NL39TEST0736169237 |
NL |
H. Klaassen |
NL82TEST0836169255 |
NL |
I. Klaassen |
NL72TEST0936169257 |
NL |
J. Klaassen |
NL46TEST0136169112 |
NL |
K. Klaassen |
NL70TEST0736160337 |
NL |
L. Klaassen |
NL18TEST0736162437 | < |