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: eps
- To launch and show the Component: EPSComponent
Our EPS Component renders EPS in your payment form and collects your shopper's selected bank.
When making an EPS payment, you additionally need to:
Requirements
Requirement | Description |
---|---|
Integration type | Make sure that you have built an Advanced flow Android Components integration. |
Setup steps | Before you begin, add in your Customer Area. |
Show EPS in your payment form
To show EPS Component in your payment form, you need to:
- Specify in your /paymentMethods request:
- countryCode: AT
- amount.currency: EUR
- amount.value: The value of the payment.
- Deserialize the response from the /paymentMethods call and get the object with
type
: eps. -
Add the EPS Component:
a. Import the EPS Component to your
build.gradle
file.implementation "com.adyen.checkout:eps:<latest-version>"
Check the latest version on GitHub.
b. Create an
epsConfiguration
object:val epsConfiguration = EpsConfiguration.Builder(context, "YOUR_CLIENT_KEY") .setEnvironment(Environment.TEST) // When you are ready to accept live payments, change the value to one of our live environments. .build()
c. Initialize the EPS Component. Pass the payment method object and the
epsConfiguration
object.val epsComponent = EpsComponent.PROVIDER.get(this@YourActivity, paymentMethod, epsConfiguration)
d. Add the EPS Component view to your layout.
<com.adyen.checkout.eps.EpsSpinnerView 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.
epsSpinnerView.attach(epsComponent, 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.epsComponent.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.-
returnURL
: URL to where the shopper should be redirected back to after they complete the payment. This URL can have a maximum of 1024 characters. Get this URL from the Component in theRedirectComponent.getReturnUrl(context)
.In the /payments response, note the
action
object. This contains the information needed to redirect the shopper.
- Pass the
action
object to your client app. You need this to initialize the Redirect Component.
Handle the redirect
- Use the Redirect Component to redirect the shopper to the issuing bank's app or website.
- After the shopper returns to your app, make a POST /payments/details request from your server, providing:
details
: TheactionComponentData.details
object from the Redirect Component.
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 are:
resultCode | Description | Action to take |
---|---|---|
Authorised | The payment was successful. | Inform the shopper that the payment has been successful. You will receive the funds in 2 days. |
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. It may take minutes or hours for the payments network to confirm this. | 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 closed the browser and failed to return to your website, 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 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 webhook.
You can also get this value using the /listRecurringDetails endpoint.
shopperReference
: The unique shopper identifier that you specified when creating the token (minimum length three characters).shopperInteraction
: ContAuth.recurringProcessingModel
: Subscription or UnscheduledCardOnFile.
For more information about the shopperInteraction
and recurringProcessingModel
fields, refer to Tokenization.
Test and go live
Check the status of test payments in your Customer Area > Transactions > Payments.
Before you can accept live payments, you need to submit a request for in your live Customer Area.