Worldline Message - Subscription Service API
Message Subscription Service Api Controller
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/wordline-message-subscription-service-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
description: 'The current set of APIs will be available in Q2 2026 on Worldline Global Issuing Platforms.
Additional APIs are under construction and planned to be available in 2026.'
version: 2.41.1
title: Worldline Card Issuing Message - Subscription Service API
contact: {}
servers:
- url: https://sbx-wlip.api1-eu2.psapigateway.preprod.giservices.io/card-issuing/api/v2
tags:
- name: Message - Subscription Service
description: Message Subscription Service Api Controller
paths:
/issuers/{issuerId}/subscriptions/{subscriptionReference}/services:
get:
tags:
- Message - Subscription Service
summary: Retrieve services by subscription reference
operationId: getSubscriptionServicesBySubscriptionReference
parameters:
- name: WL-Correlation-ID
in: header
description: WL-Correlation-ID
required: false
schema:
type: string
- name: issuerId
in: path
description: Id of the issuing bank
required: true
schema:
type: string
- name: subscriptionReference
in: path
description: Reference of the subscription
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponseEntitySubscriptionServices'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestErrorApiResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedResponseMetadata'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenErrorApiResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundErrorApiResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorErrorApiResponse'
'502':
description: Bad gateway
content:
application/json:
schema:
$ref: '#/components/schemas/BadGatewayErrorApiResponse'
post:
tags:
- Message - Subscription Service
summary: Create new service subscription
operationId: createSubscriptionService
parameters:
- name: WL-Correlation-ID
in: header
description: WL-Correlation-ID
required: false
schema:
type: string
- name: issuerId
in: path
description: Id of the issuing bank
required: true
schema:
type: string
- name: subscriptionReference
in: path
description: Reference of the subscription
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponseEntityCreateSubscriptionService'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestErrorApiResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedResponseMetadata'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenErrorApiResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundErrorApiResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorErrorApiResponse'
'502':
description: Bad gateway
content:
application/json:
schema:
$ref: '#/components/schemas/BadGatewayErrorApiResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionService'
description: subscriptionService
required: true
/issuers/{issuerId}/subscriptions/{subscriptionReference}/services/{subscriptionServiceReference}:
get:
tags:
- Message - Subscription Service
summary: Retrieve services for a subscription
operationId: getSubscriptionServiceByReference
parameters:
- name: WL-Correlation-ID
in: header
description: WL-Correlation-ID
required: false
schema:
type: string
- name: issuerId
in: path
description: Id of the issuing bank
required: true
schema:
type: string
- name: subscriptionReference
in: path
description: Reference of the subscription
required: true
schema:
type: string
- name: subscriptionServiceReference
in: path
description: Reference of the subscription service
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponseEntitySubscriptionService'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestErrorApiResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedResponseMetadata'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenErrorApiResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundErrorApiResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorErrorApiResponse'
'502':
description: Bad gateway
content:
application/json:
schema:
$ref: '#/components/schemas/BadGatewayErrorApiResponse'
put:
tags:
- Message - Subscription Service
summary: Modify subscription service by reference
operationId: modifySubscriptionServiceByReference
parameters:
- name: WL-Correlation-ID
in: header
description: WL-Correlation-ID
required: false
schema:
type: string
- name: issuerId
in: path
description: Id of the issuing bank
required: true
schema:
type: string
- name: subscriptionReference
in: path
description: Reference of the subscription
required: true
schema:
type: string
- name: subscriptionServiceReference
in: path
description: Reference of the subscription service
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponseEntityModifySubscriptionService'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestErrorApiResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedResponseMetadata'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenErrorApiResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundErrorApiResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorErrorApiResponse'
'502':
description: Bad gateway
content:
application/json:
schema:
$ref: '#/components/schemas/BadGatewayErrorApiResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SubscriptionService'
description: subscriptionService
required: true
delete:
tags:
- Message - Subscription Service
summary: Delete subscription service by reference
operationId: deleteSubscriptionServiceByReference
parameters:
- name: WL-Correlation-ID
in: header
description: WL-Correlation-ID
required: false
schema:
type: string
- name: issuerId
in: path
description: Id of the issuing bank
required: true
schema:
type: string
- name: subscriptionReference
in: path
description: Reference of the subscription
required: true
schema:
type: string
- name: subscriptionServiceReference
in: path
description: Reference of the subscription service
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ApiResponseEntityDeleteSubscriptionService'
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/BadRequestErrorApiResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/UnauthorizedResponseMetadata'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ForbiddenErrorApiResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/NotFoundErrorApiResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/InternalServerErrorErrorApiResponse'
'502':
description: Bad gateway
content:
application/json:
schema:
$ref: '#/components/schemas/BadGatewayErrorApiResponse'
components:
schemas:
InternalServerErrorResponseMetadata:
type: object
required:
- correlationId
- responseDateTime
- statusCode
- statusMessage
properties:
correlationId:
type: string
description: Correlation Identifier
responseDateTime:
type: string
example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ
description: Timestamp when response date was generated
statusCode:
type: integer
format: int32
example: 500
description: HTTP status code
statusMessage:
type: string
example: Internal server error
description: Executed REST API status message
title: InternalServerErrorResponseMetadata
SubscriptionParameter:
type: object
required:
- criteria
- value
properties:
criteria:
type: string
value:
type: string
title: SubscriptionParameter
ResponseMetadata:
type: object
required:
- correlationId
- responseDateTime
- statusCode
- statusMessage
properties:
correlationId:
type: string
description: Correlation Identifier
links:
description: Metadata Links
allOf:
- $ref: '#/components/schemas/Links'
statusMessage:
type: string
example: Executed successfully
description: Executed REST API status message
statusCode:
type: integer
format: int32
example: 200
description: HTTP status code
responseDateTime:
type: string
example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ
description: Timestamp when response date was generated
timeTakenMs:
type: integer
format: int64
example: 12
description: Wall clock time required from service to generate the response
title: ResponseMetadata
BadRequestErrorApiResponse:
type: object
required:
- responseMetadata
properties:
responseMetadata:
allOf:
- $ref: '#/components/schemas/BadRequestResponseMetadata'
title: BadRequestErrorApiResponse
NotFoundErrorApiResponse:
type: object
required:
- responseMetadata
properties:
responseMetadata:
allOf:
- $ref: '#/components/schemas/NotFoundResponseMetadata'
title: NotFoundErrorApiResponse
ForbiddenErrorApiResponse:
type: object
required:
- responseMetadata
properties:
responseMetadata:
allOf:
- $ref: '#/components/schemas/ForbiddenResponseMetadata'
title: ForbiddenErrorApiResponse
NotFoundResponseMetadata:
type: object
required:
- correlationId
- responseDateTime
- statusCode
- statusMessage
properties:
correlationId:
type: string
description: Correlation Identifier
responseDateTime:
type: string
example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ
description: Timestamp when response date was generated
statusCode:
type: integer
format: int32
example: 404
description: HTTP status code
statusMessage:
type: string
example: Not found
description: Executed REST API status message
title: NotFoundResponseMetadata
ApiResponseEntityCreateSubscriptionService:
type: object
required:
- responseMetadata
properties:
data:
$ref: '#/components/schemas/SubscriptionServiceResponse'
responseMetadata:
$ref: '#/components/schemas/ResponseMetadata'
title: ApiResponseEntityCreateSubscriptionService
description: Issuer response entity
ApiResponseEntitySubscriptionServices:
type: object
required:
- responseMetadata
properties:
data:
type: array
items:
$ref: '#/components/schemas/SubscriptionService'
responseMetadata:
$ref: '#/components/schemas/ResponseMetadata'
title: ApiResponseEntitySubscriptionServices
description: Issuer response entity
Links:
type: object
required:
- self
properties:
self:
type: string
example: /x/{x}?x=x
description: Service method URL
next:
type: string
example: /x/{x}?page[offset]=2
description: URL pagination query parameter next page
title: Links
ForbiddenResponseMetadata:
type: object
required:
- correlationId
- responseDateTime
- statusCode
- statusMessage
properties:
correlationId:
type: string
description: Correlation Identifier
responseDateTime:
type: string
example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ
description: Timestamp when response date was generated
statusCode:
type: integer
format: int32
example: 403
description: HTTP status code
statusMessage:
type: string
example: Forbidden
description: Executed REST API status message
title: ForbiddenResponseMetadata
SubscriptionServiceResponse:
type: object
properties:
subscriptionIdentifier:
$ref: '#/components/schemas/SubscriptionServiceIdentifier'
title: SubscriptionServiceResponse
ApiResponseEntityDeleteSubscriptionService:
type: object
required:
- responseMetadata
properties:
data:
$ref: '#/components/schemas/SubscriptionServiceResponse'
responseMetadata:
$ref: '#/components/schemas/ResponseMetadata'
title: ApiResponseEntityDeleteSubscriptionService
description: Issuer response entity
SubscriptionContact:
type: object
required:
- type
- value
properties:
pushDeviceType:
type: string
description: Type of (mobile) device (required if type is PUSH)
enum:
- ANDROID
- IOS
type:
type: string
example: MSISDN
enum:
- MSISDN
- EMAIL
- PUSH
value:
type: string
example: '+49171000000001'
title: SubscriptionContact
ApiResponseEntityModifySubscriptionService:
type: object
required:
- responseMetadata
properties:
data:
$ref: '#/components/schemas/SubscriptionServiceResponse'
responseMetadata:
$ref: '#/components/schemas/ResponseMetadata'
title: ApiResponseEntityModifySubscriptionService
description: Issuer response entity
InternalServerErrorErrorApiResponse:
type: object
required:
- responseMetadata
properties:
responseMetadata:
allOf:
- $ref: '#/components/schemas/InternalServerErrorResponseMetadata'
title: InternalServerErrorErrorApiResponse
UnauthorizedResponseMetadata:
type: object
required:
- correlationId
- responseDateTime
- statusCode
- statusMessage
properties:
correlationId:
type: string
description: Correlation Identifier
responseDateTime:
type: string
example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ
description: Timestamp when response date was generated
statusCode:
type: integer
format: int32
example: 401
description: HTTP status code
statusMessage:
type: string
example: Unauthorized
description: Executed REST API status message
title: UnauthorizedResponseMetadata
BadGatewayErrorApiResponse:
type: object
required:
- responseMetadata
properties:
responseMetadata:
allOf:
- $ref: '#/components/schemas/BadGatewayResponseMetadata'
title: BadGatewayErrorApiResponse
SubscriptionServiceIdentifier:
type: object
properties:
subscriptionServiceReference:
type: string
title: SubscriptionServiceIdentifier
SubscriptionEventIdentifier:
type: object
properties:
subscriptionEventReference:
type: string
title: SubscriptionEventIdentifier
BadRequestResponseMetadata:
type: object
required:
- correlationId
- responseDateTime
- statusCode
- statusMessage
properties:
correlationId:
type: string
description: Correlation Identifier
responseDateTime:
type: string
example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ
description: Timestamp when response date was generated
statusCode:
type: integer
format: int32
example: 400
description: HTTP status code
statusMessage:
type: string
example: Bad request
description: Executed REST API status message
title: BadRequestResponseMetadata
ApiResponseEntitySubscriptionService:
type: object
required:
- responseMetadata
properties:
data:
$ref: '#/components/schemas/SubscriptionService'
responseMetadata:
$ref: '#/components/schemas/ResponseMetadata'
title: ApiResponseEntitySubscriptionService
description: Issuer response entity
SubscriptionEvent:
type: object
required:
- eventName
properties:
eventName:
type: string
example: XX_Approve_FO
externalReference:
type: string
description: Optional external event identifier
parameters:
type: array
description: Optional list of parameters to customize the criteria values for events
items:
$ref: '#/components/schemas/SubscriptionParameter'
subscriptionEventIdentifier:
$ref: '#/components/schemas/SubscriptionEventIdentifier'
title: SubscriptionEvent
SubscriptionService:
type: object
required:
- serviceType
properties:
contacts:
type: array
description: List of addresses for an ALERT subscription (required if serviceType is ALERT)
items:
$ref: '#/components/schemas/SubscriptionContact'
events:
type: array
description: List of events this subscription will be notified for
items:
$ref: '#/components/schemas/SubscriptionEvent'
packet:
type: string
description: ALERT packet name from the issuer configuration (required if serviceType is ALERT)
serviceType:
type: string
example: MESSAGE_SERVICE
enum:
- ALERT
- INSTALMENT
- MESSAGE_SERVICE
subscriptionServiceIdentifier:
$ref: '#/components/schemas/SubscriptionServiceIdentifier'
title: SubscriptionService
BadGatewayResponseMetadata:
type: object
required:
- correlationId
- responseDateTime
- statusCode
- statusMessage
properties:
correlationId:
type: string
description: Correlation Identifier
responseDateTime:
type: string
example: format:yyyy-MM-dd'T'HH:mm:ss.SSSZ
description: Timestamp when response date was generated
statusCode:
type: integer
format: int32
example: 502
description: HTTP status code
statusMessage:
type: string
example: Bad Gateway
description: Executed REST API status message
title: BadGatewayResponseMetadata
securitySchemes:
basic:
type: oauth2
flows:
clientCredentials:
scopes: {}
tokenUrl: https://sbx-wlip.api1-eu2.psapigateway.preprod.giservices.io/token