Salary Deduction Enablement

Ontime calls this endpoint when a consumer agrees to pay by salary deduction, to enable it for their employment. Respond 200 with the status and the employee's employments, including when salary deduction cannot be enabled.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Header Params

Body Params application/jsonRequired

Example

{
    "salary_deduction_enablement_request": {
        "employer_id": "EMPLOYER-001",
        "employee_id": "EMP-001",
        "payroll_id": "PAYROLL-001",
        "national_registration_number": "QQ123456C",
        "agreement_datestamp": "2026-10-20T09:30:00+00:00"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Success

application/json

Indicates the request was successfully processed by the server and a valid response is included in the body.

Bodyapplication/json

Examples

AcceptedPending employer opt inRejected

{
    "salary_deduction_enablement_response": {
        "status": "accepted",
        "additional_information": null,
        "employment": [
            {
                "employment": {
                    "employee_id": "EMP-001",
                    "start_date": "2021-04-06",
                    "currency": "GBP",
                    "employer": {
                        "id": "EMPLOYER-001",
                        "name": "Emp Co Limited",
                        "registration_number": "01234567",
                        "sic_code": "64191",
                        "industry_name": "Financial Services",
                        "employer_opt_in_status": "accepted"
                    },
                    "payrolls": [
                        {
                            "payroll": {
                                "id": "PAYROLL-001",
                                "employment_status": "active",
                                "contract_type": "full_time",
                                "payment_run_frequency": "monthly",
                                "annualised_salary": 3000000,
                                "pay_dates": [
                                    {
                                        "pay_date": "2026-10-28",
                                        "payroll_cutoff": "2026-10-20",
                                        "pay_period": "October-26"
                                    },
                                    {
                                        "pay_date": "2026-11-27",
                                        "payroll_cutoff": "2026-11-19",
                                        "pay_period": "November-26"
                                    }
                                ]
                            }
                        }
                    ]
                }
            }
        ]
    }
}

🟠400Bad Request

🟠401Unauthorised

🟠403Forbidden

🟠404Not Found

🟠409Conflict

🟠422Unprocessable Entity