Update the effective Account's payer settings

Update payer-global settings for the effective Account. Contractor and W-2 payroll resolve the same default or currency-specific debit source. Payable terms resolve engagement, relationship, then effective payer Account defaults; payee-issued Invoice terms remain payee-controlled. Auto-pay for both document types resolves engagement, relationship, then effective payer Account defaults; otherwise auto-pay is off. Changing a default reaches relationships and engagements without an applicable own value; explicit values remain unchanged. Null removes an individual stored default; omitted fields stay unchanged. defaultPaymentMethod updates the canonical Client profile pointer; InternalAccount is currently rejected with 422 payments.PayerSettingsDefaultPaymentMethodUnsupported. Person sessions, API keys, and ServiceAccounts are accepted subject to the PayoutMethodChange elevation policy.

Requires a session with recent MFA step-up for PayoutMethodChange. If step-up is missing or expired, this operation returns 403 StepUpMfaRequired; create and verify an MFA challenge at /v3/platform/mfa-challenges with requiredFor: "PayoutMethodChange", then retry.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
payableDefaults
object

Account-level payer defaults. Payment terms apply to Payables; payee-issued Invoice terms remain payee-controlled. Auto-pay applies to both Invoices and Payables. Applicable values resolve engagement, relationship, then the actual payer's current own or inherited Account default; otherwise terms are unset and auto-pay is off. Changing a default reaches relationships and engagements without an applicable own value; explicit values remain unchanged. Omitted PATCH fields stay unchanged; null removes the stored default and permits an inherited fallback where the parent link allows it.

string
enum

ISO 4217 currency code

defaultPaymentMethod
object

Account-owned PaymentCard or ExternalBankAccount to persist in the canonical Client profile.

payrollSettings
object

Contractor payroll lifecycle, flags and funding. Cadence is not writable here — use PATCH /payments/payroll-schedules/Contractor.

employerPayrollSettings
object

W-2 payroll lifecycle only. Cadence moved to PATCH /payments/payroll-schedules/Employee. Requires an existing EmployerPayrollProfile whose schedule has been initialized through POST /payments/payroll-schedules/Employee/initialize — 422 when the Account has no cadence yet, 404 when it has no profile.

Headers
string
length between 1 and 255
^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

string
^(?:[A-Za-z0-9_.]{22}|[a-f0-9]{24})$

Select the Account for an Account-scoped operation. A direct ServiceAccount API key MUST supply this header, and the target must be within the ServiceAccount owner's or Authorization grant's Account boundary. A Person bearer may select an Account on which it has an active Stakeholder, and an Account session may select its bound Account (or a descendant only when the session explicitly includes descendants).

string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json