Start accepting payments using Electronic Payment Standard (EPS), a favorite payment method in Austria.

EPS allows your customers to make purchases online through quick and easy bank transfers that are both secure and guaranteed.

To start accepting EPS payments, please contact your Customer Success manager.

Overview

EPS payments follow a two-step process:

Request a payment
Redirect the customer

Request a payment

The POST request

Use the details below to set up your request.

Endpoints

POSThttps://api.checkout.com/payments

POSThttps://api.sandbox.checkout.com/payments

Header parameters

Header	Value
`Authorization` REQUIRED	`secret key` _{Use the valid secret key of your Checkout.com account. You can find this in the Hub.}
`Content-Type` REQUIRED	`application/json`

Body parameters

The table below describes the minimum recommended fields. You can find the full list, as well as complete request and response examples, in our API reference.

Field name	Description
`source` OBJECT REQUIRED	Details about the payment source.
`source.type` STRING REQUIRED	The type of payment source. Set this to `eps`.
`source.purpose` STRING REQUIRED	A description of the payment. _{Maximum characters: 27}
`amount` INTEGER OPTIONAL	The payment amount.
`currency` STRING REQUIRED	The three-letter ISO 4217 currency code. Set this to `EUR`.
`success_url` STRING OPTIONAL	For redirect payment methods, overrides the default success redirect URL configured on your account.
`failure_url` STRING OPTIONAL	For redirect payment methods, overrides the default failure redirect URL configured on your account.

Request example

{
  "source": {
    "type": "eps",
    "purpose":"Mens black t-shirt L"
  },  
 "amount": 1914,
 "currency": "EUR",
 "success_url": "http://example.com/payments/success",
 "failure_url": "http://example.com/payments/fail",
}

If a customer ID or email is not provided in the request, then we automatically create a customer profile and return the customer id in the response.

The POST response

If you receive a 202 Success response containing a status field set to Pending, then your request was successful.

Response example

{
  "id": "pay_wqvd2nukz5dujnmokm7ljhymwa",
  "status": "Pending",
  "customer": {
    "id": "cus_uvs2lu4b7ncurjx5zdtrixnc4e"
  },
  "_links": {
    "self": {
      "href": "https://api.sandbox.checkout.com/payments/pay_wqvd2nukz5dujnmokm7ljhymwa"
    },
    "redirect": {
      "href": "https://ftg-customer-integration.giropay.de/ftgbank/b/bankselection/2329733103475232793;jsessionid=6CA094B861DC4D16D1C48D1988DE4A32.sf-testapp02tom24?op=001"
    }
  }
}

Redirect the customer

Redirect your customer to the redirect link’s href in the response. This will send them to an EPS bank selection page where they will select their bank before being transferred to that bank's page to enter their authorization details. If successful, the payment can be approved.

Once they've completed this step, the customer is transferred to your predefined success or failure URL. Confirmation of an EPS payment is communicated only through webhooks. When you receive a payment_captured webhook notification, the transaction has been completed successfully. Until the payment_captured webhook is received (response code 10000), all payments are labeled as Pending.

Get details about a payment

You can retrieve details about an existing EPS payment with the following endpoint.

The GET request

Endpoints

GEThttps://api.checkout.com/payments/{payment_id}

GEThttps://api.sandbox.checkout.com/payments/{payment_id}

Header and path parameters

Header	Value
`Authorization` REQUIRED	`secret key` _{Use the valid secret key of your Checkout.com account. You can find this in the Hub.}
`Content-Type` REQUIRED	`application/json`

Path	Value
`payment_id` REQUIRED	The payment ID found in the response of the initial response.

The GET response

Response example

{
  "id": "pay_iilqeu2rsdqedkvkjhl2rxgbvy",
  "created_on": "2018-03-28T14:50:26Z",
  "source": {
    "type": "eps",
    "purpose": "Mens black t-shirt L",
    "bic": "HYPTAT22XXX",
    "iban": "AT611904300234573201",
    "account_holder_name": "Test Account"
  },
  "amount": 1914,
  "currency": "EUR",
  "payment_type": "Regular",
  "status": "Captured",
  "flagged": false,
  "_links": {
    "self": {
      "href": "http://api.checkout.com/gateway/payments/pay_iilqeu2rsdqedkvkjhl2rxgbvy"
    }
  }
}

Refund a payment

EPS supports both partial and full refunds. You can refund a payment through the Hub or using the refund API.

Cancel a payment

If the customer fails to complete their payment, we will automatically void the payment and send a payment_expired webhook.

If the customer cancels their payment, we will send a payment_canceled webhook.

Testing EPS

To start testing, you'll need to:

create a test account, and
contact your Customer Success manager or integrations engineer to activate EPS payments in the sandbox environment.

Create an EPS transaction as above, following the redirect link in the response to EPS's bank selection page.
Select the bank:
- BIC: HYPTAT22XXX
- Name: HYPO TIROL BANK AG
Confirm your selection and await redirection to the bank's page.
Log in with the following details:
- Verfügernummer (user number): 123456
- Verfügername (username): [leave empty]
- PIN: [leave empty]
Click Auftrag absenden to continue.
Leave the radio selection on mobileTAN and click sammeln und zeichnen to continue.
In the mobileTAN-Eingabe field, enter 123456 and confirm by clicking OK.
Click zurück. You should then be redirected to your predefined success URL.

Can we help?

Thanks for using Checkout.com. If you need help or have a question, message our Support team at support@checkout.com.

Powered by Atlassian Confluence and Scroll Viewport.