Skip to main content
PATCH
Update payroll settings

Authorizations

Authorization
string
header
required

Server API key, scoped. pk_test_ keys hit the sandbox tenant.

Headers

X-Step-Up-Token
string

Required when changing the second approver or the source account (see description).

X-Request-Id
string

Optional client correlation id, up to 128 characters. It is not echoed: the response's X-Request-Id is always our own req_… id. We log your value with the request as client_request_id, so support can find a request by either id. A longer value is refused with 400 parameter_invalid.

Maximum string length: 128

Body

application/json
pay_day
object

When runs pay. If it falls on a weekend or public holiday, the working day before.

email_payslips
boolean

Email payslips on pay day.

remind_before_pay_day
boolean

Remind 3 days before.

auto_pay_when_approved
boolean

Pay automatically if approved.

second_approver_membership_id
string

mem_… with a role that can approve payments. Needs step-up.

source_account_id
string

acc_…. Needs step-up.

Response

The updated settings.

Payroll settings for the business.

object
string
required

Always payroll_settings.

Allowed value: "payroll_settings"
updated_at
string<date-time>
required

RFC 3339, UTC.

Example:

"2026-10-27T08:41:00Z"

pay_day
object
required

When runs pay. If it falls on a weekend or public holiday, the working day before.

email_payslips
boolean
required

Email each person a PDF payslip on pay day.

remind_before_pay_day
boolean
required

Remind approvers 3 days before pay day and warn if the source account is short.

auto_pay_when_approved
boolean
required

Scheduled runs pay out on pay day without anyone calling executePayRun.

second_approval_threshold
object
required

Runs with net pay above this need a second approver. Set by the business's approval limits (read-only here).

source_account
object
required

Account runs are paid from (Naira · Payroll).

second_approver
object

Team member who approves runs over the threshold.

top_up_account
object

Account suggested for topping up the source account (Naira · Main).

narration_format
string

Narration on salary transfers; {Mon} and {YYYY} are replaced per run ("Salary Nov 2026"). Read-only.

approve_by_time
string

Local time (Africa/Lagos) on the day before pay day by which a run must be approved to pay on pay day.

Pattern: ^\d{2}:\d{2}$