v1
latestOpenAPI 3.1.02026-07-243113441.2 MBList contractor payment details
Get payment details for contractors in a company. This endpoint returns a list of all contractors associated with the specified company, including their payment methods and bank account details if they are paid via direct deposit.
For contractors paid by direct deposit, the response includes their bank account information with sensitive data masked for security. The payment details also include information about how their payments are split if they have multiple bank accounts configured.
For contractors paid by check, only the basic payment method information is returned.
Response Details
- For direct deposit contractors:
- Bank account details (masked)
- Payment splits configuration
- Routing numbers
- Account types
- For check payments:
- Basic payment method designation
Common Use Cases
- Fetching contractor payment information for payroll processing
- Verifying contractor payment methods
- Reviewing payment split configurations
encrypted_account_number is available only with the additional scope contractor_payment_methods:read:account_numbers.
scope: contractor_payment_methods:read
Path parameters
The UUID of the company. This identifies the company whose contractor payment details you want to retrieve.
Query parameters
Optional filter to get payment details for a specific contractor. When provided, the response will only include payment details for this contractor.
Optional filter to get payment details for contractors in a specific payment group. When provided, the response will only include payment details for contractors in this group.
Headers
Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.
Response
successful