Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zeal Contractor Payments API

The Contractor Payments API from Zeal — 2 operation(s) for contractor payments.

Zeal Contractor Payments API is one of 10 APIs that Zeal publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 5 operations across 2 paths, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 1.0.

Requests are made against a single base URL, https://api.zeal.com.

5 operations 2 paths 2 schemas 1 DELETE1 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.zeal.com
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

Zeal Contractor Payments API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — Provide your Zeal API key as a Bearer token: Authorization: Bearer . Use a test key for Test Mode and a live key for production. Requests are additionally scop…

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 1 GET, 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Contractor Payments 5
POST
/contractorPayments
Create a contractor payment
createContractorPayment body → 200
GET
/contractorPayments
Get contractor payments
getContractorPayments 2 params → 200
PUT
/contractorPayments
Update a contractor payment
updateContractorPayment body → 200
DELETE
/contractorPayments
Delete a contractor payment
deleteContractorPayment 2 params → 200
POST
/contractorPayments/disburse
Trigger a contractor payment disbursement
triggerContractorDisbursement body → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are CreateContractorPaymentRequest (4 properties), ContractorPayment (4 properties). Each schema is shown below with its type and property counts.

ContractorPayment
object
4 properties
CreateContractorPaymentRequest
object
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zeal-hq-contractor-payments-api-openapi.yml Raw ↑

Other APIs Zeal publishes across the network.

Zeal Companies API
Zeal Contractors API
Zeal Employee Check API
Zeal Employees API
Zeal Funding API
Zeal Onboarding API
Zeal Pay Schedules API
Zeal Reports API
Zeal Tax API