API reference
Pinned API version
Default version for requests without the header.
GET
/account/api-versionThe version requests without BOSPay-Version use. Pin BOSPay-Version explicitly for each integration.
- Permission
- any
- Auth
- api-key
- Idempotent
- No
- Language
- Node.js
const response = await fetch(`${process.env.BOSPAY_API_BASE}/account/api-version`, {
method: "GET",
headers: {
"Content-Type": "application/json",
"BOSPay-Version": "2026-09-23",
"X-API-Key": process.env.BOSPAY_API_KEY,
}
});
if (!response.ok) {
throw new Error(`BOSPay request failed: ${response.status}`);
}
const data = await response.json();Success
200
{
"object": "api_version",
"pinned": "2026-09-16",
"latest": "2026-09-23",
"supported": [
"2026-09-16",
"2026-09-23"
]
}Validation error
400
{
"error": {
"type": "invalid_request_error",
"code": "validation_error",
"message": "A valid fiatAmount is required.",
"field": "fiatAmount",
"requestId": "req_3f0c9a1b2c4d5e6f7a8b9c0d"
}
}