C. Hoare & Co.

C. Hoare & Co. Payment Initiation API

OBIE Read/Write Payment Initiation (PIS) API — lets onboarded, consented PISP third-party providers initiate domestic and scheduled payments and standing orders and retrieve payment/consent status on behalf of C. Hoare & Co. customers. Conformant to the OBIE v3.1 Read/Write standard; FAPI-secured (OAuth2/OIDC + PSD2 SCA + mTLS).

GitHub OpenAPI

Documentation

📖
Documentation
https://developer.hoaresbank.co.uk/apis/ob-payment-initiation-v3-1-0/docs
📖
APIReference
https://developer.hoaresbank.co.uk/apis/ob-payment-initiation-v3-1-0/docs
📖
Documentation
https://www.hoaresbank.co.uk/open-banking

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/c-hoare-and-co/refs/heads/main/openapi/c-hoare-and-co-payment-initiation-api-openapi.yml

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/c-hoare-and-co/refs/heads/main/overlays/c-hoare-and-co-payment-initiation-api-overlay.yaml

OpenAPI Specification

c-hoare-and-co-payment-initiation-api-openapi.yml Raw ↑ 
openapi: 3.0.1
info:
  title: Payment Initiation 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
paths:
  /domestic-payment-consents:
    post:
      tags:
        - Domestic Payments
      summary: Create Domestic Payment Consents
      operationId: CreateDomesticPaymentConsents
      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/201DomesticPaymentConsentsCreated'
        '400':
          $ref: '#/components/responses/400ErrorResponse'
        '401':
          $ref: '#/components/responses/401ErrorResponse'
        '403':
          $ref: '#/components/responses/403ErrorResponse'
        '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/OBWriteDomesticConsent2Param'
  '/domestic-payment-consents/{ConsentId}':
    get:
      tags:
        - Domestic Payments
      summary: Get Domestic Payment Consents
      operationId: GetDomesticPaymentConsentsConsentId
      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/200DomesticPaymentConsentsConsentIdRead'
        '400':
          $ref: '#/components/responses/400ErrorResponse'
        '401':
          $ref: '#/components/responses/401ErrorResponse'
        '403':
          $ref: '#/components/responses/403ErrorResponse'
        '405':
          $ref: '#/components/responses/405ErrorResponse'
        '406':
          $ref: '#/components/responses/406ErrorResponse'
        '429':
          $ref: '#/components/responses/429ErrorResponse'
        '500':
          $ref: '#/components/responses/500ErrorResponse'
      security:
        - TPPOAuth2Security:
            - payments
  '/domestic-payment-consents/{ConsentId}/funds-confirmation':
    get:
      tags:
        - Domestic Payments
      summary: Get Domestic Payment Consents Funds Confirmation
      operationId: GetDomesticPaymentConsentsConsentIdFundsConfirmation
      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/200DomesticPaymentConsentsConsentIdFundsConfirmationRead
        '400':
          $ref: '#/components/responses/400ErrorResponse'
        '401':
          $ref: '#/components/responses/401ErrorResponse'
        '403':
          $ref: '#/components/responses/403ErrorResponse'
        '405':
          $ref: '#/components/responses/405ErrorResponse'
        '406':
          $ref: '#/components/responses/406ErrorResponse'
        '429':
          $ref: '#/components/responses/429ErrorResponse'
        '500':
          $ref: '#/components/responses/500ErrorResponse'
      security:
        - PSUOAuth2Security:
            - payments
  /domestic-payments:
    post:
      tags:
        - Domestic Payments
      summary: Create Domestic Payments
      operationId: CreateDomesticPayments
      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/201DomesticPaymentsCreated'
        '400':
          $ref: '#/components/responses/400ErrorResponse'
        '401':
          $ref: '#/components/responses/401ErrorResponse'
        '403':
          $ref: '#/components/responses/403ErrorResponse'
        '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/OBWriteDomestic2Param'
  '/domestic-payments/{DomesticPaymentId}':
    get:
      tags:
        - Domestic Payments
      summary: Get Domestic Payments
      operationId: GetDomesticPaymentsDomesticPaymentId
      parameters:
        - $ref: '#/components/parameters/DomesticPaymentId'
        - $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/200DomesticPaymentsDomesticPaymentIdRead'
        '400':
          $ref: '#/components/responses/400ErrorResponse'
        '401':
          $ref: '#/components/responses/401ErrorResponse'
        '403':
          $ref: '#/components/responses/403ErrorResponse'
        '405':
          $ref: '#/components/responses/405ErrorResponse'
        '406':
          $ref: '#/components/responses/406ErrorResponse'
        '429':
          $ref: '#/components/responses/429ErrorResponse'
        '500':
          $ref: '#/components/responses/500ErrorResponse'
      security:
        - TPPOAuth2Security:
            - payments
  /domestic-scheduled-payment-consents:
    post:
      tags:
        - Domestic Scheduled Payments
      summary: Create Domestic Scheduled Payment Consents
      operationId: CreateDomesticScheduledPaymentConsents
      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/201DomesticScheduledPaymentConsentsCreated'
        '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/OBWriteDomesticScheduledConsent2Param'
  '/domestic-scheduled-payment-consents/{ConsentId}':
    get:
      tags:
        - Domestic Scheduled Payments
      summary: Get Domestic Scheduled Payment Consents
      operationId: GetDomesticScheduledPaymentConsentsConsentId
      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/200DomesticScheduledPaymentConsentsConsentIdRead
        '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
  /domestic-scheduled-payments:
    post:
      tags:
        - Domestic Scheduled Payments
      summary: Create Domestic Scheduled Payments
      operationId: CreateDomesticScheduledPayments
      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/201DomesticScheduledPaymentsCreated'
        '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/OBWriteDomesticScheduled2Param'
  '/domestic-scheduled-payments/{DomesticScheduledPaymentId}':
    get:
      tags:
        - Domestic Scheduled Payments
      summary: Get Domestic Scheduled Payments
      operationId: GetDomesticScheduledPaymentsDomesticScheduledPaymentId
      parameters:
        - $ref: '#/components/parameters/DomesticScheduledPaymentId'
        - $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/200DomesticScheduledPaymentsDomesticScheduledPaymentIdRead
        '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
  /domestic-standing-order-consents:
    post:
      tags:
        - Domestic Standing Orders
      summary: Create Domestic Standing Order Consents
      operationId: CreateDomesticStandingOrderConsents
      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/201DomesticStandingOrderConsentsCreated'
        '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/OBWriteDomesticStandingOrderConsent2Param'
  '/domestic-standing-order-consents/{ConsentId}':
    get:
      tags:
        - Domestic Standing Orders
      summary: Get Domestic Standing Order Consents
      operationId: GetDomesticStandingOrderConsentsConsentId
      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/200DomesticStandingOrderConsentsConsentIdRead'
        '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
  /domestic-standing-orders:
    post:
      tags:
        - Domestic Standing Orders
      summary: Create Domestic Standing Orders
      operationId: CreateDomesticStandingOrders
      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/201DomesticStandingOrdersCreated'
        '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/OBWriteDomesticStandingOrder2Param'
  '/domestic-standing-orders/{DomesticStandingOrderId}':
    get:
      tags:
        - Domestic Standing Orders
      summary: Get Domestic Standing Orders
      operationId: GetDomesticStandingOrdersDomesticStandingOrderId
      parameters:
        - $ref: '#/components/parameters/DomesticStandingOrderId'
        - $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/200DomesticStandingOrdersDomesticStandingOrderIdRead
        '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:
    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
  /international-payment-consents:
    post:
      tags:
        - International Payments
      summary: Create International Payment Consents
      operationId: CreateInternationalPaymentConsents
      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/201InternationalPaymentConsentsCreated'
        '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'
        '50

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