Salary Deduction Data Request

GET

/deductions/{payroll_id}

OperationId:get_salary_deduction_data

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:request-Can request Salary Deduction

Path Params

Query Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --globoff '/deductions/12345?pay_date={{%24date.isoTimestamp}}&pay_period=1-26' \
--header 'x-api-key: <api-key>' \
--header 'Authorization: Bearer <token>'

Responses

🟢200Success

application/json

Bodyapplication/json

Example

{
    "deduction_data_response": {
        "payroll_id": "00ca72a7-823e-455c-bdb6-3352e045a331",
        "pay_date": "2027-02-18T17:37:16.554Z",
        "id": "eb6a1461-f3a3-460f-868a-9b7823dc7857",
        "total_amount": 85.85,
        "employee_count": 1,
        "currency": "GBP",
        "deduction_data": [
            {
                "salary_deduction": {
                    "employee_id": "3eff5616-3c01-423b-b30f-036e9048a508",
                    "requested_deduction_amount": 100,
                    "payment_reference": "ABC123"
                }
            },
            {
                "salary_deduction": {
                    "employee_id": "48d0b524-20a7-4165-815f-34655a0aa691",
                    "requested_deduction_amount": 200,
                    "payment_reference": "DEF456"
                }
            },
            {
                "salary_deduction": {
                    "employee_id": "6b29d56c-0b00-412f-94b6-4bceb0638b08",
                    "requested_deduction_amount": 300,
                    "payment_reference": "GHI789"
                }
            }
        ]
    },
    "requested_payments": [
        {
            "payment_information": {
                "payment_reference": "adipisicing",
                "payment_amount": 600,
                "payment_account": {
                    "account_number": "12345678",
                    "sort_code": "12-34-56",
                    "account_holder_name": "Ontime Payment Account"
                }
            }
        }
    ]
}

🟠401Unauthorised

🟠403Forbidden

🟠404Not Found

🟠409Conflict

🟠422Unprocessable Entity

Webhooks

Salary Deduction Confirmation Submission