CashPulse
員工入口

僱主 API

Payroll API 的每一條路徑。

僱主系統提供這些介面。CashPulse 只同步可提取額度、幣種和出糧日。底薪、工時和糧單留在僱主那邊。

驗證

每個請求都帶上合作核准後簽發的金鑰。下面是介面格式。

POST

核對員工

/v1/employees/verify

請求

{
  "inviteCode": "••••",
  "employeeRef": "••••"
}

回應

{
  "employerName": "••••",
  "employeeRef": "••••",
  "active": true
}
GET

可提取額度

/v1/employees/{employeeRef}/wages

請求

—

回應

[
  {
    "employeeRef": "••••",
    "asset": "HKD",
    "withdrawable": "••••",
    "cycleEnd": "••••"
  }
]
GET

出糧日

/v1/employees/{employeeRef}/pay-schedule

請求

—

回應

{
  "employerName": "••••",
  "payday": "••••",
  "cycleStart": "••••",
  "cycleEnd": "••••"
}
POST

記錄提取

/v1/advances

請求

{
  "employeeRef": "••••",
  "asset": "HKD",
  "amount": "••••",
  "fee": "••••"
}

回應

{
  "id": "••••",
  "asset": "HKD",
  "amount": "••••",
  "fee": "••••",
  "status": "accepted"
}
POST

扣回或提前還款

/v1/deductions

請求

{
  "employeeRef": "••••",
  "advanceId": "••••",
  "asset": "HKD",
  "amount": "••••"
}

回應

{
  "ok": true
}
GET

結清狀態

/v1/employees/{employeeRef}/settlement

請求

—

回應

{
  "employerName": "••••",
  "payday": "••••",
  "state": "reserved",
  "outstanding": [
    { "asset": "HKD", "amount": "••••" }
  ]
}
POST

出糧 webhook

/employer-webhook

請求

{
  "type": "payday",
  "inviteCode": "••••",
  "employeeRef": "••••",
  "asset": "HKD",
  "amount": "••••",
  "cycleEnd": "••••"
}

回應

{
  "ok": true
}
  • POST /v1/employees/verify — 邀請碼與員工編號。未知或已停用的員工不會通過核對。
  • GET /v1/employees/{employeeRef}/wages — 只回可提取金額、幣種和結算日。不要傳底薪或糧單。
  • GET /v1/employees/{employeeRef}/pay-schedule — 出糧日和週期。
  • POST /v1/advances — 記錄提取。手續費 0.8%，上限為 HK$20 等值。
  • POST /v1/deductions — 出糧扣回或員工提前還款。
  • GET /v1/employees/{employeeRef}/settlement — 結清狀態：已排程、已預留或已結清，以及未還金額。
  • POST /employer-webhook — 僱主呼叫 CashPulse。type 為 payday 或 repayment，用來推送額度或記錄扣回。
申請合作