Bank of Scotland Domestic Standing Orders API

openapi: 3.2.0
info:
  title: Payment Initiation Domestic Standing Orders 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
servers:
- url: /open-banking/v4.0/pisp
tags:
- name: Domestic Standing Orders
paths:
  /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
components:
  schemas:
    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'
    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
    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
    OBStatusReason:
      type: object
      properties:
        StatusReasonCode:
          type: string
          description: "Specifies the status reason in a code form. \nFor 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
    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 `CountPerPeriod`.'
      type: string
      example: '00'
      maxLength: 2
    OBExternalMandateClassification1Code:
      type: string
      enum:
      - FIXE
      - USGB
      - VARI
    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
    Frequency_1:
      description: 'Individual Definitions:

        NotKnown - Not Known

        EvryDay - Every day

        EvryWorkgDay - Every working day

        IntrvlDay - An interval specified in number of calendar days (02 to 31)

        IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)

        WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07)

        IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-05 to -01, 01 to 31)

        QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED)

        ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December.

        SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November.

        RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December.

        Individual Patterns:

        NotKnown (ScheduleCode)

        EvryDay (ScheduleCode)

        EvryWorkgDay (ScheduleCode)

        IntrvlDay:NoOfDay (ScheduleCode + NoOfDay)

        IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)

        WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)

        IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)

        QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay

        The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:

        NotKnown

        EvryDay

        EvryWorkgDay

        IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1])

        IntrvlWkDay:0[1-9]:0[1-7]

        WkInMnthDay:0[1-5]:0[1-7]

        IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])

        QtrDay:(ENGLISH|SCOTTISH|RECEIVED)

        Full Regular Expression:

        ^(NotKnown)$|^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$'
      type: string
      pattern: ^(NotKnown)$|^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$
    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
    ISODateTime:
      description: "All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
      type: string
      format: date-time
    SubDepartment:
      description: Identification of a sub-division of a large organisation or building.
      type: string
      minLength: 1
      maxLength: 70
    OBFrequency6Code:
      description: For a full list of values see `OBFrequency6Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
      type: string
      enum:
      - ADHO
      - YEAR
      - DAIL
      - FRTN
      - INDA
      - MNTH
      - QURT
      - MIAN
      - WEEK
      - WODL
      - FOWK
      - TWMH
      - FOMH
      - FIMH
      - ALMH
      - NONE
      - LWMH
      - LXMH
      - TWYR
    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}$
    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
    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
    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
    OBSupplementaryData1:
      type: object
      properties: {}
      additionalProperties: true
      description: Additional information that can not be captured in the structured fields and/or any other specific block.
    StreetName:
      description: Name of a street or thoroughfare.
      type: string
      minLength: 1
      maxLength: 140
    OBError1:
      type: object
      properties:
        ErrorCode:
          $ref: '#/components/schemas/OBExternalStatusReason1Code'
        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
    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'
    TownName:
      description: Name of a built-up area, with defined boundaries, and a local government.
      type: string
      minLength: 1
      maxLength: 140
    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
    OBWritePaymentDetails1:
      type: object
      required:
      - PaymentTransactionId
      - Status
      - StatusUpdateDateTime
      properties:
        PaymentTransactionId:
          type: string
          minLength: 1
          maxLength: 210
          description: Unique identifier for the transaction within a servicing institution. This identifier is both unique and immutable.
        Status:
          $ref: '#/components/schemas/ExternalPaymentTransactionStatus1Code'
        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:
              $ref: '#/components/schemas/ExternalPaymentTransactionStatus1Code'
            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
    SecondaryIdentification:
      description: "This is secondary identification of the account, as assigned by the account servicing institution. \nThis can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)."
      type: string
      minLength: 1
      maxLength: 34
    Floor:
      description: Number that identifies the level within a building
      type: string
      minLength: 1
      maxLength: 70
    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'
    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'
    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
    BuildingName:
      description: Name of a referenced building.
      type: string
      minLength: 1
      maxLength: 140
    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}$
    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
            minLength: 1
            maxLength: 2048
    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
    BuildingNumber:
      description: Number that identifies the position of a building on a street.
      type: string
      minLength: 1
      maxLength: 16
    OBFrequency6:
      description: Regularity with which credit transfer instructions are to be created and processed
      type: object
      required:
      - Type
      properties:
        Type:
          oneOf:
          - $ref: '#/components/schemas/OBFrequency6Code'
          - $ref: '#/components/schemas/Frequency_1'
        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'
    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'
    CountryCode:
      description: Nation with its own government.
      type: string
      pattern: ^[A-Z]{2,2}$
    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'
    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
    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. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
              type: string
              format: date-time
            Status:
              $ref: '#/components/schemas/ExternalPaymentTransactionStatus1Code'
            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. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
              type: string
              format: date-time
            StatusReason:
              type: array
              items:
                $ref: '#/components/schemas/OBStatusReason'
            Refund:
              $ref: '#/components/schemas/OBDomesticRefundAccount1'
            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'
                NumberOfPayments:
                  $ref: '#/components/schemas/NumberOfPayments'
                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'
                    

# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/bank-of-scotland/refs/heads/main/openapi/bank-of-scotland-domestic-standing-orders-api-openapi.yml