Sign in

v1

latestOpenAPI 3.1.02026-07-243113441.2 MB
Employee Payment Method

Update payment method for an employee

Updates the payment method for an employee. Can set to Check or Direct Deposit with split configuration.

scope: employee_payment_methods:write

put/v1/employees/{employee_id}/payment_method

Path parameters

employee_idstring required

The UUID of the employee

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.

Request body

versionstring required

The current version of the object. See the versioning guide for information on how to use this field.

type'Check' | 'Direct Deposit' required

The payment method type. If type is Check, split_by and splits do not need to be populated. If type is Direct Deposit, split_by and splits are required.

split_by'Percentage' | 'Amount' nullable

How the payment will be split. If Percentage, split amounts must add up to exactly 100. If Amount, values are in cents and the last split amount must be null to capture the remainder.

Example request

{
  "version": "63859768485e218ccf8a449bb60f14ed"
}

Response

Successful

versionstring

The current version of the object. See the versioning guide for information on how to use this field.

type'Direct Deposit' | 'Check'

The payment method type. If type is Check, then split_by and splits do not need to be populated. If type is Direct Deposit, split_by and splits are required.

split_by'Amount' | 'Percentage' nullable

Describes how the payment will be split. If split_by is Percentage, then the split amounts must add up to exactly 100. If split_by is Amount, then the last split amount must be null to capture the remainder.