BankPaymentInstruction

Name / Description Type / Format Example
originator BankDetails {BankDetails}
bankPayments PayRunPayment[] {PayRunPayment}
status
The status of the task for posting these payments to an ExternalDataProvider
string "Queued" "Sent" "Failed" "Processing"
statusMessage
A message to elaborate on the Status
string "string"
{
  "originator": {
    "bankName": "string",
    "bankBranch": "string",
    "bankReference": "string",
    "accountName": "string",
    "accountNumber": "string",
    "sortCode": "string",
    "note": "string"
  },
  "bankPayments": [
    {
      "type": "Employee",
      "payee": {
        "id": "string",
        "name": "string",
        "metadata": {},
        "url": "string"
      },
      "date": "2020-01-19T17:23:28",
      "method": "Cash",
      "amount": 0.0,
      "reference": "string",
      "bankDetails": {
        "bankName": "string",
        "bankBranch": "string",
        "bankReference": "string",
        "accountName": "string",
        "accountNumber": "string",
        "sortCode": "string",
        "note": "string"
      },
      "bacsHash": "string"
    }
  ],
  "status": "Queued",
  "statusMessage": "string"
}
Consumed by Operations

- none -

Returned by Operations
Post Payments