Skip to content
APIs/APMs/
SEPA Direct Debit

SEPA Direct Debit

A secure and globally accepted direct debit.

Note

Make yourself familiar with our API principles to ensure a resilient integration.

Product overview

Why use SEPA Direct Debit

SEPA Direct Debit is an easy way to take bank payments from your customers, using an IBAN (International Bank Account Number).

The SEPA scheme is a set of rules that dictate how payments must be processed and settled in the SEPA (Single Euro Payment Area) region.

Feature summary

Payment typeAcceptance currencyRecurringReversePartial reverseDisputes
Bank transferEUR (Euro)✅
  • Refunds - yes
  • Cancel - no
  • Partial refund - yes
  • Partial cancel - no
✅
Best practice

To get the most from SEPA Direct Debit, refer to our SEPA overview article which lists scheme rules and some best practice and recommendations.

Acceptance countries

  • Austria
  • Belgium
  • Bulgaria
  • Croatia
  • Cyprus
  • Czech Republic
  • Denmark
  • Estonia
  • Finland
  • France
  • Germany
  • Greece
  • Hungary
  • Iceland
  • Ireland
  • Italy
  • Latvia
  • Liechtenstein
  • Lithuania
  • Luxembourg
  • Malta
  • Norway
  • Poland
  • Portugal
  • Romania
  • Slovakia
  • Slovenia
  • Spain
  • Sweden
  • The Netherlands

non-EEA countries that require swiftBic in requests:

  • Andorra
  • Gibraltar
  • Monaco
  • San Marino
  • Switzerland
  • Vatican state
  • United Kingdom

Your customer language codes

LanguageCode
Dutchnl
Englishen
Frenchfr
Germande
Italianit
Spanishes

Get started

Use our API reference and set your headers.

Request

POST https://try.access.worldpay-bsh.securedataplatform.co.uk/apmPayments

Apply APM payment details directly using our APMs API, or use our Components SDK to create a session.

Example requests

Collect the APM details and send an API request with these details to create a payment.

{
  "transactionReference": "Memory265-13/08/1876",
  "orderReference": "apm-order-12345",
  "merchant": {
    "entity": "default"
  },
  "instruction": {
    "method": "ach",
    "narrative": {
      "line1": "MindPalace"
    },
    "value": {
      "amount": 750,
      "currency": "USD"
    },
    "paymentInstrument": {
      "type": "direct",
      "accountType": "checking",
      "accountNumber": "01234567890123456",
      "routingNumber": "012345678",
      "checkNumber": "012345678901234",
      "companyName": "Worldpay",
      "billingAddress": {
        "address1": "8500 Governors Hill Drive",
        "address2": "Symmes Township",
        "postalCode": "45249",
        "city": "Ohio",
        "state": "US-OH",
        "countryCode": "US"
      }
    },
    "customer": {
      "firstName": "John",
      "lastName": "Johnson",
      "customerId": "43424",
      "email": "john@example.com"
    }
  }
}

Parameters

transactionReferencestring, [ 1 .. 64 ] characters^[a-zA-Z0-9\-_/!@#$%()*=.:;?\[\]{}~+]*$required

For Bizum transactions, please follow this extra regex [a-zA-Z0-9]{4,12}

orderReferencestring, [ 1 .. 64 ] characters^[a-zA-Z0-9\-_/!@#$%()*=.:;?\[\]{}~+]*$

A reference that you can apply to one or more payments according to your business needs. You may reuse the same reference across multiple payments, for example where:

  • the total amount for a single order is split across multiple payments
  • you use a single reference for each payment in a recurring agreement or split shipment scenario
merchantobject(MerchantV2)required
instructionobject(InstructionV2)required

Response

Example response

{
  "paymentId": "uK9Oh5zz4yKhGuFofhhnC7KnABEsnvjTFefo7uUYYarwh_KRcHUrrs1qJtQso9gjnhxT5oAgkJfCp1iX6U1upLOpzqHmhG8uXdBKXQ0rnmce4brW4F54BCV6GtAu0zUbgUZHQIK3iu8VcHfOiFVHyN-y7ZDRr24t7o6s_bHlZxo9g_WHOCgZdL-FywMmqkQA",
  "lastEvent": "sentForAuthorization",
  "_links": {
    "self": {
      "href": "https://try.access.worldpay-bsh.securedataplatform.co.uk/apmPayments/uK9Oh5zz4yKhGuFofhhnC7KnABEsnvjTFefo7uUYYarwh_KRcHUrrs1qJtQso9gjnhxT5oAgkJfCp1iX6U1upLOpzqHmhG8uXdBKXQ0rnmce4brW4F54BCV6GtAu0zUbgUZHQIK3iu8VcHfOiFVHyN-y7ZDRr24t7o6s_bHlZxo9g_WHOCgZdL-FywMmqkQA"
    }
  },
  "_actions": {},
  "redirect": "",
  "paymentInstrument": {
    "method": "sepa",
    "type": "direct"
  },
  "commandId": "cmdEy5vwB0krLe9eMwAcE66c0"
}

Schema

paymentIdstring

The identifier of the payment resource.

lastEventstring
Enum:"authorized""cancelFailed""cancelled""cancelRequested""sentForSettlement""sentForAuthorization""settlementFailed""chargebackReversed""chargedBack""disputeExpired"
_linksobject(Links)

Links to resources related to the request.

_actionsobject(ActionsV2)
redirectstring

The URL to redirect your customer to, or a QR code in Base64 to show to your customer, in order to complete the transaction.

commandIdstring

An action ID generated by us, identifying a single merchant interaction.

Example:"cmdYNdIHBPJwbkjLiykzTx0"
paymentInstrumentAll others (object) or PayPal (object) or SEPA DD (object) or Klarna (recurring) token (object)(PaymentInstrument)
One of:

Payment instrument for: ACH, Alipay China, Alipay Hong Kong, Alipay Plus, BANCOMAT Pay, Bancontact, Bizum, BLIK, EFT, Euteller, iDEAL guest, iDEAL recurring, Klarna, Klarna (recurring), Konbini, Multibanco, MyBank, Open Banking, PaysafeCard, Pix, Przelewy24, SafetyPay, Satispay, Swish, Trustly, China UnionPay, WeChat Pay.

transactionCodestring

For Pix payments - display to your customer for them to copy and paste in the Pix app.

For Swish payments - use this value as the {token} in the custom URL scheme: swish://paymentrequest?token={token}&callbackurl={callbackURL}. This will prompt the app to open, allowing your customer to complete their payment.

Example:"IZQ3iUfePwiWiwldJlipl8NGVA7w5IUg"

Errors

Check out our API reference for more responses or error codes.

Next steps

Manage your SEPA Direct Debit payment