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 Message - Subscription API

Message Subscription Api Controller

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

Tagged areas include Message - Subscription. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 5 operations across 3 paths, and defines 27 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.

5 operations 3 paths 27 schemas 1 DELETE2 GET1 POST1 PUT

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 Message - Subscription API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (basic) using the application flow.

Paths & Operations 5

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

Message - Subscription 5

Message Subscription Api Controller

POST
/issuers/{issuerId}/subscriptions
Create a new WL Message subscription
createSubscription 3 params → 200400401403404500502
GET
/issuers/{issuerId}/subscriptions/search
Search for subscriptions (with non-pci search terms)
searchSubscriptions 3 params → 200400401403404500502
GET
/issuers/{issuerId}/subscriptions/{subscriptionReference}
Retrieve subscription by reference
getSubscriptionByReference 3 params → 200400401403404500502
PUT
/issuers/{issuerId}/subscriptions/{subscriptionReference}
Modify subscription by reference
modifySubscriptionByReference 4 params → 200400401403404500502
DELETE
/issuers/{issuerId}/subscriptions/{subscriptionReference}
Delete subscription by reference
deleteSubscriptionByReference 3 params → 200400401403404500502

Schemas 27

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

SubscriptionIdentifier
object
1 property
ApiResponseEntityCreateSubscription
object
Issuer response entity
2 properties 1 required
NotFoundErrorApiResponse
object
1 property 1 required
ApiResponseEntitySearchSubscription
object
Issuer response entity
2 properties 1 required
BadGatewayErrorApiResponse
object
1 property 1 required
InternalServerErrorErrorApiResponse
object
1 property 1 required
InternalServerErrorResponseMetadata
object
4 properties 4 required
Subscription
object
4 properties 2 required
Links
object
2 properties 1 required
ApiResponseEntityDeleteSubscription
object
Issuer response entity
2 properties 1 required
UnauthorizedResponseMetadata
object
4 properties 4 required
ApiResponseEntityModifySubscription
object
Issuer response entity
2 properties 1 required
SubscriptionResponse
object
1 property
SubscriptionEvent
object
4 properties 1 required
ResponseMetadata
object
6 properties 4 required
NotFoundResponseMetadata
object
4 properties 4 required
ForbiddenErrorApiResponse
object
1 property 1 required
SubscriptionServiceIdentifier
object
1 property
SubscriptionService
object
5 properties 1 required
BadRequestResponseMetadata
object
4 properties 4 required
SubscriptionContact
object
3 properties 2 required
SubscriptionParameter
object
2 properties 2 required
SubscriptionEventIdentifier
object
1 property
BadGatewayResponseMetadata
object
4 properties 4 required
BadRequestErrorApiResponse
object
1 property 1 required
ApiResponseEntitySubscription
object
Issuer response entity
2 properties 1 required
ForbiddenResponseMetadata
object
4 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wordline-message-subscription-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