Check health
Returns the health status of the API and its database connection
Response Body
Successful health check
TypeScript Definitions
Use the response body type in TypeScript.
status
Requiredstringdatabase
Requiredobjecttimestamp
Requiredstring"date-time"
Service unavailable
TypeScript Definitions
Use the response body type in TypeScript.
status
Requiredstringdatabase
Requiredobjecttimestamp
Requiredstring"date-time"
curl -X GET "https://api.katu9.com/health"
fetch("https://api.katu9.com/health")
package main
import (
"fmt"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api.katu9.com/health"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
import requests
url = "https://api.katu9.com/health"
response = requests.request("GET", url)
print(response.text)
{
"status": "ok",
"database": {
"status": "connected",
"responseTime": "15ms"
},
"timestamp": "2023-05-20T12:34:56.789Z"
}
{
"status": "error",
"database": {
"status": "disconnected",
"error": "Connection refused"
},
"timestamp": "2023-05-20T12:34:56.789Z"
}
Get balance GET
Retrieves the merchant's balance for the specified environment and currency. Requires `x-katu9-merchant-id` and `x-katu9-environment` headers for authentication.
Create payment link POST
Creates a new payment link for an existing transaction. The new link is associated with the transaction and triggers all active merchant webhooks subscribing to the `payment_link.created` event. The webhook POSTs a JSON payload with the payment link data, the associated transactionId, and an HMAC SHA256 signature in the `X-Katu9-Signature` header.