Skip to content

Rippling: Create a new payroll payment mode change — response body — results item

Create a new payroll payment mode change: response body, field results / item. Complete fields and constraints for contract 2026-10-28.

API reference · Contract 2026-10-28

SDK schema: Create a new payroll payment mode change — response body — results item

FieldTypePresenceDescription and constraints
$objectRoot
errorobjectOptionalStructured error when the item was rejected. This field is omitted for UPDATED items and is present for REJECTED items.
error.codestringOptionalMachine-readable error code for a rejected item. DUPLICATE_NO_OP means the requested change was already requested and no retry is needed; DUPLICATE_TARGET_CONFLICT, OUT_OF_SCOPE, RUN_NOT_FOUND, WORKER_NOT_IN_RUN, and PAYMENT_MODE_NOT_SUPPORTED are terminal request errors that require changing the request or authorization; RUN_NOT_WRITABLE may be retried when the run becomes writable; PAYMENT_MODE_UPDATE_FAILED is retryable after the underlying update failure is resolved.
Known values: DUPLICATE_NO_OP, DUPLICATE_TARGET_CONFLICT, OUT_OF_SCOPE, RUN_NOT_FOUND, RUN_NOT_WRITABLE, WORKER_NOT_IN_RUN, PAYMENT_MODE_NOT_SUPPORTED, PAYMENT_MODE_UPDATE_FAILED
error.messagestringOptionalHuman-readable error message.
payment_modestringOptionalRequested Global Payroll payment mode code.
Known values: DEFAULT, BANK_FILE, MANUAL, SAME_DAY_ACH, CHECK_PRINTING, CHECK_MAILING
run_idstringOptionalID of the requested payroll run.
statusstringOptionalItem result: UPDATED or REJECTED.
Known values: UPDATED, REJECTED
worker_idstringOptionalID of the requested worker.

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.