Cynergy Bank International Scheduled Payments Consents API

openapi: 3.2.0
info:
  title: Payment Initiation International Scheduled Payments Consents 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: International Scheduled Payments Consents
paths:
  /international-scheduled-payment-consents:
    post:
      tags:
      - International Scheduled Payments Consents
      summary: Create an International Scheduled Payment Consent
      description: Enables a PISP to register an intent to initiate an International Scheduled Payment.
      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'
      - $ref: '#/components/parameters/x-client-id'
      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'
        '422':
          $ref: '#/components/responses/422Error'
        '429':
          $ref: '#/components/responses/429Error'
        '500':
          $ref: '#/components/responses/500Error'
      security:
      - TPPOAuth2Security:
        - payments
  /international-scheduled-payment-consents/{ConsentId}:
    get:
      tags:
      - International Scheduled Payments Consents
      summary: Get an International Scheduled Payment Consent
      description: Enables a PISP to retrieve the status of an intent to initiate an International Scheduled Payment.
      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'
      - $ref: '#/components/parameters/x-client-id'
      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 Consents
      summary: Confirm Funds Availability for an International Scheduled Payment
      description: Enables a PISP to check whether a PSU has sufficient available funds for an International Scheduled Payment.
      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'
      - $ref: '#/components/parameters/x-client-id'
      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
components:
  schemas:
    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
      - CRYP
    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'
    StreetName:
      description: Name of a street or thoroughfare.
      type: string
      minLength: 1
      maxLength: 140
    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
    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. \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
                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'
    CountrySubDivision:
      description: Identifies a subdivision of a country such as state, region, county.
      type: string
      minLength: 1
      maxLength: 35
    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
    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. \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/OBInternalConsentStatus2Code'
            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. \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
            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. \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
            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. \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
            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. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00"
              type: string
              format: date-time
            Charges:
              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. \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
            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. \nUsage: 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. \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
                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. \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
            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'
    TownName:
      description: Name of a built-up area, with defined boundaries, and a local government.
      type: string
      minLength: 1
      maxLength: 140
    BuildingName:
      description: Name of a referenced building.
      type: string
      minLength: 1
      maxLength: 140
    DistrictName:
      description: Number that of the regional area, known as a district, which forms part of an address
      type: string
      minLength: 1
      maxLength: 140
    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
    BuildingNumber:
      description: Number that identifies the position of a building on a street.
      type: string
      minLength: 1
      maxLength: 16
    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 refer to `OBInternalSCAExemptionType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)
          enum:
          - BillPayment
          - ContactlessTravel
          - EcommerceGoods
          - EcommerceServices
          - Kiosk
          - Parking
     

# --- truncated at 32 KB (82 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cynergy-bank/refs/heads/main/openapi/cynergy-bank-international-scheduled-payments-consents-api-openapi.yml