curl --request PATCH \
  --url https://api.panoflow.io/v1/payroll/people/{person_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pay_items": [
    {
      "type": "basic",
      "amount": {
        "amount": 20400000,
        "currency": "NGN"
      }
    },
    {
      "type": "housing",
      "amount": {
        "amount": 8500000,
        "currency": "NGN"
      }
    },
    {
      "type": "transport",
      "amount": {
        "amount": 5100000,
        "currency": "NGN"
      }
    }
  ]
}
'

{
  "id": "<string>",
  "object": "payroll_person",
  "created_at": "2026-10-27T08:41:00Z",
  "updated_at": "2026-10-27T08:41:00Z",
  "name": "<string>",
  "status": "active",
  "start_date": "2026-11-07",
  "bank_account": {
    "bank_code": "058",
    "bank_name": "<string>",
    "account_number_last4": "<string>",
    "account_name": "<string>",
    "verified_at": "2026-10-27T08:41:00Z"
  },
  "pay_items": [
    {
      "type": "basic",
      "name": "<string>",
      "amount": {
        "amount": 45000000,
        "currency": "NGN"
      }
    }
  ],
  "pay": {
    "gross": {
      "amount": 45000000,
      "currency": "NGN"
    },
    "deductions": [
      {
        "deduction_type_id": "<string>",
        "name": "<string>",
        "applies_to_everyone": true,
        "amount": {
          "amount": 45000000,
          "currency": "NGN"
        },
        "person_deduction_id": "<string>",
        "short_name": "<string>",
        "how": "<string>",
        "loan_remaining_after": {
          "amount": 45000000,
          "currency": "NGN"
        }
      }
    ],
    "deduction_total": {
      "amount": 45000000,
      "currency": "NGN"
    },
    "net": {
      "amount": 45000000,
      "currency": "NGN"
    }
  },
  "email": "jsmith@example.com",
  "role": "<string>",
  "team": "<string>",
  "end_date": "2026-11-07",
  "offboarded_at": "2026-10-27T08:41:00Z",
  "metadata": {}
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

People

Update a person (details, pay, bank account, leave)

“Edit pay”. pay_items, when sent, replaces the whole list. A new bank_account is confirmed by name enquiry exactly as on create.

Changes to pay, bank account or leave apply to draft runs immediately (their lines are recomputed). If the person is on a run that is pending_approval or scheduled, that run goes back to draft with status_reason: changed_after_approval and its approval is canceled: it needs approving again. 409 invalid_state while a run that includes them is processing, or if they are offboarded.

Error codes: invalid_api_key, parameter_invalid, parameter_missing, resource_not_found, scope_missing, csrf_token_invalid, invalid_state, bank_unavailable, name_enquiry_failed, account_number_invalid, recipient_name_mismatch, amount_too_small, rate_limited.

PATCH

payroll

people

{person_id}

curl --request PATCH \
  --url https://api.panoflow.io/v1/payroll/people/{person_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pay_items": [
    {
      "type": "basic",
      "amount": {
        "amount": 20400000,
        "currency": "NGN"
      }
    },
    {
      "type": "housing",
      "amount": {
        "amount": 8500000,
        "currency": "NGN"
      }
    },
    {
      "type": "transport",
      "amount": {
        "amount": 5100000,
        "currency": "NGN"
      }
    }
  ]
}
'

{
  "id": "<string>",
  "object": "payroll_person",
  "created_at": "2026-10-27T08:41:00Z",
  "updated_at": "2026-10-27T08:41:00Z",
  "name": "<string>",
  "status": "active",
  "start_date": "2026-11-07",
  "bank_account": {
    "bank_code": "058",
    "bank_name": "<string>",
    "account_number_last4": "<string>",
    "account_name": "<string>",
    "verified_at": "2026-10-27T08:41:00Z"
  },
  "pay_items": [
    {
      "type": "basic",
      "name": "<string>",
      "amount": {
        "amount": 45000000,
        "currency": "NGN"
      }
    }
  ],
  "pay": {
    "gross": {
      "amount": 45000000,
      "currency": "NGN"
    },
    "deductions": [
      {
        "deduction_type_id": "<string>",
        "name": "<string>",
        "applies_to_everyone": true,
        "amount": {
          "amount": 45000000,
          "currency": "NGN"
        },
        "person_deduction_id": "<string>",
        "short_name": "<string>",
        "how": "<string>",
        "loan_remaining_after": {
          "amount": 45000000,
          "currency": "NGN"
        }
      }
    ],
    "deduction_total": {
      "amount": 45000000,
      "currency": "NGN"
    },
    "net": {
      "amount": 45000000,
      "currency": "NGN"
    }
  },
  "email": "jsmith@example.com",
  "role": "<string>",
  "team": "<string>",
  "end_date": "2026-11-07",
  "offboarded_at": "2026-10-27T08:41:00Z",
  "metadata": {}
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

{
  "error": {
    "response_code": "00",
    "type": "invalid_request",
    "code": "invalid_json",
    "message": "<string>",
    "request_id": "<string>",
    "param": "<string>",
    "doc_url": "<string>",
    "details": {}
  }
}

Authorizations

Authorization

string

header

required

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

Headers

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

Path Parameters

person_id

string

required

Payroll person id (ppl_…).

Pattern: ^ppl_[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json

name

string

Full name.

Required string length: 1 - 120

string<email>

Maximum string length: 254

role

string

Job title.

Maximum string length: 80

team

string

Team.

Maximum string length: 60

start_date

string<date>

Only while starting.

Example:

"2026-11-07"

on_leave

boolean

True for paid leave (still paid), false to return to active.

bank_account

object

Where the person is paid. Confirmed by name enquiry.

Show child attributes

confirm_account_name

boolean

Accept the bank's account name even if it differs from name.

pay_items

object[]

Replaces all pay items.

Required array length: 1 - 20 elements

Show child attributes

metadata

object

Up to 20 string keys (≤ 40 chars) with string values (≤ 500 chars). Returned on the resource and its events.

Show child attributes

Response

The updated person.

A person on payroll (ppl_…).

string

required

ppl_…

object

string

required

Always payroll_person.

Allowed value: "payroll_person"

created_at

string<date-time>

required

RFC 3339, UTC.

Example:

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

updated_at

string<date-time>

required

RFC 3339, UTC.

Example:

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

name

string

required

Full name.

status

enum<string>

required

active is paid; on_leave is on paid leave and still paid ("On leave, paid"); starting has a start date after today ("Starts 1 Nov"); offboarded is past their end date and never paid again.

Available options:

active,

on_leave,

starting,

offboarded

start_date

string<date>

required

Calendar date, interpreted in Africa/Lagos.

Example:

"2026-11-07"

bank_account

object

required

The person's bank account. Only the last four digits are returned.

Show child attributes

pay_items

object[]

required

Monthly earnings.

Show child attributes

pay

object

required

What the next run would pay, with current deductions (before any one-off bonus).

Show child attributes

string<email>

Where payslips are sent.

Maximum string length: 254

role

string

Job title.

team

string

Team.

end_date

string<date>

Calendar date, interpreted in Africa/Lagos.

Example:

"2026-11-07"

offboarded_at

string<date-time>

RFC 3339, UTC.

Example:

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

metadata

object

Up to 20 string keys (≤ 40 chars) with string values (≤ 500 chars). Returned on the resource and its events.

Show child attributes

Accounts & transactions

Payments

Collections

Payroll

Approvals

Webhooks & events

OAuth

Update a person (details, pay, bank account, leave)

Authorizations

Headers

Path Parameters

Body

Response