Include or exclude a person, or set a one-off bonus

curl --request PATCH \
  --url https://api.panoflow.io/v1/payroll/runs/{run_id}/lines/{line_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bonus": {
    "amount": 5000000,
    "currency": "NGN"
  }
}
'

{
  "id": "<string>",
  "object": "pay_run",
  "created_at": "2026-10-27T08:41:00Z",
  "updated_at": "2026-10-27T08:41:00Z",
  "period": "<string>",
  "name": "<string>",
  "pay_date": "2026-11-07",
  "status": "draft",
  "pay_timing": "pay_day",
  "narration": "<string>",
  "source_account": {
    "id": "<string>",
    "name": "<string>",
    "account_number": "8012457739"
  },
  "totals": {
    "people_count": 123,
    "gross": {
      "amount": 45000000,
      "currency": "NGN"
    },
    "bonuses": {
      "amount": 45000000,
      "currency": "NGN"
    },
    "deductions": {
      "amount": 45000000,
      "currency": "NGN"
    },
    "net": {
      "amount": 45000000,
      "currency": "NGN"
    },
    "paid": {
      "amount": 45000000,
      "currency": "NGN"
    },
    "failed_count": 123
  },
  "requires_second_approval": true,
  "approve_by": "2026-10-27T08:41:00Z",
  "status_reason": "awaiting_second_approval",
  "deductions_to_remit": [
    {
      "deduction_type_id": "<string>",
      "name": "<string>",
      "amount": {
        "amount": 45000000,
        "currency": "NGN"
      },
      "remits_to": "<string>"
    }
  ],
  "funding": {
    "available": {
      "amount": 45000000,
      "currency": "NGN"
    },
    "covered": true,
    "short_by": {
      "amount": 45000000,
      "currency": "NGN"
    }
  },
  "second_approval_threshold": {
    "amount": 45000000,
    "currency": "NGN"
  },
  "approval": {
    "id": "<string>",
    "status": "pending",
    "approver_name": "<string>"
  },
  "approved_by": [
    {
      "type": "user",
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "prepared_by": {
    "type": "user",
    "id": "<string>",
    "name": "<string>"
  },
  "executed_at": "2026-10-27T08:41:00Z",
  "completed_at": "2026-10-27T08:41:00Z",
  "lines": [
    {
      "response_code": "00",
      "response_message": "Approved or completed successfully",
      "id": "<string>",
      "object": "pay_run_line",
      "person": {
        "id": "<string>",
        "name": "<string>",
        "role": "<string>",
        "bank_name": "<string>",
        "account_number_last4": "<string>"
      },
      "included": true,
      "status": "draft",
      "earnings": [
        {
          "type": "basic",
          "name": "<string>",
          "amount": {
            "amount": 45000000,
            "currency": "NGN"
          }
        }
      ],
      "bonus": {
        "amount": 45000000,
        "currency": "NGN"
      },
      "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"
      },
      "status_reason": "<string>",
      "transfer_id": "<string>",
      "payslip_id": "<string>",
      "completed_at": "2026-10-27T08:41:00Z"
    }
  ]
}

{
  "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": {}
  }
}

PATCH

payroll

runs

{run_id}

lines

{line_id}

curl --request PATCH \
  --url https://api.panoflow.io/v1/payroll/runs/{run_id}/lines/{line_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bonus": {
    "amount": 5000000,
    "currency": "NGN"
  }
}
'

{
  "id": "<string>",
  "object": "pay_run",
  "created_at": "2026-10-27T08:41:00Z",
  "updated_at": "2026-10-27T08:41:00Z",
  "period": "<string>",
  "name": "<string>",
  "pay_date": "2026-11-07",
  "status": "draft",
  "pay_timing": "pay_day",
  "narration": "<string>",
  "source_account": {
    "id": "<string>",
    "name": "<string>",
    "account_number": "8012457739"
  },
  "totals": {
    "people_count": 123,
    "gross": {
      "amount": 45000000,
      "currency": "NGN"
    },
    "bonuses": {
      "amount": 45000000,
      "currency": "NGN"
    },
    "deductions": {
      "amount": 45000000,
      "currency": "NGN"
    },
    "net": {
      "amount": 45000000,
      "currency": "NGN"
    },
    "paid": {
      "amount": 45000000,
      "currency": "NGN"
    },
    "failed_count": 123
  },
  "requires_second_approval": true,
  "approve_by": "2026-10-27T08:41:00Z",
  "status_reason": "awaiting_second_approval",
  "deductions_to_remit": [
    {
      "deduction_type_id": "<string>",
      "name": "<string>",
      "amount": {
        "amount": 45000000,
        "currency": "NGN"
      },
      "remits_to": "<string>"
    }
  ],
  "funding": {
    "available": {
      "amount": 45000000,
      "currency": "NGN"
    },
    "covered": true,
    "short_by": {
      "amount": 45000000,
      "currency": "NGN"
    }
  },
  "second_approval_threshold": {
    "amount": 45000000,
    "currency": "NGN"
  },
  "approval": {
    "id": "<string>",
    "status": "pending",
    "approver_name": "<string>"
  },
  "approved_by": [
    {
      "type": "user",
      "id": "<string>",
      "name": "<string>"
    }
  ],
  "prepared_by": {
    "type": "user",
    "id": "<string>",
    "name": "<string>"
  },
  "executed_at": "2026-10-27T08:41:00Z",
  "completed_at": "2026-10-27T08:41:00Z",
  "lines": [
    {
      "response_code": "00",
      "response_message": "Approved or completed successfully",
      "id": "<string>",
      "object": "pay_run_line",
      "person": {
        "id": "<string>",
        "name": "<string>",
        "role": "<string>",
        "bank_name": "<string>",
        "account_number_last4": "<string>"
      },
      "included": true,
      "status": "draft",
      "earnings": [
        {
          "type": "basic",
          "name": "<string>",
          "amount": {
            "amount": 45000000,
            "currency": "NGN"
          }
        }
      ],
      "bonus": {
        "amount": 45000000,
        "currency": "NGN"
      },
      "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"
      },
      "status_reason": "<string>",
      "transfer_id": "<string>",
      "payslip_id": "<string>",
      "completed_at": "2026-10-27T08:41:00Z"
    }
  ]
}

{
  "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

run_id

string

required

Pay run id (run_…).

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

line_id

string

required

Pay run line id (pln_…).

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

Body

application/json

included

boolean

False to leave this person out of this run.

bonus

object

One-off bonus for this run. Send amount 0 to clear.

Show child attributes

Response

The run, recomputed.

A month's pay run (run_…).

string

required

run_…

object

string

required

Always pay_run.

Allowed value: "pay_run"

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"

period

string

required

Pay month.

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

name

string

required

"November 2026 pay run".

pay_date

string<date>

required

Calendar date, interpreted in Africa/Lagos.

Example:

"2026-11-07"

status

enum<string>

required

CONVENTIONS §8 lifecycle: draft → pending_approval (second approver) → scheduled (waits for pay day) → processing → completed | failed; rejected by the second approver; canceled from draft, pending_approval or scheduled. UI: completed → "Paid". Pay runs are never reversed.

Available options:

draft,

pending_approval,

scheduled,

processing,

completed,

failed,

rejected,

canceled,

reversed

pay_timing

enum<string>

required

pay_day: pays on pay_date once approved. now: pays as soon as it is fully approved.

Available options:

pay_day,

now

narration

string

required

Narration on every salary transfer ("Salary Nov 2026").

source_account

object

required

One of the business's own PanoFlow accounts (owned by the Accounts service).

Show child attributes

totals

object

required

Totals over included lines. gross − deductions = net, always.

Show child attributes

requires_second_approval

boolean

required

Net is above second_approval_threshold.

approve_by

string<date-time>

Approve by this time to pay on pay_date ("26 Nov, 4pm").

Example:

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

status_reason

enum<string>

Sub-state.

Available options:

awaiting_second_approval,

awaiting_pay_day,

awaiting_execution,

changed_after_approval,

some_lines_failed,

rejected_by_approver

deductions_to_remit

object[]

Deduction totals by type, with where each goes. Stays in the source account; PanoFlow does not remit them.

Show child attributes

funding

object

Whether the source account covers the run, worked out at read time. Absent once executing.

Show child attributes

second_approval_threshold

object

An amount in minor units (kobo, cents) with its currency. Never a decimal.

Show child attributes

approval

object

The pending or decided approval (kind is pay_run), when one was needed.

Show child attributes

approved_by

object[]

Everyone who approved, in order ("Approved by Adaeze Okafor and Tolu Martins").

Show child attributes

prepared_by

object

Who did something. Shown in activity, approvals and the audit log.

Show child attributes

executed_at

string<date-time>

RFC 3339, UTC.

Example:

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

completed_at

string<date-time>

RFC 3339, UTC.

Example:

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

lines

object[]

One per person. Returned by getPayRun and run actions; omitted from lists.

Show child attributes

Accounts & transactions

Payments

Collections

Payroll

Approvals

Webhooks & events

OAuth

Include or exclude a person, or set a one-off bonus

Authorizations

Headers

Path Parameters

Body

Response