Guides

Name / Description	Type / Format	Example
`type` The content-type, this would usually be the same as the accept header you provided when you requested the report	`string`	`"string"`
`content` This could contain a link to a PDF file, HTML content or other content, depending on the Type value.	`string`	`"string"`
`model`	`BankPaymentInstruction`	`{BankPaymentInstruction}`
`stream` byte array	`string` byte	`"string"`

JSON Example

{
  "type": "string",
  "content": "string",
  "model": {
    "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-12-22",
        "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",
        "isBankDetailValid": true
      }
    ],
    "status": "Queued",
    "statusMessage": "string",
    "link": "string",
    "serviceUserNumber": "string",
    "bureauNumber": "string",
    "allowsMultiDate": true
  },
  "stream": "string"
}

References

Contained in Models

- none -

Consumed by Operations

- none -

Returned by Operations
HMRC Bank Payment
Bank Payment Instructions