BankPaymentInstruction

Name / Description Type / Format Example
originator BankDetails {BankDetails}
bankPayments PayRunPayment[] {PayRunPayment}
status string "Queued" "Sent" "Failed" "Processing"
statusMessage
A message to elaborate on the Status
string "string"
link
If available, a link to the payments in an ExternalDataProvider
string "string"
serviceUserNumber
Service user number to be used while sending payment instruction
string "string"
bureauNumber
Bureau number to be used if available while sending payment instruction
string "string"
allowsMultiDate
Allows multiple payment dates in the file
boolean true
{
  "originator": {
    "bankName": "string",
    "bankBranch": "string",
    "bankReference": "string",
    "accountName": "string",
    "accountNumber": "string",
    "sortCode": "string",
    "note": "string",
    "buildingSocietyRollNumber": "string"
  },
  "bankPayments": [
    {
      "type": "Employee",
      "payee": {
        "id": "string",
        "name": "string",
        "metadata": {},
        "url": "string"
      },
      "date": "2024-07-13",
      "method": "Cash",
      "amount": 0.0,
      "reference": "string",
      "employerPaymentReference": "string",
      "bankDetails": {
        "bankName": "string",
        "bankBranch": "string",
        "bankReference": "string",
        "accountName": "string",
        "accountNumber": "string",
        "sortCode": "string",
        "note": "string",
        "buildingSocietyRollNumber": "string"
      },
      "bacsHash": "string",
      "bacsSubReference": "string"
    }
  ],
  "status": "Queued",
  "statusMessage": "string",
  "link": "string",
  "serviceUserNumber": "string",
  "bureauNumber": "string",
  "allowsMultiDate": true
}
Consumed by Operations

- none -

Returned by Operations
Post Payments