These docs are for v2024-03-01. Click to read the latest docs for v2026-02-01.

Update an employee's payment method

put

https://api.gusto-demo.com/v1/employees/{employee_id}/payment_method

Updates an employee's payment method. Note that creating an employee bank account will also update the employee's payment method.

scope: employee_payment_methods:write

Path Params

employee_id

string

required

The UUID of the employee

Body Params

version

string

required

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

type

string

enum

required

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.

Allowed:

split_by

string

enum

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.

Allowed:

splits

array of objects

splits

Headers

X-Gusto-API-Version

string

enum

Defaults to 2024-03-01

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

Allowed:

Responses

404

Not Found

The requested resource does not exist. Make sure the provided UUID is valid.

Language

Credentials

Bearer

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Example response

422Unprocessable Entity This may happen when the body of your request contains errors such as invalid_attribute_value, or the request fails due to an invalid_operation. See the Errors Categories guide for more details.