payment-initiation-openapi.yaml

openapi: 3.0.0
info:
  title: Payment Initiation API
  description: Swagger 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: 4.0.0
paths:
  /domestic-payment-consents:
    post:
      tags:
        - Domestic Payments
      summary: Create Domestic Payment Consents
      operationId: CreateDomesticPaymentConsents
      parameters:
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-idempotency-key'
        - $ref: '#/components/parameters/x-jws-signature'
        - $ref: '#/components/parameters/x-customer-user-agent'
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              $ref: '#/components/schemas/OBWriteDomesticConsent4'
          application/json:
            schema:
              $ref: '#/components/schemas/OBWriteDomesticConsent4'
          application/jose+jwe:
            schema:
              $ref: '#/components/schemas/OBWriteDomesticConsent4'
        description: Default
        required: true
      responses:
        '201':
          $ref: '#/components/responses/201DomesticPaymentConsentsCreated'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '415':
          $ref: '#/components/responses/415Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
  /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-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-customer-user-agent'
      responses:
        '200':
          $ref: '#/components/responses/200DomesticPaymentConsentsConsentIdRead'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      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-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-customer-user-agent'
      responses:
        '200':
          $ref: >-
            #/components/responses/200DomesticPaymentConsentsConsentIdFundsConfirmationRead
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - PSUOAuth2Security:
            - payments
  /domestic-payments:
    post:
      tags:
        - Domestic Payments
      summary: Create Domestic Payments
      operationId: CreateDomesticPayments
      parameters:
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-idempotency-key'
        - $ref: '#/components/parameters/x-jws-signature'
        - $ref: '#/components/parameters/x-customer-user-agent'
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              $ref: '#/components/schemas/OBWriteDomestic2'
          application/json:
            schema:
              $ref: '#/components/schemas/OBWriteDomestic2'
          application/jose+jwe:
            schema:
              $ref: '#/components/schemas/OBWriteDomestic2'
        description: Default
        required: true
      responses:
        '201':
          $ref: '#/components/responses/201DomesticPaymentsCreated'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '409':
          $ref: '#/components/responses/409Error'
        '415':
          $ref: '#/components/responses/415Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - PSUOAuth2Security:
            - payments
  /domestic-payments/{DomesticPaymentId}:
    get:
      tags:
        - Domestic Payments
      summary: Get Domestic Payments
      operationId: GetDomesticPaymentsDomesticPaymentId
      parameters:
        - $ref: '#/components/parameters/DomesticPaymentId'
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-customer-user-agent'
      responses:
        '200':
          $ref: '#/components/responses/200DomesticPaymentsDomesticPaymentIdRead'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
  /domestic-payments/{DomesticPaymentId}/payment-details:
    get:
      tags:
        - Payment Details
      summary: Get Payment Details
      operationId: GetDomesticPaymentsDomesticPaymentIdPaymentDetails
      parameters:
        - $ref: '#/components/parameters/DomesticPaymentId'
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-customer-user-agent'
      responses:
        '200':
          $ref: >-
            #/components/responses/200DomesticPaymentsDomesticPaymentIdPaymentDetailsRead
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      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-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-idempotency-key'
        - $ref: '#/components/parameters/x-jws-signature'
        - $ref: '#/components/parameters/x-customer-user-agent'
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              $ref: '#/components/schemas/OBWriteDomesticScheduledConsent4'
          application/json:
            schema:
              $ref: '#/components/schemas/OBWriteDomesticScheduledConsent4'
          application/jose+jwe:
            schema:
              $ref: '#/components/schemas/OBWriteDomesticScheduledConsent4'
        description: Default
        required: true
      responses:
        '201':
          $ref: '#/components/responses/201DomesticScheduledPaymentConsentsCreated'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '409':
          $ref: '#/components/responses/409Error'
        '415':
          $ref: '#/components/responses/415Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
  /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-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-customer-user-agent'
      responses:
        '200':
          $ref: >-
            #/components/responses/200DomesticScheduledPaymentConsentsConsentIdRead
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
  /domestic-scheduled-payments:
    post:
      tags:
        - Domestic Scheduled Payments
      summary: Create Domestic Scheduled Payments
      operationId: CreateDomesticScheduledPayments
      parameters:
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-idempotency-key'
        - $ref: '#/components/parameters/x-jws-signature'
        - $ref: '#/components/parameters/x-customer-user-agent'
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              $ref: '#/components/schemas/OBWriteDomesticScheduled2'
          application/json:
            schema:
              $ref: '#/components/schemas/OBWriteDomesticScheduled2'
          application/jose+jwe:
            schema:
              $ref: '#/components/schemas/OBWriteDomesticScheduled2'
        description: Default
        required: true
      responses:
        '201':
          $ref: '#/components/responses/201DomesticScheduledPaymentsCreated'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '409':
          $ref: '#/components/responses/409Error'
        '415':
          $ref: '#/components/responses/415Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - PSUOAuth2Security:
            - payments
  /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-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-customer-user-agent'
      responses:
        '200':
          $ref: >-
            #/components/responses/200DomesticScheduledPaymentsDomesticScheduledPaymentIdRead
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
  /domestic-scheduled-payments/{DomesticScheduledPaymentId}/payment-details:
    get:
      tags:
        - Payment Details
      summary: Get Payment Details
      operationId: GetDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails
      parameters:
        - $ref: '#/components/parameters/DomesticScheduledPaymentId'
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-customer-user-agent'
      responses:
        '200':
          $ref: >-
            #/components/responses/200DomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetailsRead
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      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-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-idempotency-key'
        - $ref: '#/components/parameters/x-jws-signature'
        - $ref: '#/components/parameters/x-customer-user-agent'
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              $ref: '#/components/schemas/OBWriteDomesticStandingOrderConsent5'
          application/json:
            schema:
              $ref: '#/components/schemas/OBWriteDomesticStandingOrderConsent5'
          application/jose+jwe:
            schema:
              $ref: '#/components/schemas/OBWriteDomesticStandingOrderConsent5'
        description: Default
        required: true
      responses:
        '201':
          $ref: '#/components/responses/201DomesticStandingOrderConsentsCreated'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '409':
          $ref: '#/components/responses/409Error'
        '415':
          $ref: '#/components/responses/415Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
  /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-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-customer-user-agent'
      responses:
        '200':
          $ref: '#/components/responses/200DomesticStandingOrderConsentsConsentIdRead'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
  /domestic-standing-orders:
    post:
      tags:
        - Domestic Standing Orders
      summary: Create Domestic Standing Orders
      operationId: CreateDomesticStandingOrders
      parameters:
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-idempotency-key'
        - $ref: '#/components/parameters/x-jws-signature'
        - $ref: '#/components/parameters/x-customer-user-agent'
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              $ref: '#/components/schemas/OBWriteDomesticStandingOrder3'
          application/json:
            schema:
              $ref: '#/components/schemas/OBWriteDomesticStandingOrder3'
          application/jose+jwe:
            schema:
              $ref: '#/components/schemas/OBWriteDomesticStandingOrder3'
        description: Default
        required: true
      responses:
        '201':
          $ref: '#/components/responses/201DomesticStandingOrdersCreated'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '409':
          $ref: '#/components/responses/409Error'
        '415':
          $ref: '#/components/responses/415Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - PSUOAuth2Security:
            - payments
  /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-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-customer-user-agent'
      responses:
        '200':
          $ref: >-
            #/components/responses/200DomesticStandingOrdersDomesticStandingOrderIdRead
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
  /domestic-standing-orders/{DomesticStandingOrderId}/payment-details:
    get:
      tags:
        - Payment Details
      summary: Get Payment Details
      operationId: GetDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails
      parameters:
        - $ref: '#/components/parameters/DomesticStandingOrderId'
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-customer-user-agent'
      responses:
        '200':
          $ref: >-
            #/components/responses/200DomesticStandingOrdersDomesticStandingOrderIdPaymentDetailsRead
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
  /file-payment-consents:
    post:
      tags:
        - File Payments
      summary: Create File Payment Consents
      operationId: CreateFilePaymentConsents
      parameters:
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-idempotency-key'
        - $ref: '#/components/parameters/x-jws-signature'
        - $ref: '#/components/parameters/x-customer-user-agent'
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              $ref: '#/components/schemas/OBWriteFileConsent3'
          application/json:
            schema:
              $ref: '#/components/schemas/OBWriteFileConsent3'
          application/jose+jwe:
            schema:
              $ref: '#/components/schemas/OBWriteFileConsent3'
        description: Default
        required: true
      responses:
        '201':
          $ref: '#/components/responses/201FilePaymentConsentsCreated'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '409':
          $ref: '#/components/responses/409Error'
        '415':
          $ref: '#/components/responses/415Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
  /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-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-customer-user-agent'
      responses:
        '200':
          $ref: '#/components/responses/200FilePaymentConsentsConsentIdRead'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      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-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-idempotency-key'
        - $ref: '#/components/parameters/x-jws-signature'
        - $ref: '#/components/parameters/x-customer-user-agent'
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              $ref: '#/components/schemas/File'
          application/json:
            schema:
              $ref: '#/components/schemas/File'
          application/jose+jwe:
            schema:
              $ref: '#/components/schemas/File'
        description: Default
        required: true
      responses:
        '200':
          $ref: '#/components/responses/200FilePaymentConsentsConsentIdFileCreated'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '409':
          $ref: '#/components/responses/409Error'
        '415':
          $ref: '#/components/responses/415Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
    get:
      tags:
        - File Payments
      summary: Get File Payment Consents
      operationId: GetFilePaymentConsentsConsentIdFile
      parameters:
        - $ref: '#/components/parameters/ConsentId'
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-customer-user-agent'
      responses:
        '200':
          $ref: '#/components/responses/200FilePaymentConsentsConsentIdFileRead'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
  /file-payments:
    post:
      tags:
        - File Payments
      summary: Create File Payments
      operationId: CreateFilePayments
      parameters:
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-idempotency-key'
        - $ref: '#/components/parameters/x-jws-signature'
        - $ref: '#/components/parameters/x-customer-user-agent'
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              $ref: '#/components/schemas/OBWriteFile2'
          application/json:
            schema:
              $ref: '#/components/schemas/OBWriteFile2'
          application/jose+jwe:
            schema:
              $ref: '#/components/schemas/OBWriteFile2'
        description: Default
        required: true
      responses:
        '201':
          $ref: '#/components/responses/201FilePaymentsCreated'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '409':
          $ref: '#/components/responses/409Error'
        '415':
          $ref: '#/components/responses/415Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - PSUOAuth2Security:
            - payments
  /file-payments/{FilePaymentId}:
    get:
      tags:
        - File Payments
      summary: Get File Payments
      operationId: GetFilePaymentsFilePaymentId
      parameters:
        - $ref: '#/components/parameters/FilePaymentId'
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-customer-user-agent'
      responses:
        '200':
          $ref: '#/components/responses/200FilePaymentsFilePaymentIdRead'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
  /file-payments/{FilePaymentId}/payment-details:
    get:
      tags:
        - Payment Details
      summary: Get Payment Details
      operationId: GetFilePaymentsFilePaymentIdPaymentDetails
      parameters:
        - $ref: '#/components/parameters/FilePaymentId'
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-customer-user-agent'
      responses:
        '200':
          $ref: >-
            #/components/responses/200FilePaymentsFilePaymentIdPaymentDetailsRead
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      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-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-customer-user-agent'
      responses:
        '200':
          $ref: '#/components/responses/200FilePaymentsFilePaymentIdReportFileRead'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
  /international-payment-consents:
    post:
      tags:
        - International Payments
      summary: Create International Payment Consents
      operationId: CreateInternationalPaymentConsents
      parameters:
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-idempotency-key'
        - $ref: '#/components/parameters/x-jws-signature'
        - $ref: '#/components/parameters/x-customer-user-agent'
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              $ref: '#/components/schemas/OBWriteInternationalConsent5'
          application/json:
            schema:
              $ref: '#/components/schemas/OBWriteInternationalConsent5'
          application/jose+jwe:
            schema:
              $ref: '#/components/schemas/OBWriteInternationalConsent5'
        description: Default
        required: true
      responses:
        '201':
          $ref: '#/components/responses/201InternationalPaymentConsentsCreated'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '409':
          $ref: '#/components/responses/409Error'
        '415':
          $ref: '#/components/responses/415Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
  /international-payment-consents/{ConsentId}:
    get:
      tags:
        - International Payments
      summary: Get International Payment Consents
      operationId: GetInternationalPaymentConsentsConsentId
      parameters:
        - $ref: '#/components/parameters/ConsentId'
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-customer-user-agent'
      responses:
        '200':
          $ref: '#/components/responses/200InternationalPaymentConsentsConsentIdRead'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
  /international-payment-consents/{ConsentId}/funds-confirmation:
    get:
      tags:
        - International Payments
      summary: Get International Payment Consents Funds Confirmation
      operationId: GetInternationalPaymentConsentsConsentIdFundsConfirmation
      parameters:
        - $ref: '#/components/parameters/ConsentId'
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-customer-user-agent'
      responses:
        '200':
          $ref: >-
            #/components/responses/200InternationalPaymentConsentsConsentIdFundsConfirmationRead
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - PSUOAuth2Security:
            - payments
  /international-payments:
    post:
      tags:
        - International Payments
      summary: Create International Payments
      operationId: CreateInternationalPayments
      parameters:
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-idempotency-key'
        - $ref: '#/components/parameters/x-jws-signature'
        - $ref: '#/components/parameters/x-customer-user-agent'
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              $ref: '#/components/schemas/OBWriteInternational3'
          application/json:
            schema:
              $ref: '#/components/schemas/OBWriteInternational3'
          application/jose+jwe:
            schema:
              $ref: '#/components/schemas/OBWriteInternational3'
        description: Default
        required: true
      responses:
        '201':
          $ref: '#/components/responses/201InternationalPaymentsCreated'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '415':
          $ref: '#/components/responses/415Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - PSUOAuth2Security:
            - payments
  /international-payments/{InternationalPaymentId}:
    get:
      tags:
        - International Payments
      summary: Get International Payments
      operationId: GetInternationalPaymentsInternationalPaymentId
      parameters:
        - $ref: '#/components/parameters/InternationalPaymentId'
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-customer-user-agent'
      responses:
        '200':
          $ref: >-
            #/components/responses/200InternationalPaymentsInternationalPaymentIdRead
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
  /international-payments/{InternationalPaymentId}/payment-details:
    get:
      tags:
        - Payment Details
      summary: Get Payment Details
      operationId: GetInternationalPaymentsInternationalPaymentIdPaymentDetails
      parameters:
        - $ref: '#/components/parameters/InternationalPaymentId'
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-customer-user-agent'
      responses:
        '200':
          $ref: >-
            #/components/responses/200InternationalPaymentsInternationalPaymentIdPaymentDetailsRead
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
  /international-scheduled-payment-consents:
    post:
      tags:
        - International Scheduled Payments
      summary: Create International Scheduled Payment Consents
      operationId: CreateInternationalScheduledPaymentConsents
      parameters:
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-idempotency-key'
        - $ref: '#/components/parameters/x-jws-signature'
        - $ref: '#/components/parameters/x-customer-user-agent'
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              $ref: '#/components/schemas/OBWriteInternationalScheduledConsent5'
          application/json:
            schema:
              $ref: '#/components/schemas/OBWriteInternationalScheduledConsent5'
          application/jose+jwe:
            schema:
              $ref: '#/components/schemas/OBWriteInternationalScheduledConsent5'
        description: Default
        required: true
      responses:
        '201':
          $ref: >-
            #/components/responses/201InternationalScheduledPaymentConsentsCreated
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '409':
          $ref: '#/components/responses/409Error'
        '415':
          $ref: '#/components/responses/415Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
  /international-scheduled-payment-consents/{ConsentId}:
    get:
      tags:
        - International Scheduled Payments
      summary: Get International Scheduled Payment Consents
      operationId: GetInternationalScheduledPaymentConsentsConsentId
      parameters:
        - $ref: '#/components/parameters/ConsentId'
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-customer-user-agent'
      responses:
        '200':
          $ref: >-
            #/components/responses/200InternationalScheduledPaymentConsentsConsentIdRead
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
  /international-scheduled-payment-consents/{ConsentId}/funds-confirmation:
    get:
      tags:
        - International Scheduled Payments
      summary: Get International Scheduled Payment Consents Funds Confirmation
      operationId: GetInternationalScheduledPaymentConsentsConsentIdFundsConfirmation
      parameters:
        - $ref: '#/components/parameters/ConsentId'
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-customer-user-agent'
      responses:
        '200':
          $ref: >-
            #/components/responses/200InternationalScheduledPaymentConsentsConsentIdFundsConfirmationRead
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - PSUOAuth2Security:
            - payments
  /international-scheduled-payments:
    post:
      tags:
        - International Scheduled Payments
      summary: Create International Scheduled Payments
      operationId: CreateInternationalScheduledPayments
      parameters:
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-idempotency-key'
        - $ref: '#/components/parameters/x-jws-signature'
        - $ref: '#/components/parameters/x-customer-user-agent'
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              $ref: '#/components/schemas/OBWriteInternationalScheduled3'
          application/json:
            schema:
              $ref: '#/components/schemas/OBWriteInternationalScheduled3'
          application/jose+jwe:
            schema:
              $ref: '#/components/schemas/OBWriteInternationalScheduled3'
        description: Default
        required: true
      responses:
        '201':
          $ref: '#/components/responses/201InternationalScheduledPaymentsCreated'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '409':
          $ref: '#/components/responses/409Error'
        '415':
          $ref: '#/components/responses/415Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - PSUOAuth2Security:
            - payments
  /international-scheduled-payments/{InternationalScheduledPaymentId}:
    get:
      tags:
        - International Scheduled Payments
      summary: Get International Scheduled Payments
      operationId: GetInternationalScheduledPaymentsInternationalScheduledPaymentId
      parameters:
        - $ref: '#/components/parameters/InternationalScheduledPaymentId'
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-customer-user-agent'
      responses:
        '200':
          $ref: >-
            #/components/responses/200InternationalScheduledPaymentsInternationalScheduledPaymentIdRead
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
  /international-scheduled-payments/{InternationalScheduledPaymentId}/payment-details:
    get:
      tags:
        - Payment Details
      summary: Get Payment Details
      operationId: >-
        GetInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails
      parameters:
        - $ref: '#/components/parameters/InternationalScheduledPaymentId'
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-customer-user-agent'
      responses:
        '200':
          $ref: >-
            #/components/responses/200InternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetailsRead
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
  /international-standing-order-consents:
    post:
      tags:
        - International Standing Orders
      summary: Create International Standing Order Consents
      operationId: CreateInternationalStandingOrderConsents
      parameters:
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-idempotency-key'
        - $ref: '#/components/parameters/x-jws-signature'
        - $ref: '#/components/parameters/x-customer-user-agent'
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              $ref: '#/components/schemas/OBWriteInternationalStandingOrderConsent6'
          application/json:
            schema:
              $ref: '#/components/schemas/OBWriteInternationalStandingOrderConsent6'
          application/jose+jwe:
            schema:
              $ref: '#/components/schemas/OBWriteInternationalStandingOrderConsent6'
        description: Default
        required: true
      responses:
        '201':
          $ref: '#/components/responses/201InternationalStandingOrderConsentsCreated'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '409':
          $ref: '#/components/responses/409Error'
        '415':
          $ref: '#/components/responses/415Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
  /international-standing-order-consents/{ConsentId}:
    get:
      tags:
        - International Standing Orders
      summary: Get International Standing Order Consents
      operationId: GetInternationalStandingOrderConsentsConsentId
      parameters:
        - $ref: '#/components/parameters/ConsentId'
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-customer-user-agent'
      responses:
        '200':
          $ref: >-
            #/components/responses/200InternationalStandingOrderConsentsConsentIdRead
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
  /international-standing-orders:
    post:
      tags:
        - International Standing Orders
      summary: Create International Standing Orders
      operationId: CreateInternationalStandingOrders
      parameters:
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-idempotency-key'
        - $ref: '#/components/parameters/x-jws-signature'
        - $ref: '#/components/parameters/x-customer-user-agent'
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              $ref: '#/components/schemas/OBWriteInternationalStandingOrder4'
          application/json:
            schema:
              $ref: '#/components/schemas/OBWriteInternationalStandingOrder4'
          application/jose+jwe:
            schema:
              $ref: '#/components/schemas/OBWriteInternationalStandingOrder4'
        description: Default
        required: true
      responses:
        '201':
          $ref: '#/components/responses/201InternationalStandingOrdersCreated'
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '409':
          $ref: '#/components/responses/409Error'
        '415':
          $ref: '#/components/responses/415Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - PSUOAuth2Security:
            - payments
  /international-standing-orders/{InternationalStandingOrderPaymentId}:
    get:
      tags:
        - International Standing Orders
      summary: Get International Standing Orders
      operationId: GetInternationalStandingOrdersInternationalStandingOrderPaymentId
      parameters:
        - $ref: '#/components/parameters/InternationalStandingOrderPaymentId'
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-customer-user-agent'
      responses:
        '200':
          $ref: >-
            #/components/responses/200InternationalStandingOrdersInternationalStandingOrderPaymentIdRead
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
  /international-standing-orders/{InternationalStandingOrderPaymentId}/payment-details:
    get:
      tags:
        - Payment Details
      summary: Get Payment Details
      operationId: >-
        GetInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails
      parameters:
        - $ref: '#/components/parameters/InternationalStandingOrderPaymentId'
        - $ref: '#/components/parameters/x-fapi-auth-date'
        - $ref: '#/components/parameters/x-fapi-customer-ip-address'
        - $ref: '#/components/parameters/x-fapi-interaction-id'
        - $ref: '#/components/parameters/Authorization'
        - $ref: '#/components/parameters/x-customer-user-agent'
      responses:
        '200':
          $ref: >-
            #/components/responses/200InternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetailsRead
        '400':
          $ref: '#/components/responses/400Error'
        '401':
          $ref: '#/components/responses/401Error'
        '403':
          $ref: '#/components/responses/403Error'
        '404':
          $ref: '#/components/responses/404Error'
        '405':
          $ref: '#/components/responses/405Error'
        '406':
          $ref: '#/components/responses/406Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
servers:
  - url: /open-banking/v4.0/pisp
components:
  parameters:
    ConsentId:
      name: ConsentId
      in: path
      description: ConsentId
      required: true
      schema:
        type: string
    DomesticPaymentId:
      name: DomesticPaymentId
      in: path
      description: DomesticPaymentId
      required: true
      schema:
        type: string
    DomesticScheduledPaymentId:
      name: DomesticScheduledPaymentId
      in: path
      description: DomesticScheduledPaymentId
      required: true
      schema:
        type: string
    DomesticStandingOrderId:
      name: DomesticStandingOrderId
      in: path
      description: DomesticStandingOrderId
      required: true
      schema:
        type: string
    FilePaymentId:
      name: FilePaymentId
      in: path
      description: FilePaymentId
      required: true
      schema:
        type: string
    InternationalPaymentId:
      name: InternationalPaymentId
      in: path
      description: InternationalPaymentId
      required: true
      schema:
        type: string
    InternationalScheduledPaymentId:
      name: InternationalScheduledPaymentId
      in: path
      description: InternationalScheduledPaymentId
      required: true
      schema:
        type: string
    InternationalStandingOrderPaymentId:
      name: InternationalStandingOrderPaymentId
      in: path
      description: InternationalStandingOrderPaymentId
      required: true
      schema:
        type: string
    Authorization:
      in: header
      name: Authorization
      required: true
      description: An Authorisation Token as per https://tools.ietf.org/html/rfc6750
      schema:
        type: string
    x-customer-user-agent:
      in: header
      name: x-customer-user-agent
      description: Indicates the user-agent that the PSU is using.
      required: false
      schema:
        type: string
    x-fapi-customer-ip-address:
      in: header
      name: x-fapi-customer-ip-address
      required: false
      description: The PSU's IP address if the PSU is currently logged in with the TPP.
      schema:
        type: string
    x-fapi-auth-date:
      in: header
      name: x-fapi-auth-date
      required: false
      description: >-
        The time when the PSU last logged in with the TPP. 

        All dates in the HTTP headers are represented as RFC 7231 Full Dates. An
        example is below: 

        Sun, 10 Sep 2017 19:43:31 UTC
      schema:
        type: string
        pattern: >-
          ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2}
          (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4}
          \d{2}:\d{2}:\d{2} (GMT|UTC)$
    x-fapi-interaction-id:
      in: header
      name: x-fapi-interaction-id
      required: false
      description: An RFC4122 UID used as a correlation id.
      schema:
        type: string
    x-idempotency-key:
      name: x-idempotency-key
      in: header
      description: |
        Every request will be processed only once per x-idempotency-key.  The
        Idempotency Key will be valid for 24 hours.
      required: true
      schema:
        type: string
        maxLength: 40
        pattern: ^(?!\s)(.*)(\S)$
    x-jws-signature:
      in: header
      name: x-jws-signature
      required: true
      description: A detached JWS signature of the body of the payload.
      schema:
        type: string
  responses:
    201DomesticPaymentConsentsCreated:
      description: Domestic Payment Consents Created
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticConsentResponse5'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticConsentResponse5'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticConsentResponse5'
    200DomesticPaymentConsentsConsentIdRead:
      description: Domestic Payment Consents Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticConsentResponse5'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticConsentResponse5'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticConsentResponse5'
    200DomesticPaymentConsentsConsentIdFundsConfirmationRead:
      description: Domestic Payment Consents Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteFundsConfirmationResponse1'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteFundsConfirmationResponse1'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteFundsConfirmationResponse1'
    201DomesticPaymentsCreated:
      description: Domestic Payments Created
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticResponse5'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticResponse5'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticResponse5'
    200DomesticPaymentsDomesticPaymentIdRead:
      description: Domestic Payments Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticResponse5'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticResponse5'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticResponse5'
    200DomesticPaymentsDomesticPaymentIdPaymentDetailsRead:
      description: Payment Details Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWritePaymentDetailsResponse1'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWritePaymentDetailsResponse1'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWritePaymentDetailsResponse1'
    201DomesticScheduledPaymentConsentsCreated:
      description: Domestic Scheduled Payment Consents Created
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticScheduledConsentResponse5'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticScheduledConsentResponse5'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticScheduledConsentResponse5'
    200DomesticScheduledPaymentConsentsConsentIdRead:
      description: Domestic Scheduled Payment Consents Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticScheduledConsentResponse5'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticScheduledConsentResponse5'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticScheduledConsentResponse5'
    201DomesticScheduledPaymentsCreated:
      description: Domestic Scheduled Payments Created
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticScheduledResponse5'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticScheduledResponse5'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticScheduledResponse5'
    200DomesticScheduledPaymentsDomesticScheduledPaymentIdRead:
      description: Domestic Scheduled Payments Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticScheduledResponse5'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticScheduledResponse5'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticScheduledResponse5'
    200DomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetailsRead:
      description: Payment Details Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWritePaymentDetailsResponse1'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWritePaymentDetailsResponse1'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWritePaymentDetailsResponse1'
    201DomesticStandingOrderConsentsCreated:
      description: Domestic Standing Order Consents Created
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticStandingOrderConsentResponse6'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticStandingOrderConsentResponse6'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticStandingOrderConsentResponse6'
    200DomesticStandingOrderConsentsConsentIdRead:
      description: Domestic Standing Order Consents Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticStandingOrderConsentResponse6'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticStandingOrderConsentResponse6'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticStandingOrderConsentResponse6'
    201DomesticStandingOrdersCreated:
      description: Domestic Standing Orders Created
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticStandingOrderResponse6'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticStandingOrderResponse6'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticStandingOrderResponse6'
    200DomesticStandingOrdersDomesticStandingOrderIdRead:
      description: Domestic Standing Orders Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticStandingOrderResponse6'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticStandingOrderResponse6'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteDomesticStandingOrderResponse6'
    200DomesticStandingOrdersDomesticStandingOrderIdPaymentDetailsRead:
      description: Payment Details Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWritePaymentDetailsResponse1'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWritePaymentDetailsResponse1'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWritePaymentDetailsResponse1'
    201FilePaymentConsentsCreated:
      description: File Payment Consents Created
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteFileConsentResponse4'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteFileConsentResponse4'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteFileConsentResponse4'
    200FilePaymentConsentsConsentIdFileCreated:
      description: File Payment Consents Created
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
    200FilePaymentConsentsConsentIdRead:
      description: File Payment Consents Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteFileConsentResponse4'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteFileConsentResponse4'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteFileConsentResponse4'
    200FilePaymentConsentsConsentIdFileRead:
      description: File Payment Consents Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/File'
        application/json:
          schema:
            $ref: '#/components/schemas/File'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/File'
    201FilePaymentsCreated:
      description: File Payments Created
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteFileResponse3'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteFileResponse3'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteFileResponse3'
    200FilePaymentsFilePaymentIdRead:
      description: File Payments Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteFileResponse3'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteFileResponse3'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteFileResponse3'
    200FilePaymentsFilePaymentIdReportFileRead:
      description: File Payments Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/File'
        application/json:
          schema:
            $ref: '#/components/schemas/File'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/File'
    200FilePaymentsFilePaymentIdPaymentDetailsRead:
      description: Payment Details Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWritePaymentDetailsResponse1'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWritePaymentDetailsResponse1'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWritePaymentDetailsResponse1'
    201InternationalPaymentConsentsCreated:
      description: International Payment Consents Created
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalConsentResponse6'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalConsentResponse6'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalConsentResponse6'
    200InternationalPaymentConsentsConsentIdRead:
      description: International Payment Consents Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalConsentResponse6'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalConsentResponse6'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalConsentResponse6'
    200InternationalPaymentConsentsConsentIdFundsConfirmationRead:
      description: International Payment Consents Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteFundsConfirmationResponse1'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteFundsConfirmationResponse1'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteFundsConfirmationResponse1'
    201InternationalPaymentsCreated:
      description: International Payments Created
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalResponse5'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalResponse5'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalResponse5'
    200InternationalPaymentsInternationalPaymentIdRead:
      description: International Payments Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalResponse5'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalResponse5'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalResponse5'
    200InternationalPaymentsInternationalPaymentIdPaymentDetailsRead:
      description: Payment Details Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWritePaymentDetailsResponse1'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWritePaymentDetailsResponse1'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWritePaymentDetailsResponse1'
    201InternationalScheduledPaymentConsentsCreated:
      description: International Scheduled Payment Consents Created
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalScheduledConsentResponse6'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalScheduledConsentResponse6'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalScheduledConsentResponse6'
    200InternationalScheduledPaymentConsentsConsentIdRead:
      description: International Scheduled Payment Consents Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalScheduledConsentResponse6'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalScheduledConsentResponse6'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalScheduledConsentResponse6'
    200InternationalScheduledPaymentConsentsConsentIdFundsConfirmationRead:
      description: International Scheduled Payment Consents Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteFundsConfirmationResponse1'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteFundsConfirmationResponse1'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteFundsConfirmationResponse1'
    201InternationalScheduledPaymentsCreated:
      description: International Scheduled Payments Created
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalScheduledResponse6'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalScheduledResponse6'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalScheduledResponse6'
    200InternationalScheduledPaymentsInternationalScheduledPaymentIdRead:
      description: International Scheduled Payments Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalScheduledResponse6'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalScheduledResponse6'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalScheduledResponse6'
    200InternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetailsRead:
      description: Payment Details Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWritePaymentDetailsResponse1'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWritePaymentDetailsResponse1'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWritePaymentDetailsResponse1'
    201InternationalStandingOrderConsentsCreated:
      description: International Standing Order Consents Created
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: >-
              #/components/schemas/OBWriteInternationalStandingOrderConsentResponse7
        application/json:
          schema:
            $ref: >-
              #/components/schemas/OBWriteInternationalStandingOrderConsentResponse7
        application/jose+jwe:
          schema:
            $ref: >-
              #/components/schemas/OBWriteInternationalStandingOrderConsentResponse7
    200InternationalStandingOrderConsentsConsentIdRead:
      description: International Standing Order Consents Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: >-
              #/components/schemas/OBWriteInternationalStandingOrderConsentResponse7
        application/json:
          schema:
            $ref: >-
              #/components/schemas/OBWriteInternationalStandingOrderConsentResponse7
        application/jose+jwe:
          schema:
            $ref: >-
              #/components/schemas/OBWriteInternationalStandingOrderConsentResponse7
    201InternationalStandingOrdersCreated:
      description: International Standing Orders Created
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalStandingOrderResponse7'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalStandingOrderResponse7'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalStandingOrderResponse7'
    200InternationalStandingOrdersInternationalStandingOrderPaymentIdRead:
      description: International Standing Orders Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalStandingOrderResponse7'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalStandingOrderResponse7'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWriteInternationalStandingOrderResponse7'
    200InternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetailsRead:
      description: Payment Details Read
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBWritePaymentDetailsResponse1'
        application/json:
          schema:
            $ref: '#/components/schemas/OBWritePaymentDetailsResponse1'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBWritePaymentDetailsResponse1'
    400Error:
      description: Bad request
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
        application/json:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
    401Error:
      description: Unauthorized
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
    403Error:
      description: Forbidden
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
        application/json:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
    404Error:
      description: Not found
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
    405Error:
      description: Method Not Allowed
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
    406Error:
      description: Not Acceptable
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
    409Error:
      description: Conflict
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >-
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
        application/json:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
    415Error:
      description: Unsupported Media Type
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
    429Error:
      description: Too Many Requests
      headers:
        Retry-After:
          description: Number in seconds to wait
          schema:
            type: integer
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
    500Error:
      description: Internal Server Error
      headers:
        x-fapi-interaction-id:
          description: An RFC4122 UID used as a correlation id.
          required: true
          schema:
            type: string
        x-jws-signature:
          description: >
            Header containing a detached JWS signature of the body of the
            payload.
          required: true
          schema:
            type: string
      content:
        application/json; charset=utf-8:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
        application/json:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
        application/jose+jwe:
          schema:
            $ref: '#/components/schemas/OBErrorResponse1'
  securitySchemes:
    TPPOAuth2Security:
      type: oauth2
      description: TPP client credential authorisation flow with the ASPSP
      flows:
        clientCredentials:
          tokenUrl: https://authserver.example/token
          scopes:
            payments: Generic payment scope
    PSUOAuth2Security:
      type: oauth2
      description: >-
        OAuth flow, it is required when the PSU needs to perform SCA with the
        ASPSP when a TPP wants to access an ASPSP resource owned by the PSU
      flows:
        authorizationCode:
          authorizationUrl: https://authserver.example/authorization
          tokenUrl: https://authserver.example/token
          scopes:
            payments: Generic payment scope
  schemas:
    OBUltimateCreditor1:
      description: Ultimate party to which an amount of money is due.
      type: object
      properties:
        Name:
          description: >-
            Name by which a party is known and which is usually used to identify
            that party.
          type: string
          minLength: 1
          maxLength: 140
        Identification:
          description: Identification assigned by an institution.
          type: string
          minLength: 1
          maxLength: 256
        LEI:
          $ref: '#/components/schemas/LEI'
        SchemeName:
          $ref: '#/components/schemas/OBInternalAccountIdentification4Code'
        PostalAddress:
          $ref: '#/components/schemas/OBPostalAddress7'
    OBUltimateDebtor1:
      description: Ultimate party that owes an amount of money to the (ultimate) creditor.
      type: object
      properties:
        Name:
          description: >-
            Name by which a party is known and which is usually used to identify
            that party.
          type: string
          minLength: 1
          maxLength: 140
        Identification:
          description: Identification assigned by an institution.
          type: string
          minLength: 1
          maxLength: 256
        LEI:
          $ref: '#/components/schemas/LEI'
        SchemeName:
          $ref: '#/components/schemas/OBInternalAccountIdentification4Code'
        PostalAddress:
          $ref: '#/components/schemas/OBPostalAddress7'
    OBFrequency6:
      description: >-
        Regularity with which credit transfer instructions are to be created and
        processed
      type: object
      required:
        - Type
      properties:
        Type:
          $ref: '#/components/schemas/OBFrequency6Code'
        CountPerPeriod:
          description: >-
            Number of instructions to be created and processed during the
            specified period .Specifies a frequency in terms of a count per
            period within a specified frequency type. Note: should not be used
            alongside `PointInTime`
          type: integer
          example: 1
          format: int32
        PointInTime:
          $ref: '#/components/schemas/PointInTime'
    PointInTime:
      description: >-
        Exact2NumericText - Further information on the exact point in time the
        event should take place. Specifies a frequency in terms of an exact
        point in time or moment within a specified frequency type. Note: should
        not be used alongside `CountPerSide`
      type: string
      example: '00'
      maxLength: 2
    ActiveOrHistoricCurrencyCode:
      description: >-
        A code allocated to a currency by a Maintenance Agency under an
        international identification scheme, as described in the latest edition
        of the international standard ISO 4217 "Codes for the representation of
        currencies and funds".
      type: string
      pattern: ^[A-Z]{3,3}$
    BuildingName:
      description: Name of a referenced building.
      type: string
      minLength: 1
      maxLength: 140
    BuildingNumber:
      description: Number that identifies the position of a building on a street.
      type: string
      minLength: 1
      maxLength: 16
    Date:
      description: >-
        Date and time associated with the date time type. All dates in the JSON
        payloads are represented in ISO 8601 date format. 
         An example is below:
        2017-04-05
      type: string
      format: date
    ExternalCategoryPurpose1Code:
      description: >-
        Enumeration of codes that outlines the type of purpose behind a
        transaction, payment or risk. 
         For all enum values see `ExternalCategoryPurpose1Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      type: string
      enum:
        - BONU
        - CASH
        - CBLK
        - CCRD
        - CGWV
        - CIPC
        - CONC
        - CORT
        - DCRD
        - DIVI
        - DVPM
        - EPAY
        - FCDT
        - FCIN
        - FCOL
        - GOVT
        - GP2P
        - HEDG
        - ICCP
        - IDCP
        - INTC
        - INTE
        - LBOX
        - LOAN
        - MP2B
        - MP2P
        - OTHR
        - PENS
        - RPRE
        - RRCT
        - RVPM
        - SALA
        - SECU
        - SSBE
        - SUPP
        - SWEP
        - TAXS
        - TOPG
        - TRAD
        - TREA
        - VATX
        - VOST
        - WHLD
        - ZABA
    CareOf:
      description: >-
        The 'care of' address is used whenever sending mail to a person or
        organisation who does not actually live or work at the address. They
        will receive the mail for the individual.
      type: string
      minLength: 1
      maxLength: 140
    CountryCode:
      description: Nation with its own government.
      type: string
      pattern: ^[A-Z]{2,2}$
    CountrySubDivision:
      description: Identifies a subdivision of a country such as state, region, county.
      type: string
      minLength: 1
      maxLength: 35
    DistrictName:
      description: >-
        Number that of the regional area, known as a district, which forms part
        of an address
      type: string
      minLength: 1
      maxLength: 140
    Department:
      description: Identification of a division of a large organisation or building.
      type: string
      minLength: 1
      maxLength: 70
    File:
      type: object
      additionalProperties: false
      properties: {}
    Floor:
      description: Number that identifies the level within a building
      type: string
      minLength: 1
      maxLength: 70
    ISODateTime:
      description: >-
        All dates in the JSON payloads are represented in ISO 8601 date-time
        format. 

        All date-time fields in responses must include the timezone. An example
        is below:

        2017-04-05T10:43:07+00:00
      type: string
      format: date-time
    Identification_0:
      description: >-
        Identification assigned by an institution to identify an account. This
        identification is known by the account owner.
      type: string
      minLength: 1
      maxLength: 256
    Identification_1:
      description: >-
        Unique and unambiguous identification of a financial institution or a
        branch of a financial institution.
      type: string
      minLength: 1
      maxLength: 35
    Identification_3:
      description: >-
        Identification of the organisation issuing the invoice, when it is different from the creditor or ultimate creditor
      type: string
      example: '80200112344562'
      minLength: 1
      maxLength: 256
    Identification_4:
      description: >-
        Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor.
      type: string
      example: '80200112344562'
      minLength: 1
      maxLength: 256
    LEI:
      description: >-
        Legal entity identification as an alternate identification for a party.
        Legal Entity Identifier is a code allocated to a party as described in
        ISO 17442 "Financial Services - Legal Entity Identifier (LEI)".
      type: string
      minLength: 1
      maxLength: 20
      pattern: ^[0-9]{4}[0]{2}[A-Z0-9]{12}[0-9]{2}
    Links:
      type: object
      additionalProperties: false
      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
      required:
        - Self
    Meta:
      title: MetaData
      type: object
      additionalProperties: false
      description: Meta Data relevant to the payload
      properties:
        TotalPages:
          type: integer
          format: int32
        FirstAvailableDateTime:
          $ref: '#/components/schemas/ISODateTime'
        LastAvailableDateTime:
          $ref: '#/components/schemas/ISODateTime'
    Name:
      description: >-
        Name by which an agent is known and which is usually used to identify
        that agent.
      type: string
      minLength: 1
      maxLength: 140
    OBActiveCurrencyAndAmount_SimpleType:
      description: >-
        A number of monetary units specified in an active currency where the
        unit of currency is explicit and compliant with ISO 4217.
      type: string
      pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$
    OBActiveOrHistoricCurrencyAndAmount:
      type: object
      additionalProperties: false
      required:
        - Amount
        - Currency
      description: Amount of money associated with the charge type.
      properties:
        Amount:
          $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType'
        Currency:
          $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
    OBAddressTypeCode:
      description: Identifies the nature of the postal address.
      type: string
      enum:
        - Business
        - Correspondence
        - DeliveryTo
        - MailTo
        - POBox
        - Postal
        - Residential
        - Statement
    OBAddressType2Code:
      description: >-
        Identifies the nature of the postal address. For a full set of codes see
        `OBAddressType2Code`
        [here](https://github.com/OpenBankingUK/External_Internal_CodeSets).
      type: string
      enum:
        - BIZZ
        - DLVY
        - MLTO
        - PBOX
        - ADDR
        - HOME
        - CORR
        - STAT
    OBBranchAndFinancialInstitutionIdentification6_0:
      type: object
      description: >-
        Party that manages the account on behalf of the account owner, that is
        manages the registration and booking of entries on the account,
        calculates balances on the account and provides information about the
        account.

        This is the servicer of the beneficiary account.
      properties:
        SchemeName:
          $ref: >-
            #/components/schemas/OBInternalFinancialInstitutionIdentification4Code
        Identification:
          $ref: '#/components/schemas/Identification_1'
        Name:
          $ref: '#/components/schemas/Name'
        PostalAddress:
          $ref: '#/components/schemas/OBPostalAddress7'
        LEI:
          $ref: '#/components/schemas/LEI'
    OBInternalChargeBearerType1Code:
      description: >-
        Specifies which party/parties will bear the charges associated with the
        processing of the payment transaction.
        For a full list of values refer to `OBInternalChargeBearerType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      type: string
      enum:
        - BorneByCreditor
        - BorneByDebtor
        - FollowingServiceLevel
        - Shared
    OBCashAccountCreditor3:
      type: object
      properties:
        SchemeName:
          $ref: '#/components/schemas/OBInternalAccountIdentification4Code'
        Identification:
          type: string
          description: >-
            Identification assigned by an institution to identify an account.
            This identification is known by the account owner.
          maxLength: 256
        Name:
          type: string
          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.
        SecondaryIdentification:
          type: string
          description: >-
            Secondary identification of the account, as assigned by the account
            servicing institution. This can be used by building societies to
            additionally identify accounts with a roll number (in addition to a
            sort code and account number combination).
          maxLength: 34
        LEI:
          $ref: '#/components/schemas/LEI'
        Proxy:
          $ref: '#/components/schemas/OBProxy1'
      required:
        - SchemeName
        - Identification
        - Name
    OBCashAccountDebtor4:
      type: object
      description: >-
        ^ Only included in the response if `Data. ReadRefundAccount` is set to
        `Yes` in the consent.
      properties:
        SchemeName:
          type: string
          description: >-
            ^ Name of the identification scheme, in a coded form as published in
            an external list. | Namespaced Enumeration
            OBInternalAccountIdentification4Code
        Identification:
          type: string
          description: >-
            ^ Identification assigned by an institution to identify an account.
            This identification is known by the account owner. | Max256Text
        Name:
          type: string
          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.
        SecondaryIdentification:
          type: string
          description: >-
            ^ This is secondary identification of the account, as assigned by
            the account servicing institution.  This can be used by building
            societies to additionally identify accounts with a roll number (in
            addition to a sort code and account number combination) | Max34Text
        LEI:
          $ref: '#/components/schemas/LEI'
    OBExternalMandateClassification1Code:
      type: string
      enum:
        - FIXE
        - USGB
        - VARI
    OBError1:
      type: object
      properties:
        ErrorCode:
          $ref: '#/components/schemas/OBInternalErrorResponseError1Code'
        Message:
          description: >-
            A description of the error that occurred. e.g., 'A mandatory field
            isn't supplied' or 'RequestedExecutionDateTime must be in future'

            OBL 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
      additionalProperties: false
      minProperties: 1
    OBErrorResponse1:
      description: >-
        An array of detail error codes, and messages, and URLs to documentation
        to help remediation.
      type: object
      additionalProperties: false
      properties:
        Id:
          description: >-
            A unique reference for the error instance, for audit purposes, in
            case of unknown/unclassified errors.
          type: string
          minLength: 1
          maxLength: 40
        Code:
          description: >-
            Deprecated <br>High level textual error code, to help categorise the
            errors.
          type: string
          minLength: 1
          example: 400 BadRequest
          maxLength: 40
        Message:
          description: Deprecated <br>Brief Error message
          type: string
          minLength: 1
          example: There is something wrong with the request parameters provided
          maxLength: 500
        Errors:
          items:
            $ref: '#/components/schemas/OBError1'
          type: array
          minItems: 1
      required:
        - Errors
    OBInternalAccountIdentification4Code:
      description: >-
        Name of the identification scheme, in a coded form as published in an
        external list.
        For a full list of values refer to `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      type: string
      x-namespaced-enum:
        - UK.OBIE.BBAN
        - UK.OBIE.IBAN
        - UK.OBIE.PAN
        - UK.OBIE.Paym
        - UK.OBIE.SortCodeAccountNumber
        - UK.OBIE.Wallet
    ExternalCreditorReferenceType1Code:
      type: string
      minLength: 1
      maxLength: 4
      description: "Specifies the type of creditor reference as published in an external creditor reference type code set. For more information see `ExternalCreditorReferenceType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)"
      enum:
        - DISP
        - FXDR
        - PUOR
        - RPIN
        - RADM
        - SCOR
    ExternalDocumentType1Code:
      type: string
      minLength: 1
      maxLength: 4
      description: >-
        Specifies the document type as published in an external document type
        code list. For more information see `ExternalDocumentType1Code` in *ISO_External_CodeSet*
        [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      enum:
        - CINV
        - CNFA
        - CONT
        - CREN
        - DEBN
        - DISP
        - DNFA
        - HIRI
        - INVS
        - MSIN
        - PROF
        - PUOR
        - QUOT
        - SBIN
        - SPRR
        - TISH
    OBInternalFinancialInstitutionIdentification4Code:
      description: >-
        Name of the identification scheme, in a coded form as published in an
        external list.
      type: string
      x-namespaced-enum:
        - UK.OBIE.BICFI
    OBInternalExtendedAccountType1Code:
      description: Specifies the extended type of account.
      type: string
      enum:
        - Business
        - BusinessSavingsAccount
        - Charity
        - Collection
        - Corporate
        - Ewallet
        - Government
        - Investment
        - ISA
        - JointPersonal
        - Pension
        - Personal
        - PersonalSavingsAccount
        - Premier
        - Wealth
    OBInternalLocalInstrument1Code:
      description: >-
        User community specific instrument.

        Usage: This element is used to specify a local instrument, local
        clearing option and/or further qualify the service or service level.
        For a full list of values refer to `OBInternalLocalInstrument1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      type: string
      x-namespaced-enum:
        - UK.OBIE.BACS
        - UK.OBIE.BalanceTransfer
        - UK.OBIE.CHAPS
        - UK.OBIE.Euro1
        - UK.OBIE.FPS
        - UK.OBIE.Link
        - UK.OBIE.MoneyTransfer
        - UK.OBIE.Paym
        - UK.OBIE.SEPACreditTransfer
        - UK.OBIE.SEPAInstantCreditTransfer
        - UK.OBIE.SWIFT
        - UK.OBIE.Target2
    OBInternalPaymentChargeType1Code:
      description: Charge type, in a coded form. For a full list of values refer to `OBInternalPaymentChargeType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      type: string
      x-namespaced-enum:
        - UK.OBIE.CHAPSOut
    ExternalPurpose1Code:
      type: string
      minLength: 1
      maxLength: 4
      description: >-
        This is a partial list, For a full list see `ExternalPurpose1Code`
        [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      enum:
        - BKDF
        - BKFE
        - BKFM
        - BKIP
        - BKPP
        - CBLK
        - CDCB
        - CDCD
        - CDCS
        - CDDP
        - CDOC
        - CDQC
        - ETUP
        - FCOL
        - MTUP
        - ACCT
        - CASH
        - COLL
        - CSDB
        - DEPT
        - INTC
        - INTP
        - LIMA
        - NETT
        - BFWD
        - CCIR
        - CCPC
        - CCPM
        - CCSM
        - CRDS
        - CRPR
        - CRSP
        - CRTL
        - EQPT
        - EQUS
        - EXPT
        - EXTD
        - FIXI
        - FWBC
        - FWCC
        - FWSB
        - FWSC
        - MARG
        - MBSB
        - MBSC
        - MGCC
        - MGSC
        - OCCC
        - OPBC
        - OPCC
        - OPSB
        - OPSC
        - OPTN
        - OTCD
        - REPO
        - RPBC
        - RPCC
        - RPSB
        - RPSC
        - RVPO
        - SBSC
        - SCIE
        - SCIR
        - SCRP
        - SHBC
        - SHCC
        - SHSL
        - SLEB
        - SLOA
        - SWBC
        - SWCC
        - SWPT
        - SWSB
        - SWSC
        - TBAS
        - TBBC
        - TBCC
        - TRCP
        - AGRT
        - AREN
        - BEXP
        - BOCE
        - COMC
        - CPYR
        - GDDS
        - GDSV
        - GSCB
        - LICF
        - MP2B
        - POPE
        - ROYA
        - SCVE
        - SERV
        - SUBS
        - SUPP
        - TRAD
        - CHAR
        - COMT
        - MP2P
        - ECPG
        - ECPR
        - ECPU
        - EPAY
        - CLPR
        - COMP
        - DBTC
        - GOVI
        - HLRP
        - HLST
        - INPC
        - INPR
        - INSC
        - INSU
        - INTE
        - LBRI
        - LIFI
        - LOAN
        - LOAR
        - PENO
        - PPTI
        - RELG
        - RINP
        - TRFD
        - FORW
        - FXNT
        - ADMG
        - ADVA
        - BCDM
        - BCFG
        - BLDM
        - BNET
        - CBFF
        - CBFR
        - CCRD
        - CDBL
        - CFEE
        - CGDD
        - CORT
        - COST
        - CPKC
        - DCRD
        - DSMT
        - DVPM
        - EDUC
        - FACT
        - FAND
        - FCPM
        - FEES
        - GIFT
        - GOVT
        - ICCP
        - IDCP
        - IHRP
        - INSM
        - IVPT
        - MCDM
        - MCFG
        - MSVC
        - NOWS
        - OCDM
        - OCFG
        - OFEE
        - OTHR
        - PADD
        - PTSP
        - RCKE
        - RCPT
        - REBT
        - REFU
        - RENT
        - REOD
        - RIMB
        - RPNT
        - RRBN
        - RRCT
        - RRTP
        - RVPM
        - SLPI
        - SPLT
        - STDY
        - TBAN
        - TBIL
        - TCSC
        - TELI
        - TMPG
        - TPRI
        - TPRP
        - TRNC
        - TRVC
        - WEBI
        - IPAY
        - IPCA
        - IPDO
        - IPEA
        - IPEC
        - IPEW
        - IPPS
        - IPRT
        - IPU2
        - IPUW
        - ANNI
        - CAFI
        - CFDI
        - CMDT
        - DERI
        - DIVD
        - FREX
        - HEDG
        - INVS
        - PRME
        - SAVG
        - SECU
        - SEPI
        - TREA
        - UNIT
        - FNET
        - FUTR
        - ANTS
        - CVCF
        - DMEQ
        - DNTS
        - HLTC
        - HLTI
        - HSPC
        - ICRF
        - LTCF
        - MAFC
        - MARF
        - MDCS
        - VIEW
        - CDEP
        - SWFP
        - SWPP
        - SWRS
        - SWUF
        - ADCS
        - AEMP
        - ALLW
        - ALMY
        - BBSC
        - BECH
        - BENE
        - BONU
        - CCHD
        - COMM
        - CSLP
        - GFRP
        - GVEA
        - GVEB
        - GVEC
        - GVED
        - GWLT
        - HREC
        - PAYR
        - PEFC
        - PENS
        - PRCP
        - RHBS
        - SALA
        - SPSP
        - SSBE
        - LBIN
        - LCOL
        - LFEE
        - LMEQ
        - LMFI
        - LMRK
        - LREB
        - LREV
        - LSFL
        - ESTX
        - FWLV
        - GSTX
        - HSTX
        - INTX
        - NITX
        - PTXP
        - RDTX
        - TAXS
        - VATX
        - WHLD
        - TAXR
        - B112
        - BR12
        - TLRF
        - TLRR
        - AIRB
        - BUSB
        - FERB
        - RLWY
        - TRPT
        - CBTV
        - ELEC
        - ENRG
        - GASB
        - NWCH
        - NWCM
        - OTLC
        - PHON
        - UBIL
        - WTER
        - BOND
        - CABD
        - CAEQ
        - CBCR
        - DBCR
        - DICL
        - EQTS
        - FLCR
        - EFTC
        - EFTD
        - MOMA
        - RAPI
        - GAMB
        - LOTT
        - AMEX
        - SASW
        - AUCO
        - PCOM
        - PDEP
        - PLDS
        - PLRF
        - GAFA
        - GAHO
        - CPEN
        - DEPD
        - RETL
        - DEBT
    OBInternalErrorResponseError1Code:
      description: >-
        Low level textual error code, for all enum values see
        `OBInternalErrorResponseError1Code`
        [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      type: string
      minLength: 4
      maxLength: 4
      example: U001
    OBFrequency6Code:
      description: '`OBFrequency6Code` on External Codset Repo'
      type: string
      enum:
        - ADHO
        - YEAR
        - DAIL
        - FRTN
        - INDA
        - MNTH
        - QURT
        - MIAN
        - WEEK
    OBMandateRelatedInformation1:
      type: object
      required:
        - Frequency
      properties:
        MandateIdentification:
          $ref: '#/components/schemas/Identification_1'
        Classification:
          $ref: '#/components/schemas/OBExternalMandateClassification1Code'
        CategoryPurposeCode:
          $ref: '#/components/schemas/ExternalCategoryPurpose1Code'
        FirstPaymentDateTime:
          type: string
          format: date-time
        RecurringPaymentDateTime:
          description: >-
            The date on which the first recurring payment for a Standing Order
            schedule will be made. 

            Usage: This must be populated only if the first recurring date is
            different to the first payment date. All dates in the JSON payloads
            are represented in ISO 8601 date-time format. 

            All date-time fields in responses must include the timezone. An
            example is below:

            2017-04-05T10:43:07+00:00
          type: string
          format: date-time
        FinalPaymentDateTime:
          type: string
          format: date-time
        Frequency:
          $ref: '#/components/schemas/OBFrequency6'
        Reason:
          description: >-
            Reason for the direct debit mandate to allow the user to distinguish
            between different mandates for the same creditor.
          type: string
          maxLength: 256
          minLength: 1
    OBPaymentStatusReason:
      type: object
      properties:
        StatusReasonCode:
          type: string
          description: |-
            Specifies the status reason in a code form 
             For more information and enum values see `OBExternalStatusReason1Code [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
          minLength: 1
          maxLength: 4
          example: ERIN
        StatusReasonDescription:
          type: string
          description: Description supporting the StatusReasonCode.
          minLength: 1
          maxLength: 500
        Path:
          type: string
          description: >-
            Recommended but optional reference to the JSON Path of the field
            with error, e.g., Data.Initiation.InstructedAmount.Currency
          minLength: 1
          maxLength: 500
    OBProxy1:
      description: >-
        Specifies an alternate assumed name for the identification of the
        account.
      type: object
      required:
        - Identification
        - Code
      properties:
        Identification:
          description: >-
            Identification used to indicate the account identification under
            another specified name.
          type: string
          minLength: 1
          maxLength: 2048
        Code:
          $ref: '#/components/schemas/ExternalProxyAccountType1Code'
        Type:
          type: string
          description: Type of the proxy identification.
          minLength: 1
          maxLength: 35
    ExternalProxyAccountType1Code:
      description: >-
        Specifies the external proxy account type code, as published in the
        proxy account type external code set.<br /> For a full list of values see `ExternalProxyAccountType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      type: string
      enum:
        - TELE
        - EMAL
        - DNAM
        - CINC
        - COTX
        - COID
        - CUST
        - DRLC
        - EIDN
        - EWAL
        - PVTX
        - LEIC
        - MBNO
        - NIDN
        - CCPT
        - SHID
        - SOSE
        - TOKN
        - UBIL
        - VIPN
        - BIID
    OBPostalAddress7:
      type: object
      additionalProperties: false
      description: >-
        Information that locates and identifies a specific address, as defined
        by postal services.
      properties:
        AddressType:
          $ref: '#/components/schemas/OBAddressType2Code'
        Department:
          $ref: '#/components/schemas/Department'
        SubDepartment:
          $ref: '#/components/schemas/SubDepartment'
        StreetName:
          $ref: '#/components/schemas/StreetName'
        BuildingNumber:
          $ref: '#/components/schemas/BuildingNumber'
        BuildingName:
          $ref: '#/components/schemas/BuildingName'
        Floor:
          $ref: '#/components/schemas/Floor'
        UnitNumber:
          $ref: '#/components/schemas/UnitNumber'
        Room:
          $ref: '#/components/schemas/Room'
        PostBox:
          $ref: '#/components/schemas/PostBox'
        TownLocationName:
          $ref: '#/components/schemas/TownName'
        DistrictName:
          $ref: '#/components/schemas/DistrictName'
        CareOf:
          $ref: '#/components/schemas/CareOf'
        PostCode:
          $ref: '#/components/schemas/PostCode'
        TownName:
          $ref: '#/components/schemas/TownName'
        CountrySubDivision:
          $ref: '#/components/schemas/CountrySubDivision'
        Country:
          $ref: '#/components/schemas/CountryCode'
        AddressLine:
          type: array
          items:
            description: >-
              Information that locates and identifies a specific address, as
              defined by postal services, presented in free format text.
            type: string
            minLength: 1
            maxLength: 70
          minItems: 0
          maxItems: 7
    OBReferredDocumentInformation:
      type: object
      properties:
        Code:
          $ref: '#/components/schemas/ExternalDocumentType1Code'
        Issuer:
          description: 'Identification of the issuer of the reference document type.'
          type: string
          maxLength: 35
          minLength: 1
        Number:
          description: 'Identification of the type specified for the referred document line.'
          type: string
          maxLength: 35
          minLength: 1
        RelatedDate:
          description: 'Date associated with the referred document line.'
          type: string
          format: date-time
        LineDetails:
          description: 'Set of elements used to provide the content of the referred document line.'
          type: array
          items:
            type: string
    OBRemittanceInformation2:
      type: object
      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
      properties:
        Structured:
          type: array
          items:
            $ref: '#/components/schemas/OBRemittanceInformationStructured'
        Unstructured:
          type: array
          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.
          items:
            type: string
            maxLength: 140
            minLength: 1
    OBRemittanceInformationStructured:
      type: object
      properties:
        ReferredDocumentInformation:
          type: array
          items:
            $ref: '#/components/schemas/OBReferredDocumentInformation'
        ReferredDocumentAmount:
          description: 'Provides details on the amounts of the referred document.'
          type: integer
          format: int32
        CreditorReferenceInformation:
          description: 'Reference information provided by the creditor to allow the identification of the underlying documents.'
          type: object
          properties:
            Code:
              $ref: '#/components/schemas/ExternalCreditorReferenceType1Code'
            Issuer:
              description: 'Entity that assigns the identification.'
              type: string
              minLength: 1
              maxLength: 35
            Reference:
              description: 'Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.'
              type: string
              minLength: 1
              maxLength: 35
        Invoicer:
          $ref: '#/components/schemas/Identification_3'
        Invoicee:
          $ref: '#/components/schemas/Identification_4'
        TaxRemittance:
          description: 'Provides remittance information about a payment made for tax-related purposes.'
          type: string
          maxLength: 140
          minLength: 1
        AdditionalRemittanceInformation:
          description: 'Additional information, in free text form, to complement the structured remittance information.'
          type: array
          items:
            type: string
            maxLength: 140
            minLength: 1
          maxItems: 3
    OBRegulatoryAuthority2:
      type: object
      description: 'Entity requiring the regulatory reporting information. '
      properties:
        Name:
          type: string
          description: Name of the entity requiring the regulatory reporting information.
          minLength: 1
          maxLength: 140
        CountryCode:
          $ref: '#/components/schemas/CountryCode'
    OBRegulatoryReporting1:
      type: object
      description: Information needed due to regulatory and statutory requirements
      properties:
        DebitCreditReportingIndicator:
          type: string
          description: >-
            Identifies whether the regulatory reporting information applies to
            the debit side, to the credit side or to both debit and credit sides
            of the transaction. 
            For a full list of values reefer to `OBExternalRegulatoryReportingType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
          enum:
            - CRED
            - DEBT
            - BOTH
        Authority:
          $ref: '#/components/schemas/OBRegulatoryAuthority2'
        Details:
          type: array
          items:
            $ref: '#/components/schemas/OBStructuredRegulatoryReporting3'
    OBRisk1:
      type: object
      additionalProperties: false
      properties:
        PaymentContextCode:
          type: string
          description: |
            Specifies the payment context, `OBInternalPaymentContext1Code`
          enum:
            - BillingGoodsAndServicesInAdvance
            - BillingGoodsAndServicesInArrears
            - EcommerceMerchantInitiatedPayment
            - FaceToFacePointOfSale
            - TransferToSelf
            - TransferToThirdParty
        MerchantCategoryCode:
          type: string
          minLength: 3
          maxLength: 4
          description: >-
            Category code conform to ISO 18245, related to the type of services
            or goods the merchant provides for the transaction.
        MerchantCustomerIdentification:
          type: string
          minLength: 1
          maxLength: 70
          description: The unique customer identifier of the PSU with the merchant.
        ContractPresentIndicator:
          type: boolean
          description: Indicates if Payee has a contractual relationship with the PISP.
        BeneficiaryPrepopulatedIndicator:
          type: boolean
          description: >-
            Indicates if PISP has immutably prepopulated payment details in for
            the PSU.
        PaymentPurposeCode:
          $ref: '#/components/schemas/ExternalPurpose1Code'
        CategoryPurposeCode:
          $ref: '#/components/schemas/ExternalCategoryPurpose1Code'
        BeneficiaryAccountType:
          $ref: '#/components/schemas/OBInternalExtendedAccountType1Code'
        DeliveryAddress:
          $ref: '#/components/schemas/OBPostalAddress7'
      description: |-
        The Risk section is sent by the initiating party to the ASPSP.
        It is used to specify additional details for risk scoring for Payments.
    OBSCASupportData1:
      type: object
      properties:
        RequestedSCAExemptionType:
          type: string
          description: >-
            This field allows a PISP to request specific SCA Exemption for a
            Payment Initiation. For a full list of values reefer to `OBInternalSCAExemptionType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
          enum:
            - BillPayment
            - ContactlessTravel
            - EcommerceGoods
            - EcommerceServices
            - Kiosk
            - Parking
            - PartyToParty
        AppliedAuthenticationApproach:
          type: string
          maxLength: 40
          description: >-
            Specifies a character string with a maximum length of 40 characters.

            Usage: This field indicates whether the PSU was subject to SCA
            performed by the TPP

            For a full list of values refer to `OBInternalAppliedAuthenticationApproach1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
          enum:
            - CA
            - SCA
        ReferencePaymentOrderId:
          type: string
          maxLength: 40
          minLength: 1
          description: >-
            If the payment is recurring, then this field is populated with the
            transaction identifier of the previous payment occurrence so that
            the ASPSP can verify that the PISP, amount and the payee are the
            same as the previous occurrence. The value here refers to the
            payment id e.g. DomesticPaymentId  
      description: Supporting Data provided by TPP, when requesting SCA Exemption.
    OBStatusReason:
      type: object
      properties:
        StatusReasonCode:
          type: string
          description: |-
            Specifies the status reason in a code form. 
            For a full list of values refer to `OBExternalStatusReason1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
          minLength: 1
          maxLength: 4
          example: ERIN
        StatusReasonDescription:
          description: Description supporting the StatusReasonCode.
          type: string
          minLength: 1
          maxLength: 500
        Path:
          type: string
          description: >-
            Path is optional but relevant when the status reason refers to an object/field and hence conditional to provide JSON path.
          minLength: 1
          maxLength: 500
    OBStructuredRegulatoryReporting3:
      type: object
      description: >-
        Set of elements used to provide details on the regulatory reporting
        information.
      properties:
        Type:
          type: string
          description: >-
            Specifies the type of the information supplied in the regulatory
            reporting details
          minLength: 1
          maxLength: 35
        Date:
          $ref: '#/components/schemas/ISODateTime'
        Country:
          $ref: '#/components/schemas/CountryCode'
        Amount:
          $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount'
        Information:
          description: >-
            Additional details that cater for specific domestic regulatory
            requirements. 
          type: array
          items:
            type: string
            minLength: 1
            maxLength: 35
    OBSupplementaryData1:
      type: object
      properties: {}
      additionalProperties: true
      description: >-
        Additional information that can not be captured in the structured fields
        and/or any other specific block.
    OBWriteDomestic2:
      type: object
      additionalProperties: false
      required:
        - Data
        - Risk
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
            - ConsentId
            - Initiation
          properties:
            ConsentId:
              description: >-
                OB: Unique identification as assigned by the ASPSP to uniquely
                identify the consent resource.
              type: string
              minLength: 1
              maxLength: 128
            Initiation:
              type: object
              additionalProperties: false
              required:
                - InstructionIdentification
                - EndToEndIdentification
                - InstructedAmount
                - CreditorAccount
              description: >-
                The Initiation payload is sent by the initiating party to the
                ASPSP. It is used to request movement of funds from the debtor
                account to a creditor for a single domestic payment.
              properties:
                InstructionIdentification:
                  description: >-
                    Unique identification as assigned by an instructing party
                    for an instructed party to unambiguously identify the
                    instruction.

                    Usage: the  instruction identification is a point to point
                    reference that can be used between the instructing party and
                    the instructed party to refer to the individual instruction.
                    It can be included in several messages related to the
                    instruction.
                  type: string
                  minLength: 1
                  maxLength: 35
                EndToEndIdentification:
                  description: >-
                    Unique identification assigned by the initiating party to
                    unambiguously identify the transaction. This identification
                    is passed on, unchanged, throughout the entire end-to-end
                    chain.

                    Usage: The end-to-end identification can be used for
                    reconciliation or to link tasks relating to the transaction.
                    It can be included in several messages related to the
                    transaction.

                    OB: The Faster Payments Scheme can only access 31 characters
                    for the EndToEndIdentification field.
                  type: string
                  minLength: 1
                  maxLength: 35
                LocalInstrument:
                  $ref: '#/components/schemas/OBInternalLocalInstrument1Code'
                InstructedAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: >-
                    Amount of money to be moved between the debtor and creditor,
                    before deduction of charges, expressed in the currency as
                    ordered by the initiating party.

                    Usage: This amount has to be transported unchanged through
                    the transaction chain.
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                DebtorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                  description: >-
                    Unambiguous identification of the account of the debtor to
                    which a debit entry will be made as a result of the
                    transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level, as displayed
                        by the ASPSP's online channels.

                        Note, the account name is not the product name or the
                        nickname of the account.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                CreditorAgent:
                  type: object
                  additionalProperties: false
                  description: Financial institution servicing an account for the creditor.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalFinancialInstitutionIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_1'
                    Name:
                      $ref: '#/components/schemas/Name'
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                CreditorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: >-
                    Unambiguous identification of the account of the creditor to
                    which a credit entry will be posted as a result of the
                    payment transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level.

                        Note, the account name is not the product name or the
                        nickname of the account.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                CreditorPostalAddress:
                  $ref: '#/components/schemas/OBPostalAddress7'
                UltimateCreditor:
                  $ref: '#/components/schemas/OBUltimateCreditor1'
                UltimateDebtor:
                  $ref: '#/components/schemas/OBUltimateDebtor1'
                RegulatoryReporting:
                  type: array
                  items:
                    $ref: '#/components/schemas/OBRegulatoryReporting1'
                  maxItems: 10
                RemittanceInformation:
                  $ref: '#/components/schemas/OBRemittanceInformation2'
                SupplementaryData:
                  $ref: '#/components/schemas/OBSupplementaryData1'
        Risk:
          $ref: '#/components/schemas/OBRisk1'
    OBWriteDomesticConsent4:
      type: object
      additionalProperties: false
      required:
        - Data
        - Risk
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
            - Initiation
          properties:
            ReadRefundAccount:
              description: Specifies to share the refund account details with PISP. For a full set of values refer to `OBInternalReadRefundAccount1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
              type: string
              enum:
                - 'No'
                - 'Yes'
            Initiation:
              type: object
              additionalProperties: false
              required:
                - InstructionIdentification
                - EndToEndIdentification
                - InstructedAmount
                - CreditorAccount
              description: >-
                The Initiation payload is sent by the initiating party to the
                ASPSP. It is used to request movement of funds from the debtor
                account to a creditor for a single domestic payment.
              properties:
                InstructionIdentification:
                  description: >-
                    Unique identification as assigned by an instructing party
                    for an instructed party to unambiguously identify the
                    instruction.

                    Usage: the  instruction identification is a point to point
                    reference that can be used between the instructing party and
                    the instructed party to refer to the individual instruction.
                    It can be included in several messages related to the
                    instruction.
                  type: string
                  minLength: 1
                  maxLength: 35
                EndToEndIdentification:
                  description: >-
                    Unique identification assigned by the initiating party to
                    unambiguously identify the transaction. This identification
                    is passed on, unchanged, throughout the entire end-to-end
                    chain.

                    Usage: The end-to-end identification can be used for
                    reconciliation or to link tasks relating to the transaction.
                    It can be included in several messages related to the
                    transaction.

                    OB: The Faster Payments Scheme can only access 31 characters
                    for the EndToEndIdentification field.
                  type: string
                  minLength: 1
                  maxLength: 35
                LocalInstrument:
                  $ref: '#/components/schemas/OBInternalLocalInstrument1Code'
                InstructedAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: >-
                    Amount of money to be moved between the debtor and creditor,
                    before deduction of charges, expressed in the currency as
                    ordered by the initiating party.

                    Usage: This amount has to be transported unchanged through
                    the transaction chain.
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                DebtorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                  description: >-
                    Unambiguous identification of the account of the debtor to
                    which a debit entry will be made as a result of the
                    transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level, as displayed
                        by the ASPSP's online channels.

                        Note, the account name is not the product name or the
                        nickname of the account.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                CreditorAgent:
                  type: object
                  additionalProperties: false
                  description: Financial institution servicing an account for the creditor.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalFinancialInstitutionIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_1'
                    Name:
                      $ref: '#/components/schemas/Name'
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                CreditorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: >-
                    Unambiguous identification of the account of the creditor to
                    which a credit entry will be posted as a result of the
                    payment transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level.

                        Note, the account name is not the product name or the
                        nickname of the account.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                CreditorPostalAddress:
                  $ref: '#/components/schemas/OBPostalAddress7'
                UltimateCreditor:
                  $ref: '#/components/schemas/OBUltimateCreditor1'
                UltimateDebtor:
                  $ref: '#/components/schemas/OBUltimateDebtor1'
                RegulatoryReporting:
                  type: array
                  items:
                    $ref: '#/components/schemas/OBRegulatoryReporting1'
                  maxItems: 10
                RemittanceInformation:
                  $ref: '#/components/schemas/OBRemittanceInformation2'
                SupplementaryData:
                  $ref: '#/components/schemas/OBSupplementaryData1'
            Authorisation:
              type: object
              additionalProperties: false
              required:
                - AuthorisationType
              description: The authorisation type request from the TPP.
              properties:
                AuthorisationType:
                  description: Type of authorisation flow requested. For a full set of values refer to `OBInternalAuthorisation1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
                  type: string
                  enum:
                    - Any
                    - Single
                CompletionDateTime:
                  description: >-
                    Date and time at which the requested authorisation flow must
                    be completed. All dates in the JSON payloads are represented
                    in ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
            SCASupportData:
              $ref: '#/components/schemas/OBSCASupportData1'
        Risk:
          $ref: '#/components/schemas/OBRisk1'
    OBWriteDomesticConsentResponse5:
      type: object
      additionalProperties: false
      required:
        - Data
        - Risk
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
            - ConsentId
            - CreationDateTime
            - Status
            - StatusUpdateDateTime
            - Initiation
          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. All dates in the
                JSON payloads are represented in ISO 8601 date-time format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            Status:
              description: >- 
                Specifies the status of consent resource in code form.
                For a full list of values refer to `OBInternalConsentStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
              type: string
              enum:
                - AWAU
                - RJCT
                - AUTH
                - COND
            StatusReason:
              type: array
              items:
                $ref: '#/components/schemas/OBStatusReason'
            StatusUpdateDateTime:
              description: >-
                Date and time at which the resource status was updated. All dates
                in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            ReadRefundAccount:
              description: >- 
                Specifies to share the refund account details with PISP.
                For a full list of values refer to `OBInternalReadRefundAccount1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
              type: string
              enum:
                - 'No'
                - 'Yes'
            CutOffDateTime:
              description: >-
                Specified cut-off date and time for the payment consent. All
                dates in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            ExpectedExecutionDateTime:
              description: >-
                Expected execution date and time for the payment resource. All
                dates in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            ExpectedSettlementDateTime:
              description: >-
                Expected settlement date and time for the payment resource. All
                dates in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            Charges:
              type: array
              items:
                type: object
                additionalProperties: false
                description: >-
                  Set of elements used to provide details of a charge for the
                  payment initiation.
                required:
                  - ChargeBearer
                  - Type
                  - Amount
                properties:
                  ChargeBearer:
                    $ref: '#/components/schemas/OBInternalChargeBearerType1Code'
                  Type:
                    $ref: '#/components/schemas/OBInternalPaymentChargeType1Code'
                  Amount:
                    $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount'
            Initiation:
              type: object
              additionalProperties: false
              required:
                - InstructionIdentification
                - EndToEndIdentification
                - InstructedAmount
                - CreditorAccount
              description: >-
                The Initiation payload is sent by the initiating party to the
                ASPSP. It is used to request movement of funds from the debtor
                account to a creditor for a single domestic payment.
              properties:
                InstructionIdentification:
                  description: >-
                    Unique identification as assigned by an instructing party
                    for an instructed party to unambiguously identify the
                    instruction.

                    Usage: the  instruction identification is a point to point
                    reference that can be used between the instructing party and
                    the instructed party to refer to the individual instruction.
                    It can be included in several messages related to the
                    instruction.
                  type: string
                  minLength: 1
                  maxLength: 35
                EndToEndIdentification:
                  description: >-
                    Unique identification assigned by the initiating party to
                    unambiguously identify the transaction. This identification
                    is passed on, unchanged, throughout the entire end-to-end
                    chain.

                    Usage: The end-to-end identification can be used for
                    reconciliation or to link tasks relating to the transaction.
                    It can be included in several messages related to the
                    transaction.

                    OB: The Faster Payments Scheme can only access 31 characters
                    for the EndToEndIdentification field.
                  type: string
                  minLength: 1
                  maxLength: 35
                LocalInstrument:
                  $ref: '#/components/schemas/OBInternalLocalInstrument1Code'
                InstructedAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: >-
                    Amount of money to be moved between the debtor and creditor,
                    before deduction of charges, expressed in the currency as
                    ordered by the initiating party.

                    Usage: This amount has to be transported unchanged through
                    the transaction chain.
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                DebtorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                  description: >-
                    Unambiguous identification of the account of the debtor to
                    which a debit entry will be made as a result of the
                    transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level, as displayed
                        by the ASPSP's online channels.

                        Note, the account name is not the product name or the
                        nickname of the account.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                CreditorAgent:
                  type: object
                  additionalProperties: false
                  description: Financial institution servicing an account for the creditor.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalFinancialInstitutionIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_1'
                    Name:
                      $ref: '#/components/schemas/Name'
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                CreditorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: >-
                    Unambiguous identification of the account of the creditor to
                    which a credit entry will be posted as a result of the
                    payment transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level.

                        Note, the account name is not the product name or the
                        nickname of the account.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                CreditorPostalAddress:
                  $ref: '#/components/schemas/OBPostalAddress7'
                UltimateCreditor:
                  $ref: '#/components/schemas/OBUltimateCreditor1'
                UltimateDebtor:
                  $ref: '#/components/schemas/OBUltimateDebtor1'
                RegulatoryReporting:
                  type: array
                  items:
                    $ref: '#/components/schemas/OBRegulatoryReporting1'
                  maxItems: 10
                RemittanceInformation:
                  $ref: '#/components/schemas/OBRemittanceInformation2'
                SupplementaryData:
                  $ref: '#/components/schemas/OBSupplementaryData1'
            Authorisation:
              type: object
              additionalProperties: false
              required:
                - AuthorisationType
              description: The authorisation type request from the TPP.
              properties:
                AuthorisationType:
                  description: Type of authorisation flow requested. For a full list of values refer to `OBInternalAuthorisation1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
                  type: string
                  enum:
                    - Any
                    - Single
                CompletionDateTime:
                  description: >-
                    Date and time at which the requested authorisation flow must
                    be completed. All dates in the JSON payloads are represented
                    in ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
            SCASupportData:
              $ref: '#/components/schemas/OBSCASupportData1'
            Debtor:
              $ref: '#/components/schemas/OBCashAccountDebtor4'
        Risk:
          $ref: '#/components/schemas/OBRisk1'
        Links:
          $ref: '#/components/schemas/Links'
        Meta:
          $ref: '#/components/schemas/Meta'
    OBWriteDomesticResponse5:
      type: object
      additionalProperties: false
      required:
        - Data
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
            - DomesticPaymentId
            - ConsentId
            - CreationDateTime
            - Status
            - StatusUpdateDateTime
            - Initiation
          properties:
            DomesticPaymentId:
              description: >-
                OB: Unique identification as assigned by the ASPSP to uniquely
                identify the domestic 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. All dates in the
                JSON payloads are represented in ISO 8601 date-time format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            Status:
              description: >- 
                Specifies the status of the payment information group.
                For a full list of values refer to `ExternalPaymentTransactionStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
              type: string
              enum:
                - RCVD
                - PDNG
                - ACTC
                - PATC
                - ACCP
                - ACFC
                - ACSP
                - ACWC
                - ACSC
                - ACWP
                - ACCC
                - BLCK
                - RJCT
            StatusUpdateDateTime:
              description: >-
                Date and time at which the resource status was updated. All dates
                in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            StatusReason:
              type: array
              items:
                $ref: '#/components/schemas/OBStatusReason'
            ExpectedExecutionDateTime:
              description: >-
                Expected execution date and time for the payment resource. All
                dates in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            ExpectedSettlementDateTime:
              description: >-
                Expected settlement date and time for the payment resource. All
                dates in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            Refund:
              type: object
              additionalProperties: false
              required:
                - Account
              description: >-
                Unambiguous identification of the refund account to which a
                refund will be made as a result of the transaction.
              properties:
                Account:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: Provides the details to identify an account.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    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.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
            Charges:
              type: array
              items:
                type: object
                additionalProperties: false
                description: >-
                  Set of elements used to provide details of a charge for the
                  payment initiation.
                required:
                  - ChargeBearer
                  - Type
                  - Amount
                properties:
                  ChargeBearer:
                    $ref: '#/components/schemas/OBInternalChargeBearerType1Code'
                  Type:
                    $ref: '#/components/schemas/OBInternalPaymentChargeType1Code'
                  Amount:
                    $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount'
            Initiation:
              type: object
              additionalProperties: false
              required:
                - InstructionIdentification
                - EndToEndIdentification
                - InstructedAmount
                - CreditorAccount
              description: >-
                The Initiation payload is sent by the initiating party to the
                ASPSP. It is used to request movement of funds from the debtor
                account to a creditor for a single domestic payment.
              properties:
                InstructionIdentification:
                  description: >-
                    Unique identification as assigned by an instructing party
                    for an instructed party to unambiguously identify the
                    instruction.

                    Usage: the  instruction identification is a point to point
                    reference that can be used between the instructing party and
                    the instructed party to refer to the individual instruction.
                    It can be included in several messages related to the
                    instruction.
                  type: string
                  minLength: 1
                  maxLength: 35
                EndToEndIdentification:
                  description: >-
                    Unique identification assigned by the initiating party to
                    unambiguously identify the transaction. This identification
                    is passed on, unchanged, throughout the entire end-to-end
                    chain.

                    Usage: The end-to-end identification can be used for
                    reconciliation or to link tasks relating to the transaction.
                    It can be included in several messages related to the
                    transaction.

                    OB: The Faster Payments Scheme can only access 31 characters
                    for the EndToEndIdentification field.
                  type: string
                  minLength: 1
                  maxLength: 35
                LocalInstrument:
                  $ref: '#/components/schemas/OBInternalLocalInstrument1Code'
                InstructedAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: >-
                    Amount of money to be moved between the debtor and creditor,
                    before deduction of charges, expressed in the currency as
                    ordered by the initiating party.

                    Usage: This amount has to be transported unchanged through
                    the transaction chain.
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                DebtorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                  description: >-
                    Unambiguous identification of the account of the debtor to
                    which a debit entry will be made as a result of the
                    transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level, as displayed
                        by the ASPSP's online channels.

                        Note, the account name is not the product name or the
                        nickname of the account.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                CreditorAgent:
                  type: object
                  additionalProperties: false
                  description: Financial institution servicing an account for the creditor.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalFinancialInstitutionIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_1'
                    Name:
                      $ref: '#/components/schemas/Name'
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                CreditorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: >-
                    Unambiguous identification of the account of the creditor to
                    which a credit entry will be posted as a result of the
                    payment transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level.

                        Note, the account name is not the product name or the
                        nickname of the account.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                CreditorPostalAddress:
                  $ref: '#/components/schemas/OBPostalAddress7'
                UltimateCreditor:
                  $ref: '#/components/schemas/OBUltimateCreditor1'
                UltimateDebtor:
                  $ref: '#/components/schemas/OBUltimateDebtor1'
                RegulatoryReporting:
                  type: array
                  items:
                    $ref: '#/components/schemas/OBRegulatoryReporting1'
                  maxItems: 10
                RemittanceInformation:
                  $ref: '#/components/schemas/OBRemittanceInformation2'
                SupplementaryData:
                  $ref: '#/components/schemas/OBSupplementaryData1'
            MultiAuthorisation:
              type: object
              additionalProperties: false
              required:
                - Status
              description: The multiple authorisation flow response from the ASPSP.
              properties:
                Status:
                  description: Specifies the status of the authorisation flow in code form. For a full list of values refer to `OBInternalStatus2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
                  type: string
                  enum:
                    - AUTH
                    - AWAU
                    - RJCT
                NumberRequired:
                  description: >-
                    Number of authorisations required for payment order (total
                    required at the start of the multi authorisation journey).
                  type: integer
                NumberReceived:
                  description: Number of authorisations received.
                  type: integer
                LastUpdateDateTime:
                  description: >-
                    Last date and time at the authorisation flow was updated. All
                    dates in the JSON payloads are represented in ISO 8601
                    date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-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. All dates in the JSON payloads are represented
                    in ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
            Debtor:
              $ref: '#/components/schemas/OBCashAccountDebtor4'
        Links:
          $ref: '#/components/schemas/Links'
        Meta:
          $ref: '#/components/schemas/Meta'
    OBWriteDomesticScheduled2:
      type: object
      additionalProperties: false
      required:
        - Data
        - Risk
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
            - ConsentId
            - Initiation
          properties:
            ConsentId:
              description: >-
                OB: Unique identification as assigned by the ASPSP to uniquely
                identify the consent resource.
              type: string
              minLength: 1
              maxLength: 128
            Initiation:
              type: object
              additionalProperties: false
              required:
                - InstructionIdentification
                - RequestedExecutionDateTime
                - InstructedAmount
                - CreditorAccount
              description: >-
                The Initiation payload is sent by the initiating party to the
                ASPSP. It is used to request movement of funds from the debtor
                account to a creditor for a single scheduled domestic payment.
              properties:
                InstructionIdentification:
                  description: >-
                    Unique identification as assigned by an instructing party
                    for an instructed party to unambiguously identify the
                    instruction.

                    Usage: the  instruction identification is a point to point
                    reference that can be used between the instructing party and
                    the instructed party to refer to the individual instruction.
                    It can be included in several messages related to the
                    instruction.
                  type: string
                  minLength: 1
                  maxLength: 35
                EndToEndIdentification:
                  description: >-
                    Unique identification assigned by the initiating party to
                    unambiguously identify the transaction. This identification
                    is passed on, unchanged, throughout the entire end-to-end
                    chain.

                    Usage: The end-to-end identification can be used for
                    reconciliation or to link tasks relating to the transaction.
                    It can be included in several messages related to the
                    transaction.

                    OB: The Faster Payments Scheme can only access 31 characters
                    for the EndToEndIdentification field.
                  type: string
                  minLength: 1
                  maxLength: 35
                LocalInstrument:
                  $ref: '#/components/schemas/OBInternalLocalInstrument1Code'
                RequestedExecutionDateTime:
                  description: >-
                    Date at which the initiating party requests the clearing
                    agent to process the payment. 

                    Usage: This is the date on which the debtor's account is to
                    be debited. All dates in the JSON payloads are represented in
                    ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
                InstructedAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: >-
                    Amount of money to be moved between the debtor and creditor,
                    before deduction of charges, expressed in the currency as
                    ordered by the initiating party.

                    Usage: This amount has to be transported unchanged through
                    the transaction chain.
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                DebtorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                  description: >-
                    Unambiguous identification of the account of the debtor to
                    which a debit entry will be made as a result of the
                    transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level, as displayed
                        by the ASPSP's online channels.

                        Note, the account name is not the product name or the
                        nickname of the account.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                CreditorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: >-
                    Unambiguous identification of the account of the creditor to
                    which a credit entry will be posted as a result of the
                    payment transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level.

                        Note, the account name is not the product name or the
                        nickname of the account.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                RegulatoryReporting:
                  type: array
                  items:
                    $ref: '#/components/schemas/OBRegulatoryReporting1'
                  maxItems: 10
                CreditorPostalAddress:
                  $ref: '#/components/schemas/OBPostalAddress7'
                UltimateCreditor:
                  $ref: '#/components/schemas/OBUltimateCreditor1'
                UltimateDebtor:
                  $ref: '#/components/schemas/OBUltimateDebtor1'
                RemittanceInformation:
                  $ref: '#/components/schemas/OBRemittanceInformation2'
                SupplementaryData:
                  $ref: '#/components/schemas/OBSupplementaryData1'
        Risk:
          $ref: '#/components/schemas/OBRisk1'
    OBWriteDomesticScheduledConsent4:
      type: object
      additionalProperties: false
      required:
        - Data
        - Risk
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
            - Permission
            - Initiation
          properties:
            Permission:
              description: Specifies the Open Banking service request types. For a full list of values see `OBInternalPermissions2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
              type: string
              enum:
                - Create
            ReadRefundAccount:
              description: Specifies to share the refund account details with PISP. For a full list of values see `OBInternalReadRefundAccount1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
              type: string
              enum:
                - 'No'
                - 'Yes'
            Initiation:
              type: object
              additionalProperties: false
              required:
                - InstructionIdentification
                - RequestedExecutionDateTime
                - InstructedAmount
                - CreditorAccount
              description: >-
                The Initiation payload is sent by the initiating party to the
                ASPSP. It is used to request movement of funds from the debtor
                account to a creditor for a single scheduled domestic payment.
              properties:
                InstructionIdentification:
                  description: >-
                    Unique identification as assigned by an instructing party
                    for an instructed party to unambiguously identify the
                    instruction.

                    Usage: the  instruction identification is a point to point
                    reference that can be used between the instructing party and
                    the instructed party to refer to the individual instruction.
                    It can be included in several messages related to the
                    instruction.
                  type: string
                  minLength: 1
                  maxLength: 35
                EndToEndIdentification:
                  description: >-
                    Unique identification assigned by the initiating party to
                    unambiguously identify the transaction. This identification
                    is passed on, unchanged, throughout the entire end-to-end
                    chain.

                    Usage: The end-to-end identification can be used for
                    reconciliation or to link tasks relating to the transaction.
                    It can be included in several messages related to the
                    transaction.

                    OB: The Faster Payments Scheme can only access 31 characters
                    for the EndToEndIdentification field.
                  type: string
                  minLength: 1
                  maxLength: 35
                LocalInstrument:
                  $ref: '#/components/schemas/OBInternalLocalInstrument1Code'
                RequestedExecutionDateTime:
                  description: >-
                    Date at which the initiating party requests the clearing
                    agent to process the payment. 

                    Usage: This is the date on which the debtor's account is to
                    be debited. All dates in the JSON payloads are represented in
                    ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
                InstructedAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: >-
                    Amount of money to be moved between the debtor and creditor,
                    before deduction of charges, expressed in the currency as
                    ordered by the initiating party.

                    Usage: This amount has to be transported unchanged through
                    the transaction chain.
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                DebtorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                  description: >-
                    Unambiguous identification of the account of the debtor to
                    which a debit entry will be made as a result of the
                    transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level, as displayed
                        by the ASPSP's online channels.

                        Note, the account name is not the product name or the
                        nickname of the account.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                CreditorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: >-
                    Unambiguous identification of the account of the creditor to
                    which a credit entry will be posted as a result of the
                    payment transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level.

                        Note, the account name is not the product name or the
                        nickname of the account.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                CreditorPostalAddress:
                  $ref: '#/components/schemas/OBPostalAddress7'
                UltimateCreditor:
                  $ref: '#/components/schemas/OBUltimateCreditor1'
                UltimateDebtor:
                  $ref: '#/components/schemas/OBUltimateDebtor1'
                RegulatoryReporting:
                  type: array
                  items:
                    $ref: '#/components/schemas/OBRegulatoryReporting1'
                  maxItems: 10
                RemittanceInformation:
                  $ref: '#/components/schemas/OBRemittanceInformation2'
                SupplementaryData:
                  $ref: '#/components/schemas/OBSupplementaryData1'
            Authorisation:
              type: object
              additionalProperties: false
              required:
                - AuthorisationType
              description: The authorisation type request from the TPP.
              properties:
                AuthorisationType:
                  description: Type of authorisation flow requested. For a full list of values refer to `OBInternalAuthorisation1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
                  type: string
                  enum:
                    - Any
                    - Single
                CompletionDateTime:
                  description: >-
                    Date and time at which the requested authorisation flow must
                    be completed. All dates in the JSON payloads are represented
                    in ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
            SCASupportData:
              $ref: '#/components/schemas/OBSCASupportData1'
        Risk:
          $ref: '#/components/schemas/OBRisk1'
    OBWriteDomesticScheduledConsentResponse5:
      type: object
      additionalProperties: false
      required:
        - Data
        - Risk
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
            - ConsentId
            - CreationDateTime
            - Status
            - StatusUpdateDateTime
            - Permission
            - Initiation
          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. All dates in the
                JSON payloads are represented in ISO 8601 date-time format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            Status:
              description: Specifies the status of consent resource in code form. For a full list of values see `OBInternalConsentStatus1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
              type: string
              enum:
                - AUTH
                - AWAU
                - COND
                - RJCT
            StatusUpdateDateTime:
              description: >-
                Date and time at which the consent resource status was
                updated. All dates in the JSON payloads are represented in ISO
                8601 date-time format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            StatusReason:
              type: array
              items:
                $ref: '#/components/schemas/OBStatusReason'
            Permission:
              description: Specifies the Open Banking service request types. For a full list of values see `OBInternalPermissions2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
              type: string
              enum:
                - Create
            ReadRefundAccount:
              description: Specifies to share the refund account details with PISP. For a full list of values see `OBInternalReadRefundAccount1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
              type: string
              enum:
                - 'No'
                - 'Yes'
            CutOffDateTime:
              description: >-
                Specified cut-off date and time for the payment consent. All
                dates in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            ExpectedExecutionDateTime:
              description: >-
                Expected execution date and time for the payment resource. All
                dates in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            ExpectedSettlementDateTime:
              description: >-
                Expected settlement date and time for the payment resource. All
                dates in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            Charges:
              type: array
              items:
                type: object
                additionalProperties: false
                description: >-
                  Set of elements used to provide details of a charge for the
                  payment initiation.
                required:
                  - ChargeBearer
                  - Type
                  - Amount
                properties:
                  ChargeBearer:
                    $ref: '#/components/schemas/OBInternalChargeBearerType1Code'
                  Type:
                    $ref: '#/components/schemas/OBInternalPaymentChargeType1Code'
                  Amount:
                    $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount'
            Initiation:
              type: object
              additionalProperties: false
              required:
                - InstructionIdentification
                - RequestedExecutionDateTime
                - InstructedAmount
                - CreditorAccount
              description: >-
                The Initiation payload is sent by the initiating party to the
                ASPSP. It is used to request movement of funds from the debtor
                account to a creditor for a single scheduled domestic payment.
              properties:
                InstructionIdentification:
                  description: >-
                    Unique identification as assigned by an instructing party
                    for an instructed party to unambiguously identify the
                    instruction.

                    Usage: the  instruction identification is a point to point
                    reference that can be used between the instructing party and
                    the instructed party to refer to the individual instruction.
                    It can be included in several messages related to the
                    instruction.
                  type: string
                  minLength: 1
                  maxLength: 35
                EndToEndIdentification:
                  description: >-
                    Unique identification assigned by the initiating party to
                    unambiguously identify the transaction. This identification
                    is passed on, unchanged, throughout the entire end-to-end
                    chain.

                    Usage: The end-to-end identification can be used for
                    reconciliation or to link tasks relating to the transaction.
                    It can be included in several messages related to the
                    transaction.

                    OB: The Faster Payments Scheme can only access 31 characters
                    for the EndToEndIdentification field.
                  type: string
                  minLength: 1
                  maxLength: 35
                LocalInstrument:
                  $ref: '#/components/schemas/OBInternalLocalInstrument1Code'
                RequestedExecutionDateTime:
                  description: >-
                    Date at which the initiating party requests the clearing
                    agent to process the payment. 

                    Usage: This is the date on which the debtor's account is to
                    be debited. All dates in the JSON payloads are represented in
                    ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
                InstructedAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: >-
                    Amount of money to be moved between the debtor and creditor,
                    before deduction of charges, expressed in the currency as
                    ordered by the initiating party.

                    Usage: This amount has to be transported unchanged through
                    the transaction chain.
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                DebtorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                  description: >-
                    Unambiguous identification of the account of the debtor to
                    which a debit entry will be made as a result of the
                    transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level, as displayed
                        by the ASPSP's online channels.

                        Note, the account name is not the product name or the
                        nickname of the account.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                CreditorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: >-
                    Unambiguous identification of the account of the creditor to
                    which a credit entry will be posted as a result of the
                    payment transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level.

                        Note, the account name is not the product name or the
                        nickname of the account.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                CreditorPostalAddress:
                  $ref: '#/components/schemas/OBPostalAddress7'
                UltimateCreditor:
                  $ref: '#/components/schemas/OBUltimateCreditor1'
                UltimateDebtor:
                  $ref: '#/components/schemas/OBUltimateDebtor1'
                RegulatoryReporting:
                  type: array
                  items:
                    $ref: '#/components/schemas/OBRegulatoryReporting1'
                  maxItems: 10
                RemittanceInformation:
                  $ref: '#/components/schemas/OBRemittanceInformation2'
                SupplementaryData:
                  $ref: '#/components/schemas/OBSupplementaryData1'
            Authorisation:
              type: object
              additionalProperties: false
              required:
                - AuthorisationType
              description: The authorisation type request from the TPP.
              properties:
                AuthorisationType:
                  description: Type of authorisation flow requested. For a full list of values refer to `OBInternalAuthorisation1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
                  type: string
                  enum:
                    - Any
                    - Single
                CompletionDateTime:
                  description: >-
                    Date and time at which the requested authorisation flow must
                    be completed. All dates in the JSON payloads are represented
                    in ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
            SCASupportData:
              $ref: '#/components/schemas/OBSCASupportData1'
            Debtor:
              $ref: '#/components/schemas/OBCashAccountDebtor4'
        Risk:
          $ref: '#/components/schemas/OBRisk1'
        Links:
          $ref: '#/components/schemas/Links'
        Meta:
          $ref: '#/components/schemas/Meta'
    OBWriteDomesticScheduledResponse5:
      type: object
      additionalProperties: false
      required:
        - Data
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
            - DomesticScheduledPaymentId
            - ConsentId
            - CreationDateTime
            - Status
            - StatusUpdateDateTime
            - Initiation
          properties:
            DomesticScheduledPaymentId:
              description: >-
                OB: Unique identification as assigned by the ASPSP to uniquely
                identify the domestic schedule 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. All dates in the
                JSON payloads are represented in ISO 8601 date-time format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            Status:
              description: Specifies the status of the payment order resource. For a full list of values see `ExternalPaymentTransactionStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
              type: string
              enum:
                - RCVD
                - CANC
                - PDNG 
                - ACTC 
                - PATC
                - ACCP
                - ACFC
                - ACSP
                - ACWC
                - ACSC
                - ACWP
                - BLCK
                - RJCT
            StatusUpdateDateTime:
              description: >-
                Date and time at which the resource status was updated. All dates
                in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            StatusReason:
              type: array
              items:
                $ref: '#/components/schemas/OBStatusReason'
            ExpectedExecutionDateTime:
              description: >-
                Expected execution date and time for the payment resource. All
                dates in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            ExpectedSettlementDateTime:
              description: >-
                Expected settlement date and time for the payment resource. All
                dates in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            Refund:
              type: object
              additionalProperties: false
              required:
                - Account
              description: >-
                Unambiguous identification of the refund account to which a
                refund will be made as a result of the transaction.
              properties:
                Account:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: Provides the details to identify an account.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    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.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
            Charges:
              type: array
              items:
                type: object
                additionalProperties: false
                description: >-
                  Set of elements used to provide details of a charge for the
                  payment initiation.
                required:
                  - ChargeBearer
                  - Type
                  - Amount
                properties:
                  ChargeBearer:
                    $ref: '#/components/schemas/OBInternalChargeBearerType1Code'
                  Type:
                    $ref: '#/components/schemas/OBInternalPaymentChargeType1Code'
                  Amount:
                    $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount'
            Initiation:
              type: object
              additionalProperties: false
              required:
                - InstructionIdentification
                - RequestedExecutionDateTime
                - InstructedAmount
                - CreditorAccount
              description: >-
                The Initiation payload is sent by the initiating party to the
                ASPSP. It is used to request movement of funds from the debtor
                account to a creditor for a single scheduled domestic payment.
              properties:
                InstructionIdentification:
                  description: >-
                    Unique identification as assigned by an instructing party
                    for an instructed party to unambiguously identify the
                    instruction.

                    Usage: the  instruction identification is a point to point
                    reference that can be used between the instructing party and
                    the instructed party to refer to the individual instruction.
                    It can be included in several messages related to the
                    instruction.
                  type: string
                  minLength: 1
                  maxLength: 35
                EndToEndIdentification:
                  description: >-
                    Unique identification assigned by the initiating party to
                    unambiguously identify the transaction. This identification
                    is passed on, unchanged, throughout the entire end-to-end
                    chain.

                    Usage: The end-to-end identification can be used for
                    reconciliation or to link tasks relating to the transaction.
                    It can be included in several messages related to the
                    transaction.

                    OB: The Faster Payments Scheme can only access 31 characters
                    for the EndToEndIdentification field.
                  type: string
                  minLength: 1
                  maxLength: 35
                LocalInstrument:
                  $ref: '#/components/schemas/OBInternalLocalInstrument1Code'
                RequestedExecutionDateTime:
                  description: >-
                    Date at which the initiating party requests the clearing
                    agent to process the payment. 

                    Usage: This is the date on which the debtor's account is to
                    be debited. All dates in the JSON payloads are represented in
                    ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
                InstructedAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: >-
                    Amount of money to be moved between the debtor and creditor,
                    before deduction of charges, expressed in the currency as
                    ordered by the initiating party.

                    Usage: This amount has to be transported unchanged through
                    the transaction chain.
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                DebtorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                  description: >-
                    Unambiguous identification of the account of the debtor to
                    which a debit entry will be made as a result of the
                    transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level, as displayed
                        by the ASPSP's online channels.

                        Note, the account name is not the product name or the
                        nickname of the account.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                CreditorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: >-
                    Unambiguous identification of the account of the creditor to
                    which a credit entry will be posted as a result of the
                    payment transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level.

                        Note, the account name is not the product name or the
                        nickname of the account.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                CreditorPostalAddress:
                  $ref: '#/components/schemas/OBPostalAddress7'
                UltimateCreditor:
                  $ref: '#/components/schemas/OBUltimateCreditor1'
                UltimateDebtor:
                  $ref: '#/components/schemas/OBUltimateDebtor1'
                RegulatoryReporting:
                  type: array
                  items:
                    $ref: '#/components/schemas/OBRegulatoryReporting1'
                  maxItems: 10
                RemittanceInformation:
                  $ref: '#/components/schemas/OBRemittanceInformation2'
                SupplementaryData:
                  $ref: '#/components/schemas/OBSupplementaryData1'
            MultiAuthorisation:
              type: object
              additionalProperties: false
              required:
                - Status
              description: The multiple authorisation flow response from the ASPSP.
              properties:
                Status:
                  description: Specifies the status of the authorisation flow in code form.
                  type: string
                  enum:
                    - AUTH
                    - AWAU
                    - RJCT
                NumberRequired:
                  description: >-
                    Number of authorisations required for payment order (total
                    required at the start of the multi authorisation journey).
                  type: integer
                NumberReceived:
                  description: Number of authorisations received.
                  type: integer
                LastUpdateDateTime:
                  description: >-
                    Last date and time at the authorisation flow was updated. All
                    dates in the JSON payloads are represented in ISO 8601
                    date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-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. All dates in the JSON payloads are represented
                    in ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
            Debtor:
              $ref: '#/components/schemas/OBCashAccountDebtor4'
        Links:
          $ref: '#/components/schemas/Links'
        Meta:
          $ref: '#/components/schemas/Meta'
    OBWriteDomesticStandingOrder3:
      type: object
      additionalProperties: false
      required:
        - Data
        - Risk
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
            - ConsentId
            - Initiation
          properties:
            ConsentId:
              description: >-
                OB: Unique identification as assigned by the ASPSP to uniquely
                identify the consent resource.
              type: string
              minLength: 1
              maxLength: 128
            Initiation:
              type: object
              additionalProperties: false
              required:
                - MandateRelatedInformation
                - FirstPaymentAmount
                - CreditorAccount
              description: >-
                The Initiation payload is sent by the initiating party to the
                ASPSP. It is used to request movement of funds from the debtor
                account to a creditor for a domestic standing order.
              properties:
                RemittanceInformation:
                  $ref: '#/components/schemas/OBRemittanceInformation2'
                FirstPaymentAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: The amount of the first Standing Order
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                RecurringPaymentAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: The amount of the recurring Standing Order
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                FinalPaymentAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: The amount of the final Standing Order
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                DebtorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                  description: Provides the details to identify the debtor account.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level, as displayed
                        by the ASPSP's online channels.

                        Note, the account name is not the product name or the
                        nickname of the account.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                CreditorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: >-
                    Identification assigned by an institution to identify an
                    account. This identification is known by the account owner.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level.

                        Note, the account name is not the product name or the
                        nickname of the account.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                UltimateCreditor:
                  $ref: '#/components/schemas/OBUltimateCreditor1'
                UltimateDebtor:
                  $ref: '#/components/schemas/OBUltimateDebtor1'
                RegulatoryReporting:
                  type: array
                  items:
                    $ref: '#/components/schemas/OBRegulatoryReporting1'
                  maxItems: 10
                MandateRelatedInformation:
                  $ref: '#/components/schemas/OBMandateRelatedInformation1'
                SupplementaryData:
                  $ref: '#/components/schemas/OBSupplementaryData1'
        Risk:
          $ref: '#/components/schemas/OBRisk1'
    OBWriteDomesticStandingOrderConsent5:
      type: object
      additionalProperties: false
      required:
        - Data
        - Risk
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
            - Permission
            - Initiation
          properties:
            Permission:
              description: Specifies the Open Banking service request types. For a full list of values see `OBInternalPermissions2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
              type: string
              enum:
                - Create
            ReadRefundAccount:
              description: Specifies to share the refund account details with PISP. For a full list of values see `OBInternalReadRefundAccount1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
              type: string
              enum:
                - 'No'
                - 'Yes'
            Initiation:
              type: object
              additionalProperties: false
              required:
                - MandateRelatedInformation
                - FirstPaymentAmount
                - CreditorAccount
              description: >-
                The Initiation payload is sent by the initiating party to the
                ASPSP. It is used to request movement of funds from the debtor
                account to a creditor for a domestic standing order.
              properties:
                RemittanceInformation:
                  $ref: '#/components/schemas/OBRemittanceInformation2'
                FirstPaymentAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: The amount of the first Standing Order
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                RecurringPaymentAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: The amount of the recurring Standing Order
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                FinalPaymentAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: The amount of the final Standing Order
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                DebtorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                  description: Provides the details to identify the debtor account.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level, as displayed
                        by the ASPSP's online channels.

                        Note, the account name is not the product name or the
                        nickname of the account.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                CreditorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: >-
                    Identification assigned by an institution to identify an
                    account. This identification is known by the account owner.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level.

                        Note, the account name is not the product name or the
                        nickname of the account.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                UltimateCreditor:
                  $ref: '#/components/schemas/OBUltimateCreditor1'
                UltimateDebtor:
                  $ref: '#/components/schemas/OBUltimateDebtor1'
                RegulatoryReporting:
                  type: array
                  items:
                    $ref: '#/components/schemas/OBRegulatoryReporting1'
                  maxItems: 10
                MandateRelatedInformation:
                  $ref: '#/components/schemas/OBMandateRelatedInformation1'
                SupplementaryData:
                  $ref: '#/components/schemas/OBSupplementaryData1'
            Authorisation:
              type: object
              additionalProperties: false
              required:
                - AuthorisationType
              description: The authorisation type request from the TPP.
              properties:
                AuthorisationType:
                  description: Type of authorisation flow requested. For a full list of values refer to `OBInternalAuthorisation1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
                  type: string
                  enum:
                    - Any
                    - Single
                CompletionDateTime:
                  description: >-
                    Date and time at which the requested authorisation flow must
                    be completed. All dates in the JSON payloads are represented
                    in ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
            SCASupportData:
              $ref: '#/components/schemas/OBSCASupportData1'
        Risk:
          $ref: '#/components/schemas/OBRisk1'
    OBWriteDomesticStandingOrderConsentResponse6:
      type: object
      additionalProperties: false
      required:
        - Data
        - Risk
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
            - ConsentId
            - CreationDateTime
            - Status
            - StatusUpdateDateTime
            - Permission
            - Initiation
          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. All dates in the
                JSON payloads are represented in ISO 8601 date-time format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            Status:
              description: Specifies the status of consent resource in code form. For a full list of values see `OBInternalConsentStatus1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
              type: string
              enum:
                - AUTH
                - AWAU
                - COND
                - RJCT
            StatusUpdateDateTime:
              description: >-
                Date and time at which the resource status was updated. All dates
                in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            StatusReason:
              type: array
              items:
                $ref: '#/components/schemas/OBStatusReason'
            Permission:
              description: Specifies the Open Banking service request types. For a full list of values see `OBInternalPermissions2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
              type: string
              enum:
                - Create
            ReadRefundAccount:
              description: Specifies to share the refund account details with PISP.  For a full list of values see `OBInternalReadRefundAccount1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
              type: string
              enum:
                - 'No'
                - 'Yes'
            CutOffDateTime:
              description: >-
                Specified cut-off date and time for the payment consent. All
                dates in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            Charges:
              type: array
              items:
                type: object
                additionalProperties: false
                description: >-
                  Set of elements used to provide details of a charge for the
                  payment initiation.
                required:
                  - ChargeBearer
                  - Type
                  - Amount
                properties:
                  ChargeBearer:
                    $ref: '#/components/schemas/OBInternalChargeBearerType1Code'
                  Type:
                    $ref: '#/components/schemas/OBInternalPaymentChargeType1Code'
                  Amount:
                    $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount'
            Initiation:
              type: object
              additionalProperties: false
              required:
                - MandateRelatedInformation
                - FirstPaymentAmount
                - CreditorAccount
              description: >-
                The Initiation payload is sent by the initiating party to the
                ASPSP. It is used to request movement of funds from the debtor
                account to a creditor for a domestic standing order.
              properties:
                RemittanceInformation:
                  $ref: '#/components/schemas/OBRemittanceInformation2'
                FirstPaymentAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: The amount of the first Standing Order
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                RecurringPaymentAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: The amount of the recurring Standing Order
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                FinalPaymentAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: The amount of the final Standing Order
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                DebtorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                  description: >-
                    Unambiguous identification of the account of the debtor to
                    which a debit entry will be made as a result of the
                    transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level, as displayed
                        by the ASPSP's online channels.

                        Note, the account name is not the product name or the
                        nickname of the account.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                CreditorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: >-
                    Identification assigned by an institution to identify an
                    account. This identification is known by the account owner.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level.

                        Note, the account name is not the product name or the
                        nickname of the account.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                UltimateCreditor:
                  $ref: '#/components/schemas/OBUltimateCreditor1'
                UltimateDebtor:
                  $ref: '#/components/schemas/OBUltimateDebtor1'
                RegulatoryReporting:
                  type: array
                  items:
                    $ref: '#/components/schemas/OBRegulatoryReporting1'
                  maxItems: 10
                MandateRelatedInformation:
                  $ref: '#/components/schemas/OBMandateRelatedInformation1'
                SupplementaryData:
                  $ref: '#/components/schemas/OBSupplementaryData1'
            Authorisation:
              type: object
              additionalProperties: false
              required:
                - AuthorisationType
              description: The authorisation type request from the TPP.
              properties:
                AuthorisationType:
                  description: Type of authorisation flow requested.
                  type: string
                  enum:
                    - Any
                    - Single
                CompletionDateTime:
                  description: >-
                    Date and time at which the requested authorisation flow must
                    be completed. All dates in the JSON payloads are represented
                    in ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
            SCASupportData:
              $ref: '#/components/schemas/OBSCASupportData1'
            Debtor:
              $ref: '#/components/schemas/OBCashAccountDebtor4'
        Risk:
          $ref: '#/components/schemas/OBRisk1'
        Links:
          $ref: '#/components/schemas/Links'
        Meta:
          $ref: '#/components/schemas/Meta'
    OBWriteDomesticStandingOrderResponse6:
      type: object
      additionalProperties: false
      required:
        - Data
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
            - DomesticStandingOrderId
            - ConsentId
            - CreationDateTime
            - Status
            - StatusUpdateDateTime
            - Initiation
          properties:
            DomesticStandingOrderId:
              description: >-
                OB: Unique identification as assigned by the ASPSP to uniquely
                identify the domestic standing order 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 resource was created. All dates in the
                JSON payloads are represented in ISO 8601 date-time format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            Status:
              description: Specifies the status of the payment order resource. For a full list of values see `ExternalPaymentTransactionStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
              type: string
              enum:
                - RCVD
                - CANC
                - ACTC
                - PATC 
                - PDNG 
                - INFA 
                - INCO
                - RJCT 
            StatusUpdateDateTime:
              description: >-
                Date and time at which the resource status was updated. All dates
                in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            StatusReason:
              type: array
              items:
                $ref: '#/components/schemas/OBStatusReason'
            Refund:
              type: object
              additionalProperties: false
              required:
                - Account
              description: >-
                Unambiguous identification of the refund account to which a
                refund will be made as a result of the transaction.
              properties:
                Account:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: Provides the details to identify an account.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    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.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
            Charges:
              type: array
              items:
                type: object
                additionalProperties: false
                description: >-
                  Set of elements used to provide details of a charge for the
                  payment initiation.
                required:
                  - ChargeBearer
                  - Type
                  - Amount
                properties:
                  ChargeBearer:
                    $ref: '#/components/schemas/OBInternalChargeBearerType1Code'
                  Type:
                    $ref: '#/components/schemas/OBInternalPaymentChargeType1Code'
                  Amount:
                    $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount'
            Initiation:
              type: object
              additionalProperties: false
              required:
                - MandateRelatedInformation
                - FirstPaymentAmount
                - CreditorAccount
              description: >-
                The Initiation payload is sent by the initiating party to the
                ASPSP. It is used to request movement of funds from the debtor
                account to a creditor for a domestic standing order.
              properties:
                RemittanceInformation:
                  $ref: '#/components/schemas/OBRemittanceInformation2'
                FirstPaymentAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: The amount of the first Standing Order
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                RecurringPaymentAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: The amount of the recurring Standing Order
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                FinalPaymentAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: The amount of the final Standing Order
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                DebtorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                  description: Provides the details to identify the debtor account.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level, as displayed
                        by the ASPSP's online channels.

                        Note, the account name is not the product name or the
                        nickname of the account.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                CreditorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: >-
                    Identification assigned by an institution to identify an
                    account. This identification is known by the account owner.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level.

                        Note, the account name is not the product name or the
                        nickname of the account.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                UltimateCreditor:
                  $ref: '#/components/schemas/OBUltimateCreditor1'
                UltimateDebtor:
                  $ref: '#/components/schemas/OBUltimateDebtor1'
                RegulatoryReporting:
                  type: array
                  items:
                    $ref: '#/components/schemas/OBRegulatoryReporting1'
                  maxItems: 10
                MandateRelatedInformation:
                  $ref: '#/components/schemas/OBMandateRelatedInformation1'
                SupplementaryData:
                  $ref: '#/components/schemas/OBSupplementaryData1'
            MultiAuthorisation:
              type: object
              additionalProperties: false
              required:
                - Status
              description: The multiple authorisation flow response from the ASPSP.
              properties:
                Status:
                  description: Specifies the status of the authorisation flow in code form.
                  type: string
                  enum:
                    - AUTH
                    - AWAU
                    - RJCT
                NumberRequired:
                  description: >-
                    Number of authorisations required for payment order (total
                    required at the start of the multi authorisation journey).
                  type: integer
                NumberReceived:
                  description: Number of authorisations received.
                  type: integer
                LastUpdateDateTime:
                  description: >-
                    Last date and time at the authorisation flow was updated. All
                    dates in the JSON payloads are represented in ISO 8601
                    date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-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. All dates in the JSON payloads are represented
                    in ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
            Debtor:
              $ref: '#/components/schemas/OBCashAccountDebtor4'
        Links:
          $ref: '#/components/schemas/Links'
        Meta:
          $ref: '#/components/schemas/Meta'
    OBWriteFile2:
      type: object
      additionalProperties: false
      required:
        - Data
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
            - ConsentId
            - Initiation
          properties:
            ConsentId:
              description: >-
                OB: Unique identification as assigned by the ASPSP to uniquely
                identify the consent resource.
              type: string
              minLength: 1
              maxLength: 128
            Initiation:
              type: object
              additionalProperties: false
              required:
                - FileType
                - FileHash
              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.
              properties:
                FileType:
                  description: Specifies the payment file type.
                  type: string
                  x-namespaced-enum:
                    - UK.OBIE.PaymentInitiation.4.0
                    - UK.OBIE.pain.001.001.08
                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
                  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. 

                    Usage: This is the date on which the debtor's account is to
                    be debited. All dates in the JSON payloads are represented in
                    ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
                LocalInstrument:
                  $ref: '#/components/schemas/OBInternalLocalInstrument1Code'
                CreditorAgent:
                  type: object
                  additionalProperties: false
                  description: Financial institution servicing an account for the creditor.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalFinancialInstitutionIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_1'
                    Name:
                      $ref: '#/components/schemas/Name'
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                DebtorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                  description: >-
                    Unambiguous identification of the account of the debtor to
                    which a debit entry will be made as a result of the
                    transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level, as displayed
                        by the ASPSP's online channels.

                        Note, the account name is not the product name or the
                        nickname of the account.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                UltimateDebtor:
                  $ref: '#/components/schemas/OBUltimateDebtor1'
                RemittanceInformation:
                  $ref: '#/components/schemas/OBRemittanceInformation2'
                SupplementaryData:
                  $ref: '#/components/schemas/OBSupplementaryData1'
    OBWriteFileConsent3:
      type: object
      additionalProperties: false
      required:
        - Data
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
            - Initiation
          properties:
            Initiation:
              type: object
              additionalProperties: false
              required:
                - FileType
                - FileHash
              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.
              properties:
                FileType:
                  description: Specifies the payment file type.
                  type: string
                  x-namespaced-enum:
                    - UK.OBIE.PaymentInitiation.4.0
                    - UK.OBIE.pain.001.001.08
                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
                  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. 

                    Usage: This is the date on which the debtor's account is to
                    be debited. All dates in the JSON payloads are represented in
                    ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
                LocalInstrument:
                  $ref: '#/components/schemas/OBInternalLocalInstrument1Code'
                CreditorAgent:
                  type: object
                  additionalProperties: false
                  description: Financial institution servicing an account for the creditor.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalFinancialInstitutionIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_1'
                    Name:
                      $ref: '#/components/schemas/Name'
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                DebtorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                  description: >-
                    Unambiguous identification of the account of the debtor to
                    which a debit entry will be made as a result of the
                    transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level, as displayed
                        by the ASPSP's online channels.

                        Note, the account name is not the product name or the
                        nickname of the account.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                UltimateDebtor:
                  $ref: '#/components/schemas/OBUltimateDebtor1'
                RemittanceInformation:
                  $ref: '#/components/schemas/OBRemittanceInformation2'
                SupplementaryData:
                  $ref: '#/components/schemas/OBSupplementaryData1'
            Authorisation:
              type: object
              additionalProperties: false
              required:
                - AuthorisationType
              description: The authorisation type request from the TPP.
              properties:
                AuthorisationType:
                  description: Type of authorisation flow requested.
                  type: string
                  enum:
                    - Any
                    - Single
                CompletionDateTime:
                  description: >-
                    Date and time at which the requested authorisation flow must
                    be completed. All dates in the JSON payloads are represented
                    in ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
            SCASupportData:
              $ref: '#/components/schemas/OBSCASupportData1'
    OBWriteFileConsentResponse4:
      type: object
      additionalProperties: false
      required:
        - Data
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
            - ConsentId
            - CreationDateTime
            - Status
            - StatusUpdateDateTime
            - Initiation
          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. All dates in the
                JSON payloads are represented in ISO 8601 date-time format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            Status:
              description: Specifies the status of consent resource in code form.
              type: string
              enum:
                - AWAU
                - AWUP
                - RJCT
                - AUTH
                - COND
            StatusReason:
              type: array
              items:
                $ref: '#/components/schemas/OBStatusReason'
            StatusUpdateDateTime:
              description: >-
                Date and time at which the consent resource status was
                updated. All dates in the JSON payloads are represented in ISO
                8601 date-time format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            CutOffDateTime:
              description: >-
                Specified cut-off date and time for the payment consent. All
                dates in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            Charges:
              type: array
              items:
                type: object
                additionalProperties: false
                description: >-
                  Set of elements used to provide details of a charge for the
                  payment initiation.
                required:
                  - ChargeBearer
                  - Type
                  - Amount
                properties:
                  ChargeBearer:
                    $ref: '#/components/schemas/OBInternalChargeBearerType1Code'
                  Type:
                    $ref: '#/components/schemas/OBInternalPaymentChargeType1Code'
                  Amount:
                    $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount'
            Initiation:
              type: object
              additionalProperties: false
              required:
                - FileType
                - FileHash
              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.
              properties:
                FileType:
                  description: Specifies the payment file type.
                  type: string
                  x-namespaced-enum:
                    - UK.OBIE.PaymentInitiation.4.0
                    - UK.OBIE.pain.001.001.08
                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
                  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. 

                    Usage: This is the date on which the debtor's account is to
                    be debited. All dates in the JSON payloads are represented in
                    ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
                LocalInstrument:
                  $ref: '#/components/schemas/OBInternalLocalInstrument1Code'
                CreditorAgent:
                  type: object
                  additionalProperties: false
                  description: Financial institution servicing an account for the creditor.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalFinancialInstitutionIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_1'
                    Name:
                      $ref: '#/components/schemas/Name'
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                DebtorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                  description: >-
                    Unambiguous identification of the account of the debtor to
                    which a debit entry will be made as a result of the
                    transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level, as displayed
                        by the ASPSP's online channels.

                        Note, the account name is not the product name or the
                        nickname of the account.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                UltimateDebtor:
                  $ref: '#/components/schemas/OBUltimateDebtor1'
                RemittanceInformation:
                  $ref: '#/components/schemas/OBRemittanceInformation2'
                SupplementaryData:
                  $ref: '#/components/schemas/OBSupplementaryData1'
            Authorisation:
              type: object
              additionalProperties: false
              required:
                - AuthorisationType
              description: The authorisation type request from the TPP.
              properties:
                AuthorisationType:
                  description: Type of authorisation flow requested.
                  type: string
                  enum:
                    - Any
                    - Single
                CompletionDateTime:
                  description: >-
                    Date and time at which the requested authorisation flow must
                    be completed. All dates in the JSON payloads are represented
                    in ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
            SCASupportData:
              $ref: '#/components/schemas/OBSCASupportData1'
            Debtor:
              $ref: '#/components/schemas/OBCashAccountDebtor4'
        Links:
          $ref: '#/components/schemas/Links'
        Meta:
          $ref: '#/components/schemas/Meta'
    OBWriteFileResponse3:
      type: object
      additionalProperties: false
      required:
        - Data
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
            - FilePaymentId
            - ConsentId
            - CreationDateTime
            - Status
            - StatusUpdateDateTime
            - Initiation
          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. All dates in the
                JSON payloads are represented in ISO 8601 date-time format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            Status:
              description: Specifies the status of the payment order resource. See `ExternalPaymentTransactionStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) for more information.
              type: string
              enum:
                - INFA
                - INCO 
                - PDNG 
            StatusUpdateDateTime:
              description: >-
                Date and time at which the resource status was updated. All dates
                in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            StatusReason:
              type: array
              items:
                $ref: '#/components/schemas/OBStatusReason'
            Charges:
              type: array
              items:
                type: object
                additionalProperties: false
                description: >-
                  Set of elements used to provide details of a charge for the
                  payment initiation.
                required:
                  - ChargeBearer
                  - Type
                  - Amount
                properties:
                  ChargeBearer:
                    $ref: '#/components/schemas/OBInternalChargeBearerType1Code'
                  Type:
                    $ref: '#/components/schemas/OBInternalPaymentChargeType1Code'
                  Amount:
                    $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount'
            Initiation:
              type: object
              additionalProperties: false
              required:
                - FileType
                - FileHash
              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.
              properties:
                FileType:
                  description: Specifies the payment file type.
                  type: string
                  x-namespaced-enum:
                    - UK.OBIE.PaymentInitiation.4.0
                    - UK.OBIE.pain.001.001.08
                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
                  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. 

                    Usage: This is the date on which the debtor's account is to
                    be debited. All dates in the JSON payloads are represented in
                    ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
                LocalInstrument:
                  $ref: '#/components/schemas/OBInternalLocalInstrument1Code'
                DebtorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                  description: >-
                    Unambiguous identification of the account of the debtor to
                    which a debit entry will be made as a result of the
                    transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level, as displayed
                        by the ASPSP's online channels.

                        Note, the account name is not the product name or the
                        nickname of the account.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                CreditorAgent:
                  type: object
                  additionalProperties: false
                  description: Financial institution servicing an account for the creditor.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalFinancialInstitutionIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_1'
                    Name:
                      $ref: '#/components/schemas/Name'
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                UltimateDebtor:
                  $ref: '#/components/schemas/OBUltimateDebtor1'
                RemittanceInformation:
                  $ref: '#/components/schemas/OBRemittanceInformation2'
                SupplementaryData:
                  $ref: '#/components/schemas/OBSupplementaryData1'
            MultiAuthorisation:
              type: object
              additionalProperties: false
              required:
                - Status
              description: The multiple authorisation flow response from the ASPSP.
              properties:
                Status:
                  description: Specifies the status of the authorisation flow in code form.
                  type: string
                  enum:
                    - AUTH
                    - AWAF
                    - RJCT
                NumberRequired:
                  description: >-
                    Number of authorisations required for payment order (total
                    required at the start of the multi authorisation journey).
                  type: integer
                NumberReceived:
                  description: Number of authorisations received.
                  type: integer
                LastUpdateDateTime:
                  description: >-
                    Last date and time at the authorisation flow was updated. All
                    dates in the JSON payloads are represented in ISO 8601
                    date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-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. All dates in the JSON payloads are represented
                    in ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
            Debtor:
              $ref: '#/components/schemas/OBCashAccountDebtor4'
        Links:
          $ref: '#/components/schemas/Links'
        Meta:
          $ref: '#/components/schemas/Meta'
    OBWriteFundsConfirmationResponse1:
      type: object
      additionalProperties: false
      required:
        - Data
      properties:
        Data:
          type: object
          additionalProperties: false
          properties:
            FundsAvailableResult:
              type: object
              additionalProperties: false
              required:
                - FundsAvailableDateTime
                - FundsAvailable
              description: Result of a funds availability check.
              properties:
                FundsAvailableDateTime:
                  description: >-
                    Date and time at which the funds availability check was
                    generated. All dates in the JSON payloads are represented in
                    ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
                FundsAvailable:
                  description: >-
                    Flag to indicate the availability of funds given the Amount
                    in the consent request.
                  type: boolean
            SupplementaryData:
              $ref: '#/components/schemas/OBSupplementaryData1'
        Links:
          $ref: '#/components/schemas/Links'
        Meta:
          $ref: '#/components/schemas/Meta'
    OBWriteInternational3:
      type: object
      additionalProperties: false
      required:
        - Data
        - Risk
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
            - ConsentId
            - Initiation
          properties:
            ConsentId:
              description: >-
                OB: Unique identification as assigned by the ASPSP to uniquely
                identify the consent resource.
              type: string
              minLength: 1
              maxLength: 128
            Initiation:
              type: object
              additionalProperties: false
              required:
                - InstructionIdentification
                - EndToEndIdentification
                - CurrencyOfTransfer
                - InstructedAmount
                - CreditorAccount
              description: >-
                The Initiation payload is sent by the initiating party to the
                ASPSP. It is used to request movement of funds from the debtor
                account to a creditor for a single international payment.
              properties:
                InstructionIdentification:
                  description: >-
                    Unique identification as assigned by an instructing party
                    for an instructed party to unambiguously identify the
                    instruction.

                    Usage: the  instruction identification is a point to point
                    reference that can be used between the instructing party and
                    the instructed party to refer to the individual instruction.
                    It can be included in several messages related to the
                    instruction.
                  type: string
                  minLength: 1
                  maxLength: 35
                EndToEndIdentification:
                  description: >-
                    Unique identification assigned by the initiating party to
                    unambiguously identify the transaction. This identification
                    is passed on, unchanged, throughout the entire end-to-end
                    chain.

                    Usage: The end-to-end identification can be used for
                    reconciliation or to link tasks relating to the transaction.
                    It can be included in several messages related to the
                    transaction.

                    OB: The Faster Payments Scheme can only access 31 characters
                    for the EndToEndIdentification field.
                  type: string
                  minLength: 1
                  maxLength: 35
                LocalInstrument:
                  $ref: '#/components/schemas/OBInternalLocalInstrument1Code'
                InstructionPriority:
                  description: >-
                    Indicator of the urgency or order of importance that the
                    instructing party would like the instructed party to apply
                    to the processing of the instruction.
                  type: string
                  enum:
                    - Normal
                    - Urgent
                ExtendedPurpose:
                  description: >-
                    Specifies the purpose of an international payment, when
                    there is no corresponding 4 character code available in the
                    ISO20022 list of Purpose Codes.
                  type: string
                  minLength: 1
                  maxLength: 140
                ChargeBearer:
                  $ref: '#/components/schemas/OBInternalChargeBearerType1Code'
                CurrencyOfTransfer:
                  description: >-
                    Specifies the currency of the to be transferred amount,
                    which is different from the currency of the debtor's
                    account.
                  type: string
                  pattern: ^[A-Z]{3,3}$
                DestinationCountryCode:
                  description: >-
                    Country in which Credit Account is domiciled. Code to
                    identify a country, a dependency, or another area of
                    particular geopolitical interest, on the basis of country
                    names obtained from the United Nations (ISO 3166, Alpha-2
                    code).
                  type: string
                  pattern: '[A-Z]{2,2}'
                InstructedAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: >-
                    Amount of money to be moved between the debtor and creditor,
                    before deduction of charges, expressed in the currency as
                    ordered by the initiating party.

                    Usage: This amount has to be transported unchanged through
                    the transaction chain.
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                ExchangeRateInformation:
                  type: object
                  additionalProperties: false
                  required:
                    - UnitCurrency
                    - RateType
                  description: Provides details on the currency exchange rate and contract.
                  properties:
                    UnitCurrency:
                      description: >-
                        Currency in which the rate of exchange is expressed in a
                        currency exchange. In the example 1GBP = xxxCUR, the
                        unit currency is GBP.
                      type: string
                      pattern: ^[A-Z]{3,3}$
                    ExchangeRate:
                      description: >-
                        The factor used for conversion of an amount from one
                        currency to another. This reflects the price at which
                        one currency was bought with another currency.
                      type: number
                    RateType:
                      description: >-
                        Specifies the type used to complete the currency
                        exchange.
                      type: string
                      enum:
                        - Actual
                        - Agreed
                        - Indicative
                    ContractIdentification:
                      description: >-
                        Unique and unambiguous reference to the foreign exchange
                        contract agreed between the initiating party/creditor
                        and the debtor agent.
                      type: string
                      minLength: 1
                      maxLength: 256
                DebtorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                  description: >-
                    Unambiguous identification of the account of the debtor to
                    which a debit entry will be made as a result of the
                    transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level, as displayed
                        by the ASPSP's online channels.

                        Note, the account name is not the product name or the
                        nickname of the account.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                Creditor:
                  type: object
                  additionalProperties: false
                  description: Party to which an amount of money is due.
                  properties:
                    Name:
                      description: >-
                        Name by which a party is known and which is usually used
                        to identify that party.
                      type: string
                      minLength: 1
                      maxLength: 140
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                CreditorAgent:
                  type: object
                  additionalProperties: false
                  description: Financial institution servicing an account for the creditor.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalFinancialInstitutionIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_1'
                    Name:
                      $ref: '#/components/schemas/Name'
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                CreditorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: >-
                    Unambiguous identification of the account of the creditor to
                    which a credit entry will be posted as a result of the
                    payment transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level.

                        Note, the account name is not the product name or the
                        nickname of the account.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                UltimateCreditor:
                  $ref: '#/components/schemas/OBUltimateCreditor1'
                UltimateDebtor:
                  $ref: '#/components/schemas/OBUltimateDebtor1'
                RegulatoryReporting:
                  type: array
                  items:
                    $ref: '#/components/schemas/OBRegulatoryReporting1'
                  maxItems: 10
                RemittanceInformation:
                  $ref: '#/components/schemas/OBRemittanceInformation2'
                SupplementaryData:
                  $ref: '#/components/schemas/OBSupplementaryData1'
        Risk:
          $ref: '#/components/schemas/OBRisk1'
    OBWriteInternationalConsent5:
      type: object
      additionalProperties: false
      required:
        - Data
        - Risk
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
            - Initiation
          properties:
            ReadRefundAccount:
              description: Specifies to share the refund account details with PISP
              type: string
              enum:
                - 'No'
                - 'Yes'
            Initiation:
              type: object
              additionalProperties: false
              required:
                - InstructionIdentification
                - EndToEndIdentification
                - CurrencyOfTransfer
                - InstructedAmount
                - CreditorAccount
              description: >-
                The Initiation payload is sent by the initiating party to the
                ASPSP. It is used to request movement of funds from the debtor
                account to a creditor for a single international payment.
              properties:
                InstructionIdentification:
                  description: >-
                    Unique identification as assigned by an instructing party
                    for an instructed party to unambiguously identify the
                    instruction.

                    Usage: the  instruction identification is a point to point
                    reference that can be used between the instructing party and
                    the instructed party to refer to the individual instruction.
                    It can be included in several messages related to the
                    instruction.
                  type: string
                  minLength: 1
                  maxLength: 35
                EndToEndIdentification:
                  description: >-
                    Unique identification assigned by the initiating party to
                    unambiguously identify the transaction. This identification
                    is passed on, unchanged, throughout the entire end-to-end
                    chain.

                    Usage: The end-to-end identification can be used for
                    reconciliation or to link tasks relating to the transaction.
                    It can be included in several messages related to the
                    transaction.

                    OB: The Faster Payments Scheme can only access 31 characters
                    for the EndToEndIdentification field.
                  type: string
                  minLength: 1
                  maxLength: 35
                LocalInstrument:
                  $ref: '#/components/schemas/OBInternalLocalInstrument1Code'
                InstructionPriority:
                  description: >-
                    Indicator of the urgency or order of importance that the
                    instructing party would like the instructed party to apply
                    to the processing of the instruction.
                  type: string
                  enum:
                    - Normal
                    - Urgent
                ExtendedPurpose:
                  description: >-
                    Specifies the purpose of an international payment, when
                    there is no corresponding 4 character code available in the
                    ISO20022 list of Purpose Codes.
                  type: string
                  minLength: 1
                  maxLength: 140
                ChargeBearer:
                  $ref: '#/components/schemas/OBInternalChargeBearerType1Code'
                CurrencyOfTransfer:
                  description: >-
                    Specifies the currency of the to be transferred amount,
                    which is different from the currency of the debtor's
                    account.
                  type: string
                  pattern: ^[A-Z]{3,3}$
                DestinationCountryCode:
                  description: >-
                    Country in which Credit Account is domiciled. Code to
                    identify a country, a dependency, or another area of
                    particular geopolitical interest, on the basis of country
                    names obtained from the United Nations (ISO 3166, Alpha-2
                    code).
                  type: string
                  pattern: '[A-Z]{2,2}'
                InstructedAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: >-
                    Amount of money to be moved between the debtor and creditor,
                    before deduction of charges, expressed in the currency as
                    ordered by the initiating party.

                    Usage: This amount has to be transported unchanged through
                    the transaction chain.
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                ExchangeRateInformation:
                  type: object
                  additionalProperties: false
                  required:
                    - UnitCurrency
                    - RateType
                  description: Provides details on the currency exchange rate and contract.
                  properties:
                    UnitCurrency:
                      description: >-
                        Currency in which the rate of exchange is expressed in a
                        currency exchange. In the example 1GBP = xxxCUR, the
                        unit currency is GBP.
                      type: string
                      pattern: ^[A-Z]{3,3}$
                    ExchangeRate:
                      description: >-
                        The factor used for conversion of an amount from one
                        currency to another. This reflects the price at which
                        one currency was bought with another currency.
                      type: number
                    RateType:
                      description: >-
                        Specifies the type used to complete the currency
                        exchange.
                      type: string
                      enum:
                        - Actual
                        - Agreed
                        - Indicative
                    ContractIdentification:
                      description: >-
                        Unique and unambiguous reference to the foreign exchange
                        contract agreed between the initiating party/creditor
                        and the debtor agent.
                      type: string
                      minLength: 1
                      maxLength: 256
                DebtorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                  description: >-
                    Unambiguous identification of the account of the debtor to
                    which a debit entry will be made as a result of the
                    transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level, as displayed
                        by the ASPSP's online channels.

                        Note, the account name is not the product name or the
                        nickname of the account.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                Creditor:
                  type: object
                  additionalProperties: false
                  description: Party to which an amount of money is due.
                  properties:
                    Name:
                      description: >-
                        Name by which a party is known and which is usually used
                        to identify that party.
                      type: string
                      minLength: 1
                      maxLength: 350
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                CreditorAgent:
                  type: object
                  additionalProperties: false
                  description: Financial institution servicing an account for the creditor.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalFinancialInstitutionIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_1'
                    Name:
                      $ref: '#/components/schemas/Name'
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                CreditorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: >-
                    Unambiguous identification of the account of the creditor to
                    which a credit entry will be posted as a result of the
                    payment transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level.

                        Note, the account name is not the product name or the
                        nickname of the account.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                UltimateCreditor:
                  $ref: '#/components/schemas/OBUltimateCreditor1'
                UltimateDebtor:
                  $ref: '#/components/schemas/OBUltimateDebtor1'
                RegulatoryReporting:
                  type: array
                  items:
                    $ref: '#/components/schemas/OBRegulatoryReporting1'
                  maxItems: 10
                RemittanceInformation:
                  $ref: '#/components/schemas/OBRemittanceInformation2'
                SupplementaryData:
                  $ref: '#/components/schemas/OBSupplementaryData1'
            Authorisation:
              type: object
              additionalProperties: false
              required:
                - AuthorisationType
              description: The authorisation type request from the TPP.
              properties:
                AuthorisationType:
                  description: Type of authorisation flow requested.
                  type: string
                  enum:
                    - Any
                    - Single
                CompletionDateTime:
                  description: >-
                    Date and time at which the requested authorisation flow must
                    be completed. All dates in the JSON payloads are represented
                    in ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
            SCASupportData:
              $ref: '#/components/schemas/OBSCASupportData1'
        Risk:
          $ref: '#/components/schemas/OBRisk1'
    OBWriteInternationalConsentResponse6:
      type: object
      additionalProperties: false
      required:
        - Data
        - Risk
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
            - ConsentId
            - CreationDateTime
            - Status
            - StatusUpdateDateTime
            - Initiation
          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. All dates in the
                JSON payloads are represented in ISO 8601 date-time format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            Status:
              description: Specifies the status of consent resource in code form.
              type: string
              enum:
                - AWAU
                - RJCT
                - AUTH
                - COND
            StatusReason:
              type: array
              items:
                $ref: '#/components/schemas/OBStatusReason'
            StatusUpdateDateTime:
              description: >-
                Date and time at which the resource status was updated. All dates
                in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            ReadRefundAccount:
              description: Specifies to share the refund account details with PISP
              type: string
              enum:
                - 'No'
                - 'Yes'
            CutOffDateTime:
              description: >-
                Specified cut-off date and time for the payment consent. All
                dates in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            ExpectedExecutionDateTime:
              description: >-
                Expected execution date and time for the payment resource. All
                dates in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            ExpectedSettlementDateTime:
              description: >-
                Expected settlement date and time for the payment resource. All
                dates in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            Charges:
              type: array
              items:
                type: object
                additionalProperties: false
                description: >-
                  Set of elements used to provide details of a charge for the
                  payment initiation.
                required:
                  - ChargeBearer
                  - Type
                  - Amount
                properties:
                  ChargeBearer:
                    $ref: '#/components/schemas/OBInternalChargeBearerType1Code'
                  Type:
                    $ref: '#/components/schemas/OBInternalPaymentChargeType1Code'
                  Amount:
                    $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount'
            ExchangeRateInformation:
              type: object
              additionalProperties: false
              required:
                - UnitCurrency
                - ExchangeRate
                - RateType
              description: >-
                Further detailed information on the exchange rate that has been
                used in the payment transaction.
              properties:
                UnitCurrency:
                  description: >-
                    Currency in which the rate of exchange is expressed in a
                    currency exchange. In the example 1GBP = xxxCUR, the unit
                    currency is GBP.
                  type: string
                  pattern: ^[A-Z]{3,3}$
                ExchangeRate:
                  description: >-
                    The factor used for conversion of an amount from one
                    currency to another. This reflects the price at which one
                    currency was bought with another currency.
                  type: number
                RateType:
                  description: Specifies the type used to complete the currency exchange.
                  type: string
                  enum:
                    - Actual
                    - Agreed
                    - Indicative
                ContractIdentification:
                  description: >-
                    Unique and unambiguous reference to the foreign exchange
                    contract agreed between the initiating party/creditor and
                    the debtor agent.
                  type: string
                  minLength: 1
                  maxLength: 256
                ExpirationDateTime:
                  description: >-
                    Specified date and time the exchange rate agreement will
                    expire. All dates in the JSON payloads are represented in ISO
                    8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
            Initiation:
              type: object
              additionalProperties: false
              required:
                - InstructionIdentification
                - EndToEndIdentification
                - CurrencyOfTransfer
                - InstructedAmount
                - CreditorAccount
              description: >-
                The Initiation payload is sent by the initiating party to the
                ASPSP. It is used to request movement of funds from the debtor
                account to a creditor for a single international payment.
              properties:
                InstructionIdentification:
                  description: >-
                    Unique identification as assigned by an instructing party
                    for an instructed party to unambiguously identify the
                    instruction.

                    Usage: the  instruction identification is a point to point
                    reference that can be used between the instructing party and
                    the instructed party to refer to the individual instruction.
                    It can be included in several messages related to the
                    instruction.
                  type: string
                  minLength: 1
                  maxLength: 35
                EndToEndIdentification:
                  description: >-
                    Unique identification assigned by the initiating party to
                    unambiguously identify the transaction. This identification
                    is passed on, unchanged, throughout the entire end-to-end
                    chain.

                    Usage: The end-to-end identification can be used for
                    reconciliation or to link tasks relating to the transaction.
                    It can be included in several messages related to the
                    transaction.

                    OB: The Faster Payments Scheme can only access 31 characters
                    for the EndToEndIdentification field.
                  type: string
                  minLength: 1
                  maxLength: 35
                LocalInstrument:
                  $ref: '#/components/schemas/OBInternalLocalInstrument1Code'
                InstructionPriority:
                  description: >-
                    Indicator of the urgency or order of importance that the
                    instructing party would like the instructed party to apply
                    to the processing of the instruction.
                  type: string
                  enum:
                    - Normal
                    - Urgent
                ExtendedPurpose:
                  description: >-
                    Specifies the purpose of an international payment, when
                    there is no corresponding 4 character code available in the
                    ISO20022 list of Purpose Codes.
                  type: string
                  minLength: 1
                  maxLength: 140
                ChargeBearer:
                  $ref: '#/components/schemas/OBInternalChargeBearerType1Code'
                CurrencyOfTransfer:
                  description: >-
                    Specifies the currency of the to be transferred amount,
                    which is different from the currency of the debtor's
                    account.
                  type: string
                  pattern: ^[A-Z]{3,3}$
                DestinationCountryCode:
                  description: >-
                    Country in which Credit Account is domiciled. Code to
                    identify a country, a dependency, or another area of
                    particular geopolitical interest, on the basis of country
                    names obtained from the United Nations (ISO 3166, Alpha-2
                    code).
                  type: string
                  pattern: '[A-Z]{2,2}'
                InstructedAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: >-
                    Amount of money to be moved between the debtor and creditor,
                    before deduction of charges, expressed in the currency as
                    ordered by the initiating party.

                    Usage: This amount has to be transported unchanged through
                    the transaction chain.
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                ExchangeRateInformation:
                  type: object
                  additionalProperties: false
                  required:
                    - UnitCurrency
                    - RateType
                  description: Provides details on the currency exchange rate and contract.
                  properties:
                    UnitCurrency:
                      description: >-
                        Currency in which the rate of exchange is expressed in a
                        currency exchange. In the example 1GBP = xxxCUR, the
                        unit currency is GBP.
                      type: string
                      pattern: ^[A-Z]{3,3}$
                    ExchangeRate:
                      description: >-
                        The factor used for conversion of an amount from one
                        currency to another. This reflects the price at which
                        one currency was bought with another currency.
                      type: number
                    RateType:
                      description: >-
                        Specifies the type used to complete the currency
                        exchange.
                      type: string
                      enum:
                        - Actual
                        - Agreed
                        - Indicative
                    ContractIdentification:
                      description: >-
                        Unique and unambiguous reference to the foreign exchange
                        contract agreed between the initiating party/creditor
                        and the debtor agent.
                      type: string
                      minLength: 1
                      maxLength: 256
                DebtorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                  description: >-
                    Unambiguous identification of the account of the debtor to
                    which a debit entry will be made as a result of the
                    transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level, as displayed
                        by the ASPSP's online channels.

                        Note, the account name is not the product name or the
                        nickname of the account.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                Creditor:
                  type: object
                  additionalProperties: false
                  description: Party to which an amount of money is due.
                  properties:
                    Name:
                      description: >-
                        Name by which a party is known and which is usually used
                        to identify that party.
                      type: string
                      minLength: 1
                      maxLength: 350
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                CreditorAgent:
                  type: object
                  additionalProperties: false
                  description: Financial institution servicing an account for the creditor.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalFinancialInstitutionIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_1'
                    Name:
                      $ref: '#/components/schemas/Name'
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                CreditorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: >-
                    Unambiguous identification of the account of the creditor to
                    which a credit entry will be posted as a result of the
                    payment transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level.

                        Note, the account name is not the product name or the
                        nickname of the account.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                UltimateCreditor:
                  $ref: '#/components/schemas/OBUltimateCreditor1'
                UltimateDebtor:
                  $ref: '#/components/schemas/OBUltimateDebtor1'
                RegulatoryReporting:
                  type: array
                  items:
                    $ref: '#/components/schemas/OBRegulatoryReporting1'
                  maxItems: 10
                RemittanceInformation:
                  $ref: '#/components/schemas/OBRemittanceInformation2'
                SupplementaryData:
                  $ref: '#/components/schemas/OBSupplementaryData1'
            Authorisation:
              type: object
              additionalProperties: false
              required:
                - AuthorisationType
              description: The authorisation type request from the TPP.
              properties:
                AuthorisationType:
                  description: Type of authorisation flow requested.
                  type: string
                  enum:
                    - Any
                    - Single
                CompletionDateTime:
                  description: >-
                    Date and time at which the requested authorisation flow must
                    be completed. All dates in the JSON payloads are represented
                    in ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
            SCASupportData:
              $ref: '#/components/schemas/OBSCASupportData1'
            Debtor:
              $ref: '#/components/schemas/OBCashAccountDebtor4'
        Risk:
          $ref: '#/components/schemas/OBRisk1'
        Links:
          $ref: '#/components/schemas/Links'
        Meta:
          $ref: '#/components/schemas/Meta'
    OBWriteInternationalResponse5:
      type: object
      additionalProperties: false
      required:
        - Data
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
            - InternationalPaymentId
            - ConsentId
            - CreationDateTime
            - Status
            - StatusUpdateDateTime
            - Initiation
          properties:
            InternationalPaymentId:
              description: >-
                OB: Unique identification as assigned by the ASPSP to uniquely
                identify the international 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. All dates in the
                JSON payloads are represented in ISO 8601 date-time format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            Status:
              description: Specifies the status of the payment information group.
              type: string
              enum:
                - PDNG
                - ACTC
                - PATC
                - ACCP
                - ACFC
                - ACSP
                - ACWC
                - ACSC
                - ACWP
                - ACCC
                - BLCK
                - RJCT
            StatusUpdateDateTime:
              description: >-
                Date and time at which the resource status was updated. All dates
                in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            StatusReason:
              type: array
              items:
                $ref: '#/components/schemas/OBStatusReason'
            ExpectedExecutionDateTime:
              description: >-
                Expected execution date and time for the payment resource. All
                dates in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            ExpectedSettlementDateTime:
              description: >-
                Expected settlement date and time for the payment resource. All
                dates in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            Refund:
              type: object
              additionalProperties: false
              required:
                - Account
              properties:
                Creditor:
                  type: object
                  additionalProperties: false
                  description: >-
                    Set of elements used to identify a person or an
                    organisation.
                  properties:
                    Name:
                      description: >-
                        Name by which a party is known and which is usually used
                        to identify that party.
                      type: string
                      minLength: 1
                      maxLength: 140
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                Agent:
                  type: object
                  additionalProperties: false
                  description: >-
                    Set of elements used to uniquely and unambiguously identify
                    a financial institution or a branch of a financial
                    institution.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalFinancialInstitutionIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_1'
                    Name:
                      $ref: '#/components/schemas/Name'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                Account:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: Provides the details to identify an account.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    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.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
            Charges:
              type: array
              items:
                type: object
                additionalProperties: false
                description: >-
                  Set of elements used to provide details of a charge for the
                  payment initiation.
                required:
                  - ChargeBearer
                  - Type
                  - Amount
                properties:
                  ChargeBearer:
                    $ref: '#/components/schemas/OBInternalChargeBearerType1Code'
                  Type:
                    $ref: '#/components/schemas/OBInternalPaymentChargeType1Code'
                  Amount:
                    $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount'
            ExchangeRateInformation:
              type: object
              additionalProperties: false
              required:
                - UnitCurrency
                - ExchangeRate
                - RateType
              description: >-
                Further detailed information on the exchange rate that has been
                used in the payment transaction.
              properties:
                UnitCurrency:
                  description: >-
                    Currency in which the rate of exchange is expressed in a
                    currency exchange. In the example 1GBP = xxxCUR, the unit
                    currency is GBP.
                  type: string
                  pattern: ^[A-Z]{3,3}$
                ExchangeRate:
                  description: >-
                    The factor used for conversion of an amount from one
                    currency to another. This reflects the price at which one
                    currency was bought with another currency.
                  type: number
                RateType:
                  description: Specifies the type used to complete the currency exchange.
                  type: string
                  enum:
                    - Actual
                    - Agreed
                    - Indicative
                ContractIdentification:
                  description: >-
                    Unique and unambiguous reference to the foreign exchange
                    contract agreed between the initiating party/creditor and
                    the debtor agent.
                  type: string
                  minLength: 1
                  maxLength: 256
                ExpirationDateTime:
                  description: >-
                    Specified date and time the exchange rate agreement will
                    expire. All dates in the JSON payloads are represented in ISO
                    8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
            Initiation:
              type: object
              additionalProperties: false
              required:
                - InstructionIdentification
                - EndToEndIdentification
                - CurrencyOfTransfer
                - InstructedAmount
                - CreditorAccount
              description: >-
                The Initiation payload is sent by the initiating party to the
                ASPSP. It is used to request movement of funds from the debtor
                account to a creditor for a single international payment.
              properties:
                InstructionIdentification:
                  description: >-
                    Unique identification as assigned by an instructing party
                    for an instructed party to unambiguously identify the
                    instruction.

                    Usage: the  instruction identification is a point to point
                    reference that can be used between the instructing party and
                    the instructed party to refer to the individual instruction.
                    It can be included in several messages related to the
                    instruction.
                  type: string
                  minLength: 1
                  maxLength: 35
                EndToEndIdentification:
                  description: >-
                    Unique identification assigned by the initiating party to
                    unambiguously identify the transaction. This identification
                    is passed on, unchanged, throughout the entire end-to-end
                    chain.

                    Usage: The end-to-end identification can be used for
                    reconciliation or to link tasks relating to the transaction.
                    It can be included in several messages related to the
                    transaction.

                    OB: The Faster Payments Scheme can only access 31 characters
                    for the EndToEndIdentification field.
                  type: string
                  minLength: 1
                  maxLength: 35
                LocalInstrument:
                  $ref: '#/components/schemas/OBInternalLocalInstrument1Code'
                InstructionPriority:
                  description: >-
                    Indicator of the urgency or order of importance that the
                    instructing party would like the instructed party to apply
                    to the processing of the instruction.
                  type: string
                  enum:
                    - Normal
                    - Urgent
                ExtendedPurpose:
                  description: >-
                    Specifies the purpose of an international payment, when
                    there is no corresponding 4 character code available in the
                    ISO20022 list of Purpose Codes.
                  type: string
                  minLength: 1
                  maxLength: 140
                ChargeBearer:
                  $ref: '#/components/schemas/OBInternalChargeBearerType1Code'
                CurrencyOfTransfer:
                  description: >-
                    Specifies the currency of the to be transferred amount,
                    which is different from the currency of the debtor's
                    account.
                  type: string
                  pattern: ^[A-Z]{3,3}$
                DestinationCountryCode:
                  description: >-
                    Country in which Credit Account is domiciled. Code to
                    identify a country, a dependency, or another area of
                    particular geopolitical interest, on the basis of country
                    names obtained from the United Nations (ISO 3166, Alpha-2
                    code).
                  type: string
                  pattern: '[A-Z]{2,2}'
                InstructedAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: >-
                    Amount of money to be moved between the debtor and creditor,
                    before deduction of charges, expressed in the currency as
                    ordered by the initiating party.

                    Usage: This amount has to be transported unchanged through
                    the transaction chain.
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                ExchangeRateInformation:
                  type: object
                  additionalProperties: false
                  required:
                    - UnitCurrency
                    - RateType
                  description: Provides details on the currency exchange rate and contract.
                  properties:
                    UnitCurrency:
                      description: >-
                        Currency in which the rate of exchange is expressed in a
                        currency exchange. In the example 1GBP = xxxCUR, the
                        unit currency is GBP.
                      type: string
                      pattern: ^[A-Z]{3,3}$
                    ExchangeRate:
                      description: >-
                        The factor used for conversion of an amount from one
                        currency to another. This reflects the price at which
                        one currency was bought with another currency.
                      type: number
                    RateType:
                      description: >-
                        Specifies the type used to complete the currency
                        exchange.
                      type: string
                      enum:
                        - Actual
                        - Agreed
                        - Indicative
                    ContractIdentification:
                      description: >-
                        Unique and unambiguous reference to the foreign exchange
                        contract agreed between the initiating party/creditor
                        and the debtor agent.
                      type: string
                      minLength: 1
                      maxLength: 256
                DebtorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                  description: >-
                    Unambiguous identification of the account of the debtor to
                    which a debit entry will be made as a result of the
                    transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level, as displayed
                        by the ASPSP's online channels.

                        Note, the account name is not the product name or the
                        nickname of the account.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                Creditor:
                  type: object
                  additionalProperties: false
                  description: Party to which an amount of money is due.
                  properties:
                    Name:
                      description: >-
                        Name by which a party is known and which is usually used
                        to identify that party.
                      type: string
                      minLength: 1
                      maxLength: 350
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                CreditorAgent:
                  type: object
                  additionalProperties: false
                  description: Financial institution servicing an account for the creditor.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalFinancialInstitutionIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_1'
                    Name:
                      $ref: '#/components/schemas/Name'
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                CreditorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: >-
                    Unambiguous identification of the account of the creditor to
                    which a credit entry will be posted as a result of the
                    payment transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level.

                        Note, the account name is not the product name or the
                        nickname of the account.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                UltimateCreditor:
                  $ref: '#/components/schemas/OBUltimateCreditor1'
                UltimateDebtor:
                  $ref: '#/components/schemas/OBUltimateDebtor1'
                RegulatoryReporting:
                  type: array
                  items:
                    $ref: '#/components/schemas/OBRegulatoryReporting1'
                  maxItems: 10
                RemittanceInformation:
                  $ref: '#/components/schemas/OBRemittanceInformation2'
                SupplementaryData:
                  $ref: '#/components/schemas/OBSupplementaryData1'
            MultiAuthorisation:
              type: object
              additionalProperties: false
              required:
                - Status
              description: The multiple authorisation flow response from the ASPSP.
              properties:
                Status:
                  description: Specifies the status of the authorisation flow in code form.
                  type: string
                  enum:
                    - AUTH
                    - AWAF
                    - RJCT
                NumberRequired:
                  description: >-
                    Number of authorisations required for payment order (total
                    required at the start of the multi authorisation journey).
                  type: integer
                NumberReceived:
                  description: Number of authorisations received.
                  type: integer
                LastUpdateDateTime:
                  description: >-
                    Last date and time at the authorisation flow was updated. All
                    dates in the JSON payloads are represented in ISO 8601
                    date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-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. All dates in the JSON payloads are represented
                    in ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
            Debtor:
              $ref: '#/components/schemas/OBCashAccountDebtor4'
        Links:
          $ref: '#/components/schemas/Links'
        Meta:
          $ref: '#/components/schemas/Meta'
    OBWriteInternationalScheduled3:
      type: object
      additionalProperties: false
      required:
        - Data
        - Risk
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
            - ConsentId
            - Initiation
          properties:
            ConsentId:
              description: >-
                OB: Unique identification as assigned by the ASPSP to uniquely
                identify the consent resource.
              type: string
              minLength: 1
              maxLength: 128
            Initiation:
              type: object
              additionalProperties: false
              required:
                - InstructionIdentification
                - RequestedExecutionDateTime
                - CurrencyOfTransfer
                - InstructedAmount
                - CreditorAccount
              description: >-
                The Initiation payload is sent by the initiating party to the
                ASPSP. It is used to request movement of funds from the debtor
                account to a creditor for a single scheduled international
                payment.
              properties:
                InstructionIdentification:
                  description: >-
                    Unique identification as assigned by an instructing party
                    for an instructed party to unambiguously identify the
                    instruction.

                    Usage: the  instruction identification is a point to point
                    reference that can be used between the instructing party and
                    the instructed party to refer to the individual instruction.
                    It can be included in several messages related to the
                    instruction.
                  type: string
                  minLength: 1
                  maxLength: 35
                EndToEndIdentification:
                  description: >-
                    Unique identification assigned by the initiating party to
                    unambiguously identify the transaction. This identification
                    is passed on, unchanged, throughout the entire end-to-end
                    chain.

                    Usage: The end-to-end identification can be used for
                    reconciliation or to link tasks relating to the transaction.
                    It can be included in several messages related to the
                    transaction.

                    OB: The Faster Payments Scheme can only access 31 characters
                    for the EndToEndIdentification field.
                  type: string
                  minLength: 1
                  maxLength: 35
                LocalInstrument:
                  $ref: '#/components/schemas/OBInternalLocalInstrument1Code'
                InstructionPriority:
                  description: >-
                    Indicator of the urgency or order of importance that the
                    instructing party would like the instructed party to apply
                    to the processing of the instruction.
                  type: string
                  enum:
                    - Normal
                    - Urgent
                ExtendedPurpose:
                  description: >-
                    Specifies the purpose of an international payment, when
                    there is no corresponding 4 character code available in the
                    ISO20022 list of Purpose Codes.
                  type: string
                  minLength: 1
                  maxLength: 140
                ChargeBearer:
                  $ref: '#/components/schemas/OBInternalChargeBearerType1Code'
                RequestedExecutionDateTime:
                  description: >-
                    Date at which the initiating party requests the clearing
                    agent to process the payment. 

                    Usage: This is the date on which the debtor's account is to
                    be debited. All dates in the JSON payloads are represented in
                    ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
                CurrencyOfTransfer:
                  description: >-
                    Specifies the currency of the to be transferred amount,
                    which is different from the currency of the debtor's
                    account.
                  type: string
                  pattern: ^[A-Z]{3,3}$
                DestinationCountryCode:
                  description: >-
                    Country in which Credit Account is domiciled. Code to
                    identify a country, a dependency, or another area of
                    particular geopolitical interest, on the basis of country
                    names obtained from the United Nations (ISO 3166, Alpha-2
                    code).
                  type: string
                  pattern: '[A-Z]{2,2}'
                InstructedAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: >-
                    Amount of money to be moved between the debtor and creditor,
                    before deduction of charges, expressed in the currency as
                    ordered by the initiating party.

                    Usage: This amount has to be transported unchanged through
                    the transaction chain.
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                ExchangeRateInformation:
                  type: object
                  additionalProperties: false
                  required:
                    - UnitCurrency
                    - RateType
                  description: Provides details on the currency exchange rate and contract.
                  properties:
                    UnitCurrency:
                      description: >-
                        Currency in which the rate of exchange is expressed in a
                        currency exchange. In the example 1GBP = xxxCUR, the
                        unit currency is GBP.
                      type: string
                      pattern: ^[A-Z]{3,3}$
                    ExchangeRate:
                      description: >-
                        The factor used for conversion of an amount from one
                        currency to another. This reflects the price at which
                        one currency was bought with another currency.
                      type: number
                    RateType:
                      description: >-
                        Specifies the type used to complete the currency
                        exchange.
                      type: string
                      enum:
                        - Actual
                        - Agreed
                        - Indicative
                    ContractIdentification:
                      description: >-
                        Unique and unambiguous reference to the foreign exchange
                        contract agreed between the initiating party/creditor
                        and the debtor agent.
                      type: string
                      minLength: 1
                      maxLength: 256
                DebtorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                  description: >-
                    Unambiguous identification of the account of the debtor to
                    which a debit entry will be made as a result of the
                    transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level, as displayed
                        by the ASPSP's online channels.

                        Note, the account name is not the product name or the
                        nickname of the account.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                Creditor:
                  type: object
                  additionalProperties: false
                  description: Party to which an amount of money is due.
                  properties:
                    Name:
                      description: >-
                        Name by which a party is known and which is usually used
                        to identify that party.
                      type: string
                      minLength: 1
                      maxLength: 350
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                CreditorAgent:
                  type: object
                  additionalProperties: false
                  description: Financial institution servicing an account for the creditor.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalFinancialInstitutionIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_1'
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    Name:
                      $ref: '#/components/schemas/Name'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                CreditorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: >-
                    Unambiguous identification of the account of the creditor to
                    which a credit entry will be posted as a result of the
                    payment transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level.

                        Note, the account name is not the product name or the
                        nickname of the account.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                UltimateCreditor:
                  $ref: '#/components/schemas/OBUltimateCreditor1'
                UltimateDebtor:
                  $ref: '#/components/schemas/OBUltimateDebtor1'
                RegulatoryReporting:
                  type: array
                  items:
                    $ref: '#/components/schemas/OBRegulatoryReporting1'
                  maxItems: 10
                RemittanceInformation:
                  $ref: '#/components/schemas/OBRemittanceInformation2'
                SupplementaryData:
                  $ref: '#/components/schemas/OBSupplementaryData1'
        Risk:
          $ref: '#/components/schemas/OBRisk1'
    OBWriteInternationalScheduledConsent5:
      type: object
      additionalProperties: false
      required:
        - Data
        - Risk
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
            - Permission
            - Initiation
          properties:
            Permission:
              description: Specifies the Open Banking service request types.
              type: string
              enum:
                - Create
            ReadRefundAccount:
              description: Specifies to share the refund account details with PISP
              type: string
              enum:
                - 'No'
                - 'Yes'
            Initiation:
              type: object
              additionalProperties: false
              required:
                - InstructionIdentification
                - RequestedExecutionDateTime
                - CurrencyOfTransfer
                - InstructedAmount
                - CreditorAccount
              description: >-
                The Initiation payload is sent by the initiating party to the
                ASPSP. It is used to request movement of funds from the debtor
                account to a creditor for a single scheduled international
                payment.
              properties:
                InstructionIdentification:
                  description: >-
                    Unique identification as assigned by an instructing party
                    for an instructed party to unambiguously identify the
                    instruction.

                    Usage: the  instruction identification is a point to point
                    reference that can be used between the instructing party and
                    the instructed party to refer to the individual instruction.
                    It can be included in several messages related to the
                    instruction.
                  type: string
                  minLength: 1
                  maxLength: 35
                EndToEndIdentification:
                  description: >-
                    Unique identification assigned by the initiating party to
                    unambiguously identify the transaction. This identification
                    is passed on, unchanged, throughout the entire end-to-end
                    chain.

                    Usage: The end-to-end identification can be used for
                    reconciliation or to link tasks relating to the transaction.
                    It can be included in several messages related to the
                    transaction.

                    OB: The Faster Payments Scheme can only access 31 characters
                    for the EndToEndIdentification field.
                  type: string
                  minLength: 1
                  maxLength: 35
                LocalInstrument:
                  $ref: '#/components/schemas/OBInternalLocalInstrument1Code'
                InstructionPriority:
                  description: >-
                    Indicator of the urgency or order of importance that the
                    instructing party would like the instructed party to apply
                    to the processing of the instruction.
                  type: string
                  enum:
                    - Normal
                    - Urgent
                ExtendedPurpose:
                  description: >-
                    Specifies the purpose of an international payment, when
                    there is no corresponding 4 character code available in the
                    ISO20022 list of Purpose Codes.
                  type: string
                  minLength: 1
                  maxLength: 140
                ChargeBearer:
                  $ref: '#/components/schemas/OBInternalChargeBearerType1Code'
                RequestedExecutionDateTime:
                  description: >-
                    Date at which the initiating party requests the clearing
                    agent to process the payment. 

                    Usage: This is the date on which the debtor's account is to
                    be debited. All dates in the JSON payloads are represented in
                    ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
                CurrencyOfTransfer:
                  description: >-
                    Specifies the currency of the to be transferred amount,
                    which is different from the currency of the debtor's
                    account.
                  type: string
                  pattern: ^[A-Z]{3,3}$
                DestinationCountryCode:
                  description: >-
                    Country in which Credit Account is domiciled. Code to
                    identify a country, a dependency, or another area of
                    particular geopolitical interest, on the basis of country
                    names obtained from the United Nations (ISO 3166, Alpha-2
                    code).
                  type: string
                  pattern: '[A-Z]{2,2}'
                InstructedAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: >-
                    Amount of money to be moved between the debtor and creditor,
                    before deduction of charges, expressed in the currency as
                    ordered by the initiating party.

                    Usage: This amount has to be transported unchanged through
                    the transaction chain.
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                ExchangeRateInformation:
                  type: object
                  additionalProperties: false
                  required:
                    - UnitCurrency
                    - RateType
                  description: Provides details on the currency exchange rate and contract.
                  properties:
                    UnitCurrency:
                      description: >-
                        Currency in which the rate of exchange is expressed in a
                        currency exchange. In the example 1GBP = xxxCUR, the
                        unit currency is GBP.
                      type: string
                      pattern: ^[A-Z]{3,3}$
                    ExchangeRate:
                      description: >-
                        The factor used for conversion of an amount from one
                        currency to another. This reflects the price at which
                        one currency was bought with another currency.
                      type: number
                    RateType:
                      description: >-
                        Specifies the type used to complete the currency
                        exchange.
                      type: string
                      enum:
                        - Actual
                        - Agreed
                        - Indicative
                    ContractIdentification:
                      description: >-
                        Unique and unambiguous reference to the foreign exchange
                        contract agreed between the initiating party/creditor
                        and the debtor agent.
                      type: string
                      minLength: 1
                      maxLength: 256
                DebtorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                  description: >-
                    Unambiguous identification of the account of the debtor to
                    which a debit entry will be made as a result of the
                    transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level, as displayed
                        by the ASPSP's online channels.

                        Note, the account name is not the product name or the
                        nickname of the account.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                Creditor:
                  type: object
                  additionalProperties: false
                  description: Party to which an amount of money is due.
                  properties:
                    Name:
                      description: >-
                        Name by which a party is known and which is usually used
                        to identify that party.
                      type: string
                      minLength: 1
                      maxLength: 350
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                CreditorAgent:
                  type: object
                  additionalProperties: false
                  description: Financial institution servicing an account for the creditor.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalFinancialInstitutionIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_1'
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    Name:
                      $ref: '#/components/schemas/Name'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                CreditorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: >-
                    Unambiguous identification of the account of the creditor to
                    which a credit entry will be posted as a result of the
                    payment transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level.

                        Note, the account name is not the product name or the
                        nickname of the account.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                UltimateCreditor:
                  $ref: '#/components/schemas/OBUltimateCreditor1'
                UltimateDebtor:
                  $ref: '#/components/schemas/OBUltimateDebtor1'
                RegulatoryReporting:
                  type: array
                  items:
                    $ref: '#/components/schemas/OBRegulatoryReporting1'
                  maxItems: 10
                RemittanceInformation:
                  $ref: '#/components/schemas/OBRemittanceInformation2'
                SupplementaryData:
                  $ref: '#/components/schemas/OBSupplementaryData1'
            Authorisation:
              type: object
              additionalProperties: false
              required:
                - AuthorisationType
              description: The authorisation type request from the TPP.
              properties:
                AuthorisationType:
                  description: Type of authorisation flow requested.
                  type: string
                  enum:
                    - Any
                    - Single
                CompletionDateTime:
                  description: >-
                    Date and time at which the requested authorisation flow must
                    be completed. All dates in the JSON payloads are represented
                    in ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
            SCASupportData:
              $ref: '#/components/schemas/OBSCASupportData1'
        Risk:
          $ref: '#/components/schemas/OBRisk1'
    OBWriteInternationalScheduledConsentResponse6:
      type: object
      additionalProperties: false
      required:
        - Data
        - Risk
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
            - ConsentId
            - CreationDateTime
            - Status
            - StatusUpdateDateTime
            - Permission
            - Initiation
          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. All dates in the
                JSON payloads are represented in ISO 8601 date-time format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            Status:
              description: Specifies the status of consent resource in code form.
              type: string
              enum:
                - AWAU
                - RJCT
                - AUTH
                - COND
            StatusReason:
              type: array
              items:
                $ref: '#/components/schemas/OBStatusReason'
            StatusUpdateDateTime:
              description: >-
                Date and time at which the resource status was updated. All dates
                in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            Permission:
              description: Specifies the Open Banking service request types.
              type: string
              enum:
                - Create
            ReadRefundAccount:
              description: Specifies to share the refund account details with PISP
              type: string
              enum:
                - 'No'
                - 'Yes'
            CutOffDateTime:
              description: >-
                Specified cut-off date and time for the payment consent. All
                dates in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            ExpectedExecutionDateTime:
              description: >-
                Expected execution date and time for the payment resource. All
                dates in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            ExpectedSettlementDateTime:
              description: >-
                Expected settlement date and time for the payment resource. All
                dates in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            Charges:
              type: array
              items:
                type: object
                additionalProperties: false
                description: >-
                  Set of elements used to provide details of a charge for the
                  payment initiation.
                required:
                  - ChargeBearer
                  - Type
                  - Amount
                properties:
                  ChargeBearer:
                    $ref: '#/components/schemas/OBInternalChargeBearerType1Code'
                  Type:
                    $ref: '#/components/schemas/OBInternalPaymentChargeType1Code'
                  Amount:
                    $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount'
            ExchangeRateInformation:
              type: object
              additionalProperties: false
              required:
                - UnitCurrency
                - ExchangeRate
                - RateType
              description: >-
                Further detailed information on the exchange rate that has been
                used in the payment transaction.
              properties:
                UnitCurrency:
                  description: >-
                    Currency in which the rate of exchange is expressed in a
                    currency exchange. In the example 1GBP = xxxCUR, the unit
                    currency is GBP.
                  type: string
                  pattern: ^[A-Z]{3,3}$
                ExchangeRate:
                  description: >-
                    The factor used for conversion of an amount from one
                    currency to another. This reflects the price at which one
                    currency was bought with another currency.
                  type: number
                RateType:
                  description: Specifies the type used to complete the currency exchange.
                  type: string
                  enum:
                    - Actual
                    - Agreed
                    - Indicative
                ContractIdentification:
                  description: >-
                    Unique and unambiguous reference to the foreign exchange
                    contract agreed between the initiating party/creditor and
                    the debtor agent.
                  type: string
                  minLength: 1
                  maxLength: 256
                ExpirationDateTime:
                  description: >-
                    Specified date and time the exchange rate agreement will
                    expire. All dates in the JSON payloads are represented in ISO
                    8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
            Initiation:
              type: object
              additionalProperties: false
              required:
                - InstructionIdentification
                - RequestedExecutionDateTime
                - CurrencyOfTransfer
                - InstructedAmount
                - CreditorAccount
              description: >-
                The Initiation payload is sent by the initiating party to the
                ASPSP. It is used to request movement of funds from the debtor
                account to a creditor for a single scheduled international
                payment.
              properties:
                InstructionIdentification:
                  description: >-
                    Unique identification as assigned by an instructing party
                    for an instructed party to unambiguously identify the
                    instruction.

                    Usage: the  instruction identification is a point to point
                    reference that can be used between the instructing party and
                    the instructed party to refer to the individual instruction.
                    It can be included in several messages related to the
                    instruction.
                  type: string
                  minLength: 1
                  maxLength: 35
                EndToEndIdentification:
                  description: >-
                    Unique identification assigned by the initiating party to
                    unambiguously identify the transaction. This identification
                    is passed on, unchanged, throughout the entire end-to-end
                    chain.

                    Usage: The end-to-end identification can be used for
                    reconciliation or to link tasks relating to the transaction.
                    It can be included in several messages related to the
                    transaction.

                    OB: The Faster Payments Scheme can only access 31 characters
                    for the EndToEndIdentification field.
                  type: string
                  minLength: 1
                  maxLength: 35
                LocalInstrument:
                  $ref: '#/components/schemas/OBInternalLocalInstrument1Code'
                InstructionPriority:
                  description: >-
                    Indicator of the urgency or order of importance that the
                    instructing party would like the instructed party to apply
                    to the processing of the instruction.
                  type: string
                  enum:
                    - Normal
                    - Urgent
                ExtendedPurpose:
                  description: >-
                    Specifies the purpose of an international payment, when
                    there is no corresponding 4 character code available in the
                    ISO20022 list of Purpose Codes.
                  type: string
                  minLength: 1
                  maxLength: 140
                ChargeBearer:
                  $ref: '#/components/schemas/OBInternalChargeBearerType1Code'
                RequestedExecutionDateTime:
                  description: >-
                    Date at which the initiating party requests the clearing
                    agent to process the payment. 

                    Usage: This is the date on which the debtor's account is to
                    be debited. All dates in the JSON payloads are represented in
                    ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
                CurrencyOfTransfer:
                  description: >-
                    Specifies the currency of the to be transferred amount,
                    which is different from the currency of the debtor's
                    account.
                  type: string
                  pattern: ^[A-Z]{3,3}$
                DestinationCountryCode:
                  description: >-
                    Country in which Credit Account is domiciled. Code to
                    identify a country, a dependency, or another area of
                    particular geopolitical interest, on the basis of country
                    names obtained from the United Nations (ISO 3166, Alpha-2
                    code).
                  type: string
                  pattern: '[A-Z]{2,2}'
                InstructedAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: >-
                    Amount of money to be moved between the debtor and creditor,
                    before deduction of charges, expressed in the currency as
                    ordered by the initiating party.

                    Usage: This amount has to be transported unchanged through
                    the transaction chain.
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                ExchangeRateInformation:
                  type: object
                  additionalProperties: false
                  required:
                    - UnitCurrency
                    - RateType
                  description: Provides details on the currency exchange rate and contract.
                  properties:
                    UnitCurrency:
                      description: >-
                        Currency in which the rate of exchange is expressed in a
                        currency exchange. In the example 1GBP = xxxCUR, the
                        unit currency is GBP.
                      type: string
                      pattern: ^[A-Z]{3,3}$
                    ExchangeRate:
                      description: >-
                        The factor used for conversion of an amount from one
                        currency to another. This reflects the price at which
                        one currency was bought with another currency.
                      type: number
                    RateType:
                      description: >-
                        Specifies the type used to complete the currency
                        exchange.
                      type: string
                      enum:
                        - Actual
                        - Agreed
                        - Indicative
                    ContractIdentification:
                      description: >-
                        Unique and unambiguous reference to the foreign exchange
                        contract agreed between the initiating party/creditor
                        and the debtor agent.
                      type: string
                      minLength: 1
                      maxLength: 256
                DebtorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                  description: >-
                    Unambiguous identification of the account of the debtor to
                    which a debit entry will be made as a result of the
                    transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level, as displayed
                        by the ASPSP's online channels.

                        Note, the account name is not the product name or the
                        nickname of the account.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                Creditor:
                  type: object
                  additionalProperties: false
                  description: Party to which an amount of money is due.
                  properties:
                    Name:
                      description: >-
                        Name by which a party is known and which is usually used
                        to identify that party.
                      type: string
                      minLength: 1
                      maxLength: 350
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                CreditorAgent:
                  type: object
                  additionalProperties: false
                  description: Financial institution servicing an account for the creditor.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalFinancialInstitutionIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_1'
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    Name:
                      $ref: '#/components/schemas/Name'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                CreditorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: >-
                    Unambiguous identification of the account of the creditor to
                    which a credit entry will be posted as a result of the
                    payment transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level.

                        Note, the account name is not the product name or the
                        nickname of the account.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                UltimateCreditor:
                  $ref: '#/components/schemas/OBUltimateCreditor1'
                UltimateDebtor:
                  $ref: '#/components/schemas/OBUltimateDebtor1'
                RegulatoryReporting:
                  type: array
                  items:
                    $ref: '#/components/schemas/OBRegulatoryReporting1'
                  maxItems: 10
                RemittanceInformation:
                  $ref: '#/components/schemas/OBRemittanceInformation2'
                SupplementaryData:
                  $ref: '#/components/schemas/OBSupplementaryData1'
            Authorisation:
              type: object
              additionalProperties: false
              required:
                - AuthorisationType
              description: The authorisation type request from the TPP.
              properties:
                AuthorisationType:
                  description: Type of authorisation flow requested.
                  type: string
                  enum:
                    - Any
                    - Single
                CompletionDateTime:
                  description: >-
                    Date and time at which the requested authorisation flow must
                    be completed. All dates in the JSON payloads are represented
                    in ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
            SCASupportData:
              $ref: '#/components/schemas/OBSCASupportData1'
            Debtor:
              $ref: '#/components/schemas/OBCashAccountDebtor4'
        Risk:
          $ref: '#/components/schemas/OBRisk1'
        Links:
          $ref: '#/components/schemas/Links'
        Meta:
          $ref: '#/components/schemas/Meta'
    OBWriteInternationalScheduledResponse6:
      type: object
      additionalProperties: false
      required:
        - Data
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
            - InternationalScheduledPaymentId
            - ConsentId
            - CreationDateTime
            - Status
            - StatusUpdateDateTime
            - Initiation
          properties:
            InternationalScheduledPaymentId:
              description: >-
                OB: Unique identification as assigned by the ASPSP to uniquely
                identify the international scheduled 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. All dates in the
                JSON payloads are represented in ISO 8601 date-time format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            Status:
              description: Specifies the status of the payment order resource.
              type: string
              enum:
                - PDNG
                - ACTC
                - PATC
                - ACCP
                - ACFC
                - ACSP
                - ACWC
                - ACSC
                - ACWP
                - ACCC
                - BLCK
                - RJCT
            StatusUpdateDateTime:
              description: >-
                Date and time at which the resource status was updated. All dates
                in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            StatusReason:
              type: array
              items:
                $ref: '#/components/schemas/OBStatusReason'
            ExpectedExecutionDateTime:
              description: >-
                Expected execution date and time for the payment resource. All
                dates in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            ExpectedSettlementDateTime:
              description: >-
                Expected settlement date and time for the payment resource. All
                dates in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            Refund:
              type: object
              additionalProperties: false
              required:
                - Account
              properties:
                Creditor:
                  type: object
                  additionalProperties: false
                  description: >-
                    Set of elements used to identify a person or an
                    organisation.
                  properties:
                    Name:
                      description: >-
                        Name by which a party is known and which is usually used
                        to identify that party.
                      type: string
                      minLength: 1
                      maxLength: 140
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                Agent:
                  type: object
                  additionalProperties: false
                  description: >-
                    Set of elements used to uniquely and unambiguously identify
                    a financial institution or a branch of a financial
                    institution.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalFinancialInstitutionIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_1'
                    Name:
                      $ref: '#/components/schemas/Name'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                Account:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: Provides the details to identify an account.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    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.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
            Charges:
              type: array
              items:
                type: object
                additionalProperties: false
                description: >-
                  Set of elements used to provide details of a charge for the
                  payment initiation.
                required:
                  - ChargeBearer
                  - Type
                  - Amount
                properties:
                  ChargeBearer:
                    $ref: '#/components/schemas/OBInternalChargeBearerType1Code'
                  Type:
                    $ref: '#/components/schemas/OBInternalPaymentChargeType1Code'
                  Amount:
                    $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount'
            ExchangeRateInformation:
              type: object
              additionalProperties: false
              required:
                - UnitCurrency
                - ExchangeRate
                - RateType
              description: >-
                Further detailed information on the exchange rate that has been
                used in the payment transaction.
              properties:
                UnitCurrency:
                  description: >-
                    Currency in which the rate of exchange is expressed in a
                    currency exchange. In the example 1GBP = xxxCUR, the unit
                    currency is GBP.
                  type: string
                  pattern: ^[A-Z]{3,3}$
                ExchangeRate:
                  description: >-
                    The factor used for conversion of an amount from one
                    currency to another. This reflects the price at which one
                    currency was bought with another currency.
                  type: number
                RateType:
                  description: Specifies the type used to complete the currency exchange.
                  type: string
                  enum:
                    - Actual
                    - Agreed
                    - Indicative
                ContractIdentification:
                  description: >-
                    Unique and unambiguous reference to the foreign exchange
                    contract agreed between the initiating party/creditor and
                    the debtor agent.
                  type: string
                  minLength: 1
                  maxLength: 256
                ExpirationDateTime:
                  description: >-
                    Specified date and time the exchange rate agreement will
                    expire. All dates in the JSON payloads are represented in ISO
                    8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
            Initiation:
              type: object
              additionalProperties: false
              required:
                - InstructionIdentification
                - RequestedExecutionDateTime
                - CurrencyOfTransfer
                - InstructedAmount
                - CreditorAccount
              description: >-
                The Initiation payload is sent by the initiating party to the
                ASPSP. It is used to request movement of funds from the debtor
                account to a creditor for a single scheduled international
                payment.
              properties:
                InstructionIdentification:
                  description: >-
                    Unique identification as assigned by an instructing party
                    for an instructed party to unambiguously identify the
                    instruction.

                    Usage: the  instruction identification is a point to point
                    reference that can be used between the instructing party and
                    the instructed party to refer to the individual instruction.
                    It can be included in several messages related to the
                    instruction.
                  type: string
                  minLength: 1
                  maxLength: 35
                EndToEndIdentification:
                  description: >-
                    Unique identification assigned by the initiating party to
                    unambiguously identify the transaction. This identification
                    is passed on, unchanged, throughout the entire end-to-end
                    chain.

                    Usage: The end-to-end identification can be used for
                    reconciliation or to link tasks relating to the transaction.
                    It can be included in several messages related to the
                    transaction.

                    OB: The Faster Payments Scheme can only access 31 characters
                    for the EndToEndIdentification field.
                  type: string
                  minLength: 1
                  maxLength: 35
                LocalInstrument:
                  $ref: '#/components/schemas/OBInternalLocalInstrument1Code'
                InstructionPriority:
                  description: >-
                    Indicator of the urgency or order of importance that the
                    instructing party would like the instructed party to apply
                    to the processing of the instruction.
                  type: string
                  enum:
                    - Normal
                    - Urgent
                ExtendedPurpose:
                  description: >-
                    Specifies the purpose of an international payment, when
                    there is no corresponding 4 character code available in the
                    ISO20022 list of Purpose Codes.
                  type: string
                  minLength: 1
                  maxLength: 140
                ChargeBearer:
                  $ref: '#/components/schemas/OBInternalChargeBearerType1Code'
                RequestedExecutionDateTime:
                  description: >-
                    Date at which the initiating party requests the clearing
                    agent to process the payment. 

                    Usage: This is the date on which the debtor's account is to
                    be debited. All dates in the JSON payloads are represented in
                    ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
                CurrencyOfTransfer:
                  description: >-
                    Specifies the currency of the to be transferred amount,
                    which is different from the currency of the debtor's
                    account.
                  type: string
                  pattern: ^[A-Z]{3,3}$
                DestinationCountryCode:
                  description: >-
                    Country in which Credit Account is domiciled. Code to
                    identify a country, a dependency, or another area of
                    particular geopolitical interest, on the basis of country
                    names obtained from the United Nations (ISO 3166, Alpha-2
                    code).
                  type: string
                  pattern: '[A-Z]{2,2}'
                InstructedAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: >-
                    Amount of money to be moved between the debtor and creditor,
                    before deduction of charges, expressed in the currency as
                    ordered by the initiating party.

                    Usage: This amount has to be transported unchanged through
                    the transaction chain.
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                ExchangeRateInformation:
                  type: object
                  additionalProperties: false
                  required:
                    - UnitCurrency
                    - RateType
                  description: Provides details on the currency exchange rate and contract.
                  properties:
                    UnitCurrency:
                      description: >-
                        Currency in which the rate of exchange is expressed in a
                        currency exchange. In the example 1GBP = xxxCUR, the
                        unit currency is GBP.
                      type: string
                      pattern: ^[A-Z]{3,3}$
                    ExchangeRate:
                      description: >-
                        The factor used for conversion of an amount from one
                        currency to another. This reflects the price at which
                        one currency was bought with another currency.
                      type: number
                    RateType:
                      description: >-
                        Specifies the type used to complete the currency
                        exchange.
                      type: string
                      enum:
                        - Actual
                        - Agreed
                        - Indicative
                    ContractIdentification:
                      description: >-
                        Unique and unambiguous reference to the foreign exchange
                        contract agreed between the initiating party/creditor
                        and the debtor agent.
                      type: string
                      minLength: 1
                      maxLength: 256
                DebtorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                  description: >-
                    Unambiguous identification of the account of the debtor to
                    which a debit entry will be made as a result of the
                    transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level, as displayed
                        by the ASPSP's online channels.

                        Note, the account name is not the product name or the
                        nickname of the account.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                Creditor:
                  type: object
                  additionalProperties: false
                  description: Party to which an amount of money is due.
                  properties:
                    Name:
                      description: >-
                        Name by which a party is known and which is usually used
                        to identify that party.
                      type: string
                      minLength: 1
                      maxLength: 350
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                CreditorAgent:
                  type: object
                  additionalProperties: false
                  description: Financial institution servicing an account for the creditor.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalFinancialInstitutionIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_1'
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    Name:
                      $ref: '#/components/schemas/Name'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                CreditorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: >-
                    Unambiguous identification of the account of the creditor to
                    which a credit entry will be posted as a result of the
                    payment transaction.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level.

                        Note, the account name is not the product name or the
                        nickname of the account.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                UltimateCreditor:
                  $ref: '#/components/schemas/OBUltimateCreditor1'
                UltimateDebtor:
                  $ref: '#/components/schemas/OBUltimateDebtor1'
                RegulatoryReporting:
                  type: array
                  items:
                    $ref: '#/components/schemas/OBRegulatoryReporting1'
                  maxItems: 10
                RemittanceInformation:
                  $ref: '#/components/schemas/OBRemittanceInformation2'
                SupplementaryData:
                  $ref: '#/components/schemas/OBSupplementaryData1'
            MultiAuthorisation:
              type: object
              additionalProperties: false
              required:
                - Status
              description: The multiple authorisation flow response from the ASPSP.
              properties:
                Status:
                  description: Specifies the status of the authorisation flow in code form.
                  type: string
                  enum:
                    - AUTH
                    - AWAU
                    - RJCT
                NumberRequired:
                  description: >-
                    Number of authorisations required for payment order (total
                    required at the start of the multi authorisation journey).
                  type: integer
                NumberReceived:
                  description: Number of authorisations received.
                  type: integer
                LastUpdateDateTime:
                  description: >-
                    Last date and time at the authorisation flow was updated. All
                    dates in the JSON payloads are represented in ISO 8601
                    date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-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. All dates in the JSON payloads are represented
                    in ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
            Debtor:
              $ref: '#/components/schemas/OBCashAccountDebtor4'
        Links:
          $ref: '#/components/schemas/Links'
        Meta:
          $ref: '#/components/schemas/Meta'
    OBWriteInternationalStandingOrder4:
      type: object
      additionalProperties: false
      required:
        - Data
        - Risk
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
            - ConsentId
            - Initiation
          properties:
            ConsentId:
              description: >-
                OB: Unique identification as assigned by the ASPSP to uniquely
                identify the consent resource.
              type: string
              minLength: 1
              maxLength: 128
            Initiation:
              type: object
              additionalProperties: false
              required:
                - CurrencyOfTransfer
                - InstructedAmount
                - CreditorAccount
                - MandateRelatedInformation
              description: >-
                The Initiation payload is sent by the initiating party to the
                ASPSP. It is used to request movement of funds from the debtor
                account to a creditor for an international standing order.
              properties:
                RemittanceInformation:
                  $ref: '#/components/schemas/OBRemittanceInformation2'
                ExtendedPurpose:
                  description: >-
                    Specifies the purpose of an international payment, when
                    there is no corresponding 4 character code available in the
                    ISO20022 list of Purpose Codes.
                  type: string
                  minLength: 1
                  maxLength: 140
                ChargeBearer:
                  $ref: '#/components/schemas/OBInternalChargeBearerType1Code'
                CurrencyOfTransfer:
                  description: >-
                    Specifies the currency of the to be transferred amount,
                    which is different from the currency of the debtor's
                    account.
                  type: string
                  pattern: ^[A-Z]{3,3}$
                DestinationCountryCode:
                  description: >-
                    Country in which Credit Account is domiciled. Code to
                    identify a country, a dependency, or another area of
                    particular geopolitical interest, on the basis of country
                    names obtained from the United Nations (ISO 3166, Alpha-2
                    code).
                  type: string
                  pattern: '[A-Z]{2,2}'
                InstructedAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: >-
                    Amount of money to be moved between the debtor and creditor,
                    before deduction of charges, expressed in the currency as
                    ordered by the initiating party.

                    Usage: This amount has to be transported unchanged through
                    the transaction chain.
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                DebtorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                  description: Provides the details to identify the debtor account.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level, as displayed
                        by the ASPSP's online channels.

                        Note, the account name is not the product name or the
                        nickname of the account.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                Creditor:
                  type: object
                  additionalProperties: false
                  description: Party to which an amount of money is due.
                  properties:
                    Name:
                      description: >-
                        Name by which a party is known and which is usually used
                        to identify that party.
                      type: string
                      minLength: 1
                      maxLength: 350
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                CreditorAgent:
                  type: object
                  additionalProperties: false
                  description: >-
                    Party that manages the account on behalf of the account
                    owner, that is manages the registration and booking of
                    entries on the account, calculates balances on the account
                    and provides information about the account.

                    This is the servicer of the beneficiary account.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalFinancialInstitutionIdentification4Code
                    Identification:
                      description: >-
                        Unique and unambiguous identification of the servicing
                        institution.
                      type: string
                      minLength: 1
                      maxLength: 35
                    Name:
                      $ref: '#/components/schemas/Name'
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                CreditorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: Provides the details to identify the beneficiary account.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level.

                        Note, the account name is not the product name or the
                        nickname of the account.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                UltimateCreditor:
                  $ref: '#/components/schemas/OBUltimateCreditor1'
                UltimateDebtor:
                  $ref: '#/components/schemas/OBUltimateDebtor1'
                RegulatoryReporting:
                  type: array
                  items:
                    $ref: '#/components/schemas/OBRegulatoryReporting1'
                  maxItems: 10
                MandateRelatedInformation:
                  $ref: '#/components/schemas/OBMandateRelatedInformation1'
                SupplementaryData:
                  $ref: '#/components/schemas/OBSupplementaryData1'
        Risk:
          $ref: '#/components/schemas/OBRisk1'
    OBWriteInternationalStandingOrderConsent6:
      type: object
      additionalProperties: false
      required:
        - Data
        - Risk
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
            - Permission
            - Initiation
          properties:
            Permission:
              description: Specifies the Open Banking service request types.
              type: string
              enum:
                - Create
            ReadRefundAccount:
              description: Specifies to share the refund account details with PISP
              type: string
              enum:
                - 'No'
                - 'Yes'
            Initiation:
              type: object
              additionalProperties: false
              required:
                - CurrencyOfTransfer
                - InstructedAmount
                - CreditorAccount
                - MandateRelatedInformation
              description: >-
                The Initiation payload is sent by the initiating party to the
                ASPSP. It is used to request movement of funds from the debtor
                account to a creditor for an international standing order.
              properties:
                RemittanceInformation:
                  $ref: '#/components/schemas/OBRemittanceInformation2'
                ExtendedPurpose:
                  description: >-
                    Specifies the purpose of an international payment, when
                    there is no corresponding 4 character code available in the
                    ISO20022 list of Purpose Codes.
                  type: string
                  minLength: 1
                  maxLength: 140
                ChargeBearer:
                  $ref: '#/components/schemas/OBInternalChargeBearerType1Code'
                CurrencyOfTransfer:
                  description: >-
                    Specifies the currency of the to be transferred amount,
                    which is different from the currency of the debtor's
                    account.
                  type: string
                  pattern: ^[A-Z]{3,3}$
                DestinationCountryCode:
                  description: >-
                    Country in which Credit Account is domiciled. Code to
                    identify a country, a dependency, or another area of
                    particular geopolitical interest, on the basis of country
                    names obtained from the United Nations (ISO 3166, Alpha-2
                    code).
                  type: string
                  pattern: '[A-Z]{2,2}'
                InstructedAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: >-
                    Amount of money to be moved between the debtor and creditor,
                    before deduction of charges, expressed in the currency as
                    ordered by the initiating party.

                    Usage: This amount has to be transported unchanged through
                    the transaction chain.
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                DebtorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                  description: Provides the details to identify the debtor account.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level, as displayed
                        by the ASPSP's online channels.

                        Note, the account name is not the product name or the
                        nickname of the account.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                Creditor:
                  type: object
                  additionalProperties: false
                  description: Party to which an amount of money is due.
                  properties:
                    Name:
                      description: >-
                        Name by which a party is known and which is usually used
                        to identify that party.
                      type: string
                      minLength: 1
                      maxLength: 350
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                CreditorAgent:
                  type: object
                  additionalProperties: false
                  description: >-
                    Party that manages the account on behalf of the account
                    owner, that is manages the registration and booking of
                    entries on the account, calculates balances on the account
                    and provides information about the account.

                    This is the servicer of the beneficiary account.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalFinancialInstitutionIdentification4Code
                    Identification:
                      description: >-
                        Unique and unambiguous identification of the servicing
                        institution.
                      type: string
                      minLength: 1
                      maxLength: 35
                    Name:
                      $ref: '#/components/schemas/Name'
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                CreditorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: Provides the details to identify the beneficiary account.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level.

                        Note, the account name is not the product name or the
                        nickname of the account.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                UltimateCreditor:
                  $ref: '#/components/schemas/OBUltimateCreditor1'
                UltimateDebtor:
                  $ref: '#/components/schemas/OBUltimateDebtor1'
                RegulatoryReporting:
                  type: array
                  items:
                    $ref: '#/components/schemas/OBRegulatoryReporting1'
                  maxItems: 10
                MandateRelatedInformation:
                  $ref: '#/components/schemas/OBMandateRelatedInformation1'
                SupplementaryData:
                  $ref: '#/components/schemas/OBSupplementaryData1'
            Authorisation:
              type: object
              additionalProperties: false
              required:
                - AuthorisationType
              description: The authorisation type request from the TPP.
              properties:
                AuthorisationType:
                  description: Type of authorisation flow requested.
                  type: string
                  enum:
                    - Any
                    - Single
                CompletionDateTime:
                  description: >-
                    Date and time at which the requested authorisation flow must
                    be completed. All dates in the JSON payloads are represented
                    in ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
            SCASupportData:
              $ref: '#/components/schemas/OBSCASupportData1'
        Risk:
          $ref: '#/components/schemas/OBRisk1'
    OBWriteInternationalStandingOrderConsentResponse7:
      type: object
      additionalProperties: false
      required:
        - Data
        - Risk
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
            - ConsentId
            - CreationDateTime
            - Status
            - StatusUpdateDateTime
            - Permission
            - Initiation
          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. All dates in the
                JSON payloads are represented in ISO 8601 date-time format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            Status:
              description: Specifies the status of consent resource in code form.
              type: string
              enum:
                - AWAU
                - RJCT
                - AUTH
                - COND
            StatusReason:
              type: array
              items:
                $ref: '#/components/schemas/OBStatusReason'
            StatusUpdateDateTime:
              description: >-
                Date and time at which the resource status was updated. All dates
                in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            Permission:
              description: Specifies the Open Banking service request types.
              type: string
              enum:
                - Create
            ReadRefundAccount:
              description: Specifies to share the refund account details with PISP
              type: string
              enum:
                - 'No'
                - 'Yes'
            CutOffDateTime:
              description: >-
                Specified cut-off date and time for the payment consent. All
                dates in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            Charges:
              type: array
              items:
                type: object
                additionalProperties: false
                description: >-
                  Set of elements used to provide details of a charge for the
                  payment initiation.
                required:
                  - ChargeBearer
                  - Type
                  - Amount
                properties:
                  ChargeBearer:
                    $ref: '#/components/schemas/OBInternalChargeBearerType1Code'
                  Type:
                    $ref: '#/components/schemas/OBInternalPaymentChargeType1Code'
                  Amount:
                    $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount'
            Initiation:
              type: object
              additionalProperties: false
              required:
                - CurrencyOfTransfer
                - InstructedAmount
                - CreditorAccount
                - MandateRelatedInformation
              description: >-
                The Initiation payload is sent by the initiating party to the
                ASPSP. It is used to request movement of funds from the debtor
                account to a creditor for an international standing order.
              properties:
                RemittanceInformation:
                  $ref: '#/components/schemas/OBRemittanceInformation2'
                ExtendedPurpose:
                  description: >-
                    Specifies the purpose of an international payment, when
                    there is no corresponding 4 character code available in the
                    ISO20022 list of Purpose Codes.
                  type: string
                  minLength: 1
                  maxLength: 140
                ChargeBearer:
                  $ref: '#/components/schemas/OBInternalChargeBearerType1Code'
                CurrencyOfTransfer:
                  description: >-
                    Specifies the currency of the to be transferred amount,
                    which is different from the currency of the debtor's
                    account.
                  type: string
                  pattern: ^[A-Z]{3,3}$
                DestinationCountryCode:
                  description: >-
                    Country in which Credit Account is domiciled. Code to
                    identify a country, a dependency, or another area of
                    particular geopolitical interest, on the basis of country
                    names obtained from the United Nations (ISO 3166, Alpha-2
                    code).
                  type: string
                  pattern: '[A-Z]{2,2}'
                InstructedAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: >-
                    Amount of money to be moved between the debtor and creditor,
                    before deduction of charges, expressed in the currency as
                    ordered by the initiating party.

                    Usage: This amount has to be transported unchanged through
                    the transaction chain.
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                DebtorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                  description: Provides the details to identify the debtor account.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level, as displayed
                        by the ASPSP's online channels.

                        Note, the account name is not the product name or the
                        nickname of the account.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                Creditor:
                  type: object
                  additionalProperties: false
                  description: Party to which an amount of money is due.
                  properties:
                    Name:
                      description: >-
                        Name by which a party is known and which is usually used
                        to identify that party.
                      type: string
                      minLength: 1
                      maxLength: 350
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                CreditorAgent:
                  type: object
                  additionalProperties: false
                  description: >-
                    Party that manages the account on behalf of the account
                    owner, that is manages the registration and booking of
                    entries on the account, calculates balances on the account
                    and provides information about the account.

                    This is the servicer of the beneficiary account.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalFinancialInstitutionIdentification4Code
                    Identification:
                      description: >-
                        Unique and unambiguous identification of the servicing
                        institution.
                      type: string
                      minLength: 1
                      maxLength: 35
                    Name:
                      $ref: '#/components/schemas/Name'
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                CreditorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: Provides the details to identify the beneficiary account.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level.

                        Note, the account name is not the product name or the
                        nickname of the account.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                UltimateCreditor:
                  $ref: '#/components/schemas/OBUltimateCreditor1'
                UltimateDebtor:
                  $ref: '#/components/schemas/OBUltimateDebtor1'
                RegulatoryReporting:
                  type: array
                  items:
                    $ref: '#/components/schemas/OBRegulatoryReporting1'
                  maxItems: 10
                MandateRelatedInformation:
                  $ref: '#/components/schemas/OBMandateRelatedInformation1'
                SupplementaryData:
                  $ref: '#/components/schemas/OBSupplementaryData1'
            Authorisation:
              type: object
              additionalProperties: false
              required:
                - AuthorisationType
              description: The authorisation type request from the TPP.
              properties:
                AuthorisationType:
                  description: Type of authorisation flow requested.
                  type: string
                  enum:
                    - Any
                    - Single
                CompletionDateTime:
                  description: >-
                    Date and time at which the requested authorisation flow must
                    be completed. All dates in the JSON payloads are represented
                    in ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
            SCASupportData:
              $ref: '#/components/schemas/OBSCASupportData1'
            Debtor:
              $ref: '#/components/schemas/OBCashAccountDebtor4'
        Risk:
          $ref: '#/components/schemas/OBRisk1'
        Links:
          $ref: '#/components/schemas/Links'
        Meta:
          $ref: '#/components/schemas/Meta'
    OBWriteInternationalStandingOrderResponse7:
      type: object
      additionalProperties: false
      required:
        - Data
      properties:
        Data:
          type: object
          additionalProperties: false
          required:
            - InternationalStandingOrderId
            - ConsentId
            - CreationDateTime
            - Status
            - StatusUpdateDateTime
            - Initiation
          properties:
            InternationalStandingOrderId:
              description: >-
                OB: Unique identification as assigned by the ASPSP to uniquely
                identify the international standing order 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 resource was created. All dates in the
                JSON payloads are represented in ISO 8601 date-time format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            Status:
              description: Specifies the status of resource in code form. For a list of values see `ExternalPaymentTransactionStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
              type: string
              enum:
                - RCVD
                - CANC
                - ACTC 
                - PATC
                - PDNG
                - INFA 
                - INCO
                - RJCT
            StatusUpdateDateTime:
              description: >-
                Date and time at which the resource status was updated. All dates
                in the JSON payloads are represented in ISO 8601 date-time
                format. 

                All date-time fields in responses must include the timezone. An
                example is below:

                2017-04-05T10:43:07+00:00
              type: string
              format: date-time
            StatusReason:
              type: array
              items:
                $ref: '#/components/schemas/OBStatusReason'
            Refund:
              type: object
              additionalProperties: false
              required:
                - Account
              properties:
                Creditor:
                  type: object
                  additionalProperties: false
                  description: >-
                    Set of elements used to identify a person or an
                    organisation.
                  properties:
                    Name:
                      description: >-
                        Name by which a party is known and which is usually used
                        to identify that party.
                      type: string
                      minLength: 1
                      maxLength: 350
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                Agent:
                  type: object
                  additionalProperties: false
                  description: >-
                    Set of elements used to uniquely and unambiguously identify
                    a financial institution or a branch of a financial
                    institution.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalFinancialInstitutionIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_1'
                    Name:
                      $ref: '#/components/schemas/Name'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                Account:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: Provides the details to identify an account.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    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.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
            Charges:
              type: array
              items:
                type: object
                additionalProperties: false
                description: >-
                  Set of elements used to provide details of a charge for the
                  payment initiation.
                required:
                  - ChargeBearer
                  - Type
                  - Amount
                properties:
                  ChargeBearer:
                    $ref: '#/components/schemas/OBInternalChargeBearerType1Code'
                  Type:
                    $ref: '#/components/schemas/OBInternalPaymentChargeType1Code'
                  Amount:
                    $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount'
            Initiation:
              type: object
              additionalProperties: false
              required:
                - CurrencyOfTransfer
                - InstructedAmount
                - CreditorAccount
                - MandateRelatedInformation
              description: >-
                The Initiation payload is sent by the initiating party to the
                ASPSP. It is used to request movement of funds from the debtor
                account to a creditor for an international standing order.
              properties:
                RemittanceInformation:
                  $ref: '#/components/schemas/OBRemittanceInformation2'
                ExtendedPurpose:
                  description: >-
                    Specifies the purpose of an international payment, when
                    there is no corresponding 4 character code available in the
                    ISO20022 list of Purpose Codes.
                  type: string
                  minLength: 1
                  maxLength: 140
                ChargeBearer:
                  $ref: '#/components/schemas/OBInternalChargeBearerType1Code'
                CurrencyOfTransfer:
                  description: >-
                    Specifies the currency of the to be transferred amount,
                    which is different from the currency of the debtor's
                    account.
                  type: string
                  pattern: ^[A-Z]{3,3}$
                DestinationCountryCode:
                  description: >-
                    Country in which Credit Account is domiciled. Code to
                    identify a country, a dependency, or another area of
                    particular geopolitical interest, on the basis of country
                    names obtained from the United Nations (ISO 3166, Alpha-2
                    code).
                  type: string
                  pattern: '[A-Z]{2,2}'
                InstructedAmount:
                  type: object
                  additionalProperties: false
                  required:
                    - Amount
                    - Currency
                  description: >-
                    Amount of money to be moved between the debtor and creditor,
                    before deduction of charges, expressed in the currency as
                    ordered by the initiating party.

                    Usage: This amount has to be transported unchanged through
                    the transaction chain.
                  properties:
                    Amount:
                      $ref: >-
                        #/components/schemas/OBActiveCurrencyAndAmount_SimpleType
                    Currency:
                      $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode'
                DebtorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                  description: Provides the details to identify the debtor account.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level, as displayed
                        by the ASPSP's online channels.

                        Note, the account name is not the product name or the
                        nickname of the account.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                Creditor:
                  type: object
                  additionalProperties: false
                  description: Party to which an amount of money is due.
                  properties:
                    Name:
                      description: >-
                        Name by which a party is known and which is usually used
                        to identify that party.
                      type: string
                      minLength: 1
                      maxLength: 350
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                CreditorAgent:
                  type: object
                  additionalProperties: false
                  description: >-
                    Party that manages the account on behalf of the account
                    owner, that is manages the registration and booking of
                    entries on the account, calculates balances on the account
                    and provides information about the account.

                    This is the servicer of the beneficiary account.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalFinancialInstitutionIdentification4Code
                    Identification:
                      description: >-
                        Unique and unambiguous identification of the servicing
                        institution.
                      type: string
                      minLength: 1
                      maxLength: 35
                    Name:
                      $ref: '#/components/schemas/Name'
                    LEI:
                      $ref: '#/components/schemas/LEI'
                    PostalAddress:
                      $ref: '#/components/schemas/OBPostalAddress7'
                CreditorAccount:
                  type: object
                  additionalProperties: false
                  required:
                    - SchemeName
                    - Identification
                    - Name
                  description: Provides the details to identify the beneficiary account.
                  properties:
                    SchemeName:
                      $ref: >-
                        #/components/schemas/OBInternalAccountIdentification4Code
                    Identification:
                      $ref: '#/components/schemas/Identification_0'
                    Name:
                      description: >-
                        The account name is the name or names of the account
                        owner(s) represented at an account level.

                        Note, the account name is not the product name or the
                        nickname of the account.

                        OB: ASPSPs may carry out name validation for
                        Confirmation of Payee, but it is not mandatory.
                      type: string
                      minLength: 1
                      maxLength: 350
                    SecondaryIdentification:
                      $ref: '#/components/schemas/SecondaryIdentification'
                    Proxy:
                      $ref: '#/components/schemas/OBProxy1'
                UltimateCreditor:
                  $ref: '#/components/schemas/OBUltimateCreditor1'
                UltimateDebtor:
                  $ref: '#/components/schemas/OBUltimateDebtor1'
                RegulatoryReporting:
                  type: array
                  items:
                    $ref: '#/components/schemas/OBRegulatoryReporting1'
                  maxItems: 10
                MandateRelatedInformation:
                  $ref: '#/components/schemas/OBMandateRelatedInformation1'
                SupplementaryData:
                  $ref: '#/components/schemas/OBSupplementaryData1'
            MultiAuthorisation:
              type: object
              additionalProperties: false
              required:
                - Status
              description: The multiple authorisation flow response from the ASPSP.
              properties:
                Status:
                  description: Specifies the status of the authorisation flow in code form.
                  type: string
                  enum:
                    - AUTH
                    - AWAU
                    - RJCT
                NumberRequired:
                  description: >-
                    Number of authorisations required for payment order (total
                    required at the start of the multi authorisation journey).
                  type: integer
                NumberReceived:
                  description: Number of authorisations received.
                  type: integer
                LastUpdateDateTime:
                  description: >-
                    Last date and time at the authorisation flow was updated. All
                    dates in the JSON payloads are represented in ISO 8601
                    date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-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. All dates in the JSON payloads are represented
                    in ISO 8601 date-time format. 

                    All date-time fields in responses must include the timezone.
                    An example is below:

                    2017-04-05T10:43:07+00:00
                  type: string
                  format: date-time
            Debtor:
              $ref: '#/components/schemas/OBCashAccountDebtor4'
        Links:
          $ref: '#/components/schemas/Links'
        Meta:
          $ref: '#/components/schemas/Meta'
    OBWritePaymentDetailsResponse1:
      type: object
      required:
        - Data
      properties:
        Data:
          type: "object"
          additionalProperties: false
          properties:
            PaymentStatus:
              type: array
              items:
                $ref: '#/components/schemas/OBWritePaymentDetails1'
        Links:
          $ref: '#/components/schemas/Links'
        Meta:
          $ref: '#/components/schemas/Meta'
    OBWritePaymentDetails1:
      type: object
      required:
        - PaymentTransactionId
        - Status
        - StatusUpdateDateTime
      properties:
        PaymentTransactionId:
          type: string
          minLength: 1
          maxLength: 210
          description: >-
            Unique identifier for the transaction within an servicing
            institution. This identifier is both unique and immutable.
        Status:
          type: string
          description: >-
            Status of a transfer, as assigned by the transaction
            administrator. For a full list of values see `ExternalPaymentTransactionStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
          enum:
            - PDNG
            - ACTC
            - PATC
            - ACCP
            - ACFC
            - ACSP
            - ACWC
            - ACSC
            - ACWP
            - ACCC
            - BLCK
            - RJCT
        StatusUpdateDateTime:
          type: string
          format: date-time
          description: |
            Date and time at which the status was assigned to the transfer.
        StatusDetail:
          type: object
          description: "Payment status details as per underlying Payment Rail."
          required:
            - Status
          properties:
            LocalInstrument:
              $ref: '#/components/schemas/OBInternalLocalInstrument1Code'
            Status:
              description: "Status of a transfer, as assigned by the transaction administrator. For a full list of values see `ExternalPaymentTransactionStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)"
              type: string
              minLength: 1
              maxLength: 4
              enum:
                - PDNG
                - ACTC
                - PATC
                - ACCP
                - ACFC
                - ACSP
                - ACWC
                - ACSC
                - ACWP
                - ACCC
                - BLCK
                - RJCT
            StatusReason:
              description: "Reason Code provided for the status of a transfer. For a full list of values see code values for `OBExternalStatusReason1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)"
              type: string
              minLength: 1
              maxLength: 4
            StatusReasonDescription:
              description: Reason provided for the status of a transfer. For a full list of values see the code name entries for `OBExternalStatusReason1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets).
              type: string
              minLength: 1
              maxLength: 256     
    PostBox:
      description: >-
        Information that locates and identifies a box in a post office assigned
        to a person or organization, where letters for them are kept until
        called for.
      type: string
      minLength: 1
      maxLength: 16
    PostCode:
      description: >-
        Identifier consisting of a group of letters and/or numbers that is added
        to a postal address to assist the sorting of mail.
      type: string
      minLength: 1
      maxLength: 16
    Room:
      description: >-
        Information that locates and identifies a room to form part of an
        address
      type: string
      minLength: 1
      maxLength: 70
    SecondaryIdentification:
      description: >-
        This is secondary identification of the account, as assigned by the
        account servicing institution. 

        This 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
    StreetName:
      description: Name of a street or thoroughfare.
      type: string
      minLength: 1
      maxLength: 140
    SubDepartment:
      description: Identification of a sub-division of a large organisation or building.
      type: string
      minLength: 1
      maxLength: 70
    Time:
      description: >-
        Time at which assets become available to the account owner in case of a
        credit entry, or cease to be available to the account owner in case of a
        debit transaction entry.

        Usage: If transaction entry status is pending and value date is present,
        then the value date refers to an expected/requested value date.

        For transaction entries subject to availability/float and for which
        availability information is provided, the value date must not be used.
        In this case the availability component identifies the number of
        availability days. All dates in the JSON payloads are represented in ISO
        8601 date-time format. 

        All date-time fields in responses must include the timezone. An example
        is below:

        T10:43:07+00:00
      type: string
      format: time
    TownName:
      description: >-
        Name of a built-up area, with defined boundaries, and a local
        government.
      type: string
      minLength: 1
      maxLength: 140
    UnitNumber:
      description: Number that identifies the unit of a specific address .
      type: string
      minLength: 1
      maxLength: 16