Coutts

Coutts Payment Initiation API

OBIE Read/Write Payment Initiation (PIS) API for Coutts, letting FCA-authorised PISPs initiate domestic, scheduled, standing-order, international and file payments on behalf of the account holder. Conforms to the OBIE Read/Write Standard and is secured with FAPI OAuth2/OIDC, mTLS and PSD2 strong customer authentication.

GitHub OpenAPI

Documentation

📖
Documentation
https://www.bankofapis.com/products/coutts-open-banking
📖
APIReference
https://www.bankofapis.com/documentation

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/coutts/refs/heads/main/openapi/coutts-payment-initiation-openapi.yaml

Other Resources

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

OpenAPI Specification

coutts-payment-initiation-openapi.yaml Raw ↑ 
openapi: 3.0.0
info:
  title: Payment Initiation API
  description: |
    Swagger for Payment Initiation API Specification.
    
    **Please Note**: There are no optional fields, if a field is not marked as “Required” it is a Conditional field.
  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.1
paths:
  /domestic-payment-consents:
    post:
      tags:
        - Domestic Payment Consents
      summary: Create a Domestic Payment Consent
      description: Enables a PISP to register an intent to initiate a Domestic Payment.
      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'
        - $ref: '#/components/parameters/x-client-id'
      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'
        '422':
          $ref: '#/components/responses/422Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
  /domestic-payment-consents/{ConsentId}:
    get:
      tags:
        - Domestic Payment Consents
      summary: Get a Domestic Payment Consent
      description: Enables a PISP to retrieve the status of an intent to initiate a Domestic Payment.
      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'
        - $ref: '#/components/parameters/x-client-id'
      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 Payment Consents
      summary: Confirm availability of funds for a Domestic Payment
      description: Enables a PISP to check whether a PSU has sufficient available funds for a Domestic Payment.
      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'
        - $ref: '#/components/parameters/x-client-id'
      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: Initiate a Domestic Payment
      description: Enables a PISP to initiate an already PSU-approved Domestic Payment.
      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'
        - $ref: '#/components/parameters/x-client-id'
      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'
        '422':
          $ref: '#/components/responses/422Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - PSUOAuth2Security:
            - payments
  /domestic-payments/{DomesticPaymentId}:
    get:
      tags:
        - Domestic Payments
      summary: Get a Domestic Payment
      description: Enables a PISP to retrieve the status of a Domestic Payment.
      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'
        - $ref: '#/components/parameters/x-client-id'
      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:
        - Domestic Payments
      summary: Get details of a Domestic Payment
      description: Enables a PISP to retrieve detailed information on the status of a Domestic Payment. 
      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'
        - $ref: '#/components/parameters/x-client-id'
      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 Payment Consents
      summary: Create a Domestic Scheduled Payment Consent
      description: Enables a PISP to register an intent to initiate a Domestic Scheduled Payment.
      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'
        - $ref: '#/components/parameters/x-client-id'
      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'
        '422':
          $ref: '#/components/responses/422Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
  /domestic-scheduled-payment-consents/{ConsentId}:
    get:
      tags:
        - Domestic Scheduled Payment Consents
      summary: Get a Domestic Scheduled Payment Consent
      description: Enables a PISP to retrieve the status of an intent to initiate a Domestic Scheduled Payment.
      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'
        - $ref: '#/components/parameters/x-client-id'
      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: Initiate a Domestic Scheduled Payment
      description: Enables a PISP to initiate an already PSU-approved Domestic Scheduled Payment.
      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'
        - $ref: '#/components/parameters/x-client-id'
      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'
        '422':
          $ref: '#/components/responses/422Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - PSUOAuth2Security:
            - payments
  /domestic-scheduled-payments/{DomesticScheduledPaymentId}:
    get:
      tags:
        - Domestic Scheduled Payments
      summary: Get a Domestic Scheduled Payment
      description: Enables a PISP to retrieve the status of a Domestic Scheduled Payment.
      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'
        - $ref: '#/components/parameters/x-client-id'
      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:
        - Domestic Scheduled Payments
      summary: Get details of a Domestic Scheduled Payment
      description: Enables a PISP to retrieve detailed information on the status of a Domestic Scheduled Payment.
      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'
        - $ref: '#/components/parameters/x-client-id'
      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 Order Consents
      summary: Create a Domestic Standing Order Consent
      description: Enables a PISP to register an intent to initiate a Domestic Standing Order arrangement.
      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'
        - $ref: '#/components/parameters/x-client-id'
      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'
        '422':
          $ref: '#/components/responses/422Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
  /domestic-standing-order-consents/{ConsentId}:
    get:
      tags:
        - Domestic Standing Order Consents
      summary: Get a Domestic Standing Order Consent
      description: Enables a PISP to retrieve the status of an intent to initiate a Domestic Standing Order arrangement.
      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'
        - $ref: '#/components/parameters/x-client-id'
      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: Submit a Domestic Standing Order
      description: Enables a PISP to submit a Domestic Standing Order payment under an already PSU-approved Domestic Standing Order arrangement.
      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'
        - $ref: '#/components/parameters/x-client-id'
      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'
        '422':
          $ref: '#/components/responses/422Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - PSUOAuth2Security:
            - payments
  /domestic-standing-orders/{DomesticStandingOrderId}:
    get:
      tags:
        - Domestic Standing Orders
      summary: Get a Domestic Standing Order
      description: Enables a PISP to retrieve the status of a Domestic Standing Order payment.
      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'
        - $ref: '#/components/parameters/x-client-id'
      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:
        - Domestic Standing Orders
      summary: Get details of a Domestic Standing Order Payment
      description: Enables a PISP to retrieve detailed information on the status of a Domestic Standing Order payment.
      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'
        - $ref: '#/components/parameters/x-client-id'
      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 Payment Consents
      summary: Create a File Payment Consent
      description: Enables a PISP to register an intent to initiate a File Payment.
      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'
        - $ref: '#/components/parameters/x-client-id'
      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'
        '422':
          $ref: '#/components/responses/422Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
        - TPPOAuth2Security:
            - payments
  /file-payment-consents/{ConsentId}:
    get:
      tags:
        - File Payment Consents
      summary: Get a File Payment Consent
      description: Enables a PISP to retrieve the status of an intent to initiate a File Payment.
      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'
        - $ref: '#/components/parameters/x-client-id'
      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 Payment Consents
      summary: Upload a File for a ConsentId
      description: Enables a PISP to upload a file of payments to the ASPSP for PSU to authenticate.
      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'
        - $ref: '#/components/parameters/x-client-id'
      requestBody:
        content:
          application/json; charset=utf-8:
            schema:
              $ref: '#/components/schemas/File'
          application/json:
            schema:
              $ref: '#/components/schemas/File'
          application/jose+jwe:
            schema:
        

# --- truncated at 32 KB (501 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/coutts/refs/heads/main/openapi/coutts-payment-initiation-openapi.yaml