Pay out an approved run now

curl --request POST \
  --url https://api.panoflow.io/v1/payroll/runs/{run_id}/execute \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-Step-Up-Token: <x-step-up-token>'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'X-Step-Up-Token': '<x-step-up-token>',
    Authorization: 'Bearer <token>'
  }
};

fetch('https://api.panoflow.io/v1/payroll/runs/{run_id}/execute', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.panoflow.io/v1/payroll/runs/{run_id}/execute"

headers = {
    "Idempotency-Key": "<idempotency-key>",
    "X-Step-Up-Token": "<x-step-up-token>",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, headers=headers)

print(response.text)

{
  "id": "run_01JK31CZT5GEVQEZ2NTQSC0J4D",
  "object": "pay_run",
  "created_at": "2026-10-28T12:30:00Z",
  "updated_at": "2026-11-27T08:00:40Z",
  "period": "2026-11",
  "name": "November 2026 pay run",
  "pay_date": "2026-11-27",
  "status": "processing",
  "pay_timing": "pay_day",
  "narration": "Salary Nov 2026",
  "source_account": {
    "id": "acc_01JV4DK79Q9G8XE6SZAEAVSNTC",
    "name": "Naira · Payroll",
    "account_number": "8012457746"
  },
  "totals": {
    "people_count": 11,
    "gross": {
      "amount": 295000000,
      "currency": "NGN"
    },
    "bonuses": {
      "amount": 5000000,
      "currency": "NGN"
    },
    "deductions": {
      "amount": 60255000,
      "currency": "NGN"
    },
    "net": {
      "amount": 234745000,
      "currency": "NGN"
    },
    "paid": {
      "amount": 27300000,
      "currency": "NGN"
    },
    "failed_count": 1
  },
  "requires_second_approval": true,
  "approved_by": [
    {
      "type": "user",
      "id": "usr_01JNTH82F7AG3BCKKDJWBHP1G2",
      "name": "Adaeze Okafor"
    },
    {
      "type": "user",
      "id": "usr_01J01CYFW6VZSKDENC8SP3804G",
      "name": "Tolu Martins"
    }
  ],
  "executed_at": "2026-11-27T08:00:00Z",
  "lines": [
    {
      "id": "pln_01J33BSWM75ANCBX2KRQNWA605",
      "object": "pay_run_line",
      "response_code": "00",
      "response_message": "Approved or completed successfully",
      "person": {
        "id": "ppl_01J9RMZ9J92V81E5128Q6RW31F",
        "name": "Musa Ibrahim",
        "role": "Fleet supervisor",
        "bank_name": "Access Bank",
        "account_number_last4": "1045"
      },
      "included": true,
      "status": "completed",
      "earnings": [],
      "bonus": {
        "amount": 5000000,
        "currency": "NGN"
      },
      "gross": {
        "amount": 36000000,
        "currency": "NGN"
      },
      "deductions": [],
      "deduction_total": {
        "amount": 8700000,
        "currency": "NGN"
      },
      "net": {
        "amount": 27300000,
        "currency": "NGN"
      },
      "transfer_id": "trf_01JT42YMAV64G5D6TZWBE8TXF7",
      "payslip_id": "pys_01J6YXRGVZ8ZB0K9FMMXQ5CSAF",
      "completed_at": "2026-11-27T08:00:31Z"
    },
    {
      "id": "pln_01JH5PT7DRPKV53YCQWCMQY1TF",
      "object": "pay_run_line",
      "response_code": "07",
      "response_message": "Invalid account",
      "person": {
        "id": "ppl_01JZG0X454YG4GFDEXZR4YJ2C4",
        "name": "Emeka Obi",
        "role": "Dispatch rider",
        "bank_name": "Moniepoint MFB",
        "account_number_last4": "3390"
      },
      "included": true,
      "status": "failed",
      "status_reason": "The receiving bank rejected the payment. The money is back in Naira · Payroll.",
      "earnings": [],
      "bonus": {
        "amount": 0,
        "currency": "NGN"
      },
      "gross": {
        "amount": 15000000,
        "currency": "NGN"
      },
      "deductions": [],
      "deduction_total": {
        "amount": 1950000,
        "currency": "NGN"
      },
      "net": {
        "amount": 13050000,
        "currency": "NGN"
      },
      "transfer_id": "trf_01JX260YEWQ2JE73CC4QBWG06P"
    }
  ]
}

{
  "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": "51",
    "type": "invalid_request",
    "code": "payroll_short_funds",
    "message": "Naira · Payroll is short by ₦640,000.00 for this run. Move it from Naira · Main before you pay.",
    "request_id": "req_01JJJHHQGGCWFBFF9JCM4SGFE6",
    "doc_url": "https://docs.panoflow.io/errors/payroll_short_funds",
    "details": {
      "short_by": {
        "amount": 64000000,
        "currency": "NGN"
      },
      "available": {
        "amount": 170745000,
        "currency": "NGN"
      },
      "net": {
        "amount": 234745000,
        "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": {}
  }
}

Pay runs

Pay out an approved run now

Starts paying a scheduled run immediately (on pay day when automatic pay is off, or before pay day). Needs Idempotency-Key and X-Step-Up-Token.

Payroll checks that the source account’s available balance covers total net pay, then asks Payments for one hold per included line and then one NIP payout per line (transfer_id on each line). If any hold is rejected, holds already placed for this run are released and the call fails with 422 payroll_short_funds; nothing is paid.

The run moves to processing (lines processing, response_code 09). Each line then completes (00) or fails with the bank’s NIP code; the money for a failed line returns to the source account. The run ends completed when every line is completed, completed with status_reason: some_lines_failed when some failed, or failed when all failed. Payslips are issued for completed lines and emailed when email_payslips is on. Emits payrun.completed.

Error codes: invalid_api_key, parameter_invalid, resource_not_found, scope_missing, step_up_required, csrf_token_invalid, idempotency_key_reused, payroll_short_funds, bank_unavailable, business_frozen, business_not_approved, rate_limited.

POST

payroll

runs

{run_id}

execute

Pay out an approved run now

curl --request POST \
  --url https://api.panoflow.io/v1/payroll/runs/{run_id}/execute \
  --header 'Authorization: Bearer <token>' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-Step-Up-Token: <x-step-up-token>'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'X-Step-Up-Token': '<x-step-up-token>',
    Authorization: 'Bearer <token>'
  }
};

fetch('https://api.panoflow.io/v1/payroll/runs/{run_id}/execute', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.panoflow.io/v1/payroll/runs/{run_id}/execute"

headers = {
    "Idempotency-Key": "<idempotency-key>",
    "X-Step-Up-Token": "<x-step-up-token>",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, headers=headers)

print(response.text)

{
  "id": "run_01JK31CZT5GEVQEZ2NTQSC0J4D",
  "object": "pay_run",
  "created_at": "2026-10-28T12:30:00Z",
  "updated_at": "2026-11-27T08:00:40Z",
  "period": "2026-11",
  "name": "November 2026 pay run",
  "pay_date": "2026-11-27",
  "status": "processing",
  "pay_timing": "pay_day",
  "narration": "Salary Nov 2026",
  "source_account": {
    "id": "acc_01JV4DK79Q9G8XE6SZAEAVSNTC",
    "name": "Naira · Payroll",
    "account_number": "8012457746"
  },
  "totals": {
    "people_count": 11,
    "gross": {
      "amount": 295000000,
      "currency": "NGN"
    },
    "bonuses": {
      "amount": 5000000,
      "currency": "NGN"
    },
    "deductions": {
      "amount": 60255000,
      "currency": "NGN"
    },
    "net": {
      "amount": 234745000,
      "currency": "NGN"
    },
    "paid": {
      "amount": 27300000,
      "currency": "NGN"
    },
    "failed_count": 1
  },
  "requires_second_approval": true,
  "approved_by": [
    {
      "type": "user",
      "id": "usr_01JNTH82F7AG3BCKKDJWBHP1G2",
      "name": "Adaeze Okafor"
    },
    {
      "type": "user",
      "id": "usr_01J01CYFW6VZSKDENC8SP3804G",
      "name": "Tolu Martins"
    }
  ],
  "executed_at": "2026-11-27T08:00:00Z",
  "lines": [
    {
      "id": "pln_01J33BSWM75ANCBX2KRQNWA605",
      "object": "pay_run_line",
      "response_code": "00",
      "response_message": "Approved or completed successfully",
      "person": {
        "id": "ppl_01J9RMZ9J92V81E5128Q6RW31F",
        "name": "Musa Ibrahim",
        "role": "Fleet supervisor",
        "bank_name": "Access Bank",
        "account_number_last4": "1045"
      },
      "included": true,
      "status": "completed",
      "earnings": [],
      "bonus": {
        "amount": 5000000,
        "currency": "NGN"
      },
      "gross": {
        "amount": 36000000,
        "currency": "NGN"
      },
      "deductions": [],
      "deduction_total": {
        "amount": 8700000,
        "currency": "NGN"
      },
      "net": {
        "amount": 27300000,
        "currency": "NGN"
      },
      "transfer_id": "trf_01JT42YMAV64G5D6TZWBE8TXF7",
      "payslip_id": "pys_01J6YXRGVZ8ZB0K9FMMXQ5CSAF",
      "completed_at": "2026-11-27T08:00:31Z"
    },
    {
      "id": "pln_01JH5PT7DRPKV53YCQWCMQY1TF",
      "object": "pay_run_line",
      "response_code": "07",
      "response_message": "Invalid account",
      "person": {
        "id": "ppl_01JZG0X454YG4GFDEXZR4YJ2C4",
        "name": "Emeka Obi",
        "role": "Dispatch rider",
        "bank_name": "Moniepoint MFB",
        "account_number_last4": "3390"
      },
      "included": true,
      "status": "failed",
      "status_reason": "The receiving bank rejected the payment. The money is back in Naira · Payroll.",
      "earnings": [],
      "bonus": {
        "amount": 0,
        "currency": "NGN"
      },
      "gross": {
        "amount": 15000000,
        "currency": "NGN"
      },
      "deductions": [],
      "deduction_total": {
        "amount": 1950000,
        "currency": "NGN"
      },
      "net": {
        "amount": 13050000,
        "currency": "NGN"
      },
      "transfer_id": "trf_01JX260YEWQ2JE73CC4QBWG06P"
    }
  ]
}

{
  "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": "51",
    "type": "invalid_request",
    "code": "payroll_short_funds",
    "message": "Naira · Payroll is short by ₦640,000.00 for this run. Move it from Naira · Main before you pay.",
    "request_id": "req_01JJJHHQGGCWFBFF9JCM4SGFE6",
    "doc_url": "https://docs.panoflow.io/errors/payroll_short_funds",
    "details": {
      "short_by": {
        "amount": 64000000,
        "currency": "NGN"
      },
      "available": {
        "amount": 170745000,
        "currency": "NGN"
      },
      "net": {
        "amount": 234745000,
        "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": {}
  }
}

Authorizations

Authorization

string

header

required

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

Headers

Idempotency-Key

string

required

Required on money-moving POSTs. Same key + same body replays the first response; same key + different body returns 409 idempotency_key_reused. Kept 7 days.

Required string length: 1 - 255

X-Step-Up-Token

string

required

Proof of a 2FA step-up within the last 5 minutes (POST /v1/auth/step-up).

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}$

Response

Executing.

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

Pay out an approved run now

Authorizations

Headers

Path Parameters

Response