Approve a pay run (2FA)

curl --request POST \
  --url https://api.panoflow.io/v1/payroll/runs/{run_id}/approve \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-Step-Up-Token: <x-step-up-token>' \
  --data '
{
  "pay_timing": "pay_day"
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'X-Step-Up-Token': '<x-step-up-token>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({pay_timing: 'pay_day'})
};

fetch('https://api.panoflow.io/v1/payroll/runs/{run_id}/approve', 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}/approve"

payload = { "pay_timing": "pay_day" }
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "X-Step-Up-Token": "<x-step-up-token>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "id": "run_01JK31CZT5GEVQEZ2NTQSC0J4D",
  "object": "pay_run",
  "created_at": "2026-10-28T12:30:00Z",
  "updated_at": "2026-10-28T12:40:00Z",
  "period": "2026-11",
  "name": "November 2026 pay run",
  "pay_date": "2026-11-27",
  "approve_by": "2026-11-26T15:00:00Z",
  "status": "pending_approval",
  "status_reason": "awaiting_second_approval",
  "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"
    }
  },
  "funding": {
    "available": {
      "amount": 354014000,
      "currency": "NGN"
    },
    "covered": true
  },
  "requires_second_approval": true,
  "second_approval_threshold": {
    "amount": 200000000,
    "currency": "NGN"
  },
  "approval": {
    "id": "apr_01JS2R2X43GC4NQHN2GMHK041E",
    "status": "pending",
    "approver_name": "Tolu Martins"
  },
  "approved_by": [
    {
      "type": "user",
      "id": "usr_01JNTH82F7AG3BCKKDJWBHP1G2",
      "name": "Adaeze Okafor"
    }
  ],
  "prepared_by": {
    "type": "user",
    "id": "usr_01JNTH82F7AG3BCKKDJWBHP1G2",
    "name": "Adaeze Okafor"
  }
}

{
  "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": "57",
    "type": "conflict",
    "code": "self_approval_not_allowed",
    "message": "You sent this run for approval, so someone else has to approve it.",
    "request_id": "req_01JJJHHQGGCWFBFF9JCM4SGFE6"
  }
}

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

Pay runs

Approve a pay run (2FA)

“Pay N people · ₦…” on the review screen, after the 2FA dialog. Always needs X-Step-Up-Token and an Idempotency-Key.

First approval (maker), from draft:

Fails with 422 payroll_short_funds (details.short_by, details.available) if the source account’s available balance cannot cover net pay. Nothing changes; top up and retry.
If net pay is over second_approval_threshold, the run moves to pending_approval (status_reason: awaiting_second_approval) and an approval (kind: pay_run) is created for the second approver, who is notified. Returns 200.
Otherwise it is approved: with pay_timing: pay_day it moves to scheduled (200); with now it starts executing at once (202, as executePayRun).

Second approval (checker), from pending_approval: a different user calling this endpoint decides the pending approval (same effect as POST /v1/approvals/{approval_id}/approve). The requester can never approve their own run: 409 self_approval_not_allowed. Funds are checked again. Then scheduled (200) or, for now, executing (202). Rejection goes through POST /v1/approvals/{approval_id}/reject and moves the run to rejected.

With auto_pay_when_approved off in settings, a scheduled run waits on pay day for executePayRun.

Error codes: invalid_api_key, parameter_invalid, parameter_missing, resource_not_found, scope_missing, step_up_required, csrf_token_invalid, idempotency_key_reused, self_approval_not_allowed, invalid_state, already_decided, payroll_short_funds, rate_limited.

POST

payroll

runs

{run_id}

approve

Approve a pay run (2FA)

curl --request POST \
  --url https://api.panoflow.io/v1/payroll/runs/{run_id}/approve \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --header 'X-Step-Up-Token: <x-step-up-token>' \
  --data '
{
  "pay_timing": "pay_day"
}
'

const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    'X-Step-Up-Token': '<x-step-up-token>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({pay_timing: 'pay_day'})
};

fetch('https://api.panoflow.io/v1/payroll/runs/{run_id}/approve', 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}/approve"

payload = { "pay_timing": "pay_day" }
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "X-Step-Up-Token": "<x-step-up-token>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

{
  "id": "run_01JK31CZT5GEVQEZ2NTQSC0J4D",
  "object": "pay_run",
  "created_at": "2026-10-28T12:30:00Z",
  "updated_at": "2026-10-28T12:40:00Z",
  "period": "2026-11",
  "name": "November 2026 pay run",
  "pay_date": "2026-11-27",
  "approve_by": "2026-11-26T15:00:00Z",
  "status": "pending_approval",
  "status_reason": "awaiting_second_approval",
  "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"
    }
  },
  "funding": {
    "available": {
      "amount": 354014000,
      "currency": "NGN"
    },
    "covered": true
  },
  "requires_second_approval": true,
  "second_approval_threshold": {
    "amount": 200000000,
    "currency": "NGN"
  },
  "approval": {
    "id": "apr_01JS2R2X43GC4NQHN2GMHK041E",
    "status": "pending",
    "approver_name": "Tolu Martins"
  },
  "approved_by": [
    {
      "type": "user",
      "id": "usr_01JNTH82F7AG3BCKKDJWBHP1G2",
      "name": "Adaeze Okafor"
    }
  ],
  "prepared_by": {
    "type": "user",
    "id": "usr_01JNTH82F7AG3BCKKDJWBHP1G2",
    "name": "Adaeze Okafor"
  }
}

{
  "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": "57",
    "type": "conflict",
    "code": "self_approval_not_allowed",
    "message": "You sent this run for approval, so someone else has to approve it.",
    "request_id": "req_01JJJHHQGGCWFBFF9JCM4SGFE6"
  }
}

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

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

Body

application/json

pay_timing

enum<string>

Maker only. Overrides the run's pay_timing.

Available options:

pay_day,

now

note

string

Note on the approval (reason for the maker, decision note for the checker).

Maximum string length: 500

Response

Approved; now pending_approval or scheduled.

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

Approve a pay run (2FA)

Authorizations

Headers

Path Parameters

Body

Response