Last updated 9 October 2026View as Markdown
Statutory redundancy pay
POST /v1/redundancy-pay Needs a keyStatutory redundancy pay from age, full years of service and weekly pay, with the weekly cap.
Request
A JSON body. Fields not listed here are rejected.
| Field | Type | Description |
|---|---|---|
age required | integer | Age at the redundancy, in whole years. Allowed: 16 to 100. |
years_of_service required | integer | Full years of continuous employment. Allowed: 0 to 84. |
weekly_pay required | number | Gross weekly pay. Allowed: 0 or more, under 100,000,000. |
tax_year optional | string | The tax year, such as 2026-27. The latest when not given. Default "2026-27". |
Example
cURL
curl https://api.checktakehomepay.co.uk/v1/redundancy-pay \
-H "Authorization: Bearer $CHECKTAKEHOMEPAY_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"age": 45,
"years_of_service": 10,
"weekly_pay": 800
}'Node.js
const response = await fetch('https://api.checktakehomepay.co.uk/v1/redundancy-pay', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.CHECKTAKEHOMEPAY_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
"age": 45,
"years_of_service": 10,
"weekly_pay": 800
}),
});
const result = await response.json();Python
import os
import requests
response = requests.post(
"https://api.checktakehomepay.co.uk/v1/redundancy-pay",
headers={"Authorization": f"Bearer {os.environ['CHECKTAKEHOMEPAY_API_KEY']}"},
json={"age": 45, "years_of_service": 10, "weekly_pay": 800},
)
result = response.json()Response
200, with the result and what produced it: tax_year, engine, hmrc_test_data, assumptions and sources. This is the example's real response. Every field's type is in the OpenAPI document.
200 OK
{
"tax_year": "2026-27",
"engine": "2026-27.1",
"hmrc_test_data": "rest of UK and Welsh tax v1.0, Scottish tax v1.1, NI v1.0, directors NI v1.0, student loans v1.0",
"eligible": true,
"weeks": 12,
"weekly_pay": 751,
"weekly_pay_cap": 751,
"amount": 9012,
"assumptions": [
"Statutory redundancy pay needs 2 years of continuous employment. Counting back from the redundancy over at most 20 years: half a week for each year under 22, a week from 22, a week and a half from 41, a year counting at the age at its start.",
"Weekly pay is capped at £751 for redundancies on or after 6 April 2026.",
"A contract can pay more: this is the legal minimum."
],
"sources": [
"https://www.gov.uk/redundant-your-rights/redundancy-pay"
]
}Errors
- 400
INVALID_INPUT: the message names each field that is wrong. - 401
UNAUTHENTICATED(no key) orINVALID_KEY(a key we don’t know, or a revoked one).
Every code, and how to handle them: Errors.