Docs / API reference
Exchange rate and health
Read the current HTG to USD exchange rate and the card minimum with GET /api/gateway/v1/exchange-rate, and check the API status with the health endpoint.
Exchange rate
GET
/api/gateway/v1/exchange-rateReturns the current rate in gourdes per US dollar, and the minimum amount for a card payment.
| Parameter | Type | Description |
|---|---|---|
amount |
number | Optional. An amount in HTG to convert to USD. Without it, the endpoint returns only the rate. |
curl "https://api.tranzak.co/api/gateway/v1/exchange-rate?amount=500" \
-H "X-Api-Key: $TRANZAK_API_KEY"
const res = await fetch('https://api.tranzak.co/api/gateway/v1/exchange-rate?amount=500', {
headers: { 'X-Api-Key': process.env.TRANZAK_API_KEY },
});
const { data } = await res.json();
import os, requests
data = requests.get(
"https://api.tranzak.co/api/gateway/v1/exchange-rate",
headers={"X-Api-Key": os.environ["TRANZAK_API_KEY"]},
params={"amount": 500},
).json()["data"]
Response:
{
"success": true,
"data": {
"base_currency": "USD",
"quote_currency": "HTG",
"rate": 130,
"conversion": { "amount_htg": 500, "amount_usd": 3.85 },
"card_minimum": { "HTG": 65, "USD": 0.5 }
}
}
| Field | Description |
|---|---|
rate |
Gourdes for one US dollar. |
conversion |
Present only when you pass amount. |
card_minimum |
The minimum for a card payment, per currency. Use it to disable your pay button before the customer clicks. |
The rate can change at any time. See Currencies and exchange rate for how it is applied.
Health
GET
/api/gateway/v1/healthA lightweight check that the API is reachable.
curl https://api.tranzak.co/api/gateway/v1/health \
-H "X-Api-Key: $TRANZAK_API_KEY"
{
"success": true,
"service": "Tranzak Gateway API",
"version": "1.0",
"timestamp": "2026-10-04T14:00:00.000000Z"
}