Get payroll settings
Error codes: invalid_api_key, parameter_invalid, scope_missing, rate_limited.
Authorizations
Server API key, scoped. pk_test_ keys hit the sandbox tenant.
Headers
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.
128Response
The settings.
Payroll settings for the business.
Always payroll_settings.
"payroll_settings"RFC 3339, UTC.
"2026-10-27T08:41:00Z"
When runs pay. If it falls on a weekend or public holiday, the working day before.
Email each person a PDF payslip on pay day.
Remind approvers 3 days before pay day and warn if the source account is short.
Scheduled runs pay out on pay day without anyone calling executePayRun.
Runs with net pay above this need a second approver. Set by the business's approval limits (read-only here).
Account runs are paid from (Naira · Payroll).
Team member who approves runs over the threshold.
Account suggested for topping up the source account (Naira · Main).
Narration on salary transfers; {Mon} and {YYYY} are replaced per run ("Salary Nov 2026"). Read-only.
Local time (Africa/Lagos) on the day before pay day by which a run must be approved to pay on pay day.
^\d{2}:\d{2}$