openapi: 3.0.0 info: title: Account and Transaction API Specification Account Access Consents International Scheduled Payments API description: 'Swagger for Account and Transaction 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/aisp tags: - name: International Scheduled Payments paths: /international-scheduled-payments: post: tags: - International Scheduled Payments summary: Initiate an International Scheduled Payment description: Enables a PISP to initiate an already PSU-approved International Scheduled Payment. operationId: CreateInternationalScheduledPayments parameters: - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-idempotency-key' - $ref: '#/components/parameters/x-jws-signature' - $ref: '#/components/parameters/x-customer-user-agent' - $ref: '#/components/parameters/x-client-id' requestBody: content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBWriteInternationalScheduled3' application/json: schema: $ref: '#/components/schemas/OBWriteInternationalScheduled3' application/jose+jwe: schema: $ref: '#/components/schemas/OBWriteInternationalScheduled3' description: Default required: true responses: '201': $ref: '#/components/responses/201InternationalScheduledPaymentsCreated' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' '404': $ref: '#/components/responses/404Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '409': $ref: '#/components/responses/409Error' '415': $ref: '#/components/responses/415Error' '422': $ref: '#/components/responses/422Error' '429': $ref: '#/components/responses/429Error' '500': $ref: '#/components/responses/500Error' security: - PSUOAuth2Security: - payments /international-scheduled-payments/{InternationalScheduledPaymentId}: get: tags: - International Scheduled Payments summary: Get an International Scheduled Payment description: Enables a PISP to retrieve the status of an International Scheduled Payment. operationId: GetInternationalScheduledPaymentsInternationalScheduledPaymentId parameters: - $ref: '#/components/parameters/InternationalScheduledPaymentId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' - $ref: '#/components/parameters/x-client-id' responses: '200': $ref: '#/components/responses/200InternationalScheduledPaymentsInternationalScheduledPaymentIdRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' '404': $ref: '#/components/responses/404Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' '500': $ref: '#/components/responses/500Error' security: - TPPOAuth2Security: - payments /international-scheduled-payments/{InternationalScheduledPaymentId}/payment-details: get: tags: - International Scheduled Payments summary: Get details of an International Scheduled Payment description: Enables a PISP to retrieve detailed information on the status of an International Scheduled Payment. operationId: GetInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails parameters: - $ref: '#/components/parameters/InternationalScheduledPaymentId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' - $ref: '#/components/parameters/x-client-id' responses: '200': $ref: '#/components/responses/200InternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetailsRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '403': $ref: '#/components/responses/403Error' '404': $ref: '#/components/responses/404Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' '500': $ref: '#/components/responses/500Error' security: - TPPOAuth2Security: - payments components: schemas: OBRemittanceInformation2: type: object description: Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system properties: Structured: type: array items: $ref: '#/components/schemas/OBRemittanceInformationStructured' Unstructured: type: array description: Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in an unstructured form. items: type: string maxLength: 140 minLength: 1 LEI: description: Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)". type: string example: IZ9Q00LZEVUKWCQY6X15 minLength: 1 maxLength: 20 pattern: ^[A-Z0-9]{18,18}[0-9]{2,2}$ ExternalCategoryPurpose1Code: description: "Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. \n For all enum values see `ExternalCategoryPurpose1Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)" type: string enum: - BONU - CASH - CBLK - CCRD - CGWV - CIPC - CONC - CORT - DCRD - DIVI - DVPM - EPAY - FCDT - FCIN - FCOL - GOVT - GP2P - HEDG - ICCP - IDCP - INTC - INTE - LBOX - LOAN - MP2B - MP2P - OTHR - PENS - RPRE - RRCT - RVPM - SALA - SECU - SSBE - SUPP - SWEP - TAXS - TOPG - TRAD - TREA - VATX - VOST - WHLD - ZABA StreetName: description: Name of a street or thoroughfare. type: string minLength: 1 maxLength: 140 OBCashAccountDebtor4: type: object description: ^ Only included in the response if `Data. ReadRefundAccount` is set to `Yes` in the consent. properties: SchemeName: type: string description: ^ Name of the identification scheme, in a coded form as published in an external list. | Namespaced Enumeration OBInternalAccountIdentification4Code Identification: type: string description: ^ Identification assigned by an institution to identify an account. This identification is known by the account owner. | Max256Text Name: type: string description: ^ Name of the account, as assigned by the account servicing institution. Usage The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. SecondaryIdentification: type: string description: ^ This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination) | Max34Text LEI: $ref: '#/components/schemas/LEI' 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' 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 OBWriteInternationalScheduledResponse6: type: object additionalProperties: false required: - Data properties: Data: type: object additionalProperties: false required: - InternationalScheduledPaymentId - ConsentId - CreationDateTime - Status - StatusUpdateDateTime - Initiation properties: InternationalScheduledPaymentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the international scheduled payment resource.' type: string minLength: 1 maxLength: 40 ConsentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' type: string minLength: 1 maxLength: 128 CreationDateTime: description: "Date and time at which the message was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. \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/ExternalPaymentTransactionStatus2Code' StatusUpdateDateTime: description: "Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time StatusReason: type: array items: $ref: '#/components/schemas/OBStatusReason' 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 Refund: $ref: '#/components/schemas/OBDomesticRefundAccount1' Charges: type: array items: type: object additionalProperties: false description: Set of elements used to provide details of a charge for the payment initiation. required: - ChargeBearer - Type - Amount properties: ChargeBearer: $ref: '#/components/schemas/OBInternalChargeBearerType1Code' Type: $ref: '#/components/schemas/OBInternalPaymentChargeType1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount' 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' MultiAuthorisation: type: object additionalProperties: false required: - Status description: The multiple authorisation flow response from the ASPSP. properties: Status: description: Specifies the status of the authorisation flow in code form. type: string enum: - AUTH - AWAF - RJCT NumberRequired: description: Number of authorisations required for payment order (total required at the start of the multi authorisation journey). type: integer NumberReceived: description: Number of authorisations received. type: integer LastUpdateDateTime: description: "Last date and time at the authorisation flow was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. \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' 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}$ CountryCode: description: Nation with its own government. type: string pattern: ^[A-Z]{2,2}$ OBInternalAccountIdentification4Code: description: Name of the identification scheme, in a coded form as published in an external list. For a full list of values refer to `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string x-namespaced-enum: - UK.OBIE.BBAN - UK.OBIE.IBAN - UK.OBIE.PAN - UK.OBIE.Paym - UK.OBIE.SortCodeAccountNumber - UK.OBIE.Wallet TownName: description: Name of a built-up area, with defined boundaries, and a local government. type: string minLength: 1 maxLength: 140 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 Department: description: Identification of a division of a large organisation or building. type: string minLength: 1 maxLength: 70 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}$ Identification_4: description: Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor. type: string example: '80200112344562' minLength: 1 maxLength: 256 ExternalProxyAccountType1Code: description: Specifies the external proxy account type code, as published in the proxy account type external code set.
For a full list of values see `ExternalProxyAccountType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string enum: - TELE - EMAL - DNAM - CINC - COTX - COID - CUST - DRLC - EIDN - EWAL - PVTX - LEIC - MBNO - NIDN - CCPT - SHID - SOSE - TOKN - UBIL - VIPN - BIID OBInternalFinancialInstitutionIdentification4Code: description: Name of the identification scheme, in a coded form as published in an external list. type: string x-namespaced-enum: - UK.OBIE.BICFI OBInternalChargeBearerType1Code: description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. For a full list of values refer to `OBInternalChargeBearerType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string enum: - BorneByCreditor - BorneByDebtor - FollowingServiceLevel - Shared OBInternalLocalInstrument1Code: description: 'User community specific instrument. Usage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level. For a full list of values refer to `OBInternalLocalInstrument1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)' type: string x-namespaced-enum: - UK.OBIE.BACS - UK.OBIE.BalanceTransfer - UK.OBIE.CHAPS - UK.OBIE.Euro1 - UK.OBIE.FPS - UK.OBIE.Link - UK.OBIE.MoneyTransfer - UK.OBIE.Paym - UK.OBIE.SEPACreditTransfer - UK.OBIE.SEPAInstantCreditTransfer - UK.OBIE.SWIFT - UK.OBIE.Target2 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' 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 OBAddressType2Code: description: Identifies the nature of the postal address. For a full set of codes see `OBAddressType2Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets). type: string enum: - BIZZ - DLVY - MLTO - PBOX - ADDR - HOME - CORR - STAT BuildingName: description: Name of a referenced building. type: string minLength: 1 maxLength: 140 ExternalPaymentTransactionStatus2Code: description: "Specifies the status of the payment order resource. \n\nFor a full list of values see `ExternalPaymentTransactionStatus2Code` in *OB_Internal_CodeSet* \n[here](https://github.com/OpenBankingUK/External_Internal_CodeSets)\n" type: string enum: - CANC - RCVD - PDNG - ACTC - PATC - ACCP - ACFC - ACSP - ACWC - ACSC - BLCK - ACCC - ACWP - RJCT BuildingNumber: description: Number that identifies the position of a building on a street. type: string minLength: 1 maxLength: 16 Floor: description: Number that identifies the level within a building type: string minLength: 1 maxLength: 70 OBReferredDocumentInformation: type: object properties: Code: $ref: '#/components/schemas/ExternalDocumentType1Code' Issuer: description: Identification of the issuer of the reference document type. type: string maxLength: 35 minLength: 1 Number: description: Identification of the type specified for the referred document line. type: string maxLength: 35 minLength: 1 RelatedDate: description: Date associated with the referred document line. type: string format: date-time LineDetails: description: Set of elements used to provide the content of the referred document line. type: array items: type: string minLength: 1 maxLength: 2048 OBWriteInternationalScheduled3: type: object additionalProperties: false required: - Data - Risk properties: Data: type: object additionalProperties: false required: - ConsentId - Initiation properties: ConsentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' type: string minLength: 1 maxLength: 128 Initiation: type: object additionalProperties: false required: - InstructionIdentification - RequestedExecutionDateTime - CurrencyOfTransfer - InstructedAmount - CreditorAccount description: The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment. properties: InstructionIdentification: description: 'Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.' type: string minLength: 1 maxLength: 35 EndToEndIdentification: description: 'Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field.' type: string minLength: 1 maxLength: 35 LocalInstrument: $ref: '#/components/schemas/OBInternalLocalInstrument1Code' InstructionPriority: description: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. type: string enum: - Normal - Urgent ExtendedPurpose: description: Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes. type: string minLength: 1 maxLength: 140 ChargeBearer: $ref: '#/components/schemas/OBInternalChargeBearerType1Code' RequestedExecutionDateTime: description: "Date at which the initiating party requests the clearing agent to process the payment. \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' Risk: $ref: '#/components/schemas/OBRisk1' ExternalCreditorReferenceType1Code: type: string minLength: 1 maxLength: 4 description: Specifies the type of creditor reference as published in an external creditor reference type code set. For more information see `ExternalCreditorReferenceType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - DISP - FXDR - PUOR - RPIN - RADM - SCOR SubDepartment: description: Identification of a sub-division of a large organisation or building. type: string minLength: 1 maxLength: 70 OBRegulatoryReporting1: type: object description: Information needed due to regulatory and statutory requirements properties: DebitCreditReportingIndicator: type: string description: Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction. For a full list of values refer to `OBExternalRegulatoryReportingType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - CRED - DEBT - BOTH Authority: $ref: '#/components/schemas/OBRegulatoryAuthority2' Details: type: array items: $ref: '#/components/schemas/OBStructuredRegulatoryReporting3' CareOf: description: The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual. type: string minLength: 1 maxLength: 140 OBExternalStatusReason1Code: description: Low level textual error code, for all enum values see `OBExternalStatusReason1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string minLength: 4 maxLength: 4 example: U001 OBStatusReason: type: object properties: StatusReasonCode: type: string description: "Specifies the status reason in a code form. \nFor a full list of values refer to `OBExternalStatusReason1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)" minLength: 1 maxLength: 4 example: ERIN StatusReasonDescription: description: Description supporting the StatusReasonCode. type: string minLength: 1 maxLength: 500 Path: type: string description: Path is optional but relevant when the status reason refers to an object/field and hence conditional to provide JSON path. minLength: 1 maxLength: 500 OBSupplementaryData1: type: object properties: {} additionalProperties: true description: Additional information that can not be captured in the structured fields and/or any other specific block. OBPostalAddress7: type: object additionalProperties: false description: Information that locates and identifies a specific address, as defined by postal services. properties: AddressType: $ref: '#/components/schemas/OBAddressType2Code' Department: $ref: '#/components/schemas/Department' SubDepartment: $ref: '#/components/schemas/SubDepartment' StreetName: $ref: '#/components/schemas/StreetName' BuildingNumber: $ref: '#/components/schemas/BuildingNumber' BuildingName: $ref: '#/components/schemas/BuildingName' Floor: $ref: '#/components/schemas/Floor' UnitNumber: $ref: '#/components/schemas/UnitNumber' Room: $ref: '#/components/schemas/Room' PostBox: $ref: '#/components/schemas/PostBox' TownLocationName: $ref: '#/components/schemas/TownName' DistrictName: $ref: '#/components/schemas/DistrictName' CareOf: $ref: '#/components/schemas/CareOf' PostCode: $ref: '#/components/schemas/PostCode' TownName: $ref: '#/components/schemas/TownName' CountrySubDivision: $ref: '#/components/schemas/CountrySubDivision' Country: $ref: '#/components/schemas/CountryCode' AddressLine: type: array items: description: Information that locates and identifies a specific address, as defined by postal services, presented in free format text. type: string minLength: 1 maxLength: 70 minItems: 0 maxItems: 7 OBDomesticRefundAccount1: description: Unambiguous identification of the refund account to which a refund will be made as a result of the transaction. type: object additionalProperties: false required: - Account properties: Account: type: object additionalProperties: false required: - SchemeName - Identification - Name description: Provides the details to identify an account. properties: SchemeName: $ref: '#/components/schemas/OBInternalAccountIdentification4Code' Identification: $ref: '#/components/schemas/Identification_0' Name: description: 'Name of the account, as assigned by the account servicing institution. Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.' type: string minLength: 1 maxLength: 350 SecondaryIdentification: $ref: '#/components/schemas/SecondaryIdentification' OBWritePaymentDetailsResponse1: type: object required: - Data properties: Data: type: object additionalProperties: false properties: PaymentStatus: type: array items: $ref: '#/components/schemas/OBWritePaymentDetails1' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' OBInternalExtendedAccountType1Code: description: Specifies the extended type of account. type: string enum: - Business - BusinessSavingsAccount - Charity - Collection - Corporate - Ewallet - Government - Investment - ISA - JointPersonal - Pension - Personal - PersonalSavingsAccount - Premier - Wealth ExternalPaymentTransactionStatus1Code: description: "The current status of the payment resource.\n\nFor a full list of values see `ExternalPaymentTransactionStatus1Code` in *OB_Internal_CodeSet* \n[here](https://github.com/OpenBankingUK/External_Internal_CodeSets)\n" type: string enum: - CANC - RCVD - ACTC - PATC - PDNG - RJCT - INFA - INCO - ACCP - ACFC - ACSP - ACWC - ACSC - BLCK - ACCC - ACWP DistrictName: description: Number that of the regional area, known as a district, which forms part of an address type: string minLength: 1 maxLength: 140 OBRegulatoryAuthority2: type: object description: 'Entity requiring the regulatory reporting information. ' properties: Name: type: string description: Name of the entity requiring the regulatory reporting information. minLength: 1 maxLength: 140 CountryCode: $ref: '#/components/schemas/CountryCode' 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' 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 OBUltimateDebtor1: description: Ultimate party that owes an amount of money to the (ultimate) creditor. type: object properties: Name: description: Name by which a party is known and which is usually used to identify that party. type: string minLength: 1 maxLength: 140 Identification: description: Identification assigned by an institution. type: string minLength: 1 maxLength: 256 LEI: $ref: '#/components/schemas/LEI' SchemeName: $ref: '#/components/schemas/OBInternalAccountIdentification4Code' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' 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 ExternalDocumentType1Code: type: string minLength: 1 maxLength: 4 description: Specifies the document type as published in an external document type code list. For more information see `ExternalDocumentType1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - CINV - CNFA - CONT - CREN - DEBN - DISP - DNFA - HIRI - INVS - MSIN - PROF - PUOR - QUOT - SBIN - SPRR - TISH OBWritePaymentDetails1: type: object required: - PaymentTransactionId - Status - StatusUpdateDateTime properties: PaymentTransactionId: type: string minLength: 1 maxLength: 210 description: Unique identifier for the transaction within a servicing institution. This identifier is both unique and immutable. Status: $ref: '#/components/schemas/ExternalPaymentTransactionStatus1Code' StatusUpdateDateTime: type: string format: date-time description: 'Date and time at which the status was assigned to the transfer. ' StatusDetail: type: object description: Payment status details as per underlying Payment Rail. required: - Status properties: LocalInstrument: $ref: '#/components/schemas/OBInternalLocalInstrument1Code' Status: $ref: '#/components/schemas/ExternalPaymentTransactionStatus1Code' StatusReason: description: Reason Code provided for the status of a transfer. For a full list of values see code values for `OBExternalStatusReason1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) type: string minLength: 1 maxLength: 4 StatusReasonDescription: description: Reason provided for the status of a transfer. For a full list of values see the code name entries for `OBExternalStatusReason1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets). type: string minLength: 1 maxLength: 256 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 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 UnitNumber: description: Number that identifies the unit of a specific address . type: string minLength: 1 maxLength: 16 OBProxy1: description: Specifies an alternate assumed name for the identification of the account. type: object required: - Identification - Code properties: Identification: description: Identification used to indicate the account identification under another specified name. type: string minLength: 1 maxLength: 2048 Code: $ref: '#/components/schemas/ExternalProxyAccountType1Code' Type: type: string description: Type of the proxy identification. minLength: 1 maxLength: 35 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 CountrySubDivision: description: Identifies a subdivision of a country such as state, region, county. type: string minLength: 1 maxLength: 35 OBRemittanceInformationStructured: type: object properties: ReferredDocumentInformation: type: array items: $ref: '#/components/schemas/OBReferredDocumentInformation' ReferredDocumentAmount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' CreditorReferenceInformation: description: Reference information provided by the creditor to allow the identification of the underlying documents. type: object properties: Code: $ref: '#/components/schemas/ExternalCreditorReferenceType1Code' Issuer: description: Entity that assigns the identification. type: string minLength: 1 maxLength: 35 Reference: description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. type: string minLength: 1 maxLength: 35 Invoicer: $ref: '#/components/schemas/Identification_3' Invoicee: $ref: '#/components/schemas/Identification_4' TaxRemittance: description: Provides remittance information about a payment made for tax-related purposes. type: string maxLength: 140 minLength: 1 AdditionalRemittanceInformation: description: Additional information, in free text form, to complement the structured remittance information. type: array items: type: string maxLength: 140 minLength: 1 maxItems: 3 Room: description: Information that locates and identifies a room to form part of an address type: string minLength: 1 maxLength: 70 Identification_1: description: Unique identification, as assigned by the creditor, to unambiguously identify the mandate. type: string minLength: 1 maxLength: 35 Identification_3: description: Identification of the organisation issuing the invoice, when it is different from the creditor or ultimate creditor type: string example: '80200112344562' minLength: 1 maxLength: 256 OBRisk1: type: object additionalProperties: false properties: PaymentContextCode: type: string description: 'Specifies the payment context, `OBInternalPaymentContext1Code`
The following values are deprecated and **must not** be used in a new consent or payment. They may optionally be returned for a historical payment/consent migrated to v4:
* BillPayment - @deprecated * EcommerceGoods - @deprecated * EcommerceServices - @deprecated * PartyToParty - @deprecated * PispPayee - @deprecated * Other - @deprecated ' enum: - BillingGoodsAndServicesInAdvance - BillingGoodsAndServicesInArrears - EcommerceMerchantInitiatedPayment - FaceToFacePointOfSale - TransferToSelf - TransferToThirdParty - BillPayment - EcommerceGoods - EcommerceServices - PartyToParty - PispPayee - Other MerchantCategoryCode: type: string minLength: 3 maxLength: 4 description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. MerchantCustomerIdentification: type: string minLength: 1 maxLength: 70 description: The unique customer identifier of the PSU with the merchant. ContractPresentIndicator: type: boolean description: Indicates if Payee has a contractual relationship with the PISP. BeneficiaryPrepopulatedIndicator: type: boolean description: Indicates if PISP has immutably prepopulated payment details in for the PSU. PaymentPurposeCode: $ref: '#/components/schemas/ExternalPurpose1Code' CategoryPurposeCode: $ref: '#/components/schemas/ExternalCategoryPurpose1Code' BeneficiaryAccountType: $ref: '#/components/schemas/OBInternalExtendedAccountType1Code' DeliveryAddress: $ref: '#/components/schemas/OBPostalAddress7' description: 'The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.' OBErrorResponse1: description: An array of detail error codes, and messages, and URLs to documentation to help remediation. type: object additionalProperties: false properties: Id: description: A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors. type: string minLength: 1 maxLength: 40 Code: description: Deprecated
High level textual error code, to help categorise the errors. type: string minLength: 1 example: 400 BadRequest maxLength: 40 Message: description: Deprecated
Brief Error message type: string minLength: 1 example: There is something wrong with the request parameters provided maxLength: 500 Errors: items: $ref: '#/components/schemas/OBError1' type: array minItems: 1 required: - Errors 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 OBError1: type: object properties: ErrorCode: $ref: '#/components/schemas/OBExternalStatusReason1Code' Message: description: 'A description of the error that occurred. e.g., ''A mandatory field isn''t supplied'' or ''RequestedExecutionDateTime must be in future'' OBL doesn''t standardise this field' type: string minLength: 1 maxLength: 500 Path: description: Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency type: string minLength: 1 maxLength: 500 Url: description: URL to help remediate the problem, or provide more information, or to API Reference, or help etc type: string required: - ErrorCode additionalProperties: false minProperties: 1 parameters: x-client-id: in: header name: x-client-id required: false description: "Only used if an ASPSP requires the client ID in order to return rate limit headers. \n\nTPPs __must__ refer to ASPSP developer portals for further information on any rate limit policies, if the headers are supported and any additional requirements.\n\nThis header __must not__ be used for client authentication\n" schema: type: string x-idempotency-key: name: x-idempotency-key in: header description: 'Every request will be processed only once per x-idempotency-key. The Idempotency Key will be valid for 24 hours. ' required: true schema: type: string maxLength: 40 pattern: ^(?!\s)(.*)(\S)$ x-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-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-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-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)$ InternationalScheduledPaymentId: name: InternationalScheduledPaymentId in: path description: InternationalScheduledPaymentId required: true schema: type: string Authorization: in: header name: Authorization required: true description: An Authorisation Token as per https://tools.ietf.org/html/rfc6750 schema: type: string x-customer-user-agent: in: header name: x-customer-user-agent description: Indicates the user-agent that the PSU is using. required: false schema: type: string responses: 405Error: description: Method Not Allowed headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string 500Error: description: Internal Server Error headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string x-jws-signature: description: 'Header containing a detached JWS signature of the body of the payload. ' required: true schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBErrorResponse1' application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' application/jose+jwe: schema: $ref: '#/components/schemas/OBErrorResponse1' 201InternationalScheduledPaymentsCreated: description: International Scheduled Payments Created headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string x-jws-signature: description: 'Header containing a detached JWS signature of the body of the payload. ' required: true schema: type: string RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' RateLimit: $ref: '#/components/headers/RateLimit' content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBWriteInternationalScheduledResponse6' application/json: schema: $ref: '#/components/schemas/OBWriteInternationalScheduledResponse6' application/jose+jwe: schema: $ref: '#/components/schemas/OBWriteInternationalScheduledResponse6' 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 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' 200InternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetailsRead: description: Payment Details Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string x-jws-signature: description: 'Header containing a detached JWS signature of the body of the payload. ' required: true schema: type: string RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' RateLimit: $ref: '#/components/headers/RateLimit' content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBWritePaymentDetailsResponse1' application/json: schema: $ref: '#/components/schemas/OBWritePaymentDetailsResponse1' application/jose+jwe: schema: $ref: '#/components/schemas/OBWritePaymentDetailsResponse1' 400Error: description: Bad request headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string x-jws-signature: description: 'Header containing a detached JWS signature of the body of the payload. ' required: true schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBErrorResponse1' application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' application/jose+jwe: schema: $ref: '#/components/schemas/OBErrorResponse1' 415Error: description: Unsupported Media Type headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string 409Error: description: Conflict headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string x-jws-signature: description: Header containing a detached JWS signature of the body of the payload. required: true schema: type: string content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBErrorResponse1' application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' application/jose+jwe: schema: $ref: '#/components/schemas/OBErrorResponse1' 401Error: description: Unauthorized headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string 404Error: description: Not found headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string 200InternationalScheduledPaymentsInternationalScheduledPaymentIdRead: description: International Scheduled Payments Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string x-jws-signature: description: 'Header containing a detached JWS signature of the body of the payload. ' required: true schema: type: string RateLimit-Policy: $ref: '#/components/headers/RateLimit-Policy' RateLimit: $ref: '#/components/headers/RateLimit' content: application/json; charset=utf-8: schema: $ref: '#/components/schemas/OBWriteInternationalScheduledResponse6' application/json: schema: $ref: '#/components/schemas/OBWriteInternationalScheduledResponse6' application/jose+jwe: schema: $ref: '#/components/schemas/OBWriteInternationalScheduledResponse6' 422Error: description: Duplicate Idempotency key 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' 406Error: description: Not Acceptable headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string headers: RateLimit-Policy: required: false description: 'TPPs __must__ refer to ASPSP developer portals for further information on any rate limit policies, if the headers are supported and any additional requirements. A non-empty list of Quota Policy Items. The Item value __MUST__ be a String. Example: `RateLimit-Policy: "default";q=100;w=10` The **REQUIRED** "q" parameter indicates the quota allocated by this policy measured in quota units. The **OPTIONAL** "w" parameter value conveys a time window. ' schema: type: string RateLimit: required: false description: 'TPPs __must__ refer to ASPSP developer portals for further information on any rate limit policies, if the headers are supported and any additional requirements. A server uses the "RateLimit" response header field to communicate the current service limit for a quota policy for a particular partition key. Example: `RateLimit: "default";r=50;t=30` The **REQUIRED** "r" parameter value conveys the remaining quota units for the identified policy. The **OPTIONAL** "t" parameter value conveys the time window reset time for the identified policy. ' schema: type: string 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