Woolworths Group Health check API

The Health check API from Woolworths Group — 1 operation(s) for health check.

Operations 1

GET /health Get service health #

Documentation

Specifications

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-product-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-order-info-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-order-data-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-program-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-category-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-product-dto-paged-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-order-digital-cards-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-activated-cards-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-digital-order-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-physical-order-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-order-status-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-order-processing-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-transaction-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-cancel-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-transaction-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-cancel-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-create-key-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-api-key-details-schema.json
📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-cnp-authorization-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-cnp-transaction-detail-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-account-status-inquiry-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-account-status-inquiry-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-cnp-refunds-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-cnp-voids-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-merchant-api-application-queries-view-models-payment-details-view-model-schema.json
📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-merchant-api-application-queries-view-models-refund-details-view-model-schema.json
📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-merchant-api-application-queries-view-models-payment-details-by-payment-id-view-model-schema.json
📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-merchant-api-application-queries-view-models-merchant-session-view-model-schema.json
📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-merchant-api-application-queries-view-models-refund-details-by-refund-id-view-model-schema.json
📊
JSONSchema
https://artifacts.apis.io/woolworths-group/json-schema/woolworths-group-merchant-api-application-commands-merchant-initiate-payment-merchant-initiate-payment-command-schema.json

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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/woolworths-group:woolworths-group-health-check-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

woolworths-group-health-check-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: WPay External Partner Integration Health check API
  description: Gift Card API for External Partner Integration
  version: 1.2.0
servers:
- url: https://pt-api.wpay.com.au/v1/partner/giftcards
  description: Integration environment
security:
- X-Api-Key: []
tags:
- name: Health Check
paths:
  /health:
    get:
      summary: Get service health
      operationId: getServiceHealth
      description: This API allows you to get the operational status of the service
      tags:
      - Health Check
      responses:
        '200':
          description: This response code indicates the service is healthy.
        '400':
          description: This response code indicates that an error was encountered while fetching the status. The cause will be a validation problem or logic rule.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BusinessLogicErrorResponse'
        5XX:
          description: This response code indicates that an unexpected error has occurred. The service is unhealthy and unavailable to handle requests.
components:
  schemas:
    BusinessLogicErrorResponse:
      required:
      - code
      type: object
      description: Payload for a business logic error
      properties:
        httpStatusCode:
          type: number
          description: The http status code
          example: 400
        errorCode:
          type: string
          description: The error code
          example: '5313'
        errorMessage:
          type: string
          description: The error message
          example: Duplicate reference number provided
        messages:
          type: array
          items:
            type: string
        additionalTxnFields:
          type: object
          properties:
            responseCode:
              type: number
              example: 10004
      example:
        httpStatusCode: 400
        errorCode: '5313'
        errorMessage: Duplicate reference number provided
        messages: []
        additionalTxnFields:
          responseCode: 10004
  securitySchemes:
    X-Api-Key:
      type: apiKey
      name: X-Api-Key
      in: header
x-readme:
  explorer-enabled: true
  proxy-enabled: true
x-assembled-from:
  note: Merged verbatim from the per-operation OpenAPI definitions Wpay (Woolworths Group payments business) embeds in each ReadMe reference page; raw pages saved under openapi/_original/wpay-developerhub/.
  retrieved: '2026-10-22'
  sources:
  - https://developerhub.wpay.com.au/giftingservices/reference/activatephysicalgiftcard.md
  - https://developerhub.wpay.com.au/giftingservices/reference/getactivatedgiftcards.md
  - https://developerhub.wpay.com.au/giftingservices/reference/getgiftcardorderstatus.md
  - https://developerhub.wpay.com.au/giftingservices/reference/getservicehealth.md
  - https://developerhub.wpay.com.au/giftingservices/reference/ordergiftcards.md
  - https://developerhub.wpay.com.au/giftingservices/reference/postordersreverse.md