Get Contractor Payment Link

Time	Status	User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

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 Skip link to Returns

Returns response status and the link to the requested contractor.

attributes	type	description
success	boolean	Response status
data	string	Link to contractor payment page
errors	array	Contains a list of error objects which consists of: `message`: Error message `code`: Error code as described in Error codes

companyID

string

required

Company ID of employer

contractorPaymentID

string

required

ID of Contractor Payment

allow_retry

boolean

Defaults to false

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

truefalse

``200 200

``400 400

Updated 3 months ago

ShellNodeRubyPHPPython


xxxxxxxxxx

curl --request GET \

--url 'https://api.zeal.com/paymentLink?allow_retry=false' \

--header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200 - Result400 - Result

Updated3 months ago