openapi: 3.1.0 info: title: Payment Initiation description: Initiate a single and immediate non-mandated funds transfer version: v4.0 x-method: searched x-source: https://developer.barclays.com/api/apis/versions/6f206027-5e08-4f4f-a1c5-553cba3c847c.bdn/design?specification=oas31 x-harvested: '2026-09-04' x-harvested-note: Verbatim OpenAPI 3.1 design export from the Barclays API Exchange registry (developer.barclays.com), fetched anonymously. The untouched export is in openapi/_original/barclays-payment-initiation-openapi.json. The UK Open Banking documents carry OBIE (openbanking.org.uk) in info.contact/termsOfService because they are the OBIE standard contract as Barclays implements and publishes it — the API, the registry record and the host are Barclays'. tags: - name: Domestic Payments description: Domestic Payments - name: Payment Details description: Payment Details - name: Domestic Scheduled Payments description: Domestic Scheduled Payments - name: Domestic Standing Orders description: Domestic Standing Orders - name: File Payments description: File Payments - name: International Payments description: International Payments - name: International Scheduled Payments description: International Scheduled Payments - name: International Standing Orders description: International Standing Orders paths: /international-payments/{internationalPaymentId}/payment-details: summary: Get Payment Details description: Get Payment Details get: tags: - Payment Details summary: Get Payment Details description: Get Payment Details operationId: GetInternationalPaymentsInternationalPaymentIdPaymentDetails parameters: - $ref: '#/components/parameters/InternationalPaymentId' - $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: '500': $ref: '#/components/responses/500Error' '405': $ref: '#/components/responses/405Error' deprecated: false /international-scheduled-payment-consents/{consentId}/funds-confirmation: summary: Get International Scheduled Payment Consents Funds Confirmation description: Get International Scheduled Payment Consents Funds Confirmation get: tags: - International Scheduled Payments summary: Get International Scheduled Payment Consents Funds Confirmation description: Get International Scheduled Payment Consents Funds Confirmation operationId: GetInternationalScheduledPaymentConsentsConsentIdFundsConfirmation parameters: - $ref: '#/components/parameters/ConsentId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200InternationalScheduledPaymentConsentsConsentIdFundsConfirmationRead' '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}: summary: Get File Payment Consents description: Get File Payment Consents get: tags: - File Payments summary: Get File Payment Consents description: 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 /domestic-payment-consents/{consentId}: summary: Get Domestic Payment Consents description: Get Domestic Payment Consents get: tags: - Domestic Payments summary: Get Domestic Payment Consents description: Get Domestic Payment Consents operationId: GetDomesticPaymentConsentsConsentId 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/200DomesticPaymentConsentsConsentIdRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '500': $ref: '#/components/responses/500Error' '403': $ref: '#/components/responses/403Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' deprecated: false /domestic-scheduled-payments/{domesticScheduledPaymentId}/payment-details: summary: Get Payment Details description: Get Payment Details get: tags: - Payment Details summary: Get Payment Details description: Get Payment Details operationId: GetDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails parameters: - $ref: '#/components/parameters/DomesticScheduledPaymentId' - $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: '500': $ref: '#/components/responses/500Error' '405': $ref: '#/components/responses/405Error' deprecated: false /domestic-scheduled-payment-consents: summary: Create Domestic Scheduled Payment Consents description: Create Domestic Scheduled Payment Consents post: tags: - Domestic Scheduled Payments summary: Create Domestic Scheduled Payment Consents description: Create Domestic Scheduled Payment Consents operationId: CreateDomesticScheduledPaymentConsents 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/OBWriteDomesticScheduledConsent4' examples: domestic-scheduled-payment-consents-request: value: Data: Authorisation: AuthorisationType: Any CompletionDateTime: '2025-05-30T10:35:27Z' Permission: Create ReadRefundAccount: 'Yes' Initiation: InstructionIdentification: 89f0a53a91ee47f6a383536f851d6b5a EndToEndIdentification: FRESCO.21302.GFX.20 LocalInstrument: UK.OBIE.Paym RequestedExecutionDateTime: '2018-08-06T00:00:00+00:00' InstructedAmount: Amount: '200.00' Currency: GBP DebtorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '11280001234567' Name: Andrea Frost Proxy: Identification: '+441632960540' Code: TELE Type: Telephone CreditorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 SecondaryIdentification: 08080021325641 Name: Tom Kirkman 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 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: - 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 Risk: {} required: true responses: '201': $ref: '#/components/responses/201DomesticScheduledPaymentConsentsCreated' '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 /domestic-standing-order-consents/{consentId}: summary: Get Domestic Standing Order Consents description: Get Domestic Standing Order Consents get: tags: - Domestic Standing Orders summary: Get Domestic Standing Order Consents description: Get Domestic Standing Order Consents operationId: GetDomesticStandingOrderConsentsConsentId 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/200DomesticStandingOrderConsentsConsentIdRead' '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 description: 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 /domestic-payments/{domesticPaymentId}/payment-details: summary: Get Payment Details description: Get Payment Details get: tags: - Payment Details summary: Get Payment Details description: Get Payment Details operationId: GetDomesticPaymentsDomesticPaymentIdPaymentDetails parameters: - $ref: '#/components/parameters/DomesticPaymentId' - $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: '500': $ref: '#/components/responses/500Error' '405': $ref: '#/components/responses/405Error' deprecated: false /international-payment-consents/{consentId}: summary: Get International Payment Consents description: Get International Payment Consents get: tags: - International Payments summary: Get International Payment Consents description: Get International Payment Consents operationId: GetInternationalPaymentConsentsConsentId 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/200InternationalPaymentConsentsConsentIdRead' '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 /international-scheduled-payment-consents: summary: Create International Scheduled Payment Consents description: Create International Scheduled Payment Consents post: tags: - International Scheduled Payments summary: Create International Scheduled Payment Consents description: Create International Scheduled Payment Consents operationId: CreateInternationalScheduledPaymentConsents parameters: - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-idempotency-key' - $ref: '#/components/parameters/x-jws-signature' - $ref: '#/components/parameters/x-customer-user-agent' requestBody: description: Default content: application/json: schema: $ref: '#/components/schemas/OBWriteInternationalScheduledConsent5' examples: create-int-sched-pay-con-request: value: Data: Permission: Create ReadRefundAccount: 'Yes' Initiation: InstructionIdentification: ACME412 EndToEndIdentification: FRESCO.21302.GFX.20 LocalInstrument: UK.OBIE.Paym InstructionPriority: Normal ChargeBearer: Shared RequestedExecutionDateTime: '2024-09-16T10:25:28.422Z' CurrencyOfTransfer: USD DestinationCountryCode: GB InstructedAmount: Amount: '165.88' Currency: GBP ExchangeRateInformation: UnitCurrency: GBP ExchangeRate: 1.22 RateType: Actual ContractIdentification: '415621656' DebtorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber SecondaryIdentification: '0002' Identification: '11280001234567' Name: Andrea Smith Proxy: Identification: '2360549017905188' Code: TELE Type: Telephone Creditor: Name: A Creditor Name LEI: 8200007YHFDMEODY8412 PostalAddress: AddressType: BIZZ StreetName: Bank Street BuildingNumber: '11' Floor: '6' PostCode: Z78 4TY TownName: London Country: UK CreditorAgent: SchemeName: UK.OBIE.IBAN Identification: 08080021325698 LEI: 1234005BLKBSWLCX4E37 Name: ACED Inc PostalAddress: AddressType: BIZZ Department: Finance SubDepartment: Payroll StreetName: Bank Street BuildingNumber: '11' BuildingName: Tower Bridges Floor: '6' UnitNumber: UNIT591 Room: '844' PostBox: PO Box 123456 DistrictName: Greater London CareOf: Ms Jane Smith PostCode: Z78 4TY TownName: London CountrySubDivision: string Country: UK CreditorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: ACME Inc SecondaryIdentification: '0002' Proxy: Identification: '2360549017905188' Code: TELE Type: Telephone UltimateCreditor: Name: Ultimate Creditor Identification: '2360549017905161589' LEI: 60450004FECVJV7YN339 SchemeName: UK.OBIE.IBAN PostalAddress: AddressType: BIZZ StreetName: Bank Street BuildingNumber: '11' Floor: '6' PostCode: Z78 4TY TownName: London Country: UK UltimateDebtor: Name: Ultimate Debtor Identification: '2360549017905161589' LEI: 8200007YHFDMEODY1965 SchemeName: UK.OBIE.IBAN PostalAddress: AddressType: BIZZ StreetName: Bank Street BuildingNumber: '11' Floor: '6' PostCode: Z78 4TY TownName: London Country: UK RegulatoryReporting: - DebitCreditReportingIndicator: CRED Authority: Name: Authority Name CountryCode: UK Details: - Type: CRED Date: '2024-09-16T10:25:28.422Z' Country: UK Amount: Amount: '165.88' Currency: USD Information: - Reg Info 1 - Reg Info 2 RemittanceInformation: Structured: - ReferredDocumentInformation: - Code: CINV Issuer: Issuer01 Number: Number_01 RelatedDate: '2024-09-16T10:25:28.422Z' LineDetails: - Line details 1 - Line details 2 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 SupplementaryData: additionalProp1: {} Authorisation: AuthorisationType: Any CompletionDateTime: '2024-09-16T10:25:28.422Z' SCASupportData: RequestedSCAExemptionType: EcommerceGoods AppliedAuthenticationApproach: SCA ReferencePaymentOrderId: O-611265 Risk: PaymentContextCode: TransferToThirdParty ContractPresentIndicator: false PaymentPurposeCode: EPAY CategoryPurposeCode: CASH BeneficiaryAccountType: Business MerchantCategoryCode: '7300' MerchantCustomerIdentification: 053598653254 DeliveryAddress: AddressLine: - Flat 7 - Acacia Lodge StreetName: Acacia Avenue BuildingNumber: '27' PostCode: GU31 2ZZ TownName: Sparsholt CountrySubDivision: Wessex Country: UK required: true responses: '201': $ref: '#/components/responses/201InternationalScheduledPaymentConsentsCreated' '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 /domestic-payments: summary: Create Domestic Payments description: Create Domestic Payments post: tags: - Domestic Payments summary: Create Domestic Payments description: Create Domestic Payments operationId: CreateDomesticPayments 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/OBWriteDomestic2' examples: get-domestic-payments: value: Data: ConsentId: BARCLAYS-P-12345678901234 Initiation: InstructionIdentification: ACME412 EndToEndIdentification: FRESCO.21302.GFX.20 LocalInstrument: UK.OBIE.Paym InstructedAmount: Amount: '165.88' Currency: GBP CreditorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: ACME Inc SecondaryIdentification: '0002' Proxy: Identification: '+441632960540' Code: TELE Type: Telephone DebtorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080025612489 SecondaryIdentification: 080801562314789 Name: Jane Smith 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 UltimateCreditor: SchemeName: UK.OBIE.BBAN Identification: '2360549017905161589' Name: Ultimate Creditor LEI: 60450004FECVJV7YN339 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 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: - 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 Risk: PaymentContextCode: EcommerceMerchantInitiatedPayment ContractPresentIndicator: false PaymentPurposeCode: EPAY CategoryPurposeCode: CASH BeneficiaryAccountType: Business MerchantCategoryCode: '7300' MerchantCustomerIdentification: 053598653254 DeliveryAddress: AddressLine: - Flat 7 - Acacia Lodge StreetName: Acacia Avenue BuildingNumber: '27' PostCode: GU31 2ZZ TownName: Sparsholt CountrySubDivision: Wessex Country: UK required: true responses: '201': $ref: '#/components/responses/201DomesticPaymentsCreated' '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' '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 /international-scheduled-payment-consents/{consentId}: summary: Get International Scheduled Payment Consents description: Get International Scheduled Payment Consents get: tags: - International Scheduled Payments summary: Get International Scheduled Payment Consents description: Get International Scheduled Payment Consents operationId: GetInternationalScheduledPaymentConsentsConsentId parameters: - $ref: '#/components/parameters/ConsentId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200InternationalScheduledPaymentConsentsConsentIdRead' '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 /domestic-payment-consents: summary: Create Domestic Payment Consents description: Create Domestic Payment Consents post: tags: - Domestic Payments summary: Create Domestic Payment Consents description: Create Domestic Payment Consents operationId: CreateDomesticPaymentConsents 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/OBWriteDomesticConsent4' examples: create-domestic-payment-consents: value: Data: ReadRefundAccount: 'Yes' Initiation: InstructionIdentification: ACME412 EndToEndIdentification: FRESCO.21302.GFX.20 LocalInstrument: UK.OBIE.Paym 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 Authorisation: AuthorisationType: Any CompletionDateTime: '2025-05-30T10:35:27Z' SCASupportData: RequestedSCAExemptionType: EcommerceGoods AppliedAuthenticationApproach: SCA ReferencePaymentOrderId: O-611265 Risk: PaymentContextCode: EcommerceMerchantInitiatedPayment ContractPresentIndicator: false PaymentPurposeCode: EPAY CategoryPurposeCode: CASH BeneficiaryAccountType: Business MerchantCategoryCode: '7300' MerchantCustomerIdentification: 053598653254 DeliveryAddress: AddressLine: - Flat 7 - Acacia Lodge StreetName: Acacia Avenue BuildingNumber: '27' PostCode: GU31 2ZZ TownName: Sparsholt CountrySubDivision: Wessex Country: GB required: true responses: '201': $ref: '#/components/responses/201DomesticPaymentConsentsCreated' '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' '415': $ref: '#/components/responses/415Error' '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 description: 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 /domestic-scheduled-payment-consents/{consentId}: summary: Get Domestic Scheduled Payment Consents description: Get Domestic Scheduled Payment Consents get: tags: - Domestic Scheduled Payments summary: Get Domestic Scheduled Payment Consents description: Get Domestic Scheduled Payment Consents operationId: GetDomesticScheduledPaymentConsentsConsentId 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/200DomesticScheduledPaymentConsentsConsentIdRead' '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 description: 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 description: 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 /international-scheduled-payments: summary: Create International Scheduled Payments description: Create International Scheduled Payments post: tags: - International Scheduled Payments summary: Create International Scheduled Payments description: Create International Scheduled Payments operationId: CreateInternationalScheduledPayments parameters: - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-idempotency-key' - $ref: '#/components/parameters/x-jws-signature' - $ref: '#/components/parameters/x-customer-user-agent' requestBody: description: Default content: application/json: schema: $ref: '#/components/schemas/OBWriteInternationalScheduled3' examples: create-int-sched-payments-request: value: Data: ConsentId: BARCLAYS-P-12345678901234 Initiation: InstructionIdentification: string EndToEndIdentification: string LocalInstrument: UK.OBIE.SWIFT InstructionPriority: Normal ChargeBearer: BorneByCreditor RequestedExecutionDateTime: '2018-09-19T11:03:57.587Z' CurrencyOfTransfer: USD InstructedAmount: Amount: '1000.00' Currency: GBP ExchangeRateInformation: UnitCurrency: GBP ExchangeRate: 88.1 RateType: Actual ContractIdentification: string DebtorAccount: SchemeName: UK.OBIE.BBAN Identification: IN34567890123456789012345678901234 Name: string SecondaryIdentification: string Creditor: Name: John Snow PostalAddress: AddressType: BIZZ Department: string SubDepartment: string StreetName: string BuildingNumber: '21' PostCode: string TownName: string CountrySubDivision: string Country: UK AddressLine: - string CreditorAgent: SchemeName: UK.OBIE.IBAN Identification: '12345678901234' Name: string PostalAddress: AddressType: BIZZ Department: string SubDepartment: string StreetName: string BuildingNumber: '23' PostCode: string TownName: string CountrySubDivision: string Country: IN AddressLine: - string CreditorAccount: SchemeName: UK.OBIE.IBAN Identification: IN34567890123456789012345678901234 Name: string SecondaryIdentification: string RemittanceInformation: Unstructured: - string Risk: PaymentContextCode: TransferToThirdParty MerchantCategoryCode: AMAZ MerchantCustomerIdentification: string DeliveryAddress: AddressLine: - string StreetName: string BuildingNumber: string PostCode: string TownName: string CountrySubDivision: CountrySubDivision1 Country: GB BeneficiaryPrepopulatedIndicator: true PaymentPurposeCode: EPAY BeneficiaryAccountType: BusinessSavingsAccount required: true responses: '201': $ref: '#/components/responses/201InternationalScheduledPaymentsCreated' '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 /domestic-payment-consents/{consentId}/funds-confirmation: summary: Get Domestic Payment Consents Funds Confirmation description: Get Domestic Payment Consents Funds Confirmation get: tags: - Domestic Payments summary: Get Domestic Payment Consents Funds Confirmation description: Get Domestic Payment Consents Funds Confirmation operationId: GetDomesticPaymentConsentsConsentIdFundsConfirmation 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/200DomesticPaymentConsentsConsentIdFundsConfirmationRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '500': $ref: '#/components/responses/500Error' '403': $ref: '#/components/responses/403Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' deprecated: false /international-standing-orders: summary: Create International Standing Orders description: Create International Standing Orders post: tags: - International Standing Orders summary: Create International Standing Orders description: Create International Standing Orders operationId: CreateInternationalStandingOrders parameters: - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-idempotency-key' - $ref: '#/components/parameters/x-jws-signature' - $ref: '#/components/parameters/x-customer-user-agent' requestBody: description: Default content: application/json: schema: $ref: '#/components/schemas/OBWriteInternationalStandingOrder4' examples: create-int-stand-order-request: value: Data: ConsentId: BARCLAYS-P-12345678901234 Initiation: ChargeBearer: Shared DestinationCountryCode: GB CurrencyOfTransfer: GBP DebtorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: ACME Inc SecondaryIdentification: '0002' LEI: 8200007YHFDMEODY1965 Proxy: Identification: 07700900000 Code: TELE Type: Telephone CreditorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: ACME Inc SecondaryIdentification: '0002' Proxy: Identification: '+441632960540' Code: TELE Type: Telephone InstructedAmount: Amount: '20' Currency: EUR Creditor: SchemeName: UK.OBIE.SortCodeAccountNumber LEI: 8200007YHFDMEODY8412 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 CurrencyOfTansfer: EUR 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 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: UK RegulatoryReporting: - DebitCreditReportingIndicator: CRED Authority: Name: string CountryCode: UG Details: - Date: '2024-04-25T13:26:41.911Z' 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: - 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 MandateRelatedInformation: MandateIdentification: SO003538282 Classification: FIXE CategoryPurposeCode: CASH FirstPaymentDateTime: '2024-09-04T16:33:53.087Z' FinalPaymentDateTime: '2025-09-04T16:33:53.087Z' Frequency: Type: DAIL CountPerPeriod: 1 Reason: Pocket Money Risk: PaymentContextCode: TransferToThirdParty PaymentPurposeCode: EPAY CategoryPurposeCode: CASH BeneficiaryAccountType: Business MerchantCategoryCode: '7300' MerchantCustomerIdentification: 053598653254 DeliveryAddress: AddressLine: - Flat 7 - Acacia Lodge StreetName: Acacia Avenue BuildingNumber: '27' PostCode: GU31 2ZZ TownName: Sparsholt CountrySubDivision: Wessex Country: UK required: true responses: '422': $ref: '#/components/responses/422Error' '500': $ref: '#/components/responses/500Error' '405': $ref: '#/components/responses/405Error' deprecated: false /international-scheduled-payments/{internationalScheduledPaymentId}: summary: Get International Scheduled Payments description: Get International Scheduled Payments get: tags: - International Scheduled Payments summary: Get International Scheduled Payments description: Get International Scheduled Payments operationId: GetInternationalScheduledPaymentsInternationalScheduledPaymentId parameters: - $ref: '#/components/parameters/InternationalScheduledPaymentId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200InternationalScheduledPaymentsInternationalScheduledPaymentIdRead' '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 /domestic-standing-orders: summary: Create Domestic Standing Orders description: Create Domestic Standing Orders post: tags: - Domestic Standing Orders summary: Create Domestic Standing Orders description: Create Domestic Standing Orders operationId: CreateDomesticStandingOrders parameters: - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-idempotency-key' - $ref: '#/components/parameters/x-jws-signature' - $ref: '#/components/parameters/x-customer-user-agent' requestBody: description: Default content: application/json: schema: $ref: '#/components/schemas/OBWriteDomesticStandingOrder3' examples: create-dom-stand-order-request: value: Data: ConsentId: BARCLAYS-P-12345678901234 Initiation: RemittanceInformation: Structured: - ReferredDocumentInformation: - Code: CINV Issuer: Issuer01 Number: Number_01 RelatedDate: '2024-09-04T16:33:53.086Z' LineDetails: - Line Detail ReferredDocumentAmount: 1 CreditorReferenceInformation: Code: DISP Issuer: Issuer01 Reference: Pocket money for Damien Invoicer: INVR51856 Invoicee: INVE5161856 TaxRemittance: Tax Remittance related information AdditionalRemittanceInformation: - Free text for additional information Unstructured: - Internal ops code 5120101 FirstPaymentAmount: Amount: '7.00' Currency: GBP RecurringPaymentAmount: Amount: '7.00' Currency: GBP FinalPaymentAmount: Amount: '7.00' Currency: GBP DebtorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '11280001234567' Name: Andrea Smith SecondaryIdentification: '0002' Proxy: Identification: 07700900000 Code: TELE Type: Telephone CreditorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: Bob Clements SecondaryIdentification: '0002' Proxy: Identification: 07700900999 Code: TELE Type: Telephone UltimateCreditor: SchemeName: UK.OBIE.BBAN Identification: '2360549017905161589' Name: Ultimate Creditor LEI: 60450004FECVJV7YN339 PostalAddress: AddressType: BIZZ StreetName: Bank Street BuildingNumber: '11' Floor: '6' PostCode: Z78 4TY TownName: London Country: UK 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 RegulatoryReporting: - DebitCreditReportingIndicator: CRED Authority: Name: Authority Name CountryCode: GB Details: - Type: CRED Date: '2024-04-25T13:26:41.911Z' Country: GB Amount: Amount: '7.00' Currency: GBP Information: - Reg info1 - Reg info2 MandateRelatedInformation: MandateIdentification: SO003538282 Classification: FIXE CategoryPurposeCode: CASH FirstPaymentDateTime: '2024-09-04T16:33:53.087Z' FinalPaymentDateTime: '2025-09-04T16:33:53.087Z' Frequency: Type: DAIL CountPerPeriod: 1 Reason: Pocket Money Risk: PaymentContextCode: TransferToThirdParty required: true responses: '201': $ref: '#/components/responses/201DomesticStandingOrdersCreated' '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 /international-payments: summary: Create International Payments description: Create International Payments post: tags: - International Payments summary: Create International Payments description: Create International Payments operationId: CreateInternationalPayments 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/OBWriteInternational3' examples: create-int-payment-request: value: Data: ConsentId: BARCLAYS-P-12345678901234 Initiation: InstructionIdentification: string EndToEndIdentification: string LocalInstrument: UK.OBIE.SWIFT InstructionPriority: Normal ChargeBearer: BorneByCreditor CurrencyOfTransfer: USD InstructedAmount: Amount: '21.21' Currency: GBP ExchangeRateInformation: UnitCurrency: GBP ExchangeRate: 0 RateType: Actual ContractIdentification: string DebtorAccount: SchemeName: UK.OBIE.BBAN Identification: '12345678901234' Name: string SecondaryIdentification: string Creditor: Name: string PostalAddress: AddressType: BIZZ Department: string SubDepartment: string StreetName: string BuildingNumber: '90' PostCode: string TownName: string CountrySubDivision: string Country: UK AddressLine: - string CreditorAgent: SchemeName: UK.OBIE.IBAN Identification: GB1234567890456078 Name: string PostalAddress: AddressType: BIZZ Department: string SubDepartment: string StreetName: string BuildingNumber: string PostCode: string TownName: string CountrySubDivision: string Country: UK AddressLine: - string CreditorAccount: SchemeName: UK.OBIE.IBAN Identification: GB1234567890456078 Name: string SecondaryIdentification: string RemittanceInformation: Unstructured: - string Risk: PaymentContextCode: TransferToThirdParty MerchantCategoryCode: AMAZ MerchantCustomerIdentification: string DeliveryAddress: AddressLine: - string StreetName: string BuildingNumber: '21' PostCode: string TownName: string CountrySubDivision: CountrySubDivision1 Country: UK BeneficiaryPrepopulatedIndicator: true PaymentPurposeCode: EPAY BeneficiaryAccountType: BusinessSavingsAccount required: true responses: '201': $ref: '#/components/responses/201InternationalPaymentsCreated' '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' deprecated: false /file-payment-consents: summary: Create File Payment Consents description: Create File Payment Consents post: tags: - File Payments summary: Create File Payment Consents description: 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 /international-standing-orders/{internationalStandingOrderPaymentId}: summary: Get International Standing Orders description: Get International Standing Orders get: tags: - International Standing Orders summary: Get International Standing Orders description: Get International Standing Orders operationId: GetInternationalStandingOrdersInternationalStandingOrderPaymentId parameters: - $ref: '#/components/parameters/InternationalStandingOrderPaymentId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '500': $ref: '#/components/responses/500Error' '405': $ref: '#/components/responses/405Error' deprecated: false /international-standing-order-consents/{consentId}: summary: Get International Standing Order Consents description: Get International Standing Order Consents get: tags: - International Standing Orders summary: Get International Standing Order Consents description: Get International Standing Order Consents operationId: GetInternationalStandingOrderConsentsConsentId parameters: - $ref: '#/components/parameters/ConsentId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '500': $ref: '#/components/responses/500Error' '405': $ref: '#/components/responses/405Error' deprecated: false /file-payments/{filePaymentId}/payment-details: summary: Get Payment Details description: Get Payment Details get: tags: - Payment Details summary: Get Payment Details description: Get Payment Details operationId: GetFilePaymentsFilePaymentIdPaymentDetails 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: '500': $ref: '#/components/responses/500Error' '405': $ref: '#/components/responses/405Error' deprecated: false /international-standing-order-consents: summary: Create International Standing Order Consents description: Create International Standing Order Consents post: tags: - International Standing Orders summary: Create International Standing Order Consents description: Create International Standing Order Consents operationId: CreateInternationalStandingOrderConsents parameters: - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-idempotency-key' - $ref: '#/components/parameters/x-jws-signature' - $ref: '#/components/parameters/x-customer-user-agent' requestBody: description: Default content: application/json: schema: $ref: '#/components/schemas/OBWriteInternationalStandingOrderConsent6' examples: create-int-stand-order-con-request: value: Data: Permission: Create ReadRefundAccount: 'Yes' Authorisation: AuthorisationType: Any CompletionDateTime: '2025-05-30T10:35:27Z' Initiation: ChargeBearer: Shared CurrencyOfTransfer: USD DestinationCountryCode: GB Creditor: Name: ACME Inc LEI: 8200007YHFDMEODY1965 PostalAddress: AddressType: BIZZ StreetName: Bank Street BuildingNumber: '11' Floor: '6' PostCode: Z78 4TY TownName: London Country: UK CreditorAccount: SchemeName: UK.OBIE.IBAN Identification: DE89370400440532013000 SecondaryIdentification: '0002' Name: Tom Kirkman Proxy: Identification: 07700900000 Code: TELE Type: Telephone DebtorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '11280001234567' Name: Andrea Frost InstructedAmount: Amount: '20' Currency: EUR MandateRelatedInformation: MandateIdentification: Golfers Classification: FIXE CategoryPurposeCode: BONU FirstPaymentDateTime: '2024-04-25T12:46:49.425Z' RecurringPaymentDateTime: '2024-04-25T12:46:49.425Z' FinalPaymentDateTime: '2024-04-25T12:46:49.425Z' Reason: Membership fees Frequency: Type: MNTH CountPerPeriod: 1 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 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: UK 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: - 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 Risk: PaymentContextCode: TransferToThirdParty PaymentPurposeCode: EPAY CategoryPurposeCode: CASH BeneficiaryAccountType: Business MerchantCategoryCode: '7300' MerchantCustomerIdentification: 053598653254 DeliveryAddress: AddressLine: - Flat 7 - Acacia Lodge StreetName: Acacia Avenue BuildingNumber: '27' PostCode: GU31 2ZZ TownName: Sparsholt CountrySubDivision: Wessex Country: UK required: true responses: '422': $ref: '#/components/responses/422Error' '500': $ref: '#/components/responses/500Error' '405': $ref: '#/components/responses/405Error' deprecated: false /domestic-payments/{domesticPaymentId}: summary: Get Domestic Payments description: Get Domestic Payments get: tags: - Domestic Payments summary: Get Domestic Payments description: Get Domestic Payments operationId: GetDomesticPaymentsDomesticPaymentId parameters: - $ref: '#/components/parameters/DomesticPaymentId' - $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/200DomesticPaymentsDomesticPaymentIdRead' '400': $ref: '#/components/responses/400Error' '401': $ref: '#/components/responses/401Error' '500': $ref: '#/components/responses/500Error' '403': $ref: '#/components/responses/403Error' '405': $ref: '#/components/responses/405Error' '406': $ref: '#/components/responses/406Error' '429': $ref: '#/components/responses/429Error' deprecated: false /international-scheduled-payments/{internationalScheduledPaymentId}/payment-details: summary: Get Payment Details description: Get Payment Details get: tags: - Payment Details summary: Get Payment Details description: Get Payment Details operationId: GetInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails parameters: - $ref: '#/components/parameters/InternationalScheduledPaymentId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '500': $ref: '#/components/responses/500Error' '405': $ref: '#/components/responses/405Error' deprecated: false /domestic-standing-order-consents: summary: Create Domestic Standing Order Consents description: Create Domestic Standing Order Consents post: tags: - Domestic Standing Orders summary: Create Domestic Standing Order Consents description: Create Domestic Standing Order Consents operationId: CreateDomesticStandingOrderConsents 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/OBWriteDomesticStandingOrderConsent5' examples: create-dom-stand-order-consent: value: Data: Permission: Create ReadRefundAccount: 'No' Initiation: RemittanceInformation: Structured: - ReferredDocumentInformation: - Code: CINV Issuer: Issuer01 Number: Number_01 RelatedDate: '2024-09-04T16:33:53.086Z' LineDetails: - Line Detail ReferredDocumentAmount: 1 CreditorReferenceInformation: Code: DISP Issuer: Issuer01 Reference: Pocket money for Damien Invoicer: INVR51856 Invoicee: INVE5161856 TaxRemittance: Tax Remittance related information AdditionalRemittanceInformation: - Free text for additional information Unstructured: - Internal ops code 5120101 FirstPaymentAmount: Amount: '7.00' Currency: GBP RecurringPaymentAmount: Amount: '7.00' Currency: GBP FinalPaymentAmount: Amount: '7.00' Currency: GBP DebtorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '11280001234567' Name: Andrea Smith SecondaryIdentification: '0002' Proxy: Identification: 07700900000 Code: TELE Type: Telephone CreditorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: Bob Clements SecondaryIdentification: '0002' Proxy: Identification: 07700900999 Code: TELE Type: Telephone UltimateCreditor: SchemeName: UK.OBIE.BBAN Identification: '2360549017905161589' Name: Ultimate Creditor LEI: 60450004FECVJV7YN339 PostalAddress: AddressType: BIZZ StreetName: Bank Street BuildingNumber: '11' Floor: '6' PostCode: Z78 4TY TownName: London Country: UK 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 RegulatoryReporting: - DebitCreditReportingIndicator: CRED Authority: Name: Authority Name CountryCode: GB Details: - Type: CRED Date: '2024-04-25T13:26:41.911Z' Country: GB Amount: Amount: '7.00' Currency: GBP Information: - Reg info1 - Reg info2 MandateRelatedInformation: MandateIdentification: SO003538282 Classification: FIXE CategoryPurposeCode: CASH FirstPaymentDateTime: '2024-09-04T16:33:53.087Z' FinalPaymentDateTime: '2025-09-04T16:33:53.087Z' Frequency: Type: DAIL CountPerPeriod: 1 Reason: Pocket Money Risk: PaymentContextCode: TransferToThirdParty required: true responses: '201': $ref: '#/components/responses/201DomesticStandingOrderConsentsCreated' '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 /domestic-standing-orders/{domesticStandingOrderId}: summary: Get Domestic Standing Orders description: Get Domestic Standing Orders get: tags: - Domestic Standing Orders summary: Get Domestic Standing Orders description: Get Domestic Standing Orders operationId: GetDomesticStandingOrdersDomesticStandingOrderId parameters: - $ref: '#/components/parameters/DomesticStandingOrderId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '200': $ref: '#/components/responses/200DomesticStandingOrdersDomesticStandingOrderIdRead' '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 /international-payments/{internationalPaymentId}: summary: Get International Payments description: Get International Payments get: tags: - International Payments summary: Get International Payments description: Get International Payments operationId: GetInternationalPaymentsInternationalPaymentId parameters: - $ref: '#/components/parameters/InternationalPaymentId' - $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/200InternationalPaymentsInternationalPaymentIdRead' '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 /domestic-scheduled-payments: summary: Create Domestic Scheduled Payments description: Create Domestic Scheduled Payments post: tags: - Domestic Scheduled Payments summary: Create Domestic Scheduled Payments description: Create Domestic Scheduled Payments operationId: CreateDomesticScheduledPayments 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/OBWriteDomesticScheduled2' examples: create-dom-sched-pay-request: value: Data: ConsentId: BARCLAYS-P-12345678901234 Initiation: InstructionIdentification: 89f0a53a91ee47f6a383536f851d6b5a RequestedExecutionDateTime: '2018-08-06T00:00:00+00:00' InstructedAmount: Amount: '200.00' Currency: GBP DebtorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '11280001234567' SecondaryIdentification: 080801562314789 Name: Andrea Frost Proxy: Identification: '441234012345' Code: TELE Type: Telephone CreditorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: Tom Kirkman SecondaryIdentification: '0002' Proxy: Identification: '+441632960540' 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 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 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 Risk: PaymentContextCode: TransferToThirdParty ContractPresentIndicator: false PaymentPurposeCode: EPAY CategoryPurposeCode: CASH BeneficiaryAccountType: Business MerchantCategoryCode: '7300' MerchantCustomerIdentification: 053598653254 DeliveryAddress: AddressLine: - Flat 7 - Acacia Lodge StreetName: Acacia Avenue BuildingNumber: '27' PostCode: GU31 2ZZ TownName: Sparsholt CountrySubDivision: Wessex Country: GB required: true responses: '201': $ref: '#/components/responses/201DomesticScheduledPaymentsCreated' '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 /international-payment-consents: summary: Create International Payment Consents description: Create International Payment Consents post: tags: - International Payments summary: Create International Payment Consents description: Create International Payment Consents operationId: CreateInternationalPaymentConsents 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/OBWriteInternationalConsent5' examples: create-int-pay-consent-request: value: Data: ReadRefundAccount: 'Yes' Authorisation: AuthorisationType: Any CompletionDateTime: '2025-05-30T10:35:27Z' Initiation: InstructionIdentification: ACME412 EndToEndIdentification: FRESCO.21302.GFX.20 LocalInstrument: UK.OBIE.Paym InstructionPriority: Normal CurrencyOfTransfer: USD DestinationCountryCode: GB InstructedAmount: Amount: '165.88' Currency: GBP ExchangeRateInformation: UnitCurrency: GBP ExchangeRate: 1.22 RateType: Actual ContractIdentification: 0591968098186 DebtorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber SecondaryIdentification: '0002' Identification: '11280001234567' Name: Andrea Smith Proxy: Identification: 07700900000 Code: TELE Type: Telephone CreditorAgent: LEI: 1311005BLKBSWLCX4E37 SchemeName: UK.OBIE.IBAN Name: ACED Inc Identification: 08080021325698 PostalAddress: 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: UK Creditor: Name: Mr Joe Creditor LEI: 8200007YHFDMEODY1965 PostalAddress: AddressType: BIZZ StreetName: Bank Street BuildingNumber: '11' Floor: '6' PostCode: Z78 4TY TownName: London Country: UK CreditorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: ACME Inc SecondaryIdentification: '0002' Proxy: Identification: '+441632960540' 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 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: UK 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: - 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 Risk: PaymentContextCode: TransferToThirdParty ContractPresentIndicator: false PaymentPurposeCode: EPAY CategoryPurposeCode: CASH BeneficiaryAccountType: Business MerchantCategoryCode: '7300' MerchantCustomerIdentification: 053598653254 DeliveryAddress: AddressLine: - Flat 7 - Acacia Lodge StreetName: Acacia Avenue BuildingNumber: '27' PostCode: GU31 2ZZ TownName: Sparsholt CountrySubDivision: Wessex Country: UK required: true responses: '201': $ref: '#/components/responses/201InternationalPaymentConsentsCreated' '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 /international-standing-orders/{internationalStandingOrderPaymentId}/payment-details: summary: Get Payment Details description: Get Payment Details get: tags: - Payment Details summary: Get Payment Details description: Get Payment Details operationId: GetInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails parameters: - $ref: '#/components/parameters/InternationalStandingOrderPaymentId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '500': $ref: '#/components/responses/500Error' '405': $ref: '#/components/responses/405Error' deprecated: false /international-payment-consents/{consentId}/funds-confirmation: summary: Get International Payment Consents Funds Confirmation description: Get International Payment Consents Funds Confirmation get: tags: - International Payments summary: Get International Payment Consents Funds Confirmation description: Get International Payment Consents Funds Confirmation operationId: GetInternationalPaymentConsentsConsentIdFundsConfirmation 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/200InternationalPaymentConsentsConsentIdFundsConfirmationRead' '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 /domestic-scheduled-payments/{domesticScheduledPaymentId}: summary: Get Domestic Scheduled Payments description: Get Domestic Scheduled Payments get: tags: - Domestic Scheduled Payments summary: Get Domestic Scheduled Payments description: Get Domestic Scheduled Payments operationId: GetDomesticScheduledPaymentsDomesticScheduledPaymentId parameters: - $ref: '#/components/parameters/DomesticScheduledPaymentId' - $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/200DomesticScheduledPaymentsDomesticScheduledPaymentIdRead' '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 /domestic-standing-orders/{domesticStandingOrderId}/payment-details: summary: Get Payment Details description: Get Payment Details get: tags: - Payment Details summary: Get Payment Details description: Get Payment Details operationId: GetDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails parameters: - $ref: '#/components/parameters/DomesticStandingOrderId' - $ref: '#/components/parameters/x-fapi-auth-date' - $ref: '#/components/parameters/x-fapi-customer-ip-address' - $ref: '#/components/parameters/x-fapi-interaction-id' - $ref: '#/components/parameters/Authorization' - $ref: '#/components/parameters/x-customer-user-agent' responses: '500': $ref: '#/components/responses/500Error' '405': $ref: '#/components/responses/405Error' deprecated: false /file-payments: summary: Create File Payments description: Create File Payments post: tags: - File Payments summary: Create File Payments description: 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: 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 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 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})$ 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}$ OBPaymentStatusReason: type: object additionalProperties: false deprecated: false properties: StatusReasonCode: type: string description: "Specifies the status reason in a code form \n For more information and enum values see `OBExternalStatusReason1Code\ \ [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)" example: ERIN maxLength: 4 minLength: 1 StatusReasonDescription: type: string description: Description supporting the StatusReasonCode. 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 nullable: false 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})$ OBWriteDomesticStandingOrderResponse6: type: object additionalProperties: false deprecated: false properties: Data: type: object additionalProperties: false properties: DomesticStandingOrderId: type: string description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic standing order 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 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: $ref: '#/components/schemas/ExternalPaymentTransactionStatus1Code' 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 Refund: $ref: '#/components/schemas/OBDomesticRefundAccount1' Charges: type: array items: type: object additionalProperties: false description: Set of elements used to provide details of a charge for the payment initiation. 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 from the debtor account to a creditor for a domestic standing order. properties: RemittanceInformation: $ref: '#/components/schemas/OBRemittanceInformation2' NumberOfPayments: $ref: '#/components/schemas/NumberOfPayments' FirstPaymentAmount: type: object additionalProperties: false description: The amount of the first Standing Order properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' required: - Amount - Currency RecurringPaymentAmount: type: object additionalProperties: false description: The amount of the recurring Standing Order properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' required: - Amount - Currency FinalPaymentAmount: type: object additionalProperties: false description: The amount of the final Standing Order properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' required: - Amount - Currency DebtorAccount: type: object additionalProperties: false description: Provides the details to identify the debtor account. 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 CreditorAccount: type: object additionalProperties: false description: Identification assigned by an institution to identify an account. This identification is known by the account owner. 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 UltimateCreditor: $ref: '#/components/schemas/OBUltimateCreditor1' UltimateDebtor: $ref: '#/components/schemas/OBUltimateDebtor1' RegulatoryReporting: type: array items: $ref: '#/components/schemas/OBRegulatoryReporting1' maxItems: 3 minItems: 0 MandateRelatedInformation: $ref: '#/components/schemas/OBMandateRelatedInformation1' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' required: - CreditorAccount - FirstPaymentAmount - MandateRelatedInformation 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 - DomesticStandingOrderId - Initiation - Status - StatusUpdateDateTime Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data 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. \n\ Usage: 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 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. \n\ Usage: 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 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}$ 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}$ NumberOfPayments: type: string description: Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date. maxLength: 35 minLength: 1 pattern: ^\d{1,4}$ ExternalPaymentTransactionStatus3Code: type: string description: 'Specifies the status of the payment information group. For a full list of values refer to `ExternalPaymentTransactionStatus3Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) ' enum: - RCVD - PDNG - ACTC - PATC - ACCP - ACFC - ACSP - ACWC - ACSC - BLCK - ACCC - ACWP - RJCT OBInternalConsentStatus2Code: type: string description: Specifies the status of consent resource in code form. For a full list of values refer to `OBInternalConsentStatus2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - AWAU - RJCT - AUTH - COND PointInTime: type: string description: 'Exact2NumericText - Further information on the exact point in time the event should take place. Specifies a frequency in terms of an exact point in time or moment within a specified frequency type. Note: should not be used alongside `CountPerPeriod`' example: '00' maxLength: 2 minLength: 2 pattern: ^(0[1-9]|[12][0-9]|3[01]|-[1-4])$ 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 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 OBAddressTypeCode: type: string description: Identifies the nature of the postal address. enum: - Business - Correspondence - DeliveryTo - MailTo - POBox - Postal - Residential - Statement example: Business OBBranchAndFinancialInstitutionIdentification6_0: type: object additionalProperties: false deprecated: false description: 'Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.' properties: SchemeName: $ref: '#/components/schemas/OBInternalFinancialInstitutionIdentification4Code' Identification: $ref: '#/components/schemas/Identification_1' Name: $ref: '#/components/schemas/Name' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' LEI: $ref: '#/components/schemas/LEI' nullable: false OBCashAccountCreditor3: type: object additionalProperties: false deprecated: false properties: SchemeName: $ref: '#/components/schemas/OBInternalAccountIdentification4Code' Identification: type: string description: Identification assigned by an institution to identify an account. This identification is known by the account owner. 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: 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). example: '1234567890' maxLength: 34 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-. '()£="_,&@#\/;+]{1,34})$ LEI: $ref: '#/components/schemas/LEI' Proxy: $ref: '#/components/schemas/OBProxy1' required: - Identification - Name - SchemeName nullable: false 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}$ 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}$ 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}$ OBMandateRelatedInformation1: type: object additionalProperties: false deprecated: false properties: MandateIdentification: $ref: '#/components/schemas/Identification_1' Classification: $ref: '#/components/schemas/OBExternalMandateClassification1Code' CategoryPurposeCode: $ref: '#/components/schemas/ExternalCategoryPurpose1Code' FirstPaymentDateTime: type: string format: date-time RecurringPaymentDateTime: type: string format: date-time description: "The date on which the first recurring payment for a Standing Order schedule will be made. \nUsage:\ \ This must be populated only if the first recurring date is different to the first payment date. 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' FinalPaymentDateTime: type: string format: date-time Frequency: $ref: '#/components/schemas/OBFrequency6' Reason: type: string description: Reason for the direct debit mandate to allow the user to distinguish between different mandates for the same creditor. example: reason maxLength: 256 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_-]{1,256})$ required: - Frequency 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})$ 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}$ OBWriteDomesticScheduledConsentResponse5: type: object additionalProperties: false deprecated: false properties: Data: type: object additionalProperties: false deprecated: 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: $ref: '#/components/schemas/OBInternalConsentStatus2Code' 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" StatusReason: type: array items: $ref: '#/components/schemas/OBStatusReason' maxItems: 99999 minItems: 0 Permission: type: string description: Specifies the Open Banking service request types. For a full list of values see `OBInternalPermissions2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - Create ReadRefundAccount: type: string description: Specifies to share the refund account details with PISP. For a full list of values see `OBInternalReadRefundAccount1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - 'No' - 'Yes' 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" ExpectedExecutionDateTime: type: string format: date-time description: "Expected execution date and time for the payment resource. All dates in the JSON payloads are\ \ represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone.\ \ An example is below:\n2017-04-05T10:43:07+00:00" ExpectedSettlementDateTime: type: string format: date-time description: "Expected settlement date and time for the payment resource. All dates in the JSON payloads are\ \ represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone.\ \ An example is below:\n2017-04-05T10:43:07+00:00" Charges: type: array items: type: object additionalProperties: false deprecated: 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 nullable: false maxItems: 99999 minItems: 0 Initiation: type: object additionalProperties: false deprecated: false description: The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment. 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' RequestedExecutionDateTime: type: string format: date-time description: "Date at which the initiating party requests the clearing agent to process the payment. \n\ Usage: 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" 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 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' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' required: - CreditorAccount - InstructedAmount - InstructionIdentification - RequestedExecutionDateTime nullable: false Authorisation: type: object additionalProperties: false deprecated: false description: The authorisation type request from the TPP. properties: AuthorisationType: type: string description: Type of authorisation flow requested. For a full list of values refer to `OBInternalAuthorisation1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) 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 nullable: false SCASupportData: $ref: '#/components/schemas/OBSCASupportData1' Debtor: $ref: '#/components/schemas/OBCashAccountDebtor4' required: - ConsentId - CreationDateTime - Initiation - Permission - Status - StatusUpdateDateTime nullable: false Risk: $ref: '#/components/schemas/OBRisk1' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data - Risk 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}$ OBWriteDomesticResponse5: type: object additionalProperties: false deprecated: false properties: Data: type: object additionalProperties: false deprecated: false properties: DomesticPaymentId: type: string description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic 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/ExternalPaymentTransactionStatus3Code' 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 ExpectedExecutionDateTime: type: string format: date-time description: "Expected execution date and time for the payment resource. All dates in the JSON payloads are\ \ represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone.\ \ An example is below:\n2017-04-05T10:43:07+00:00" ExpectedSettlementDateTime: type: string format: date-time description: "Expected settlement date and time for the payment resource. All dates in the JSON payloads are\ \ represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone.\ \ An example is below:\n2017-04-05T10:43:07+00:00" Refund: $ref: '#/components/schemas/OBDomesticRefundAccount1' Charges: type: array items: type: object additionalProperties: false deprecated: 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 nullable: false maxItems: 99999 minItems: 0 Initiation: type: object additionalProperties: false deprecated: false description: The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment. 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' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' required: - CreditorAccount - EndToEndIdentification - InstructedAmount - InstructionIdentification nullable: false MultiAuthorisation: type: object additionalProperties: false deprecated: 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. For a full list of values refer to `OBInternalStatus2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) 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 nullable: false Debtor: $ref: '#/components/schemas/OBCashAccountDebtor4' required: - ConsentId - CreationDateTime - DomesticPaymentId - Initiation - Status - StatusUpdateDateTime nullable: false Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data nullable: false 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})$ 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 OBWriteDomesticScheduledResponse5: type: object additionalProperties: false deprecated: false properties: Data: type: object additionalProperties: false deprecated: false properties: DomesticScheduledPaymentId: type: string description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic schedule 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/ExternalPaymentTransactionStatus2Code' 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 ExpectedExecutionDateTime: type: string format: date-time description: "Expected execution date and time for the payment resource. All dates in the JSON payloads are\ \ represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone.\ \ An example is below:\n2017-04-05T10:43:07+00:00" ExpectedSettlementDateTime: type: string format: date-time description: "Expected settlement date and time for the payment resource. All dates in the JSON payloads are\ \ represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone.\ \ An example is below:\n2017-04-05T10:43:07+00:00" Refund: $ref: '#/components/schemas/OBDomesticRefundAccount1' Charges: type: array items: type: object additionalProperties: false deprecated: 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 nullable: false maxItems: 99999 minItems: 0 Initiation: type: object additionalProperties: false deprecated: false description: The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment. 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' RequestedExecutionDateTime: type: string format: date-time description: "Date at which the initiating party requests the clearing agent to process the payment. \n\ Usage: 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" 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 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' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' required: - CreditorAccount - InstructedAmount - InstructionIdentification - RequestedExecutionDateTime nullable: false MultiAuthorisation: type: object additionalProperties: false deprecated: 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 nullable: false Debtor: $ref: '#/components/schemas/OBCashAccountDebtor4' required: - ConsentId - CreationDateTime - DomesticScheduledPaymentId - Initiation - Status - StatusUpdateDateTime nullable: false Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data nullable: false OBWriteInternationalScheduledConsent5: type: object additionalProperties: false deprecated: false properties: Data: type: object additionalProperties: false properties: Permission: type: string description: Specifies the Open Banking service request types. enum: - Create ReadRefundAccount: type: string description: Specifies to share the refund account details with PISP enum: - 'No' - 'Yes' 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 from the debtor account to a creditor for a single scheduled international payment. 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' InstructionPriority: type: string description: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. enum: - Normal - Urgent ExtendedPurpose: type: string description: Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes. example: string maxLength: 140 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,140})$ ChargeBearer: $ref: '#/components/schemas/OBInternalChargeBearerType1Code' RequestedExecutionDateTime: type: string format: date-time description: "Date at which the initiating party requests the clearing agent to process the payment. \n\ Usage: 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" CurrencyOfTransfer: type: string description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. example: GBP maxLength: 3 minLength: 3 pattern: ^[A-Z]{3,3}$ DestinationCountryCode: type: string description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). example: GB maxLength: 2 minLength: 2 pattern: ^[A-Z]{2,2}$ InstructedAmount: type: object additionalProperties: 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 ExchangeRateInformation: type: object additionalProperties: false description: Provides details on the currency exchange rate and contract. properties: UnitCurrency: type: string description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. example: GBP maxLength: 3 minLength: 3 pattern: ^[A-Z]{3,3}$ ExchangeRate: type: number description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. example: 0 maximum: 99999999 minimum: 0 RateType: type: string description: Specifies the type used to complete the currency exchange. enum: - Actual - Agreed - Indicative ContractIdentification: type: string description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. example: Contract Info maxLength: 256 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_-]{1,256})$ required: - RateType - UnitCurrency 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 Creditor: type: object additionalProperties: false description: 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: Name maxLength: 140 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-. '()£="_,&@#\/;+]{1,140})$ LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' CreditorAgent: type: object additionalProperties: false description: Financial institution servicing an account for the creditor. properties: SchemeName: $ref: '#/components/schemas/OBInternalFinancialInstitutionIdentification4Code' Identification: $ref: '#/components/schemas/Identification_1' LEI: $ref: '#/components/schemas/LEI' Name: $ref: '#/components/schemas/Name' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' CreditorAccount: type: object additionalProperties: false 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 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' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' required: - CreditorAccount - CurrencyOfTransfer - InstructedAmount - InstructionIdentification - RequestedExecutionDateTime 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 - Permission Risk: $ref: '#/components/schemas/OBRisk1' required: - Data - Risk nullable: false OBWriteInternationalConsentResponse6: 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: $ref: '#/components/schemas/OBInternalConsentStatus2Code' 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 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" ReadRefundAccount: type: string description: Specifies to share the refund account details with PISP enum: - 'No' - 'Yes' 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" ExpectedExecutionDateTime: type: string format: date-time description: "Expected execution date and time for the payment resource. All dates in the JSON payloads are\ \ represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone.\ \ An example is below:\n2017-04-05T10:43:07+00:00" ExpectedSettlementDateTime: type: string format: date-time description: "Expected settlement date and time for the payment resource. All dates in the JSON payloads are\ \ represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone.\ \ An example is below:\n2017-04-05T10:43:07+00:00" 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 ExchangeRateInformation: type: object additionalProperties: false description: Further detailed information on the exchange rate that has been used in the payment transaction. properties: UnitCurrency: type: string description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. example: GBP maxLength: 3 minLength: 3 pattern: ^[A-Z]{3,3}$ ExchangeRate: type: number description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. example: 0 maximum: 99999999 minimum: 0 RateType: type: string description: Specifies the type used to complete the currency exchange. enum: - Actual - Agreed - Indicative ContractIdentification: type: string description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. example: Contract Info maxLength: 256 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_-]{1,256})$ ExpirationDateTime: type: string format: date-time description: "Specified date and time the exchange rate agreement will expire. All dates in the JSON payloads\ \ are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone.\ \ An example is below:\n2017-04-05T10:43:07+00:00" required: - ExchangeRate - RateType - UnitCurrency 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 from the debtor account to a creditor for a single international payment. 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' InstructionPriority: type: string description: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. enum: - Normal - Urgent ExtendedPurpose: type: string description: Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes. example: string maxLength: 140 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,140})$ ChargeBearer: $ref: '#/components/schemas/OBInternalChargeBearerType1Code' CurrencyOfTransfer: type: string description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. example: GBP maxLength: 3 minLength: 3 pattern: ^[A-Z]{3,3}$ DestinationCountryCode: type: string description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). example: GB maxLength: 2 minLength: 2 pattern: ^[A-Z]{2,2}$ InstructedAmount: type: object additionalProperties: 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 ExchangeRateInformation: type: object additionalProperties: false description: Provides details on the currency exchange rate and contract. properties: UnitCurrency: type: string description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. example: GBP maxLength: 3 minLength: 3 pattern: ^[A-Z]{3,3}$ ExchangeRate: type: number description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. example: 0 maximum: 99999999 minimum: 0 RateType: type: string description: Specifies the type used to complete the currency exchange. enum: - Actual - Agreed - Indicative ContractIdentification: type: string description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. example: Contract Info maxLength: 256 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_-]{1,256})$ required: - RateType - UnitCurrency 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 Creditor: type: object additionalProperties: false description: 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: Name maxLength: 140 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-. '()£="_,&@#\/;+]{1,140})$ LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' CreditorAgent: type: object additionalProperties: false description: Financial institution servicing an account for the creditor. properties: SchemeName: $ref: '#/components/schemas/OBInternalFinancialInstitutionIdentification4Code' Identification: $ref: '#/components/schemas/Identification_1' Name: $ref: '#/components/schemas/Name' LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' CreditorAccount: type: object additionalProperties: 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 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' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' required: - CreditorAccount - CurrencyOfTransfer - EndToEndIdentification - InstructedAmount - InstructionIdentification 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 Risk: $ref: '#/components/schemas/OBRisk1' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data - Risk nullable: false OBRisk1: type: object additionalProperties: false deprecated: false description: 'The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.' properties: PaymentContextCode: type: string description: 'Specifies the payment context, `OBInternalPaymentContext1Code` The following values are deprecated and **must not** be used in a new consent or payment. They may optionally be returned for a hstorical payment/consent migrated to v4:
* BillPayment - @deprecated * EcommerceGoods - @deprecated * EcommerceServices - @deprecated * PartyToParty - @deprecated * PispPayee - @deprecated * Other - @deprecated ' enum: - BillingGoodsAndServicesInAdvance - BillingGoodsAndServicesInArrears - EcommerceMerchantInitiatedPayment - FaceToFacePointOfSale - TransferToSelf - TransferToThirdParty - BillPayment - EcommerceGoods - EcommerceServices - PartyToParty - PispPayee - Other example: TransferToSelf MerchantCategoryCode: type: string description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. example: AMAZ maxLength: 4 minLength: 3 pattern: ^(?!\s)[a-zA-Z0-9]{3,4}$ MerchantCustomerIdentification: type: string description: The unique customer identifier of the PSU with the merchant. example: customer info maxLength: 70 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-. '()@#£="_|]{1,70})$ ContractPresentIndicator: type: boolean description: Indicates if Payee has a contractual relationship with the PISP. example: true BeneficiaryPrepopulatedIndicator: type: boolean description: Indicates if PISP has immutably prepopulated payment details in for the PSU. example: true PaymentPurposeCode: $ref: '#/components/schemas/ExternalPurpose1Code' CategoryPurposeCode: $ref: '#/components/schemas/ExternalCategoryPurpose1Code' BeneficiaryAccountType: $ref: '#/components/schemas/OBInternalExtendedAccountType1Code' DeliveryAddress: $ref: '#/components/schemas/OBPostalAddress7' nullable: false OBWriteDomesticConsent4: type: object additionalProperties: false deprecated: false properties: Data: type: object additionalProperties: false deprecated: false properties: ReadRefundAccount: type: string description: Specifies to share the refund account details with PISP. For a full set of values refer to `OBInternalReadRefundAccount1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - 'No' - 'Yes' Initiation: type: object additionalProperties: false deprecated: false description: The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment. 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' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' required: - CreditorAccount - EndToEndIdentification - InstructedAmount - InstructionIdentification nullable: false Authorisation: type: object additionalProperties: false deprecated: false description: The authorisation type request from the TPP. properties: AuthorisationType: type: string description: Type of authorisation flow requested. For a full set of values refer to `OBInternalAuthorisation1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - Any - Single - Multiple 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 nullable: false SCASupportData: $ref: '#/components/schemas/OBSCASupportData1' required: - Initiation nullable: false Risk: $ref: '#/components/schemas/OBRisk1' required: - Data - Risk nullable: false OBExternalMandateClassification1Code: type: string enum: - FIXE - USGB - VARI 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 OBWriteInternationalScheduled3: 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 from the debtor account to a creditor for a single scheduled international payment. 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' InstructionPriority: type: string description: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. enum: - Normal - Urgent ExtendedPurpose: type: string description: Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes. example: string maxLength: 140 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,140})$ ChargeBearer: $ref: '#/components/schemas/OBInternalChargeBearerType1Code' RequestedExecutionDateTime: type: string format: date-time description: "Date at which the initiating party requests the clearing agent to process the payment. \n\ Usage: 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" CurrencyOfTransfer: type: string description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. example: GBP maxLength: 3 minLength: 3 pattern: ^[A-Z]{3,3}$ DestinationCountryCode: type: string description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). example: GB maxLength: 2 minLength: 2 pattern: ^[A-Z]{2,2}$ InstructedAmount: type: object additionalProperties: 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 ExchangeRateInformation: type: object additionalProperties: false description: Provides details on the currency exchange rate and contract. properties: UnitCurrency: type: string description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. example: GBP maxLength: 3 minLength: 3 pattern: ^[A-Z]{3,3}$ ExchangeRate: type: number description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. example: 0 maximum: 99999999 minimum: 0 RateType: type: string description: Specifies the type used to complete the currency exchange. enum: - Actual - Agreed - Indicative ContractIdentification: type: string description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. example: Contract Info maxLength: 256 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_-]{1,256})$ required: - RateType - UnitCurrency 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 Creditor: type: object additionalProperties: false description: 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: Name maxLength: 140 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-. '()£="_,&@#\/;+]{1,140})$ LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' CreditorAgent: type: object additionalProperties: false description: Financial institution servicing an account for the creditor. properties: SchemeName: $ref: '#/components/schemas/OBInternalFinancialInstitutionIdentification4Code' Identification: $ref: '#/components/schemas/Identification_1' LEI: $ref: '#/components/schemas/LEI' Name: $ref: '#/components/schemas/Name' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' CreditorAccount: type: object additionalProperties: false 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 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' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' required: - CreditorAccount - CurrencyOfTransfer - InstructedAmount - InstructionIdentification - RequestedExecutionDateTime required: - ConsentId - Initiation Risk: $ref: '#/components/schemas/OBRisk1' required: - Data - Risk 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 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}$ 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 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})$ ExternalPaymentTransactionStatus1Code: type: string description: "The current status of the payment resource.\n\nFor a full list of values see `ExternalPaymentTransactionStatus1Code`\ \ in *OB_Internal_CodeSet* \n[here](https://github.com/OpenBankingUK/External_Internal_CodeSets)\n" enum: - CANC - RCVD - ACTC - PATC - PDNG - RJCT - INFA - INCO - ACCP - ACFC - ACSP - ACWC - ACSC - BLCK - ACCC - ACWP 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})$ OBWriteInternationalResponse5: type: object additionalProperties: false deprecated: false properties: Data: type: object additionalProperties: false properties: InternationalPaymentId: type: string description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the international 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/ExternalPaymentTransactionStatus3Code' 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 ExpectedExecutionDateTime: type: string format: date-time description: "Expected execution date and time for the payment resource. All dates in the JSON payloads are\ \ represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone.\ \ An example is below:\n2017-04-05T10:43:07+00:00" ExpectedSettlementDateTime: type: string format: date-time description: "Expected settlement date and time for the payment resource. All dates in the JSON payloads are\ \ represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone.\ \ An example is below:\n2017-04-05T10:43:07+00:00" Refund: $ref: '#/components/schemas/OBDomesticRefundAccount1' Charges: type: array items: type: object additionalProperties: false description: Set of elements used to provide details of a charge for the payment initiation. properties: ChargeBearer: $ref: '#/components/schemas/OBInternalChargeBearerType1Code' Type: $ref: '#/components/schemas/OBInternalPaymentChargeType1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount' required: - Amount - ChargeBearer - Type maxItems: 99999 minItems: 0 ExchangeRateInformation: type: object additionalProperties: false description: Further detailed information on the exchange rate that has been used in the payment transaction. properties: UnitCurrency: type: string description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. example: GBP maxLength: 3 minLength: 3 pattern: ^[A-Z]{3,3}$ ExchangeRate: type: number description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. example: 0 maximum: 99999999 minimum: 0 RateType: type: string description: Specifies the type used to complete the currency exchange. enum: - Actual - Agreed - Indicative ContractIdentification: type: string description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. example: Contract Info maxLength: 256 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_-]{1,256})$ ExpirationDateTime: type: string format: date-time description: "Specified date and time the exchange rate agreement will expire. All dates in the JSON payloads\ \ are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone.\ \ An example is below:\n2017-04-05T10:43:07+00:00" required: - ExchangeRate - RateType - UnitCurrency 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 from the debtor account to a creditor for a single international payment. 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' InstructionPriority: type: string description: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. enum: - Normal - Urgent ExtendedPurpose: type: string description: Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes. example: string maxLength: 140 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,140})$ ChargeBearer: $ref: '#/components/schemas/OBInternalChargeBearerType1Code' CurrencyOfTransfer: type: string description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. example: GBP maxLength: 3 minLength: 3 pattern: ^[A-Z]{3,3}$ DestinationCountryCode: type: string description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). example: GB maxLength: 2 minLength: 2 pattern: ^[A-Z]{2,2}$ InstructedAmount: type: object additionalProperties: 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 ExchangeRateInformation: type: object additionalProperties: false description: Provides details on the currency exchange rate and contract. properties: UnitCurrency: type: string description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. example: GBP maxLength: 3 minLength: 3 pattern: ^[A-Z]{3,3}$ ExchangeRate: type: number description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. example: 0 maximum: 99999999 minimum: 0 RateType: type: string description: Specifies the type used to complete the currency exchange. enum: - Actual - Agreed - Indicative ContractIdentification: type: string description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. example: Contract Info maxLength: 256 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_-]{1,256})$ required: - RateType - UnitCurrency 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 Creditor: type: object additionalProperties: false description: 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: Name maxLength: 140 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-. '()£="_,&@#\/;+]{1,140})$ LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' CreditorAgent: type: object additionalProperties: false description: Financial institution servicing an account for the creditor. properties: SchemeName: $ref: '#/components/schemas/OBInternalFinancialInstitutionIdentification4Code' Identification: $ref: '#/components/schemas/Identification_1' Name: $ref: '#/components/schemas/Name' LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' CreditorAccount: type: object additionalProperties: 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 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' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' required: - CreditorAccount - CurrencyOfTransfer - EndToEndIdentification - InstructedAmount - InstructionIdentification 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 - Initiation - InternationalPaymentId - Status - StatusUpdateDateTime Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data nullable: false OBWriteDomesticStandingOrderConsentResponse6: type: object additionalProperties: false deprecated: false properties: Data: type: object additionalProperties: false deprecated: 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: $ref: '#/components/schemas/OBInternalConsentStatus2Code' 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 Permission: type: string description: Specifies the Open Banking service request types. For a full list of values see `OBInternalPermissions2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - Create ReadRefundAccount: type: string description: Specifies to share the refund account details with PISP. For a full list of values see `OBInternalReadRefundAccount1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - 'No' - 'Yes' 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 deprecated: 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 nullable: false maxItems: 99999 minItems: 0 Initiation: type: object additionalProperties: false deprecated: false description: The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a domestic standing order. properties: RemittanceInformation: $ref: '#/components/schemas/OBRemittanceInformation2' NumberOfPayments: $ref: '#/components/schemas/NumberOfPayments' FirstPaymentAmount: type: object additionalProperties: false deprecated: false description: The amount of the first Standing Order properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' required: - Amount - Currency nullable: false RecurringPaymentAmount: type: object additionalProperties: false deprecated: false description: The amount of the recurring Standing Order properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' required: - Amount - Currency nullable: false FinalPaymentAmount: type: object additionalProperties: false deprecated: false description: The amount of the final Standing Order 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 CreditorAccount: type: object additionalProperties: false deprecated: false description: Identification assigned by an institution to identify an account. This identification is known by the account owner. 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 UltimateCreditor: $ref: '#/components/schemas/OBUltimateCreditor1' UltimateDebtor: $ref: '#/components/schemas/OBUltimateDebtor1' RegulatoryReporting: type: array items: $ref: '#/components/schemas/OBRegulatoryReporting1' maxItems: 3 minItems: 0 MandateRelatedInformation: $ref: '#/components/schemas/OBMandateRelatedInformation1' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' required: - CreditorAccount - FirstPaymentAmount - MandateRelatedInformation nullable: false Authorisation: type: object additionalProperties: false deprecated: 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 nullable: false SCASupportData: $ref: '#/components/schemas/OBSCASupportData1' Debtor: $ref: '#/components/schemas/OBCashAccountDebtor4' required: - ConsentId - CreationDateTime - Initiation - Permission - Status - StatusUpdateDateTime nullable: false Risk: $ref: '#/components/schemas/OBRisk1' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data - Risk nullable: false OBInternalExtendedAccountType1Code: type: string description: Specifies the extended type of account. enum: - Business - BusinessSavingsAccount - Charity - Collection - Corporate - Ewallet - Government - Investment - ISA - JointPersonal - Pension - Personal - PersonalSavingsAccount - Premier - Wealth example: ISA 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})$ 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. \n\ Usage: 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 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' 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. \n\ Usage: 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 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})$ ExternalCategoryPurpose1Code: type: string description: "Enumeration of codes that outlines the type of purpose behind a transaction, payment or risk. \n For all\ \ enum values see `ExternalCategoryPurpose1Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets)" enum: - BONU - CASH - CBLK - CCRD - CGWV - CIPC - CONC - CORT - DCRD - DIVI - DVPM - EPAY - FCDT - FCIN - FCOL - GOVT - GP2P - HEDG - ICCP - IDCP - INTC - INTE - LBOX - LOAN - MP2B - MP2P - OTHR - PENS - RPRE - RRCT - RVPM - SALA - SECU - SSBE - SUPP - SWEP - TAXS - TOPG - TRAD - TREA - VATX - VOST - WHLD - ZABA example: BONU 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 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 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. \n\ Usage: 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 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 ExternalPaymentTransactionStatus2Code: type: string description: "Specifies the status of the payment order resource. \n\nFor a full list of values see `ExternalPaymentTransactionStatus2Code`\ \ in *OB_Internal_CodeSet* \n[here](https://github.com/OpenBankingUK/External_Internal_CodeSets)\n" enum: - CANC - RCVD - PDNG - ACTC - PATC - ACCP - ACFC - ACSP - ACWC - ACSC - BLCK - ACCC - ACWP - RJCT OBWriteDomesticScheduled2: type: object additionalProperties: false deprecated: false properties: Data: type: object additionalProperties: false deprecated: 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 deprecated: false description: The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment. 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' RequestedExecutionDateTime: type: string format: date-time description: "Date at which the initiating party requests the clearing agent to process the payment. \n\ Usage: 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" 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 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 RegulatoryReporting: type: array items: $ref: '#/components/schemas/OBRegulatoryReporting1' maxItems: 3 minItems: 0 CreditorPostalAddress: $ref: '#/components/schemas/OBPostalAddress7' UltimateCreditor: $ref: '#/components/schemas/OBUltimateCreditor1' UltimateDebtor: $ref: '#/components/schemas/OBUltimateDebtor1' RemittanceInformation: $ref: '#/components/schemas/OBRemittanceInformation2' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' required: - CreditorAccount - InstructedAmount - InstructionIdentification - RequestedExecutionDateTime nullable: false required: - ConsentId - Initiation nullable: false Risk: $ref: '#/components/schemas/OBRisk1' required: - Data - Risk 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})$ 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 OBDomesticRefundAccount1: type: object additionalProperties: false description: Unambiguous identification of the refund account to which a refund will be made as a result of the transaction. properties: Account: type: object additionalProperties: false description: Provides the details to identify an account. properties: SchemeName: $ref: '#/components/schemas/OBInternalAccountIdentification4Code' Identification: $ref: '#/components/schemas/Identification_0' 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. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory.' maxLength: 350 minLength: 1 SecondaryIdentification: $ref: '#/components/schemas/SecondaryIdentification' required: - Identification - Name - SchemeName required: - Account OBWriteDomesticStandingOrderConsent5: type: object additionalProperties: false deprecated: false properties: Data: type: object additionalProperties: false deprecated: false properties: Permission: type: string description: Specifies the Open Banking service request types. For a full list of values see `OBInternalPermissions2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - Create ReadRefundAccount: type: string description: Specifies to share the refund account details with PISP. For a full list of values see `OBInternalReadRefundAccount1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - 'No' - 'Yes' Initiation: type: object additionalProperties: false deprecated: false description: The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a domestic standing order. properties: RemittanceInformation: $ref: '#/components/schemas/OBRemittanceInformation2' NumberOfPayments: $ref: '#/components/schemas/NumberOfPayments' FirstPaymentAmount: type: object additionalProperties: false deprecated: false description: The amount of the first Standing Order properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' required: - Amount - Currency nullable: false RecurringPaymentAmount: type: object additionalProperties: false deprecated: false description: The amount of the recurring Standing Order properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' required: - Amount - Currency nullable: false FinalPaymentAmount: type: object additionalProperties: false deprecated: false description: The amount of the final Standing Order 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: Provides the details to identify the debtor account. 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 CreditorAccount: type: object additionalProperties: false deprecated: false description: Identification assigned by an institution to identify an account. This identification is known by the account owner. 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 UltimateCreditor: $ref: '#/components/schemas/OBUltimateCreditor1' UltimateDebtor: $ref: '#/components/schemas/OBUltimateDebtor1' RegulatoryReporting: type: array items: $ref: '#/components/schemas/OBRegulatoryReporting1' maxItems: 3 minItems: 0 MandateRelatedInformation: $ref: '#/components/schemas/OBMandateRelatedInformation1' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' required: - CreditorAccount - FirstPaymentAmount - MandateRelatedInformation nullable: false Authorisation: type: object additionalProperties: false deprecated: false description: The authorisation type request from the TPP. properties: AuthorisationType: type: string description: Type of authorisation flow requested. For a full list of values refer to `OBInternalAuthorisation1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) 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 nullable: false SCASupportData: $ref: '#/components/schemas/OBSCASupportData1' required: - Initiation - Permission nullable: false Risk: $ref: '#/components/schemas/OBRisk1' required: - Data - Risk nullable: false Frequency_1: type: string description: "Individual Definitions:\nIntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the\ \ week (01 to 07)\nWkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the\ \ week (01 to 07)\nIntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day\ \ within the month (-05 to -01, 01 to 31)\nQtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED)\nENGLISH = Paid\ \ on the 25th March, 24th June, 29th September and 25th December.\nSCOTTISH = Paid on the 2nd February, 15th May,\ \ 1st August and 11th November.\nRECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December.\n\ WEEK = Event takes place once a week.\nFRTN = Event takes place every two weeks.\nFOWK = Event takes place every four\ \ weeks.\nMNTH = Event takes place every month or once a month.\nTWMH = Event takes place after every 2 months.\n\ FOMH = Event takes place after every 4 months\nMIAN = Event takes place every six months or two times a year.\nYEAR\ \ = Event takes place every year or once a year.\nQURT = Event takes place every three months or four times a year.\n\ LWMH = Event takes place on last working day of the month\nLXMH = Event takes place on last Monday, Tuesday, Wednesday,\ \ Thursday, Friday of the month\nTWYR = Event takes place every 2 years\nIndividual Patterns:\nIntrvlWkDay:IntervalInWeeks:DayInWeek\ \ (ScheduleCode + IntervalInWeeks + DayInWeek)\nWkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)\n\ IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)\nQtrDay: + either (ENGLISH,\ \ SCOTTISH or RECEIVED) ScheduleCode + QuarterDay\nWEEK = (ScheduleCode + PointInTime).\nFRTN = (ScheduleCode + PointInTime).\n\ FOWK = (ScheduleCode + PointInTime).\nMNTH = (ScheduleCode + PointInTime).\nTWMH = (ScheduleCode + PointInTime).\n\ FOMH = (ScheduleCode + PointInTime).\nMIAN = (ScheduleCode + PointInTime).\nYEAR = (ScheduleCode + PointInTime).\n\ QURT = (ScheduleCode + PointInTime). \nLWMH = (ScheduleCode).\nLXMH = (ScheduleCode + PointInTime).\nTWYR = (ScheduleCode\ \ + PointInTime).\nThe regular expression for this element combines five smaller versions for each permitted pattern.\ \ To aid legibility - the components are presented individually here:\nIntrvlWkDay:0[124]:0[1-5]\nWkInMnthDay:0[1-5]:0[1-5]\n\ IntrvlMnthDay:(0[1-46]|12|24):(-0[1-4]|0[1-9]|[12][0-9]|3[01])\nQtrDay:(ENGLISH|SCOTTISH|RECEIVED)\nWEEK combined\ \ with PointInTime from 01-05\nFRTN combined with PointInTime from 01-05\nFOWK combined with PointInTime from 01-05\n\ MNTH combined with PointInTime -1 or 31 or 01-30 or -4 or -3 or -2 or -1\nTWMH combined with PointInTime from 01-31\ \ or -4 or -3 or -2 or -1\nFOMH combined with PointInTime from 01-31 or -4 or -3 or -2 or -1\nMIAN combined with PointInTime\ \ from 01-31 or -4 or -3 or -2 or -1\nYEAR combined with PointInTime from 01-31 or -4 or -3 or -2 or -1\nQURT combined\ \ with PointInTime from 01-31 or -4 or -3 or -2 or -1 \nLWMH on its own\nLXMH combined with PointInTime from 01-05\n\ TWYR combined with PointInTime from 01-31 or -4 or -3 or -2 or -1\nFull Regular Expression:\n^(IntrvlWkDay:0[124]:0[1-5])$|^(WkInMnthDay:0[1-5]:0[1-5])$|^(IntrvlMnthDay:(0[1-46]|12|24):(-0[1-4]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$|^(WEEK)$|^(FRTN)$|^(FOWK)$|^(MNTH)$|^(TWMH)$|^(FOMH)$|^(MIAN)$|^(YEAR)$|^(QURT)$|^(LWMH)$|^(LXMH)$|^(TWYR)$" pattern: ^(IntrvlWkDay:0[124]:0[1-5])$|^(WkInMnthDay:0[1-5]:0[1-5])$|^(IntrvlMnthDay:(0[1-46]|12|24):(-0[1-4]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$|^(WEEK)$|^(FRTN)$|^(FOWK)$|^(MNTH)$|^(TWMH)$|^(FOMH)$|^(MIAN)$|^(YEAR)$|^(QURT)$|^(LWMH)$|^(LXMH)$|^(TWYR)$ 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 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}$ OBSupplementaryData1: type: object additionalProperties: true description: Additional information that can not be captured in the structured fields and/or any other specific block. OBWriteInternationalConsent5: type: object additionalProperties: false deprecated: false properties: Data: type: object additionalProperties: false properties: ReadRefundAccount: type: string description: Specifies to share the refund account details with PISP enum: - 'No' - 'Yes' 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 from the debtor account to a creditor for a single international payment. 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' InstructionPriority: type: string description: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. enum: - Normal - Urgent ExtendedPurpose: type: string description: Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes. example: string maxLength: 140 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,140})$ ChargeBearer: $ref: '#/components/schemas/OBInternalChargeBearerType1Code' CurrencyOfTransfer: type: string description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. example: GBP maxLength: 3 minLength: 3 pattern: ^[A-Z]{3,3}$ DestinationCountryCode: type: string description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). example: GB maxLength: 2 minLength: 2 pattern: ^[A-Z]{2,2}$ InstructedAmount: type: object additionalProperties: 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 ExchangeRateInformation: type: object additionalProperties: false description: Provides details on the currency exchange rate and contract. properties: UnitCurrency: type: string description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. example: GBP maxLength: 3 minLength: 3 pattern: ^[A-Z]{3,3}$ ExchangeRate: type: number description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. example: 0 maximum: 99999999 minimum: 0 RateType: type: string description: Specifies the type used to complete the currency exchange. enum: - Actual - Agreed - Indicative ContractIdentification: type: string description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. example: Contract Info maxLength: 256 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_-]{1,256})$ required: - RateType - UnitCurrency 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 Creditor: type: object additionalProperties: false description: 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: Name maxLength: 140 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-. '()£="_,&@#\/;+]{1,140})$ LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' CreditorAgent: type: object additionalProperties: false description: Financial institution servicing an account for the creditor. properties: SchemeName: $ref: '#/components/schemas/OBInternalFinancialInstitutionIdentification4Code' Identification: $ref: '#/components/schemas/Identification_1' Name: $ref: '#/components/schemas/Name' LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' CreditorAccount: type: object additionalProperties: 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 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' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' required: - CreditorAccount - CurrencyOfTransfer - EndToEndIdentification - InstructedAmount - InstructionIdentification 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 Risk: $ref: '#/components/schemas/OBRisk1' required: - Data - Risk nullable: false 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}$ 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 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 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 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 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 OBFrequency6: type: object additionalProperties: false description: Regularity with which credit transfer instructions are to be created and processed properties: Type: $ref: '#/components/schemas/Frequency_1' CountPerPeriod: type: integer format: int32 description: 'Number of instructions to be created and processed during the specified period .Specifies a frequency in terms of a count per period within a specified frequency type. Note: should not be used alongside `PointInTime`' example: 1 maximum: 99999 minimum: 0 PointInTime: $ref: '#/components/schemas/PointInTime' required: - Type File: type: object additionalProperties: false deprecated: false 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 SecondaryIdentification: type: string description: "This is secondary identification of the account, as assigned by the account servicing institution. \n\ 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)." example: Secondary Identification maxLength: 34 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-. '()£="_,&@#\/;+]{1,34})$ 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 Time: type: string format: time description: "Time at which assets become available to the account owner in case of a credit entry, or cease to be available\ \ to the account owner in case of a debit transaction entry.\nUsage: If transaction entry status is pending and value\ \ date is present, then the value date refers to an expected/requested value date.\nFor transaction entries subject\ \ to availability/float and for which availability information is provided, the value date must not be used. In this\ \ case the availability component identifies the number of availability days. 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:\n\ T10:43:07+00:00" example: T10:43:07+00:00 OBWriteInternationalScheduledResponse6: type: object additionalProperties: false deprecated: false properties: Data: type: object additionalProperties: false properties: InternationalScheduledPaymentId: type: string description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the international scheduled 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/ExternalPaymentTransactionStatus2Code' 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 ExpectedExecutionDateTime: type: string format: date-time description: "Expected execution date and time for the payment resource. All dates in the JSON payloads are\ \ represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone.\ \ An example is below:\n2017-04-05T10:43:07+00:00" ExpectedSettlementDateTime: type: string format: date-time description: "Expected settlement date and time for the payment resource. All dates in the JSON payloads are\ \ represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone.\ \ An example is below:\n2017-04-05T10:43:07+00:00" Refund: $ref: '#/components/schemas/OBDomesticRefundAccount1' Charges: type: array items: type: object additionalProperties: false description: Set of elements used to provide details of a charge for the payment initiation. properties: ChargeBearer: $ref: '#/components/schemas/OBInternalChargeBearerType1Code' Type: $ref: '#/components/schemas/OBInternalPaymentChargeType1Code' Amount: $ref: '#/components/schemas/OBActiveOrHistoricCurrencyAndAmount' required: - Amount - ChargeBearer - Type maxItems: 99999 minItems: 0 ExchangeRateInformation: type: object additionalProperties: false description: Further detailed information on the exchange rate that has been used in the payment transaction. properties: UnitCurrency: type: string description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. example: GBP maxLength: 3 minLength: 3 pattern: ^[A-Z]{3,3}$ ExchangeRate: type: number description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. example: 0 maximum: 99999999 minimum: 0 RateType: type: string description: Specifies the type used to complete the currency exchange. enum: - Actual - Agreed - Indicative ContractIdentification: type: string description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. example: Contract Info maxLength: 256 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_-]{1,256})$ ExpirationDateTime: type: string format: date-time description: "Specified date and time the exchange rate agreement will expire. All dates in the JSON payloads\ \ are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone.\ \ An example is below:\n2017-04-05T10:43:07+00:00" required: - ExchangeRate - RateType - UnitCurrency 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 from the debtor account to a creditor for a single scheduled international payment. 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' InstructionPriority: type: string description: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. enum: - Normal - Urgent ExtendedPurpose: type: string description: Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes. example: string maxLength: 140 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,140})$ ChargeBearer: $ref: '#/components/schemas/OBInternalChargeBearerType1Code' RequestedExecutionDateTime: type: string format: date-time description: "Date at which the initiating party requests the clearing agent to process the payment. \n\ Usage: 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" CurrencyOfTransfer: type: string description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. example: GBP maxLength: 3 minLength: 3 pattern: ^[A-Z]{3,3}$ DestinationCountryCode: type: string description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). example: GB maxLength: 2 minLength: 2 pattern: ^[A-Z]{2,2}$ InstructedAmount: type: object additionalProperties: 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 ExchangeRateInformation: type: object additionalProperties: false description: Provides details on the currency exchange rate and contract. properties: UnitCurrency: type: string description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. example: GBP maxLength: 3 minLength: 3 pattern: ^[A-Z]{3,3}$ ExchangeRate: type: number description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. example: 0 maximum: 99999999 minimum: 0 RateType: type: string description: Specifies the type used to complete the currency exchange. enum: - Actual - Agreed - Indicative ContractIdentification: type: string description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. example: Contract Info maxLength: 256 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_-]{1,256})$ required: - RateType - UnitCurrency 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 Creditor: type: object additionalProperties: false description: 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: Name maxLength: 140 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-. '()£="_,&@#\/;+]{1,140})$ LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' CreditorAgent: type: object additionalProperties: false description: Financial institution servicing an account for the creditor. properties: SchemeName: $ref: '#/components/schemas/OBInternalFinancialInstitutionIdentification4Code' Identification: $ref: '#/components/schemas/Identification_1' LEI: $ref: '#/components/schemas/LEI' Name: $ref: '#/components/schemas/Name' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' CreditorAccount: type: object additionalProperties: false 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 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' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' required: - CreditorAccount - CurrencyOfTransfer - InstructedAmount - InstructionIdentification - RequestedExecutionDateTime 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 - Initiation - InternationalScheduledPaymentId - Status - StatusUpdateDateTime Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data nullable: false 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 OBWriteFundsConfirmationResponse1: type: object additionalProperties: false deprecated: false properties: Data: type: object additionalProperties: false properties: FundsAvailableResult: type: object additionalProperties: false description: Result of a funds availability check. properties: FundsAvailableDateTime: type: string format: date-time description: "Date and time at which the funds availability check was generated. All dates in the JSON payloads\ \ are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone.\ \ An example is below:\n2017-04-05T10:43:07+00:00" FundsAvailable: type: boolean description: Flag to indicate the availability of funds given the Amount in the consent request. required: - FundsAvailable - FundsAvailableDateTime SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data nullable: false 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 OBWriteDomesticStandingOrder3: type: object additionalProperties: false deprecated: false properties: Data: type: object additionalProperties: false deprecated: 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 deprecated: false description: The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a domestic standing order. properties: RemittanceInformation: $ref: '#/components/schemas/OBRemittanceInformation2' NumberOfPayments: $ref: '#/components/schemas/NumberOfPayments' FirstPaymentAmount: type: object additionalProperties: false deprecated: false description: The amount of the first Standing Order properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' required: - Amount - Currency nullable: false RecurringPaymentAmount: type: object additionalProperties: false deprecated: false description: The amount of the recurring Standing Order properties: Amount: $ref: '#/components/schemas/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/components/schemas/ActiveOrHistoricCurrencyCode' required: - Amount - Currency nullable: false FinalPaymentAmount: type: object additionalProperties: false deprecated: false description: The amount of the final Standing Order 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: Provides the details to identify the debtor account. 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 CreditorAccount: type: object additionalProperties: false deprecated: false description: Identification assigned by an institution to identify an account. This identification is known by the account owner. 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 UltimateCreditor: $ref: '#/components/schemas/OBUltimateCreditor1' UltimateDebtor: $ref: '#/components/schemas/OBUltimateDebtor1' RegulatoryReporting: type: array items: $ref: '#/components/schemas/OBRegulatoryReporting1' maxItems: 3 minItems: 0 MandateRelatedInformation: $ref: '#/components/schemas/OBMandateRelatedInformation1' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' required: - CreditorAccount - FirstPaymentAmount - MandateRelatedInformation nullable: false required: - ConsentId - Initiation nullable: false Risk: $ref: '#/components/schemas/OBRisk1' required: - Data - Risk nullable: false CountryCode: type: string description: Nation with its own government. example: US maxLength: 2 minLength: 2 pattern: ^[A-Z]{2,2}$ 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 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})$ OBWriteInternationalStandingOrder4: 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 from the debtor account to a creditor for an international standing order. properties: RemittanceInformation: $ref: '#/components/schemas/OBRemittanceInformation2' NumberOfPayments: $ref: '#/components/schemas/NumberOfPayments' ExtendedPurpose: type: string description: Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes. example: string maxLength: 140 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,140})$ ChargeBearer: $ref: '#/components/schemas/OBInternalChargeBearerType1Code' CurrencyOfTransfer: type: string description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. example: GBP maxLength: 3 minLength: 3 pattern: ^[A-Z]{3,3}$ DestinationCountryCode: type: string description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). example: GB maxLength: 2 minLength: 2 pattern: ^[A-Z]{2,2}$ InstructedAmount: type: object additionalProperties: 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 DebtorAccount: type: object additionalProperties: false description: Provides the details to identify the debtor account. 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 Creditor: type: object additionalProperties: false description: 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: Name maxLength: 140 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-. '()£="_,&@#\/;+]{1,140})$ LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' CreditorAgent: type: object additionalProperties: false description: 'Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.' properties: SchemeName: $ref: '#/components/schemas/OBInternalFinancialInstitutionIdentification4Code' Identification: type: string description: Unique and unambiguous identification of the servicing institution. maxLength: 35 minLength: 1 Name: $ref: '#/components/schemas/Name' LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' CreditorAccount: type: object additionalProperties: false description: Provides the details to identify the beneficiary account. 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 UltimateCreditor: $ref: '#/components/schemas/OBUltimateCreditor1' UltimateDebtor: $ref: '#/components/schemas/OBUltimateDebtor1' RegulatoryReporting: type: array items: $ref: '#/components/schemas/OBRegulatoryReporting1' maxItems: 3 minItems: 0 MandateRelatedInformation: $ref: '#/components/schemas/OBMandateRelatedInformation1' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' required: - CreditorAccount - CurrencyOfTransfer - InstructedAmount - MandateRelatedInformation required: - ConsentId - Initiation Risk: $ref: '#/components/schemas/OBRisk1' required: - Data - Risk nullable: false OBWriteInternationalStandingOrderConsent6: type: object additionalProperties: false deprecated: false properties: Data: type: object additionalProperties: false properties: Permission: type: string description: Specifies the Open Banking service request types. enum: - Create ReadRefundAccount: type: string description: Specifies to share the refund account details with PISP enum: - 'No' - 'Yes' 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 from the debtor account to a creditor for an international standing order. properties: RemittanceInformation: $ref: '#/components/schemas/OBRemittanceInformation2' NumberOfPayments: $ref: '#/components/schemas/NumberOfPayments' ExtendedPurpose: type: string description: Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes. example: string maxLength: 140 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,140})$ ChargeBearer: $ref: '#/components/schemas/OBInternalChargeBearerType1Code' CurrencyOfTransfer: type: string description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. example: GBP maxLength: 3 minLength: 3 pattern: ^[A-Z]{3,3}$ DestinationCountryCode: type: string description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). example: GB maxLength: 2 minLength: 2 pattern: ^[A-Z]{2,2}$ InstructedAmount: type: object additionalProperties: 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 DebtorAccount: type: object additionalProperties: false description: Provides the details to identify the debtor account. 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 Creditor: type: object additionalProperties: false description: 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: Name maxLength: 140 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-. '()£="_,&@#\/;+]{1,140})$ LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' CreditorAgent: type: object additionalProperties: false description: 'Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.' properties: SchemeName: $ref: '#/components/schemas/OBInternalFinancialInstitutionIdentification4Code' Identification: type: string description: Unique and unambiguous identification of the servicing institution. example: '12345' maxLength: 35 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-. '_]{1,35})$ Name: $ref: '#/components/schemas/Name' LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' CreditorAccount: type: object additionalProperties: false description: Provides the details to identify the beneficiary account. 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 UltimateCreditor: $ref: '#/components/schemas/OBUltimateCreditor1' UltimateDebtor: $ref: '#/components/schemas/OBUltimateDebtor1' RegulatoryReporting: type: array items: $ref: '#/components/schemas/OBRegulatoryReporting1' maxItems: 3 minItems: 0 MandateRelatedInformation: $ref: '#/components/schemas/OBMandateRelatedInformation1' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' required: - CreditorAccount - CurrencyOfTransfer - InstructedAmount - MandateRelatedInformation 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 - Permission Risk: $ref: '#/components/schemas/OBRisk1' required: - Data - Risk nullable: false 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 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})$ OBWriteInternationalScheduledConsentResponse6: 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: $ref: '#/components/schemas/OBInternalConsentStatus2Code' 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 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" Permission: type: string description: Specifies the Open Banking service request types. enum: - Create ReadRefundAccount: type: string description: Specifies to share the refund account details with PISP enum: - 'No' - 'Yes' 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" ExpectedExecutionDateTime: type: string format: date-time description: "Expected execution date and time for the payment resource. All dates in the JSON payloads are\ \ represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone.\ \ An example is below:\n2017-04-05T10:43:07+00:00" ExpectedSettlementDateTime: type: string format: date-time description: "Expected settlement date and time for the payment resource. All dates in the JSON payloads are\ \ represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone.\ \ An example is below:\n2017-04-05T10:43:07+00:00" 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 ExchangeRateInformation: type: object additionalProperties: false description: Further detailed information on the exchange rate that has been used in the payment transaction. properties: UnitCurrency: type: string description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. example: GBP maxLength: 3 minLength: 3 pattern: ^[A-Z]{3,3}$ ExchangeRate: type: number description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. example: 0 maximum: 99999999 minimum: 0 RateType: type: string description: Specifies the type used to complete the currency exchange. enum: - Actual - Agreed - Indicative ContractIdentification: type: string description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. example: Contract Info maxLength: 256 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_-]{1,256})$ ExpirationDateTime: type: string format: date-time description: "Specified date and time the exchange rate agreement will expire. All dates in the JSON payloads\ \ are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone.\ \ An example is below:\n2017-04-05T10:43:07+00:00" required: - ExchangeRate - RateType - UnitCurrency 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 from the debtor account to a creditor for a single scheduled international payment. 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' InstructionPriority: type: string description: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. enum: - Normal - Urgent ExtendedPurpose: type: string description: Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes. example: string maxLength: 140 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,140})$ ChargeBearer: $ref: '#/components/schemas/OBInternalChargeBearerType1Code' RequestedExecutionDateTime: type: string format: date-time description: "Date at which the initiating party requests the clearing agent to process the payment. \n\ Usage: 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" CurrencyOfTransfer: type: string description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. example: GBP maxLength: 3 minLength: 3 pattern: ^[A-Z]{3,3}$ DestinationCountryCode: type: string description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). example: GB maxLength: 2 minLength: 2 pattern: ^[A-Z]{2,2}$ InstructedAmount: type: object additionalProperties: 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 ExchangeRateInformation: type: object additionalProperties: false description: Provides details on the currency exchange rate and contract. properties: UnitCurrency: type: string description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. example: GBP maxLength: 3 minLength: 3 pattern: ^[A-Z]{3,3}$ ExchangeRate: type: number description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. example: 0 maximum: 99999999 minimum: 0 RateType: type: string description: Specifies the type used to complete the currency exchange. enum: - Actual - Agreed - Indicative ContractIdentification: type: string description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. example: Contract Info maxLength: 256 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_-]{1,256})$ required: - RateType - UnitCurrency 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 Creditor: type: object additionalProperties: false description: 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: Name maxLength: 140 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-. '()£="_,&@#\/;+]{1,140})$ LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' CreditorAgent: type: object additionalProperties: false description: Financial institution servicing an account for the creditor. properties: SchemeName: $ref: '#/components/schemas/OBInternalFinancialInstitutionIdentification4Code' Identification: $ref: '#/components/schemas/Identification_1' LEI: $ref: '#/components/schemas/LEI' Name: $ref: '#/components/schemas/Name' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' CreditorAccount: type: object additionalProperties: false 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 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' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' required: - CreditorAccount - CurrencyOfTransfer - InstructedAmount - InstructionIdentification - RequestedExecutionDateTime 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 - Permission - Status - StatusUpdateDateTime Risk: $ref: '#/components/schemas/OBRisk1' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data - Risk nullable: false 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 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 OBWriteDomestic2: type: object additionalProperties: false deprecated: false properties: Data: type: object additionalProperties: false deprecated: 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 deprecated: false description: The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment. 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' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' required: - CreditorAccount - EndToEndIdentification - InstructedAmount - InstructionIdentification nullable: false required: - ConsentId - Initiation nullable: false Risk: $ref: '#/components/schemas/OBRisk1' required: - Data - Risk nullable: false 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 Date: type: string format: date description: "Date and time associated with the date time type. All dates in the JSON payloads are represented in ISO\ \ 8601 date format. \n An example is below:\n2017-04-05" example: '2017-04-05' 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' 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}$ OBWriteInternational3: 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 from the debtor account to a creditor for a single international payment. 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' InstructionPriority: type: string description: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. enum: - Normal - Urgent ExtendedPurpose: type: string description: Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes. example: string maxLength: 140 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,140})$ ChargeBearer: $ref: '#/components/schemas/OBInternalChargeBearerType1Code' CurrencyOfTransfer: type: string description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. example: GBP maxLength: 3 minLength: 3 pattern: ^[A-Z]{3,3}$ DestinationCountryCode: type: string description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). example: GB maxLength: 2 minLength: 2 pattern: ^[A-Z]{2,2}$ InstructedAmount: type: object additionalProperties: 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 ExchangeRateInformation: type: object additionalProperties: false description: Provides details on the currency exchange rate and contract. properties: UnitCurrency: type: string description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. example: GBP maxLength: 3 minLength: 3 pattern: ^[A-Z]{3,3}$ ExchangeRate: type: number description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. example: 0 maximum: 99999999 minimum: 0 RateType: type: string description: Specifies the type used to complete the currency exchange. enum: - Actual - Agreed - Indicative ContractIdentification: type: string description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. example: Contract Info maxLength: 256 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_-]{1,256})$ required: - RateType - UnitCurrency 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 Creditor: type: object additionalProperties: false description: 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: Name maxLength: 140 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-. '()£="_,&@#\/;+]{1,140})$ LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' CreditorAgent: type: object additionalProperties: false description: Financial institution servicing an account for the creditor. properties: SchemeName: $ref: '#/components/schemas/OBInternalFinancialInstitutionIdentification4Code' Identification: $ref: '#/components/schemas/Identification_1' Name: $ref: '#/components/schemas/Name' LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' CreditorAccount: type: object additionalProperties: 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 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' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' required: - CreditorAccount - CurrencyOfTransfer - EndToEndIdentification - InstructedAmount - InstructionIdentification required: - ConsentId - Initiation Risk: $ref: '#/components/schemas/OBRisk1' required: - Data - Risk nullable: false OBWriteInternationalStandingOrderResponse7: type: object additionalProperties: false deprecated: false properties: Data: type: object additionalProperties: false properties: InternationalStandingOrderId: type: string description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the international standing order 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 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: $ref: '#/components/schemas/ExternalPaymentTransactionStatus1Code' 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 Refund: $ref: '#/components/schemas/OBDomesticRefundAccount1' Charges: type: array items: type: object additionalProperties: false description: Set of elements used to provide details of a charge for the payment initiation. 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 from the debtor account to a creditor for an international standing order. properties: RemittanceInformation: $ref: '#/components/schemas/OBRemittanceInformation2' NumberOfPayments: $ref: '#/components/schemas/NumberOfPayments' ExtendedPurpose: type: string description: Specifies the purpose of an international payment, when there is no corresponding 4 character code available in the ISO20022 list of Purpose Codes. example: string maxLength: 140 minLength: 1 pattern: ^(?!\s)([A-Za-z0-9!+\/\= '.,@#()_\-]{1,140})$ ChargeBearer: $ref: '#/components/schemas/OBInternalChargeBearerType1Code' CurrencyOfTransfer: type: string description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. example: GBP maxLength: 3 minLength: 3 pattern: ^[A-Z]{3,3}$ DestinationCountryCode: type: string description: Country in which Credit Account is domiciled. Code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code). example: GB maxLength: 2 minLength: 2 pattern: ^[A-Z]{2,2}$ InstructedAmount: type: object additionalProperties: 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 DebtorAccount: type: object additionalProperties: false description: Provides the details to identify the debtor account. 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 Creditor: type: object additionalProperties: false description: 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: Name maxLength: 140 minLength: 1 pattern: ^(?!\s)([a-zA-Z0-9-. '()£="_,&@#\/;+]{1,140})$ LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' CreditorAgent: type: object additionalProperties: false description: 'Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account.' properties: SchemeName: $ref: '#/components/schemas/OBInternalFinancialInstitutionIdentification4Code' Identification: type: string description: Unique and unambiguous identification of the servicing institution. maxLength: 35 minLength: 1 Name: $ref: '#/components/schemas/Name' LEI: $ref: '#/components/schemas/LEI' PostalAddress: $ref: '#/components/schemas/OBPostalAddress7' CreditorAccount: type: object additionalProperties: false description: Provides the details to identify the beneficiary account. 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 UltimateCreditor: $ref: '#/components/schemas/OBUltimateCreditor1' UltimateDebtor: $ref: '#/components/schemas/OBUltimateDebtor1' RegulatoryReporting: type: array items: $ref: '#/components/schemas/OBRegulatoryReporting1' maxItems: 3 minItems: 0 MandateRelatedInformation: $ref: '#/components/schemas/OBMandateRelatedInformation1' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' required: - CreditorAccount - CurrencyOfTransfer - InstructedAmount - MandateRelatedInformation 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 - Initiation - InternationalStandingOrderId - Status - StatusUpdateDateTime Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data nullable: false 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 ExternalPurpose1Code: type: string description: This is a partial list, For a full list see `ExternalPurpose1Code` [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - BKDF - BKFE - BKFM - BKIP - BKPP - CBLK - CDCB - CDCD - CDCS - CDDP - CDOC - CDQC - ETUP - FCOL - MTUP - ACCT - CASH - COLL - CSDB - DEPT - INTC - INTP - LIMA - NETT - BFWD - CCIR - CCPC - CCPM - CCSM - CRDS - CRPR - CRSP - CRTL - EQPT - EQUS - EXPT - EXTD - FIXI - FWBC - FWCC - FWSB - FWSC - MARG - MBSB - MBSC - MGCC - MGSC - OCCC - OPBC - OPCC - OPSB - OPSC - OPTN - OTCD - REPO - RPBC - RPCC - RPSB - RPSC - RVPO - SBSC - SCIE - SCIR - SCRP - SHBC - SHCC - SHSL - SLEB - SLOA - SWBC - SWCC - SWPT - SWSB - SWSC - TBAS - TBBC - TBCC - TRCP - AGRT - AREN - BEXP - BOCE - COMC - CPYR - GDDS - GDSV - GSCB - LICF - MP2B - POPE - ROYA - SCVE - SERV - SUBS - SUPP - TRAD - CHAR - COMT - MP2P - ECPG - ECPR - ECPU - EPAY - CLPR - COMP - DBTC - GOVI - HLRP - HLST - INPC - INPR - INSC - INSU - INTE - LBRI - LIFI - LOAN - LOAR - PENO - PPTI - RELG - RINP - TRFD - FORW - FXNT - ADMG - ADVA - BCDM - BCFG - BLDM - BNET - CBFF - CBFR - CCRD - CDBL - CFEE - CGDD - CORT - COST - CPKC - DCRD - DSMT - DVPM - EDUC - FACT - FAND - FCPM - FEES - GIFT - GOVT - ICCP - IDCP - IHRP - INSM - IVPT - MCDM - MCFG - MSVC - NOWS - OCDM - OCFG - OFEE - OTHR - PADD - PTSP - RCKE - RCPT - REBT - REFU - RENT - REOD - RIMB - RPNT - RRBN - RRCT - RRTP - RVPM - SLPI - SPLT - STDY - TBAN - TBIL - TCSC - TELI - TMPG - TPRI - TPRP - TRNC - TRVC - WEBI - IPAY - IPCA - IPDO - IPEA - IPEC - IPEW - IPPS - IPRT - IPU2 - IPUW - ANNI - CAFI - CFDI - CMDT - DERI - DIVD - FREX - HEDG - INVS - PRME - SAVG - SECU - SEPI - TREA - UNIT - FNET - FUTR - ANTS - CVCF - DMEQ - DNTS - HLTC - HLTI - HSPC - ICRF - LTCF - MAFC - MARF - MDCS - VIEW - CDEP - SWFP - SWPP - SWRS - SWUF - ADCS - AEMP - ALLW - ALMY - BBSC - BECH - BENE - BONU - CCHD - COMM - CSLP - GFRP - GVEA - GVEB - GVEC - GVED - GWLT - HREC - PAYR - PEFC - PENS - PRCP - RHBS - SALA - SPSP - SSBE - LBIN - LCOL - LFEE - LMEQ - LMFI - LMRK - LREB - LREV - LSFL - ESTX - FWLV - GSTX - HSTX - INTX - NITX - PTXP - RDTX - TAXS - VATX - WHLD - TAXR - B112 - BR12 - TLRF - TLRR - AIRB - BUSB - FERB - RLWY - TRPT - CBTV - ELEC - ENRG - GASB - NWCH - NWCM - OTLC - PHON - UBIL - WTER - BOND - CABD - CAEQ - CBCR - DBCR - DICL - EQTS - FLCR - EFTC - EFTD - MOMA - RAPI - GAMB - LOTT - AMEX - SASW - AUCO - PCOM - PDEP - PLDS - PLRF - GAFA - GAHO - CPEN - DEPD - RETL - DEBT - CRYP example: BKFE 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' OBWriteDomesticConsentResponse5: type: object additionalProperties: false deprecated: false properties: Data: type: object additionalProperties: false deprecated: 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: $ref: '#/components/schemas/OBInternalConsentStatus2Code' 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 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" ReadRefundAccount: type: string description: Specifies to share the refund account details with PISP. For a full list of values refer to `OBInternalReadRefundAccount1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - 'No' - 'Yes' 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" ExpectedExecutionDateTime: type: string format: date-time description: "Expected execution date and time for the payment resource. All dates in the JSON payloads are\ \ represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone.\ \ An example is below:\n2017-04-05T10:43:07+00:00" ExpectedSettlementDateTime: type: string format: date-time description: "Expected settlement date and time for the payment resource. All dates in the JSON payloads are\ \ represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone.\ \ An example is below:\n2017-04-05T10:43:07+00:00" Charges: type: array items: type: object additionalProperties: false deprecated: 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 nullable: false maxItems: 99999 minItems: 0 Initiation: type: object additionalProperties: false deprecated: false description: The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single domestic payment. 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' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' required: - CreditorAccount - EndToEndIdentification - InstructedAmount - InstructionIdentification nullable: false Authorisation: type: object additionalProperties: false deprecated: false description: The authorisation type request from the TPP. properties: AuthorisationType: type: string description: Type of authorisation flow requested. For a full list of values refer to `OBInternalAuthorisation1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) 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 nullable: false SCASupportData: $ref: '#/components/schemas/OBSCASupportData1' Debtor: $ref: '#/components/schemas/OBCashAccountDebtor4' required: - ConsentId - CreationDateTime - Initiation - Status - StatusUpdateDateTime nullable: false Risk: $ref: '#/components/schemas/OBRisk1' Links: $ref: '#/components/schemas/Links' Meta: $ref: '#/components/schemas/Meta' required: - Data - Risk nullable: false OBWriteDomesticScheduledConsent4: type: object additionalProperties: false deprecated: false properties: Data: type: object additionalProperties: false deprecated: false properties: Permission: type: string description: Specifies the Open Banking service request types. For a full list of values see `OBInternalPermissions2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - Create ReadRefundAccount: type: string description: Specifies to share the refund account details with PISP. For a full list of values see `OBInternalReadRefundAccount1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) enum: - 'No' - 'Yes' Initiation: type: object additionalProperties: false deprecated: false description: The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled domestic payment. 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' RequestedExecutionDateTime: type: string format: date-time description: "Date at which the initiating party requests the clearing agent to process the payment. \n\ Usage: 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" 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 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' SupplementaryData: $ref: '#/components/schemas/OBSupplementaryData1' required: - CreditorAccount - InstructedAmount - InstructionIdentification - RequestedExecutionDateTime nullable: false Authorisation: type: object additionalProperties: false deprecated: false description: The authorisation type request from the TPP. properties: AuthorisationType: type: string description: Type of authorisation flow requested. For a full list of values refer to `OBInternalAuthorisation1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) 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 nullable: false SCASupportData: $ref: '#/components/schemas/OBSCASupportData1' required: - Initiation - Permission nullable: false Risk: $ref: '#/components/schemas/OBRisk1' required: - Data - Risk nullable: false responses: 200DomesticStandingOrderConsentsConsentIdRead: description: Domestic Standing Order 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/OBWriteDomesticStandingOrderConsentResponse6' examples: get-dom-stand-order-con-response: value: Data: ConsentId: BARCLAYS-P-12345678901234 CreationDateTime: '2024-09-04T18:17:23.786Z' Status: AUTH StatusUpdateDateTime: '2024-09-04T18:19:23.786Z' Permission: Create ReadRefundAccount: 'No' Charges: - ChargeBearer: BorneByCreditor Type: UK.OBIE.CHAPSOut Amount: Amount: '0.50' Currency: GBP Initiation: RemittanceInformation: Structured: - ReferredDocumentInformation: - Code: CINV Issuer: Issuer01 Number: Number_01 RelatedDate: '2024-09-04T16:33:53.086Z' LineDetails: - Line Detail ReferredDocumentAmount: 1 CreditorReferenceInformation: Code: DISP Issuer: Issuer01 Reference: Pocket money for Damien Invoicer: INVR51856 Invoicee: INVE5161856 TaxRemittance: Tax Remittance related information AdditionalRemittanceInformation: - Free text for additional information Unstructured: - Internal ops code 5120101 FirstPaymentAmount: Amount: '7.00' Currency: GBP RecurringPaymentAmount: Amount: '7.00' Currency: GBP FinalPaymentAmount: Amount: '7.00' Currency: GBP DebtorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '11280001234567' Name: Andrea Smith SecondaryIdentification: '0002' Proxy: Identification: 07700900000 Code: TELE Type: Telephone CreditorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: Bob Clements SecondaryIdentification: '0002' Proxy: Identification: 07700900999 Code: TELE Type: Telephone 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: 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 RegulatoryReporting: - DebitCreditReportingIndicator: CRED Authority: Name: Authority Name CountryCode: GB Details: - Type: CRED Date: '2024-04-25T13:26:41.911Z' Country: GB Amount: Amount: '7.00' Currency: GBP Information: - Reg info1 - Reg info2 MandateRelatedInformation: MandateIdentification: SO003538282 Classification: FIXE CategoryPurposeCode: CASH FirstPaymentDateTime: '2024-09-04T16:33:53.087Z' FinalPaymentDateTime: '2025-09-04T16:33:53.087Z' Frequency: Type: DAIL CountPerPeriod: 1 Reason: Pocket Money Risk: PaymentContextCode: TransferToThirdParty Links: Self: https://api.alphabank.com/open-banking/v4.0/pisp/domestic-standing-order-consents/SOC-100 Meta: {} 200InternationalScheduledPaymentConsentsConsentIdRead: description: International Scheduled 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/OBWriteInternationalScheduledConsentResponse6' examples: get-int-sched-consent-response: value: Data: ConsentId: BARCLAYS-P-12345678901234 CreationDateTime: '2018-09-18T10:11:48.520Z' Status: AUTH StatusUpdateDateTime: '2018-09-18T10:11:48.520Z' Permission: Create CutOffDateTime: '2018-09-18T10:11:48.520Z' ExpectedExecutionDateTime: '2018-09-18T10:11:48.520Z' ExpectedSettlementDateTime: '2018-09-18T10:11:48.520Z' ReadRefundAccount: 'Yes' Charges: - ChargeBearer: BorneByCreditor Type: UK.OBIE.CHAPSOut Amount: Amount: '3.50' Currency: GBP ExchangeRateInformation: UnitCurrency: GBP ExchangeRate: 90 RateType: Actual ContractIdentification: string ExpirationDateTime: '2018-09-21T10:11:48.520Z' Initiation: InstructionIdentification: string EndToEndIdentification: string LocalInstrument: UK.OBIE.Target2 InstructionPriority: Normal ChargeBearer: BorneByCreditor RequestedExecutionDateTime: '2018-09-18T10:11:48.520Z' CurrencyOfTransfer: INR InstructedAmount: Amount: '900000.00' Currency: INR ExchangeRateInformation: UnitCurrency: GBP ExchangeRate: 90 RateType: Actual ContractIdentification: string DebtorAccount: SchemeName: UK.OBIE.IBAN Identification: IN34567890123456789012345678901234 Name: string SecondaryIdentification: string Creditor: Name: string PostalAddress: AddressType: BIZZ Department: string SubDepartment: string StreetName: string BuildingNumber: '34' PostCode: string TownName: string CountrySubDivision: string Country: AU AddressLine: - string CreditorAgent: SchemeName: UK.OBIE.IBAN Identification: '12345612345678' Name: string PostalAddress: AddressType: BIZZ Department: string SubDepartment: string StreetName: string BuildingNumber: '67' PostCode: string TownName: string CountrySubDivision: string Country: UK AddressLine: - string CreditorAccount: SchemeName: UK.OBIE.IBAN Identification: UK34567890123456789012345678901234 Name: string SecondaryIdentification: string RemittanceInformation: Unstructured: - string Authorisation: AuthorisationType: Any CompletionDateTime: '2018-09-18T10:11:48.520Z' Risk: PaymentContextCode: TransferToThirdParty MerchantCategoryCode: AMAZ MerchantCustomerIdentification: string DeliveryAddress: AddressLine: - string StreetName: string BuildingNumber: '21' PostCode: string TownName: string CountrySubDivision: CountrySubDivision1 Country: IN BeneficiaryPrepopulatedIndicator: true PaymentPurposeCode: EPAY BeneficiaryAccountType: BusinessSavingsAccount Links: Self: https://api.alphabank.com/open-banking/v4.0/pisp/domestic-scheduled-payments/7290-003 Meta: TotalPages: 0 FirstAvailableDateTime: '2018-09-18T10:11:48.520Z' LastAvailableDateTime: '2018-09-18T10:11:48.520Z' 200InternationalScheduledPaymentsInternationalScheduledPaymentIdRead: description: International Scheduled Payments Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string 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/OBWriteInternationalScheduledResponse6' examples: get-int-sched-payments-response: value: Data: InternationalScheduledPaymentId: BARCLAYS-P-12345678901234 ConsentId: BARCLAYS-P-12345678901234 CreationDateTime: '2018-10-05T05:32:21.233Z' Status: ACCP StatusUpdateDateTime: '2018-10-05T05:32:21.233Z' ExpectedExecutionDateTime: '2018-10-05T05:32:21.233Z' ExpectedSettlementDateTime: '2018-10-05T05:32:21.233Z' Charges: - ChargeBearer: BorneByCreditor Type: UK.OBIE.CHAPSOut Amount: Amount: '22.22' Currency: GBP ExchangeRateInformation: UnitCurrency: GBP ExchangeRate: 0 RateType: Actual ContractIdentification: string ExpirationDateTime: '2018-10-05T05:32:21.233Z' Initiation: InstructionIdentification: string EndToEndIdentification: string LocalInstrument: UK.OBIE.SWIFT InstructionPriority: Normal ChargeBearer: BorneByCreditor RequestedExecutionDateTime: '2018-09-19T11:03:57.587Z' CurrencyOfTransfer: USD InstructedAmount: Amount: '1000.00' Currency: GBP ExchangeRateInformation: UnitCurrency: GBP ExchangeRate: 88.1 RateType: Actual ContractIdentification: string DebtorAccount: SchemeName: UK.OBIE.IBAN Identification: IN34567890123456789012345678901234 Name: string SecondaryIdentification: string Creditor: Name: John Snow PostalAddress: AddressType: BIZZ Department: string SubDepartment: string StreetName: string BuildingNumber: '21' PostCode: string TownName: string CountrySubDivision: string Country: UK AddressLine: - string CreditorAgent: SchemeName: UK.OBIE.IBAN Identification: '12345678901234' Name: string PostalAddress: AddressType: BIZZ Department: string SubDepartment: string StreetName: string BuildingNumber: '23' PostCode: string TownName: string CountrySubDivision: string Country: IN AddressLine: - string CreditorAccount: SchemeName: UK.OBIE.IBAN Identification: IN34567890123456789012345678901234 Name: string SecondaryIdentification: string RemittanceInformation: Unstructured: - string MultiAuthorisation: Status: AUTH NumberRequired: 0 NumberReceived: 0 LastUpdateDateTime: '2018-10-05T05:32:21.233Z' ExpirationDateTime: '2018-10-05T05:32:21.233Z' Refund: Account: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: test Links: Self: https://api.alphabank.com/open-banking/v4.0/pisp/domestic-scheduled-payments/7290-003 Meta: TotalPages: 0 FirstAvailableDateTime: '2018-10-05T05:32:21.233Z' LastAvailableDateTime: '2018-10-05T05:32:21.233Z' 201DomesticPaymentsCreated: description: Domestic 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/OBWriteDomesticResponse5' examples: create-domestic-payment-response: value: Data: DomesticPaymentId: 58923-001 ConsentId: BARCLAYS-P-12345678901234 Status: ACSP StatusReason: - StatusReasonCode: U30 CreationDateTime: '2017-06-05T15:15:22+00:00' StatusUpdateDateTime: '2017-06-05T15:15:13+00:00' ExpectedExecutionDateTime: '2017-06-05T15:15:22+00:00' ExpectedSettlementDateTime: '2017-06-06T15:15:22+00:00' Refund: Account: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325677 SecondaryIdentification: '0002' Name: NTPC Inc Debtor: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: ACME Inc SecondaryIdentification: '0002' LEI: 8200007YHFDMEODY1965 Charges: - ChargeBearer: Shared Type: UK.OBIE.CHAPSOut Amount: Amount: '0.88' Currency: GBP MultiAuthorisation: Status: AUTH NumberRequired: 2 NumberReceived: 2 LastUpdateDateTime: '2017-06-05T15:15:13+00:00' ExpirationDateTime: '2017-06-06T15:15:13+00:00' Initiation: 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: '441234012345' Code: TELE Type: Telephone CreditorPostalAddress: 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 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: UK 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 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/domestic-payments/58923-001 Meta: {} 200DomesticPaymentConsentsConsentIdRead: description: Domestic 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/OBWriteDomesticConsentResponse5' examples: get-domestic-payment-consent: value: Data: ConsentId: BARCLAYS-P-12345678901234 Status: AUTH CreationDateTime: '2017-06-05T15:15:13+00:00' StatusUpdateDateTime: '2017-06-05T15:15:22+00:00' ReadRefundAccount: 'Yes' Initiation: InstructionIdentification: ACME412 EndToEndIdentification: FRESCO.21302.GFX.20 InstructedAmount: Amount: '165.88' Currency: GBP CreditorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: ACME Inc SecondaryIdentification: '0002' Proxy: Identification: '441234012885' Code: TELE Type: Telephone CreditorPostalAddress: 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 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 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: - Date: '2024-04-25T13:26:41.911Z' 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: - 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 Debtor: Name: D Jones SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 SecondaryIdentification: '0002' LEI: 8200007YHFDMEODY1965 Risk: PaymentContextCode: EcommerceMerchantInitiatedPayment ContractPresentIndicator: false PaymentPurposeCode: EPAY BeneficiaryAccountType: Business MerchantCustomerIdentification: 053598653254 DeliveryAddress: AddressLine: - Flat 7 - Acacia Lodge StreetName: Acacia Avenue BuildingNumber: '27' PostCode: GU31 2ZZ TownName: Sparsholt CountrySubDivision: Wessex Country: GB Links: Self: https://api.alphabank.com/open-banking/v4.0/pisp/domestic-payment-consents/58923 Meta: {} 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' 200InternationalStandingOrdersInternationalStandingOrderPaymentIdRead: description: International Standing Orders Read headers: x-fapi-interaction-id: description: An RFC4122 UID used as a correlation id. required: true schema: type: string 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/OBWriteInternationalStandingOrderResponse7' 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: {} 201InternationalPaymentConsentsCreated: description: International 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/OBWriteInternationalConsentResponse6' examples: create-int-con-response: value: Data: ConsentId: BARCLAYS-P-12345678901234 Status: AWAU StatusReason: - StatusReasonCode: U036 StatusReasonDescription: Waiting for completion of consent authorisation to be completed by user ExpectedExecutionDateTime: '2017-06-05T15:15:22+00:00' ExpectedSettlementDateTime: '2017-06-06T15:15:22+00:00' CutOffDateTime: '2017-06-05T16:00:13+00:00' CreationDateTime: '2017-06-05T15:15:13+00:00' StatusUpdateDateTime: '2017-06-05T15:15:13+00:00' ReadRefundAccount: 'Yes' Debtor: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: ACME Inc SecondaryIdentification: '0002' LEI: 8200007YHFDMEODY1965 Authorisation: AuthorisationType: Any CompletionDateTime: '2024-05-30T10:35:27Z' Charges: - ChargeBearer: Shared Type: UK.OBIE.CHAPSOut Amount: Amount: '0.88' Currency: GBP Initiation: ChargeBearer: Shared InstructionIdentification: ACME412 EndToEndIdentification: FRESCO.21302.GFX.20 CurrencyOfTransfer: USD DestinationCountryCode: GB LocalInstrument: UK.OBIE.Paym InstructionPriority: Normal InstructedAmount: Amount: '165.88' Currency: GBP Creditor: Name: Mr Joe Creditor LEI: 8200007YHFDMEODY1965 PostalAddress: AddressType: BIZZ StreetName: Bank Street BuildingNumber: '11' Floor: '6' PostCode: Z78 4TY TownName: London Country: UK CreditorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: ACME Inc SecondaryIdentification: '0002' Proxy: Identification: 07700900000 Code: TELE Type: Telephone CreditorAgent: LEI: 1234005BLKBSWLCX4E37 SchemeName: UK.OBIE.IBAN Name: ACED Inc Identification: 08080021325698 PostalAddress: 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: UK ExchangeRateInformation: UnitCurrency: GBP ExchangeRate: 1.22 RateType: Actual ContractIdentification: '19854961984' 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 DebtorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber SecondaryIdentification: '0002' Identification: '11280001234567' Name: Andrea Smith Proxy: Identification: 07700900000 Code: TELE Type: Telephone 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: UK RegulatoryReporting: - DebitCreditReportingIndicator: CRED Authority: Name: string CountryCode: UG Details: - Date: '2024-04-25T13:26:41.911Z' 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: - 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 ExchangeRateInformation: UnitCurrency: GBP ExchangeRate: 1.1 RateType: Actual ExpirationDateTime: '2017-06-05T15:45:13+00:00' Risk: PaymentContextCode: TransferToThirdParty ContractPresentIndicator: false PaymentPurposeCode: EPAY CategoryPurposeCode: CASH BeneficiaryAccountType: Business MerchantCategoryCode: '7300' MerchantCustomerIdentification: 053598653254 DeliveryAddress: AddressLine: - Flat 7 - Acacia Lodge StreetName: Acacia Avenue BuildingNumber: '27' PostCode: GU31 2ZZ TownName: Sparsholt CountrySubDivision: Wessex Country: UK Links: Self: https://api.alphabank.com/open-banking/v4.0/pisp/international-payment-consents/58923 Meta: {} 201DomesticStandingOrderConsentsCreated: description: Domestic Standing Order 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/OBWriteDomesticStandingOrderConsentResponse6' examples: create-dom-stand-order-con-response: value: Data: ConsentId: BARCLAYS-P-12345678901234 CreationDateTime: '2024-09-04T18:17:23.786Z' Status: AWAU StatusUpdateDateTime: '2024-09-04T18:17:23.786Z' StatusReason: - StatusReasonCode: U036 StatusReasonDescription: Waiting for completion of consent authorisation to be completed by user Permission: Create ReadRefundAccount: 'No' CutOffDateTime: '2024-09-04T18:17:23.786Z' Charges: - ChargeBearer: BorneByCreditor Type: UK.OBIE.CHAPSOut Amount: Amount: '0.50' Currency: GBP Initiation: RemittanceInformation: Structured: - ReferredDocumentInformation: - Code: CINV Issuer: Issuer01 Number: Number_01 RelatedDate: '2024-09-04T16:33:53.086Z' LineDetails: - Line Detail ReferredDocumentAmount: 1 CreditorReferenceInformation: Code: DISP Issuer: Issuer01 Reference: Pocket money for Damien Invoicer: INVR51856 Invoicee: INVE5161856 TaxRemittance: Tax Remittance related information AdditionalRemittanceInformation: - Free text for additional information Unstructured: - Internal ops code 5120101 FirstPaymentAmount: Amount: '7.00' Currency: GBP RecurringPaymentAmount: Amount: '7.00' Currency: GBP FinalPaymentAmount: Amount: '7.00' Currency: GBP DebtorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '11280001234567' Name: Andrea Smith SecondaryIdentification: '0002' Proxy: Identification: 07700900000 Code: TELE Type: Telephone CreditorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: Bob Clements SecondaryIdentification: '0002' Proxy: Identification: 07700900999 Code: TELE Type: Telephone 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: 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 RegulatoryReporting: - DebitCreditReportingIndicator: CRED Authority: Name: Authority Name CountryCode: GB Details: - Type: CRED Date: '2024-04-25T13:26:41.911Z' Country: GB Amount: Amount: '7.00' Currency: GBP Information: - Reg info1 - Reg info2 MandateRelatedInformation: MandateIdentification: SO003538282 Classification: FIXE CategoryPurposeCode: CASH FirstPaymentDateTime: '2024-09-04T16:33:53.087Z' FinalPaymentDateTime: '2025-09-04T16:33:53.087Z' Frequency: Type: DAIL CountPerPeriod: 1 Reason: Pocket Money Risk: PaymentContextCode: TransferToThirdParty Links: Self: https://api.alphabank.com/open-banking/v4.0/pisp/domestic-standing-order-consents/SOC-100 Meta: {} 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' 200InternationalPaymentConsentsConsentIdRead: description: International 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/OBWriteInternationalConsentResponse6' examples: get-int-pay-con-response: value: Data: CreationDateTime: '2017-06-05T15:15:23+00:00' ConsentId: BARCLAYS-P-12345678901234 FundsAvailableResult: FundsAvailableDateTime: '2017-06-05T15:15:23+00:00' FundsAvailable: true Status: AWAU StatusUpdateDateTime: '2017-06-05T15:15:23+00:00' Risk: PaymentContextCode: TransferToThirdParty MerchantCategoryCode: AMAZ MerchantCustomerIdentification: string DeliveryAddress: AddressLine: - string StreetName: string BuildingNumber: '21' PostCode: string TownName: string CountrySubDivision: CountrySubDivision1 Country: IN BeneficiaryPrepopulatedIndicator: true PaymentPurposeCode: EPAY BeneficiaryAccountType: BusinessSavingsAccount Links: Self: https://api.alphabank.com/open-banking/v4.0/pisp/international-payment-consents/58923/funds-confirmation Meta: {} 201DomesticScheduledPaymentConsentsCreated: description: Domestic Scheduled 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/OBWriteDomesticScheduledConsentResponse5' examples: create-dom-payment-sched-con-response: value: Data: ConsentId: BARCLAYS-P-12345678901234 Permission: Create ReadRefundAccount: 'Yes' Status: AWAU CreationDateTime: '2018-05-05T15:15:13+00:00' StatusUpdateDateTime: '2018-05-05T15:15:13+00:00' ExpectedExecutionDateTime: '2018-06-05T15:15:22+00:00' ExpectedSettlementDateTime: '2018-06-06T15:15:22+00:00' Authorisation: AuthorisationType: Any CompletionDateTime: '2025-05-30T10:35:27Z' StatusReason: - StatusReasonCode: U036 StatusReasonDescription: Waiting for completion of consent authorisation to be completed by user Charges: - ChargeBearer: Shared Type: UK.OBIE.CHAPSOut Amount: Amount: '0.88' Currency: GBP Initiation: InstructionIdentification: 89f0a53a91ee47f6a383536f851d6b5a RequestedExecutionDateTime: '2018-08-06T00:00:00+00:00' EndToEndIdentification: FRESCO.21302.GFX.20 LocalInstrument: UK.OBIE.Paym InstructedAmount: Amount: '200.00' Currency: GBP DebtorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '11280001234567' Name: Andrea Frost SecondaryIdentification: '0002' Proxy: Identification: '2360549017905188' Code: TELE Type: Telephone CreditorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: Tom Kirkman 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 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: - 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 Risk: PaymentContextCode: TransferToThirdParty ContractPresentIndicator: false PaymentPurposeCode: EPAY CategoryPurposeCode: CASH BeneficiaryAccountType: Business MerchantCategoryCode: '7300' MerchantCustomerIdentification: 053598653254 DeliveryAddress: AddressLine: - Flat 7 - Acacia Lodge StreetName: Acacia Avenue BuildingNumber: '27' PostCode: GU31 2ZZ TownName: Sparsholt CountrySubDivision: Wessex Country: GB Links: Self: https://api.alphabank.com/open-banking/v4.0/pisp/domestic-scheduled-payment-consents/7290 Meta: {} 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 200DomesticScheduledPaymentsDomesticScheduledPaymentIdRead: description: Domestic Scheduled 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/OBWriteDomesticScheduledResponse5' examples: get-dom-sched-pay-response: value: Data: DomesticScheduledPaymentId: BARCLAYS-P-12345678901234 ConsentId: BARCLAYS-P-12345678901234 Status: ACCP CreationDateTime: '2017-06-05T15:15:22+00:00' StatusUpdateDateTime: '2017-06-05T15:15:13+00:00' Refund: Account: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: test Initiation: InstructionIdentification: ACME412 EndToEndIdentification: FRESCO.21302.GFX.20 RequestedExecutionDateTime: '2018-09-05T08:05:04.600Z' InstructedAmount: Amount: '165.88' Currency: GBP CreditorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: ACME Inc SecondaryIdentification: '0002' RemittanceInformation: Unstructured: - Internal ops code 5120101 Links: Self: https://api.alphabank.com/open-banking/v3.0/domestic-payments/58923-001 Meta: {} 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 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 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 200DomesticPaymentsDomesticPaymentIdRead: description: Domestic 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/OBWriteDomesticResponse5' examples: get-domestic-payment: value: Data: DomesticPaymentId: 58923-001 ConsentId: BARCLAYS-P-12345678901234 Status: ACSP CreationDateTime: '2017-06-05T15:15:22+00:00' StatusUpdateDateTime: '2017-06-05T15:15:22+00:00' Initiation: InstructionIdentification: ACME412 EndToEndIdentification: FRESCO.21302.GFX.20 InstructedAmount: Amount: '165.88' Currency: GBP 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 CreditorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: ACME Inc 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/domestic-payments/58923-001 Meta: {} 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 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: {} 201InternationalScheduledPaymentConsentsCreated: description: International Scheduled 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/OBWriteInternationalScheduledConsentResponse6' examples: create-int-sched-pay-con-response: value: Data: ConsentId: BARCLAYS-P-12345678901234 CreationDateTime: '2024-09-16T10:25:28.443Z' Status: AWAU StatusReason: - StatusReasonCode: AWAU StatusReasonDescription: Waiting for completion of consent authorisation to be completed by user StatusUpdateDateTime: '2024-09-16T10:25:28.443Z' Permission: Create ReadRefundAccount: 'Yes' CutOffDateTime: '2024-09-16T10:25:28.443Z' ExpectedExecutionDateTime: '2024-10-16T10:25:28.443Z' ExpectedSettlementDateTime: '2024-10-16T11:25:28.443Z' Charges: - ChargeBearer: Shared Type: UK.OBIE.CHAPSOut Amount: Amount: '0.88' Currency: GBP ExchangeRateInformation: UnitCurrency: GBP ExchangeRate: 1.22 RateType: Actual ContractIdentification: 0591968098186 ExpirationDateTime: '2024-09-16T10:25:28.443Z' Initiation: InstructionIdentification: ACME412 EndToEndIdentification: FRESCO.21302.GFX.20 LocalInstrument: UK.OBIE.Paym InstructionPriority: Normal ChargeBearer: Shared RequestedExecutionDateTime: '2024-09-16T10:25:28.422Z' CurrencyOfTransfer: USD DestinationCountryCode: GB InstructedAmount: Amount: '165.88' Currency: GBP ExchangeRateInformation: UnitCurrency: GBP ExchangeRate: 1.22 RateType: Actual ContractIdentification: '415621656' DebtorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber SecondaryIdentification: '0002' Identification: '11280001234567' Name: Andrea Smith Proxy: Identification: '2360549017905188' Code: TELE Type: Telephone Creditor: Name: A Creditor Name LEI: 8200007YHFDMEODY8412 PostalAddress: AddressType: BIZZ StreetName: Bank Street BuildingNumber: '11' Floor: '6' PostCode: Z78 4TY TownName: London Country: UK CreditorAgent: SchemeName: UK.OBIE.IBAN Identification: 08080021325698 LEI: 1234005BLKBSWLCX4E37 Name: ACED Inc PostalAddress: AddressType: BIZZ Department: Finance SubDepartment: Payroll StreetName: Bank Street BuildingNumber: '11' BuildingName: Tower Bridges Floor: '6' UnitNumber: UNIT591 Room: '844' PostBox: PO Box 123456 DistrictName: Greater London CareOf: Ms Jane Smith PostCode: Z78 4TY TownName: London CountrySubDivision: string Country: UK CreditorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: ACME Inc SecondaryIdentification: '0002' Proxy: Identification: '2360549017905188' Code: TELE Type: Telephone UltimateCreditor: Name: Ultimate Creditor Identification: '2360549017905161589' LEI: 60450004FECVJV7YN339 SchemeName: UK.OBIE.IBAN PostalAddress: AddressType: BIZZ StreetName: Bank Street BuildingNumber: '11' Floor: '6' PostCode: Z78 4TY TownName: London Country: UK UltimateDebtor: Name: Ultimate Debtor Identification: '2360549017905161589' LEI: 8200007YHFDMEODY1965 SchemeName: UK.OBIE.IBAN PostalAddress: AddressType: BIZZ StreetName: Bank Street BuildingNumber: '11' Floor: '6' PostCode: Z78 4TY TownName: London Country: UK RegulatoryReporting: - DebitCreditReportingIndicator: CRED Authority: Name: Authority Name CountryCode: UK Details: - Type: CRED Date: '2024-09-16T10:25:28.422Z' Country: UK Amount: Amount: '165.88' Currency: USD Information: - Reg Info 1 - Reg Info 2 RemittanceInformation: Structured: - ReferredDocumentInformation: - Code: CINV Issuer: Issuer01 Number: Number_01 RelatedDate: '2024-09-16T10:25:28.422Z' LineDetails: - Line details 1 - Line details 2 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 SupplementaryData: additionalProp1: {} Authorisation: AuthorisationType: Any CompletionDateTime: '2024-09-16T10:25:28.444Z' SCASupportData: RequestedSCAExemptionType: EcommerceGoods AppliedAuthenticationApproach: SCA ReferencePaymentOrderId: O-611265 Debtor: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: ACME Inc SecondaryIdentification: '0002' LEI: 8200007YHFDMEODY1965 Risk: PaymentContextCode: BillingGoodsAndServicesInAdvance MerchantCategoryCode: stri MerchantCustomerIdentification: string ContractPresentIndicator: true BeneficiaryPrepopulatedIndicator: true PaymentPurposeCode: BKDF CategoryPurposeCode: BONU BeneficiaryAccountType: Business DeliveryAddress: AddressType: BIZZ Department: string SubDepartment: string StreetName: string BuildingNumber: string BuildingName: string Floor: string UnitNumber: string Room: string PostBox: string TownLocationName: string DistrictName: string CareOf: string PostCode: string TownName: string CountrySubDivision: string Country: HD AddressLine: - string Links: Self: https://api.alphabank.com/open-banking/v4.0/pisp/international-scheduled-payment-consents/58923 Meta: {} 201DomesticPaymentConsentsCreated: description: Domestic 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/OBWriteDomesticConsentResponse5' examples: create-domestic-payment-consent-response: value: Data: ConsentId: BARCLAYS-P-12345678901234 Status: AWAU StatusReason: - StatusReasonCode: U036 StatusReasonDescription: Waiting for completion of consent authorisation to be completed by user CutOffDateTime: '2017-07-05T15:15:22+00:00' ExpectedExecutionDateTime: '2017-06-05T15:15:22+00:00' ExpectedSettlementDateTime: '2017-06-06T15:15:22+00:00' CreationDateTime: '2017-06-05T15:15:13+00:00' StatusUpdateDateTime: '2017-06-05T15:15:13+00:00' ReadRefundAccount: 'Yes' Authorisation: AuthorisationType: Any CompletionDateTime: '2024-05-30T10:35:27Z' Charges: - ChargeBearer: Shared Type: UK.OBIE.CHAPSOut Amount: Amount: '0.88' Currency: GBP Initiation: InstructionIdentification: ACME412 EndToEndIdentification: FRESCO.21302.GFX.20 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: '441234012885' 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 CreditorPostalAddress: 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 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: UK 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: - 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 Risk: PaymentContextCode: EcommerceMerchantInitiatedPayment ContractPresentIndicator: false PaymentPurposeCode: EPAY CategoryPurposeCode: CASH BeneficiaryAccountType: Business MerchantCategoryCode: '7300' MerchantCustomerIdentification: 053598653254 DeliveryAddress: AddressLine: - Flat 7 - Acacia Lodge StreetName: Acacia Avenue BuildingNumber: '27' PostCode: GU31 2ZZ TownName: Sparsholt CountrySubDivision: Wessex Country: UK Links: Self: https://api.alphabank.com/open-banking/v4.0/pisp/domestic-payment-consents/58923 Meta: {} 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: 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 200InternationalPaymentConsentsConsentIdFundsConfirmationRead: description: International 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/OBWriteFundsConfirmationResponse1' examples: get-funds-conf-response: value: Data: FundsAvailableResult: FundsAvailableDateTime: '2019-05-03T08:40:08.481Z' FundsAvailable: true SupplementaryData: {} Links: Self: https://api.alphabank.com/open-banking/v4.0/pisp/domestic-scheduled-payments/7290-003 Meta: TotalPages: 0 FirstAvailableDateTime: '2019-05-03T08:40:08.481Z' LastAvailableDateTime: '2019-05-03T08:40:08.481Z' 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: {} 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: 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: 201DomesticScheduledPaymentsCreated: description: Domestic Scheduled 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/OBWriteDomesticScheduledResponse5' examples: create-dom-sched-pay-response: value: Data: DomesticScheduledPaymentId: 7290-003 ConsentId: BARCLAYS-P-12345678901234 Status: RCVD StatusReason: - StatusReasonCode: U030 StatusReasonDescription: Payment order successfully received CreationDateTime: '2018-05-05T15:15:13+00:00' StatusUpdateDateTime: '2018-05-05T15:15:13+00:00' ExpectedExecutionDateTime: '2018-06-05T15:15:22+00:00' ExpectedSettlementDateTime: '2018-06-06T15:15:22+00:00' Charges: - ChargeBearer: Shared Type: UK.OBIE.CHAPSOut Amount: Amount: '0.88' Currency: GBP Debtor: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: ACME Inc SecondaryIdentification: '0002' LEI: 8200007YHFDMEODY1965 MultiAuthorisation: Status: AUTH NumberRequired: 2 NumberReceived: 2 LastUpdateDateTime: '2018-06-05T15:15:13+00:00' ExpirationDateTime: '2018-06-06T15:15:13+00:00' Refund: Account: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325677 SecondaryIdentification: '0002' Name: NTPC Inc Initiation: InstructionIdentification: 89f0a53a91ee47f6a383536f851d6b5a RequestedExecutionDateTime: '2018-08-06T00:00:00+00:00' EndToEndIdentification: FRESCO.21302.GFX.20 LocalInstrument: UK.OBIE.Paym InstructedAmount: Amount: '200.00' Currency: GBP DebtorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '11280001234567' SecondaryIdentification: '0002' Name: Andrea Frost Proxy: Identification: '+441632960540' Code: TELE Type: Telephone CreditorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 SecondaryIdentification: 08098 Name: Tom Kirkman Proxy: Identification: '+441632960540' 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: 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 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: UK 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: - 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 Links: Self: https://api.alphabank.com/open-banking/v4.0/pisp/domestic-scheduled-payments/7290-003 Meta: {} 200InternationalScheduledPaymentConsentsConsentIdFundsConfirmationRead: description: International Scheduled 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/OBWriteFundsConfirmationResponse1' examples: get-int-sched-pay-consent-response: value: Data: FundsAvailableResult: FundsAvailableDateTime: '2017-06-05T15:15:23+00:00' FundsAvailable: true Links: Self: https://api.alphabank.com/open-banking/v4.0/pisp/international-scheduled-payment-consents/58923/funds-confirmation 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' 200InternationalPaymentsInternationalPaymentIdRead: description: International 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/OBWriteInternationalResponse5' examples: get-int-payments-response: value: Data: InternationalPaymentId: BARCLAYS-P-12345678901234 ConsentId: BARCLAYS-P-12345678901234 CreationDateTime: '2018-10-04T14:39:33.662Z' Status: ACCP StatusUpdateDateTime: '2018-10-04T14:39:33.662Z' ExpectedExecutionDateTime: '2018-10-04T14:39:33.662Z' ExpectedSettlementDateTime: '2018-10-04T14:39:33.662Z' Charges: - ChargeBearer: BorneByCreditor Type: UK.OBIE.CHAPSOut Amount: Amount: '15.00' Currency: GBP ExchangeRateInformation: UnitCurrency: INR ExchangeRate: 95 RateType: Actual ContractIdentification: FirstTransfer ExpirationDateTime: '2018-10-04T14:39:33.662Z' Initiation: InstructionIdentification: string EndToEndIdentification: LondonContri LocalInstrument: UK.OBIE.Target2 InstructionPriority: Normal ChargeBearer: BorneByCreditor CurrencyOfTransfer: GBP InstructedAmount: Amount: '1000.00' Currency: GBP ExchangeRateInformation: UnitCurrency: INR ExchangeRate: 95.25 RateType: Actual ContractIdentification: FirstTransfer DebtorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '12345678901234' Name: Self SecondaryIdentification: afdfg Creditor: Name: Self PostalAddress: AddressType: BIZZ Department: None SubDepartment: None StreetName: Zoo Road BuildingNumber: 13F PostCode: AB12CD TownName: Pune CountrySubDivision: string Country: IN AddressLine: - string CreditorAgent: SchemeName: UK.OBIE.IBAN Identification: US1231123123456790 Name: string PostalAddress: AddressType: BIZZ Department: Forex SubDepartment: Remittance StreetName: string BuildingNumber: '0' PostCode: ABC123D TownName: string CountrySubDivision: string Country: US AddressLine: - string CreditorAccount: SchemeName: UK.OBIE.IBAN Identification: AB1234567890123456 Name: AP SecondaryIdentification: string RemittanceInformation: Unstructured: - string MultiAuthorisation: Status: AUTH NumberRequired: 2 NumberReceived: 1 LastUpdateDateTime: '2018-10-04T14:39:33.662Z' ExpirationDateTime: '2018-10-04T14:39:33.662Z' Refund: Account: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: test Links: Self: https://api.alphabank.com/open-banking/v4.0/pisp/domestic-scheduled-payments/7290-003 Meta: TotalPages: 0 FirstAvailableDateTime: '2018-10-04T14:39:33.662Z' LastAvailableDateTime: '2018-10-04T14:39:33.662Z' 200DomesticPaymentConsentsConsentIdFundsConfirmationRead: description: Domestic 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/OBWriteFundsConfirmationResponse1' examples: get-fund-confirmation-response: value: Data: FundsAvailableResult: FundsAvailableDateTime: '2019-05-03T08:40:08.481Z' FundsAvailable: true SupplementaryData: {} Links: Self: https://www.example.org/self First: https://www.example.org/first Prev: https://www.example.org/prev Next: https://www.example.org/next Last: https://www.example.org/last Meta: TotalPages: 0 FirstAvailableDateTime: '2019-05-03T08:40:08.481Z' LastAvailableDateTime: '2019-05-03T08:40:08.481Z' 201InternationalPaymentsCreated: description: International 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/OBWriteInternationalResponse5' examples: create-int-payment-response: value: Data: InternationalPaymentId: BARCLAYS-P-12345678901234 ConsentId: BARCLAYS-P-12345678901234 CreationDateTime: '2018-10-04T14:39:33.662Z' Status: ACCP StatusUpdateDateTime: '2018-10-04T14:39:33.662Z' ExpectedExecutionDateTime: '2018-10-04T14:39:33.662Z' ExpectedSettlementDateTime: '2018-10-04T14:39:33.662Z' Charges: - ChargeBearer: BorneByCreditor Type: UK.OBIE.CHAPSOut Amount: Amount: '15.00' Currency: GBP ExchangeRateInformation: UnitCurrency: INR ExchangeRate: 95 RateType: Actual ContractIdentification: FirstTransfer ExpirationDateTime: '2018-10-04T14:39:33.662Z' Initiation: InstructionIdentification: string EndToEndIdentification: LondonContri LocalInstrument: UK.OBIE.Target2 InstructionPriority: Normal ChargeBearer: BorneByCreditor CurrencyOfTransfer: GBP InstructedAmount: Amount: '1000.00' Currency: GBP ExchangeRateInformation: UnitCurrency: INR ExchangeRate: 95.25 RateType: Actual ContractIdentification: FirstTransfer DebtorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '12345678901234' Name: Self SecondaryIdentification: afdfg Creditor: Name: Self PostalAddress: AddressType: BIZZ Department: None SubDepartment: None StreetName: Zoo Road BuildingNumber: 13F PostCode: AB12CD TownName: Pune CountrySubDivision: string Country: IN AddressLine: - string CreditorAgent: SchemeName: UK.OBIE.IBAN Identification: US1231123123456790 Name: string PostalAddress: AddressType: BIZZ Department: Forex SubDepartment: Remittance StreetName: string BuildingNumber: '0' PostCode: ABC123D TownName: string CountrySubDivision: string Country: US AddressLine: - string CreditorAccount: SchemeName: UK.OBIE.IBAN Identification: AB1234567890123456 Name: AP SecondaryIdentification: string RemittanceInformation: Unstructured: - string MultiAuthorisation: Status: AUTH NumberRequired: 2 NumberReceived: 1 LastUpdateDateTime: '2018-10-04T14:39:33.662Z' ExpirationDateTime: '2018-10-04T14:39:33.662Z' Refund: Account: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: test Links: Self: https://api.alphabank.com/open-banking/v4.0/pisp/domestic-scheduled-payments/7290-003 Meta: TotalPages: 0 FirstAvailableDateTime: '2018-10-04T14:39:33.662Z' LastAvailableDateTime: '2018-10-04T14:39:33.662Z' 200DomesticScheduledPaymentConsentsConsentIdRead: description: Domestic Scheduled 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/OBWriteDomesticScheduledConsentResponse5' examples: get-dom-sched-consent-response: value: Data: ConsentId: BARCLAYS-P-12345678901234 CreationDateTime: '2018-09-02T21:03:39.315Z' Status: AUTH StatusUpdateDateTime: '2018-09-02T21:03:39.315Z' Permission: Create CutOffDateTime: '2018-09-02T21:03:39.315Z' ExpectedExecutionDateTime: '2018-09-02T21:03:39.315Z' ExpectedSettlementDateTime: '2018-09-02T21:03:39.315Z' ReadRefundAccount: 'Yes' Charges: - ChargeBearer: BorneByCreditor Type: UK.OBIE.CHAPSOut Amount: Amount: '15.00' Currency: GBP Initiation: InstructionIdentification: string EndToEndIdentification: string LocalInstrument: UK.OBIE.BACS RequestedExecutionDateTime: '2018-09-02T21:03:39.315Z' InstructedAmount: Amount: '221.00' Currency: GBP DebtorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '12345678901234' Name: string SecondaryIdentification: string CreditorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '45678901234567' Name: string SecondaryIdentification: string CreditorPostalAddress: AddressType: BIZZ Department: string SubDepartment: string StreetName: string BuildingNumber: '123' PostCode: string TownName: string CountrySubDivision: string Country: UK AddressLine: - string RemittanceInformation: Unstructured: - string Authorisation: AuthorisationType: Any CompletionDateTime: '2018-09-02T21:03:39.315Z' Risk: PaymentContextCode: TransferToThirdParty MerchantCategoryCode: AMAZ MerchantCustomerIdentification: string DeliveryAddress: AddressLine: - string StreetName: string BuildingNumber: '90' PostCode: string TownName: string CountrySubDivision: CountrySubDivision1 Country: UK BeneficiaryPrepopulatedIndicator: true PaymentPurposeCode: EPAY BeneficiaryAccountType: BusinessSavingsAccount Links: Self: https://api.alphabank.com/open-banking/v4.0/pisp/domestic-scheduled-payments/7290-003 Meta: TotalPages: 0 FirstAvailableDateTime: '2018-10-05T12:46:49.163Z' LastAvailableDateTime: '2018-10-05T12:46:49.163Z' 201DomesticStandingOrdersCreated: description: Domestic Standing Orders 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/OBWriteDomesticStandingOrderResponse6' examples: create-dom-stand-order-response: value: Data: DomesticStandingOrderId: SO-SOC-100 ConsentId: BARCLAYS-P-12345678901234 CreationDateTime: '2024-09-15T21:04:07.370Z' Status: RCVD StatusUpdateDateTime: '2024-09-15T21:05:07.370Z' StatusReason: - StatusReasonCode: U030 StatusReasonDescription: Payment order successfully received Refund: Account: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325677 Name: NTPC Inc Charges: - ChargeBearer: Shared Type: UK.OBIE.CHAPSOut Amount: Amount: '0.80' Currency: GBP Initiation: RemittanceInformation: Structured: - ReferredDocumentInformation: - Code: CINV Issuer: Issuer01 Number: Number_01 RelatedDate: '2024-09-04T16:33:53.086Z' LineDetails: - Line Detail ReferredDocumentAmount: 1 CreditorReferenceInformation: Code: DISP Issuer: Issuer01 Reference: Pocket money for Damien Invoicer: INVR51856 Invoicee: INVE5161856 TaxRemittance: Tax Remittance related information AdditionalRemittanceInformation: - Free text for additional information Unstructured: - Internal ops code 5120101 FirstPaymentAmount: Amount: '7.00' Currency: GBP RecurringPaymentAmount: Amount: '7.00' Currency: GBP FinalPaymentAmount: Amount: '7.00' Currency: GBP DebtorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '11280001234567' Name: Andrea Smith SecondaryIdentification: '0002' Proxy: Identification: 07700900000 Code: TELE Type: Telephone CreditorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: Bob Clements SecondaryIdentification: '0002' Proxy: Identification: 07700900999 Code: TELE Type: Telephone 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: 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 RegulatoryReporting: - DebitCreditReportingIndicator: CRED Authority: Name: Authority Name CountryCode: GB Details: - Type: CRED Date: '2024-04-25T13:26:41.911Z' Country: GB Amount: Amount: '7.00' Currency: GBP Information: - Reg info1 - Reg info2 MandateRelatedInformation: MandateIdentification: SO003538282 Classification: FIXE CategoryPurposeCode: CASH FirstPaymentDateTime: '2024-09-04T16:33:53.087Z' FinalPaymentDateTime: '2025-09-04T16:33:53.087Z' Frequency: Type: DAIL CountPerPeriod: 1 Reason: Pocket Money MultiAuthorisation: Status: AUTH NumberRequired: 2 NumberReceived: 2 LastUpdateDateTime: '2024-09-15T21:05:07.371Z' ExpirationDateTime: '2024-09-15T21:06:07.371Z' Debtor: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: ACME Inc SecondaryIdentification: '0002' LEI: 8200007YHFDMEODY1965 Links: Self: https://api.alphabank.com/open-banking/v4.0/pisp/domestic-standing-orders/SO-SOC-100 Meta: {} 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 201InternationalScheduledPaymentsCreated: description: International Scheduled 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/OBWriteInternationalScheduledResponse6' examples: create-int-sched-payments-response: value: Data: InternationalScheduledPaymentId: BARCLAYS-P-12345678901234 ConsentId: BARCLAYS-P-12345678901234 CreationDateTime: '2018-10-05T05:32:21.233Z' Status: ACCP StatusUpdateDateTime: '2018-10-05T05:32:21.233Z' ExpectedExecutionDateTime: '2018-10-05T05:32:21.233Z' ExpectedSettlementDateTime: '2018-10-05T05:32:21.233Z' Charges: - ChargeBearer: BorneByCreditor Type: UK.OBIE.CHAPSOut Amount: Amount: '22.22' Currency: GBP ExchangeRateInformation: UnitCurrency: GBP ExchangeRate: 0 RateType: Actual ContractIdentification: string ExpirationDateTime: '2018-10-05T05:32:21.233Z' Initiation: InstructionIdentification: string EndToEndIdentification: string LocalInstrument: UK.OBIE.SWIFT InstructionPriority: Normal ChargeBearer: BorneByCreditor RequestedExecutionDateTime: '2018-09-19T11:03:57.587Z' CurrencyOfTransfer: USD InstructedAmount: Amount: '1000.00' Currency: GBP ExchangeRateInformation: UnitCurrency: GBP ExchangeRate: 88.1 RateType: Actual ContractIdentification: string DebtorAccount: SchemeName: UK.OBIE.IBAN Identification: IN34567890123456789012345678901234 Name: string SecondaryIdentification: string Creditor: Name: John Snow PostalAddress: AddressType: BIZZ Department: string SubDepartment: string StreetName: string BuildingNumber: '21' PostCode: string TownName: string CountrySubDivision: string Country: UK AddressLine: - string CreditorAgent: SchemeName: UK.OBIE.IBAN Identification: '12345678901234' Name: string PostalAddress: AddressType: BIZZ Department: string SubDepartment: string StreetName: string BuildingNumber: '23' PostCode: string TownName: string CountrySubDivision: string Country: IN AddressLine: - string CreditorAccount: SchemeName: UK.OBIE.IBAN Identification: IN34567890123456789012345678901234 Name: string SecondaryIdentification: string RemittanceInformation: Unstructured: - string MultiAuthorisation: Status: AUTH NumberRequired: 0 NumberReceived: 0 LastUpdateDateTime: '2018-10-05T05:32:21.233Z' ExpirationDateTime: '2018-10-05T05:32:21.233Z' Refund: Account: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: test Links: Self: https://api.alphabank.com/open-banking/v4.0/pisp/domestic-scheduled-payments/7290-003 Meta: TotalPages: 0 FirstAvailableDateTime: '2018-10-05T05:32:21.233Z' LastAvailableDateTime: '2018-10-05T05:32:21.233Z' 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: 200DomesticStandingOrdersDomesticStandingOrderIdRead: description: Domestic Standing Orders 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/OBWriteDomesticStandingOrderResponse6' examples: get-dom-stand-order-response: value: Data: DomesticStandingOrderId: BARCLAYS-P-12345678901234 ConsentId: BARCLAYS-P-12345678901234 CreationDateTime: '1976-01-01T06:06:06+00:00' Status: RCVD StatusUpdateDateTime: '1976-06-06T06:06:06+00:00' Initiation: FirstPaymentAmount: Amount: '6.66' Currency: GBP RecurringPaymentAmount: Amount: '7.00' Currency: GBP FinalPaymentAmount: Amount: '7.00' Currency: GBP DebtorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: '11280001234567' Name: Andrea Smith CreditorAccount: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: Bob Clements MandateRelatedInformation: MandateIdentification: SO003538282 Classification: FIXE CategoryPurposeCode: CASH FirstPaymentDateTime: '2024-09-04T16:33:53.087Z' FinalPaymentDateTime: '2025-09-04T16:33:53.087Z' Frequency: Type: DAIL CountPerPeriod: 1 Reason: Pocket Money Refund: Account: SchemeName: UK.OBIE.SortCodeAccountNumber Identification: 08080021325698 Name: test Links: Self: https://api.alphabank.com/open-banking/v3.0/domestic-standing-orders/SO-SOC-100 Meta: {} parameters: DomesticPaymentId: name: domesticPaymentId in: path description: DomesticPaymentId 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 InternationalStandingOrderPaymentId: name: internationalStandingOrderPaymentId in: path description: InternationalStandingOrderPaymentId required: true schema: type: string maxLength: 25 minLength: 1 pattern: ^BARCLAYS-P-\d{14}$ example: BARCLAYS-P-12345678901234 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 DomesticStandingOrderId: name: domesticStandingOrderId in: path description: DomesticStandingOrderId required: true schema: type: string maxLength: 25 minLength: 1 pattern: ^BARCLAYS-P-\d{14}$ example: BARCLAYS-P-12345678901234 InternationalPaymentId: name: internationalPaymentId in: path description: InternationalPaymentId required: true schema: type: string maxLength: 25 minLength: 1 pattern: ^BARCLAYS-P-\d{14}$ example: BARCLAYS-P-12345678901234 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 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-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 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 InternationalScheduledPaymentId: name: internationalScheduledPaymentId in: path description: InternationalScheduledPaymentId required: true schema: type: string maxLength: 25 minLength: 1 pattern: ^BARCLAYS-P-\d{14}$ example: BARCLAYS-P-12345678901234 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 DomesticScheduledPaymentId: name: domesticScheduledPaymentId in: path description: DomesticScheduledPaymentId required: true schema: type: string maxLength: 25 minLength: 1 pattern: ^BARCLAYS-P-\d{14}$ example: BARCLAYS-P-12345678901234 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