List contractor payments
Changed onReturns a list of all payments for the specified contractor.
get/contractors/{contractor}/payments (COPY)
Request
- Base URLhttps://sandbox.checkhq.com
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
contractorstring required
ID of the contractor to return payments for
Query parameters
payrollstring
Return payments for the payroll specified by this payroll ID.
limitinteger
Number of payments returned per page. The maximum value is 500.
statusstring
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.
Response
200
Changes
- info
endpoint added
- info