Worldpay Operational API

The Operational API from Worldpay — 1 operation(s) for operational.

OpenAPI Specification

worldpay-operational-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: 3DS 3DS actions Operational API
  description: "Protect your business and meet regulatory requirements by verifying your customer's identity.\n\n__Authentication header__\n  ```\n    Authorization: {your_credentials}\n  ```\nReplace `{your_credentials}` with your base64-encoded Basic Auth username and password given to your by your Worldpay Implementation Manager.\n<br /> <br />\n\nYou **must** use the `Authorization` header for any request you send to our 3DS API.\n\n__Accept/Content-Type header__\n  ```\n  Content-Type: application/vnd.worldpay.verifications.customers-v3.hal+json\n  Accept: application/vnd.worldpay.verifications.customers-v3.hal+json\n  ```\nWe use the Accept header to identify which version of our API you are using. You must use the Accept header for any request you send to our 3DS API.\n\nWe require the Content-Type header if the request you're sending includes a request body, and if the HTTP method is a `POST` or a `PUT`.\n<br /><br />\n\n\n__DNS whitelisting__  \nWhitelist the following URLs:\n* `https://try.access.worldpay.com/`\n* `https://access.worldpay.com/`\n\nPlease ensure you use DNS whitelisting, not explicit IP whitelisting."
  version: '3'
  x-metadata:
    category:
    - 3DS
    - SCA Exemptions
    business:
    - Enterprise
    catalog-list: true
    generated: false
servers:
- url: https://try.access.worldpay.com
  description: Test (Try)
- url: https://access.worldpay.com
  description: Live
security:
- BasicAuth: []
tags:
- name: Operational
paths:
  /apmPayments/status:
    get:
      operationId: status
      responses:
        '200':
          content:
            '*/*':
              example: OK - 2022-05-16T10:50:55.444486
              schema:
                type: string
          description: The status of the service is OK.
        '400':
          $ref: '#/components/schemas/AccessApiValidationError'
      summary: Used to check whether the service is up
      tags:
      - Operational
components:
  schemas:
    AccessApiValidationError:
      description: Validation error object.
  securitySchemes:
    BasicAuth:
      type: http
      scheme: basic