PayRunPayment

Name / Description Type / Format Example
type string "Employee" "Hmrc" "PensionProvider"
payee Item {Item}
date
The date the payment is to be made
string date "2021-10-23"
method string "Cash" "Cheque" "Credit" "DirectDebit"
amount
The amount to pay
number double 0.0
reference
The period the payment is for
string "string"
bankDetails BankDetails {BankDetails}
bacsHash
if paying by Credit and you've enabled BacsHash then this will contain the BacsHash included on the FPS
string "string"
bacsSubReference
if paying by Credit and you've enabled BacsHash then this will contain the BacsSubReference included on the FPS
string "string"
{
  "type": "Employee",
  "payee": {
    "id": "string",
    "name": "string",
    "metadata": {},
    "url": "string"
  },
  "date": "2021-10-23",
  "method": "Cash",
  "amount": 0.0,
  "reference": "string",
  "bankDetails": {
    "bankName": "string",
    "bankBranch": "string",
    "bankReference": "string",
    "accountName": "string",
    "accountNumber": "string",
    "sortCode": "string",
    "note": "string"
  },
  "bacsHash": "string",
  "bacsSubReference": "string"
}
Consumed by Operations

- none -

Returned by Operations

- none -