Salary Deduction Confirmation Submission

Call this endpoint to tell Ontime what you deducted for a batch. Send the confirmation as JSON (Content-Type: application/json) or as CSV (Content-Type: text/csv). Any other content type is rejected. Parameters such as ; charset=utf-8 are ignored.

A 200 means Ontime has received the confirmation. Ontime checks it afterwards, and rejects it if:

batch_id or payroll_id does not match the path;

total_amount is not the sum of confirmed_deduction_amount, or employee_count is not the number of entries;

an entry has no confirmed_deduction_amount, or an unknown deduction_amount_reason;

an employee in the batch is missing or appears more than once;

an employee's confirmed amount, or the total, is more than was requested.

You can send a confirmation again for the same batch, for example after a rejection; it replaces the one before it. Once a confirmation has been fully processed, another one for the same batch is refused.

In CSV, the pay date is DD/MM/YYYY and the deductions section must be the last:

batch_id,payroll_id,total_amount,employee_count,pay_date,currency
261020101530123456,PAYROLL-001,2000,2,31/10/2026,GBP

employee_id,requested_deduction_amount,confirmed_deduction_amount,deduction_amount_reason
EMP-001,4509,2000,insufficient_funds
EMP-002,0,0,

Every error body is a problem_details object.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

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

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

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

Token URL: https://${userPoolDomain}.auth.${region}.amazoncognito.com/oauth2/token

Scopes:

deduction_data_confirmation:submit-Can submit Confirmation Deduction data

Path Params

Header Params

Body Params application/jsonRequired

Example

{
    "deduction_data_confirmation": {
        "batch_id": "261020101530123456",
        "payroll_id": "PAYROLL-001",
        "total_amount": 2000,
        "employee_count": 2,
        "pay_date": "2026-10-31",
        "currency": "GBP",
        "deduction_data": [
            {
                "salary_deduction": {
                    "employee_id": "EMP-001",
                    "requested_deduction_amount": 4509,
                    "confirmed_deduction_amount": 2000,
                    "deduction_amount_reason": "insufficient_funds"
                }
            },
            {
                "salary_deduction": {
                    "employee_id": "EMP-002",
                    "requested_deduction_amount": 0,
                    "confirmed_deduction_amount": 0
                }
            }
        ]
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Salary Deduction Confirmation Submission

Request

Request Code Samples

Responses