Email a payslip to the person

curl --request POST \
  --url https://api.panoflow.io/v1/payroll/payslips/{payslip_id}/email \
  --header 'Authorization: Bearer <token>'

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

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

import requests

url = "https://api.panoflow.io/v1/payroll/payslips/{payslip_id}/email"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

{
  "id": "<string>",
  "object": "payslip",
  "created_at": "2026-10-27T08:41:00Z",
  "run_id": "<string>",
  "period": "<string>",
  "pay_date": "2026-11-07",
  "person": {
    "id": "<string>",
    "name": "<string>",
    "role": "<string>",
    "email": "jsmith@example.com"
  },
  "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"
  },
  "line_id": "<string>",
  "paid_into": {
    "bank_name": "<string>",
    "account_number_last4": "<string>"
  },
  "emailed_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": {}
  }
}

POST

payroll

payslips

{payslip_id}

Email a payslip to the person

curl --request POST \
  --url https://api.panoflow.io/v1/payroll/payslips/{payslip_id}/email \
  --header 'Authorization: Bearer <token>'

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

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

import requests

url = "https://api.panoflow.io/v1/payroll/payslips/{payslip_id}/email"

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

{
  "id": "<string>",
  "object": "payslip",
  "created_at": "2026-10-27T08:41:00Z",
  "run_id": "<string>",
  "period": "<string>",
  "pay_date": "2026-11-07",
  "person": {
    "id": "<string>",
    "name": "<string>",
    "role": "<string>",
    "email": "jsmith@example.com"
  },
  "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"
  },
  "line_id": "<string>",
  "paid_into": {
    "bank_name": "<string>",
    "account_number_last4": "<string>"
  },
  "emailed_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

Idempotency-Key

string

Optional on non-money POSTs; honoured when sent.

Required string length: 1 - 255

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

payslip_id

string

required

Payslip id (pys_…).

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

Response

Email queued.

A payslip (pys_…), issued when a line completes.

string

required

pys_…

object

string

required

Always payslip.

Allowed value: "payslip"

created_at

string<date-time>

required

RFC 3339, UTC.

Example:

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

run_id

string

required

run_…

period

string

required

Pay month.

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

pay_date

string<date>

required

Calendar date, interpreted in Africa/Lagos.

Example:

"2026-11-07"

person

object

required

Snapshot at issue.

Show child attributes

earnings

object[]

required

Pay items.

Show child attributes

bonus

object

required

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

Show child attributes

gross

object

required

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

Show child attributes

deductions

object[]

required

Deductions.

Show child attributes

deduction_total

object

required

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

Show child attributes

net

object

required

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

Show child attributes

line_id

string

pln_…

paid_into

object

Where net pay went.

Show child attributes

emailed_at

string<date-time>

RFC 3339, UTC.

Example:

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

Accounts & transactions

Payments

Collections

Payroll

Approvals

Webhooks & events

OAuth

Email a payslip to the person

Authorizations

Headers

Path Parameters

Response