Guide

Purpose

  • To clearly describe in OpenAPI format what each shared component, parameter and common response a service should use.
  • For service design - a base to start from that conforms to agreed standards. Worldpay products should look and feel the same to integrate with.
  • Recognise that API standards will evolve over time but a target state exists at the point of new service creation or a major update.

placeholder image

Starter OpenAPI file

A starter OpenAPI that passes lint checks and includes many common components

placeholder image

Shared Components

A list of shared components related to schema, parameters and error responses

placeholder image

Standards

Agreed set of standards when creating new components and openapi files