Get Contractor Payment Link

Fetches an expirable link that displays contractor payment details, including the pay statement.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

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 an contractor's browser.

NOTE: This link expires 24 hours after generation.

Returns

Returns response status and the link to the requested contractor.

attributestypedescription
successbooleanResponse status
datastringLink to contractor payment page
errorsarrayContains a list of error objects which consists of:
message: Error message
code: Error code as described in Error codes
Query Params
string
required

Company ID of employer

string
required

ID of Contractor Payment

boolean
Defaults to false

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

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json