{ "swagger": "2.0", "info": { "title": "Payment Initiation API", "description": "Swagger for Payment Initiation API Specification", "termsOfService": "https://www.openbanking.org.uk/terms", "contact": { "name": "Service Desk", "email": "ServiceDesk@openbanking.org.uk" }, "license": { "name": "open-licence", "url": "https://www.openbanking.org.uk/open-licence" }, "version": "v3.1.2" }, "basePath": "/open-banking/v3.1/pisp", "schemes": [ "https" ], "consumes": [ "application/json; charset=utf-8", "application/jose+jwe" ], "produces": [ "application/json; charset=utf-8", "application/jose+jwe" ], "paths": { "/domestic-payment-consents": { "post": { "tags": [ "Domestic Payments" ], "summary": "Create Domestic Payment Consents", "operationId": "CreateDomesticPaymentConsents", "parameters": [ { "$ref": "#/parameters/OBWriteDomesticConsent3Param" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" }, { "$ref": "#/parameters/x-idempotency-key" }, { "$ref": "#/parameters/x-jws-signature" } ], "responses": { "201": { "$ref": "#/responses/201DomesticPaymentConsentsCreated" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } }, "/domestic-payment-consents/{ConsentId}": { "get": { "tags": [ "Domestic Payments" ], "summary": "Get Domestic Payment Consents", "operationId": "GetDomesticPaymentConsentsConsentId", "parameters": [ { "$ref": "#/parameters/ConsentId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200DomesticPaymentConsentsConsentIdRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } }, "/domestic-payment-consents/{ConsentId}/funds-confirmation": { "get": { "tags": [ "Domestic Payments" ], "summary": "Get Domestic Payment Consents", "operationId": "GetDomesticPaymentConsentsConsentIdFundsConfirmation", "parameters": [ { "$ref": "#/parameters/ConsentId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200DomesticPaymentConsentsConsentIdFundsConfirmationRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "payments" ] } ] } }, "/domestic-payments": { "post": { "tags": [ "Domestic Payments" ], "summary": "Create Domestic Payments", "operationId": "CreateDomesticPayments", "parameters": [ { "$ref": "#/parameters/OBWriteDomestic2Param" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" }, { "$ref": "#/parameters/x-idempotency-key" }, { "$ref": "#/parameters/x-jws-signature" } ], "responses": { "201": { "$ref": "#/responses/201DomesticPaymentsCreated" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "payments" ] } ] } }, "/domestic-payments/{DomesticPaymentId}": { "get": { "tags": [ "Domestic Payments" ], "summary": "Get Domestic Payments", "operationId": "GetDomesticPaymentsDomesticPaymentId", "parameters": [ { "$ref": "#/parameters/DomesticPaymentId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200DomesticPaymentsDomesticPaymentIdRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } }, "/domestic-payments/{DomesticPaymentId}/payment-details": { "get": { "tags": [ "Payment Details" ], "summary": "Get Payment Details", "operationId": "GetDomesticPaymentsDomesticPaymentIdPaymentDetails", "parameters": [ { "$ref": "#/parameters/DomesticPaymentId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200DomesticPaymentsDomesticPaymentIdPaymentDetailsRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } }, "/domestic-scheduled-payment-consents": { "post": { "tags": [ "Domestic Scheduled Payments" ], "summary": "Create Domestic Scheduled Payment Consents", "operationId": "CreateDomesticScheduledPaymentConsents", "parameters": [ { "$ref": "#/parameters/OBWriteDomesticScheduledConsent3Param" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" }, { "$ref": "#/parameters/x-idempotency-key" }, { "$ref": "#/parameters/x-jws-signature" } ], "responses": { "201": { "$ref": "#/responses/201DomesticScheduledPaymentConsentsCreated" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } }, "/domestic-scheduled-payment-consents/{ConsentId}": { "get": { "tags": [ "Domestic Scheduled Payments" ], "summary": "Get Domestic Scheduled Payment Consents", "operationId": "GetDomesticScheduledPaymentConsentsConsentId", "parameters": [ { "$ref": "#/parameters/ConsentId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200DomesticScheduledPaymentConsentsConsentIdRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } }, "/domestic-scheduled-payments": { "post": { "tags": [ "Domestic Scheduled Payments" ], "summary": "Create Domestic Scheduled Payments", "operationId": "CreateDomesticScheduledPayments", "parameters": [ { "$ref": "#/parameters/OBWriteDomesticScheduled2Param" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" }, { "$ref": "#/parameters/x-idempotency-key" }, { "$ref": "#/parameters/x-jws-signature" } ], "responses": { "201": { "$ref": "#/responses/201DomesticScheduledPaymentsCreated" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "payments" ] } ] } }, "/domestic-scheduled-payments/{DomesticScheduledPaymentId}": { "get": { "tags": [ "Domestic Scheduled Payments" ], "summary": "Get Domestic Scheduled Payments", "operationId": "GetDomesticScheduledPaymentsDomesticScheduledPaymentId", "parameters": [ { "$ref": "#/parameters/DomesticScheduledPaymentId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200DomesticScheduledPaymentsDomesticScheduledPaymentIdRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } }, "/domestic-scheduled-payments/{DomesticScheduledPaymentId}/payment-details": { "get": { "tags": [ "Payment Details" ], "summary": "Get Payment Details", "operationId": "GetDomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetails", "parameters": [ { "$ref": "#/parameters/DomesticScheduledPaymentId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200DomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetailsRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } }, "/domestic-standing-order-consents": { "post": { "tags": [ "Domestic Standing Orders" ], "summary": "Create Domestic Standing Order Consents", "operationId": "CreateDomesticStandingOrderConsents", "parameters": [ { "$ref": "#/parameters/OBWriteDomesticStandingOrderConsent4Param" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" }, { "$ref": "#/parameters/x-idempotency-key" }, { "$ref": "#/parameters/x-jws-signature" } ], "responses": { "201": { "$ref": "#/responses/201DomesticStandingOrderConsentsCreated" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } }, "/domestic-standing-order-consents/{ConsentId}": { "get": { "tags": [ "Domestic Standing Orders" ], "summary": "Get Domestic Standing Order Consents", "operationId": "GetDomesticStandingOrderConsentsConsentId", "parameters": [ { "$ref": "#/parameters/ConsentId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200DomesticStandingOrderConsentsConsentIdRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } }, "/domestic-standing-orders": { "post": { "tags": [ "Domestic Standing Orders" ], "summary": "Create Domestic Standing Orders", "operationId": "CreateDomesticStandingOrders", "parameters": [ { "$ref": "#/parameters/OBWriteDomesticStandingOrder3Param" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" }, { "$ref": "#/parameters/x-idempotency-key" }, { "$ref": "#/parameters/x-jws-signature" } ], "responses": { "201": { "$ref": "#/responses/201DomesticStandingOrdersCreated" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "payments" ] } ] } }, "/domestic-standing-orders/{DomesticStandingOrderId}": { "get": { "tags": [ "Domestic Standing Orders" ], "summary": "Get Domestic Standing Orders", "operationId": "GetDomesticStandingOrdersDomesticStandingOrderId", "parameters": [ { "$ref": "#/parameters/DomesticStandingOrderId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200DomesticStandingOrdersDomesticStandingOrderIdRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } }, "/domestic-standing-orders/{DomesticStandingOrderId}/payment-details": { "get": { "tags": [ "Payment Details" ], "summary": "Get Payment Details", "operationId": "GetDomesticStandingOrdersDomesticStandingOrderIdPaymentDetails", "parameters": [ { "$ref": "#/parameters/DomesticStandingOrderId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200DomesticStandingOrdersDomesticStandingOrderIdPaymentDetailsRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } }, "/file-payment-consents": { "post": { "tags": [ "File Payments" ], "summary": "Create File Payment Consents", "operationId": "CreateFilePaymentConsents", "parameters": [ { "$ref": "#/parameters/OBWriteFileConsent3Param" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" }, { "$ref": "#/parameters/x-idempotency-key" }, { "$ref": "#/parameters/x-jws-signature" } ], "responses": { "201": { "$ref": "#/responses/201FilePaymentConsentsCreated" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } }, "/file-payment-consents/{ConsentId}": { "get": { "tags": [ "File Payments" ], "summary": "Get File Payment Consents", "operationId": "GetFilePaymentConsentsConsentId", "parameters": [ { "$ref": "#/parameters/ConsentId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200FilePaymentConsentsConsentIdRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } }, "/file-payment-consents/{ConsentId}/file": { "post": { "tags": [ "File Payments" ], "summary": "Create File Payment Consents", "operationId": "CreateFilePaymentConsentsConsentIdFile", "parameters": [ { "$ref": "#/parameters/FileParam" }, { "$ref": "#/parameters/ConsentId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" }, { "$ref": "#/parameters/x-idempotency-key" }, { "$ref": "#/parameters/x-jws-signature" } ], "responses": { "200": { "$ref": "#/responses/200FilePaymentConsentsConsentIdFileCreated" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] }, "get": { "tags": [ "File Payments" ], "summary": "Get File Payment Consents", "operationId": "GetFilePaymentConsentsConsentIdFile", "parameters": [ { "$ref": "#/parameters/ConsentId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200FilePaymentConsentsConsentIdFileRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } }, "/file-payments": { "post": { "tags": [ "File Payments" ], "summary": "Create File Payments", "operationId": "CreateFilePayments", "parameters": [ { "$ref": "#/parameters/OBWriteFile2Param" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" }, { "$ref": "#/parameters/x-idempotency-key" }, { "$ref": "#/parameters/x-jws-signature" } ], "responses": { "201": { "$ref": "#/responses/201FilePaymentsCreated" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "payments" ] } ] } }, "/file-payments/{FilePaymentId}": { "get": { "tags": [ "File Payments" ], "summary": "Get File Payments", "operationId": "GetFilePaymentsFilePaymentId", "parameters": [ { "$ref": "#/parameters/FilePaymentId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200FilePaymentsFilePaymentIdRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } }, "/file-payments/{FilePaymentId}/payment-details": { "get": { "tags": [ "Payment Details" ], "summary": "Get Payment Details", "operationId": "GetFilePaymentsFilePaymentIdPaymentDetails", "parameters": [ { "$ref": "#/parameters/FilePaymentId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200FilePaymentsFilePaymentIdPaymentDetailsRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } }, "/file-payments/{FilePaymentId}/report-file": { "get": { "tags": [ "File Payments" ], "summary": "Get File Payments", "operationId": "GetFilePaymentsFilePaymentIdReportFile", "parameters": [ { "$ref": "#/parameters/FilePaymentId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200FilePaymentsFilePaymentIdReportFileRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } }, "/international-payment-consents": { "post": { "tags": [ "International Payments" ], "summary": "Create International Payment Consents", "operationId": "CreateInternationalPaymentConsents", "parameters": [ { "$ref": "#/parameters/OBWriteInternationalConsent3Param" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" }, { "$ref": "#/parameters/x-idempotency-key" }, { "$ref": "#/parameters/x-jws-signature" } ], "responses": { "201": { "$ref": "#/responses/201InternationalPaymentConsentsCreated" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } }, "/international-payment-consents/{ConsentId}": { "get": { "tags": [ "International Payments" ], "summary": "Get International Payment Consents", "operationId": "GetInternationalPaymentConsentsConsentId", "parameters": [ { "$ref": "#/parameters/ConsentId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200InternationalPaymentConsentsConsentIdRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } }, "/international-payment-consents/{ConsentId}/funds-confirmation": { "get": { "tags": [ "International Payments" ], "summary": "Get International Payment Consents", "operationId": "GetInternationalPaymentConsentsConsentIdFundsConfirmation", "parameters": [ { "$ref": "#/parameters/ConsentId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200InternationalPaymentConsentsConsentIdFundsConfirmationRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "payments" ] } ] } }, "/international-payments": { "post": { "tags": [ "International Payments" ], "summary": "Create International Payments", "operationId": "CreateInternationalPayments", "parameters": [ { "$ref": "#/parameters/OBWriteInternational2Param" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" }, { "$ref": "#/parameters/x-idempotency-key" }, { "$ref": "#/parameters/x-jws-signature" } ], "responses": { "201": { "$ref": "#/responses/201InternationalPaymentsCreated" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "payments" ] } ] } }, "/international-payments/{InternationalPaymentId}": { "get": { "tags": [ "International Payments" ], "summary": "Get International Payments", "operationId": "GetInternationalPaymentsInternationalPaymentId", "parameters": [ { "$ref": "#/parameters/InternationalPaymentId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200InternationalPaymentsInternationalPaymentIdRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } }, "/international-payments/{InternationalPaymentId}/payment-details": { "get": { "tags": [ "Payment Details" ], "summary": "Get Payment Details", "operationId": "GetInternationalPaymentsInternationalPaymentIdPaymentDetails", "parameters": [ { "$ref": "#/parameters/InternationalPaymentId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200InternationalPaymentsInternationalPaymentIdPaymentDetailsRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } }, "/international-scheduled-payment-consents": { "post": { "tags": [ "International Scheduled Payments" ], "summary": "Create International Scheduled Payment Consents", "operationId": "CreateInternationalScheduledPaymentConsents", "parameters": [ { "$ref": "#/parameters/OBWriteInternationalScheduledConsent3Param" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" }, { "$ref": "#/parameters/x-idempotency-key" }, { "$ref": "#/parameters/x-jws-signature" } ], "responses": { "201": { "$ref": "#/responses/201InternationalScheduledPaymentConsentsCreated" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } }, "/international-scheduled-payment-consents/{ConsentId}": { "get": { "tags": [ "International Scheduled Payments" ], "summary": "Get International Scheduled Payment Consents", "operationId": "GetInternationalScheduledPaymentConsentsConsentId", "parameters": [ { "$ref": "#/parameters/ConsentId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200InternationalScheduledPaymentConsentsConsentIdRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } }, "/international-scheduled-payment-consents/{ConsentId}/funds-confirmation": { "get": { "tags": [ "International Scheduled Payments" ], "summary": "Get International Scheduled Payment Consents", "operationId": "GetInternationalScheduledPaymentConsentsConsentIdFundsConfirmation", "parameters": [ { "$ref": "#/parameters/ConsentId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200InternationalScheduledPaymentConsentsConsentIdFundsConfirmationRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "payments" ] } ] } }, "/international-scheduled-payments": { "post": { "tags": [ "International Scheduled Payments" ], "summary": "Create International Scheduled Payments", "operationId": "CreateInternationalScheduledPayments", "parameters": [ { "$ref": "#/parameters/OBWriteInternationalScheduled2Param" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" }, { "$ref": "#/parameters/x-idempotency-key" }, { "$ref": "#/parameters/x-jws-signature" } ], "responses": { "201": { "$ref": "#/responses/201InternationalScheduledPaymentsCreated" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "payments" ] } ] } }, "/international-scheduled-payments/{InternationalScheduledPaymentId}": { "get": { "tags": [ "International Scheduled Payments" ], "summary": "Get International Scheduled Payments", "operationId": "GetInternationalScheduledPaymentsInternationalScheduledPaymentId", "parameters": [ { "$ref": "#/parameters/InternationalScheduledPaymentId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200InternationalScheduledPaymentsInternationalScheduledPaymentIdRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } }, "/international-scheduled-payments/{InternationalScheduledPaymentId}/payment-details": { "get": { "tags": [ "Payment Details" ], "summary": "Get Payment Details", "operationId": "GetInternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetails", "parameters": [ { "$ref": "#/parameters/InternationalScheduledPaymentId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200InternationalScheduledPaymentsInternationalScheduledPaymentIdPaymentDetailsRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } }, "/international-standing-order-consents": { "post": { "tags": [ "International Standing Orders" ], "summary": "Create International Standing Order Consents", "operationId": "CreateInternationalStandingOrderConsents", "parameters": [ { "$ref": "#/parameters/OBWriteInternationalStandingOrderConsent4Param" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" }, { "$ref": "#/parameters/x-idempotency-key" }, { "$ref": "#/parameters/x-jws-signature" } ], "responses": { "201": { "$ref": "#/responses/201InternationalStandingOrderConsentsCreated" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } }, "/international-standing-order-consents/{ConsentId}": { "get": { "tags": [ "International Standing Orders" ], "summary": "Get International Standing Order Consents", "operationId": "GetInternationalStandingOrderConsentsConsentId", "parameters": [ { "$ref": "#/parameters/ConsentId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200InternationalStandingOrderConsentsConsentIdRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } }, "/international-standing-orders": { "post": { "tags": [ "International Standing Orders" ], "summary": "Create International Standing Orders", "operationId": "CreateInternationalStandingOrders", "parameters": [ { "$ref": "#/parameters/OBWriteInternationalStandingOrder3Param" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" }, { "$ref": "#/parameters/x-idempotency-key" }, { "$ref": "#/parameters/x-jws-signature" } ], "responses": { "201": { "$ref": "#/responses/201InternationalStandingOrdersCreated" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "PSUOAuth2Security": [ "payments" ] } ] } }, "/international-standing-orders/{InternationalStandingOrderPaymentId}": { "get": { "tags": [ "International Standing Orders" ], "summary": "Get International Standing Orders", "operationId": "GetInternationalStandingOrdersInternationalStandingOrderPaymentId", "parameters": [ { "$ref": "#/parameters/InternationalStandingOrderPaymentId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200InternationalStandingOrdersInternationalStandingOrderPaymentIdRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } }, "/international-standing-orders/{InternationalStandingOrderPaymentId}/payment-details": { "get": { "tags": [ "Payment Details" ], "summary": "Get Payment Details", "operationId": "GetInternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetails", "parameters": [ { "$ref": "#/parameters/InternationalStandingOrderPaymentId" }, { "$ref": "#/parameters/x-fapi-auth-date" }, { "$ref": "#/parameters/x-fapi-customer-ip-address" }, { "$ref": "#/parameters/x-fapi-interaction-id" }, { "$ref": "#/parameters/Authorization" } ], "responses": { "200": { "$ref": "#/responses/200InternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetailsRead" }, "400": { "$ref": "#/responses/400Error" }, "401": { "$ref": "#/responses/401Error" }, "403": { "$ref": "#/responses/403Error" }, "404": { "$ref": "#/responses/404Error" }, "405": { "$ref": "#/responses/405Error" }, "406": { "$ref": "#/responses/406Error" }, "429": { "$ref": "#/responses/429Error" }, "500": { "$ref": "#/responses/500Error" } }, "security": [ { "TPPOAuth2Security": [ "payments" ] } ] } } }, "parameters": { "OBWriteDomesticConsent3Param": { "name": "OBWriteDomesticConsent3Param", "in": "body", "description": "Default", "required": true, "schema": { "$ref": "#/definitions/OBWriteDomesticConsent3" } }, "ConsentId": { "name": "ConsentId", "in": "path", "description": "ConsentId", "required": true, "type": "string" }, "OBWriteDomestic2Param": { "name": "OBWriteDomestic2Param", "in": "body", "description": "Default", "required": true, "schema": { "$ref": "#/definitions/OBWriteDomestic2" } }, "DomesticPaymentId": { "name": "DomesticPaymentId", "in": "path", "description": "DomesticPaymentId", "required": true, "type": "string" }, "OBWriteDomesticScheduledConsent3Param": { "name": "OBWriteDomesticScheduledConsent3Param", "in": "body", "description": "Default", "required": true, "schema": { "$ref": "#/definitions/OBWriteDomesticScheduledConsent3" } }, "OBWriteDomesticScheduled2Param": { "name": "OBWriteDomesticScheduled2Param", "in": "body", "description": "Default", "required": true, "schema": { "$ref": "#/definitions/OBWriteDomesticScheduled2" } }, "DomesticScheduledPaymentId": { "name": "DomesticScheduledPaymentId", "in": "path", "description": "DomesticScheduledPaymentId", "required": true, "type": "string" }, "OBWriteDomesticStandingOrderConsent4Param": { "name": "OBWriteDomesticStandingOrderConsent4Param", "in": "body", "description": "Default", "required": true, "schema": { "$ref": "#/definitions/OBWriteDomesticStandingOrderConsent4" } }, "OBWriteDomesticStandingOrder3Param": { "name": "OBWriteDomesticStandingOrder3Param", "in": "body", "description": "Default", "required": true, "schema": { "$ref": "#/definitions/OBWriteDomesticStandingOrder3" } }, "DomesticStandingOrderId": { "name": "DomesticStandingOrderId", "in": "path", "description": "DomesticStandingOrderId", "required": true, "type": "string" }, "OBWriteInternationalConsent3Param": { "name": "OBWriteInternationalConsent3Param", "in": "body", "description": "Default", "required": true, "schema": { "$ref": "#/definitions/OBWriteInternationalConsent3" } }, "OBWriteInternational2Param": { "name": "OBWriteInternational2Param", "in": "body", "description": "Default", "required": true, "schema": { "$ref": "#/definitions/OBWriteInternational2" } }, "InternationalPaymentId": { "name": "InternationalPaymentId", "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" } }, "InternationalScheduledPaymentId": { "name": "InternationalScheduledPaymentId", "in": "path", "description": "InternationalScheduledPaymentId", "required": true, "type": "string" }, "OBWriteInternationalStandingOrderConsent4Param": { "name": "OBWriteInternationalStandingOrderConsent4Param", "in": "body", "description": "Default", "required": true, "schema": { "$ref": "#/definitions/OBWriteInternationalStandingOrderConsent4" } }, "OBWriteInternationalStandingOrder3Param": { "name": "OBWriteInternationalStandingOrder3Param", "in": "body", "description": "Default", "required": true, "schema": { "$ref": "#/definitions/OBWriteInternationalStandingOrder3" } }, "InternationalStandingOrderPaymentId": { "name": "InternationalStandingOrderPaymentId", "in": "path", "description": "InternationalStandingOrderPaymentId", "required": true, "type": "string" }, "OBWriteFileConsent3Param": { "name": "OBWriteFileConsent3Param", "in": "body", "description": "Default", "required": true, "schema": { "$ref": "#/definitions/OBWriteFileConsent3" } }, "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" } }, "FilePaymentId": { "name": "FilePaymentId", "in": "path", "description": "FilePaymentId", "required": true, "type": "string" }, "Authorization": { "in": "header", "name": "Authorization", "type": "string", "required": true, "description": "An Authorisation Token as per https://tools.ietf.org/html/rfc6750" }, "x-customer-user-agent": { "in": "header", "name": "x-customer-user-agent", "type": "string", "description": "Indicates the user-agent that the PSU is using.", "required": false }, "x-fapi-customer-ip-address": { "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-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)$" }, "x-fapi-interaction-id": { "in": "header", "name": "x-fapi-interaction-id", "type": "string", "required": false, "description": "An RFC4122 UID used as a correlation id." }, "x-idempotency-key": { "name": "x-idempotency-key", "in": "header", "description": "Every request will be processed only once per x-idempotency-key. The\nIdempotency Key will be valid for 24 hours.\n", "required": true, "type": "string", "pattern": "^(?!\\s)(.*)(\\S)$", "maxLength": 40 }, "x-jws-signature": { "in": "header", "name": "x-jws-signature", "type": "string", "required": true, "description": "A detached JWS signature of the body of the payload." } }, "responses": { "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.\n" } }, "schema": { "$ref": "#/definitions/OBWriteDomesticConsentResponse3" } }, "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.\n" } }, "schema": { "$ref": "#/definitions/OBWriteDomesticConsentResponse3" } }, "200DomesticPaymentConsentsConsentIdFundsConfirmationRead": { "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.\n" } }, "schema": { "$ref": "#/definitions/OBWriteFundsConfirmationResponse1" } }, "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.\n" } }, "schema": { "$ref": "#/definitions/OBWriteDomesticResponse3" } }, "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.\n" } }, "schema": { "$ref": "#/definitions/OBWriteDomesticResponse3" } }, "200DomesticPaymentsDomesticPaymentIdPaymentDetailsRead": { "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.\n" } }, "schema": { "$ref": "#/definitions/OBWritePaymentDetailsResponse1" } }, "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.\n" } }, "schema": { "$ref": "#/definitions/OBWriteDomesticScheduledConsentResponse3" } }, "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.\n" } }, "schema": { "$ref": "#/definitions/OBWriteDomesticScheduledConsentResponse3" } }, "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.\n" } }, "schema": { "$ref": "#/definitions/OBWriteDomesticScheduledResponse3" } }, "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.\n" } }, "schema": { "$ref": "#/definitions/OBWriteDomesticScheduledResponse3" } }, "200DomesticScheduledPaymentsDomesticScheduledPaymentIdPaymentDetailsRead": { "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.\n" } }, "schema": { "$ref": "#/definitions/OBWritePaymentDetailsResponse1" } }, "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.\n" } }, "schema": { "$ref": "#/definitions/OBWriteDomesticStandingOrderConsentResponse4" } }, "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.\n" } }, "schema": { "$ref": "#/definitions/OBWriteDomesticStandingOrderConsentResponse4" } }, "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.\n" } }, "schema": { "$ref": "#/definitions/OBWriteDomesticStandingOrderResponse4" } }, "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.\n" } }, "schema": { "$ref": "#/definitions/OBWriteDomesticStandingOrderResponse4" } }, "200DomesticStandingOrdersDomesticStandingOrderIdPaymentDetailsRead": { "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.\n" } }, "schema": { "$ref": "#/definitions/OBWritePaymentDetailsResponse1" } }, "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.\n" } }, "schema": { "$ref": "#/definitions/OBWriteInternationalConsentResponse3" } }, "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.\n" } }, "schema": { "$ref": "#/definitions/OBWriteInternationalConsentResponse3" } }, "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.\n" } }, "schema": { "$ref": "#/definitions/OBWriteFundsConfirmationResponse1" } }, "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.\n" } }, "schema": { "$ref": "#/definitions/OBWriteInternationalResponse3" } }, "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.\n" } }, "schema": { "$ref": "#/definitions/OBWriteInternationalResponse3" } }, "200InternationalPaymentsInternationalPaymentIdPaymentDetailsRead": { "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.\n" } }, "schema": { "$ref": "#/definitions/OBWritePaymentDetailsResponse1" } }, "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.\n" } }, "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.\n" } }, "schema": { "$ref": "#/definitions/OBWriteInternationalScheduledConsentResponse3" } }, "200InternationalScheduledPaymentConsentsConsentIdFundsConfirmationRead": { "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.\n" } }, "schema": { "$ref": "#/definitions/OBWriteFundsConfirmationResponse1" } }, "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.\n" } }, "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.\n" } }, "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.\n" } }, "schema": { "$ref": "#/definitions/OBWritePaymentDetailsResponse1" } }, "201InternationalStandingOrderConsentsCreated": { "description": "International 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.\n" } }, "schema": { "$ref": "#/definitions/OBWriteInternationalStandingOrderConsentResponse4" } }, "200InternationalStandingOrderConsentsConsentIdRead": { "description": "International 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.\n" } }, "schema": { "$ref": "#/definitions/OBWriteInternationalStandingOrderConsentResponse4" } }, "201InternationalStandingOrdersCreated": { "description": "International 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.\n" } }, "schema": { "$ref": "#/definitions/OBWriteInternationalStandingOrderResponse4" } }, "200InternationalStandingOrdersInternationalStandingOrderPaymentIdRead": { "description": "International 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.\n" } }, "schema": { "$ref": "#/definitions/OBWriteInternationalStandingOrderResponse4" } }, "200InternationalStandingOrdersInternationalStandingOrderPaymentIdPaymentDetailsRead": { "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.\n" } }, "schema": { "$ref": "#/definitions/OBWritePaymentDetailsResponse1" } }, "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.\n" } }, "schema": { "$ref": "#/definitions/OBWriteFileConsentResponse3" } }, "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.\n" } }, "schema": { "$ref": "#/definitions/OBWriteFileConsentResponse3" } }, "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.\n" } }, "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.\n" } }, "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.\n" } }, "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.\n" } }, "schema": { "$ref": "#/definitions/File" } }, "200FilePaymentsFilePaymentIdPaymentDetailsRead": { "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.\n" } }, "schema": { "$ref": "#/definitions/OBWritePaymentDetailsResponse1" } }, "400Error": { "description": "Bad request", "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.\n" } }, "schema": { "$ref": "#/definitions/OBErrorResponse1" } }, "401Error": { "description": "Unauthorized", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } } }, "403Error": { "description": "Forbidden", "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.\n" } }, "schema": { "$ref": "#/definitions/OBErrorResponse1" } }, "404Error": { "description": "Not found", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } } }, "405Error": { "description": "Method Not Allowed", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } } }, "406Error": { "description": "Not Acceptable", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } } }, "415Error": { "description": "Unsupported Media Type", "headers": { "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } } }, "429Error": { "description": "Too Many Requests", "headers": { "Retry-After": { "description": "Number in seconds to wait", "type": "integer" }, "x-fapi-interaction-id": { "type": "string", "description": "An RFC4122 UID used as a correlation id." } } }, "500Error": { "description": "Internal Server Error", "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.\n" } }, "schema": { "$ref": "#/definitions/OBErrorResponse1" } } }, "securityDefinitions": { "TPPOAuth2Security": { "type": "oauth2", "flow": "application", "tokenUrl": "https://authserver.example/token", "scopes": { "payments": "Generic payment scope" }, "description": "TPP client credential authorisation flow with the ASPSP" }, "PSUOAuth2Security": { "type": "oauth2", "flow": "accessCode", "tokenUrl": "https://authserver.example/token", "authorizationUrl": "https://authserver.example/authorization", "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" } }, "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}$" }, "BuildingNumber": { "description": "Number that identifies the position of a building on a street.", "type": "string", "minLength": 1, "maxLength": 16 }, "CountryCode": { "description": "Nation with its own government.", "type": "string", "pattern": "^[A-Z]{2,2}$" }, "CountrySubDivision": { "description": "Identifies a subdivision of a country such as state, region, county.", "type": "string", "minLength": 1, "maxLength": 35 }, "Department": { "description": "Identification of a division of a large organisation or building.", "type": "string", "minLength": 1, "maxLength": 70 }, "File": { "type": "object", "properties": {} }, "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 }, "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 }, "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" ] }, "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" ] }, "OBError1": { "type": "object", "properties": { "ErrorCode": { "description": "Low level textual error code, e.g., UK.OBIE.Field.Missing", "type": "string", "x-namespaced-enum": [ "UK.OBIE.Field.Expected", "UK.OBIE.Field.Invalid", "UK.OBIE.Field.InvalidDate", "UK.OBIE.Field.Missing", "UK.OBIE.Field.Unexpected", "UK.OBIE.Header.Invalid", "UK.OBIE.Header.Missing", "UK.OBIE.Reauthenticate", "UK.OBIE.Resource.ConsentMismatch", "UK.OBIE.Resource.InvalidConsentStatus", "UK.OBIE.Resource.InvalidFormat", "UK.OBIE.Resource.NotFound", "UK.OBIE.Rules.AfterCutOffDateTime", "UK.OBIE.Rules.DuplicateReference", "UK.OBIE.Signature.Invalid", "UK.OBIE.Signature.InvalidClaim", "UK.OBIE.Signature.Malformed", "UK.OBIE.Signature.Missing", "UK.OBIE.Signature.MissingClaim", "UK.OBIE.Signature.Unexpected", "UK.OBIE.UnexpectedError", "UK.OBIE.Unsupported.AccountIdentifier", "UK.OBIE.Unsupported.AccountSecondaryIdentifier", "UK.OBIE.Unsupported.Currency", "UK.OBIE.Unsupported.Frequency", "UK.OBIE.Unsupported.LocalInstrument", "UK.OBIE.Unsupported.Scheme" ] }, "Message": { "description": "A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future'\nOBIE 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 }, "OBExternalAccountIdentification4Code": { "description": "Name of the identification scheme, in a coded form as published in an external list.", "type": "string", "x-namespaced-enum": [ "UK.OBIE.BBAN", "UK.OBIE.IBAN", "UK.OBIE.PAN", "UK.OBIE.Paym", "UK.OBIE.SortCodeAccountNumber" ] }, "OBExternalLocalInstrument1Code": { "description": "User community specific instrument.\nUsage: This element is used to specify a local instrument, local clearing option and/or further qualify the service or service level.", "type": "string", "x-namespaced-enum": [ "UK.OBIE.BACS", "UK.OBIE.BalanceTransfer", "UK.OBIE.CHAPS", "UK.OBIE.Euro1", "UK.OBIE.FPS", "UK.OBIE.Link", "UK.OBIE.MoneyTransfer", "UK.OBIE.Paym", "UK.OBIE.SEPACreditTransfer", "UK.OBIE.SEPAInstantCreditTransfer", "UK.OBIE.SWIFT", "UK.OBIE.Target2" ] }, "OBExternalPaymentChargeType1Code": { "description": "Charge type, in a coded form.", "type": "string", "x-namespaced-enum": [ "UK.OBIE.CHAPSOut" ] }, "OBPostalAddress6": { "type": "object", "description": "Information that locates and identifies a specific address, as defined by postal services.", "properties": { "AddressType": { "$ref": "#/definitions/OBAddressTypeCode" }, "Department": { "$ref": "#/definitions/Department" }, "SubDepartment": { "$ref": "#/definitions/SubDepartment" }, "StreetName": { "$ref": "#/definitions/StreetName" }, "BuildingNumber": { "$ref": "#/definitions/BuildingNumber" }, "PostCode": { "$ref": "#/definitions/PostCode" }, "TownName": { "$ref": "#/definitions/TownName" }, "CountrySubDivision": { "$ref": "#/definitions/CountrySubDivision" }, "Country": { "$ref": "#/definitions/CountryCode" }, "AddressLine": { "type": "array", "items": { "description": "Information that locates and identifies a specific address, as defined by postal services, presented in free format text.", "type": "string", "minLength": 1, "maxLength": 70 }, "minItems": 0, "maxItems": 7 } } }, "OBRisk1": { "type": "object", "description": "The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Payments.", "properties": { "PaymentContextCode": { "description": "Specifies the payment context", "type": "string", "enum": [ "BillPayment", "EcommerceGoods", "EcommerceServices", "Other", "PartyToParty" ] }, "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": { "type": "object", "required": [ "TownName", "Country" ], "description": "Information that locates and identifies a specific address, as defined by postal services or in free format text.", "properties": { "AddressLine": { "type": "array", "items": { "description": "Information that locates and identifies a specific address, as defined by postal services, that is presented in free format text.", "type": "string", "minLength": 1, "maxLength": 70 }, "minItems": 0, "maxItems": 2 }, "StreetName": { "$ref": "#/definitions/StreetName" }, "BuildingNumber": { "$ref": "#/definitions/BuildingNumber" }, "PostCode": { "$ref": "#/definitions/PostCode" }, "TownName": { "$ref": "#/definitions/TownName" }, "CountrySubDivision": { "type": "array", "items": { "description": "Identifies a subdivision of a country, for instance state, region, county.", "type": "string", "minLength": 1, "maxLength": 35 }, "minItems": 0, "maxItems": 2 }, "Country": { "description": "Nation with its own government, occupying a particular territory.", "type": "string", "pattern": "^[A-Z]{2,2}$" } } } } }, "OBSupplementaryData1": { "type": "object", "properties": {}, "additionalProperties": true, "description": "Additional information that can not be captured in the structured fields and/or any other specific block." }, "OBWriteDomestic2": { "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", "EndToEndIdentification", "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 domestic payment.", "properties": { "InstructionIdentification": { "description": "Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.\nUsage: 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.\nUsage: 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.\nOB: 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", "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.\nUsage: This amount has to be transported unchanged through the transaction chain.", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode" } } }, "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.\nNote, the account name is not the product name or the nickname of the account.", "type": "string", "minLength": 1, "maxLength": 70 }, "SecondaryIdentification": { "$ref": "#/definitions/SecondaryIdentification" } } }, "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.\nNote, the account name is not the product name or the nickname of the account.\nOB: 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" } } }, "CreditorPostalAddress": { "$ref": "#/definitions/OBPostalAddress6" }, "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.\nUsage: 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.\nIf 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.\nOB: 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" } } }, "OBWriteDomesticConsent3": { "type": "object", "required": [ "Data", "Risk" ], "properties": { "Data": { "type": "object", "required": [ "Initiation" ], "properties": { "Initiation": { "type": "object", "required": [ "InstructionIdentification", "EndToEndIdentification", "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 domestic payment.", "properties": { "InstructionIdentification": { "description": "Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.\nUsage: 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.\nUsage: 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.\nOB: 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", "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.\nUsage: This amount has to be transported unchanged through the transaction chain.", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode" } } }, "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.\nNote, the account name is not the product name or the nickname of the account.", "type": "string", "minLength": 1, "maxLength": 70 }, "SecondaryIdentification": { "$ref": "#/definitions/SecondaryIdentification" } } }, "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.\nNote, the account name is not the product name or the nickname of the account.\nOB: 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" } } }, "CreditorPostalAddress": { "$ref": "#/definitions/OBPostalAddress6" }, "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.\nUsage: 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.\nIf 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.\nOB: 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.\nUsage: 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.\nUsage: 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" } } }, "OBWriteDomesticConsentResponse3": { "type": "object", "required": [ "Data", "Risk" ], "properties": { "Data": { "type": "object", "required": [ "ConsentId", "CreationDateTime", "Status", "StatusUpdateDateTime", "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" }, "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" } } } }, "Initiation": { "type": "object", "required": [ "InstructionIdentification", "EndToEndIdentification", "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 domestic payment.", "properties": { "InstructionIdentification": { "description": "Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.\nUsage: 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.\nUsage: 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.\nOB: 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", "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.\nUsage: This amount has to be transported unchanged through the transaction chain.", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode" } } }, "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.\nNote, the account name is not the product name or the nickname of the account.", "type": "string", "minLength": 1, "maxLength": 70 }, "SecondaryIdentification": { "$ref": "#/definitions/SecondaryIdentification" } } }, "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.\nNote, the account name is not the product name or the nickname of the account.\nOB: 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" } } }, "CreditorPostalAddress": { "$ref": "#/definitions/OBPostalAddress6" }, "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.\nUsage: 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.\nIf 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.\nOB: 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.\nUsage: 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.\nUsage: 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" } } }, "OBWriteDomesticResponse3": { "type": "object", "required": [ "Data" ], "properties": { "Data": { "type": "object", "required": [ "DomesticPaymentId", "ConsentId", "CreationDateTime", "Status", "StatusUpdateDateTime", "Initiation" ], "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.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 information group.", "type": "string", "enum": [ "AcceptedCreditSettlementCompleted", "AcceptedSettlementCompleted", "AcceptedSettlementInProcess", "AcceptedWithoutPosting", "Pending", "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" }, "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" } } } }, "Initiation": { "type": "object", "required": [ "InstructionIdentification", "EndToEndIdentification", "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 domestic payment.", "properties": { "InstructionIdentification": { "description": "Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.\nUsage: 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.\nUsage: 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.\nOB: 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", "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.\nUsage: This amount has to be transported unchanged through the transaction chain.", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode" } } }, "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.\nNote, the account name is not the product name or the nickname of the account.", "type": "string", "minLength": 1, "maxLength": 70 }, "SecondaryIdentification": { "$ref": "#/definitions/SecondaryIdentification" } } }, "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.\nNote, the account name is not the product name or the nickname of the account.\nOB: 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" } } }, "CreditorPostalAddress": { "$ref": "#/definitions/OBPostalAddress6" }, "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.\nUsage: 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.\nIf 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.\nOB: 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" } } }, "OBWriteDomesticScheduled2": { "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", "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 domestic payment.", "properties": { "InstructionIdentification": { "description": "Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.\nUsage: 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.\nUsage: 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.\nOB: 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.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" }, "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.\nUsage: This amount has to be transported unchanged through the transaction chain.", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode" } } }, "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.\nNote, the account name is not the product name or the nickname of the account.", "type": "string", "minLength": 1, "maxLength": 70 }, "SecondaryIdentification": { "$ref": "#/definitions/SecondaryIdentification" } } }, "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.\nNote, the account name is not the product name or the nickname of the account.\nOB: 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" } } }, "CreditorPostalAddress": { "$ref": "#/definitions/OBPostalAddress6" }, "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.\nUsage: 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.\nIf 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.\nOB: 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" } } }, "OBWriteDomesticScheduledConsent3": { "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", "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 domestic payment.", "properties": { "InstructionIdentification": { "description": "Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.\nUsage: 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.\nUsage: 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.\nOB: 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.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" }, "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.\nUsage: This amount has to be transported unchanged through the transaction chain.", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode" } } }, "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.\nNote, the account name is not the product name or the nickname of the account.", "type": "string", "minLength": 1, "maxLength": 70 }, "SecondaryIdentification": { "$ref": "#/definitions/SecondaryIdentification" } } }, "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.\nNote, the account name is not the product name or the nickname of the account.\nOB: 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" } } }, "CreditorPostalAddress": { "$ref": "#/definitions/OBPostalAddress6" }, "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.\nUsage: 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.\nIf 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.\nOB: 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.\nUsage: 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.\nUsage: 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" } } }, "OBWriteDomesticScheduledConsentResponse3": { "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 consent resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00", "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" } } } }, "Initiation": { "type": "object", "required": [ "InstructionIdentification", "RequestedExecutionDateTime", "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 domestic payment.", "properties": { "InstructionIdentification": { "description": "Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.\nUsage: 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.\nUsage: 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.\nOB: 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.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" }, "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.\nUsage: This amount has to be transported unchanged through the transaction chain.", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode" } } }, "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.\nNote, the account name is not the product name or the nickname of the account.", "type": "string", "minLength": 1, "maxLength": 70 }, "SecondaryIdentification": { "$ref": "#/definitions/SecondaryIdentification" } } }, "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.\nNote, the account name is not the product name or the nickname of the account.\nOB: 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" } } }, "CreditorPostalAddress": { "$ref": "#/definitions/OBPostalAddress6" }, "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.\nUsage: 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.\nIf 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.\nOB: 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.\nUsage: 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.\nUsage: 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" } } }, "OBWriteDomesticScheduledResponse3": { "type": "object", "required": [ "Data" ], "properties": { "Data": { "type": "object", "required": [ "DomesticScheduledPaymentId", "ConsentId", "CreationDateTime", "Status", "StatusUpdateDateTime", "Initiation" ], "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.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" } } } }, "Initiation": { "type": "object", "required": [ "InstructionIdentification", "RequestedExecutionDateTime", "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 domestic payment.", "properties": { "InstructionIdentification": { "description": "Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.\nUsage: 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.\nUsage: 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.\nOB: 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.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" }, "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.\nUsage: This amount has to be transported unchanged through the transaction chain.", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode" } } }, "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.\nNote, the account name is not the product name or the nickname of the account.", "type": "string", "minLength": 1, "maxLength": 70 }, "SecondaryIdentification": { "$ref": "#/definitions/SecondaryIdentification" } } }, "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.\nNote, the account name is not the product name or the nickname of the account.\nOB: 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" } } }, "CreditorPostalAddress": { "$ref": "#/definitions/OBPostalAddress6" }, "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.\nUsage: 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.\nIf 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.\nOB: 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" } } }, "OBWriteDomesticStandingOrder3": { "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": [ "Frequency", "FirstPaymentDateTime", "FirstPaymentAmount", "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 domestic standing order.", "properties": { "Frequency": { "description": "Individual Definitions:\nEvryDay - Every day\nEvryWorkgDay - Every working day\nIntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)\nWkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07)\nIntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31)\nQtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). \nENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. \nSCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November.\nRECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. \nIndividual Patterns:\nEvryDay (ScheduleCode)\nEvryWorkgDay (ScheduleCode)\nIntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)\nWkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)\nIntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)\nQtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay\nThe regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:\nEvryDay\nEvryWorkgDay\nIntrvlWkDay:0[1-9]:0[1-7]\nWkInMnthDay:0[1-5]:0[1-7]\nIntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])\nQtrDay:(ENGLISH|SCOTTISH|RECEIVED)\nFull Regular Expression:\n^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$", "type": "string", "pattern": "^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$" }, "Reference": { "description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.\nUsage: 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.\nIf the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.", "type": "string", "minLength": 1, "maxLength": 35 }, "NumberOfPayments": { "description": "Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.", "type": "string", "minLength": 1, "maxLength": 35 }, "FirstPaymentDateTime": { "description": "The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00", "type": "string", "format": "date-time" }, "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.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00", "type": "string", "format": "date-time" }, "FinalPaymentDateTime": { "description": "The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00", "type": "string", "format": "date-time" }, "FirstPaymentAmount": { "type": "object", "required": [ "Amount", "Currency" ], "description": "The amount of the first Standing Order", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode" } } }, "RecurringPaymentAmount": { "type": "object", "required": [ "Amount", "Currency" ], "description": "The amount of the recurring Standing Order", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode" } } }, "FinalPaymentAmount": { "type": "object", "required": [ "Amount", "Currency" ], "description": "The amount of the final Standing Order", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode" } } }, "DebtorAccount": { "type": "object", "required": [ "SchemeName", "Identification" ], "description": "Provides the details to identify the debtor account.", "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.\nNote, the account name is not the product name or the nickname of the account.", "type": "string", "minLength": 1, "maxLength": 70 }, "SecondaryIdentification": { "$ref": "#/definitions/SecondaryIdentification" } } }, "CreditorAccount": { "type": "object", "required": [ "SchemeName", "Identification", "Name" ], "description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.", "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.\nNote, the account name is not the product name or the nickname of the account.\nOB: 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" } } }, "SupplementaryData": { "$ref": "#/definitions/OBSupplementaryData1" } } } } }, "Risk": { "$ref": "#/definitions/OBRisk1" } } }, "OBWriteDomesticStandingOrderConsent4": { "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": [ "Frequency", "FirstPaymentDateTime", "FirstPaymentAmount", "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 domestic standing order.", "properties": { "Frequency": { "description": "Individual Definitions:\nEvryDay - Every day\nEvryWorkgDay - Every working day\nIntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)\nWkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07)\nIntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31)\nQtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). \nENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. \nSCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November.\nRECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. \nIndividual Patterns:\nEvryDay (ScheduleCode)\nEvryWorkgDay (ScheduleCode)\nIntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)\nWkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)\nIntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)\nQtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay\nThe regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:\nEvryDay\nEvryWorkgDay\nIntrvlWkDay:0[1-9]:0[1-7]\nWkInMnthDay:0[1-5]:0[1-7]\nIntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])\nQtrDay:(ENGLISH|SCOTTISH|RECEIVED)\nFull Regular Expression:\n^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$", "type": "string", "pattern": "^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$" }, "Reference": { "description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.\nUsage: 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.\nIf the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.", "type": "string", "minLength": 1, "maxLength": 35 }, "NumberOfPayments": { "description": "Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.", "type": "string", "minLength": 1, "maxLength": 35 }, "FirstPaymentDateTime": { "description": "The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00", "type": "string", "format": "date-time" }, "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.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00", "type": "string", "format": "date-time" }, "FinalPaymentDateTime": { "description": "The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00", "type": "string", "format": "date-time" }, "FirstPaymentAmount": { "type": "object", "required": [ "Amount", "Currency" ], "description": "The amount of the first Standing Order", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode" } } }, "RecurringPaymentAmount": { "type": "object", "required": [ "Amount", "Currency" ], "description": "The amount of the recurring Standing Order", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode" } } }, "FinalPaymentAmount": { "type": "object", "required": [ "Amount", "Currency" ], "description": "The amount of the final Standing Order", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode" } } }, "DebtorAccount": { "type": "object", "required": [ "SchemeName", "Identification" ], "description": "Provides the details to identify the debtor account.", "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.\nNote, the account name is not the product name or the nickname of the account.", "type": "string", "minLength": 1, "maxLength": 70 }, "SecondaryIdentification": { "$ref": "#/definitions/SecondaryIdentification" } } }, "CreditorAccount": { "type": "object", "required": [ "SchemeName", "Identification", "Name" ], "description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.", "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.\nNote, the account name is not the product name or the nickname of the account.\nOB: 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" } } }, "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.\nUsage: 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.\nUsage: 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" } } }, "OBWriteDomesticStandingOrderConsentResponse4": { "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" }, "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" } } } }, "Initiation": { "type": "object", "required": [ "Frequency", "FirstPaymentDateTime", "FirstPaymentAmount", "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 domestic standing order.", "properties": { "Frequency": { "description": "Individual Definitions:\nEvryDay - Every day\nEvryWorkgDay - Every working day\nIntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)\nWkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07)\nIntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31)\nQtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). \nENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. \nSCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November.\nRECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. \nIndividual Patterns:\nEvryDay (ScheduleCode)\nEvryWorkgDay (ScheduleCode)\nIntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)\nWkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)\nIntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)\nQtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay\nThe regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:\nEvryDay\nEvryWorkgDay\nIntrvlWkDay:0[1-9]:0[1-7]\nWkInMnthDay:0[1-5]:0[1-7]\nIntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])\nQtrDay:(ENGLISH|SCOTTISH|RECEIVED)\nFull Regular Expression:\n^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$", "type": "string", "pattern": "^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$" }, "Reference": { "description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.\nUsage: 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.\nIf the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.", "type": "string", "minLength": 1, "maxLength": 35 }, "NumberOfPayments": { "description": "Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.", "type": "string", "minLength": 1, "maxLength": 35 }, "FirstPaymentDateTime": { "description": "The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00", "type": "string", "format": "date-time" }, "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.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00", "type": "string", "format": "date-time" }, "FinalPaymentDateTime": { "description": "The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00", "type": "string", "format": "date-time" }, "FirstPaymentAmount": { "type": "object", "required": [ "Amount", "Currency" ], "description": "The amount of the first Standing Order", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode" } } }, "RecurringPaymentAmount": { "type": "object", "required": [ "Amount", "Currency" ], "description": "The amount of the recurring Standing Order", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode" } } }, "FinalPaymentAmount": { "type": "object", "required": [ "Amount", "Currency" ], "description": "The amount of the final Standing Order", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode" } } }, "DebtorAccount": { "type": "object", "required": [ "SchemeName", "Identification" ], "description": "Provides the details to identify the debtor account.", "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.\nNote, the account name is not the product name or the nickname of the account.", "type": "string", "minLength": 1, "maxLength": 70 }, "SecondaryIdentification": { "$ref": "#/definitions/SecondaryIdentification" } } }, "CreditorAccount": { "type": "object", "required": [ "SchemeName", "Identification", "Name" ], "description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.", "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.\nNote, the account name is not the product name or the nickname of the account.\nOB: 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" } } }, "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.\nUsage: 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.\nUsage: 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" } } }, "OBWriteDomesticStandingOrderResponse4": { "type": "object", "required": [ "Data" ], "properties": { "Data": { "type": "object", "required": [ "DomesticStandingOrderId", "ConsentId", "CreationDateTime", "Status", "StatusUpdateDateTime", "Initiation" ], "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.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" }, "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" } } } }, "Initiation": { "type": "object", "required": [ "Frequency", "FirstPaymentDateTime", "FirstPaymentAmount", "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 domestic standing order.", "properties": { "Frequency": { "description": "Individual Definitions:\nEvryDay - Every day\nEvryWorkgDay - Every working day\nIntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)\nWkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07)\nIntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31)\nQtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). \nENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. \nSCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November.\nRECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. \nIndividual Patterns:\nEvryDay (ScheduleCode)\nEvryWorkgDay (ScheduleCode)\nIntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)\nWkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)\nIntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)\nQtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay\nThe regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:\nEvryDay\nEvryWorkgDay\nIntrvlWkDay:0[1-9]:0[1-7]\nWkInMnthDay:0[1-5]:0[1-7]\nIntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])\nQtrDay:(ENGLISH|SCOTTISH|RECEIVED)\nFull Regular Expression:\n^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$", "type": "string", "pattern": "^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$" }, "Reference": { "description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.\nUsage: 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.\nIf the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.", "type": "string", "minLength": 1, "maxLength": 35 }, "NumberOfPayments": { "description": "Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.", "type": "string", "minLength": 1, "maxLength": 35 }, "FirstPaymentDateTime": { "description": "The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00", "type": "string", "format": "date-time" }, "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.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00", "type": "string", "format": "date-time" }, "FinalPaymentDateTime": { "description": "The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00", "type": "string", "format": "date-time" }, "FirstPaymentAmount": { "type": "object", "required": [ "Amount", "Currency" ], "description": "The amount of the first Standing Order", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode" } } }, "RecurringPaymentAmount": { "type": "object", "required": [ "Amount", "Currency" ], "description": "The amount of the recurring Standing Order", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode" } } }, "FinalPaymentAmount": { "type": "object", "required": [ "Amount", "Currency" ], "description": "The amount of the final Standing Order", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode" } } }, "DebtorAccount": { "type": "object", "required": [ "SchemeName", "Identification" ], "description": "Provides the details to identify the debtor account.", "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.\nNote, the account name is not the product name or the nickname of the account.", "type": "string", "minLength": 1, "maxLength": 70 }, "SecondaryIdentification": { "$ref": "#/definitions/SecondaryIdentification" } } }, "CreditorAccount": { "type": "object", "required": [ "SchemeName", "Identification", "Name" ], "description": "Identification assigned by an institution to identify an account. This identification is known by the account owner.", "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.\nNote, the account name is not the product name or the nickname of the account.\nOB: 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" } } }, "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" } } }, "OBWriteFile2": { "type": "object", "required": [ "Data" ], "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": [ "FileType", "FileHash" ], "description": "The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.", "properties": { "FileType": { "description": "Specifies the payment file type.", "type": "string", "x-namespaced-enum": [ "UK.OBIE.PaymentInitiation.3.1", "UK.OBIE.pain.001.001.08" ] }, "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", "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.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" }, "LocalInstrument": { "$ref": "#/definitions/OBExternalLocalInstrument1Code" }, "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.\nNote, the account name is not the product name or the nickname of the account.", "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.\nUsage: 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.\nIf 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.\nOB: 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" } } } } } } }, "OBWriteFileConsent3": { "type": "object", "required": [ "Data" ], "properties": { "Data": { "type": "object", "required": [ "Initiation" ], "properties": { "Initiation": { "type": "object", "required": [ "FileType", "FileHash" ], "description": "The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.", "properties": { "FileType": { "description": "Specifies the payment file type.", "type": "string", "x-namespaced-enum": [ "UK.OBIE.PaymentInitiation.3.1", "UK.OBIE.pain.001.001.08" ] }, "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", "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.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" }, "LocalInstrument": { "$ref": "#/definitions/OBExternalLocalInstrument1Code" }, "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.\nNote, the account name is not the product name or the nickname of the account.", "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.\nUsage: 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.\nIf 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.\nOB: 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.\nUsage: 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.\nUsage: 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 } } } } } } }, "OBWriteFileConsentResponse3": { "type": "object", "required": [ "Data" ], "properties": { "Data": { "type": "object", "required": [ "ConsentId", "CreationDateTime", "Status", "StatusUpdateDateTime", "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", "AwaitingUpload", "Consumed", "Rejected" ] }, "StatusUpdateDateTime": { "description": "Date and time at which the consent resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00", "type": "string", "format": "date-time" }, "CutOffDateTime": { "description": "Specified cut-off date and time for the payment consent.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00", "type": "string", "format": "date-time" }, "Charges": { "type": "array", "items": { "type": "object", "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" } } } }, "Initiation": { "type": "object", "required": [ "FileType", "FileHash" ], "description": "The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.", "properties": { "FileType": { "description": "Specifies the payment file type.", "type": "string", "x-namespaced-enum": [ "UK.OBIE.PaymentInitiation.3.1", "UK.OBIE.pain.001.001.08" ] }, "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", "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.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" }, "LocalInstrument": { "$ref": "#/definitions/OBExternalLocalInstrument1Code" }, "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.\nNote, the account name is not the product name or the nickname of the account.", "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.\nUsage: 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.\nIf 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.\nOB: 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.\nUsage: 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.\nUsage: 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 } } } } }, "Links": { "$ref": "#/definitions/Links" }, "Meta": { "$ref": "#/definitions/Meta" } } }, "OBWriteFileResponse2": { "type": "object", "required": [ "Data" ], "properties": { "Data": { "type": "object", "required": [ "FilePaymentId", "ConsentId", "CreationDateTime", "Status", "StatusUpdateDateTime", "Initiation" ], "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.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": [ "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" }, "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" } } } }, "Initiation": { "type": "object", "required": [ "FileType", "FileHash" ], "description": "The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds using a payment file.", "properties": { "FileType": { "description": "Specifies the payment file type.", "type": "string", "x-namespaced-enum": [ "UK.OBIE.PaymentInitiation.3.1", "UK.OBIE.pain.001.001.08" ] }, "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", "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.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" }, "LocalInstrument": { "$ref": "#/definitions/OBExternalLocalInstrument1Code" }, "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.\nNote, the account name is not the product name or the nickname of the account.", "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.\nUsage: 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.\nIf 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.\nOB: 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", "required": [ "Data" ], "properties": { "Data": { "type": "object", "properties": { "FundsAvailableResult": { "type": "object", "required": [ "FundsAvailableDateTime", "FundsAvailable" ], "description": "Result of a funds availability check.", "properties": { "FundsAvailableDateTime": { "description": "Date and time at which the funds availability check was generated.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00", "type": "string", "format": "date-time" }, "FundsAvailable": { "description": "Flag to indicate the availability of funds given the Amount in the consent request.", "type": "boolean" } } }, "SupplementaryData": { "$ref": "#/definitions/OBSupplementaryData1" } } }, "Links": { "$ref": "#/definitions/Links" }, "Meta": { "$ref": "#/definitions/Meta" } } }, "OBWriteInternational2": { "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", "EndToEndIdentification", "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 international payment.", "properties": { "InstructionIdentification": { "description": "Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.\nUsage: 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.\nUsage: 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.\nOB: 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.\nThe list of valid codes is an external code list published separately.\nExternal code sets can be downloaded from www.iso20022.org.", "type": "string" }, "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", "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.\nUsage: 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.\nNote, 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.\nNote, the account name is not the product name or the nickname of the account.\nOB: 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.\nUsage: 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.\nIf 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.\nOB: 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" } } }, "OBWriteInternationalConsent3": { "type": "object", "required": [ "Data", "Risk" ], "properties": { "Data": { "type": "object", "required": [ "Initiation" ], "properties": { "Initiation": { "type": "object", "required": [ "InstructionIdentification", "EndToEndIdentification", "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 international payment.", "properties": { "InstructionIdentification": { "description": "Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.\nUsage: 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.\nUsage: 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.\nOB: 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.\nThe list of valid codes is an external code list published separately.\nExternal code sets can be downloaded from www.iso20022.org.", "type": "string" }, "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", "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.\nUsage: 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.\nNote, 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.\nNote, the account name is not the product name or the nickname of the account.\nOB: 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.\nUsage: 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.\nIf 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.\nOB: 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.\nUsage: 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.\nUsage: 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" } } }, "OBWriteInternationalConsentResponse3": { "type": "object", "required": [ "Data", "Risk" ], "properties": { "Data": { "type": "object", "required": [ "ConsentId", "CreationDateTime", "Status", "StatusUpdateDateTime", "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" }, "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", "EndToEndIdentification", "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 international payment.", "properties": { "InstructionIdentification": { "description": "Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.\nUsage: 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.\nUsage: 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.\nOB: 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.\nThe list of valid codes is an external code list published separately.\nExternal code sets can be downloaded from www.iso20022.org.", "type": "string" }, "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", "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.\nUsage: 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.\nNote, 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.\nNote, the account name is not the product name or the nickname of the account.\nOB: 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.\nUsage: 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.\nIf 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.\nOB: 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.\nUsage: 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.\nUsage: 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" } } }, "OBWriteInternationalResponse3": { "type": "object", "required": [ "Data" ], "properties": { "Data": { "type": "object", "required": [ "InternationalPaymentId", "ConsentId", "CreationDateTime", "Status", "StatusUpdateDateTime", "Initiation" ], "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.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 information group.", "type": "string", "enum": [ "AcceptedCreditSettlementCompleted", "AcceptedSettlementCompleted", "AcceptedSettlementInProcess", "AcceptedWithoutPosting", "Pending", "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" }, "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", "EndToEndIdentification", "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 international payment.", "properties": { "InstructionIdentification": { "description": "Unique identification as assigned by an instructing party for an instructed party to unambiguously identify the instruction.\nUsage: 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.\nUsage: 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.\nOB: 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.\nThe list of valid codes is an external code list published separately.\nExternal code sets can be downloaded from www.iso20022.org.", "type": "string" }, "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", "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.\nUsage: 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.\nNote, 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.\nNote, the account name is not the product name or the nickname of the account.\nOB: 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.\nUsage: 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.\nIf 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.\nOB: 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" } } }, "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.\nUsage: 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.\nUsage: 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.\nOB: 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.\nThe list of valid codes is an external code list published separately.\nExternal 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.\nUsage: 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.\nNote, 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.\nNote, the account name is not the product name or the nickname of the account.\nOB: 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.\nUsage: 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.\nIf 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.\nOB: 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" } } }, "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.\nUsage: 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.\nUsage: 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.\nOB: 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.\nThe list of valid codes is an external code list published separately.\nExternal 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.\nUsage: 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.\nNote, 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.\nNote, the account name is not the product name or the nickname of the account.\nOB: 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.\nUsage: 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.\nIf 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.\nOB: 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.\nUsage: 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.\nUsage: 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.\nUsage: 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.\nUsage: 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.\nOB: 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.\nThe list of valid codes is an external code list published separately.\nExternal 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.\nUsage: 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.\nNote, 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.\nNote, the account name is not the product name or the nickname of the account.\nOB: 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.\nUsage: 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.\nIf 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.\nOB: 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.\nUsage: 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.\nUsage: 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" } } }, "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.\nUsage: 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.\nUsage: 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.\nOB: 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.\nThe list of valid codes is an external code list published separately.\nExternal 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.\nUsage: 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.\nNote, 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.\nNote, the account name is not the product name or the nickname of the account.\nOB: 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.\nUsage: 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.\nIf 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.\nOB: 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" } } }, "OBWriteInternationalStandingOrder3": { "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": [ "Frequency", "FirstPaymentDateTime", "CurrencyOfTransfer", "InstructedAmount", "CreditorAccount" ], "description": "The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for an international standing order.", "properties": { "Frequency": { "description": "Individual Definitions:\nEvryDay - Every day\nEvryWorkgDay - Every working day\nIntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)\nWkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07)\nIntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31)\nQtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). \nENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. \nSCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November.\nRECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. \nIndividual Patterns:\nEvryDay (ScheduleCode)\nEvryWorkgDay (ScheduleCode)\nIntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)\nWkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)\nIntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)\nQtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay\nThe regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:\nEvryDay\nEvryWorkgDay\nIntrvlWkDay:0[1-9]:0[1-7]\nWkInMnthDay:0[1-5]:0[1-7]\nIntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])\nQtrDay:(ENGLISH|SCOTTISH|RECEIVED)\nFull Regular Expression:\n^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$", "type": "string", "pattern": "^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$" }, "Reference": { "description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.\nUsage: 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.\nIf the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.", "type": "string", "minLength": 1, "maxLength": 35 }, "NumberOfPayments": { "description": "Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.", "type": "string", "minLength": 1, "maxLength": 35 }, "FirstPaymentDateTime": { "description": "The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00", "type": "string", "format": "date-time" }, "FinalPaymentDateTime": { "description": "The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00", "type": "string", "format": "date-time" }, "Purpose": { "description": "Specifies the external purpose code in the format of character string with a maximum length of 4 characters.\nThe list of valid codes is an external code list published separately.\nExternal code sets can be downloaded from www.iso20022.org.", "type": "string" }, "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", "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.\nUsage: This amount has to be transported unchanged through the transaction chain.", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode" } } }, "DebtorAccount": { "type": "object", "required": [ "SchemeName", "Identification" ], "description": "Provides the details to identify the debtor account.", "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.\nNote, 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": "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.\nThis is the servicer of the beneficiary account.", "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 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" } } }, "CreditorAccount": { "type": "object", "required": [ "SchemeName", "Identification", "Name" ], "description": "Provides the details to identify the beneficiary account.", "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.\nNote, the account name is not the product name or the nickname of the account.\nOB: 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" } } }, "SupplementaryData": { "$ref": "#/definitions/OBSupplementaryData1" } } } } }, "Risk": { "$ref": "#/definitions/OBRisk1" } } }, "OBWriteInternationalStandingOrderConsent4": { "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": [ "Frequency", "FirstPaymentDateTime", "CurrencyOfTransfer", "InstructedAmount", "CreditorAccount" ], "description": "The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for an international standing order.", "properties": { "Frequency": { "description": "Individual Definitions:\nEvryDay - Every day\nEvryWorkgDay - Every working day\nIntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)\nWkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07)\nIntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31)\nQtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). \nENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. \nSCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November.\nRECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. \nIndividual Patterns:\nEvryDay (ScheduleCode)\nEvryWorkgDay (ScheduleCode)\nIntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)\nWkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)\nIntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)\nQtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay\nThe regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:\nEvryDay\nEvryWorkgDay\nIntrvlWkDay:0[1-9]:0[1-7]\nWkInMnthDay:0[1-5]:0[1-7]\nIntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])\nQtrDay:(ENGLISH|SCOTTISH|RECEIVED)\nFull Regular Expression:\n^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$", "type": "string", "pattern": "^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$" }, "Reference": { "description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.\nUsage: 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.\nIf the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.", "type": "string", "minLength": 1, "maxLength": 35 }, "NumberOfPayments": { "description": "Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.", "type": "string", "minLength": 1, "maxLength": 35 }, "FirstPaymentDateTime": { "description": "The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00", "type": "string", "format": "date-time" }, "FinalPaymentDateTime": { "description": "The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00", "type": "string", "format": "date-time" }, "Purpose": { "description": "Specifies the external purpose code in the format of character string with a maximum length of 4 characters.\nThe list of valid codes is an external code list published separately.\nExternal code sets can be downloaded from www.iso20022.org.", "type": "string" }, "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", "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.\nUsage: This amount has to be transported unchanged through the transaction chain.", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode" } } }, "DebtorAccount": { "type": "object", "required": [ "SchemeName", "Identification" ], "description": "Provides the details to identify the debtor account.", "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.\nNote, 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": "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.\nThis is the servicer of the beneficiary account.", "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 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" } } }, "CreditorAccount": { "type": "object", "required": [ "SchemeName", "Identification", "Name" ], "description": "Provides the details to identify the beneficiary account.", "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.\nNote, the account name is not the product name or the nickname of the account.\nOB: 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" } } }, "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.\nUsage: 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.\nUsage: 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" } } }, "OBWriteInternationalStandingOrderConsentResponse4": { "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 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" }, "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" } } } }, "Initiation": { "type": "object", "required": [ "Frequency", "FirstPaymentDateTime", "CurrencyOfTransfer", "InstructedAmount", "CreditorAccount" ], "description": "The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for an international standing order.", "properties": { "Frequency": { "description": "Individual Definitions:\nEvryDay - Every day\nEvryWorkgDay - Every working day\nIntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)\nWkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07)\nIntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31)\nQtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). \nENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. \nSCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November.\nRECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. \nIndividual Patterns:\nEvryDay (ScheduleCode)\nEvryWorkgDay (ScheduleCode)\nIntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)\nWkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)\nIntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)\nQtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay\nThe regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:\nEvryDay\nEvryWorkgDay\nIntrvlWkDay:0[1-9]:0[1-7]\nWkInMnthDay:0[1-5]:0[1-7]\nIntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])\nQtrDay:(ENGLISH|SCOTTISH|RECEIVED)\nFull Regular Expression:\n^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$", "type": "string", "pattern": "^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$" }, "Reference": { "description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.\nUsage: 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.\nIf the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.", "type": "string", "minLength": 1, "maxLength": 35 }, "NumberOfPayments": { "description": "Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.", "type": "string", "minLength": 1, "maxLength": 35 }, "FirstPaymentDateTime": { "description": "The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00", "type": "string", "format": "date-time" }, "FinalPaymentDateTime": { "description": "The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00", "type": "string", "format": "date-time" }, "Purpose": { "description": "Specifies the external purpose code in the format of character string with a maximum length of 4 characters.\nThe list of valid codes is an external code list published separately.\nExternal code sets can be downloaded from www.iso20022.org.", "type": "string" }, "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", "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.\nUsage: This amount has to be transported unchanged through the transaction chain.", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode" } } }, "DebtorAccount": { "type": "object", "required": [ "SchemeName", "Identification" ], "description": "Provides the details to identify the debtor account.", "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.\nNote, 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": "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.\nThis is the servicer of the beneficiary account.", "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 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" } } }, "CreditorAccount": { "type": "object", "required": [ "SchemeName", "Identification", "Name" ], "description": "Provides the details to identify the beneficiary account.", "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.\nNote, the account name is not the product name or the nickname of the account.\nOB: 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" } } }, "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.\nUsage: 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.\nUsage: 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" } } }, "OBWriteInternationalStandingOrderResponse4": { "type": "object", "required": [ "Data" ], "properties": { "Data": { "type": "object", "required": [ "InternationalStandingOrderId", "ConsentId", "CreationDateTime", "Status", "StatusUpdateDateTime", "Initiation" ], "properties": { "InternationalStandingOrderId": { "description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the international standing order resource.", "type": "string", "minLength": 1, "maxLength": 40 }, "ConsentId": { "description": "OB: Unique identification as assigned by the ASPSP to uniquely identify the consent resource.", "type": "string", "minLength": 1, "maxLength": 128 }, "CreationDateTime": { "description": "Date and time at which the resource was created.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00", "type": "string", "format": "date-time" }, "Status": { "description": "Specifies the status of resource in code form.", "type": "string", "enum": [ "Cancelled", "InitiationCompleted", "InitiationFailed", "InitiationPending" ] }, "StatusUpdateDateTime": { "description": "Date and time at which the resource status was updated.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00", "type": "string", "format": "date-time" }, "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" } } } }, "Initiation": { "type": "object", "required": [ "Frequency", "FirstPaymentDateTime", "CurrencyOfTransfer", "InstructedAmount", "CreditorAccount" ], "description": "The Initiation payload is sent by the initiating party to the ASPSP. It is used to request movement of funds from the debtor account to a creditor for an international standing order.", "properties": { "Frequency": { "description": "Individual Definitions:\nEvryDay - Every day\nEvryWorkgDay - Every working day\nIntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07)\nWkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07)\nIntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31)\nQtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED). \nENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. \nSCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November.\nRECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. \nIndividual Patterns:\nEvryDay (ScheduleCode)\nEvryWorkgDay (ScheduleCode)\nIntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek)\nWkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek)\nIntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth)\nQtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay\nThe regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here:\nEvryDay\nEvryWorkgDay\nIntrvlWkDay:0[1-9]:0[1-7]\nWkInMnthDay:0[1-5]:0[1-7]\nIntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01])\nQtrDay:(ENGLISH|SCOTTISH|RECEIVED)\nFull Regular Expression:\n^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$", "type": "string", "pattern": "^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlDay:((0[2-9])|([1-2][0-9])|3[0-1]))$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$" }, "Reference": { "description": "Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction.\nUsage: 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.\nIf the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification.", "type": "string", "minLength": 1, "maxLength": 35 }, "NumberOfPayments": { "description": "Number of the payments that will be made in completing this frequency sequence including any executed since the sequence start date.", "type": "string", "minLength": 1, "maxLength": 35 }, "FirstPaymentDateTime": { "description": "The date on which the first payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00", "type": "string", "format": "date-time" }, "FinalPaymentDateTime": { "description": "The date on which the final payment for a Standing Order schedule will be made.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below:\n2017-04-05T10:43:07+00:00", "type": "string", "format": "date-time" }, "Purpose": { "description": "Specifies the external purpose code in the format of character string with a maximum length of 4 characters.\nThe list of valid codes is an external code list published separately.\nExternal code sets can be downloaded from www.iso20022.org.", "type": "string" }, "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", "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.\nUsage: This amount has to be transported unchanged through the transaction chain.", "properties": { "Amount": { "$ref": "#/definitions/OBActiveCurrencyAndAmount_SimpleType" }, "Currency": { "$ref": "#/definitions/ActiveOrHistoricCurrencyCode" } } }, "DebtorAccount": { "type": "object", "required": [ "SchemeName", "Identification" ], "description": "Provides the details to identify the debtor account.", "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.\nNote, 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": "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.\nThis is the servicer of the beneficiary account.", "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 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" } } }, "CreditorAccount": { "type": "object", "required": [ "SchemeName", "Identification", "Name" ], "description": "Provides the details to identify the beneficiary account.", "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.\nNote, the account name is not the product name or the nickname of the account.\nOB: 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" } } }, "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" } } }, "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" } } }, "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 }, "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 }, "StreetName": { "description": "Name of a street or thoroughfare.", "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 }, "TownName": { "description": "Name of a built-up area, with defined boundaries, and a local government.", "type": "string", "minLength": 1, "maxLength": 35 } } }