--- swagger: "2.0" info: x-ibm-name: ob-payment-initiation-v31 title: Payment Initiation V3 description: "This API provides the ability for authorised payment initiation service providers (PISPs, TPPs – third party providers) to initiate and set up new domestic, international and file based payments. The TPPs will be able to initiate requests directly from the customer’s (PSU- payment service user) current - personal or business - accounts, after being granted consent. Within Domestic Payments, Faster and CHAPS immediate payments can be initiated. This API is developed according to the Open Banking Read/Write API Specifications and fulfils PSD2 regulation, see https://www.openbanking.org.uk\n\n\n
\n**API Information**\n\n| Title | Payment Initiation V3 |\n|-----|-----|\n| Protocol | TLS-MA |\n| Open Banking Specification Version | 3.1 |\n| Access | Free to use but subscription is required |\n\n\n** Key Features:**\n-\tDomestic payments (in GBP)\n-\tDomestic scheduled payments (in GBP)\n-\tDomestic standing orders (in GBP)\n-\tInternational payments\n-\tFile payments (Domestic payments in GBP, File Status & Report File)\n\n
\n\n** Not in this version: **\n\n**_Domestic Payments_**\n\nSantander do not support the object \"Authorisation\" for the domestic-payment-consents endpoint. If a PISP consent request is received with this object, it will be rejected as a HTTP 400 BAD request.\n\n**_International Payments_**\n\nSantander do not support \"InstructionPriority\" for the international-payment-consents endpoint. If a PISP consent request is received with this, it will be rejected as a HTTP 400 BAD request.

\n\nSantander only support DebtorAccount/SchemeName equal to UK.OBIE.SortCodeAccountNumber or SortCodeAccountNumber for the international-payment-consents endpoint, when populated in the request. If a PISP consent request is received with a different DebtorAccount/SchemeName, (or with a DebtorAccount structure but the SchemeName value = NULL), it will be rejected as a HTTP 400 BAD request.

\n\nSantander only support a CreditorAgent/SchemeName of UK.OBIE.BICFI or BICFI for the international-payment-consents endpoint. If a PISP consent request is received with a different CreditorAgent/SchemeName, (or with UK.OBIE.BICFI or BICFI but further validations are not passed), it will be rejected as a HTTP 400 BAD request. A request for sending USD to US can provide the NCCCode and NCCIdentification in SupplementaryData instead of the CreditorAgent SchemeName and Identification (see below).

\n\nSantander only support an international payment request where the CreditorAccount/SchemeName is UK.OBIE.IBAN or UK.Santander.OtherAccount (or IBAN or OtherAccount) for the international-payment-consents endpoint. If a PISP consent request is received with a different CreditorAccount/SchemeName it will be rejected as a HTTP 400 BAD request.

\n\nPlease note that customers executing an international payment will not have visibility of personalised charges/final charges and exchange rates until the requested payment has been executed by Santander UK.

\n\nExecution of any SEPA payments for Corporate customers is not available.
\n\n**_File Payments_**\n\nSantander only supports Bulk Faster Payment File processing (1 debit for multiple credit payments) for SBBI & Corporate Business Customers. OB File Payments processing is not supported for Retail Santander customers (including Cahoot).

\nSantander will only support payment files uploaded in the 'UK.OBIE.PaymentInitiation.3.1' format. Any other type of file format uploaded will result in the file being rejected.

\nSantander will only accept domestic payments specified in the PaymentInitiation file that will be processed via faster payment scheme. The payments will need to have the LocalInstrument value set to ‘UK.OBIE.FPS’. Any other payment type will result in the file being rejected.

\nSantander does not currently support scheduled payments for domestic file payments processing.

\nSantander does not currently support multi-auth processing for BULK faster payments file processing.

\nSantander will not currently provide individual payment status details in the report-file for BULK file payments. \n\n** **" termsOfService: https://www.openbanking.org.uk/terms contact: name: Support Mailbox email: openbankingAPI@santander.co.uk license: name: Open Banking url: https://www.openbanking.org.uk/terms version: 3.1.19 basePath: /open-banking/v3.1/pisp schemes: - https consumes: - application/json; charset=utf-8 produces: - application/json; charset=utf-8 paths: /domestic-payment-consents: post: tags: - Domestic Payments summary: Create Domestic Payment Consents operationId: DPCPost parameters: - $ref: '#/parameters/OBWriteDomesticConsent2Param' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-idempotency-key' - $ref: '#/parameters/x-jws-signature-Param' - $ref: '#/parameters/x-customer-user-agent-Param' produces: - application/json; charset=utf-8 responses: 201: $ref: '#/responses/201DomesticPaymentConsentsCreated' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: description: "" 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 415: $ref: '#/responses/415ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - TPPOAuth2Security: - payments /domestic-payment-consents/{consent_id}: get: tags: - Domestic Payments summary: Get Domestic Payment Consents operationId: DPCGet parameters: - $ref: '#/parameters/consent_id' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-customer-user-agent-Param' produces: - application/json; charset=utf-8 responses: 200: $ref: '#/responses/200DomesticPaymentConsentsConsentIdRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: description: "" 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - TPPOAuth2Security: - payments /domestic-payment-consents/{consent_id}/funds-confirmation: get: tags: - Domestic Payments summary: Get Domestic Payment Consents Funds Confirmation operationId: DPCCoFGet parameters: - $ref: '#/parameters/consent_id' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-customer-user-agent-Param' produces: - application/json; charset=utf-8 responses: 200: $ref: '#/responses/200DomesticPaymentConsentsConsentIdFundsConfirmationRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: description: "" 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - PSUOAuth2Security: - payments /domestic-payments: post: tags: - Domestic Payments summary: Create Domestic Payments operationId: DPPost parameters: - $ref: '#/parameters/OBWriteDomestic2Param' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-idempotency-key' - $ref: '#/parameters/x-jws-signature-Param' - $ref: '#/parameters/x-customer-user-agent-Param' produces: - application/json; charset=utf-8 responses: 201: $ref: '#/responses/201DomesticPaymentsCreated' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: description: "" 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 415: $ref: '#/responses/415ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - PSUOAuth2Security: - payments /domestic-payments/{domestic_payment_id}: get: tags: - Domestic Payments summary: Get Domestic Payments operationId: DPGet parameters: - $ref: '#/parameters/domestic_payment_id' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-customer-user-agent-Param' produces: - application/json; charset=utf-8 responses: 200: $ref: '#/responses/200DomesticPaymentsDomesticPaymentIdRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: description: "" 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - PSUOAuth2Security: - payments TPPOAuth2Security: - payments /domestic-scheduled-payment-consents: post: tags: - Domestic Scheduled Payments summary: Create Domestic Scheduled Payment Consents operationId: DSPCPost parameters: - $ref: '#/parameters/OBWriteDomesticScheduledConsent2Param' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-idempotency-key' - $ref: '#/parameters/x-jws-signature-Param' - $ref: '#/parameters/x-customer-user-agent-Param' produces: - application/json; charset=utf-8 responses: 201: $ref: '#/responses/201DomesticScheduledPaymentConsentsCreated' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 415: $ref: '#/responses/415ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - TPPOAuth2Security: - payments /domestic-scheduled-payment-consents/{consent_id}: get: tags: - Domestic Scheduled Payments summary: Get Domestic Scheduled Payment Consents operationId: DSPCGet parameters: - $ref: '#/parameters/consent_id' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-customer-user-agent-Param' produces: - application/json; charset=utf-8 responses: 200: $ref: '#/responses/200DomesticScheduledPaymentConsentsConsentIdRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - TPPOAuth2Security: - payments /domestic-scheduled-payments: post: tags: - Domestic Scheduled Payments summary: Create Domestic Scheduled Payments operationId: DSPPost parameters: - $ref: '#/parameters/OBWriteDomesticScheduled2Param' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-idempotency-key' - $ref: '#/parameters/x-jws-signature-Param' - $ref: '#/parameters/x-customer-user-agent-Param' produces: - application/json; charset=utf-8 responses: 201: $ref: '#/responses/201DomesticScheduledPaymentsCreated' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 415: $ref: '#/responses/415ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - PSUOAuth2Security: - payments /domestic-scheduled-payments/{domestic_scheduled_payment_id}: get: tags: - Domestic Scheduled Payments summary: Get Domestic Scheduled Payments operationId: DSPGet parameters: - $ref: '#/parameters/domestic_scheduled_payment_id' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-customer-user-agent-Param' produces: - application/json; charset=utf-8 responses: 200: $ref: '#/responses/200DomesticScheduledPaymentsDomesticScheduledPaymentIdRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - PSUOAuth2Security: - payments TPPOAuth2Security: - payments /domestic-standing-order-consents: post: tags: - Domestic Standing Orders summary: Create Domestic Standing Order Consents operationId: DSOCPost parameters: - $ref: '#/parameters/OBWriteDomesticStandingOrderConsent2Param' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-idempotency-key' - $ref: '#/parameters/x-jws-signature-Param' - $ref: '#/parameters/x-customer-user-agent-Param' produces: - application/json; charset=utf-8 responses: 201: $ref: '#/responses/201DomesticStandingOrderConsentsCreated' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 415: $ref: '#/responses/415ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - TPPOAuth2Security: - payments /domestic-standing-order-consents/{consent_id}: get: tags: - Domestic Standing Orders summary: Get Domestic Standing Order Consents operationId: DSOCGet parameters: - $ref: '#/parameters/consent_id' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-customer-user-agent-Param' produces: - application/json; charset=utf-8 responses: 200: $ref: '#/responses/200DomesticStandingOrderConsentsConsentIdRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - TPPOAuth2Security: - payments /domestic-standing-orders: post: tags: - Domestic Standing Orders summary: Create Domestic Standing Orders operationId: DSOPost parameters: - $ref: '#/parameters/OBWriteDomesticStandingOrder2Param' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-idempotency-key' - $ref: '#/parameters/x-jws-signature-Param' - $ref: '#/parameters/x-customer-user-agent-Param' produces: - application/json; charset=utf-8 responses: 201: $ref: '#/responses/201DomesticStandingOrdersCreated' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 415: $ref: '#/responses/415ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - PSUOAuth2Security: - payments /domestic-standing-orders/{domestic_standing_order_id}: get: tags: - Domestic Standing Orders summary: Get Domestic Standing Orders operationId: DSOGet parameters: - $ref: '#/parameters/domestic_standing_order_id' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-customer-user-agent-Param' produces: - application/json; charset=utf-8 responses: 200: $ref: '#/responses/200DomesticStandingOrdersDomesticStandingOrderIdRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - PSUOAuth2Security: - payments TPPOAuth2Security: - payments /international-payment-consents: post: tags: - International Payments summary: Create International Payment Consents operationId: IPCPost parameters: - $ref: '#/parameters/OBWriteInternationalConsent2Param' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-idempotency-key' - $ref: '#/parameters/x-jws-signature-Param' - $ref: '#/parameters/x-customer-user-agent-Param' produces: - application/json; charset=utf-8 responses: 201: $ref: '#/responses/201InternationalPaymentConsentsCreated' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 415: $ref: '#/responses/415ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - TPPOAuth2Security: - payments /international-payment-consents/{consent_id}: get: tags: - International Payments summary: Get International Payment Consents operationId: IPCGet parameters: - $ref: '#/parameters/consent_id' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-customer-user-agent-Param' produces: - application/json; charset=utf-8 responses: 200: $ref: '#/responses/200InternationalPaymentConsentsConsentIdRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - TPPOAuth2Security: - payments /international-payment-consents/{consent_id}/funds-confirmation: get: tags: - International Payments summary: Get International Payment Consents Funds Confirmation operationId: IPCCoFGet parameters: - $ref: '#/parameters/consent_id' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-customer-user-agent-Param' produces: - application/json; charset=utf-8 responses: 200: $ref: '#/responses/200InternationalPaymentConsentsConsentIdFundsConfirmationRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: description: "" 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - PSUOAuth2Security: - payments /international-payments: post: tags: - International Payments summary: Create International Payments operationId: IPPost parameters: - $ref: '#/parameters/OBWriteInternational2Param' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-idempotency-key' - $ref: '#/parameters/x-jws-signature-Param' - $ref: '#/parameters/x-customer-user-agent-Param' produces: - application/json; charset=utf-8 responses: 201: $ref: '#/responses/201InternationalPaymentsCreated' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 415: $ref: '#/responses/415ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - PSUOAuth2Security: - payments /international-payments/{international_payment_id}: get: tags: - International Payments summary: Get International Payments operationId: IPGet parameters: - $ref: '#/parameters/international_payment_id' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-customer-user-agent-Param' produces: - application/json; charset=utf-8 responses: 200: $ref: '#/responses/200InternationalPaymentsInternationalPaymentIdRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - TPPOAuth2Security: - payments /file-payment-consents: post: tags: - File Payments summary: Create File Payment Consents operationId: FPCPost parameters: - $ref: '#/parameters/OBWriteFileConsent2Param' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-idempotency-key' - $ref: '#/parameters/x-jws-signature-Param' - $ref: '#/parameters/x-customer-user-agent-Param' produces: - application/json; charset=utf-8 responses: 201: $ref: '#/responses/201FilePaymentConsentsCreated' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 415: $ref: '#/responses/415ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - TPPOAuth2Security: - payments /file-payment-consents/{consent_id}: get: tags: - File Payments summary: Get File Payment Consents operationId: FPCGet parameters: - $ref: '#/parameters/consent_id' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-customer-user-agent-Param' produces: - application/json; charset=utf-8 responses: 200: $ref: '#/responses/200FilePaymentConsentsConsentIdRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - TPPOAuth2Security: - payments /file-payment-consents/{consent_id}/file: post: tags: - File Payments summary: Create File Payment Consents operationId: FPCFilePost parameters: - $ref: '#/parameters/FileParam' - $ref: '#/parameters/consent_id' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-idempotency-key' - $ref: '#/parameters/x-jws-signature-Param' - $ref: '#/parameters/x-customer-user-agent-Param' consumes: - '*/*' produces: - application/json; charset=utf-8 responses: 200: $ref: '#/responses/200FilePaymentConsentsConsentIdFileCreated' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 415: $ref: '#/responses/415ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - TPPOAuth2Security: - payments get: tags: - File Payments summary: Get File Payment Consents operationId: FPCFileGet parameters: - $ref: '#/parameters/consent_id' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-customer-user-agent-Param' produces: - '*/*' responses: 200: $ref: '#/responses/200FilePaymentConsentsConsentIdFileRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - TPPOAuth2Security: - payments /file-payments: post: tags: - File Payments summary: Create File Payments operationId: FPPost parameters: - $ref: '#/parameters/OBWriteFile2Param' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-idempotency-key' - $ref: '#/parameters/x-jws-signature-Param' - $ref: '#/parameters/x-customer-user-agent-Param' produces: - application/json; charset=utf-8 responses: 201: $ref: '#/responses/201FilePaymentsCreated' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 415: $ref: '#/responses/415ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - PSUOAuth2Security: - payments /file-payments/{file_payment_id}: get: tags: - File Payments summary: Get File Payments operationId: FPGet parameters: - $ref: '#/parameters/file_payment_id' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-customer-user-agent-Param' produces: - application/json; charset=utf-8 responses: 200: $ref: '#/responses/200FilePaymentsFilePaymentIdRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - TPPOAuth2Security: - payments /file-payments/{file_payment_id}/report-file: get: tags: - File Payments summary: Get File Payments operationId: FPReportGet parameters: - $ref: '#/parameters/file_payment_id' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/Authorization' - $ref: '#/parameters/x-customer-user-agent-Param' produces: - '*/*' responses: 200: $ref: '#/responses/200FilePaymentsFilePaymentIdReportFileRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - TPPOAuth2Security: - payments parameters: 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 type: string pattern: ^(?!\s)(.*)(\S)$ maxLength: 40 x-fapi-financial-id-Param: in: header name: x-fapi-financial-id type: string required: true description: The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB. x-fapi-customer-ip-address-Param: in: header name: x-fapi-customer-ip-address type: string required: false description: The PSU's IP address if the PSU is currently logged in with the TPP. x-fapi-interaction-id-Param: in: header name: x-fapi-interaction-id type: string required: false description: An RFC4122 UID used as a correlation id. x-fapi-customer-last-logged-time-Param: in: header name: x-fapi-customer-last-logged-time type: string required: false description: "The time when the PSU last logged in with the TPP. \nAll dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: \nSun, 10 Sep 2017 19:43:31 UTC" 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)$ Authorization: in: header name: Authorization type: string required: true description: An Authorisation Token as per https://tools.ietf.org/html/rfc6750 x-jws-signature-Param: in: header name: x-jws-signature type: string required: true description: A detached JWS signature of the body of the payload. OBWriteDomesticStandingOrderConsent2Param: name: OBWriteDomesticStandingOrderConsent2Param in: body description: Default required: true schema: $ref: '#/definitions/OBWriteDomesticStandingOrderConsent2' consent_id: name: consent_id in: path description: consent_id required: true type: string OBWriteDomesticStandingOrder2Param: name: OBWriteDomesticStandingOrder2Param in: body description: Default required: true schema: $ref: '#/definitions/OBWriteDomesticStandingOrder2' domestic_standing_order_id: name: domestic_standing_order_id in: path description: domestic_standing_order_id required: true type: string OBWriteDomesticConsent2Param: name: OBWriteDomesticConsent2Param in: body description: Default required: true schema: $ref: '#/definitions/OBWriteDomesticConsent2' OBWriteDomestic2Param: name: OBWriteDomestic2Param in: body description: Default required: true schema: $ref: '#/definitions/OBWriteDomestic2' domestic_payment_id: name: domestic_payment_id in: path description: domestic_payment_id required: true type: string OBWriteDomesticScheduledConsent2Param: name: OBWriteDomesticScheduledConsent2Param in: body description: Default required: true schema: $ref: '#/definitions/OBWriteDomesticScheduledConsent2' OBWriteDomesticScheduled2Param: name: OBWriteDomesticScheduled2Param in: body description: Default required: true schema: $ref: '#/definitions/OBWriteDomesticScheduled2' domestic_scheduled_payment_id: name: domestic_scheduled_payment_id in: path description: domestic_scheduled_payment_id required: true type: string x-customer-user-agent-Param: in: header name: x-customer-user-agent type: string description: Indicates the user-agent that the PSU is using. required: false x-fapi-auth-date: in: header name: x-fapi-auth-date type: string required: false description: "The time when the PSU last logged in with the TPP. \nAll dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: \nSun, 10 Sep 2017 19:43:31 UTC" 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)$ OBWriteFileConsent2Param: name: OBWriteFileConsent2Param in: body description: Default required: true schema: $ref: '#/definitions/OBWriteFileConsent2' FileParam: name: FileParam in: body description: Default required: true schema: $ref: '#/definitions/File' OBWriteFile2Param: name: OBWriteFile2Param in: body description: Default required: true schema: $ref: '#/definitions/OBWriteFile2' file_payment_id: name: file_payment_id in: path description: FilePaymentId required: true type: string OBWriteInternationalConsent2Param: name: OBWriteInternationalConsent2Param in: body description: Default required: true schema: $ref: '#/definitions/OBWriteInternationalConsent2' OBWriteInternational2Param: name: OBWriteInternational2Param in: body description: Default required: true schema: $ref: '#/definitions/OBWriteInternational2' international_payment_id: name: international_payment_id in: path description: InternationalPaymentId required: true type: string OBWriteInternationalScheduledConsent3Param: name: OBWriteInternationalScheduledConsent3Param in: body description: Default required: true schema: $ref: '#/definitions/OBWriteInternationalScheduledConsent3' OBWriteInternationalScheduled2Param: name: OBWriteInternationalScheduled2Param in: body description: Default required: true schema: $ref: '#/definitions/OBWriteInternationalScheduled2' international_scheduled_payment_id: name: international_scheduled_payment_id in: path description: InternationalScheduledPaymentId required: true type: string responses: 201DomesticStandingOrderConsentsCreated: description: Domestic Standing Order Consents Created headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteDomesticStandingOrderConsentResponse2' 200DomesticStandingOrderConsentsConsentIdRead: description: Domestic Standing Order Consents Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteDomesticStandingOrderConsentResponse2' 201DomesticStandingOrdersCreated: description: Domestic Standing Orders Created headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteDomesticStandingOrderResponse2' 200DomesticStandingOrdersDomesticStandingOrderIdRead: description: Domestic Standing Orders Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteDomesticStandingOrderResponse2' 201DomesticPaymentConsentsCreated: description: Domestic Payment Consents Created headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteDomesticConsentResponse2' 200DomesticPaymentConsentsConsentIdRead: description: Domestic Payment Consents Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteDomesticConsentResponse2' 201DomesticPaymentsCreated: description: Domestic Payments Created headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteDomesticResponse2' 200DomesticPaymentsDomesticPaymentIdRead: description: Domestic Payments Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteDomesticResponse2' 201DomesticScheduledPaymentConsentsCreated: description: Domestic Scheduled Payment Consents Created headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteDomesticScheduledConsentResponse2' 200DomesticScheduledPaymentConsentsConsentIdRead: description: Domestic Scheduled Payment Consents Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteDomesticScheduledConsentResponse2' 201DomesticScheduledPaymentsCreated: description: Domestic Scheduled Payments Created headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteDomesticScheduledResponse2' 200DomesticScheduledPaymentsDomesticScheduledPaymentIdRead: description: Domestic Scheduled Payments Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteDomesticScheduledResponse2' 200DomesticPaymentConsentsConsentIdFundsConfirmationRead: description: Domestic Payment Consents Funds Confirmation Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteFundsConfirmationResponse1' 200InternationalPaymentConsentsConsentIdFundsConfirmationRead: description: International Payment Consents Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteFundsConfirmationResponse1' 201FilePaymentConsentsCreated: description: File Payment Consents Created headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteFileConsentResponse2' 200FilePaymentConsentsConsentIdFileCreated: description: File Payment Consents Created headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. 200FilePaymentConsentsConsentIdRead: description: File Payment Consents Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteFileConsentResponse2' 200FilePaymentConsentsConsentIdFileRead: description: File Payment Consents Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/File' 201FilePaymentsCreated: description: File Payments Created headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteFileResponse2' 200FilePaymentsFilePaymentIdRead: description: File Payments Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteFileResponse2' 200FilePaymentsFilePaymentIdReportFileRead: description: File Payments Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/File' 201InternationalPaymentConsentsCreated: description: International Payment Consents Created headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteInternationalConsentResponse2' 200InternationalPaymentConsentsConsentIdRead: description: International Payment Consents Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteInternationalConsentResponse2' 201InternationalPaymentsCreated: description: International Payments Created headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteInternationalResponse2' 200InternationalPaymentsInternationalPaymentIdRead: description: International Payments Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteInternationalResponse2' 201InternationalScheduledPaymentConsentsCreated: description: International Scheduled Payment Consents Created headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: | Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteInternationalScheduledConsentResponse3' 200InternationalScheduledPaymentConsentsConsentIdRead: description: International Scheduled Payment Consents Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: | Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteInternationalScheduledConsentResponse3' 201InternationalScheduledPaymentsCreated: description: International Scheduled Payments Created headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: | Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteInternationalScheduledResponse3' 200InternationalScheduledPaymentsInternationalScheduledPaymentIdRead: description: International Scheduled Payments Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: | Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWriteInternationalScheduledResponse3' 200InternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetailsRead: description: Payment Details Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. x-jws-signature: type: string description: | Header containing a detached JWS signature of the body of the payload. schema: $ref: '#/definitions/OBWritePaymentDetailsResponse1' 400ErrorResponse: description: Bad request schema: $ref: '#/definitions/OBErrorResponse1' 401ErrorResponse: description: Unauthorized 403ErrorResponse: description: Forbidden 404ErrorResponse: description: Not found 405ErrorResponse: description: Method Not Allowed 406ErrorResponse: description: Not Acceptable 415ErrorResponse: description: Unsupported Media Type 429ErrorResponse: description: Too Many Requests headers: Retry-After: description: Number in seconds to wait type: integer 500ErrorResponse: description: Internal Server Error schema: $ref: '#/definitions/OBErrorResponse1' definitions: ActiveOrHistoricCurrencyCode: description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". type: string pattern: ^[A-Z]{3,3}$ OBActiveCurrencyAndAmount_SimpleType: description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. type: string pattern: ^\d{1,13}\.\d{1,5}$ OBActiveOrHistoricCurrencyAndAmount: type: object required: - Amount - Currency description: Amount of money associated with the charge type. properties: Amount: $ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/definitions/ActiveOrHistoricCurrencyCode' OBAddressTypeCode: description: Identifies the nature of the postal address. type: string enum: - Business - Correspondence - DeliveryTo - MailTo - POBox - Postal - Residential - Statement OBAuthorisation1: description: The authorisation type request from the TPP. type: object properties: AuthorisationType: $ref: '#/definitions/OBExternalAuthorisation1Code' CompletionDateTime: description: "Date and time at which the requested authorisation flow must be completed.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time required: - AuthorisationType additionalProperties: false OBChargeBearerType1Code: description: Specifies which party/parties will bear the charges associated with the processing of the payment transaction. type: string enum: - BorneByCreditor - BorneByDebtor - FollowingServiceLevel - Shared OBDomesticScheduled2: 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. type: object properties: InstructionIdentification: description: |- Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction. type: string minLength: 1 maxLength: 35 EndToEndIdentification: description: |- Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field. type: string minLength: 1 maxLength: 35 LocalInstrument: $ref: '#/definitions/OBExternalLocalInstrument1Code' RequestedExecutionDateTime: description: "Date at which the initiating party requests the clearing agent to process the payment. \nUsage: This is the date on which the debtor's account is to be debited.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time InstructedAmount: type: object properties: Amount: $ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType' Currency: type: string pattern: ^[A-Z]{3,3}$ required: - Amount - Currency 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. DebtorAccount: $ref: '#/definitions/OBCashAccountDebtor4' CreditorAccount: $ref: '#/definitions/OBCashAccountCreditor3' CreditorPostalAddress: $ref: '#/definitions/OBPostalAddress6' RemittanceInformation: $ref: '#/definitions/OBRemittanceInformation1' SupplementaryData: $ref: '#/definitions/OBSupplementaryData1' required: - InstructionIdentification - RequestedExecutionDateTime - InstructedAmount - CreditorAccount additionalProperties: false OBDomesticStandingOrder2: 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. type: object properties: Frequency: description: "Individual Definitions:\nEvryDay - Every day\nEvryWorkgDay - Every working day\nIntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)\nWkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07)\nIntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31)\nQtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). \nENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. \nSCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November.\nRECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. \nIndividual Patterns:\nEvryDay (ScheduleCode)\nEvryWorkgDay (ScheduleCode)\nIntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)\nWkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)\nIntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)\nQtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay\nThe regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:\nEvryDay\nEvryWorkgDay\nIntrvlWkDay:0[1-9]:0[1-7]\nWkInMnthDay:0[1-5]:0[1-7]\nIntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])\nQtrDay:(ENGLISH|SCOTTISH|RECEIVED)\nFull Regular Expression:\n^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$" type: string minLength: 1 maxLength: 35 pattern: ^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$ Reference: description: |- Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. type: string minLength: 1 maxLength: 35 NumberOfPayments: description: Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date. type: string minLength: 1 maxLength: 35 FirstPaymentDateTime: description: "The date on which the first payment for a Standing Order schedule will be made.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time RecurringPaymentDateTime: 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.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time FinalPaymentDateTime: description: "The date on which the final payment for a Standing Order schedule will be made.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time FirstPaymentAmount: type: object properties: Amount: $ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType' Currency: type: string pattern: ^[A-Z]{3,3}$ required: - Amount - Currency additionalProperties: false description: The amount of the first Standing Order RecurringPaymentAmount: type: object properties: Amount: $ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType' Currency: type: string pattern: ^[A-Z]{3,3}$ required: - Amount - Currency additionalProperties: false description: The amount of the recurring Standing Order FinalPaymentAmount: type: object properties: Amount: $ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType' Currency: type: string pattern: ^[A-Z]{3,3}$ required: - Amount - Currency additionalProperties: false description: The amount of the final Standing Order DebtorAccount: $ref: '#/definitions/OBCashAccountDebtor4' CreditorAccount: $ref: '#/definitions/OBCashAccountCreditor3' SupplementaryData: $ref: '#/definitions/OBSupplementaryData1' required: - Frequency - FirstPaymentDateTime - FirstPaymentAmount - CreditorAccount additionalProperties: false OBSupplementaryData1: description: Additional information that can not be captured in the structured fields and/or any other specific block. type: object properties: [] additionalProperties: false OBExternalAccountIdentification4Code: description: Name of the identification scheme, in a coded form as published in an external list. type: string example: - UK.OBIE.BBAN - UK.OBIE.IBAN - UK.OBIE.PAN - UK.OBIE.Paym - UK.OBIE.SortCodeAccountNumber minLength: 1 maxLength: 40 OBCashAccountDebtor4: description: Provides the details to identify the debtor account. type: object properties: SchemeName: $ref: '#/definitions/OBExternalAccountIdentification4Code' Identification: description: Identification assigned by an institution to identify an account. This identification is known by the account owner. type: string minLength: 1 maxLength: 256 Name: description: |- Name 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. type: string minLength: 1 maxLength: 70 SecondaryIdentification: $ref: '#/definitions/SecondaryIdentification' required: - SchemeName - Identification additionalProperties: false OBCashAccountCreditor3: description: Provides the details to identify the beneficiary account. type: object properties: SchemeName: $ref: '#/definitions/OBExternalAccountIdentification4Code' Identification: description: Identification assigned by an institution to identify an account. This identification is known by the account owner. type: string minLength: 1 maxLength: 256 Name: description: |- Name of the account, as assigned by the account servicing institution. Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. type: string minLength: 1 maxLength: 70 SecondaryIdentification: $ref: '#/definitions/SecondaryIdentification' required: - SchemeName - Identification - Name additionalProperties: false OBExternalAuthorisation1Code: description: Type of authorisation flow requested. type: string enum: - Any - Single OBExternalConsentStatus1Code: description: Specifies the status of resource in code form. type: string enum: - Authorised - AwaitingAuthorisation - Consumed - Rejected OBExternalPaymentContext1Code: description: Specifies the payment context type: string enum: - BillPayment - EcommerceGoods - EcommerceServices - Other - PartyToParty OBExternalPermissions2Code: description: Specifies the Open Banking service request types. type: string enum: - Create OBExternalStatus1Code: description: Specifies the status of resource in code form. type: string enum: - InitiationCompleted - InitiationFailed - InitiationPending OBExternalStatus2Code: description: Specifies the status of the authorisation flow in code form. type: string enum: - Authorised - AwaitingFurtherAuthorisation - Rejected OBMultiAuthorisation1: description: The multiple authorisation flow response from the ASPSP. type: object properties: Status: $ref: '#/definitions/OBExternalStatus2Code' NumberRequired: description: Number of authorisations required for payment order (total required at the start of the multi authorisation journey). type: integer format: int32 NumberReceived: description: Number of authorisations required for payment order (total required at the start of the multi authorisation journey). type: integer format: int32 LastUpdateDateTime: description: "Last date and time at the authorisation flow was updated.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time ExpirationDateTime: description: "Date and time at which the requested authorisation flow must be completed.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time required: - Status additionalProperties: false OBPostalAddress6: description: Information that locates and identifies a specific address, as defined by postal services. type: object properties: AddressType: $ref: '#/definitions/OBAddressTypeCode' Department: description: Identification of a division of a large organisation or building. type: string minLength: 1 maxLength: 70 SubDepartment: description: Identification of a sub-division of a large organisation or building. type: string minLength: 1 maxLength: 70 StreetName: description: Name of a street or thoroughfare. type: string minLength: 1 maxLength: 70 BuildingNumber: description: Number that identifies the position of a building on a street. type: string minLength: 1 maxLength: 16 PostCode: description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. type: string minLength: 1 maxLength: 16 TownName: description: Name of a built-up area, with defined boundaries, and a local government. type: string minLength: 1 maxLength: 35 CountrySubDivision: description: Identifies a subdivision of a country such as state, region, county. type: string minLength: 1 maxLength: 35 Country: description: Nation with its own government. type: string pattern: ^[A-Z]{2,2}$ AddressLine: items: type: string minLength: 1 maxLength: 70 type: array description: Information that locates and identifies a specific address, as defined by postal services, presented in free format text. minItems: 0 maxItems: 7 additionalProperties: false OBPriority2Code: description: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. type: string enum: - Normal - Urgent OBExchangeRate1: description: Provides details on the currency exchange rate and contract. type: object properties: UnitCurrency: description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. type: string pattern: ^[A-Z]{3,3}$ ExchangeRate: description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. type: number RateType: $ref: '#/definitions/OBExchangeRateType2Code' ContractIdentification: description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. type: string minLength: 1 maxLength: 256 required: - UnitCurrency - RateType additionalProperties: false OBExchangeRate2: description: Further detailed information on the exchange rate that has been used in the payment transaction. type: object properties: UnitCurrency: description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. type: string pattern: ^[A-Z]{3,3}$ ExchangeRate: description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. type: number RateType: $ref: '#/definitions/OBExchangeRateType2Code' ContractIdentification: description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. type: string minLength: 1 maxLength: 256 ExpirationDateTime: description: "Specified date and time the exchange rate agreement will expire.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time required: - UnitCurrency - ExchangeRate - RateType additionalProperties: false OBExchangeRateType2Code: description: Specifies the type used to complete the currency exchange. type: string enum: - Actual - Agreed - Indicative OBExternalFinancialInstitutionIdentification4Code: description: Name of the identification scheme, in a coded form as published in an external list. type: string example: - UK.OBIE.BICFI minLength: 1 maxLength: 40 OBBranchAndFinancialInstitutionIdentification6: 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. type: object properties: SchemeName: $ref: '#/definitions/OBExternalFinancialInstitutionIdentification4Code' Identification: description: Unique and unambiguous identification of the servicing institution. type: string minLength: 1 maxLength: 35 Name: description: Name by which an agent is known and which is usually used to identify that agent. type: string minLength: 1 maxLength: 140 PostalAddress: $ref: '#/definitions/OBPostalAddress6' additionalProperties: false OBPartyIdentification43: description: Party to which an amount of money is due. type: object properties: Name: description: Name by which a party is known and which is usually used to identify that party. type: string minLength: 1 maxLength: 140 PostalAddress: $ref: '#/definitions/OBPostalAddress6' additionalProperties: false OBExternalPurpose1Code1: description: |- Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org. type: string minLength: 1 maxLength: 4 OBRemittanceInformation1: 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. type: object properties: Unstructured: 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. type: string minLength: 1 maxLength: 140 Reference: description: |- Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped. type: string minLength: 1 maxLength: 35 additionalProperties: false OBRisk1: 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. type: object properties: PaymentContextCode: $ref: '#/definitions/OBExternalPaymentContext1Code' MerchantCategoryCode: description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. type: string minLength: 3 maxLength: 4 MerchantCustomerIdentification: description: The unique customer identifier of the PSU with the merchant. type: string minLength: 1 maxLength: 70 DeliveryAddress: description: Information that locates and identifies a specific address, as defined by postal services or in free format text. type: object properties: AddressLine: items: type: string minLength: 1 maxLength: 70 type: array description: Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text. minItems: 0 maxItems: 2 StreetName: description: Name of a street or thoroughfare. type: string minLength: 1 maxLength: 70 BuildingNumber: description: Number that identifies the position of a building on a street. type: string minLength: 1 maxLength: 16 PostCode: description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. type: string minLength: 1 maxLength: 16 TownName: description: Name of a built-up area, with defined boundaries, and a local government. type: string minLength: 1 maxLength: 35 CountrySubDivision: items: type: string minLength: 1 maxLength: 35 type: array description: Identifies a subdivision of a country, for instance state, region, county. minItems: 0 maxItems: 2 Country: description: Nation with its own government, occupying a particular territory. type: string pattern: ^[A-Z]{2,2}$ required: - TownName - Country additionalProperties: false additionalProperties: false OBTransactionIndividualStatus1Code: description: Specifies the status of the payment information group. type: string enum: - AcceptedSettlementCompleted - AcceptedSettlementInProcess - Pending - Rejected OBWriteDataDomestic2: type: object properties: ConsentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' type: string minLength: 1 maxLength: 128 Initiation: $ref: '#/definitions/OBDomestic2' required: - ConsentId - Initiation additionalProperties: false OBWriteDataDomesticConsent2: type: object properties: Initiation: $ref: '#/definitions/OBDomestic2' Authorisation: $ref: '#/definitions/OBAuthorisation1' required: - Initiation additionalProperties: false OBDomestic2: 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. type: object properties: InstructionIdentification: description: |- Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction. type: string minLength: 1 maxLength: 35 EndToEndIdentification: description: |- Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field. type: string minLength: 1 maxLength: 35 LocalInstrument: $ref: '#/definitions/OBExternalLocalInstrument1Code' InstructedAmount: type: object properties: Amount: $ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType' Currency: type: string pattern: ^[A-Z]{3,3}$ required: - Amount - Currency 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. DebtorAccount: $ref: '#/definitions/OBCashAccountDebtor4' CreditorAccount: $ref: '#/definitions/OBCashAccountCreditor3' CreditorPostalAddress: $ref: '#/definitions/OBPostalAddress6' RemittanceInformation: $ref: '#/definitions/OBRemittanceInformation1' SupplementaryData: $ref: '#/definitions/OBSupplementaryData1' required: - InstructionIdentification - EndToEndIdentification - InstructedAmount - CreditorAccount additionalProperties: false OBWriteDataDomesticConsentResponse2: type: object properties: ConsentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' type: string minLength: 1 maxLength: 128 CreationDateTime: description: "Date and time at which the resource was created.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Status: $ref: '#/definitions/OBExternalConsentStatus1Code' StatusUpdateDateTime: description: "Date and time at which the resource status was updated.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time CutOffDateTime: description: "Specified cut-off date and time for the payment consent.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time ExpectedExecutionDateTime: description: "Expected execution date and time for the payment resource.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time ExpectedSettlementDateTime: description: "Expected settlement date and time for the payment resource.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Charges: items: $ref: '#/definitions/OBCharge2' type: array description: Set of elements used to provide details of a charge for the payment initiation. Initiation: $ref: '#/definitions/OBDomestic2' Authorisation: $ref: '#/definitions/OBAuthorisation1' required: - ConsentId - CreationDateTime - Status - StatusUpdateDateTime - Initiation additionalProperties: false OBWriteDataDomesticResponse2: type: object properties: DomesticPaymentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic payment resource.' type: string minLength: 1 maxLength: 40 ConsentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' type: string minLength: 1 maxLength: 128 CreationDateTime: description: "Date and time at which the message was created.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Status: $ref: '#/definitions/OBTransactionIndividualStatus1Code' StatusUpdateDateTime: description: "Date and time at which the resource status was updated.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time ExpectedExecutionDateTime: description: "Expected execution date and time for the payment resource.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time ExpectedSettlementDateTime: description: "Expected settlement date and time for the payment resource.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Charges: items: $ref: '#/definitions/OBCharge2' type: array description: Set of elements used to provide details of a charge for the payment initiation. Initiation: $ref: '#/definitions/OBDomestic2' MultiAuthorisation: $ref: '#/definitions/OBMultiAuthorisation1' required: - DomesticPaymentId - ConsentId - CreationDateTime - Status - StatusUpdateDateTime - Initiation additionalProperties: false OBWriteFile2: type: object properties: Data: $ref: '#/definitions/OBWriteDataFile2' required: - Data additionalProperties: false OBWriteFileConsent2: type: object properties: Data: $ref: '#/definitions/OBWriteDataFileConsent2' required: - Data additionalProperties: false OBWriteFileConsentResponse2: type: object properties: Data: $ref: '#/definitions/OBWriteDataFileConsentResponse2' Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' required: - Data - Links - Meta additionalProperties: false OBWriteFileResponse2: type: object properties: Data: $ref: '#/definitions/OBWriteDataFileResponse2' Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' required: - Data - Links - Meta additionalProperties: false OBWriteDataFile2: type: object properties: ConsentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' type: string minLength: 1 maxLength: 128 Initiation: $ref: '#/definitions/OBFile2' required: - ConsentId - Initiation additionalProperties: false OBWriteDataFileConsent2: type: object properties: Initiation: $ref: '#/definitions/OBFile2' Authorisation: $ref: '#/definitions/OBAuthorisation1' required: - Initiation additionalProperties: false OBWriteDataFileConsentResponse2: type: object properties: ConsentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' type: string minLength: 1 maxLength: 128 CreationDateTime: description: "Date and time at which the resource was created.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Status: $ref: '#/definitions/OBExternalConsentStatus2Code' StatusUpdateDateTime: description: "Date and time at which the consent resource status was updated.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time CutOffDateTime: description: "Specified cut-off date and time for the payment consent.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Charges: items: $ref: '#/definitions/OBCharge2' type: array description: Set of elements used to provide details of a charge for the payment initiation. Initiation: $ref: '#/definitions/OBFile2' Authorisation: $ref: '#/definitions/OBAuthorisation1' required: - ConsentId - CreationDateTime - Status - StatusUpdateDateTime - Initiation additionalProperties: false OBWriteDataFileResponse2: type: object properties: FilePaymentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the file payment resource.' type: string minLength: 1 maxLength: 40 ConsentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' type: string minLength: 1 maxLength: 128 CreationDateTime: description: "Date and time at which the message was created.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Status: $ref: '#/definitions/OBExternalStatus1Code' StatusUpdateDateTime: description: "Date and time at which the resource status was updated.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Charges: items: $ref: '#/definitions/OBCharge2' type: array description: Set of elements used to provide details of a charge for the payment initiation. Initiation: $ref: '#/definitions/OBFile2' MultiAuthorisation: $ref: '#/definitions/OBMultiAuthorisation1' required: - FilePaymentId - ConsentId - CreationDateTime - Status - StatusUpdateDateTime - Initiation additionalProperties: false OBFile2: 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. type: object properties: FileType: $ref: '#/definitions/OBExternalFileType1Code' FileHash: description: A base64 encoding of a SHA256 hash of the file to be uploaded. type: string minLength: 1 maxLength: 44 FileReference: description: Reference for the file. type: string minLength: 1 maxLength: 40 NumberOfTransactions: description: Number of individual transactions contained in the payment information group. type: string minLength: 1 maxLength: 15 pattern: '[0-9]{1,15}' ControlSum: description: Total of all individual amounts included in the group, irrespective of currencies. type: number RequestedExecutionDateTime: description: "Date at which the initiating party requests the clearing agent to process the payment. \nUsage: This is the date on which the debtor's account is to be debited.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time LocalInstrument: $ref: '#/definitions/OBExternalLocalInstrument1Code' DebtorAccount: $ref: '#/definitions/OBCashAccountDebtor4' RemittanceInformation: $ref: '#/definitions/OBRemittanceInformation1' SupplementaryData: $ref: '#/definitions/OBSupplementaryData1' required: - FileType - FileHash additionalProperties: false OBExternalFileType1Code: description: Specifies the payment file type. type: string example: - UK.OBIE.PaymentInitiation.3.1 - UK.OBIE.pain.001.001.08 minLength: 1 maxLength: 40 OBExternalConsentStatus2Code: description: Specifies the status of consent resource in code form. type: string enum: - Authorised - AwaitingAuthorisation - AwaitingUpload - Consumed - Rejected OBWriteDataDomesticScheduled2: type: object properties: ConsentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' type: string minLength: 1 maxLength: 128 Initiation: $ref: '#/definitions/OBDomesticScheduled2' required: - ConsentId - Initiation additionalProperties: false OBWriteDataDomesticScheduledConsent2: type: object properties: Permission: $ref: '#/definitions/OBExternalPermissions2Code' Initiation: $ref: '#/definitions/OBDomesticScheduled2' Authorisation: $ref: '#/definitions/OBAuthorisation1' required: - Permission - Initiation additionalProperties: false OBWriteDataDomesticScheduledConsentResponse2: type: object properties: ConsentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' type: string minLength: 1 maxLength: 128 CreationDateTime: description: "Date and time at which the resource was created.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Status: $ref: '#/definitions/OBExternalConsentStatus1Code' StatusUpdateDateTime: description: "Date and time at which the consent resource status was updated.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Permission: $ref: '#/definitions/OBExternalPermissions2Code' CutOffDateTime: description: "Specified cut-off date and time for the payment consent.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time ExpectedExecutionDateTime: description: "Expected execution date and time for the payment resource.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time ExpectedSettlementDateTime: description: "Expected settlement date and time for the payment resource.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Charges: items: $ref: '#/definitions/OBCharge2' type: array description: Set of elements used to provide details of a charge for the payment initiation. Initiation: $ref: '#/definitions/OBDomesticScheduled2' Authorisation: $ref: '#/definitions/OBAuthorisation1' required: - ConsentId - CreationDateTime - Status - StatusUpdateDateTime - Permission - Initiation additionalProperties: false OBWriteDataDomesticScheduledResponse2: type: object properties: DomesticScheduledPaymentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic schedule payment resource.' type: string minLength: 1 maxLength: 40 ConsentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' type: string minLength: 1 maxLength: 128 CreationDateTime: description: "Date and time at which the message was created.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Status: $ref: '#/definitions/OBExternalStatus1Code' StatusUpdateDateTime: description: "Date and time at which the resource status was updated.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time ExpectedExecutionDateTime: description: "Expected execution date and time for the payment resource.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time ExpectedSettlementDateTime: description: "Expected settlement date and time for the payment resource.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Charges: items: $ref: '#/definitions/OBCharge2' type: array description: Set of elements used to provide details of a charge for the payment initiation. Initiation: $ref: '#/definitions/OBDomesticScheduled2' MultiAuthorisation: $ref: '#/definitions/OBMultiAuthorisation1' required: - DomesticScheduledPaymentId - ConsentId - CreationDateTime - Status - StatusUpdateDateTime - Initiation additionalProperties: false OBWriteDataDomesticStandingOrder2: type: object properties: ConsentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' type: string minLength: 1 maxLength: 128 Initiation: $ref: '#/definitions/OBDomesticStandingOrder2' required: - ConsentId - Initiation additionalProperties: false OBWriteDataDomesticStandingOrderConsent2: type: object properties: Permission: $ref: '#/definitions/OBExternalPermissions2Code' Initiation: $ref: '#/definitions/OBDomesticStandingOrder2' Authorisation: $ref: '#/definitions/OBAuthorisation1' required: - Permission - Initiation additionalProperties: false OBWriteDataDomesticStandingOrderConsentResponse2: type: object properties: ConsentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' type: string minLength: 1 maxLength: 128 CreationDateTime: description: "Date and time at which the resource was created.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Status: $ref: '#/definitions/OBExternalConsentStatus1Code' StatusUpdateDateTime: description: "Date and time at which the resource status was updated.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Permission: $ref: '#/definitions/OBExternalPermissions2Code' CutOffDateTime: description: "Specified cut-off date and time for the payment consent.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Charges: items: $ref: '#/definitions/OBCharge2' type: array description: Set of elements used to provide details of a charge for the payment initiation. Initiation: $ref: '#/definitions/OBDomesticStandingOrder2' Authorisation: $ref: '#/definitions/OBAuthorisation1' required: - ConsentId - CreationDateTime - Status - StatusUpdateDateTime - Permission - Initiation additionalProperties: false OBWriteDataDomesticStandingOrderResponse2: type: object properties: DomesticStandingOrderId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the domestic standing order resource.' type: string minLength: 1 maxLength: 40 ConsentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' type: string minLength: 1 maxLength: 128 CreationDateTime: description: "Date and time at which the resource was created.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Status: $ref: '#/definitions/OBExternalStatus1Code' StatusUpdateDateTime: description: "Date and time at which the resource status was updated.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Charges: items: $ref: '#/definitions/OBCharge2' type: array description: Set of elements used to provide details of a charge for the payment initiation. Initiation: $ref: '#/definitions/OBDomesticStandingOrder2' MultiAuthorisation: $ref: '#/definitions/OBMultiAuthorisation1' required: - DomesticStandingOrderId - ConsentId - CreationDateTime - Status - StatusUpdateDateTime - Initiation additionalProperties: false OBWriteDomestic2: type: object properties: Data: $ref: '#/definitions/OBWriteDataDomestic2' Risk: $ref: '#/definitions/OBRisk1' required: - Data - Risk additionalProperties: false OBWriteDomesticConsent2: type: object properties: Data: $ref: '#/definitions/OBWriteDataDomesticConsent2' Risk: $ref: '#/definitions/OBRisk1' required: - Data - Risk additionalProperties: false OBWriteDomesticConsentResponse2: type: object properties: Data: $ref: '#/definitions/OBWriteDataDomesticConsentResponse2' Risk: $ref: '#/definitions/OBRisk1' Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' required: - Data - Risk - Links - Meta additionalProperties: false OBWriteDomesticResponse2: type: object properties: Data: $ref: '#/definitions/OBWriteDataDomesticResponse2' Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' required: - Data - Links - Meta additionalProperties: false OBWriteDomesticScheduled2: type: object properties: Data: $ref: '#/definitions/OBWriteDataDomesticScheduled2' Risk: $ref: '#/definitions/OBRisk1' required: - Data - Risk additionalProperties: false OBWriteDomesticScheduledConsent2: type: object properties: Data: $ref: '#/definitions/OBWriteDataDomesticScheduledConsent2' Risk: $ref: '#/definitions/OBRisk1' required: - Data - Risk additionalProperties: false OBWriteDomesticScheduledConsentResponse2: type: object properties: Data: $ref: '#/definitions/OBWriteDataDomesticScheduledConsentResponse2' Risk: $ref: '#/definitions/OBRisk1' Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' required: - Data - Risk - Links - Meta additionalProperties: false OBWriteDomesticScheduledResponse2: type: object properties: Data: $ref: '#/definitions/OBWriteDataDomesticScheduledResponse2' Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' required: - Data - Links - Meta additionalProperties: false OBWriteDomesticStandingOrder2: type: object properties: Data: $ref: '#/definitions/OBWriteDataDomesticStandingOrder2' Risk: $ref: '#/definitions/OBRisk1' required: - Data - Risk additionalProperties: false OBWriteDomesticStandingOrderConsent2: type: object properties: Data: $ref: '#/definitions/OBWriteDataDomesticStandingOrderConsent2' Risk: $ref: '#/definitions/OBRisk1' required: - Data - Risk additionalProperties: false OBWriteDomesticStandingOrderConsentResponse2: type: object properties: Data: $ref: '#/definitions/OBWriteDataDomesticStandingOrderConsentResponse2' Risk: $ref: '#/definitions/OBRisk1' Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' required: - Data - Risk - Links - Meta additionalProperties: false OBWriteDomesticStandingOrderResponse2: type: object properties: Data: $ref: '#/definitions/OBWriteDataDomesticStandingOrderResponse2' Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' required: - Data - Links - Meta additionalProperties: false OBWriteInternational2: type: object properties: Data: $ref: '#/definitions/OBWriteDataInternational2' Risk: $ref: '#/definitions/OBRisk1' required: - Data - Risk additionalProperties: false OBWriteInternationalConsent2: type: object properties: Data: $ref: '#/definitions/OBWriteDataInternationalConsent2' Risk: $ref: '#/definitions/OBRisk1' required: - Data - Risk additionalProperties: false OBWriteInternationalConsentResponse2: type: object properties: Data: $ref: '#/definitions/OBWriteDataInternationalConsentResponse2' Risk: $ref: '#/definitions/OBRisk1' Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' required: - Data - Risk - Links - Meta additionalProperties: false OBWriteInternationalResponse2: type: object properties: Data: $ref: '#/definitions/OBWriteDataInternationalResponse2' Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' required: - Data - Links - Meta additionalProperties: false OBInternational2: 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. type: object properties: InstructionIdentification: description: |- Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction. type: string minLength: 1 maxLength: 35 EndToEndIdentification: description: |- Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field. type: string minLength: 1 maxLength: 35 LocalInstrument: $ref: '#/definitions/OBExternalLocalInstrument1Code' InstructionPriority: $ref: '#/definitions/OBPriority2Code' Purpose: $ref: '#/definitions/OBExternalPurpose1Code1' ChargeBearer: $ref: '#/definitions/OBChargeBearerType1Code' CurrencyOfTransfer: description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. type: string pattern: ^[A-Z]{3,3}$ InstructedAmount: type: object properties: Amount: $ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType' Currency: type: string pattern: ^[A-Z]{3,3}$ required: - Amount - Currency 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. ExchangeRateInformation: $ref: '#/definitions/OBExchangeRate1' DebtorAccount: $ref: '#/definitions/OBCashAccountDebtor4' Creditor: $ref: '#/definitions/OBPartyIdentification43' CreditorAgent: $ref: '#/definitions/OBBranchAndFinancialInstitutionIdentification6' CreditorAccount: $ref: '#/definitions/OBCashAccountCreditor3' RemittanceInformation: $ref: '#/definitions/OBRemittanceInformation1' SupplementaryData: $ref: '#/definitions/OBSupplementaryData1' required: - InstructionIdentification - EndToEndIdentification - CurrencyOfTransfer - InstructedAmount - CreditorAccount additionalProperties: false OBWriteDataInternational2: type: object properties: ConsentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' type: string minLength: 1 maxLength: 128 Initiation: $ref: '#/definitions/OBInternational2' required: - ConsentId - Initiation additionalProperties: false OBWriteDataInternationalConsent2: type: object properties: Initiation: $ref: '#/definitions/OBInternational2' Authorisation: $ref: '#/definitions/OBAuthorisation1' required: - Initiation additionalProperties: false OBWriteDataInternationalConsentResponse2: type: object properties: ConsentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' type: string minLength: 1 maxLength: 128 CreationDateTime: description: "Date and time at which the resource was created.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Status: $ref: '#/definitions/OBExternalConsentStatus1Code' StatusUpdateDateTime: description: "Date and time at which the resource status was updated.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time CutOffDateTime: description: "Specified cut-off date and time for the payment consent.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time ExpectedExecutionDateTime: description: "Expected execution date and time for the payment resource.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time ExpectedSettlementDateTime: description: "Expected settlement date and time for the payment resource.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Charges: items: $ref: '#/definitions/OBCharge2' type: array description: Set of elements used to provide details of a charge for the payment initiation. ExchangeRateInformation: $ref: '#/definitions/OBExchangeRate2' Initiation: $ref: '#/definitions/OBInternational2' Authorisation: $ref: '#/definitions/OBAuthorisation1' required: - ConsentId - CreationDateTime - Status - StatusUpdateDateTime - Initiation additionalProperties: false OBWriteDataInternationalResponse2: type: object properties: InternationalPaymentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the international payment resource.' type: string minLength: 1 maxLength: 40 ConsentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' type: string minLength: 1 maxLength: 128 CreationDateTime: description: "Date and time at which the message was created.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Status: $ref: '#/definitions/OBTransactionIndividualStatus1Code' StatusUpdateDateTime: description: "Date and time at which the resource status was updated.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time ExpectedExecutionDateTime: description: "Expected execution date and time for the payment resource.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time ExpectedSettlementDateTime: description: "Expected settlement date and time for the payment resource.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Charges: items: $ref: '#/definitions/OBCharge2' type: array description: Set of elements used to provide details of a charge for the payment initiation. ExchangeRateInformation: $ref: '#/definitions/OBExchangeRate2' Initiation: $ref: '#/definitions/OBInternational2' MultiAuthorisation: $ref: '#/definitions/OBMultiAuthorisation1' required: - InternationalPaymentId - ConsentId - CreationDateTime - Status - StatusUpdateDateTime - Initiation additionalProperties: false OBWriteInternationalScheduledConsent3: type: object required: - Data - Risk properties: Data: type: object required: - Permission - Initiation properties: Permission: description: Specifies the Open Banking service request types. type: string enum: - Create Initiation: type: object required: - InstructionIdentification - RequestedExecutionDateTime - CurrencyOfTransfer - InstructedAmount - CreditorAccount description: The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment. properties: InstructionIdentification: description: |- Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction. type: string minLength: 1 maxLength: 35 EndToEndIdentification: description: |- Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field. type: string minLength: 1 maxLength: 35 LocalInstrument: $ref: '#/definitions/OBExternalLocalInstrument1Code' InstructionPriority: description: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. type: string enum: - Normal - Urgent Purpose: description: |- Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org. type: string ChargeBearer: $ref: '#/definitions/OBChargeBearerType1Code' RequestedExecutionDateTime: description: "Date at which the initiating party requests the clearing agent to process the payment. \nUsage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time CurrencyOfTransfer: description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. type: string pattern: ^[A-Z]{3,3}$ InstructedAmount: type: object required: - Amount - Currency description: |- Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain. properties: Amount: $ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/definitions/ActiveOrHistoricCurrencyCode' ExchangeRateInformation: type: object required: - UnitCurrency - RateType description: Provides details on the currency exchange rate and contract. properties: UnitCurrency: description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. type: string pattern: ^[A-Z]{3,3}$ ExchangeRate: description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. type: number RateType: description: Specifies the type used to complete the currency exchange. type: string enum: - Actual - Agreed - Indicative ContractIdentification: description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. type: string minLength: 1 maxLength: 256 DebtorAccount: type: object required: - SchemeName - Identification description: Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. properties: SchemeName: $ref: '#/definitions/OBExternalAccountIdentification4Code' Identification: $ref: '#/definitions/Identification' Name: description: |- The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account. type: string minLength: 1 maxLength: 70 SecondaryIdentification: $ref: '#/definitions/SecondaryIdentification' Creditor: type: object description: Party to which an amount of money is due. properties: Name: description: Name by which a party is known and which is usually used to identify that party. type: string minLength: 1 maxLength: 140 PostalAddress: $ref: '#/definitions/OBPostalAddress6' CreditorAgent: type: object description: Financial institution servicing an account for the creditor. properties: SchemeName: description: Name of the identification scheme, in a coded form as published in an external list. type: string x-namespaced-enum: - UK.OBIE.BICFI Identification: description: Unique and unambiguous identification of a financial institution or a branch of a financial institution. type: string minLength: 1 maxLength: 35 Name: description: Name by which an agent is known and which is usually used to identify that agent. type: string minLength: 1 maxLength: 140 PostalAddress: $ref: '#/definitions/OBPostalAddress6' CreditorAccount: type: object required: - SchemeName - Identification - Name description: Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. properties: SchemeName: $ref: '#/definitions/OBExternalAccountIdentification4Code' Identification: $ref: '#/definitions/Identification' Name: description: |- The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. type: string minLength: 1 maxLength: 70 SecondaryIdentification: $ref: '#/definitions/SecondaryIdentification' RemittanceInformation: type: object description: Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. properties: Unstructured: 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. type: string minLength: 1 maxLength: 140 Reference: description: |- Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped. type: string minLength: 1 maxLength: 35 SupplementaryData: $ref: '#/definitions/OBSupplementaryData1' Authorisation: type: object required: - AuthorisationType description: The authorisation type request from the TPP. properties: AuthorisationType: description: Type of authorisation flow requested. type: string enum: - Any - Single CompletionDateTime: description: "Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time SCASupportData: type: object description: Supporting Data provided by TPP, when requesting SCA Exemption. properties: RequestedSCAExemptionType: description: This field allows a PISP to request specific SCA Exemption for a Payment Initiation type: string enum: - BillPayment - ContactlessTravel - EcommerceGoods - EcommerceServices - Kiosk - Parking - PartyToParty AppliedAuthenticationApproach: 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 type: string enum: - CA - SCA ReferencePaymentOrderId: description: |- Specifies a character string with a maximum length of 140 characters. Usage: If the payment is recurring then 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. type: string minLength: 1 maxLength: 128 Risk: $ref: '#/definitions/OBRisk1' OBWriteInternationalScheduledConsentResponse3: type: object required: - Data - Risk properties: Data: type: object required: - ConsentId - CreationDateTime - Status - StatusUpdateDateTime - Permission - Initiation properties: ConsentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' type: string minLength: 1 maxLength: 128 CreationDateTime: description: "Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Status: description: Specifies the status of consent resource in code form. type: string enum: - Authorised - AwaitingAuthorisation - Consumed - Rejected StatusUpdateDateTime: description: "Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Permission: description: Specifies the Open Banking service request types. type: string enum: - Create CutOffDateTime: description: "Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time ExpectedExecutionDateTime: description: "Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time ExpectedSettlementDateTime: description: "Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Charges: type: array items: type: object description: Set of elements used to provide details of a charge for the payment initiation. required: - ChargeBearer - Type - Amount properties: ChargeBearer: $ref: '#/definitions/OBChargeBearerType1Code' Type: $ref: '#/definitions/OBExternalPaymentChargeType1Code' Amount: $ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount' ExchangeRateInformation: type: object required: - UnitCurrency - ExchangeRate - RateType description: Further detailed information on the exchange rate that has been used in the payment transaction. properties: UnitCurrency: description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. type: string pattern: ^[A-Z]{3,3}$ ExchangeRate: description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. type: number RateType: description: Specifies the type used to complete the currency exchange. type: string enum: - Actual - Agreed - Indicative ContractIdentification: description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. type: string minLength: 1 maxLength: 256 ExpirationDateTime: description: "Specified date and time the exchange rate agreement will expire.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Initiation: type: object required: - InstructionIdentification - RequestedExecutionDateTime - CurrencyOfTransfer - InstructedAmount - CreditorAccount description: The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment. properties: InstructionIdentification: description: |- Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction. type: string minLength: 1 maxLength: 35 EndToEndIdentification: description: |- Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field. type: string minLength: 1 maxLength: 35 LocalInstrument: $ref: '#/definitions/OBExternalLocalInstrument1Code' InstructionPriority: description: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. type: string enum: - Normal - Urgent Purpose: description: |- Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org. type: string ChargeBearer: $ref: '#/definitions/OBChargeBearerType1Code' RequestedExecutionDateTime: description: "Date at which the initiating party requests the clearing agent to process the payment. \nUsage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time CurrencyOfTransfer: description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. type: string pattern: ^[A-Z]{3,3}$ InstructedAmount: type: object required: - Amount - Currency description: |- Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain. properties: Amount: $ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/definitions/ActiveOrHistoricCurrencyCode' ExchangeRateInformation: type: object required: - UnitCurrency - RateType description: Provides details on the currency exchange rate and contract. properties: UnitCurrency: description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. type: string pattern: ^[A-Z]{3,3}$ ExchangeRate: description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. type: number RateType: description: Specifies the type used to complete the currency exchange. type: string enum: - Actual - Agreed - Indicative ContractIdentification: description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. type: string minLength: 1 maxLength: 256 DebtorAccount: type: object required: - SchemeName - Identification description: Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. properties: SchemeName: $ref: '#/definitions/OBExternalAccountIdentification4Code' Identification: $ref: '#/definitions/Identification' Name: description: |- The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account. type: string minLength: 1 maxLength: 70 SecondaryIdentification: $ref: '#/definitions/SecondaryIdentification' Creditor: type: object description: Party to which an amount of money is due. properties: Name: description: Name by which a party is known and which is usually used to identify that party. type: string minLength: 1 maxLength: 140 PostalAddress: $ref: '#/definitions/OBPostalAddress6' CreditorAgent: type: object description: Financial institution servicing an account for the creditor. properties: SchemeName: description: Name of the identification scheme, in a coded form as published in an external list. type: string x-namespaced-enum: - UK.OBIE.BICFI Identification: description: Unique and unambiguous identification of a financial institution or a branch of a financial institution. type: string minLength: 1 maxLength: 35 Name: description: Name by which an agent is known and which is usually used to identify that agent. type: string minLength: 1 maxLength: 140 PostalAddress: $ref: '#/definitions/OBPostalAddress6' CreditorAccount: type: object required: - SchemeName - Identification - Name description: Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. properties: SchemeName: $ref: '#/definitions/OBExternalAccountIdentification4Code' Identification: $ref: '#/definitions/Identification' Name: description: |- The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. type: string minLength: 1 maxLength: 70 SecondaryIdentification: $ref: '#/definitions/SecondaryIdentification' RemittanceInformation: type: object description: Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. properties: Unstructured: 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. type: string minLength: 1 maxLength: 140 Reference: description: |- Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped. type: string minLength: 1 maxLength: 35 SupplementaryData: $ref: '#/definitions/OBSupplementaryData1' Authorisation: type: object required: - AuthorisationType description: The authorisation type request from the TPP. properties: AuthorisationType: description: Type of authorisation flow requested. type: string enum: - Any - Single CompletionDateTime: description: "Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time SCASupportData: type: object description: Supporting Data provided by TPP, when requesting SCA Exemption. properties: RequestedSCAExemptionType: description: This field allows a PISP to request specific SCA Exemption for a Payment Initiation type: string enum: - BillPayment - ContactlessTravel - EcommerceGoods - EcommerceServices - Kiosk - Parking - PartyToParty AppliedAuthenticationApproach: 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 type: string enum: - CA - SCA ReferencePaymentOrderId: description: |- Specifies a character string with a maximum length of 140 characters. Usage: If the payment is recurring then 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. type: string minLength: 1 maxLength: 128 Risk: $ref: '#/definitions/OBRisk1' Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' OBWriteInternationalScheduled2: type: object required: - Data - Risk properties: Data: type: object required: - ConsentId - Initiation properties: ConsentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' type: string minLength: 1 maxLength: 128 Initiation: type: object required: - InstructionIdentification - RequestedExecutionDateTime - CurrencyOfTransfer - InstructedAmount - CreditorAccount description: The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment. properties: InstructionIdentification: description: |- Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction. type: string minLength: 1 maxLength: 35 EndToEndIdentification: description: |- Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field. type: string minLength: 1 maxLength: 35 LocalInstrument: $ref: '#/definitions/OBExternalLocalInstrument1Code' InstructionPriority: description: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. type: string enum: - Normal - Urgent Purpose: description: |- Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org. type: string ChargeBearer: $ref: '#/definitions/OBChargeBearerType1Code' RequestedExecutionDateTime: description: "Date at which the initiating party requests the clearing agent to process the payment. \nUsage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time CurrencyOfTransfer: description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. type: string pattern: ^[A-Z]{3,3}$ InstructedAmount: type: object required: - Amount - Currency description: |- Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain. properties: Amount: $ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/definitions/ActiveOrHistoricCurrencyCode' ExchangeRateInformation: type: object required: - UnitCurrency - RateType description: Provides details on the currency exchange rate and contract. properties: UnitCurrency: description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. type: string pattern: ^[A-Z]{3,3}$ ExchangeRate: description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. type: number RateType: description: Specifies the type used to complete the currency exchange. type: string enum: - Actual - Agreed - Indicative ContractIdentification: description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. type: string minLength: 1 maxLength: 256 DebtorAccount: type: object required: - SchemeName - Identification description: Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. properties: SchemeName: $ref: '#/definitions/OBExternalAccountIdentification4Code' Identification: $ref: '#/definitions/Identification' Name: description: |- The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account. type: string minLength: 1 maxLength: 70 SecondaryIdentification: $ref: '#/definitions/SecondaryIdentification' Creditor: type: object description: Party to which an amount of money is due. properties: Name: description: Name by which a party is known and which is usually used to identify that party. type: string minLength: 1 maxLength: 140 PostalAddress: $ref: '#/definitions/OBPostalAddress6' CreditorAgent: type: object description: Financial institution servicing an account for the creditor. properties: SchemeName: description: Name of the identification scheme, in a coded form as published in an external list. type: string x-namespaced-enum: - UK.OBIE.BICFI Identification: description: Unique and unambiguous identification of a financial institution or a branch of a financial institution. type: string minLength: 1 maxLength: 35 Name: description: Name by which an agent is known and which is usually used to identify that agent. type: string minLength: 1 maxLength: 140 PostalAddress: $ref: '#/definitions/OBPostalAddress6' CreditorAccount: type: object required: - SchemeName - Identification - Name description: Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. properties: SchemeName: $ref: '#/definitions/OBExternalAccountIdentification4Code' Identification: $ref: '#/definitions/Identification' Name: description: |- The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. type: string minLength: 1 maxLength: 70 SecondaryIdentification: $ref: '#/definitions/SecondaryIdentification' RemittanceInformation: type: object description: Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. properties: Unstructured: 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. type: string minLength: 1 maxLength: 140 Reference: description: |- Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped. type: string minLength: 1 maxLength: 35 SupplementaryData: $ref: '#/definitions/OBSupplementaryData1' Risk: $ref: '#/definitions/OBRisk1' OBWriteInternationalScheduledResponse3: type: object required: - Data properties: Data: type: object required: - InternationalScheduledPaymentId - ConsentId - CreationDateTime - Status - StatusUpdateDateTime - Initiation properties: InternationalScheduledPaymentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the international scheduled payment resource.' type: string minLength: 1 maxLength: 40 ConsentId: description: 'OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.' type: string minLength: 1 maxLength: 128 CreationDateTime: description: "Date and time at which the message was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Status: description: Specifies the status of the payment order resource. type: string enum: - Cancelled - InitiationCompleted - InitiationFailed - InitiationPending StatusUpdateDateTime: description: "Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time ExpectedExecutionDateTime: description: "Expected execution date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time ExpectedSettlementDateTime: description: "Expected settlement date and time for the payment resource.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Charges: type: array items: type: object description: Set of elements used to provide details of a charge for the payment initiation. required: - ChargeBearer - Type - Amount properties: ChargeBearer: $ref: '#/definitions/OBChargeBearerType1Code' Type: $ref: '#/definitions/OBExternalPaymentChargeType1Code' Amount: $ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount' ExchangeRateInformation: type: object required: - UnitCurrency - ExchangeRate - RateType description: Further detailed information on the exchange rate that has been used in the payment transaction. properties: UnitCurrency: description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. type: string pattern: ^[A-Z]{3,3}$ ExchangeRate: description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. type: number RateType: description: Specifies the type used to complete the currency exchange. type: string enum: - Actual - Agreed - Indicative ContractIdentification: description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. type: string minLength: 1 maxLength: 256 ExpirationDateTime: description: "Specified date and time the exchange rate agreement will expire.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Initiation: type: object required: - InstructionIdentification - RequestedExecutionDateTime - CurrencyOfTransfer - InstructedAmount - CreditorAccount description: The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for a single scheduled international payment. properties: InstructionIdentification: description: |- Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction. Usage: the instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction. type: string minLength: 1 maxLength: 35 EndToEndIdentification: description: |- Unique identification assigned by the initiating party to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Usage: The end-to-end identification can be used for reconciliation or to link tasks relating to the transaction. It can be included in several messages related to the transaction. OB: The Faster Payments Scheme can only access 31 characters for the EndToEndIdentification field. type: string minLength: 1 maxLength: 35 LocalInstrument: $ref: '#/definitions/OBExternalLocalInstrument1Code' InstructionPriority: description: Indicator of the urgency or order of importance that the instructing party would like the instructed party to apply to the processing of the instruction. type: string enum: - Normal - Urgent Purpose: description: |- Specifies the external purpose code in the format of character string with a maximum length of 4 characters. The list of valid codes is an external code list published separately. External code sets can be downloaded from www.iso20022.org. type: string ChargeBearer: $ref: '#/definitions/OBChargeBearerType1Code' RequestedExecutionDateTime: description: "Date at which the initiating party requests the clearing agent to process the payment. \nUsage: This is the date on which the debtor's account is to be debited.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time CurrencyOfTransfer: description: Specifies the currency of the to be transferred amount, which is different from the currency of the debtor's account. type: string pattern: ^[A-Z]{3,3}$ InstructedAmount: type: object required: - Amount - Currency description: |- Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party. Usage: This amount has to be transported unchanged through the transaction chain. properties: Amount: $ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType' Currency: $ref: '#/definitions/ActiveOrHistoricCurrencyCode' ExchangeRateInformation: type: object required: - UnitCurrency - RateType description: Provides details on the currency exchange rate and contract. properties: UnitCurrency: description: Currency in which the rate of exchange is expressed in a currency exchange. In the example 1GBP = xxxCUR, the unit currency is GBP. type: string pattern: ^[A-Z]{3,3}$ ExchangeRate: description: The factor used for conversion of an amount from one currency to another. This reflects the price at which one currency was bought with another currency. type: number RateType: description: Specifies the type used to complete the currency exchange. type: string enum: - Actual - Agreed - Indicative ContractIdentification: description: Unique and unambiguous reference to the foreign exchange contract agreed between the initiating party/creditor and the debtor agent. type: string minLength: 1 maxLength: 256 DebtorAccount: type: object required: - SchemeName - Identification description: Unambiguous identification of the account of the debtor to which a debit entry will be made as a result of the transaction. properties: SchemeName: $ref: '#/definitions/OBExternalAccountIdentification4Code' Identification: $ref: '#/definitions/Identification' Name: description: |- The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account. type: string minLength: 1 maxLength: 70 SecondaryIdentification: $ref: '#/definitions/SecondaryIdentification' Creditor: type: object description: Party to which an amount of money is due. properties: Name: description: Name by which a party is known and which is usually used to identify that party. type: string minLength: 1 maxLength: 140 PostalAddress: $ref: '#/definitions/OBPostalAddress6' CreditorAgent: type: object description: Financial institution servicing an account for the creditor. properties: SchemeName: description: Name of the identification scheme, in a coded form as published in an external list. type: string x-namespaced-enum: - UK.OBIE.BICFI Identification: description: Unique and unambiguous identification of a financial institution or a branch of a financial institution. type: string minLength: 1 maxLength: 35 Name: description: Name by which an agent is known and which is usually used to identify that agent. type: string minLength: 1 maxLength: 140 PostalAddress: $ref: '#/definitions/OBPostalAddress6' CreditorAccount: type: object required: - SchemeName - Identification - Name description: Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction. properties: SchemeName: $ref: '#/definitions/OBExternalAccountIdentification4Code' Identification: $ref: '#/definitions/Identification' Name: description: |- The account name is the name or names of the account owner(s) represented at an account level. Note, the account name is not the product name or the nickname of the account. OB: ASPSPs may carry out name validation for Confirmation of Payee, but it is not mandatory. type: string minLength: 1 maxLength: 70 SecondaryIdentification: $ref: '#/definitions/SecondaryIdentification' RemittanceInformation: type: object description: Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system. properties: Unstructured: 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. type: string minLength: 1 maxLength: 140 Reference: description: |- Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. OB: The Faster Payments Scheme can only accept 18 characters for the ReferenceInformation field - which is where this ISO field will be mapped. type: string minLength: 1 maxLength: 35 SupplementaryData: $ref: '#/definitions/OBSupplementaryData1' MultiAuthorisation: type: object required: - Status description: The multiple authorisation flow response from the ASPSP. properties: Status: description: Specifies the status of the authorisation flow in code form. type: string enum: - Authorised - AwaitingFurtherAuthorisation - Rejected NumberRequired: description: Number of authorisations required for payment order (total required at the start of the multi authorisation journey). type: integer NumberReceived: description: Number of authorisations received. type: integer LastUpdateDateTime: description: "Last date and time at the authorisation flow was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time ExpirationDateTime: description: "Date and time at which the requested authorisation flow must be completed.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' OBWriteFundsConfirmationResponse1: type: object properties: Data: $ref: '#/definitions/OBWriteDataFundsConfirmationResponse1' Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' required: - Data - Links - Meta additionalProperties: false OBWriteDataFundsConfirmationResponse1: type: object properties: FundsAvailableResult: $ref: '#/definitions/OBFundsAvailableResult1' SupplementaryData: $ref: '#/definitions/OBSupplementaryData1' additionalProperties: false OBExternalLocalInstrument1Code: 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. type: string example: - 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 minLength: 1 maxLength: 50 OBCharge2: description: Set of elements used to provide details of a charge for the payment initiation. type: object properties: ChargeBearer: $ref: '#/definitions/OBChargeBearerType1Code' Type: $ref: '#/definitions/OBExternalPaymentChargeType1Code' Amount: type: object properties: Amount: $ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType' Currency: type: string pattern: ^[A-Z]{3,3}$ required: - Amount - Currency additionalProperties: false description: Amount of money associated with the charge type. required: - ChargeBearer - Type - Amount additionalProperties: false OBExternalPaymentChargeType1Code: description: Charge type, in a coded form. type: string example: - UK.OBIE.CHAPSOut - UK.OBIE.BalanceTransferOut - UK.OBIE.MoneyTransferOut minLength: 1 maxLength: 40 OBFundsAvailableResult1: description: Result of a funds availability check. type: object properties: FundsAvailableDateTime: description: "Date and time at which the funds availability check was generated.\nAll dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time FundsAvailable: description: Flag to indicate the availability of funds given the Amount in the consent request. type: boolean required: - FundsAvailableDateTime - FundsAvailable additionalProperties: false OBWritePaymentDetailsResponse1: type: object required: - Data properties: Data: type: object properties: PaymentStatus: type: array items: type: object description: Payment status details. required: - PaymentTransactionId - Status - StatusUpdateDateTime properties: PaymentTransactionId: description: Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable. type: string minLength: 1 maxLength: 210 Status: description: Status of a transfe, as assigned by the transaction administrator. type: string enum: - Accepted - AcceptedCancellationRequest - AcceptedCreditSettlementCompleted - AcceptedCustomerProfile - AcceptedFundsChecked - AcceptedSettlementCompleted - AcceptedSettlementInProcess - AcceptedTechnicalValidation - AcceptedWithChange - AcceptedWithoutPosting - Cancelled - NoCancellationProcess - PartiallyAcceptedCancellationRequest - PartiallyAcceptedTechnicalCorrect - PaymentCancelled - Pending - PendingCancellationRequest - Received - Rejected - RejectedCancellationRequest StatusUpdateDateTime: description: "Date and time at which the status was assigned to the transfer.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time StatusDetail: type: object required: - Status description: Payment status details as per underlying Payment Rail. properties: LocalInstrument: $ref: '#/definitions/OBExternalLocalInstrument1Code' Status: description: Status of a transfer, as assigned by the transaction administrator. type: string minLength: 1 maxLength: 128 StatusReason: description: Reason Code provided for the status of a transfer. type: string enum: - Cancelled - PendingFailingSettlement - PendingSettlement - Proprietary - ProprietaryRejection - Suspended - Unmatched StatusReasonDescription: description: Reason provided for the status of a transfer. type: string minLength: 1 maxLength: 256 Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' OBError1: type: object properties: ErrorCode: description: Low level textual error code, e.g., UK.OBIE.Field.Missing type: string minLength: 1 maxLength: 128 Message: description: |- A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field type: string minLength: 1 maxLength: 500 Path: description: Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency type: string minLength: 1 maxLength: 500 Url: description: URL to help remediate the problem, or provide more information, or to API Reference, or help etc type: string required: - ErrorCode - Message additionalProperties: false minProperties: 1 OBErrorResponse1: description: An array of detail error codes, and messages, and URLs to documentation to help remediation. type: object properties: Code: description: High level textual error code, to help categorize the errors. type: string minLength: 1 maxLength: 40 Id: description: A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors. type: string minLength: 1 maxLength: 40 Message: description: Brief Error message, e.g., 'There is something wrong with the request parameters provided' type: string minLength: 1 maxLength: 500 Errors: items: $ref: '#/definitions/OBError1' type: array minItems: 1 required: - Code - Message - Errors additionalProperties: false File: type: string format: binary ISODateTime: description: "All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00" type: string format: date-time Identification: description: Identification assigned by an institution to identify an account. This identification is known by the account owner. type: string minLength: 1 maxLength: 256 SecondaryIdentification: description: "This is secondary identification of the account, as assigned by the account servicing institution. \nThis can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination)." type: string minLength: 1 maxLength: 34 Links: type: object 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 additionalProperties: false required: - Self Meta: title: MetaData type: object description: Meta Data relevant to the payload properties: TotalPages: type: integer format: int32 FirstAvailableDateTime: $ref: '#/definitions/ISODateTime' LastAvailableDateTime: $ref: '#/definitions/ISODateTime' additionalProperties: false securityDefinitions: PSUOAuth2Security: type: oauth2 flow: accessCode tokenUrl: https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/token authorizationUrl: https://openbanking.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/authorize scopes: payments: Generic payment scope 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 x-tokenIntrospect: url: https://openbanking.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/introspect TPPOAuth2Security: type: oauth2 flow: application tokenUrl: https://openbanking-ma.santander.co.uk/sanuk/external/open-banking/openid-connect-provider/v1/oauth2/token scopes: payments: "" description: TPP client credential authorisation flow with the ASPSP x-tokenIntrospect: url: "" tags: - name: Payments description: Payments endpoints x-ibm-configuration: enforced: true testable: true phase: specified categories: - Type / Experience - SanUK Business Domain / Common Services & Guidance / Payments - BIAN Business Area / NA - BIAN Business Domain / NA - BIAN Service Domain / NA security: - PSUOAuth2Security: - payments TPPOAuth2Security: - payments x-ibm-endpoints: - endpointUrl: https://openbanking-ma.santander.co.uk/sanuk/external description: Endpoint for Open Banking TLS MA only type: - production ...