C. Hoare & Co. File Payments API

openapi: 3.2.0
info:
  title: Payment Initiation File Payments API
  description: OpenAPI for Payment Initiation API Specification
  termsOfService: https://www.openbanking.org.uk/terms
  contact:
    name: Service Desk
    email: ServiceDesk@openbanking.org.uk
  license:
    name: open-licence
    url: https://www.openbanking.org.uk/open-licence
  version: v3.1.0
servers:
- url: https://api.hoaresbank.co.uk/open-banking/v3.1/pisp
  description: Base URL declared by the provider in apis.yml (roadmap#122).
tags:
- name: File Payments
paths:
  /file-payment-consents:
    post:
      tags:
      - File Payments
      summary: Create File Payment Consents
      operationId: CreateFilePaymentConsents
      parameters:
      - $ref: '#/components/parameters/x-fapi-financial-id-Param'
      - $ref: '#/components/parameters/x-fapi-customer-last-logged-time-Param'
      - $ref: '#/components/parameters/x-fapi-customer-ip-address-Param'
      - $ref: '#/components/parameters/x-fapi-interaction-id-Param'
      - $ref: '#/components/parameters/AuthorizationParam'
      - $ref: '#/components/parameters/x-idempotency-key'
      - $ref: '#/components/parameters/x-jws-signature-Param'
      - $ref: '#/components/parameters/x-customer-user-agent-Param'
      responses:
        '201':
          $ref: '#/components/responses/201FilePaymentConsentsCreated'
        '400':
          $ref: '#/components/responses/400ErrorResponse'
        '401':
          $ref: '#/components/responses/401ErrorResponse'
        '403':
          $ref: '#/components/responses/403ErrorResponse'
        '404':
          $ref: '#/components/responses/404ErrorResponse'
        '405':
          $ref: '#/components/responses/405ErrorResponse'
        '406':
          $ref: '#/components/responses/406ErrorResponse'
        '415':
          $ref: '#/components/responses/415ErrorResponse'
        '429':
          $ref: '#/components/responses/429ErrorResponse'
        '500':
          $ref: '#/components/responses/500ErrorResponse'
      security:
      - TPPOAuth2Security:
        - payments
      requestBody:
        $ref: '#/components/requestBodies/OBWriteFileConsent2Param'
  /file-payment-consents/{ConsentId}:
    get:
      tags:
      - File Payments
      summary: Get File Payment Consents
      operationId: GetFilePaymentConsentsConsentId
      parameters:
      - $ref: '#/components/parameters/ConsentId'
      - $ref: '#/components/parameters/x-fapi-financial-id-Param'
      - $ref: '#/components/parameters/x-fapi-customer-last-logged-time-Param'
      - $ref: '#/components/parameters/x-fapi-customer-ip-address-Param'
      - $ref: '#/components/parameters/x-fapi-interaction-id-Param'
      - $ref: '#/components/parameters/AuthorizationParam'
      - $ref: '#/components/parameters/x-customer-user-agent-Param'
      responses:
        '200':
          $ref: '#/components/responses/200FilePaymentConsentsConsentIdRead'
        '400':
          $ref: '#/components/responses/400ErrorResponse'
        '401':
          $ref: '#/components/responses/401ErrorResponse'
        '403':
          $ref: '#/components/responses/403ErrorResponse'
        '404':
          $ref: '#/components/responses/404ErrorResponse'
        '405':
          $ref: '#/components/responses/405ErrorResponse'
        '406':
          $ref: '#/components/responses/406ErrorResponse'
        '429':
          $ref: '#/components/responses/429ErrorResponse'
        '500':
          $ref: '#/components/responses/500ErrorResponse'
      security:
      - TPPOAuth2Security:
        - payments
  /file-payment-consents/{ConsentId}/file:
    post:
      tags:
      - File Payments
      summary: Create File Payment Consents
      operationId: CreateFilePaymentConsentsConsentIdFile
      parameters:
      - $ref: '#/components/parameters/ConsentId'
      - $ref: '#/components/parameters/x-fapi-financial-id-Param'
      - $ref: '#/components/parameters/x-fapi-customer-last-logged-time-Param'
      - $ref: '#/components/parameters/x-fapi-customer-ip-address-Param'
      - $ref: '#/components/parameters/x-fapi-interaction-id-Param'
      - $ref: '#/components/parameters/AuthorizationParam'
      - $ref: '#/components/parameters/x-idempotency-key'
      - $ref: '#/components/parameters/x-jws-signature-Param'
      - $ref: '#/components/parameters/x-customer-user-agent-Param'
      responses:
        '200':
          $ref: '#/components/responses/200FilePaymentConsentsConsentIdFileCreated'
        '400':
          $ref: '#/components/responses/400ErrorResponse'
        '401':
          $ref: '#/components/responses/401ErrorResponse'
        '403':
          $ref: '#/components/responses/403ErrorResponse'
        '404':
          $ref: '#/components/responses/404ErrorResponse'
        '405':
          $ref: '#/components/responses/405ErrorResponse'
        '406':
          $ref: '#/components/responses/406ErrorResponse'
        '415':
          $ref: '#/components/responses/415ErrorResponse'
        '429':
          $ref: '#/components/responses/429ErrorResponse'
        '500':
          $ref: '#/components/responses/500ErrorResponse'
      security:
      - TPPOAuth2Security:
        - payments
      requestBody:
        $ref: '#/components/requestBodies/FileParam'
    get:
      tags:
      - File Payments
      summary: Get File Payment Consents
      operationId: GetFilePaymentConsentsConsentIdFile
      parameters:
      - $ref: '#/components/parameters/ConsentId'
      - $ref: '#/components/parameters/x-fapi-financial-id-Param'
      - $ref: '#/components/parameters/x-fapi-customer-last-logged-time-Param'
      - $ref: '#/components/parameters/x-fapi-customer-ip-address-Param'
      - $ref: '#/components/parameters/x-fapi-interaction-id-Param'
      - $ref: '#/components/parameters/AuthorizationParam'
      - $ref: '#/components/parameters/x-customer-user-agent-Param'
      responses:
        '200':
          $ref: '#/components/responses/200FilePaymentConsentsConsentIdFileRead'
        '400':
          $ref: '#/components/responses/400ErrorResponse'
        '401':
          $ref: '#/components/responses/401ErrorResponse'
        '403':
          $ref: '#/components/responses/403ErrorResponse'
        '404':
          $ref: '#/components/responses/404ErrorResponse'
        '405':
          $ref: '#/components/responses/405ErrorResponse'
        '406':
          $ref: '#/components/responses/406ErrorResponse'
        '429':
          $ref: '#/components/responses/429ErrorResponse'
        '500':
          $ref: '#/components/responses/500ErrorResponse'
      security:
      - TPPOAuth2Security:
        - payments
  /file-payments:
    post:
      tags:
      - File Payments
      summary: Create File Payments
      operationId: CreateFilePayments
      parameters:
      - $ref: '#/components/parameters/x-fapi-financial-id-Param'
      - $ref: '#/components/parameters/x-fapi-customer-last-logged-time-Param'
      - $ref: '#/components/parameters/x-fapi-customer-ip-address-Param'
      - $ref: '#/components/parameters/x-fapi-interaction-id-Param'
      - $ref: '#/components/parameters/AuthorizationParam'
      - $ref: '#/components/parameters/x-idempotency-key'
      - $ref: '#/components/parameters/x-jws-signature-Param'
      - $ref: '#/components/parameters/x-customer-user-agent-Param'
      responses:
        '201':
          $ref: '#/components/responses/201FilePaymentsCreated'
        '400':
          $ref: '#/components/responses/400ErrorResponse'
        '401':
          $ref: '#/components/responses/401ErrorResponse'
        '403':
          $ref: '#/components/responses/403ErrorResponse'
        '404':
          $ref: '#/components/responses/404ErrorResponse'
        '405':
          $ref: '#/components/responses/405ErrorResponse'
        '406':
          $ref: '#/components/responses/406ErrorResponse'
        '415':
          $ref: '#/components/responses/415ErrorResponse'
        '429':
          $ref: '#/components/responses/429ErrorResponse'
        '500':
          $ref: '#/components/responses/500ErrorResponse'
      security:
      - PSUOAuth2Security:
        - payments
      requestBody:
        $ref: '#/components/requestBodies/OBWriteFile2Param'
  /file-payments/{FilePaymentId}:
    get:
      tags:
      - File Payments
      summary: Get File Payments
      operationId: GetFilePaymentsFilePaymentId
      parameters:
      - $ref: '#/components/parameters/FilePaymentId'
      - $ref: '#/components/parameters/x-fapi-financial-id-Param'
      - $ref: '#/components/parameters/x-fapi-customer-last-logged-time-Param'
      - $ref: '#/components/parameters/x-fapi-customer-ip-address-Param'
      - $ref: '#/components/parameters/x-fapi-interaction-id-Param'
      - $ref: '#/components/parameters/AuthorizationParam'
      - $ref: '#/components/parameters/x-customer-user-agent-Param'
      responses:
        '200':
          $ref: '#/components/responses/200FilePaymentsFilePaymentIdRead'
        '400':
          $ref: '#/components/responses/400ErrorResponse'
        '401':
          $ref: '#/components/responses/401ErrorResponse'
        '403':
          $ref: '#/components/responses/403ErrorResponse'
        '404':
          $ref: '#/components/responses/404ErrorResponse'
        '405':
          $ref: '#/components/responses/405ErrorResponse'
        '406':
          $ref: '#/components/responses/406ErrorResponse'
        '429':
          $ref: '#/components/responses/429ErrorResponse'
        '500':
          $ref: '#/components/responses/500ErrorResponse'
      security:
      - TPPOAuth2Security:
        - payments
  /file-payments/{FilePaymentId}/report-file:
    get:
      tags:
      - File Payments
      summary: Get File Payments
      operationId: GetFilePaymentsFilePaymentIdReportFile
      parameters:
      - $ref: '#/components/parameters/FilePaymentId'
      - $ref: '#/components/parameters/x-fapi-financial-id-Param'
      - $ref: '#/components/parameters/x-fapi-customer-last-logged-time-Param'
      - $ref: '#/components/parameters/x-fapi-customer-ip-address-Param'
      - $ref: '#/components/parameters/x-fapi-interaction-id-Param'
      - $ref: '#/components/parameters/AuthorizationParam'
      - $ref: '#/components/parameters/x-customer-user-agent-Param'
      responses:
        '200':
          $ref: '#/components/responses/200FilePaymentsFilePaymentIdReportFileRead'
        '400':
          $ref: '#/components/responses/400ErrorResponse'
        '401':
          $ref: '#/components/responses/401ErrorResponse'
        '403':
          $ref: '#/components/responses/403ErrorResponse'
        '404':
          $ref: '#/components/responses/404ErrorResponse'
        '405':
          $ref: '#/components/responses/405ErrorResponse'
        '406':
          $ref: '#/components/responses/406ErrorResponse'
        '429':
          $ref: '#/components/responses/429ErrorResponse'
        '500':
          $ref: '#/components/responses/500ErrorResponse'
      security:
      - TPPOAuth2Security:
        - payments
components:
  responses:
    200FilePaymentConsentsConsentIdRead:
      description: File Payment Consents Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          schema:
            type: string
        x-jws-signature:
          description: Header containing a detached JWS signature of the body of the payload.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteFileConsentResponse2'
    201FilePaymentConsentsCreated:
      description: File Payment Consents Created
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          schema:
            type: string
        x-jws-signature:
          description: Header containing a detached JWS signature of the body of the payload.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteFileConsentResponse2'
    200FilePaymentConsentsConsentIdFileRead:
      description: File Payment Consents Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          schema:
            type: string
        x-jws-signature:
          description: Header containing a detached JWS signature of the body of the payload.
          schema:
            type: string
      content:
        '*/*':
          schema:
            type: string
            format: binary
    201FilePaymentsCreated:
      description: File Payments Created
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          schema:
            type: string
        x-jws-signature:
          description: Header containing a detached JWS signature of the body of the payload.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteFileResponse2'
    401ErrorResponse:
      description: Unauthorized
    415ErrorResponse:
      description: Unsupported Media Type
    429ErrorResponse:
      description: Too Many Requests
      headers:
        Retry-After:
          description: Number in seconds to wait
          schema:
            type: integer
    500ErrorResponse:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
    405ErrorResponse:
      description: Method Not Allowed
    200FilePaymentConsentsConsentIdFileCreated:
      description: File Payment Consents Created
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          schema:
            type: string
    400ErrorResponse:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
    200FilePaymentsFilePaymentIdRead:
      description: File Payments Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          schema:
            type: string
        x-jws-signature:
          description: Header containing a detached JWS signature of the body of the payload.
          schema:
            type: string
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteFileResponse2'
    200FilePaymentsFilePaymentIdReportFileRead:
      description: File Payments Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          schema:
            type: string
        x-jws-signature:
          description: Header containing a detached JWS signature of the body of the payload.
          schema:
            type: string
      content:
        '*/*':
          schema:
            type: string
            format: binary
    406ErrorResponse:
      description: Not Acceptable
    404ErrorResponse:
      description: Not found
    403ErrorResponse:
      description: Forbidden
  schemas:
    OBCharge2:
      description: Set of elements used to provide details of a charge for the payment initiation.
      type: object
      properties:
        ChargeBearer:
          $ref: '#/components/schemas/OBChargeBearerType1Code'
        Type:
          $ref: '#/components/schemas/OBExternalPaymentChargeType1Code'
        Amount:
          type: object
          properties:
            Amount:
              $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType'
            Currency:
              type: string
              pattern: ^[A-Z]{3,3}$
          required:
          - Amount
          - Currency
          additionalProperties: false
          description: Amount of money associated with the charge type.
      required:
      - ChargeBearer
      - Type
      - Amount
      additionalProperties: false
    Links:
      type: object
      description: Links relevant to the payload
      properties:
        Self:
          type: string
          format: uri
        First:
          type: string
          format: uri
        Prev:
          type: string
          format: uri
        Next:
          type: string
          format: uri
        Last:
          type: string
          format: uri
      additionalProperties: false
      required:
      - Self
    OBSupplementaryData1:
      description: Additional information that can not be captured in the structured fields and/or any other specific block.
      type: object
      properties: {}
      additionalProperties: false
    OBExternalPaymentChargeType1Code:
      description: Charge type, in a coded form.
      type: string
      example:
      - UK.OBIE.CHAPSOut
      - UK.OBIE.BalanceTransferOut
      - UK.OBIE.MoneyTransferOut
      minLength: 1
      maxLength: 40
    OBRemittanceInformation1:
      description: Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system.
      type: object
      properties:
        Unstructured:
          description: Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form.
          type: string
          minLength: 1
          maxLength: 140
        Reference:
          description: 'Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.

            Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money.

            If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor''s reference or payment remittance identification should be quoted in the end-to-end transaction identification.

            OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped.'
          type: string
          minLength: 1
          maxLength: 35
      additionalProperties: false
    OBMultiAuthorisation1:
      description: The multiple authorisation flow response from the ASPSP.
      type: object
      properties:
        Status:
          $ref: '#/components/schemas/OBExternalStatus2Code'
        NumberRequired:
          description: Number of authorisations required for payment order (total required at the start of the multi authorisation journey).
          type: integer
          format: int32
        NumberReceived:
          description: Number of authorisations required for payment order (total required at the start of the multi authorisation journey).
          type: integer
          format: int32
        LastUpdateDateTime:
          description: "Last date and time at the authorisation flow was updated.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
          type: string
          format: date-time
        ExpirationDateTime:
          description: "Date and time at which the requested authorisation flow must be completed.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
          type: string
          format: date-time
      required:
      - Status
      additionalProperties: false
    OBFile2:
      description: The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.
      type: object
      properties:
        FileType:
          $ref: '#/components/schemas/OBExternalFileType1Code'
        FileHash:
          description: A base64 encoding of a SHA256 hash of the file to be uploaded.
          type: string
          minLength: 1
          maxLength: 44
        FileReference:
          description: Reference for the file.
          type: string
          minLength: 1
          maxLength: 40
        NumberOfTransactions:
          description: Number of individual transactions contained in the payment information group.
          type: string
          minLength: 1
          maxLength: 15
          pattern: '[0-9]{1,15}'
        ControlSum:
          description: Total of all individual amounts included in the group, irrespective of currencies.
          type: number
        RequestedExecutionDateTime:
          description: "Date at which the initiating party requests the clearing agent to process the payment. \nUsage: This is the date on which the debtor's account is to be debited.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
          type: string
          format: date-time
        LocalInstrument:
          $ref: '#/components/schemas/OBExternalLocalInstrument1Code'
        DebtorAccount:
          $ref: '#/components/schemas/OBCashAccountDebtor4'
        RemittanceInformation:
          $ref: '#/components/schemas/OBRemittanceInformation1'
        SupplementaryData:
          $ref: '#/components/schemas/OBSupplementaryData1'
      required:
      - FileType
      - FileHash
      additionalProperties: false
    Meta:
      title: MetaData
      type: object
      description: Meta Data relevant to the payload
      properties:
        TotalPages:
          type: integer
          format: int32
        FirstAvailableDateTime:
          $ref: '#/components/schemas/ISODateTime'
        LastAvailableDateTime:
          $ref: '#/components/schemas/ISODateTime'
      additionalProperties: false
    OBWriteDataFileConsentResponse2:
      type: object
      properties:
        ConsentId:
          description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.'
          type: string
          minLength: 1
          maxLength: 128
        CreationDateTime:
          description: "Date and time at which the resource was created.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
          type: string
          format: date-time
        Status:
          $ref: '#/components/schemas/OBExternalConsentStatus2Code'
        StatusUpdateDateTime:
          description: "Date and time at which the consent resource status was updated.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
          type: string
          format: date-time
        CutOffDateTime:
          description: "Specified cut-off date and time for the payment consent.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
          type: string
          format: date-time
        Charges:
          items:
            $ref: '#/components/schemas/OBCharge2'
          type: array
          description: Set of elements used to provide details of a charge for the payment initiation.
        Initiation:
          $ref: '#/components/schemas/OBFile2'
        Authorisation:
          $ref: '#/components/schemas/OBAuthorisation1'
      required:
      - ConsentId
      - CreationDateTime
      - Status
      - StatusUpdateDateTime
      - Initiation
      additionalProperties: false
    OBWriteDataFile2:
      type: object
      properties:
        ConsentId:
          description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.'
          type: string
          minLength: 1
          maxLength: 128
        Initiation:
          $ref: '#/components/schemas/OBFile2'
      required:
      - ConsentId
      - Initiation
      additionalProperties: false
    OBWriteFile2:
      type: object
      properties:
        Data:
          $ref: '#/components/schemas/OBWriteDataFile2'
      required:
      - Data
      additionalProperties: false
    OBError1:
      type: object
      properties:
        ErrorCode:
          description: Low level textual error code, e.g., UK.OBIE.Field.Missing
          type: string
          minLength: 1
          maxLength: 128
        Message:
          description: 'A description of the error that occurred. e.g., ''A mandatory field isn''t supplied'' or ''RequestedExecutionDateTime must be in future''

            OBIE doesn''t standardise this field'
          type: string
          minLength: 1
          maxLength: 500
        Path:
          description: Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency
          type: string
          minLength: 1
          maxLength: 500
        Url:
          description: URL to help remediate the problem, or provide more information, or to API Reference, or help etc
          type: string
      required:
      - ErrorCode
      - Message
      additionalProperties: false
      minProperties: 1
    OBWriteFileConsentResponse2:
      type: object
      properties:
        Data:
          $ref: '#/components/schemas/OBWriteDataFileConsentResponse2'
        Links:
          $ref: '#/components/schemas/Links'
        Meta:
          $ref: '#/components/schemas/Meta'
      required:
      - Data
      - Links
      - Meta
      additionalProperties: false
    OBCashAccountDebtor4:
      description: Provides the details to identify the debtor account.
      type: object
      properties:
        SchemeName:
          $ref: '#/components/schemas/OBExternalAccountIdentification4Code'
        Identification:
          description: Identification assigned by an institution to identify an account. This identification is known by the account owner.
          type: string
          minLength: 1
          maxLength: 256
        Name:
          description: 'Name of the account, as assigned by the account servicing institution.

            Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account.'
          type: string
          minLength: 1
          maxLength: 70
        SecondaryIdentification:
          description: "This is secondary identification of the account, as assigned by the account servicing institution. \nThis can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)."
          type: string
          minLength: 1
          maxLength: 34
      required:
      - SchemeName
      - Identification
      additionalProperties: false
    File:
      type: string
      format: binary
    OBErrorResponse1:
      description: An array of detail error codes, and messages, and URLs to documentation to help remediation.
      type: object
      properties:
        Code:
          description: High level textual error code, to help categorize the errors.
          type: string
          minLength: 1
          maxLength: 40
        Id:
          description: A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors.
          type: string
          minLength: 1
          maxLength: 40
        Message:
          description: Brief Error message, e.g., 'There is something wrong with the request parameters provided'
          type: string
          minLength: 1
          maxLength: 500
        Errors:
          items:
            $ref: '#/components/schemas/OBError1'
          type: array
          minItems: 1
      required:
      - Code
      - Message
      - Errors
      additionalProperties: false
    OBWriteDataFileResponse2:
      type: object
      properties:
        FilePaymentId:
          description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the file payment resource.'
          type: string
          minLength: 1
          maxLength: 40
        ConsentId:
          description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.'
          type: string
          minLength: 1
          maxLength: 128
        CreationDateTime:
          description: "Date and time at which the message was created.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
          type: string
          format: date-time
        Status:
          $ref: '#/components/schemas/OBExternalStatus1Code'
        StatusUpdateDateTime:
          description: "Date and time at which the resource status was updated.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
          type: string
          format: date-time
        Charges:
          items:
            $ref: '#/components/schemas/OBCharge2'
          type: array
          description: Set of elements used to provide details of a charge for the payment initiation.
        Initiation:
          $ref: '#/components/schemas/OBFile2'
        MultiAuthorisation:
          $ref: '#/components/schemas/OBMultiAuthorisation1'
      required:
      - FilePaymentId
      - ConsentId
      - CreationDateTime
      - Status
      - StatusUpdateDateTime
      - Initiation
      additionalProperties: false
    OBExternalAuthorisation1Code:
      description: Type of authorisation flow requested.
      type: string
      enum:
      - Any
      - Single
    ISODateTime:
      description: "All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
      type: string
      format: date-time
    OBWriteFileConsent2:
      type: object
      properties:
        Data:
          $ref: '#/components/schemas/OBWriteDataFileConsent2'
      required:
      - Data
      additionalProperties: false
    OBChargeBearerType1Code:
      description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction.
      type: string
      enum:
      - BorneByCreditor
      - BorneByDebtor
      - FollowingServiceLevel
      - Shared
    OBWriteDataFileConsent2:
      type: object
      properties:
        Initiation:
          $ref: '#/components/schemas/OBFile2'
        Authorisation:
          $ref: '#/components/schemas/OBAuthorisation1'
      required:
      - Initiation
      additionalProperties: false
    OBWriteFileResponse2:
      type: object
      properties:
        Data:
          $ref: '#/components/schemas/OBWriteDataFileResponse2'
        Links:
          $ref: '#/components/schemas/Links'
        Meta:
          $ref: '#/components/schemas/Meta'
      required:
      - Data
      - Links
      - Meta
      additionalProperties: false
    OBExternalStatus2Code:
      description: Specifies the status of the authorisation flow in code form.
      type: string
      enum:
      - Authorised
      - AwaitingFurtherAuthorisation
      - Rejected
    OBExternalFileType1Code:
      description: Specifies the payment file type.
      type: string
      example:
      - UK.OBIE.PaymentInitiation.3.1
      - UK.OBIE.pain.001.001.08
      minLength: 1
      maxLength: 40
    OBExternalAccountIdentification4Code:
      description: Name of the identification scheme, in a coded form as published in an external list.
      type: string
      example:
      - UK.OBIE.BBAN
      - UK.OBIE.IBAN
      - UK.OBIE.PAN
      - UK.OBIE.Paym
      - UK.OBIE.SortCodeAccountNumber
      minLength: 1
      maxLength: 40
    OBExternalLocalInstrument1Code:
      description: 'User community specific instrument.

        Usage: This element is used to specify a

# --- truncated at 32 KB (37 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/c-hoare-and-co/refs/heads/main/openapi/c-hoare-and-co-file-payments-api-openapi.yml