> 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/ue5-sdk-v3/function-references/pay/pay-api-health/checkhealthpayapi.md).

# CheckHealthPayApi

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" %}

```cpp
void CheckHealthPayApi(const FVyOnCheckHealthPayApiComplete& OnComplete) const;
```

{% endcode %}

\
**Parameters**

| OnComplete | FVyOnCheckHealthPayApiComplete | The callback function called when the user preferences retrieval operation is complete. |
| ---------- | ------------------------------ | --------------------------------------------------------------------------------------- |

\
**OnComplete Callback** (FVyOnCheckHealthPayApiComplete)\
Contains a [FVyPayApiHealthDto](/sdk-reference/ue5-sdk-v3/object-references/pay/fvypayapihealthdto.md) response type