Get a payslip
Error codes: invalid_api_key, parameter_invalid, resource_not_found, 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.
128Path Parameters
Payslip id (pys_…).
^pys_[0-9A-HJKMNP-TV-Z]{26}$Response
The payslip.
A payslip (pys_…), issued when a line completes.
pys_…
Always payslip.
"payslip"RFC 3339, UTC.
"2026-10-27T08:41:00Z"
run_…
Pay month.
^\d{4}-\d{2}$Calendar date, interpreted in Africa/Lagos.
"2026-11-07"
Snapshot at issue.
Pay items.
An amount in minor units (kobo, cents) with its currency. Never a decimal.
An amount in minor units (kobo, cents) with its currency. Never a decimal.
Deductions.
An amount in minor units (kobo, cents) with its currency. Never a decimal.
An amount in minor units (kobo, cents) with its currency. Never a decimal.
pln_…
Where net pay went.
RFC 3339, UTC.
"2026-10-27T08:41:00Z"