| Name / Description | Type / Format | Example | |
|---|---|---|---|
type
|
string
|
"Employee"
"Hmrc"
"PensionProvider"
"Aeo"
"Deduction"
|
|
payee
|
Item
|
{Item}
|
|
date
The date the payment is to be made
|
string
date
|
"2025-10-28"
|
|
method
|
string
|
"Cash"
"Cheque"
"Credit"
"DirectDebit"
|
|
amount
The amount to pay
|
number
double
|
0.0
|
|
reference
The period the payment is for
|
string
|
"string"
|
|
employerPaymentReference
The employer's payment reference, formatted as per the employer settings
|
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"
|
|
isBankDetailValid
for checking if bank details are valid
|
boolean
|
true
|
{
"uniqueId": "string",
"header": "string",
"content": "string",
"useColumnHeaders": true
}
- none -
- none -