---
updatedAt: 2026-05-06T08:14:56.000Z
agentTools:
  projectIndex: https://developerhub.wpay.com.au/giftingservices/llms.txt
---

# Get service health

This API allows you to get the operational status of the service

# OpenAPI definition

```json
{
  "openapi": "3.0.3",
  "info": {
    "title": "WPay External Partner Integration 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"
    }
  ],
  "tags": [
    {
      "name": "Health check"
    }
  ],
  "security": [
    {
      "X-Api-Key": []
    }
  ],
  "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": {
    "securitySchemes": {
      "X-Api-Key": {
        "type": "apiKey",
        "name": "X-Api-Key",
        "in": "header"
      }
    },
    "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
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```