Skip to main content
GET
Get Contractor Payment Link
Given the Company ID and Contractor Payment ID, Zeal returns an expirable, mobile-friendly link with the contractor payment details, including the ability to download the pay statement. This link can be hosted on your custom domain in an iframe component and/or can be opened directly in a contractor’s browser.
This link expires 24 hours after generation.

Authorizations

Authorization
string
header
required

Query Parameters

companyID
string
required

Company ID of employer

contractorPaymentID
string
required

ID of Contractor Payment

allow_retry
boolean
default:false

Boolean flag to allow the worker to retry a returned transaction on this contractor payment

Response

200

success
boolean
default:true
Example:

true

data
string
Example:

"https://payroll.yourdomain.com/public/paystub/<accessToken>"