Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Worldline Direct Debit API

Direct Debit Api Controller

Worldline Direct Debit API is one of 79 APIs that Worldline publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Direct Debit. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 3 operations across 3 paths, and defines 26 schemas. It is described by OpenAPI 2.0, at version 2.41.1.

Requests are made against the base URL https://api.connect.worldline-solutions.com.

3 operations 3 paths 26 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
2.41.1
Base URL
https://api.connect.worldline-solutions.com
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Worldline Direct Debit API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (basic) using the application flow.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Direct Debit 3

Direct Debit Api Controller

POST
/issuers/{issuerId}/direct-debits
Create a direct debit instruction
createDirectDebit 6 params → 400401403404500502200
GET
/issuers/{issuerId}/direct-debits/{endToEndId}
Retrieve a direct debit
retrieveDirectDebit 7 params → 400401403404500502200
POST
/issuers/{issuerId}/direct-debits/{endToEndId}/cancel
Cancel direct debit
cancelDirectDebit 7 params → 400401403404500502200

Schemas 26

The contract defines 26 schemas that model the data the API accepts and returns. The most detailed are DirectDebit (21 properties), ResponseMetadata (6 properties), CreateDirectDebitRequest (4 properties), BadGatewayResponseMetadata (4 properties). Each schema is shown below with its type and property counts.

CreateDirectDebitRequest
object
4 properties 2 required
DirectDebitStatusHistory
object
4 properties
NotFoundErrorApiResponse
object
1 property 1 required
BadGatewayErrorApiResponse
object
1 property 1 required
InternalServerErrorErrorApiResponse
object
1 property 1 required
InternalServerErrorResponseMetadata
object
4 properties 4 required
UnauthorizedErrorApiResponse
object
1 property 1 required
CancelDirectDebitRequest
object
1 property
DirectDebit
object
21 properties
Links
object
2 properties 1 required
UnauthorizedResponseMetadata
object
4 properties 4 required
ApiResponseEntityCreateDirectDebitResponse
object
Issuer response entity
2 properties 1 required
ApiResponseEntityDirectDebit
object
Issuer response entity
2 properties 1 required
NotFoundResponseMetadata
object
4 properties 4 required
ResponseMetadata
object
6 properties 4 required
AccountIdentifier
object
2 properties
ApiResponseEntityCancelDirectDebitResponse
object
Issuer response entity
2 properties 1 required
Amount
object
3 properties 3 required
ForbiddenErrorApiResponse
object
1 property 1 required
CreateDirectDebitResponse
object
2 properties 2 required
DirectDebitIdentifier
object
1 property
BadRequestResponseMetadata
object
4 properties 4 required
CancelDirectDebitResponse
object
3 properties 3 required
BadGatewayResponseMetadata
object
4 properties 4 required
BadRequestErrorApiResponse
object
1 property 1 required
ForbiddenResponseMetadata
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wordline-direct-debit-api-openapi.yml Raw ↑

Other APIs Worldline publishes across the network.

Worldline Connect (Global Collect) API
Worldline Direct (Global Online Pay) API
Worldline Acquiring API
Worldline Financial Services Issuing API
Worldline Financial Services Acquiring API
Worldline Open Banking API
Worldline SmartPOS API
Worldline Identity and Authentication API
Worldline Account - AccountState API
Worldline Account API
Worldline Account - Authorization API
Worldline Account - Authorization Restriction API