> Statutory Parental Bereavement Pay with the Check Take Home Pay API, POST /v1/statutory/parental-bereavement-pay: every field, an example request in cURL, Node.js and Python, and the response.

Web version: https://checktakehomepay.co.uk/docs/api/statutory-parental-bereavement-pay · Last updated: 2026-10-09

# Statutory Parental Bereavement Pay

`POST /v1/statutory/parental-bereavement-pay` Needs a key

Statutory Parental Bereavement Pay, week by week for up to 2 weeks, from average weekly earnings, with eligibility on the lower earnings limit.

## Request

A JSON body. Fields not listed here are rejected.

| Field | Type | Description |
| --- | --- | --- |
| `average_weekly_earnings` required | object | Average weekly earnings: { amount } a week, or the earnings in the relevant period with the weeks, months or days to divide them by. |
| `average_weekly_earnings.amount` optional | number | Average weekly earnings, when already known. Allowed: 0 or more, under 100,000,000. |
| `average_weekly_earnings.earnings` optional | number | Gross earnings paid in the relevant period. Allowed: 0 or more, under 100,000,000. |
| `average_weekly_earnings.weeks` optional | integer | Whole weeks in the relevant period, for weekly, two-weekly and four-weekly pay. Allowed: 1 to 52. |
| `average_weekly_earnings.months` optional | integer | Months in the relevant period, for monthly pay. Allowed: 1 to 12. |
| `average_weekly_earnings.days` optional | integer | Days in the relevant period, for irregular pay or a new employee. Allowed: 1 to 366. |
| `tax_year` optional | string | The tax year, such as 2026-27. The latest when not given. Default `"2026-27"`. |
| `from_week` optional | integer | The first week of the claim to pay, for a claim split across tax years. Allowed: 1 to 39. Default `1`. |
| `weeks` optional | integer | Weeks to pay from from\_week, when fewer than the rest. Allowed: 1 to 39. |

## Example

cURL

```
curl https://api.checktakehomepay.co.uk/v1/statutory/parental-bereavement-pay \
  -H "Authorization: Bearer $CHECKTAKEHOMEPAY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "average_weekly_earnings": {
    "amount": 400
  }
}'
```

Node.js

```
const response = await fetch('https://api.checktakehomepay.co.uk/v1/statutory/parental-bereavement-pay', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.CHECKTAKEHOMEPAY_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    "average_weekly_earnings": {
      "amount": 400
    }
  }),
});
const result = await response.json();
```

Python

```
import os
import requests

response = requests.post(
    "https://api.checktakehomepay.co.uk/v1/statutory/parental-bereavement-pay",
    headers={"Authorization": f"Bearer {os.environ['CHECKTAKEHOMEPAY_API_KEY']}"},
    json={"average_weekly_earnings": {"amount": 400}},
)
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](https://api.checktakehomepay.co.uk/openapi.json).

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",
  "average_weekly_earnings": 400,
  "eligible": true,
  "lower_earnings_limit": 129,
  "weeks": [
    {
      "from": 1,
      "to": 2,
      "weekly": 194.32
    }
  ],
  "total": 388.64,
  "assumptions": [
    "The lower of £194.32 and 90% of average weekly earnings for each week, up to 2.",
    "Payable when average weekly earnings reach the lower earnings limit. The caller checks the employment conditions (such as 26 weeks with the employer by the qualifying week) and works out the relevant period.",
    "Every week is at this tax year's rates: for weeks after 5 April, ask again with the next tax year and from_week."
  ],
  "sources": [
    "https://www.gov.uk/guidance/rates-and-thresholds-for-employers-2026-to-2027",
    "https://www.gov.uk/guidance/statutory-sick-pay-manually-calculate-your-employees-payments"
  ]
}
```

## Errors

-   400 `INVALID_INPUT`: the message names each field that is wrong.
-   401 `UNAUTHENTICATED` (no key) or `INVALID_KEY` (a key we don’t know, or a revoked one).

Every code, and how to handle them: [Errors](https://checktakehomepay.co.uk/docs/errors).