Payment-method icon

EPS for API only

Add EPS to your API-only integration.

You can add EPS to your existing integration. The following instructions show only what you must add to your integration specifically for EPS.

If an instruction on this page corresponds with a step in the main integration guide, it includes a link to corresponding step of the main integration guide.

Requirements

Requirement Description
Integration type Make sure that you have an existing API-only integration.
Redirect handling Make sure that your existing integration is set up to handle the redirect.
action.type: redirect.
Setup steps Before you begin, add EPS in your Customer Area.

How it works

  1. The shopper selects EPS from the list of payment methods, then selects their bank.
  2. The shopper is redirected to the bank website to enter their bank details.
  3. The shopper confirms the payment and is redirected back to your website.

Build your payment form

To show EPS in your payment form, you need to:

  1. Show a list of available banks to your shopper.
  2. After the shopper selects a bank, pass the corresponding Issuer ID value to your server. You'll need this to make a payment.

List of issuer IDs

The available banks for EPS are different in the test and live environment:

You can also get the issuer list from the /paymentMethods response.

Get EPS as an available payment method

When you make the /paymentMethods to get available payment methods, specify the following so that EPS is included in the response.

Parameter Values
countryCode AT
amount.currency EUR
amount.value The value of the payment.

The list of issuing banks are included in the paymentMethods object, as well as type: eps.

Add additional parameters to your /payments request

When you make a payment, add the following parameters in your /payments request:

  • paymentMethod.type: eps
  • paymentMethod.issuer: The EPS issuer value of the shopper's selected bank. For example, Dolomitenbank.
  • returnUrl: The URL where the shopper will be redirected back to after they complete the payment. This URL can have a maximum of 1024 characters.

Recurring payments

We support recurring transactions for EPS 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 recurring.token.created webhook containing:

  • type: recurring.token.created
  • shopperReference: your unique identifier for the shopper.
  • eventId: the pspReference of the initial payment.
  • storedPaymentMethodId: the token that you need to make recurring payments for this shopper.

Make sure that your server is able to receive the Recurring tokens life cycle events webhook. You can set up this webhook in your Customer Area.

Make a payment with a token

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

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 EPS test payments in your Customer Area > Transactions > Payments.

Before you can accept live EPS payments, you need to submit a request for EPS in your live Customer Area.

See also