Worldline HealthCheck API

The HealthCheck API from Worldline — 1 operation(s) for healthcheck.

OpenAPI Specification

wordline-healthcheck-api-openapi.yml Raw ↑
swagger: '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 Account - AccountState HealthCheck API
  contact: {}
host: sbx-wlip.api1-eu2.psapigateway.preprod.giservices.io/card-issuing
basePath: /api/v2
schemes:
- https
tags:
- name: HealthCheck
paths:
  /health:
    get:
      tags:
      - HealthCheck
      summary: getHealthCheckResponse
      operationId: getHealthCheckResponseUsingGET
      description: This API enables the caller to check globally the status of our solution. This can be considered as a watch-dog message.
      produces:
      - '*/*'
      parameters:
      - name: WL-Correlation-ID
        in: header
        description: WL-Correlation-ID
        required: false
        type: string
      - name: WL-Origin
        in: header
        required: false
        type: string
      responses:
        '200':
          description: OK
          schema:
            $ref: '#/definitions/apiResponseEntityHealthCheckStatus'
      security:
      - basic: []
      deprecated: false
definitions:
  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
  ResponseMetadata:
    type: object
    required:
    - correlationId
    - responseDateTime
    - statusCode
    - statusMessage
    properties:
      correlationId:
        type: string
        description: Correlation Identifier
      links:
        description: Metadata Links
        allOf:
        - $ref: '#/definitions/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
  HealthCheckStatus:
    type: object
    properties:
      status:
        type: string
    title: HealthCheckStatus
  apiResponseEntityHealthCheckStatus:
    type: object
    required:
    - responseMetadata
    properties:
      data:
        description: Response data
        allOf:
        - $ref: '#/definitions/HealthCheckStatus'
      responseMetadata:
        description: Response metadata
        allOf:
        - $ref: '#/definitions/ResponseMetadata'
    title: apiResponseEntityHealthCheckStatus
    description: Issuer response entity
securityDefinitions:
  basic:
    type: oauth2
    flow: application
    tokenUrl: https://sbx-wlip.api1-eu2.psapigateway.preprod.giservices.io/token