v1

latestOpenAPI 3.1.02026-07-243113441.2 MB

Contractor Payments

Fund a contractor payment [DEMO]

🚧 Demo action

This action is only available in the Demo environment

Simulate funding a contractor payment. Funding only occurs automatically in the production environment when bank transactions are generated. Use this action in the demo environment to transition a contractor payment's status from Unfunded to Funded. A Funded status is required for generating a contractor payment receipt.

scope: payrolls:run

put/v1/contractor_payments/{contractor_payment_uuid}/fund

Path parameters

contractor_payment_uuidstring required

The UUID of the contractor payment

Headers

X-Gusto-API-Version'2026-06-15'

Determines the date-based API version associated with your API call. If none is provided, your application's minimum API version is used.

Response

uuidstring required

The unique identifier of the contractor payment in Gusto.

contractor_uuidstring

The UUID of the contractor.

bonusstring float

The bonus amount in the payment.

datestring

The payment date.

hoursstring float

The number of hours worked for the payment.

payment_method'Direct Deposit' | 'Check' | 'Historical Payment' | 'Correction Payment'

The payment method.

reimbursementstring float

The reimbursement amount in the payment.

status'Funded' | 'Unfunded'

Contractor payment status

hourly_ratestring float

The rate per hour worked for the payment.

may_cancelboolean

Determine if the contractor payment can be cancelled.

wagestring float

The fixed wage of the payment, regardless of hours worked.

wage_type'Hourly' | 'Fixed'

The wage type for the payment.

wage_totalstring float

(hours * hourly_rate) + wage + bonus

invoice_numberstring nullable

An optional invoice number associated with this contractor payment. This will be visible to the contractor on their paystub. Maximum 25 characters.

memostring nullable

An optional note or memo for this contractor payment. This will be visible to the contractor on their paystub.