GuidesReferenceChangelogAPI Upgrades
Reference

List contractor payments

get
https://sandbox.checkhq.com/contractors//payments

Returns a list of payments for the specified contractor from approved, managed payrolls. Payments on draft payrolls and on external payrolls are omitted. For external payroll contractor payments, use List external payrolls.

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

ID of the contractor to return payments for

Query Params
string

Return payments for the payroll specified by this payroll ID.

int32
Defaults to 25

Number of payments returned per page. The maximum value is 25.

string

Filters to only show payments for payrolls with the specified status. If multiple status params are provided, payments with any of the statuses will be returned. Accepted values are pending, processing, failed, or paid.

date

Return payments from payrolls with a payday on or after this date (YYYY-MM-DD)

date

Return payments from payrolls with a payday on or before this date (YYYY-MM-DD)

Response

Updated 15 days ago

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

Updated 15 days ago

Did this page help you?