---
updatedAt: 2026-10-02T14:55:13.000Z
agentTools:
  projectIndex: https://docs.venly.io/llms.txt
---

# Check Health

This endpoint is used to check the current health of the **PAY-API**. It returns the API health status as either **UP** or **DOWN**.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "PAY API",
    "description": "Venly Pay OA3.0 Documentation",
    "contact": {
      "name": "Venly",
      "url": "https://venly.io",
      "email": "contact@venly.io"
    },
    "version": "1.7.0"
  },
  "servers": [
    {
      "url": "https://api-pay-sandbox.venly.io/",
      "description": "Sandbox Environment"
    },
    {
      "url": "https://api-pay.venly.io/",
      "description": "Production Environment"
    }
  ],
  "paths": {
    "/actuator/health": {
      "get": {
        "tags": [
          "PAY-API Health"
        ],
        "summary": "Check Health",
        "description": "This endpoint is used to check the current health of the **PAY-API**. It returns the API health status as either **UP** or **DOWN**.",
        "operationId": "healthCheckPay",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "properties": {
                    "status": {
                      "type": "string",
                      "description": "Indicates the status of API services as either `UP` or `DOWN`.",
                      "examples": [
                        "UP"
                      ]
                    }
                  }
                }
              }
            }
          }
        },
        "security": [
          {
            "OAuth2": []
          }
        ]
      }
    }
  },
  "components": {
    "securitySchemes": {
      "OAuth2": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "https://login-qa.arkane.network/auth/realms/Arkane/protocol/openid-connect/token",
            "scopes": {
              "openid": "openid"
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```