openapi: 3.2.0 info: title: Payment Initiation File Payments API description: Initiate a single and immediate non-mandated funds transfer version: v4.0 tags: - name: File Payments description: File Payments paths: /file-payment-consents/{consentId}: summary: Get File Payment Consents description: Get File Payment Consents get: tags: - File Payments summary: Get File Payment Consents operationId: GetFilePaymentConsentsConsentId parameters: - $ref: '#/components/parameters/ConsentId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200FilePaymentConsentsConsentIdRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '500': $ref: '#/components/responses/500Error' '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' deprecated: false /file-payments/{filePaymentId}: summary: Get File Payments description: Get File Payments get: tags: - File Payments summary: Get File Payments operationId: GetFilePaymentsFilePaymentId parameters: - $ref: '#/components/parameters/FilePaymentId' - $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/200FilePaymentsFilePaymentIdRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '500': $ref: '#/components/responses/500Error' '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' deprecated: false /file-payments/{filePaymentId}/report-file: summary: Get File Payments description: Get File Payments get: tags: - File Payments summary: Get File Payments operationId: GetFilePaymentsFilePaymentIdReportFile parameters: - $ref: '#/components/parameters/FilePaymentId' - $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/200FilePaymentsFilePaymentIdReportFileRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '500': $ref: '#/components/responses/500Error' '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' deprecated: false /file-payment-consents/{consentId}/file: summary: Create File Payment Consents description: Create File Payment Consents get: tags: - File Payments summary: Get File Payment Consents operationId: GetFilePaymentConsentsConsentIdFile 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/200FilePaymentConsentsConsentIdFileRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '500': $ref: '#/components/responses/500Error' '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' deprecated: false post: tags: - File Payments summary: Create File Payment Consents operationId: CreateFilePaymentConsentsConsentIdFile parameters: - $ref: '#/components/parameters/ConsentId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-idempotency-key' - $ref: '#/components/parameters/x-jws-signature' - $ref: '#/components/parameters/x-customer-user-agent' requestBody: description: Default content: application/json: schema: $ref: '#/components/schemas/OBWriteFileConsent4' examples: create-filepayment-con-req: value: Data: DomesticPayments: - InstructionIdentification: ACME412 EndToEndIdentification: FRESCO.21302.GFX.20 LocalInstrument: UK.OBIE.CHAPS InstructedAmount: Amount: '165.88' Currency: GBP DebtorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080025612489 SecondaryIdentification: 080801562314789 Name: Jane Smith Proxy: Identification: '441234012345' Code: TELE Type: Telephone CreditorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: ACME Inc SecondaryIdentification: '0002' Proxy: Identification: '2360549017905188' Code: TELE Type: Telephone CreditorPostalAddress: AddressType: BIZZ Department: Finance SubDepartment: Payroll StreetName: Bank Street BuildingNumber: '11' BuildingName: Tower Bridges Floor: '6' UnitNumber: UNIT591 Room: '844' PostBox: PO Box 123456 PostCode: Z78 4TY TownLocationName: Bank TownName: London DistrictName: Greater London CareOf: Ms Jane Smith CountrySubDivision: England Country: GB UltimateDebtor: SchemeName: UK.OBIE.IBAN Identification: '2360549017905161589' Name: Ultimate Debtor LEI: 8200007YHFDMEODY1965 PostalAddress: AddressType: BIZZ StreetName: Bank Street BuildingNumber: '11' Floor: '6' PostCode: Z78 4TY TownName: London Country: GB CreditorAgent: LEI: 123400LZEVUKWCQY6X15 SchemeName: UK.OBIE.IBAN Identification: '80200112344562' Name: The Credit Agent PostalAddress: AddressType: BIZZ StreetName: Bank Street BuildingNumber: '11' Floor: '6' PostCode: Z78 4TY TownName: London Country: GB UltimateCreditor: SchemeName: UK.OBIE.IBAN Identification: '2360549017905161589' Name: Ultimate Creditor LEI: 60450004FECVJV7YN339 PostalAddress: AddressType: BIZZ StreetName: Bank Street BuildingNumber: '11' Floor: '6' PostCode: Z78 4TY TownName: London Country: GB RegulatoryReporting: - DebitCreditReportingIndicator: CRED Authority: Name: string CountryCode: UG Details: - Type: CRED Date: '2024-04-25T13:26:41.911Z' Information: - Reg info1 - Reg info2 Country: QG Amount: Amount: '4.68702' Currency: JGM RemittanceInformation: Structured: - ReferredDocumentInformation: - Code: CINV Issuer: Issuer01 Number: Number_01 RelatedDate: '2024-04-25T13:26:41.911Z' LineDetails: - LineDetail ReferredDocumentAmount: 1 CreditorReferenceInformation: Code: DISP Issuer: Issuer01 Reference: REF_26518 Invoicer: INVR51856 Invoicee: INVE5161856 TaxRemittance: Tax Remittance related information AdditionalRemittanceInformation: - Free text for additional information Unstructured: - Internal ops code 5120101 required: true responses: '200': $ref: '#/components/responses/200FilePaymentConsentsConsentIdFileCreated' '400': $ref: '#/components/responses/400Error' '422': $ref: '#/components/responses/422Error' '401': $ref: '#/components/responses/401Error' '500': $ref: '#/components/responses/500Error' '403': $ref: '#/components/responses/403Error' '404': $ref: '#/components/responses/404Error' '415': $ref: '#/components/responses/415Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' '409': $ref: '#/components/responses/409Error' deprecated: false /file-payment-consents: summary: Create File Payment Consents description: Create File Payment Consents post: tags: - File Payments summary: Create File Payment Consents operationId: CreateFilePaymentConsents parameters: - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-idempotency-key' - $ref: '#/components/parameters/x-jws-signature' - $ref: '#/components/parameters/x-customer-user-agent' requestBody: description: Default content: application/json: schema: $ref: '#/components/schemas/OBWriteFileConsent3' examples: create-file-pay-con-request: value: Data: Authorisation: AuthorisationType: Any CompletionDateTime: '2025-05-30T10:35:27Z' Initiation: FileType: UK.OBIE.pain.001.001.08 FileHash: m5ah/h1UjLvJYMxqAoZmj9dKdjZnsGNm+yMkJp/KuqQ FileReference: GB2OK238 NumberOfTransactions: '100' ControlSum: 3459.3 RequestedExecutionDateTime: '2024-06-03T00:00:00Z' LocalInstrument: UK.OBIE.CHAPS DebtorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '11280001234567' Name: Andrea Smith SecondaryIdentification: '0002' Proxy: Identification: '441234012345' Code: TELE Type: Telephone UltimateDebtor: SchemeName: UK.OBIE.BBAN Identification: '2360549017905161589' Name: Ultimate Debtor LEI: 8200007YHFDMEODY1965 PostalAddress: AddressType: BIZZ StreetName: Bank Street BuildingNumber: '11' Floor: '6' PostCode: Z78 4TY TownName: London Country: UK CreditorAgent: LEI: 123400LZEVUKWCQY6X15 SchemeName: UK.OBIE.IBAN Identification: '80200112344562' Name: The Credit Agent PostalAddress: AddressType: BIZZ StreetName: Bank Street BuildingNumber: '11' Floor: '6' PostCode: Z78 4TY TownName: London Country: UK RemittanceInformation: Structured: - ReferredDocumentInformation: - Code: CINV Issuer: Issuer01 Number: Number_01 RelatedDate: '2024-04-25T13:26:41.911Z' LineDetails: - string ReferredDocumentAmount: 1 CreditorReferenceInformation: Code: DISP Issuer: Issuer01 Reference: REF_26518 Invoicer: INVR51856 Invoicee: INVE5161856 TaxRemittance: Tax Remittance related information AdditionalRemittanceInformation: - Free text for additional information Unstructured: - Internal ops code 5120101 SCASupportData: RequestedSCAExemptionType: EcommerceGoods AppliedAuthenticationApproach: SCA ReferencePaymentOrderId: O-611265 required: true responses: '201': $ref: '#/components/responses/201FilePaymentConsentsCreated' '400': $ref: '#/components/responses/400Error' '422': $ref: '#/components/responses/422Error' '401': $ref: '#/components/responses/401Error' '500': $ref: '#/components/responses/500Error' '403': $ref: '#/components/responses/403Error' '404': $ref: '#/components/responses/404Error' '415': $ref: '#/components/responses/415Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' '409': $ref: '#/components/responses/409Error' deprecated: false /file-payments: summary: Create File Payments description: Create File Payments post: tags: - File Payments summary: Create File Payments operationId: CreateFilePayments 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: description: Default content: application/json: schema: $ref: '#/components/schemas/OBWriteFile2' examples: create-file-pay-request: value: Data: ConsentId: BARCLAYS-P-12345678901234 Initiation: LocalInstrument: UK.OBIE.Paym RequestedExecutionDateTime: '2017-06-05T15:15:22+00:00' FileType: UK.OBIE.pain.001.001.08 FileHash: m5ah/h1UjLvJYMxqAoZmj9dKdjZnsGNm+yMkJp/KuqQ FileReference: GB2OK238 NumberOfTransactions: '100' ControlSum: 3459.3 DebtorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '11280001234567' Name: Andrea Smith SecondaryIdentification: '0002' Proxy: Identification: '441234012345' Code: TELE Type: Telephone UltimateDebtor: SchemeName: UK.OBIE.BBAN Identification: '2360549017905161589' Name: Ultimate Debtor LEI: 8200007YHFDMEODY1965 PostalAddress: AddressType: BIZZ StreetName: Bank Street BuildingNumber: '11' Floor: '6' PostCode: Z78 4TY TownName: London Country: UK CreditorAgent: LEI: 123400LZEVUKWCQY6X15 SchemeName: UK.OBIE.IBAN Identification: '80200112344562' Name: The Credit Agent PostalAddress: AddressType: BIZZ StreetName: Bank Street BuildingNumber: '11' Floor: '6' PostCode: Z78 4TY TownName: London Country: UK RemittanceInformation: Structured: - ReferredDocumentInformation: - Code: CINV Issuer: Issuer01 Number: Number_01 RelatedDate: '2024-04-25T13:26:41.911Z' LineDetails: - string ReferredDocumentAmount: 1 CreditorReferenceInformation: Code: DISP Issuer: Issuer01 Reference: REF_26518 Invoicer: INVR51856 Invoicee: INVE5161856 TaxRemittance: Tax Remittance related information AdditionalRemittanceInformation: - Free text for additional information Unstructured: - Internal ops code 5120101 required: true responses: '201': $ref: '#/components/responses/201FilePaymentsCreated' '400': $ref: '#/components/responses/400Error' '422': $ref: '#/components/responses/422Error' '401': $ref: '#/components/responses/401Error' '500': $ref: '#/components/responses/500Error' '403': $ref: '#/components/responses/403Error' '404': $ref: '#/components/responses/404Error' '415': $ref: '#/components/responses/415Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' '409': $ref: '#/components/responses/409Error' deprecated: false components: schemas: Meta: type: object additionalProperties: false deprecated: false description: Meta Data relevant to the payload properties: TotalPages: type: integer format: int32 example: 10 maximum: 999999 minimum: 0 FirstAvailableDateTime: $ref: '#/components/schemas/ISODateTime' LastAvailableDateTime: $ref: '#/components/schemas/ISODateTime' title: MetaData nullable: false OBInternalChargeBearerType1Code: type: string 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) enum: - BorneByCreditor - BorneByDebtor - FollowingServiceLevel - Shared example: BorneByCreditor SecondaryIdentification: type: string 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)." example: Secondary Identification maxLength: 34 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-. '()£="_,&@#\/;+]{1,34})$ CountrySubDivision: type: string description: Identifies a subdivision of a country such as state, region, county. example: Manchester, Lancaster maxLength: 35 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9\- '.,]){1,35}$ OBProxy1: type: object additionalProperties: false deprecated: false description: Specifies an alternate assumed name for the identification of the account. properties: Identification: type: string description: Identification used to indicate the account identification under another specified name. example: 08080021325698 maxLength: 2048 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_-]{1,2048})$ Code: $ref: '#/components/schemas/ExternalProxyAccountType1Code' Type: type: string description: Type of the proxy identification. example: Telephone maxLength: 35 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_-]{1,35})$ required: - Code - Identification nullable: false OBSupplementaryData1: type: object additionalProperties: true description: Additional information that can not be captured in the structured fields and/or any other specific block. PostCode: type: string description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. example: ST15 8WD maxLength: 16 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9 ]){1,16}$ Department: type: string description: Identification of a division of a large organisation or building. example: Back Office maxLength: 70 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9\- '.,\/]){1,70}$ OBRegulatoryReporting1: type: object additionalProperties: false deprecated: false 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 reefer 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' maxItems: 3 minItems: 1 nullable: false OBSCASupportData1: type: object additionalProperties: false deprecated: false description: Supporting Data provided by TPP, when requesting SCA Exemption. properties: RequestedSCAExemptionType: type: string description: This field allows a PISP to request specific SCA Exemption for a Payment Initiation. For a full list of values reefer to `OBInternalSCAExemptionType1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - BillPayment - ContactlessTravel - EcommerceGoods - EcommerceServices - Kiosk - Parking - PartyToParty AppliedAuthenticationApproach: type: string 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 For a full list of values refer to `OBInternalAppliedAuthenticationApproach1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)' enum: - CA - SCA ReferencePaymentOrderId: type: string 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 example: P-12345678901234 maxLength: 40 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9\-. '()£="_,&@#\/&+]{1,40})$ nullable: false UnitNumber: type: string description: Number that identifies the unit of a specific address . example: string maxLength: 16 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_-]{1,16})$ OBUltimateCreditor1: type: object additionalProperties: false description: Ultimate party to which an amount of money is due. properties: Name: type: string description: Name by which a party is known and which is usually used to identify that party. example: Arthur Dent maxLength: 140 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,140})$ Identification: type: string description: Identification assigned by an institution. example: '1234567890' maxLength: 256 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,256})$ LEI: $ref: '#/components/schemas/LEI' SchemeName: $ref: '#/components/schemas/OBInternalAccountIdentification4Code' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' OBInternalErrorResponseError1Code: type: string description: Low level textual error code, for all enum values see `OBInternalErrorResponseError1Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) example: U001 maxLength: 4 minLength: 4 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_-]{4,4})$ BuildingName: type: string description: Name of a referenced building. example: St Stephens House maxLength: 140 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,140})$ OBAddressType2Code: type: string description: Identifies the nature of the postal address. For a full set of codes see `OBAddressType2Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets). enum: - BIZZ - DLVY - MLTO - PBOX - ADDR - HOME - CORR - STAT example: BIZZ OBStructuredRegulatoryReporting3: type: object additionalProperties: false deprecated: false 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 example: type maxLength: 35 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_-]{1,35})$ Date: $ref: '#/components/schemas/ISODateTime' Country: $ref: '#/components/schemas/CountryCode' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount' Information: type: array description: Additional details that cater for specific domestic regulatory requirements. items: type: string example: item maxLength: 35 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_-]{1,35})$ maxItems: 3 minItems: 1 nullable: false ExternalCreditorReferenceType1Code: type: string 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 example: DISP TownName: type: string description: Name of a built-up area, with defined boundaries, and a local government. example: Burslem maxLength: 35 minLength: 1 pattern: ^(?!\s)([a-zA-Z- '.,]){1,35}$ OBActiveOrHistoricCurrencyAndAmount: type: object additionalProperties: false deprecated: false description: Amount of money associated with the charge type. properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' required: - Amount - Currency nullable: false File: type: object additionalProperties: false deprecated: false nullable: false OBWriteFile2: type: object additionalProperties: false deprecated: false properties: Data: type: object additionalProperties: false properties: ConsentId: type: string description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' example: BARCLAYS-P-12345678901234 maxLength: 25 minLength: 1 pattern: ^BARCLAYS-P-\d{14}$ Initiation: type: object additionalProperties: false description: The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file. properties: FileType: type: string description: Specifies the payment file type. enum: - UK.OBIE.PaymentInitiation.4.0 FileHash: type: string description: A base64 encoding of a SHA256 hash of the file to be uploaded. example: m5ah/h1UjLvJYMxqAoZmj9dKdjZnsGNm+yMkJp/KuqQ maxLength: 44 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9+/=]{1,44})$ FileReference: type: string description: Reference for the file. example: file ref maxLength: 40 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9- '.,@#_\/()]){1,40}$ NumberOfTransactions: type: string description: Number of individual transactions contained in the payment information group. example: '1' maxLength: 15 minLength: 1 pattern: ^[0-9]{1,15}$ ControlSum: type: number description: Total of all individual amounts included in the group, irrespective of currencies. maximum: 999999999 minimum: 1 RequestedExecutionDateTime: type: string format: date-time 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" LocalInstrument: $ref: '#/components/schemas/OBInternalLocalInstrument1Code' 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' Name: $ref: '#/components/schemas/Name' LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' DebtorAccount: type: object additionalProperties: false 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: type: string 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.' example: Name maxLength: 70 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-. '()£="_,&@#\/;+]{1,70})$ SecondaryIdentification: $ref: '#/components/schemas/SecondaryIdentification' Proxy: $ref: '#/components/schemas/OBProxy1' required: - Identification - SchemeName UltimateDebtor: $ref: '#/components/schemas/OBUltimateDebtor1' RemittanceInformation: $ref: '#/components/schemas/OBRemittanceInformation2' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' required: - FileHash - FileType required: - ConsentId - Initiation required: - Data nullable: false OBRegulatoryAuthority2: type: object additionalProperties: false deprecated: false description: 'Entity requiring the regulatory reporting information. ' properties: Name: type: string description: Name of the entity requiring the regulatory reporting information. example: name maxLength: 140 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,140})$ CountryCode: $ref: '#/components/schemas/CountryCode' nullable: false OBInternalPaymentChargeType1Code: type: string 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) enum: - UK.OBIE.CHAPSOut OBActiveCurrencyAndAmount_SimpleType: type: string description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. example: '1209.06' maxLength: 19 minLength: 1 pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ CareOf: type: string 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. example: Arthur Dent maxLength: 140 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,140})$ OBInternalFinancialInstitutionIdentification4Code: type: string description: Name of the identification scheme, in a coded form as published in an external list. enum: - UK.OBIE.BICFI - UK.OBIE.NCC.GB example: UK.OBIE.BICFI ExternalPaymentTransactionStatus4Code: type: string description: "Specifies the status of the payment order resource.\n\nSee `ExternalPaymentTransactionStatus4Code` in *OB_Internal_CodeSet* \n[here](https://github.com/OpenBankingUK/External_Internal_CodeSets) for more information.\n" enum: - PDNG - INFA - INCO PostBox: type: string 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. example: '42' maxLength: 16 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_-]{1,16})$ OBWriteFileConsent4Array: type: object additionalProperties: false deprecated: false properties: InstructionIdentification: type: string 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.' example: ANSM023 maxLength: 35 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9\-. '()£="_]{1,35})$ EndToEndIdentification: type: string 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.' example: FRESCO maxLength: 35 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-. '()£="_]{1,35})$ LocalInstrument: $ref: '#/components/schemas/OBInternalLocalInstrument1Code' InstructedAmount: type: object additionalProperties: false deprecated: false 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' required: - Amount - Currency nullable: false DebtorAccount: type: object additionalProperties: false deprecated: false 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: type: string 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.' example: Name maxLength: 70 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-. '()£="_,&@#\/;+]{1,70})$ SecondaryIdentification: $ref: '#/components/schemas/SecondaryIdentification' Proxy: $ref: '#/components/schemas/OBProxy1' required: - Identification - SchemeName nullable: false CreditorAgent: type: object additionalProperties: false deprecated: false description: Financial institution servicing an account for the creditor. properties: SchemeName: $ref: '#/components/schemas/OBInternalFinancialInstitutionIdentification4Code' Identification: $ref: '#/components/schemas/Identification_1' Name: $ref: '#/components/schemas/Name' LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' nullable: false CreditorAccount: type: object additionalProperties: false deprecated: false 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: type: string 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.' example: Creditor Name maxLength: 70 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-. '()£="_,&@#\/;+]{1,70})$ SecondaryIdentification: $ref: '#/components/schemas/SecondaryIdentification' Proxy: $ref: '#/components/schemas/OBProxy1' required: - Identification - Name - SchemeName nullable: false CreditorPostalAddress: $ref: '#/components/schemas/OBPostalAddress7' UltimateCreditor: $ref: '#/components/schemas/OBUltimateCreditor1' UltimateDebtor: $ref: '#/components/schemas/OBUltimateDebtor1' RegulatoryReporting: type: array items: $ref: '#/components/schemas/OBRegulatoryReporting1' maxItems: 3 minItems: 0 RemittanceInformation: $ref: '#/components/schemas/OBRemittanceInformation2' required: - CreditorAccount - InstructedAmount - InstructionIdentification nullable: false CountryCode: type: string description: Nation with its own government. example: US maxLength: 2 minLength: 2 pattern: ^[A-Z]{2,2}$ Identification_4: type: string description: Identification of the party to whom an invoice is issued, when it is different from the debtor or ultimate debtor. example: '80200112344562' maxLength: 256 minLength: 1 pattern: ^[a-zA-Z0-9]{1,256}$ ExternalProxyAccountType1Code: type: string 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) enum: - TELE - EMAL - DNAM - CINC - COTX - COID - CUST - DRLC - EIDN - EWAL - PVTX - LEIC - MBNO - NIDN - CCPT - SHID - SOSE - TOKN - UBIL - VIPN - BIID OBErrorResponse1: type: object additionalProperties: false deprecated: false description: An array of detail error codes, and messages, and URLs to documentation to help remediation. properties: Id: type: string description: A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors. maxLength: 40 minLength: 1 Code: type: string description: Deprecated
High level textual error code, to help categorise the errors. example: 400 BadRequest maxLength: 40 minLength: 1 Message: type: string description: Deprecated
Brief Error message example: There is something wrong with the request parameters provided maxLength: 500 minLength: 1 Errors: type: array items: $ref: '#/components/schemas/OBError1' maxItems: 99999 minItems: 1 required: - Errors nullable: false OBPostalAddress7: type: object additionalProperties: false deprecated: 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: type: string description: Information that locates and identifies a specific address, as defined by postal services, presented in free format text. example: Melbourne Cresent maxLength: 70 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-. '()£="_,&@#\/]{1,70})$ maxItems: 7 minItems: 1 nullable: false OBWriteFileResponse3: type: object additionalProperties: false deprecated: false properties: Data: type: object additionalProperties: false properties: FilePaymentId: type: string description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the file payment resource.' maxLength: 40 minLength: 1 ConsentId: type: string description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' example: BARCLAYS-P-12345678901234 maxLength: 25 minLength: 1 pattern: ^BARCLAYS-P-\d{14}$ CreationDateTime: type: string format: date-time 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" Status: $ref: '#/components/schemas/ExternalPaymentTransactionStatus4Code' StatusUpdateDateTime: type: string format: date-time 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" StatusReason: type: array items: $ref: '#/components/schemas/OBStatusReason' maxItems: 99999 minItems: 0 Charges: type: array items: type: object additionalProperties: false description: Set of elements used to provide details of a charge for the payment initiation. properties: ChargeBearer: $ref: '#/components/schemas/OBInternalChargeBearerType1Code' Type: $ref: '#/components/schemas/OBInternalPaymentChargeType1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount' required: - Amount - ChargeBearer - Type maxItems: 99999 minItems: 0 Initiation: type: object additionalProperties: false description: The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file. properties: FileType: type: string description: Specifies the payment file type. enum: - UK.OBIE.PaymentInitiation.4.0 - UK.OBIE.pain.001.001.08 FileHash: type: string description: A base64 encoding of a SHA256 hash of the file to be uploaded. example: m5ah/h1UjLvJYMxqAoZmj9dKdjZnsGNm+yMkJp/KuqQ maxLength: 44 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9+/=]{1,44})$ FileReference: type: string description: Reference for the file. example: file ref maxLength: 40 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9- '.,@#_\/()]){1,40}$ NumberOfTransactions: type: string description: Number of individual transactions contained in the payment information group. example: '1' maxLength: 15 minLength: 1 pattern: ^[0-9]{1,15}$ ControlSum: type: number description: Total of all individual amounts included in the group, irrespective of currencies. maximum: 999999999 minimum: 1 RequestedExecutionDateTime: type: string format: date-time 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" LocalInstrument: $ref: '#/components/schemas/OBInternalLocalInstrument1Code' DebtorAccount: type: object additionalProperties: false 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: type: string 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.' example: Name maxLength: 70 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-. '()£="_,&@#\/;+]{1,70})$ SecondaryIdentification: $ref: '#/components/schemas/SecondaryIdentification' Proxy: $ref: '#/components/schemas/OBProxy1' required: - Identification - SchemeName 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' Name: $ref: '#/components/schemas/Name' LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' UltimateDebtor: $ref: '#/components/schemas/OBUltimateDebtor1' RemittanceInformation: $ref: '#/components/schemas/OBRemittanceInformation2' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' required: - FileHash - FileType MultiAuthorisation: type: object additionalProperties: false description: The multiple authorisation flow response from the ASPSP. properties: Status: type: string description: Specifies the status of the authorisation flow in code form. enum: - AUTH - AWAF - RJCT NumberRequired: type: integer description: Number of authorisations required for payment order (total required at the start of the multi authorisation journey). example: 42 maximum: 99999999 minimum: 0 NumberReceived: type: integer description: Number of authorisations received. example: 42 maximum: 99999999 minimum: 0 LastUpdateDateTime: type: string format: date-time 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" ExpirationDateTime: type: string format: date-time 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" required: - Status Debtor: $ref: '#/components/schemas/OBCashAccountDebtor4' required: - ConsentId - CreationDateTime - FilePaymentId - Initiation - Status - StatusUpdateDateTime Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data nullable: false Name: type: string description: Name by which an agent is known and which is usually used to identify that agent. example: name maxLength: 140 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-. '()£="_,&@#\/;+]{1,140})$ Room: type: string description: Information that locates and identifies a room to form part of an address example: '42' maxLength: 70 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_-]{1,70})$ Identification_3: type: string description: Identification of the organisation issuing the invoice, when it is different from the creditor or ultimate creditor example: '80200112344562' maxLength: 256 minLength: 1 pattern: ^[a-zA-Z0-9]{1,256}$ LEI: type: string 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)". example: IZ9Q00LZEVUKWCQY6X15 maxLength: 20 minLength: 20 pattern: ^[A-Z0-9]{18,18}[0-9]{2,2}$ OBStatusReason: type: object additionalProperties: false deprecated: false 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)" example: ERIN maxLength: 4 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,4})$ StatusReasonDescription: type: string description: Description supporting the StatusReasonCode. example: description maxLength: 500 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9\-. '()£="_,&@#\/;&+]{1,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. example: path maxLength: 500 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,500})$ nullable: false SubDepartment: type: string description: Identification of a sub-division of a large organisation or building. example: string maxLength: 70 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9- '.,\/]){1,70}$ ActiveOrHistoricCurrencyCode: type: string 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". example: GBP maxLength: 3 minLength: 3 pattern: ^[A-Z]{3,3}$ OBRemittanceInformation2: type: object additionalProperties: false deprecated: false 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' maxItems: 5 minItems: 1 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 example: string maxLength: 140 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-. '()£="_,&@#\/;:&+]{1,140})$ maxItems: 4 minItems: 1 nullable: false ISODateTime: type: string format: date-time 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" example: '2017-04-05T10:43:07Z' OBWriteFileResponse4: type: object additionalProperties: false deprecated: false properties: Data: type: object additionalProperties: false properties: FilePaymentId: type: string description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the file payment resource.' maxLength: 40 minLength: 1 ConsentId: type: string description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' example: BARCLAYS-P-12345678901234 maxLength: 25 minLength: 1 pattern: ^BARCLAYS-P-\d{14}$ CreationDateTime: type: string format: date-time 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" Status: type: string description: The current status of the file payment. enum: - PDNG - RJCT - ACSP - ACSC - PATC - ACCP StatusUpdateDateTime: type: string format: date-time 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" Initiation: type: object additionalProperties: false description: The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file. properties: FileType: type: string description: Specifies the payment file type. enum: - UK.OBIE.PaymentInitiation.4.0 - UK.OBIE.pain.001.001.08 FileHash: type: string description: A base64 encoding of a SHA256 hash of the file to be uploaded. example: m5ah/h1UjLvJYMxqAoZmj9dKdjZnsGNm+yMkJp/KuqQ maxLength: 44 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9+/=]{1,44})$ FileReference: type: string description: Reference for the file. example: file ref maxLength: 40 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9- '.,@#_\/()]){1,40}$ NumberOfTransactions: type: string description: Number of individual transactions contained in the payment information group. example: '1' maxLength: 15 minLength: 1 pattern: ^[0-9]{1,15}$ ControlSum: type: number description: Total of all individual amounts included in the group, irrespective of currencies. maximum: 999999999 minimum: 1 RequestedExecutionDateTime: type: string format: date-time 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" LocalInstrument: $ref: '#/components/schemas/OBInternalLocalInstrument1Code' DebtorAccount: type: object additionalProperties: false 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: type: string 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.' example: Name maxLength: 70 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-. '()£="_,&@#\/;+]{1,70})$ SecondaryIdentification: $ref: '#/components/schemas/SecondaryIdentification' Proxy: $ref: '#/components/schemas/OBProxy1' required: - Identification - SchemeName 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' Name: $ref: '#/components/schemas/Name' LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' UltimateDebtor: $ref: '#/components/schemas/OBUltimateDebtor1' RemittanceInformation: $ref: '#/components/schemas/OBRemittanceInformation2' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' required: - FileHash - FileType MultiAuthorisation: type: object additionalProperties: false description: The multiple authorisation flow response from the ASPSP. properties: Status: type: string description: Specifies the status of the authorisation flow in code form. enum: - AUTH - AWAF - RJCT NumberRequired: type: integer description: Number of authorisations required for payment order (total required at the start of the multi authorisation journey). example: 42 maximum: 99999999 minimum: 0 NumberReceived: type: integer description: Number of authorisations received. example: 42 maximum: 99999999 minimum: 0 LastUpdateDateTime: type: string format: date-time 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" ExpirationDateTime: type: string format: date-time 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" required: - Status required: - ConsentId - CreationDateTime - FilePaymentId - Initiation - Status - StatusUpdateDateTime Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data nullable: false Identification_0: type: string description: Identification assigned by an institution to identify an account. This identification is known by the account owner. example: '10210393826475' maxLength: 256 minLength: 1 pattern: ^[a-zA-Z0-9]{1,256}$ Links: type: object additionalProperties: false deprecated: 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 nullable: false OBWriteFileConsent4: type: object additionalProperties: false deprecated: false properties: Data: type: object additionalProperties: false deprecated: false properties: DomesticPayments: type: array items: $ref: '#/components/schemas/OBWriteFileConsent4Array' maxItems: 50 minItems: 2 required: - DomesticPayments nullable: false required: - Data nullable: false ExternalDocumentType1Code: type: string 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 - CREN - DEBN - DISP - DNFA - HIRI - MSIN - PUOR - SBIN - AROI - BOLD - CMCN - SOAC - TSUT - VCHR example: CNFA OBWriteFileConsentResponse4: type: object additionalProperties: false deprecated: false properties: Data: type: object additionalProperties: false properties: ConsentId: type: string description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' example: BARCLAYS-P-12345678901234 maxLength: 25 minLength: 1 pattern: ^BARCLAYS-P-\d{14}$ CreationDateTime: type: string format: date-time 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" Status: type: string description: Specifies the status of consent resource in code form. enum: - AWAU - AWUP - RJCT - AUTH - COND StatusReason: type: array items: $ref: '#/components/schemas/OBStatusReason' maxItems: 99999 minItems: 0 StatusUpdateDateTime: type: string format: date-time description: "Date and time at which the consent 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" CutOffDateTime: type: string format: date-time 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" Charges: type: array items: type: object additionalProperties: false description: Set of elements used to provide details of a charge for the payment initiation. properties: ChargeBearer: $ref: '#/components/schemas/OBInternalChargeBearerType1Code' Type: $ref: '#/components/schemas/OBInternalPaymentChargeType1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount' required: - Amount - ChargeBearer - Type maxItems: 99999 minItems: 0 Initiation: type: object additionalProperties: false description: The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file. properties: FileType: type: string description: Specifies the payment file type. enum: - UK.OBIE.PaymentInitiation.4.0 - UK.OBIE.pain.001.001.08 FileHash: type: string description: A base64 encoding of a SHA256 hash of the file to be uploaded. example: m5ah/h1UjLvJYMxqAoZmj9dKdjZnsGNm+yMkJp/KuqQ maxLength: 44 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9+/=]{1,44})$ FileReference: type: string description: Reference for the file. example: file ref maxLength: 40 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9- '.,@#_\/()]){1,40}$ NumberOfTransactions: type: string description: Number of individual transactions contained in the payment information group. example: '1' maxLength: 15 minLength: 1 pattern: ^[0-9]{1,15}$ ControlSum: type: number description: Total of all individual amounts included in the group, irrespective of currencies. maximum: 999999999 minimum: 1 RequestedExecutionDateTime: type: string format: date-time 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" LocalInstrument: $ref: '#/components/schemas/OBInternalLocalInstrument1Code' 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' Name: $ref: '#/components/schemas/Name' LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' DebtorAccount: type: object additionalProperties: false 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: type: string 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.' example: Name maxLength: 70 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-. '()£="_,&@#\/;+]{1,70})$ SecondaryIdentification: $ref: '#/components/schemas/SecondaryIdentification' Proxy: $ref: '#/components/schemas/OBProxy1' required: - Identification - SchemeName UltimateDebtor: $ref: '#/components/schemas/OBUltimateDebtor1' RemittanceInformation: $ref: '#/components/schemas/OBRemittanceInformation2' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' required: - FileHash - FileType Authorisation: type: object additionalProperties: false description: The authorisation type request from the TPP. properties: AuthorisationType: type: string description: Type of authorisation flow requested. enum: - Any - Single CompletionDateTime: type: string format: date-time 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" required: - AuthorisationType SCASupportData: $ref: '#/components/schemas/OBSCASupportData1' Debtor: $ref: '#/components/schemas/OBCashAccountDebtor4' required: - ConsentId - CreationDateTime - Initiation - Status - StatusUpdateDateTime Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data nullable: false BuildingNumber: type: string description: Number that identifies the position of a building on a street. example: 21A maxLength: 16 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9 \s]{1,16})$ StreetName: type: string description: Name of a street or thoroughfare. example: Hamil Road maxLength: 70 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9- '.,\/]{1,70})$ OBInternalLocalInstrument1Code: type: string 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)' 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 example: UK.OBIE.FPS OBReferredDocumentInformation: type: object additionalProperties: false deprecated: false properties: Code: $ref: '#/components/schemas/ExternalDocumentType1Code' Issuer: type: string description: Identification of the issuer of the reference document type. example: issuer maxLength: 35 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,35})$ Number: type: string description: Identification of the type specified for the referred document line. example: number maxLength: 35 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,35})$ RelatedDate: type: string format: date-time description: Date associated with the referred document line. example: '2024-04-25T13:26:41.911Z' LineDetails: type: array description: Set of elements used to provide the content of the referred document line. items: type: string example: string maxLength: 2048 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,2048})$ maxItems: 3 minItems: 0 nullable: false OBCashAccountDebtor4: type: object additionalProperties: false deprecated: false 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 example: '1234567890' maxLength: 256 minLength: 1 pattern: ^[a-zA-Z0-9]{1,256}$ 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 example: '1234567890' maxLength: 34 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-. '()£="_,&@#\/;+]{1,34})$ LEI: $ref: '#/components/schemas/LEI' nullable: false Floor: type: string description: Number that identifies the level within a building example: '10' maxLength: 70 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,70})$ OBInternalAccountIdentification4Code: type: string 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) enum: - UK.OBIE.BBAN - UK.OBIE.IBAN - UK.OBIE.PAN - UK.OBIE.Paym - UK.OBIE.SortCodeAccountNumber - UK.OBIE.Wallet example: UK.OBIE.IBAN OBUltimateDebtor1: type: object additionalProperties: false description: Ultimate party that owes an amount of money to the (ultimate) creditor. properties: Name: type: string description: Name by which a party is known and which is usually used to identify that party. example: Arthur Dent maxLength: 140 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,140})$ Identification: type: string description: Identification assigned by an institution. example: '1234567890' maxLength: 256 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,256})$ LEI: $ref: '#/components/schemas/LEI' SchemeName: $ref: '#/components/schemas/OBInternalAccountIdentification4Code' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' OBError1: type: object additionalProperties: false deprecated: false minProperties: 1 properties: ErrorCode: $ref: '#/components/schemas/OBInternalErrorResponseError1Code' Message: type: string 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' maxLength: 500 minLength: 1 Path: type: string description: Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency maxLength: 500 minLength: 1 Url: type: string description: URL to help remediate the problem, or provide more information, or to API Reference, or help etc required: - ErrorCode nullable: false OBRemittanceInformationStructured: type: object additionalProperties: false deprecated: false properties: ReferredDocumentInformation: type: array items: $ref: '#/components/schemas/OBReferredDocumentInformation' maxItems: 3 minItems: 1 ReferredDocumentAmount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' CreditorReferenceInformation: type: object additionalProperties: false deprecated: false description: Reference information provided by the creditor to allow the identification of the underlying documents. properties: Code: $ref: '#/components/schemas/ExternalCreditorReferenceType1Code' Issuer: type: string description: Entity that assigns the identification. example: Issuer01 maxLength: 35 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_-]{1,35})$ Reference: type: string description: Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. example: Reference01 maxLength: 35 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_-]{1,35})$ nullable: false Invoicer: $ref: '#/components/schemas/Identification_3' Invoicee: $ref: '#/components/schemas/Identification_4' TaxRemittance: type: string description: Provides remittance information about a payment made for tax-related purposes. example: Tax Remittance related information maxLength: 140 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_-]{1,140})$ AdditionalRemittanceInformation: type: array description: Additional information, in free text form, to complement the structured remittance information. items: type: string example: Additional Tax Remittance related information maxLength: 140 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_-]{1,140})$ maxItems: 3 minItems: 0 nullable: false OBWriteFileConsent3: type: object additionalProperties: false deprecated: false properties: Data: type: object additionalProperties: false properties: Initiation: type: object additionalProperties: false description: The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file. properties: FileType: type: string description: Specifies the payment file type. enum: - UK.OBIE.PaymentInitiation.4.0 - UK.OBIE.pain.001.001.08 FileHash: type: string description: A base64 encoding of a SHA256 hash of the file to be uploaded. example: m5ah/h1UjLvJYMxqAoZmj9dKdjZnsGNm+yMkJp/KuqQ maxLength: 44 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9+/=]{1,44})$ FileReference: type: string description: Reference for the file. example: file ref maxLength: 40 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9- '.,@#_\/()]){1,40}$ NumberOfTransactions: type: string description: Number of individual transactions contained in the payment information group. example: '1' maxLength: 15 minLength: 1 pattern: ^[0-9]{1,15}$ ControlSum: type: number description: Total of all individual amounts included in the group, irrespective of currencies. maximum: 999999999 minimum: 1 RequestedExecutionDateTime: type: string format: date-time 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" LocalInstrument: $ref: '#/components/schemas/OBInternalLocalInstrument1Code' 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' Name: $ref: '#/components/schemas/Name' LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' DebtorAccount: type: object additionalProperties: false 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: type: string 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.' example: Name maxLength: 70 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-. '()£="_,&@#\/;+]{1,70})$ SecondaryIdentification: $ref: '#/components/schemas/SecondaryIdentification' Proxy: $ref: '#/components/schemas/OBProxy1' required: - Identification - SchemeName UltimateDebtor: $ref: '#/components/schemas/OBUltimateDebtor1' RemittanceInformation: $ref: '#/components/schemas/OBRemittanceInformation2' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' required: - FileHash - FileType Authorisation: type: object additionalProperties: false description: The authorisation type request from the TPP. properties: AuthorisationType: type: string description: Type of authorisation flow requested. enum: - Any - Single CompletionDateTime: type: string format: date-time 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" required: - AuthorisationType SCASupportData: $ref: '#/components/schemas/OBSCASupportData1' required: - Initiation required: - Data nullable: false Identification_1: type: string description: Unique and unambiguous identification of a financial institution or a branch of a financial institution. example: '10210393826475' maxLength: 35 minLength: 1 pattern: ^[a-zA-Z0-9]{1,35}$ DistrictName: type: string description: Number that of the regional area, known as a district, which forms part of an address example: District 13 maxLength: 140 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,140})$ responses: 200FilePaymentConsentsConsentIdFileCreated: description: File Payment Consents Created headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate 415Error: description: Unsupported Media Type headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate 404Error: description: Not found headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate 405Error: description: Method Not Allowed headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate 422Error: description: Unprocessable headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d x-jws-signature: description: Header containing a detached JWS signature of the body of the payload. required: true schema: type: string deprecated: false maxLength: 8192 minLength: 10 pattern: ^[A-Za-z0-9-_="\/.]{1,8192}$ nullable: false example: V2hhdCBoYXRoIGdvZCB3cm91Z2h0ID8=..QnkgR2VvcmdlLCBzaGUncyBnb3QgaXQhIEJ5IEdlb3JnZSBzaGUncyBnb3QgaXQhIE5vdyBvbmNlIGFnYWluLCB3aGVyZSBkb2VzIGl0IHJhaW4 Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' examples: 409ErrorResponse: value: Code: OB.BadRequest Id: 2b5f0fb2-730b-11e8-adc0-fa7ae01bbebc Message: Invalid request parameters Errors: - ErrorCode: AC17 Message: Version must be supplied Path: Data.Initiation Url: - ErrorCode: AC17 Message: Version supplied is not valid Path: Data.Initiation.CreditorAccount Url: 400Error: description: Bad request headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' examples: 400ErrorResponse: value: Code: OB.BadRequest Id: 2b5f0fb2-730b-11e8-adc0-fa7ae01bbebc Message: Invalid request parameters Errors: - ErrorCode: AC17 Message: Version must be supplied Path: Data.Initiation Url: - ErrorCode: AC17 Message: Version supplied is not valid Path: Data.Initiation.CreditorAccount Url: 401Error: description: Unauthorized headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate 406Error: description: Not Acceptable headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate 201FilePaymentConsentsCreated: description: File Payment Consents Created headers: Location: description: Mandatory response header for HTTP 201 (Created) response codes schema: type: string deprecated: false maxLength: 492 minLength: 2 pattern: ^(https:\/\/[-a-zA-Z0-9\\._\\\/?=]{2,492})$ nullable: true example: https://www.example.org/index.php x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d x-jws-signature: description: 'Header containing a detached JWS signature of the body of the payload. ' required: true schema: type: string deprecated: false maxLength: 8192 minLength: 10 pattern: ^[A-Za-z0-9-_="\/.]{1,8192}$ nullable: false example: V2hhdCBoYXRoIGdvZCB3cm91Z2h0ID8=..QnkgR2VvcmdlLCBzaGUncyBnb3QgaXQhIEJ5IEdlb3JnZSBzaGUncyBnb3QgaXQhIE5vdyBvbmNlIGFnYWluLCB3aGVyZSBkb2VzIGl0IHJhaW4 Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBWriteFileConsentResponse4' examples: create-file-pay-con-response: value: Data: ConsentId: BARCLAYS-P-12345678901234 Status: AWUP CreationDateTime: '2018-06-05T15:15:13+00:00' StatusUpdateDateTime: '2018-06-05T15:15:13+00:00' CutOffDateTime: '2018-07-05T15:15:22+00:00' StatusReason: - StatusReasonCode: U036 StatusReasonDescription: Authorisation not completed. Awaiting file upload Charges: - ChargeBearer: Shared Type: UK.OBIE.CHAPSOut Amount: Amount: '0.88' Currency: GBP Authorisation: AuthorisationType: Any CompletionDateTime: '2019-05-30T10:35:27Z' Debtor: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '11280001234567' LEI: 8200007YHFDMEODY1965 Name: Andrea Smith SecondaryIdentification: '0002' Initiation: LocalInstrument: UK.OBIE.Paym RequestedExecutionDateTime: '2017-06-05T15:15:22+00:00' FileType: UK.OBIE.pain.001.001.08 FileHash: m5ah/h1UjLvJYMxqAoZmj9dKdjZnsGNm+yMkJp/KuqQ FileReference: GB2OK238 NumberOfTransactions: '100' ControlSum: 3459.3 DebtorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '11280001234567' Name: Andrea Smith SecondaryIdentification: '0002' Proxy: Identification: '441234012345' Code: TELE Type: Telephone CreditorAgent: LEI: 123400LZEVUKWCQY6X15 SchemeName: UK.OBIE.IBAN Identification: '80200112344562' Name: The Credit Agent PostalAddress: AddressType: BIZZ StreetName: Bank Street BuildingNumber: '11' Floor: '6' PostCode: Z78 4TY TownName: London Country: UK UltimateDebtor: SchemeName: UK.OBIE.IBAN Identification: '2360549017905161589' Name: Ultimate Debtor LEI: 8200007YHFDMEODY1965 PostalAddress: AddressType: BIZZ StreetName: Bank Street BuildingNumber: '11' Floor: '6' PostCode: Z78 4TY TownName: London Country: UK RemittanceInformation: Structured: - ReferredDocumentInformation: - Code: CINV Issuer: Issuer01 Number: Number_01 RelatedDate: '2024-04-25T13:26:41.911Z' LineDetails: - string ReferredDocumentAmount: 1 CreditorReferenceInformation: Code: DISP Issuer: Issuer01 Reference: REF_26518 Invoicer: INVR51856 Invoicee: INVE5161856 TaxRemittance: Tax Remittance related information AdditionalRemittanceInformation: - Free text for additional information Unstructured: - Internal ops code 5120101 SCASupportData: RequestedSCAExemptionType: EcommerceGoods AppliedAuthenticationApproach: SCA ReferencePaymentOrderId: O-611265 Links: Self: https://api.alphabank.com/open-banking/v4.0/pisp/file-payment-consents/512345 Meta: {} 201FilePaymentsCreated: description: File Payments Created headers: Location: description: Mandatory response header for HTTP 201 (Created) response codes schema: type: string deprecated: false maxLength: 492 minLength: 2 pattern: ^(https:\/\/[-a-zA-Z0-9\\._\\\/?=]{2,492})$ nullable: true example: https://www.example.org/index.php x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d x-jws-signature: description: 'Header containing a detached JWS signature of the body of the payload. ' required: true schema: type: string deprecated: false maxLength: 8192 minLength: 10 pattern: ^[A-Za-z0-9-_="\/.]{1,8192}$ nullable: false example: V2hhdCBoYXRoIGdvZCB3cm91Z2h0ID8=..QnkgR2VvcmdlLCBzaGUncyBnb3QgaXQhIEJ5IEdlb3JnZSBzaGUncyBnb3QgaXQhIE5vdyBvbmNlIGFnYWluLCB3aGVyZSBkb2VzIGl0IHJhaW4 Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBWriteFileResponse3' examples: create-file-pay-response: value: Data: ConsentId: BARCLAYS-P-12345678901234 FilePaymentId: FP1-512345 Status: INFA CreationDateTime: '2018-06-05T15:15:13+00:00' StatusUpdateDateTime: '2018-06-05T15:15:13+00:00' StatusReason: - StatusReasonCode: U030 StatusReasonDescription: Payment order successfully received Charges: - ChargeBearer: Shared Type: UK.OBIE.CHAPSOut Amount: Amount: '0.88' Currency: GBP Debtor: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '11280001234567' Name: Andrea Smith SecondaryIdentification: '0002' LEI: 8200007YHFDMEODY1965 MultiAuthorisation: Status: AUTH NumberRequired: 2 NumberReceived: 2 LastUpdateDateTime: '2017-06-05T15:15:13+00:00' ExpirationDateTime: '2017-06-06T15:15:13+00:00' Initiation: FileType: UK.OBIE.pain.001.001.08 FileHash: m5ah/h1UjLvJYMxqAoZmj9dKdjZnsGNm+yMkJp/KuqQ FileReference: GB2OK238 NumberOfTransactions: '100' ControlSum: 3459.3 LocalInstrument: UK.OBIE.CHAPS RequestedExecutionDateTime: '2024-06-03T00:00:00Z' DebtorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '11280001234567' Name: Andrea Smith SecondaryIdentification: '0002' Proxy: Identification: '441234012345' Code: TELE Type: Telephone UltimateDebtor: SchemeName: UK.OBIE.IBAN Identification: '2360549017905161589' Name: Ultimate Debtor LEI: 8200007YHFDMEODY1965 PostalAddress: AddressType: BIZZ StreetName: Bank Street BuildingNumber: '11' Floor: '6' PostCode: Z78 4TY TownName: London Country: UK CreditorAgent: LEI: 123400LZEVUKWCQY6X15 SchemeName: UK.OBIE.IBAN Identification: '80200112344562' Name: The Credit Agent PostalAddress: AddressType: BIZZ StreetName: Bank Street BuildingNumber: '11' Floor: '6' PostCode: Z78 4TY TownName: London Country: UK RemittanceInformation: Structured: - ReferredDocumentInformation: - Code: CINV Issuer: Issuer01 Number: Number_01 RelatedDate: '2024-04-25T13:26:41.911Z' LineDetails: - string ReferredDocumentAmount: 1 CreditorReferenceInformation: Code: DISP Issuer: Issuer01 Reference: REF_26518 Invoicer: INVR51856 Invoicee: INVE5161856 TaxRemittance: Tax Remittance related information AdditionalRemittanceInformation: - Free text for additional information Unstructured: - Internal ops code 5120101 Links: Self: https://api.alphabank.com/open-banking/v4.0/pisp/file-payments/FP1-512345 Meta: {} 200FilePaymentsFilePaymentIdRead: description: File Payments Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d x-jws-signature: description: 'Header containing a detached JWS signature of the body of the payload. ' required: true schema: type: string deprecated: false maxLength: 8192 minLength: 10 pattern: ^[A-Za-z0-9-_="\/.]{1,8192}$ nullable: false example: V2hhdCBoYXRoIGdvZCB3cm91Z2h0ID8=..QnkgR2VvcmdlLCBzaGUncyBnb3QgaXQhIEJ5IEdlb3JnZSBzaGUncyBnb3QgaXQhIE5vdyBvbmNlIGFnYWluLCB3aGVyZSBkb2VzIGl0IHJhaW4 Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBWriteFileResponse3' examples: get-file-response: value: Data: FilePaymentId: BARCLAYS-P-12345678901234 ConsentId: BARCLAYS-P-12345678901234 CreationDateTime: '2018-10-15T09:38:33.700Z' Status: INFA StatusUpdateDateTime: '2018-10-15T09:38:33.700Z' Charges: - ChargeBearer: BorneByCreditor Type: UK.OBIE.CHAPSOut Amount: Amount: '22.21' Currency: GBP Initiation: FileType: UK.OBIE.PaymentInitiation.4.0 FileHash: 5ah/h1UjLvJYMxqAoZmj9dKdjZnsGNm+yMkJp/KuqQ FileReference: B2OK238 NumberOfTransactions: '100' ControlSum: 24.3 RequestedExecutionDateTime: '2018-10-15T08:47:41.218Z' LocalInstrument: UK.OBIE.FPS DebtorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '12345678901234' Name: DebtorAccountName SecondaryIdentification: DSecId2 RemittanceInformation: Unstructured: - Unstructured MultiAuthorisation: Status: AUTH NumberRequired: 0 NumberReceived: 0 LastUpdateDateTime: '2018-10-15T09:38:33.700Z' ExpirationDateTime: '2018-10-15T09:38:33.700Z' Links: Self: https://api.alphabank.com/open-banking/v4.0/pisp/domestic-scheduled-payments/7290-003 Meta: TotalPages: 0 FirstAvailableDateTime: '2018-10-15T09:38:33.700Z' LastAvailableDateTime: '2018-10-15T09:38:33.700Z' 200FilePaymentsFilePaymentIdReportFileRead: description: File Payments Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d x-jws-signature: description: 'Header containing a detached JWS signature of the body of the payload. ' required: true schema: type: string deprecated: false maxLength: 8192 minLength: 10 pattern: ^[A-Za-z0-9-_="\/.]{1,8192}$ nullable: false example: V2hhdCBoYXRoIGdvZCB3cm91Z2h0ID8=..QnkgR2VvcmdlLCBzaGUncyBnb3QgaXQhIEJ5IEdlb3JnZSBzaGUncyBnb3QgaXQhIE5vdyBvbmNlIGFnYWluLCB3aGVyZSBkb2VzIGl0IHJhaW4 Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBWriteFileResponse4' examples: create-file-pay-reportfile-response: value: Data: ConsentId: BARCLAYS-P-12345678901234 FilePaymentId: FP1-512345 Status: ACSP CreationDateTime: '2018-06-05T15:15:13+00:00' StatusUpdateDateTime: '2018-06-05T15:15:13+00:00' MultiAuthorisation: Status: AUTH NumberRequired: 2 NumberReceived: 2 LastUpdateDateTime: '2017-06-05T15:15:13+00:00' ExpirationDateTime: '2017-06-06T15:15:13+00:00' Initiation: FileType: UK.OBIE.pain.001.001.08 FileHash: m5ah/h1UjLvJYMxqAoZmj9dKdjZnsGNm+yMkJp/KuqQ FileReference: GB2OK238 NumberOfTransactions: '100' ControlSum: 3459.3 LocalInstrument: UK.OBIE.CHAPS RequestedExecutionDateTime: '2024-06-03T00:00:00Z' DebtorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '11280001234567' Name: Andrea Smith SecondaryIdentification: '0002' Proxy: Identification: '441234012345' Code: TELE Type: Telephone RemittanceInformation: Structured: - ReferredDocumentInformation: - Code: CINV Issuer: Issuer01 Number: Number_01 RelatedDate: '2024-04-25T13:26:41.911Z' LineDetails: - string ReferredDocumentAmount: 1 CreditorReferenceInformation: Code: DISP Issuer: Issuer01 Reference: REF_26518 Invoicer: INVR51856 Invoicee: INVE5161856 TaxRemittance: Tax Remittance related information AdditionalRemittanceInformation: - Free text for additional information Unstructured: - Internal ops code 5120101 Links: Self: https://api.alphabank.com/open-banking/v4.0/pisp/file-payments/{filePaymentId}/reportfile/58923-001 Meta: {} 409Error: description: Conflict headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d x-jws-signature: description: Header containing a detached JWS signature of the body of the payload. required: true schema: type: string deprecated: false maxLength: 8192 minLength: 10 pattern: ^[A-Za-z0-9-_="\/.]{1,8192}$ nullable: false example: V2hhdCBoYXRoIGdvZCB3cm91Z2h0ID8=..QnkgR2VvcmdlLCBzaGUncyBnb3QgaXQhIEJ5IEdlb3JnZSBzaGUncyBnb3QgaXQhIE5vdyBvbmNlIGFnYWluLCB3aGVyZSBkb2VzIGl0IHJhaW4 Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' examples: 409ErrorResponse: value: Code: OB.BadRequest Id: 2b5f0fb2-730b-11e8-adc0-fa7ae01bbebc Message: Invalid request parameters Errors: - ErrorCode: AC17 Message: Version must be supplied Path: Data.Initiation Url: - ErrorCode: AC17 Message: Version supplied is not valid Path: Data.Initiation.CreditorAccount Url: 403Error: description: Forbidden headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' examples: 403ErrorResponse: value: Code: OB.BadRequest Id: 2b5f0fb2-730b-11e8-adc0-fa7ae01bbebc Message: Invalid request parameters Errors: - ErrorCode: AC17 Message: Version must be supplied Path: Data.Initiation Url: - ErrorCode: AC17 Message: Version supplied is not valid Path: Data.Initiation.CreditorAccount Url: 500Error: description: Internal Server Error headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBErrorResponse1' examples: 500ErrorResponse: value: Code: OB.BadRequest Id: 2b5f0fb2-730b-11e8-adc0-fa7ae01bbebc Message: Invalid request parameters Errors: - ErrorCode: AC17 Message: Version must be supplied Path: Data.Initiation Url: - ErrorCode: AC17 Message: Version supplied is not valid Path: Data.Initiation.CreditorAccount Url: 429Error: description: Too Many Requests headers: Retry-After: description: Number in seconds to wait schema: type: integer deprecated: false maximum: 9999999 minimum: 1 nullable: false example: 120 x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate 200FilePaymentConsentsConsentIdRead: description: File Payment Consents Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d x-jws-signature: description: 'Header containing a detached JWS signature of the body of the payload. ' required: true schema: type: string deprecated: false maxLength: 8192 minLength: 10 pattern: ^[A-Za-z0-9-_="\/.]{1,8192}$ nullable: false example: V2hhdCBoYXRoIGdvZCB3cm91Z2h0ID8=..QnkgR2VvcmdlLCBzaGUncyBnb3QgaXQhIEJ5IEdlb3JnZSBzaGUncyBnb3QgaXQhIE5vdyBvbmNlIGFnYWluLCB3aGVyZSBkb2VzIGl0IHJhaW4 Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/OBWriteFileConsentResponse4' examples: get-file-consent-response: value: Data: ConsentId: BARCLAYS-P-12345678901234 CreationDateTime: '2018-10-15T08:47:41.218Z' Status: AWAU StatusUpdateDateTime: '2018-10-15T08:47:41.218Z' Charges: - ChargeBearer: BorneByCreditor Type: UK.OBIE.CHAPSOut Amount: Amount: '22.21' Currency: GBP Initiation: FileType: UK.OBIE.PaymentInitiation.4.0 FileHash: 5ah/h1UjLvJYMxqAoZmj9dKdjZnsGNm+yMkJp/KuqQ FileReference: B2OK238 NumberOfTransactions: '100' ControlSum: 24.3 RequestedExecutionDateTime: '2018-10-15T08:47:41.218Z' LocalInstrument: UK.OBIE.FPS DebtorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '12345678901234' Name: DebtorAccountName SecondaryIdentification: DSecId2 RemittanceInformation: Unstructured: - Unstructured Authorisation: AuthorisationType: Any CompletionDateTime: '2018-10-15T08:44:15.520Z' Links: Self: https://api.alphabank.com/open-banking/v4.0/pisp/domestic-scheduled-payments/7290-003 Meta: TotalPages: 0 FirstAvailableDateTime: '2018-10-15T08:47:41.218Z' LastAvailableDateTime: '2018-10-15T08:47:41.218Z' 200FilePaymentConsentsConsentIdFileRead: description: File Payment Consents Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d x-jws-signature: description: 'Header containing a detached JWS signature of the body of the payload. ' required: true schema: type: string deprecated: false maxLength: 8192 minLength: 10 pattern: ^[A-Za-z0-9-_="\/.]{1,8192}$ nullable: false example: V2hhdCBoYXRoIGdvZCB3cm91Z2h0ID8=..QnkgR2VvcmdlLCBzaGUncyBnb3QgaXQhIEJ5IEdlb3JnZSBzaGUncyBnb3QgaXQhIE5vdyBvbmNlIGFnYWluLCB3aGVyZSBkb2VzIGl0IHJhaW4 Cache-Control: description: GIS mandatory response header. This is added by the Cognac sidecar. schema: type: string default: no-cache, no-store, must-revalidate deprecated: false maxLength: 35 minLength: 35 pattern: ^no-cache, no-store, must-revalidate$ nullable: false example: no-cache, no-store, must-revalidate content: application/json: schema: $ref: '#/components/schemas/File' parameters: ConsentId: name: consentId in: path description: ConsentId required: true schema: type: string maxLength: 25 minLength: 1 pattern: ^BARCLAYS-P-\d{14}$ example: BARCLAYS-P-12345678901234 x-jws-signature: name: x-jws-signature in: header description: A detached JWS signature of the body of the payload. required: true schema: type: string deprecated: false maxLength: 8192 minLength: 10 pattern: ^[A-Za-z0-9-_="\/.]{1,8192}$ nullable: false example: V2hhdCBoYXRoIGdvZCB3cm91Z2h0ID8=..QnkgR2VvcmdlLCBzaGUncyBnb3QgaXQhIEJ5IEdlb3JnZSBzaGUncyBnb3QgaXQhIE5vdyBvbmNlIGFnYWluLCB3aGVyZSBkb2VzIGl0IHJhaW4 x-fapi-interaction-id: name: x-fapi-interaction-id in: header description: An RFC4122 UID used as a correlation id. required: false schema: type: string deprecated: false maxLength: 36 minLength: 32 pattern: ^[A-Za-f0-9]{8}-?[A-Za-f0-9]{4}-?[1-5][A-Za-f0-9]{3}-?[89ab][A-Za-f0-9]{3}-?[A-Za-f0-9]{12}$ nullable: false example: 93bac548-d2de-4546-b106-880a5018460d x-fapi-customer-ip-address: name: x-fapi-customer-ip-address in: header description: The PSU's IP address if the PSU is currently logged in with the TPP. required: false schema: type: string maxLength: 40 minLength: 7 pattern: ^((?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(([0-9a-fA-F]{1,4}:){7,7}[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,7}:|([0-9a-fA-F]{1,4}:){1,6}:[0-9a-fA-F]{1,4}|([0-9a-fA-F]{1,4}:){1,5}(:[0-9a-fA-F]{1,4}){1,2}|([0-9a-fA-F]{1,4}:){1,4}(:[0-9a-fA-F]{1,4}){1,3}|([0-9a-fA-F]{1,4}:){1,3}(:[0-9a-fA-F]{1,4}){1,4}|([0-9a-fA-F]{1,4}:){1,2}(:[0-9a-fA-F]{1,4}){1,5}|[0-9a-fA-F]{1,4}:((:[0-9a-fA-F]{1,4}){1,6})|:((:[0-9a-fA-F]{1,4}){1,7}|:)|fe80:(:[0-9a-fA-F]{0,4}){0,4}%[0-9a-zA-Z]{1,}|::(ffff(:0{1,4}){0,1}:){0,1}((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])|([0-9a-fA-F]{1,4}:){1,4}:((25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])\.){3,3}(25[0-5]|(2[0-4]|1{0,1}[0-9]){0,1}[0-9])))$ nullable: false example: 104.25.212.99 FilePaymentId: name: filePaymentId in: path description: FilePaymentId required: true schema: type: string maxLength: 25 minLength: 1 pattern: ^BARCLAYS-P-\d{14}$ example: BARCLAYS-P-12345678901234 x-fapi-auth-date: name: x-fapi-auth-date in: header 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" required: false schema: type: string deprecated: false maxLength: 29 minLength: 29 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)$ nullable: false example: Sun, 10 Sep 2017 19:43:31 UTC x-customer-user-agent: name: x-customer-user-agent in: header description: Indicates the user-agent that the PSU is using. required: false schema: type: string deprecated: false maxLength: 500 minLength: 1 nullable: false example: Mozilla/5.0 (iPad; U; CPU OS 3_2_1 like Mac OS X; en-us) AppleWebKit/531.21.10 (KHTML, like Gecko) Mobile/7B405 Authorization: name: Authorization in: header description: An Authorisation Token as per https://tools.ietf.org/html/rfc6750 required: true schema: type: string maxLength: 4871 minLength: 1 pattern: ^Bearer [A-Za-z0-9-_=]{1,256}\.\.[A-Za-z0-9-_=]{1,100}\.[A-Za-z0-9-_=]{1,4096}\.[A-Za-z0-9-_=]{1,100}$ nullable: false example: Bearer eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE0OTk4NTA5NjUsInN1YiI6IkJhcmNsYXlzX1BheW1lbnRfU2VydmljZSIsInNjb3BlIjpbImlkcy5tYW5hZ2Vfa2V5IiwiaWRzLm1hbmFnZV9jbGllbnQiXSwiaXNzIjoiaHR0cDovL2lkZW50aXR5LXNlcnZpY2UvIiwiaWF0IjoxNDk5ODUwMDY1fQ.OX-u14YLs7iksl6gnZ9ZqMBu-ekFi4pSva5mzhuf2xU 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 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-. '()@#£%{}=":_]{1,40})$ example: FRESNO.1317.GFX.22 securitySchemes: TPPOAuth2Security: type: oauth2 description: TPP client credential authorisation flow with the ASPSP flows: clientCredentials: tokenUrl: https://authserver.example/token scopes: payments: Generic payment scope 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: payments: Generic payment scope