openapi: 3.0.0 info: title: Account and Transaction API Specification Account Access International Standing Orders API description: Swagger for Account and Transaction API Specification termsOfService: https://www.openbanking.org.uk/terms contact: name: Service Desk email: ServiceDesk@openbanking.org.uk license: name: open-licence url: https://www.openbanking.org.uk/open-licence version: 3.1.11 servers: - url: /open-banking/v3.1/aisp tags: - name: International Standing Orders paths: /international-standing-order-consents: post: tags: - International Standing Orders summary: Create International Standing Order Consents operationId: CreateInternationalStandingOrderConsents parameters: - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-idempotency-key' - $ref: '#/components/parameters/x-jws-signature' - $ref: '#/components/parameters/x-customer-user-agent' requestBody: content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBWriteInternationalStandingOrderConsent6' application/json: schema: $ref: '#/components/schemas/OBWriteInternationalStandingOrderConsent6' application/jose+jwe: schema: $ref: '#/components/schemas/OBWriteInternationalStandingOrderConsent6' description: Default required: true responses: 201: $ref: '#/components/responses/201InternationalStandingOrderConsentsCreated' 400: $ref: '#/components/responses/400Error' 401: $ref: '#/components/responses/401Error' 403: $ref: '#/components/responses/403Error' 404: $ref: '#/components/responses/404Error' 405: $ref: '#/components/responses/405Error' 406: $ref: '#/components/responses/406Error' 415: $ref: '#/components/responses/415Error' 429: $ref: '#/components/responses/429Error' 500: $ref: '#/components/responses/500Error' security: - TPPOAuth2Security: - payments /international-standing-order-consents/{ConsentId}: get: tags: - International Standing Orders summary: Get International Standing Order Consents operationId: GetInternationalStandingOrderConsentsConsentId parameters: - $ref: '#/components/parameters/ConsentId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: 200: $ref: '#/components/responses/200InternationalStandingOrderConsentsConsentIdRead' 400: $ref: '#/components/responses/400Error' 401: $ref: '#/components/responses/401Error' 403: $ref: '#/components/responses/403Error' 404: $ref: '#/components/responses/404Error' 405: $ref: '#/components/responses/405Error' 406: $ref: '#/components/responses/406Error' 429: $ref: '#/components/responses/429Error' 500: $ref: '#/components/responses/500Error' security: - TPPOAuth2Security: - payments /international-standing-orders: post: tags: - International Standing Orders summary: Create International Standing Orders operationId: CreateInternationalStandingOrders parameters: - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-idempotency-key' - $ref: '#/components/parameters/x-jws-signature' - $ref: '#/components/parameters/x-customer-user-agent' requestBody: content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBWriteInternationalStandingOrder4' application/json: schema: $ref: '#/components/schemas/OBWriteInternationalStandingOrder4' application/jose+jwe: schema: $ref: '#/components/schemas/OBWriteInternationalStandingOrder4' description: Default required: true responses: 201: $ref: '#/components/responses/201InternationalStandingOrdersCreated' 400: $ref: '#/components/responses/400Error' 401: $ref: '#/components/responses/401Error' 403: $ref: '#/components/responses/403Error' 404: $ref: '#/components/responses/404Error' 405: $ref: '#/components/responses/405Error' 406: $ref: '#/components/responses/406Error' 415: $ref: '#/components/responses/415Error' 429: $ref: '#/components/responses/429Error' 500: $ref: '#/components/responses/500Error' security: - PSUOAuth2Security: - payments /international-standing-orders/{InternationalStandingOrderPaymentId}: get: tags: - International Standing Orders summary: Get International Standing Orders operationId: GetInternationalStandingOrdersInternationalStandingOrderPaymentId parameters: - $ref: '#/components/parameters/InternationalStandingOrderPaymentId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: 200: $ref: '#/components/responses/200InternationalStandingOrdersInternationalStandingOrderPaymentIdRead' 400: $ref: '#/components/responses/400Error' 401: $ref: '#/components/responses/401Error' 403: $ref: '#/components/responses/403Error' 404: $ref: '#/components/responses/404Error' 405: $ref: '#/components/responses/405Error' 406: $ref: '#/components/responses/406Error' 429: $ref: '#/components/responses/429Error' 500: $ref: '#/components/responses/500Error' security: - TPPOAuth2Security: - payments components: schemas: 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 Identification_1: description: Unique and unambiguous identification of a financial institution or a branch of a financial institution. type: string minLength: 1 maxLength: 35 OBChargeBearerType1Code: description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. type: string enum: - BorneByCreditor - BorneByDebtor - FollowingServiceLevel - Shared OBSCASupportData1: type: object properties: RequestedSCAExemptionType: type: string description: This field allows a PISP to request specific SCA Exemption for a Payment Initiation enum: - BillPayment - ContactlessTravel - EcommerceGoods - EcommerceServices - Kiosk - Parking - PartyToParty AppliedAuthenticationApproach: type: string maxLength: 40 description: 'Specifies a character string with a maximum length of 40 characters. Usage: This field indicates whether the PSU was subject to SCA performed by the TPP' enum: - CA - SCA ReferencePaymentOrderId: type: string maxLength: 40 minLength: 1 description: 'If the payment is recurring, then this field is populated with the transaction identifier of the previous payment occurrence so that the ASPSP can verify that the PISP, amount and the payee are the same as the previous occurrence. The value here refers to the payment id e.g. DomesticPaymentId ' description: Supporting Data provided by TPP, when requesting SCA Exemption. OBErrorResponse1: description: An array of detail error codes, and messages, and URLs to documentation to help remediation. type: object additionalProperties: false properties: Code: description: High level textual error code, to help categorize the errors. type: string minLength: 1 maxLength: 40 Id: description: A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors. type: string minLength: 1 maxLength: 40 Message: description: Brief Error message, e.g., 'There is something wrong with the request parameters provided' type: string minLength: 1 maxLength: 500 Errors: items: $ref: '#/components/schemas/OBError1' type: array minItems: 1 required: - Code - Message - Errors OBCashAccountDebtor4: type: object description: ^ Only incuded 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 OBExternalAccountIdentification4Code 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 CountrySubDivision: description: Identifies a subdivision of a country such as state, region, county. type: string minLength: 1 maxLength: 35 OBExternalExtendedAccountType1Code: 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 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 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' OBError1: type: object additionalProperties: false properties: ErrorCode: description: Low level textual error code, e.g., UK.OBIE.Field.Missing type: string x-namespaced-enum: - UK.OBIE.Field.Expected - UK.OBIE.Field.Invalid - UK.OBIE.Field.InvalidDate - UK.OBIE.Field.Missing - UK.OBIE.Field.Unexpected - UK.OBIE.Header.Invalid - UK.OBIE.Header.Missing - UK.OBIE.Reauthenticate - UK.OBIE.Resource.ConsentMismatch - UK.OBIE.Resource.InvalidConsentStatus - UK.OBIE.Resource.InvalidFormat - UK.OBIE.Resource.NotFound - UK.OBIE.Rules.AfterCutOffDateTime - UK.OBIE.Rules.DuplicateReference - UK.OBIE.Signature.Invalid - UK.OBIE.Signature.InvalidClaim - UK.OBIE.Signature.Malformed - UK.OBIE.Signature.Missing - UK.OBIE.Signature.MissingClaim - UK.OBIE.Signature.Unexpected - UK.OBIE.UnexpectedError - UK.OBIE.Unsupported.AccountIdentifier - UK.OBIE.Unsupported.AccountSecondaryIdentifier - UK.OBIE.Unsupported.Currency - UK.OBIE.Unsupported.Frequency - UK.OBIE.Unsupported.LocalInstrument - UK.OBIE.Unsupported.Scheme Message: description: 'A description of the error that occurred. e.g., ''A mandatory field isn''t supplied'' or ''RequestedExecutionDateTime must be in future'' OBIE 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 - Message minProperties: 1 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 OBSupplementaryData1: type: object properties: {} additionalProperties: true description: Additional information that can not be captured in the structured fields and/or any other specific block. OBWriteInternationalStandingOrderConsentResponse7: type: object additionalProperties: false required: - Data - Risk properties: Data: type: object additionalProperties: false required: - ConsentId - CreationDateTime - Status - StatusUpdateDateTime - Permission - Initiation properties: ConsentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' type: string minLength: 1 maxLength: 128 CreationDateTime: description: "Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. \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: description: Specifies the status of resource in code form. type: string enum: - Authorised - AwaitingAuthorisation - Consumed - Rejected 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 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/OBChargeBearerType1Code' Type: $ref: '#/components/schemas/OBExternalPaymentChargeType1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount' Initiation: type: object additionalProperties: false required: - Frequency - FirstPaymentDateTime - 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 an international standing order. properties: Frequency: description: "Individual Definitions:\nEvryDay - Every day\nEvryWorkgDay - Every working day\nIntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)\nWkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07)\nIntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31)\nQtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). \nENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. \nSCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November.\nRECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. \nIndividual Patterns:\nEvryDay (ScheduleCode)\nEvryWorkgDay (ScheduleCode)\nIntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)\nWkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)\nIntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)\nQtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay\nThe regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:\nEvryDay\nEvryWorkgDay\nIntrvlWkDay:0[1-9]:0[1-7]\nWkInMnthDay:0[1-5]:0[1-7]\nIntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])\nQtrDay:(ENGLISH|SCOTTISH|RECEIVED)\nFull Regular Expression:\n^(EvryDay)$|^(EvryWorkgDay)$|^(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: ^(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))$ Reference: description: 'Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor''s reference or payment remittance identification should be quoted in the end-to-end transaction identification.' type: string minLength: 1 maxLength: 35 NumberOfPayments: description: Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date. type: string minLength: 1 maxLength: 35 FirstPaymentDateTime: description: "The date on which the first payment for a Standing Order schedule will be made.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 FinalPaymentDateTime: description: "The date on which the final payment for a Standing Order schedule will be made.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 Purpose: description: 'Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.' type: string minLength: 1 maxLength: 4 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/OBChargeBearerType1Code' CurrencyOfTransfer: description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. type: string pattern: ^[A-Z]{3,3}$ DestinationCountryCode: description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). type: string pattern: '[A-Z]{2,2}' InstructedAmount: type: object additionalProperties: false required: - Amount - Currency description: 'Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.' properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' DebtorAccount: type: object additionalProperties: false required: - SchemeName - Identification description: 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/OBExternalAccountIdentification4Code' 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' 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 PostalAddress: $ref: '#/components/schemas/OBPostalAddress6' CreditorAgent: type: object additionalProperties: false description: 'Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.' properties: SchemeName: $ref: '#/components/schemas/OBExternalFinancialInstitutionIdentification4Code' Identification: description: Unique and unambiguous identification of the servicing institution. type: string minLength: 1 maxLength: 35 Name: $ref: '#/components/schemas/Name' PostalAddress: $ref: '#/components/schemas/OBPostalAddress6' CreditorAccount: type: object additionalProperties: false required: - SchemeName - Identification - Name description: Provides the details to identify the beneficiary account. properties: SchemeName: $ref: '#/components/schemas/OBExternalAccountIdentification4Code' 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' 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' OBAddressTypeCode: description: Identifies the nature of the postal address. type: string enum: - Business - Correspondence - DeliveryTo - MailTo - POBox - Postal - Residential - Statement OBActiveCurrencyAndAmount_SimpleType: description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. type: string pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ OBActiveOrHistoricCurrencyAndAmount: type: object additionalProperties: false required: - Amount - Currency description: Amount of money associated with the charge type. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' StreetName: description: Name of a street or thoroughfare. type: string minLength: 1 maxLength: 70 TownName: description: Name of a built-up area, with defined boundaries, and a local government. type: string minLength: 1 maxLength: 35 OBPostalAddress6: type: object additionalProperties: false description: Information that locates and identifies a specific address, as defined by postal services. properties: AddressType: $ref: '#/components/schemas/OBAddressTypeCode' Department: $ref: '#/components/schemas/Department' SubDepartment: $ref: '#/components/schemas/SubDepartment' StreetName: $ref: '#/components/schemas/StreetName' BuildingNumber: $ref: '#/components/schemas/BuildingNumber' 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 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 Name: description: Name by which an agent is known and which is usually used to identify that agent. type: string minLength: 1 maxLength: 140 SubDepartment: description: Identification of a sub-division of a large organisation or building. type: string minLength: 1 maxLength: 70 OBExternalAccountIdentification4Code: description: Name of the identification scheme, in a coded form as published in an external list. type: string x-namespaced-enum: - UK.OBIE.BBAN - UK.OBIE.IBAN - UK.OBIE.PAN - UK.OBIE.Paym - UK.OBIE.SortCodeAccountNumber - UK.OBIE.Wallet 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}$ OBRisk1: type: object additionalProperties: false properties: PaymentContextCode: type: string description: 'Specifies the payment context * BillPayment - @deprecated * EcommerceGoods - @deprecated * EcommerceServices - @deprecated * Other - @deprecated * PartyToParty - @deprecated ' enum: - BillingGoodsAndServicesInAdvance - BillingGoodsAndServicesInArrears - PispPayee - EcommerceMerchantInitiatedPayment - FaceToFacePointOfSale - TransferToSelf - TransferToThirdParty - BillPayment - EcommerceGoods - EcommerceServices - Other - PartyToParty MerchantCategoryCode: type: string minLength: 3 maxLength: 4 description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. MerchantCustomerIdentification: type: string minLength: 1 maxLength: 70 description: The unique customer identifier of the PSU with the merchant. ContractPresentInidicator: type: boolean description: Indicates if Payee has a contractual relationship with the PISP. BeneficiaryPrepopulatedIndicator: type: boolean description: Indicates if PISP has immutably prepopulated payment details in for the PSU. PaymentPurposeCode: type: string minLength: 3 maxLength: 4 description: Category code, related to the type of services or goods that corresponds to the underlying purpose of the payment that conforms to Recommended UK Purpose Code in ISO 20022 Payment Messaging List BeneficiaryAccountType: $ref: '#/components/schemas/OBExternalExtendedAccountType1Code' DeliveryAddress: required: - Country - TownName type: object properties: AddressLine: maxItems: 2 minItems: 0 type: array items: type: string minLength: 1 maxLength: 70 description: 'Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text.' StreetName: $ref: '#/components/schemas/StreetName' BuildingNumber: $ref: '#/components/schemas/BuildingNumber' PostCode: $ref: '#/components/schemas/PostCode' TownName: $ref: '#/components/schemas/TownName' CountrySubDivision: $ref: '#/components/schemas/CountrySubDivision' Country: $ref: '#/components/schemas/CountryCode' description: 'Information that locates and identifies a specific address, as defined by postal services or in free format text.' description: 'The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.' OBWriteInternationalStandingOrderConsent6: type: object additionalProperties: false required: - Data - Risk properties: Data: type: object additionalProperties: false required: - Permission - Initiation properties: Permission: description: Specifies the Open Banking service request types. type: string enum: - Create ReadRefundAccount: description: Specifies to share the refund account details with PISP type: string enum: - 'No' - 'Yes' Initiation: type: object additionalProperties: false required: - Frequency - FirstPaymentDateTime - 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 an international standing order. properties: Frequency: description: "Individual Definitions:\nEvryDay - Every day\nEvryWorkgDay - Every working day\nIntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)\nWkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07)\nIntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31)\nQtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). \nENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. \nSCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November.\nRECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. \nIndividual Patterns:\nEvryDay (ScheduleCode)\nEvryWorkgDay (ScheduleCode)\nIntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)\nWkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)\nIntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)\nQtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay\nThe regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:\nEvryDay\nEvryWorkgDay\nIntrvlWkDay:0[1-9]:0[1-7]\nWkInMnthDay:0[1-5]:0[1-7]\nIntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])\nQtrDay:(ENGLISH|SCOTTISH|RECEIVED)\nFull Regular Expression:\n^(EvryDay)$|^(EvryWorkgDay)$|^(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: ^(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))$ Reference: description: 'Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor''s reference or payment remittance identification should be quoted in the end-to-end transaction identification.' type: string minLength: 1 maxLength: 35 NumberOfPayments: description: Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date. type: string minLength: 1 maxLength: 35 FirstPaymentDateTime: description: "The date on which the first payment for a Standing Order schedule will be made.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 FinalPaymentDateTime: description: "The date on which the final payment for a Standing Order schedule will be made.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 Purpose: description: 'Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.' type: string minLength: 1 maxLength: 4 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/OBChargeBearerType1Code' CurrencyOfTransfer: description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. type: string pattern: ^[A-Z]{3,3}$ DestinationCountryCode: description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). type: string pattern: '[A-Z]{2,2}' InstructedAmount: type: object additionalProperties: false required: - Amount - Currency description: 'Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.' properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' DebtorAccount: type: object additionalProperties: false required: - SchemeName - Identification description: Provides the details to identify the debtor account. properties: SchemeName: $ref: '#/components/schemas/OBExternalAccountIdentification4Code' 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' 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 PostalAddress: $ref: '#/components/schemas/OBPostalAddress6' CreditorAgent: type: object additionalProperties: false description: 'Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.' properties: SchemeName: $ref: '#/components/schemas/OBExternalFinancialInstitutionIdentification4Code' Identification: description: Unique and unambiguous identification of the servicing institution. type: string minLength: 1 maxLength: 35 Name: $ref: '#/components/schemas/Name' PostalAddress: $ref: '#/components/schemas/OBPostalAddress6' CreditorAccount: type: object additionalProperties: false required: - SchemeName - Identification - Name description: Provides the details to identify the beneficiary account. properties: SchemeName: $ref: '#/components/schemas/OBExternalAccountIdentification4Code' 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' 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' Risk: $ref: '#/components/schemas/OBRisk1' OBExternalFinancialInstitutionIdentification4Code: description: Name of the identification scheme, in a coded form as published in an external list. type: string x-namespaced-enum: - UK.OBIE.BICFI CountryCode: description: Nation with its own government. type: string pattern: ^[A-Z]{2,2}$ OBExternalPaymentChargeType1Code: description: Charge type, in a coded form. type: string x-namespaced-enum: - UK.OBIE.CHAPSOut OBWriteInternationalStandingOrderResponse7: type: object additionalProperties: false required: - Data properties: Data: type: object additionalProperties: false required: - InternationalStandingOrderId - ConsentId - CreationDateTime - Status - StatusUpdateDateTime - Initiation properties: InternationalStandingOrderId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the international standing order resource.' type: string minLength: 1 maxLength: 40 ConsentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' type: string minLength: 1 maxLength: 128 CreationDateTime: description: "Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. \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: description: Specifies the status of resource in code form. type: string enum: - Cancelled - InitiationCompleted - InitiationFailed - InitiationPending 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 Refund: type: object additionalProperties: false required: - Account properties: Creditor: type: object additionalProperties: false description: Set of elements used to identify a person or an organisation. properties: Name: description: Name by which a party is known and which is usually used to identify that party. type: string minLength: 1 maxLength: 350 PostalAddress: $ref: '#/components/schemas/OBPostalAddress6' Agent: type: object additionalProperties: false description: Set of elements used to uniquely and unambiguously identify a financial institution or a branch of a financial institution. properties: SchemeName: $ref: '#/components/schemas/OBExternalFinancialInstitutionIdentification4Code' Identification: $ref: '#/components/schemas/Identification_1' Name: $ref: '#/components/schemas/Name' PostalAddress: $ref: '#/components/schemas/OBPostalAddress6' Account: type: object additionalProperties: false required: - SchemeName - Identification - Name description: Provides the details to identify an account. properties: SchemeName: $ref: '#/components/schemas/OBExternalAccountIdentification4Code' Identification: $ref: '#/components/schemas/Identification_0' Name: description: 'Name of the account, as assigned by the account servicing institution. Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.' type: string minLength: 1 maxLength: 350 SecondaryIdentification: $ref: '#/components/schemas/SecondaryIdentification' Charges: type: array items: type: object additionalProperties: false description: Set of elements used to provide details of a charge for the payment initiation. required: - ChargeBearer - Type - Amount properties: ChargeBearer: $ref: '#/components/schemas/OBChargeBearerType1Code' Type: $ref: '#/components/schemas/OBExternalPaymentChargeType1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount' Initiation: type: object additionalProperties: false required: - Frequency - FirstPaymentDateTime - 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 an international standing order. properties: Frequency: description: "Individual Definitions:\nEvryDay - Every day\nEvryWorkgDay - Every working day\nIntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)\nWkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07)\nIntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31)\nQtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). \nENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. \nSCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November.\nRECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. \nIndividual Patterns:\nEvryDay (ScheduleCode)\nEvryWorkgDay (ScheduleCode)\nIntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)\nWkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)\nIntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)\nQtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay\nThe regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:\nEvryDay\nEvryWorkgDay\nIntrvlWkDay:0[1-9]:0[1-7]\nWkInMnthDay:0[1-5]:0[1-7]\nIntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])\nQtrDay:(ENGLISH|SCOTTISH|RECEIVED)\nFull Regular Expression:\n^(EvryDay)$|^(EvryWorkgDay)$|^(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: ^(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))$ Reference: description: 'Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor''s reference or payment remittance identification should be quoted in the end-to-end transaction identification.' type: string minLength: 1 maxLength: 35 NumberOfPayments: description: Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date. type: string minLength: 1 maxLength: 35 FirstPaymentDateTime: description: "The date on which the first payment for a Standing Order schedule will be made.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 FinalPaymentDateTime: description: "The date on which the final payment for a Standing Order schedule will be made.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 Purpose: description: 'Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.' type: string minLength: 1 maxLength: 4 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/OBChargeBearerType1Code' CurrencyOfTransfer: description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. type: string pattern: ^[A-Z]{3,3}$ DestinationCountryCode: description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). type: string pattern: '[A-Z]{2,2}' InstructedAmount: type: object additionalProperties: false required: - Amount - Currency description: 'Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.' properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' DebtorAccount: type: object additionalProperties: false required: - SchemeName - Identification description: 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/OBExternalAccountIdentification4Code' 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' 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 PostalAddress: $ref: '#/components/schemas/OBPostalAddress6' CreditorAgent: type: object additionalProperties: false description: 'Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.' properties: SchemeName: $ref: '#/components/schemas/OBExternalFinancialInstitutionIdentification4Code' Identification: description: Unique and unambiguous identification of the servicing institution. type: string minLength: 1 maxLength: 35 Name: $ref: '#/components/schemas/Name' PostalAddress: $ref: '#/components/schemas/OBPostalAddress6' CreditorAccount: type: object additionalProperties: false required: - SchemeName - Identification - Name description: Provides the details to identify the beneficiary account. properties: SchemeName: $ref: '#/components/schemas/OBExternalAccountIdentification4Code' 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' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' MultiAuthorisation: type: object additionalProperties: false required: - Status description: The multiple authorisation flow response from the ASPSP. properties: Status: description: Specifies the status of the authorisation flow in code form. type: string enum: - Authorised - AwaitingFurtherAuthorisation - Rejected NumberRequired: description: Number of authorisations required for payment order (total required at the start of the multi authorisation journey). type: integer NumberReceived: description: Number of authorisations received. type: integer LastUpdateDateTime: description: "Last date and time at the authorisation flow was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. \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 ExpirationDateTime: description: "Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. \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 Debtor: $ref: '#/components/schemas/OBCashAccountDebtor4' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' BuildingNumber: description: Number that identifies the position of a building on a street. type: string minLength: 1 maxLength: 16 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 OBWriteInternationalStandingOrder4: type: object additionalProperties: false required: - Data - Risk properties: Data: type: object additionalProperties: false required: - ConsentId - Initiation properties: ConsentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' type: string minLength: 1 maxLength: 128 Initiation: type: object additionalProperties: false required: - Frequency - FirstPaymentDateTime - 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 an international standing order. properties: Frequency: description: "Individual Definitions:\nEvryDay - Every day\nEvryWorkgDay - Every working day\nIntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)\nWkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07)\nIntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31)\nQtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). \nENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. \nSCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November.\nRECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. \nIndividual Patterns:\nEvryDay (ScheduleCode)\nEvryWorkgDay (ScheduleCode)\nIntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)\nWkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)\nIntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)\nQtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay\nThe regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:\nEvryDay\nEvryWorkgDay\nIntrvlWkDay:0[1-9]:0[1-7]\nWkInMnthDay:0[1-5]:0[1-7]\nIntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])\nQtrDay:(ENGLISH|SCOTTISH|RECEIVED)\nFull Regular Expression:\n^(EvryDay)$|^(EvryWorkgDay)$|^(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: ^(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))$ Reference: description: 'Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor''s reference or payment remittance identification should be quoted in the end-to-end transaction identification.' type: string minLength: 1 maxLength: 35 NumberOfPayments: description: Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date. type: string minLength: 1 maxLength: 35 FirstPaymentDateTime: description: "The date on which the first payment for a Standing Order schedule will be made.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 FinalPaymentDateTime: description: "The date on which the final payment for a Standing Order schedule will be made.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 Purpose: description: 'Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org.' type: string minLength: 1 maxLength: 4 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/OBChargeBearerType1Code' CurrencyOfTransfer: description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. type: string pattern: ^[A-Z]{3,3}$ DestinationCountryCode: description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). type: string pattern: '[A-Z]{2,2}' InstructedAmount: type: object additionalProperties: false required: - Amount - Currency description: 'Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain.' properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' DebtorAccount: type: object additionalProperties: false required: - SchemeName - Identification description: Provides the details to identify the debtor account. properties: SchemeName: $ref: '#/components/schemas/OBExternalAccountIdentification4Code' 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' 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 PostalAddress: $ref: '#/components/schemas/OBPostalAddress6' CreditorAgent: type: object additionalProperties: false description: 'Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.' properties: SchemeName: $ref: '#/components/schemas/OBExternalFinancialInstitutionIdentification4Code' Identification: description: Unique and unambiguous identification of the servicing institution. type: string minLength: 1 maxLength: 35 Name: $ref: '#/components/schemas/Name' PostalAddress: $ref: '#/components/schemas/OBPostalAddress6' CreditorAccount: type: object additionalProperties: false required: - SchemeName - Identification - Name description: Provides the details to identify the beneficiary account. properties: SchemeName: $ref: '#/components/schemas/OBExternalAccountIdentification4Code' 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' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' Risk: $ref: '#/components/schemas/OBRisk1' Department: description: Identification of a division of a large organisation or building. type: string minLength: 1 maxLength: 70 responses: 200InternationalStandingOrdersInternationalStandingOrderPaymentIdRead: description: International Standing Orders Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string x-jws-signature: description: 'Header containing a detached JWS signature of the body of the payload. ' required: true schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBWriteInternationalStandingOrderResponse7' application/json: schema: $ref: '#/components/schemas/OBWriteInternationalStandingOrderResponse7' application/jose+jwe: schema: $ref: '#/components/schemas/OBWriteInternationalStandingOrderResponse7' 400Error: description: Bad request headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string x-jws-signature: description: 'Header containing a detached JWS signature of the body of the payload. ' required: true schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBErrorResponse1' application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' application/jose+jwe: schema: $ref: '#/components/schemas/OBErrorResponse1' 500Error: description: Internal Server Error headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string x-jws-signature: description: 'Header containing a detached JWS signature of the body of the payload. ' required: true schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBErrorResponse1' application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' application/jose+jwe: schema: $ref: '#/components/schemas/OBErrorResponse1' 200InternationalStandingOrderConsentsConsentIdRead: description: International Standing Order Consents Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string x-jws-signature: description: 'Header containing a detached JWS signature of the body of the payload. ' required: true schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBWriteInternationalStandingOrderConsentResponse7' application/json: schema: $ref: '#/components/schemas/OBWriteInternationalStandingOrderConsentResponse7' application/jose+jwe: schema: $ref: '#/components/schemas/OBWriteInternationalStandingOrderConsentResponse7' 404Error: description: Not found headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string 406Error: description: Not Acceptable headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string 405Error: description: Method Not Allowed headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string 415Error: description: Unsupported Media Type headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string 403Error: description: Forbidden headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string x-jws-signature: description: 'Header containing a detached JWS signature of the body of the payload. ' required: true schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBErrorResponse1' application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' application/jose+jwe: schema: $ref: '#/components/schemas/OBErrorResponse1' 401Error: description: Unauthorized headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string 201InternationalStandingOrdersCreated: description: International Standing Orders Created headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string x-jws-signature: description: 'Header containing a detached JWS signature of the body of the payload. ' required: true schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBWriteInternationalStandingOrderResponse7' application/json: schema: $ref: '#/components/schemas/OBWriteInternationalStandingOrderResponse7' application/jose+jwe: schema: $ref: '#/components/schemas/OBWriteInternationalStandingOrderResponse7' 429Error: description: Too Many Requests headers: Retry-After: description: Number in seconds to wait schema: type: integer x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string 201InternationalStandingOrderConsentsCreated: description: International Standing Order Consents Created headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string x-jws-signature: description: 'Header containing a detached JWS signature of the body of the payload. ' required: true schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBWriteInternationalStandingOrderConsentResponse7' application/json: schema: $ref: '#/components/schemas/OBWriteInternationalStandingOrderConsentResponse7' application/jose+jwe: schema: $ref: '#/components/schemas/OBWriteInternationalStandingOrderConsentResponse7' parameters: x-fapi-auth-date: in: header name: x-fapi-auth-date required: false description: "The time when the PSU last logged in with the TPP. \nAll dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: \nSun, 10 Sep 2017 19:43:31 UTC" schema: type: string pattern: ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$ x-customer-user-agent: in: header name: x-customer-user-agent description: Indicates the user-agent that the PSU is using. required: false schema: type: string Authorization: in: header name: Authorization required: true description: An Authorisation Token as per https://tools.ietf.org/html/rfc6750 schema: type: string InternationalStandingOrderPaymentId: name: InternationalStandingOrderPaymentId in: path description: InternationalStandingOrderPaymentId required: true schema: type: string ConsentId: name: ConsentId in: path description: ConsentId required: true schema: type: string x-fapi-customer-ip-address: in: header name: x-fapi-customer-ip-address required: false description: The PSU's IP address if the PSU is currently logged in with the TPP. schema: type: string x-fapi-interaction-id: in: header name: x-fapi-interaction-id required: false description: An RFC4122 UID used as a correlation id. schema: type: string x-jws-signature: in: header name: x-jws-signature required: true description: A detached JWS signature of the body of the payload. schema: type: string x-idempotency-key: name: x-idempotency-key in: header description: 'Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours. ' required: true schema: type: string maxLength: 40 pattern: ^(?!\s)(.*)(\S)$ securitySchemes: TPPOAuth2Security: type: oauth2 description: TPP client credential authorisation flow with the ASPSP flows: clientCredentials: tokenUrl: https://authserver.example/token scopes: accounts: Ability to read Accounts information PSUOAuth2Security: type: oauth2 description: OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU flows: authorizationCode: authorizationUrl: https://authserver.example/authorization tokenUrl: https://authserver.example/token scopes: accounts: Ability to read Accounts information