> For the complete documentation index, see [llms.txt](https://sdk.venly.io/sdk-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sdk.venly.io/sdk-reference/ts-js-v3/function-references/pay/pay-api-health/checkhealthpayapi.md).

# checkHealthPayAPI

### 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**.

{% code overflow="wrap" %}

```javascript
public checkHealthPayAPI() : VyPromise<VyPayApiHealthDto>
```

{% endcode %}

{% tabs %}
{% tab title="Details" %}
**Returns**

VyPromise<[VyPayApiHealthDto](/sdk-reference/ts-js-v3/object-references/pay/vypayapihealthdto.md)>
{% endtab %}
{% endtabs %}