Get the next pay run at a glance

curl --request GET \
  --url https://api.panoflow.io/v1/payroll/upcoming-run \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.panoflow.io/v1/payroll/upcoming-run', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "object": "upcoming_pay_run",
  "period": "2026-11",
  "name": "November 2026 pay run",
  "pay_date": "2026-11-27",
  "approve_by": "2026-11-26T15:00:00Z",
  "people_count": 11,
  "net": {
    "amount": 229745000,
    "currency": "NGN"
  },
  "source_account": {
    "id": "acc_01JV4DK79Q9G8XE6SZAEAVSNTC",
    "name": "Naira · Payroll",
    "account_number": "8012457746"
  },
  "source_available": {
    "amount": 354014000,
    "currency": "NGN"
  }
}

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

GET

payroll

upcoming-run

Get the next pay run at a glance

curl --request GET \
  --url https://api.panoflow.io/v1/payroll/upcoming-run \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.panoflow.io/v1/payroll/upcoming-run', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "object": "upcoming_pay_run",
  "period": "2026-11",
  "name": "November 2026 pay run",
  "pay_date": "2026-11-27",
  "approve_by": "2026-11-26T15:00:00Z",
  "people_count": 11,
  "net": {
    "amount": 229745000,
    "currency": "NGN"
  },
  "source_account": {
    "id": "acc_01JV4DK79Q9G8XE6SZAEAVSNTC",
    "name": "Naira · Payroll",
    "account_number": "8012457746"
  },
  "source_available": {
    "amount": 354014000,
    "currency": "NGN"
  }
}

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

Response

The upcoming run.

The next pay run card.

object

string

required

Always upcoming_pay_run.

Allowed value: "upcoming_pay_run"

period

string

required

Pay month.

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

name

string

required

Run name.

pay_date

string<date>

required

Calendar date, interpreted in Africa/Lagos.

Example:

"2026-11-07"

approve_by

string<date-time>

required

RFC 3339, UTC.

Example:

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

people_count

integer

required

People to be paid.

net

object

required

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

Show child attributes

source_account

object

required

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

Show child attributes

source_available

object

required

The source account's balances.available (AccountBalances) when this summary was read.

Show child attributes

run_id

string

run_… once prepared.

run_status

enum<string>

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

short_by

object

Present when the balance cannot cover net pay ("Top up ₦… before 26 Nov, 4pm").

Show child attributes

Accounts & transactions

Payments

Collections

Payroll

Approvals

Webhooks & events

OAuth

Get the next pay run at a glance

Authorizations

Headers

Response