How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
OnPay

OnPay Employees API

The Employees API from OnPay — 14 operation(s) for employees.

Documentation Provider Profile APIs.io OpenAPI GitHub

OnPay Employees API is one of 6 APIs that OnPay publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Employees. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 23 operations across 14 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://onpaydev.com/v2.

23 operations 14 paths 19 schemas 10 GET6 PATCH6 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://api.onpay.com/v2
Authentication
OAuth 2.0, API Key
Resource Areas
1

Authentication & Security 2

OnPay Employees API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow, exposing 6 scopes. An API key is passed in the header as Authorization (Bearer).

Paths & Operations 23

Across 14 paths, the API surfaces 23 operations — 10 GET, 6 PATCH, 6 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Employees 23
GET
/employees
Get employees
getEmployees → 200400401402
POST
/employees
Create employees
postEmployees body → 200
GET
/employees/{employee_id}
Get employees by employee id
getEmployeesByEmployeeId 1 param → 200default
PATCH
/employees/{employee_id}
Update employees by employee id
patchEmployeesByEmployeeId 1 param body → 200default
GET
/employees/{employee_id}/deductions
Get employees by employee id deductions
getEmployeesByEmployeeIdDeductions 1 param → 200default
PATCH
/employees/{employee_id}/deductions/{deduction_id}
Update employees by employee id deductions by deduction id
patchEmployeesByEmployeeIdDeductionsByDeductionId 2 params body → 200default
POST
/employees/{employee_id}/deductions/{deduction_id}
Create employees by employee id deductions by deduction id
postEmployeesByEmployeeIdDeductionsByDeductionId 2 params body → 200
GET
/employees/{employee_id}/deductions/{deduction_id}/schedule
Get employees by employee id deductions by deduction id schedule
getEmployeesByEmployeeIdDeductionsByDeductionIdSchedule 2 params → 200
POST
/employees/{employee_id}/deductions/{deduction_id}/schedule
Create employees by employee id deductions by deduction id schedule
postEmployeesByEmployeeIdDeductionsByDeductionIdSchedule 2 params body → 200
GET
/employees/{employee_id}/bank-accounts
Get employees by employee id bank accounts
getEmployeesByEmployeeIdBankAccounts 1 param → 200
PUT
/employees/{employee_id}/bank-accounts
Replace employees by employee id bank accounts
putEmployeesByEmployeeIdBankAccounts 1 param body → 200
GET
/employees/{employee_id}/wages
Get employees by employee id wages
getEmployeesByEmployeeIdWages 1 param → 200
PATCH
/employees/{employee_id}/wages
Update employees by employee id wages
patchEmployeesByEmployeeIdWages 1 param body → 200
GET
/employees/{employee_id}/wages/schedule
Get employees by employee id wages schedule
getEmployeesByEmployeeIdWagesSchedule 1 param → 200
POST
/employees/{employee_id}/wages/schedule
Create employees by employee id wages schedule
postEmployeesByEmployeeIdWagesSchedule 1 param body → 200
GET
/employees/{employee_id}/leave
Get employees by employee id leave
getEmployeesByEmployeeIdLeave 1 param → 200
PATCH
/employees/{employee_id}/leave
Update employees by employee id leave
patchEmployeesByEmployeeIdLeave 1 param body → 200
GET
/employees/{employee_id}/tax-fields
Get employees by employee id tax fields
getEmployeesByEmployeeIdTaxFields 1 param → 200
PATCH
/employees/{employee_id}/tax-fields
Update employees by employee id tax fields
patchEmployeesByEmployeeIdTaxFields 1 param body → 200
PATCH
/employees/{employee_id}/tax-fields/worksite
Update employees by employee id tax fields worksite
patchEmployeesByEmployeeIdTaxFieldsWorksite 1 param body → 200
POST
/employees/{employee_id}/termination
Create employees by employee id termination
postEmployeesByEmployeeIdTermination 1 param body → 200
POST
/employees/{employee_id}/rehire
Create employees by employee id rehire
postEmployeesByEmployeeIdRehire 1 param body → 200
GET
/employees/recent-notes-and-comments
Get employees recent notes and comments
getEmployeesRecentNotesAndComments → 200400401402

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are Employee (45 properties), EmployeeDeductionItemBatch (19 properties), EmployeeDeductionItem (14 properties), DeductionListItem (10 properties). Each schema is shown below with its type and property counts.

StateDisplayFieldsObject
object
2 properties
DeductionIncludedIn401kReports
string
L For Standard Deductions: include as loan in 401k reports S report as safe harbor Y include in deferral amounts N exclude
PatchSuccessful
object
1 property
EmployeeAchAccountPutItem
object
5 properties
EmployeePost
object
4 properties
EmployeeDeductionItem
object
14 properties
DeductionListItem
object
10 properties
PayItem
object
6 properties
EmployeeDeductionItemBatch
object
19 properties
DeductionType
integer
1 Section 125 2 401K 3 403B 4 457 6 Roth 401K 7 Roth 403B 8 FSA 9 HSA 10 Simple IRA 21 Post-tax 22 Cash tips imputed 23 Union dues 24 Imputed 25 Union dues bas…
EmployeeAchAccountItem
object
9 properties
InsertSuccessful
object
2 properties
WageListItem
object
6 properties
DisplayFieldsObject
object
5 properties
EmployeeNote
object
8 properties
StateInformationObject
object
1 property
LeaveItem
object
3 properties
ErrorBadRequest
object
2 properties
Employee
object
45 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

onpay-employees-api-openapi.yml Raw ↑

Other APIs OnPay publishes across the network.

OnPay Company API
AE Profile APIs.io
OnPay Deductions API
AE Profile APIs.io
OnPay Pay Runs API
AE Profile APIs.io
OnPay Reports API
AE Profile APIs.io
OnPay User API
AE Profile APIs.io
#Employees
← Back to O APIs
API Details
ID
onpay:onpay-employees-api
Base URL
https://api.onpay.com/v2
Docs
https://onpay.readme.io/reference/authorization
Provider
OnPay
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=onpay-employees-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/onpay-employees-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of OnPay Employees API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.