Note: The API patterns for Direct Debit Collections differ from our standard payment endpoints, as they originate from an acquired product. While we're working to harmonize the experience, full support for these endpoints is maintained.

This section provides technical details about our Direct Debit API endpoints configuration and implementation guidelines to ensure smooth integration and usage.

General information

Base URL and authentication

Authentication follows our standard process as described in Authentication and authorization . However, for Direct Debit Collection API requests, you'll need to use different base URLs:

• Sandbox environment: https://sepaexpress-sand-fx.azurewebsites.net/
• Production environment: https://sepaexpress-prod-fx.azurewebsites.net/

All requests must use HTTPS.

MIME Types

Our API requires you to send all requests JSON-formatted and UFT-8 encoded.

Date Format

Coordinated Universal Time (or UTC) is the primary time standard by which the world regulates clocks and time. By adding one hour to UTC, you will get the Central European Time (CET), which applies in Germany, Austria, Switzerland and other Central European countries. The Central European Summer Time (CEST) in summer is obtained by adding two hours.

The following shows an example of what date format is supported when using our API:

2022-09-01T19:22:31.3807768Z

Idempotency keys

Our Direct Debit API endpoints support idempotency keys, to prevent the worst-case-scenario of creating a double booking, for example due to a network timeout.

This means that any request you send us can and will be only 'accepted' one single time. If you send the same request again after it has previously been accepted, our API will respond with the HTTP error code 400. Idempotency keys are optional, but highly recommended to use.

{
  "error": {
      "id": "{{errorId}}",
      "code": 400,
      "message": "IdempotencyKey {{key}} was already used at {{date}} creating entity {{entityId}}.",
      "details": []
  }
}