Skip to main content
POST
Create Contractor Payment
Create a contractor payment in Zeal. Zeal will process the payment for the contractor the day before the pay_date. Multiple contractor payments may be submitted for the same contractor and the same pay_date.

Returns

Returns boolean indicating success status and contractor payment object if successful.

Authorizations

Authorization
string
header
required

Body

application/json
companyID
string
required

Company ID of employer

contractorID
string
required

ID of Contractor that needs to be paid out

pay_date
string<date>
required

Pay date for this payment. Formatted as a date in ISO-8601 format (YYYY-MM-DD). If the pay_date falls on a weekend/bank holiday or the current time is after 2 PM two days before the given pay_date, please correct the date and resubmit. We will not roll forward the pay_date automatically

approval_required
boolean
default:false

Set to true if this payment requires manual approval by the employer. Otherwise, by default, Zeal will automatically process the payment two business days before the pay_date

amount
number<float>

Amount that needs to be paid out. Only required if no payment items are present.

payment_items
object[]

Array of payment item objects. If payment items are present, amount is not required.

speed
enum<string>

Accepts two_day, one_day, one_day_no_reserve, zero_day,zero_day_no_reserve or instant as values (Early Access)

Available options:
two_day,
one_day,
one_day_no_reserve,
zero_day,
instant,
zero_day_no_reserve
type
enum<string>
default:regular

Type of payment. Only regular payments are reported on a contractor's Form 1099-NEC.

Available options:
regular,
reimbursement
disbursement
object

The disbursement for the how payment will be made. Defaults to direct_deposit if left empty.

customerAccountID
string

ID of Customer Account associated with this Contractor Payment

apply_contractor_deductions
boolean

Applies a deduction to this check for each contractor deduction template that is effective at the time of the pay date for the contractor. Note: Only applicable when payment_items is provided

metadata
object

Custom metadata object.

Response

200

success
boolean
default:true
Example:

true

data
object