icon_search Search
Close X

HOW CAN WE HELP?

# Data Dictionary v3.1.2

XPath FieldName MinOccurs MaxOccurs DataType Length MinLength MaxLength Pattern CodeName CodeDescription EnhancedDefinition
OBIEMIReportData OBIEMIReportData OBIEMIReportData
OBIEMIReportData/PerformanceAndAvailability PerformanceAndAvailability 0 unbounded OBMIPnAOBIEReportData1
OBIEMIReportData/PerformanceAndAvailability/MIBrandId MIBrandId 1 1 OBMIBrands1Code Brand Name that an organisation uses to market its products or services to a consumer.
OBIEMIReportData/PerformanceAndAvailability/MIBrandId/:code:0001 AIBFirstTrustBank AIB First Trust Bank
OBIEMIReportData/PerformanceAndAvailability/MIBrandId/:code:0002 AIBGroupUK AIB Group (UK) p.l.c.
OBIEMIReportData/PerformanceAndAvailability/MIBrandId/:code:0003 BankOfIrelandUK Bank of Ireland UK
OBIEMIReportData/PerformanceAndAvailability/MIBrandId/:code:0004 BankOfScotland Bank of Scotland
OBIEMIReportData/PerformanceAndAvailability/MIBrandId/:code:0005 Barclays Barclays
OBIEMIReportData/PerformanceAndAvailability/MIBrandId/:code:0006 DanskeBank Danske Bank
OBIEMIReportData/PerformanceAndAvailability/MIBrandId/:code:0007 FirstDirect First Direct
OBIEMIReportData/PerformanceAndAvailability/MIBrandId/:code:0008 Halifax Halifax
OBIEMIReportData/PerformanceAndAvailability/MIBrandId/:code:0009 HSBC HSBC
OBIEMIReportData/PerformanceAndAvailability/MIBrandId/:code:0010 Lloyds Lloyds
OBIEMIReportData/PerformanceAndAvailability/MIBrandId/:code:0011 MAndSBank M&S Bank
OBIEMIReportData/PerformanceAndAvailability/MIBrandId/:code:0012 NationwideBuildingSociety Nationwide Building Society
OBIEMIReportData/PerformanceAndAvailability/MIBrandId/:code:0013 Natwest Natwest
OBIEMIReportData/PerformanceAndAvailability/MIBrandId/:code:0014 RBS RBS
OBIEMIReportData/PerformanceAndAvailability/MIBrandId/:code:0015 Santander UK plc Santander UK plc
OBIEMIReportData/PerformanceAndAvailability/MIBrandId/:code:0016 UBN UBN
OBIEMIReportData/PerformanceAndAvailability/MIBrandId/:code:9999 OTHERBrand Other Brand
OBIEMIReportData/PerformanceAndAvailability/ReportDate ReportDate 1 1 ISODate A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
OBIEMIReportData/PerformanceAndAvailability/EndPoint EndPoint 1 1 OBMIEndPoint1Code Endpoint used for MI reporting
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0000 OIDC OIDC endpoints for token IDs
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0001 POSTAccountAccessConsents POST /account-access-consents
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0002 POSTAccountAccessConsentsConsentId GET /account-access-consents/{ConsentId}
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0003 DELETEAccountAccessConsentsConsentId DELETE /account-access-consents/{ConsentId}
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0004 GETAccounts GET /accounts
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0005 GETAccountsAccountId GET /accounts/{AccountId}
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0006 GETAccountsAccountIdBalances GET /accounts/{AccountId}/balances
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0007 GETBalances GET /balances
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0008 GETAccountsAccountIdTransactions GET /accounts/{AccountId}/transactions
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0009 GETTransactions GET /transactions
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0010 GETAccountsAccountIdBeneficiaries GET /accounts/{AccountId}/beneficiaries
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0011 GETBeneficiaries GET /beneficiaries
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0012 GETAccountsAccountIdDirectDebits GET /accounts/{AccountId}/direct-debits
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0013 GETDirectDebits GET /direct-debits
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0014 GETAccountsAccountIdStandingOrders GET /accounts/{AccountId}/standing-orders
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0015 GETStandingOrders GET /standing-orders
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0016 GETAccountsAccountIdProduct GET /accounts/{AccountId}/product
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0017 GETProducts GET /products
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0018 GETAccountsAccountIdoffers GET /accounts/{AccountId}/offers
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0019 GETOffers GET /offers
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0020 GETAccountsAccountIdParty GET /accounts/{AccountId}/party
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0021 GETParty GET /party
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0022 GETAccountsAccountIdScheduledPayments GET /accounts/{AccountId}/scheduled-payments
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0023 GETScheduledPayments GET /scheduled-payments
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0024 GETAccountsAccountIdStatements GET /accounts/{AccountId}/statements
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0025 GETAccountsAccountIdStatementsStatementId GET /accounts/{AccountId}/statements/{StatementId}
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0026 GETAccountsAccountIdStatementsStatementIdFile GET /accounts/{AccountId}/statements/{StatementId}/file
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0027 GETAccountsAccountIdStatementsStatementIdTransactions GET /accounts/{AccountId}/statements/{StatementId}/transactions
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0028 GETStatements GET /statements
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0029 POSTDomesticPaymentConsents POST /domestic-payment-consents
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0030 GETDomesticPaymentConsentsConsentId GET /domestic-payment-consents/{ConsentId}
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0031 POSTDomesticPayments POST /domestic-payments
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0032 GETDomesticPaymentsDomesticPaymentId GET /domestic-payments/{DomesticPaymentId}
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0033 POSTDomesticScheduledPaymentConsents POST /domestic-scheduled-payment-consents
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0034 GETDomesticScheduledPaymentConsentsConsentId GET /domestic-scheduled-payment-consents/{ConsentId}
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0035 POSTDomesticScheduledPayments POST /domestic-scheduled-payments
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0036 GETDomesticScheduledPaymentsDomesticScheduledPaymentId GET /domestic-scheduled-payments/{DomesticScheduledPaymentId}
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0037 POSTDomesticStandingOrderConsents POST /domestic-standing-order-consents
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0038 GETDomesticStandingOrderConsentsConsentId GET /domestic-standing-order-consents/{ConsentId}
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0039 POSTDomesticStandingOrders POST /domestic-standing-orders
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0040 GETDomesticStandingOrdersDomesticStandingOrderId GET /domestic-standing-orders/{DomesticStandingOrderId}
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0041 POSTInternationalPaymentConsents POST /international-payment-consents
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0042 GETInternationalPaymentConsentsConsentId GET /international-payment-consents/{ConsentId}
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0043 POSTInternationalPayments POST /international-payments
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0044 GETInternationalPaymentsInternationalPaymentId GET /international-payments/{InternationalPaymentId}
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0045 POSTInternationalScheduledPaymentConsents POST /international-scheduled-payment-consents
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0046 GETInternationalScheduledPaymentConsentsConsentId GET /international-scheduled-payment-consents/{ConsentId}
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0047 POSTInternationalScheduledPayments POST /international-scheduled-payments
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0048 GETInternationalScheduledPaymentsInternationalScheduledPaymentId GET /international-scheduled-payments/{InternationalScheduledPaymentId}
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0049 POSTInternationalStandingOrderConsents POST /international-standing-order-consents
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0050 GETInternationalStandingOrderConsentsConsentId GET /international-standing-order-consents/{ConsentId}
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0051 POSTInternationalStandingOrders POST /international-standing-orders
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0052 GETInternationalStandingOrdersInternationalStandingOrderPaymentId GET /international-standing-orders/{InternationalStandingOrderPaymentId}
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0053 POSTFilePaymentConsents POST /file-payment-consents
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0054 GETFilePaymentConsentsConsentId GET /file-payment-consents/{ConsentId}
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0055 POSTFilePaymentConsentsConsentIdFile POST /file-payment-consents/{ConsentId}/file
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0056 GETFilePaymentConsentsConsentIdFile GET /file-payment-consents/{ConsentId}/file
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0057 POSTFilePayments POST /file-payments
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0058 GETFilePaymentsFilePaymentId GET /file-payments/{FilePaymentId}
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0059 GETFilePaymentsFilePaymentIdReportFile GET /file-payments/{FilePaymentId}/report-file
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0060 POSTFundsConfirmationConsents POST /funds-confirmation-consents
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0061 GETFundsConfirmationConsentsConsentId GET /funds-confirmation-consents/{ConsentId}
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0062 DELETEFundsConfirmationConsentsConsentId DELETE /funds-confirmation-consents/{ConsentId}
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0063 POSTFundsConfirmations POST /funds-confirmations
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0064 POSTPayments POST /payments
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0065 GETPaymentsPaymentId GET /payments/{PaymentId}
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0066 POSTPaymentSubmissions POST /payment-submissions
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0067 GETPaymentSubmissionsPaymentSubmissionId GET /payment-submissions/{PaymentSubmissionId}
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0068 POSTAccountRequests POST /account-requests
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0069 GETAccountRequestsAccountRequestId GET /account-requests/{AccountRequestId}
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0070 DELETEAccountRequestsAccountRequestId DELETE /account-requests/{AccountRequestId}
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0071 POSTcallback-urls POST /callback-urls
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0072 GETcallback-urls GET /callback-urls
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0073 PUTcallback-urlsCallbackUrlId PUT /callback-urls/{CallbackUrlId}
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0074 DELETEcallback-urlsCallbackUrlId DELETE /callback-urls/{CallbackUrlId}
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0075 GET domestic-payment-consentsConsentIdfunds-confirmation GET /domestic-payment-consents/{ConsentId}/funds-confirmation
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0076 GETinternational-payment-consentsConsentIdfunds-confirmation GET /international-payment-consents/{ConsentId}/funds-confirmation
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0077 GETinternational-sch-payment-consentsConsentIdfunds-confirmation GET /international-scheduled-payment-consents/{ConsentId}/funds-confirmation
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0078 GETaccountsAccountIdparties GET /accounts/{AccountId}/parties
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0079 GETdomestic-paymentsDomesticPaymentIdpayment-details GET /domestic-payments/{DomesticPaymentId}/payment-details
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0080 GETdomestic-scheduled-paymentsDomesticSPaymentIdpayment-details GET /domestic-scheduled-payments/{DomesticScheduledPaymentId}/payment-details
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0081 GETdomestic-standing-ordersDomesticSOrderIdpayment-details GET /domestic-standing-orders/{DomesticStandingOrderId}/payment-details
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0082 GETinternational-paymentsInternationalPaymentIdpayment-details GET /international-payments/{InternationalPaymentId}/payment-details
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0083 GETinternational-scheduled-paymentsInternationalSPIdpayment-details GET /international-scheduled-payments/{InternationalScheduledPaymentId}/payment-details
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0084 GETinternational-standing-ordersInternationalSOrderPIdpayment-details GET /international-standing-orders/{InternationalStandingOrderPaymentId}/payment-details
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0085 GETfile-paymentsFilePaymentIdpayment-details GET /file-payments/{FilePaymentId}/payment-details
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0086 POSTevent-subscriptions POST /event-subscriptions
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0087 GETevent-subscriptions GET /event-subscriptions
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0088 PUTevent-subscriptionsEventSubscriptionId PUT /event-subscriptions/{EventSubscriptionId}
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0089 DELETEevent-subscriptionsEventSubscriptionId DELETE /event-subscriptions/{EventSubscriptionId}
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0090 POSTevent-notifications POST /event-notifications
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:0091 POSTevents POST /events
OBIEMIReportData/PerformanceAndAvailability/EndPoint/:code:9999 OTHEREndoint Other End point
OBIEMIReportData/PerformanceAndAvailability/CoreNonCoreHours CoreNonCoreHours 1 1 OBMICoreNonCoreHours1Code Core and non code hours used for MI Reporting
OBIEMIReportData/PerformanceAndAvailability/CoreNonCoreHours/:code:HRCH CoreHours Core Hours (06.00 - 00.00)
OBIEMIReportData/PerformanceAndAvailability/CoreNonCoreHours/:code:HRNC NonCoreHours Non Core Hours (00.00 - 06.00)
OBIEMIReportData/PerformanceAndAvailability/Uptime Uptime 1 1 Max5Text 1 5 ^[0-1][0-5]:[0-5][0-9]$ Uptime (8.4/8.5) Uptime per each individual endpoint in hours and minutes. (Elapsed time) Note on reporting availability of endpoints: For endpoints to be reported as available (uptime), they need to be fully operational in terms of fulfilling their functionality and being able to response back to the requesting TPP (i.e. no technical x500 failures). However, this should exclude cases of network errors outside the ASPSP control or cases of TPPs becoming unavailable. For further details, please refer to section "Dedicated Interface Downtime" of the "MI Reporting Data API Specification" page. Total uptime is calculated as: 1. Core Hours: Uptime = Total number of core hours (18:00) - Total Planned Downtime (hh:mm) - Total Unplanned Downtime (hh:mm) 2. Non-Core Hours: Uptime = Total number of non-core hours (6:00) - Total Planned Downtime (hh:mm) - Total Unplanned Downtime (hh:mm) Hours and seconds text in the following format: "hh:mm" Max value: A) Core Hours: 18:00, B) Non Core Hours: 06:00 Min value: A) Core Hours: 00:00, B) Non Core Hours: 00:00 Conditions 1. Core Hours: Uptime + Planned Downtime + Unplanned Downtime = 18hours 2. Non-Core Hours: Uptime + Planned Downtime + Unplanned Downtime = 6hours
OBIEMIReportData/PerformanceAndAvailability/PlannedDowntime PlannedDowntime 1 1 Max5Text 1 5 ^[0-1][0-5]:[0-5][0-9]$ Planned Downtime (8.4/8.5) Any planned duration that the API endpoints become unavailable. For the avoidance of doubt this extends to include all systems that are required for the relevant endpoint to be fully functional (Refer to A. Guidelines item 9). The clock for unavailability should start immediately and consolidated duration must be reported during core hours and non core hours, as elapsed time. Due to per minute granularity, rounding is expected to take place to the nearest whole minute (e.g. 1min 15 sec should be reported as 1min, 1min 40 sec should be reported as 2min). For further details, please refer to section "Dedicated Interface Downtime" of the "MI Reporting Data API Specification" page. Hours and seconds text in the following format: "hh:mm" Conditions 1. Core Hours: Uptime + Planned Downtime + Unplanned Downtime = 18hours 2. Non-Core Hours: Uptime + Planned Downtime + Unplanned Downtime = 6hours
OBIEMIReportData/PerformanceAndAvailability/UnplannedDowntime UnplannedDowntime 1 1 Max5Text 1 5 ^[0-1][0-5]:[0-5][0-9]$ Unplanned Downtime (8.4/8.5) Any unplanned duration that the API endpoints become unavailable due to technical faults or any other reasons. For the avoidance of doubt this extends to include all systems that are required for the relevant endpoint to be fully functional (For further details, please refer to section "Dedicated Interface Downtime" of the "MI Reporting Data API Specification" page.). The clock for unavailability should start as defined in section "Dedicated Interface Downtime" of the "MI Reporting Data API Specification" page, and consolidated duration must be reported during core hours and non core hours, as elapsed time. Due to per minute granularity, rounding is expected to take place to the nearest whole minute (e.g. 1min 15 sec should be reported as 1min, 1min 40 sec should be reported as 2min). Hours and seconds text in the following format: "hh:mm" Conditions 1. Core Hours: Uptime + Planned Downtime + Unplanned Downtime = 18hours 2. Non-Core Hours: Uptime + Planned Downtime + Unplanned Downtime = 6hours
OBIEMIReportData/PerformanceAndAvailability/MedianTTLBResponseTime MedianTTLBResponseTime 1 1 Number Median TTLB Response Time (Time to Last Byte)(8.6/8.7/8.8) The median value across all values of Time to Last Byte (TTLB) response time for each API endpoint during the duration of core and non core hours (e.g. a Get Account Transactions Request generates a Get Account Transactions Response message). Time to Last Byte (TTLB) is defined in the context of the OBIE reporting template as the total time taken for an API endpoint call to generate a response message and provide to AISPs, PISPs or CBPIIs all the information as required as defined in 36(1)(a), 36(1)(b), 36(1)(c) of the RTS and 66(4)(b), 65(3) of the PSD2. The response time clock should start at the point the endpoint call is fully received by the ASPSP, and should stop at the point the last byte of the response message is transmitted to the AISP, PISP, or CBPII. The response time must be reported in milliseconds as follows: 1. Core Hours: Median (TTLB response time of each endpoint call of a specific type between 06.00 and 0.00 excluding the endpoint downtime) 2. Non Core Hours: Median (TTLB response time of each endpoint call of a specific type between 00.00 and 06.00 excluding the endpoint downtime) If an endpoint is unavailable during the whole of the reported period, response time should be zero. Values in milliseconds
OBIEMIReportData/PerformanceAndAvailability/MedianTTFBResponseTime MedianTTFBResponseTime 1 1 Number Median TTFB Response Time(Time to First Byte)(8.9) The median value across all values of Time to First Byte (TTFB) response time for each API endpoint during the duration of core and non core hours (e.g. a Get Account Transactions Request generates a Get Account Transactions Response message). Time to First Byte (TTFB) is defined in the context of the OBIE reporting template as the total time taken for an API endpoint call to generate a response message and start providing to AISPs, PISPs or CBPIIs all the information as required as defined in 36(1)(a), 36(1)(b), 36(1)(c) of the RTS and 66(4)(b), 65(3) of the PSD2. The response time clock should start at the point the endpoint call is fully received by the ASPSP, and should stop at the point the first byte of the response message is transmitted to the AISP, PISP, or CBPII. The response time must be reported in milliseconds as follows: 1. Core Hours: Median (TTFB response time of each endpoint call of a specific type between 06.00 and 0.00 excluding the endpoint downtime) 2. Non Core Hours: Median (TTFB response time of each endpoint call of a specific type between 00.00 and 06.00 excluding the endpoint downtime) If an endpoint is unavailable during the whole of the reported period, response time should be zero. Values in milliseconds
OBIEMIReportData/PerformanceAndAvailability/MedianResponsePayloadSize MedianResponsePayloadSize 1 1 Number Median ResponsePayload Size (8.10) The median value across all values of Response Payload for each API endpoint during the duration of core and non core hours (e.g. a Get Account Transactions Request generates a Get Account Transactions Response message). The response payload size of the response message to each supported Read/Write API endpoints must also include the size of the message headers. The Response Payload must be reported in bytes as follows: 1. Core Hours: Median (Response payload of each endpoint call of a specific type between 06.00 and 0.00 excluding the endpoint downtime) 2. Non Core Hours: Median (Response payload of each endpoint call of a specific type between 00.00 and 06.00 excluding the endpoint downtime) If an endpoint is unavailable during the whole of the reported period, the response payload should be zero. Values in Bytes
OBIEMIReportData/PerformanceAndAvailability/MaxPaymentInitiationsPerSecond MaxPaymentInitiationsPerSecond 1 1 Max4AlphaNumericText 1 4 [a-zA-Z0-9]{1,4} Max Payment Initiations Per Second (PIPS)(8.12) This field is only applicable to PIS endpoints. For AIS and CBPII endpoints it should be populated with NULL. The maximum number of successful payment initiations per second (PIPS) for the payment order POST API calls during the duration of core and non core hours. The PIPS must be reported as whole numbers as follows: 1. Core Hours: Max (number of payment initiation POST endpoint calls during the period of 1 sec, for all 1 second periods between 06.00 and 0.00 excluding the endpoint downtime) 1.Non-Core Hours: Max (number of payment initiation POST endpoint calls during the period of 1 sec, for all 1 second periods between 00.00 and 06.00 excluding the endpoint Max value: 9999 Min value: 0 Not applicable: NULLdowntime)
OBIEMIReportData/PerformanceAndAvailability/AverageTTLBResponseTime AverageTTLBResponseTime 1 1 Number Average TTLB Response Time (Time to Last Byte) The average (mean) value across all values of Time to Last Byte (TTLB) response time for each API endpoint during the duration of core and non core hours (e.g. a Get Account Transactions Request generates a Get Account Transactions Response message). Time to Last Byte (TTLB) is defined in the context of the OBIE reporting template as the total time taken for an API endpoint call to generate a response message and provide to AISPs, PISPs or CBPIIs all the information as required as defined in 36(1)(a), 36(1)(b), 36(1)(c) of the RTS and 66(4)(b), 65(3) of the PSD2. The response time clock should start at the point the endpoint call is fully received by the ASPSP, and should stop at the point the last byte of the response message is transmitted to the AISP, PISP, or CBPII. The response time must be reported in milliseconds as follows: 1. Core Hours: Mean (TTLB response time of each endpoint call of a specific type between 06.00 and 0.00 excluding the endpoint downtime) 2. Non Core Hours: Mean (TTLB response time of each endpoint call of a specific type between 00.00 and 06.00 excluding the endpoint downtime) If an endpoint is unavailable during the whole of the reported period, response time should be zero. Conditions 1. TTLB >= TTFB
OBIEMIReportData/PerformanceAndAvailability/AverageTTFBResponseTime AverageTTFBResponseTime 1 1 Number Average TTFB Response Time (Time to First Byte) The average (mean) value across all values of Time to First Byte (TTFB) response time for each API endpoint during the duration of core and non core hours (e.g. a Get Account Transactions Request generates a Get Account Transactions Response message). Time to First Byte (TTFB) is defined in the context of the OBIE reporting template as the total time taken for an API endpoint call to generate a response message and start providing to AISPs, PISPs or CBPIIs all the information as required as defined in 36(1)(a), 36(1)(b), 36(1)(c) of the RTS and 66(4)(b), 65(3) of the PSD2. The response time clock should start at the point the endpoint call is fully received by the ASPSP, and should stop at the point the first byte of the response message is transmitted to the AISP, PISP, or CBPII. The response time must be reported in milliseconds as follows: 1. Core Hours: Mean (TTFB response time of each endpoint call of a specific type between 06.00 and 0.00 excluding the endpoint downtime) 2. Non Core Hours: Mean (TTFB response time of each endpoint call of a specific type between 00.00 and 06.00 excluding the endpoint downtime) If an endpoint is unavailable during the whole of the reported period, response time should be zero. Conditions 1. TTLB >= TTFB
OBIEMIReportData/PerformanceAndAvailability/TotalNumberAPIcalls TotalNumberAPIcalls 1 1 Number This is the total number of API calls per day per endpoint, per brand split by core/non-core.
OBIEMIReportData/PerformanceAndAvailability/TotalTTLBResponseTime TotalTTLBResponseTime 1 1 Number Total TTLB Response Time (Time to Last Byte) This is the sum of all the TTLB responses of all endpoint calls of each endpoint type during the period of core hours or non-core hours. For the avoidance of doubt, this is the sum of all the TTLB response times generated by the Total Number of API calls for each endpoint.
OBIEMIReportData/PerformanceAndAvailability/TotalTTFBResponseTime TotalTTFBResponseTime 1 1 Number Total TTFB Response Time(Time to First Byte) This is the sum of all the TTFB responses of all endpoint calls of each endpoint type during the period of core hours or non-core hours. For the avoidance of doubt, this is the sum of all the TTFB response times generated by the Total Number of API calls for each endpoint.
OBIEMIReportData/PerformanceAndAvailability/TotalResponsePayloadSize TotalResponsePayloadSize 1 1 Number This is the sum of the payload of all the response messages for all endpoint calls of each endpoint type during the period of core hours or non-core hours. For the avoidance of doubt, this is the sum of all the payloads of the response messages generated by the Total Number of API calls for each endpoint.
OBIEMIReportData/PerformanceAndAvailability/Version Version 1 1 OBAPIMajorVersionType1Code The OBIE Standards version of the endpoint implementation by the ASPSP, aggregated at the level of major or minor release, as defined in item#10 of Section 2 key usage instructions.
OBIEMIReportData/PerformanceAndAvailability/Version/:code:V3.0 V3.0 V3.0
OBIEMIReportData/PerformanceAndAvailability/Version/:code:V3.1 V3.1 V3.1
OBIEMIReportData/PerformanceAndAvailability/Version/:code:V3.2 V3.2 V3.2
OBIEMIReportData/PerformanceAndAvailability/Version/:code:V3.3 V3.3 V3.3
OBIEMIReportData/PerformanceAndAvailability/Version/:code:V4.0 V4.0 V4.0
OBIEMIReportData/PerformanceAndAvailability/Version/:code:V4.1 V4.1 V4.1
OBIEMIReportData/PerformanceAndAvailability/Version/:code:VOTH Other Other version
OBIEMIReportData/PerformanceAndAvailability/OtherMIBrand OtherMIBrand 0 1 OBMIOtherBrandType1
OBIEMIReportData/PerformanceAndAvailability/OtherMIBrand/MIBrandId MIBrandId 1 1 OB_CodeMnemonic Other Brand Id which is not available in the published
OBIEMIReportData/PerformanceAndAvailability/OtherMIBrand/BrandName BrandName 1 1 Max500Text 1 500 Long name associated with the code
OBIEMIReportData/PerformanceAndAvailability/OtherMIBrand/Description Description 0 1 Max350Text 1 350 Description to describe the purpose of the code
OBIEMIReportData/PerformanceAndAvailability/OtherEndpoint OtherEndpoint 0 1 OBMIOtherEndpointType1
OBIEMIReportData/PerformanceAndAvailability/OtherEndpoint/EndpointId EndpointId 1 1 OB_CodeMnemonic Other Endpint Id which is not available in the published
OBIEMIReportData/PerformanceAndAvailability/OtherEndpoint/Endpoint Endpoint 1 1 Max500Text 1 500 Long name associated with the code
OBIEMIReportData/PerformanceAndAvailability/OtherEndpoint/Description Description 0 1 Max350Text 1 350 Description to describe the purpose of the code
OBIEMIReportData/PerformanceAndAvailability/OtherVersion OtherVersion 0 1 OBMIOtherVersionType1
OBIEMIReportData/PerformanceAndAvailability/OtherVersion/Version Version 1 1 OB_CodeMnemonic Other Version which is not available in published list
OBIEMIReportData/PerformanceAndAvailability/OtherVersion/VersionName VersionName 1 1 Max70Text 1 70 Long name associated with the code
OBIEMIReportData/PerformanceAndAvailability/OtherVersion/Description Description 0 1 Max350Text 1 350 Description to describe the purpose of the code
OBIEMIReportData/ResponseOutliers ResponseOutliers 0 unbounded OBMIPerformanceOutliersReportData1
OBIEMIReportData/ResponseOutliers/MIBrandId MIBrandId 1 1 OBMIBrands1Code Brand Name that an organisation uses to market its products or services to a consumer.
OBIEMIReportData/ResponseOutliers/MIBrandId/:code:0001 AIBFirstTrustBank AIB First Trust Bank
OBIEMIReportData/ResponseOutliers/MIBrandId/:code:0002 AIBGroupUK AIB Group (UK) p.l.c.
OBIEMIReportData/ResponseOutliers/MIBrandId/:code:0003 BankOfIrelandUK Bank of Ireland UK
OBIEMIReportData/ResponseOutliers/MIBrandId/:code:0004 BankOfScotland Bank of Scotland
OBIEMIReportData/ResponseOutliers/MIBrandId/:code:0005 Barclays Barclays
OBIEMIReportData/ResponseOutliers/MIBrandId/:code:0006 DanskeBank Danske Bank
OBIEMIReportData/ResponseOutliers/MIBrandId/:code:0007 FirstDirect First Direct
OBIEMIReportData/ResponseOutliers/MIBrandId/:code:0008 Halifax Halifax
OBIEMIReportData/ResponseOutliers/MIBrandId/:code:0009 HSBC HSBC
OBIEMIReportData/ResponseOutliers/MIBrandId/:code:0010 Lloyds Lloyds
OBIEMIReportData/ResponseOutliers/MIBrandId/:code:0011 MAndSBank M&S Bank
OBIEMIReportData/ResponseOutliers/MIBrandId/:code:0012 NationwideBuildingSociety Nationwide Building Society
OBIEMIReportData/ResponseOutliers/MIBrandId/:code:0013 Natwest Natwest
OBIEMIReportData/ResponseOutliers/MIBrandId/:code:0014 RBS RBS
OBIEMIReportData/ResponseOutliers/MIBrandId/:code:0015 Santander UK plc Santander UK plc
OBIEMIReportData/ResponseOutliers/MIBrandId/:code:0016 UBN UBN
OBIEMIReportData/ResponseOutliers/MIBrandId/:code:9999 OTHERBrand Other Brand
OBIEMIReportData/ResponseOutliers/ReportDate ReportDate 1 1 ISODate A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
OBIEMIReportData/ResponseOutliers/EndPoint EndPoint 1 1 OBMIEndPoint1Code Endpoint used for MI reporting. Note: ASPSPs must only report endpoints that have gone live in their systems.
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0000 OIDC OIDC endpoints for token IDs
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0001 POSTAccountAccessConsents POST /account-access-consents
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0002 POSTAccountAccessConsentsConsentId GET /account-access-consents/{ConsentId}
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0003 DELETEAccountAccessConsentsConsentId DELETE /account-access-consents/{ConsentId}
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0004 GETAccounts GET /accounts
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0005 GETAccountsAccountId GET /accounts/{AccountId}
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0006 GETAccountsAccountIdBalances GET /accounts/{AccountId}/balances
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0007 GETBalances GET /balances
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0008 GETAccountsAccountIdTransactions GET /accounts/{AccountId}/transactions
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0009 GETTransactions GET /transactions
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0010 GETAccountsAccountIdBeneficiaries GET /accounts/{AccountId}/beneficiaries
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0011 GETBeneficiaries GET /beneficiaries
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0012 GETAccountsAccountIdDirectDebits GET /accounts/{AccountId}/direct-debits
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0013 GETDirectDebits GET /direct-debits
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0014 GETAccountsAccountIdStandingOrders GET /accounts/{AccountId}/standing-orders
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0015 GETStandingOrders GET /standing-orders
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0016 GETAccountsAccountIdProduct GET /accounts/{AccountId}/product
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0017 GETProducts GET /products
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0018 GETAccountsAccountIdoffers GET /accounts/{AccountId}/offers
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0019 GETOffers GET /offers
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0020 GETAccountsAccountIdParty GET /accounts/{AccountId}/party
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0021 GETParty GET /party
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0022 GETAccountsAccountIdScheduledPayments GET /accounts/{AccountId}/scheduled-payments
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0023 GETScheduledPayments GET /scheduled-payments
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0024 GETAccountsAccountIdStatements GET /accounts/{AccountId}/statements
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0025 GETAccountsAccountIdStatementsStatementId GET /accounts/{AccountId}/statements/{StatementId}
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0026 GETAccountsAccountIdStatementsStatementIdFile GET /accounts/{AccountId}/statements/{StatementId}/file
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0027 GETAccountsAccountIdStatementsStatementIdTransactions GET /accounts/{AccountId}/statements/{StatementId}/transactions
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0028 GETStatements GET /statements
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0029 POSTDomesticPaymentConsents POST /domestic-payment-consents
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0030 GETDomesticPaymentConsentsConsentId GET /domestic-payment-consents/{ConsentId}
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0031 POSTDomesticPayments POST /domestic-payments
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0032 GETDomesticPaymentsDomesticPaymentId GET /domestic-payments/{DomesticPaymentId}
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0033 POSTDomesticScheduledPaymentConsents POST /domestic-scheduled-payment-consents
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0034 GETDomesticScheduledPaymentConsentsConsentId GET /domestic-scheduled-payment-consents/{ConsentId}
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0035 POSTDomesticScheduledPayments POST /domestic-scheduled-payments
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0036 GETDomesticScheduledPaymentsDomesticScheduledPaymentId GET /domestic-scheduled-payments/{DomesticScheduledPaymentId}
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0037 POSTDomesticStandingOrderConsents POST /domestic-standing-order-consents
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0038 GETDomesticStandingOrderConsentsConsentId GET /domestic-standing-order-consents/{ConsentId}
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0039 POSTDomesticStandingOrders POST /domestic-standing-orders
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0040 GETDomesticStandingOrdersDomesticStandingOrderId GET /domestic-standing-orders/{DomesticStandingOrderId}
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0041 POSTInternationalPaymentConsents POST /international-payment-consents
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0042 GETInternationalPaymentConsentsConsentId GET /international-payment-consents/{ConsentId}
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0043 POSTInternationalPayments POST /international-payments
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0044 GETInternationalPaymentsInternationalPaymentId GET /international-payments/{InternationalPaymentId}
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0045 POSTInternationalScheduledPaymentConsents POST /international-scheduled-payment-consents
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0046 GETInternationalScheduledPaymentConsentsConsentId GET /international-scheduled-payment-consents/{ConsentId}
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0047 POSTInternationalScheduledPayments POST /international-scheduled-payments
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0048 GETInternationalScheduledPaymentsInternationalScheduledPaymentId GET /international-scheduled-payments/{InternationalScheduledPaymentId}
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0049 POSTInternationalStandingOrderConsents POST /international-standing-order-consents
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0050 GETInternationalStandingOrderConsentsConsentId GET /international-standing-order-consents/{ConsentId}
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0051 POSTInternationalStandingOrders POST /international-standing-orders
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0052 GETInternationalStandingOrdersInternationalStandingOrderPaymentId GET /international-standing-orders/{InternationalStandingOrderPaymentId}
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0053 POSTFilePaymentConsents POST /file-payment-consents
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0054 GETFilePaymentConsentsConsentId GET /file-payment-consents/{ConsentId}
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0055 POSTFilePaymentConsentsConsentIdFile POST /file-payment-consents/{ConsentId}/file
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0056 GETFilePaymentConsentsConsentIdFile GET /file-payment-consents/{ConsentId}/file
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0057 POSTFilePayments POST /file-payments
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0058 GETFilePaymentsFilePaymentId GET /file-payments/{FilePaymentId}
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0059 GETFilePaymentsFilePaymentIdReportFile GET /file-payments/{FilePaymentId}/report-file
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0060 POSTFundsConfirmationConsents POST /funds-confirmation-consents
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0061 GETFundsConfirmationConsentsConsentId GET /funds-confirmation-consents/{ConsentId}
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0062 DELETEFundsConfirmationConsentsConsentId DELETE /funds-confirmation-consents/{ConsentId}
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0063 POSTFundsConfirmations POST /funds-confirmations
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0064 POSTPayments POST /payments
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0065 GETPaymentsPaymentId GET /payments/{PaymentId}
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0066 POSTPaymentSubmissions POST /payment-submissions
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0067 GETPaymentSubmissionsPaymentSubmissionId GET /payment-submissions/{PaymentSubmissionId}
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0068 POSTAccountRequests POST /account-requests
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0069 GETAccountRequestsAccountRequestId GET /account-requests/{AccountRequestId}
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0070 DELETEAccountRequestsAccountRequestId DELETE /account-requests/{AccountRequestId}
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0071 POSTcallback-urls POST /callback-urls
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0072 GETcallback-urls GET /callback-urls
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0073 PUTcallback-urlsCallbackUrlId PUT /callback-urls/{CallbackUrlId}
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0074 DELETEcallback-urlsCallbackUrlId DELETE /callback-urls/{CallbackUrlId}
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0075 GET domestic-payment-consentsConsentIdfunds-confirmation GET /domestic-payment-consents/{ConsentId}/funds-confirmation
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0076 GETinternational-payment-consentsConsentIdfunds-confirmation GET /international-payment-consents/{ConsentId}/funds-confirmation
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0077 GETinternational-sch-payment-consentsConsentIdfunds-confirmation GET /international-scheduled-payment-consents/{ConsentId}/funds-confirmation
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0078 GETaccountsAccountIdparties GET /accounts/{AccountId}/parties
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0079 GETdomestic-paymentsDomesticPaymentIdpayment-details GET /domestic-payments/{DomesticPaymentId}/payment-details
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0080 GETdomestic-scheduled-paymentsDomesticSPaymentIdpayment-details GET /domestic-scheduled-payments/{DomesticScheduledPaymentId}/payment-details
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0081 GETdomestic-standing-ordersDomesticSOrderIdpayment-details GET /domestic-standing-orders/{DomesticStandingOrderId}/payment-details
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0082 GETinternational-paymentsInternationalPaymentIdpayment-details GET /international-payments/{InternationalPaymentId}/payment-details
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0083 GETinternational-scheduled-paymentsInternationalSPIdpayment-details GET /international-scheduled-payments/{InternationalScheduledPaymentId}/payment-details
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0084 GETinternational-standing-ordersInternationalSOrderPIdpayment-details GET /international-standing-orders/{InternationalStandingOrderPaymentId}/payment-details
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0085 GETfile-paymentsFilePaymentIdpayment-details GET /file-payments/{FilePaymentId}/payment-details
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0086 POSTevent-subscriptions POST /event-subscriptions
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0087 GETevent-subscriptions GET /event-subscriptions
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0088 PUTevent-subscriptionsEventSubscriptionId PUT /event-subscriptions/{EventSubscriptionId}
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0089 DELETEevent-subscriptionsEventSubscriptionId DELETE /event-subscriptions/{EventSubscriptionId}
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0090 POSTevent-notifications POST /event-notifications
OBIEMIReportData/ResponseOutliers/EndPoint/:code:0091 POSTevents POST /events
OBIEMIReportData/ResponseOutliers/EndPoint/:code:9999 OTHEREndoint Other End point
OBIEMIReportData/ResponseOutliers/ReportTime ReportTime 1 1 ISOTime Reported time for the outlier endpoint call. UTC time format (hh:mm:ss)
OBIEMIReportData/ResponseOutliers/TTLBResponseTime TTLBResponseTime 1 1 Number TTLB Response Time (Time to Last Byte)(8.6/8.7/8.8) The Time to Last Byte (TTLB) response time for the API endpoint that generated an outlier from the overall data set of TTLB response times (e.g. a Get Account Transactions Request generates a Get Account Transactions Response message with response time being an outlier). Please note that as per the current definitions, the metric to be used for identifying the outlier will be the value of the TTLB response. This is because the TTLB time includes the TTFB time as per the definitions used in the context of OBIE reporting and thus most probably would cover the cases where TTFB would also be an outlier. . Time to Last Byte (TTLB) is defined in the context of the OBIE reporting template as the total time taken for an API endpoint call to generate a response message and provide to AISPs, PISPs or CBPIIs all the information as required as defined in 36(1)(a), 36(1)(b), 36(1)(c) of the RTS and 66(4)(b), 65(3) of the PSD2. The response time clock should start at the point the endpoint call is fully received by the ASPSP, and should stop at the point the last byte of the response message is transmitted to the AISP, PISP, or CBPII. The response time must be reported in milliseconds.
OBIEMIReportData/ResponseOutliers/TTFBResponseTime TTFBResponseTime 1 1 Number TTFB Response Time (Time to First Byte)(8.9) The Time to First Byte (TTFB) response time for the API endpoint that generated an outlier from the overall data set of TTLB response times (e.g. a Get Account Transactions Request generates a Get Account Transactions Response message with response time being an outlier). Time to First Byte (TTFB) is defined in the context of the OBIE reporting template as the total time taken for an API endpoint call to generate a response message and start providing to AISPs, PISPs or CBPIIs all the information as required as defined in 36(1)(a), 36(1)(b), 36(1)(c) of the RTS and 66(4)(b), 65(3) of the PSD2. The response time clock should start at the point the endpoint call is fully received by the ASPSP, and should stop at the point the first byte of the response message is transmitted to the AISP, PISP, or CBPII. The response time must be reported in milliseconds.
OBIEMIReportData/ResponseOutliers/TPPApplicationID TPPApplicationID 1 1 Max16Text 1 16 This is the unique ID assigned to a TPP during their registration with the OBIE Directory for a specific application. This is the field 'software_id; in the Software Statement Assertion (SSA). It is this TPP application that made the API endpoint call that generated the outlier.
OBIEMIReportData/ResponseOutliers/ResponsePayloadSize ResponsePayloadSize 1 1 Number The value of the Response Payload for the API endpoint that generated the outlier (e.g. a Get Account Transactions Request generates a Get Account Transactions Response message with response time being an outlier) The response payload size of the response message to the supported Read/Write API endpoints must also include the size of the message headers. The Response Payload must be reported in bytes.
OBIEMIReportData/ResponseOutliers/Version Version 1 1 OBAPIMajorVersionType1Code The OBIE Standards version of the endpoint implementation by the ASPSP, aggregated at the level of major or minor release, as defined in item#10 of Section 2 key usage instructions.
OBIEMIReportData/ResponseOutliers/Version/:code:V3.0 V3.0 V3.0
OBIEMIReportData/ResponseOutliers/Version/:code:V3.1 V3.1 V3.1
OBIEMIReportData/ResponseOutliers/Version/:code:V3.2 V3.2 V3.2
OBIEMIReportData/ResponseOutliers/Version/:code:V3.3 V3.3 V3.3
OBIEMIReportData/ResponseOutliers/Version/:code:V4.0 V4.0 V4.0
OBIEMIReportData/ResponseOutliers/Version/:code:V4.1 V4.1 V4.1
OBIEMIReportData/ResponseOutliers/Version/:code:VOTH Other Other version
OBIEMIReportData/ResponseOutliers/OtherMIBrand OtherMIBrand 0 1 OBMIOtherBrandType1
OBIEMIReportData/ResponseOutliers/OtherMIBrand/MIBrandId MIBrandId 1 1 OB_CodeMnemonic Other Brand Id which is not available in the published
OBIEMIReportData/ResponseOutliers/OtherMIBrand/BrandName BrandName 1 1 Max500Text 1 500 Long name associated with the code
OBIEMIReportData/ResponseOutliers/OtherMIBrand/Description Description 0 1 Max350Text 1 350 Description to describe the purpose of the code
OBIEMIReportData/ResponseOutliers/OtherEndpoint OtherEndpoint 0 1 OBMIOtherEndpointType1
OBIEMIReportData/ResponseOutliers/OtherEndpoint/EndpointId EndpointId 1 1 OB_CodeMnemonic Other Endpint Id which is not available in the published
OBIEMIReportData/ResponseOutliers/OtherEndpoint/Endpoint Endpoint 1 1 Max500Text 1 500 Long name associated with the code
OBIEMIReportData/ResponseOutliers/OtherEndpoint/Description Description 0 1 Max350Text 1 350 Description to describe the purpose of the code
OBIEMIReportData/ResponseOutliers/OtherVersion OtherVersion 0 1 OBMIOtherVersionType1
OBIEMIReportData/ResponseOutliers/OtherVersion/Version Version 1 1 OB_CodeMnemonic Other Version which is not available in published list
OBIEMIReportData/ResponseOutliers/OtherVersion/VersionName VersionName 1 1 Max70Text 1 70 Long name associated with the code
OBIEMIReportData/ResponseOutliers/OtherVersion/Description Description 0 1 Max350Text 1 350 Description to describe the purpose of the code
OBIEMIReportData/AuthEfficacyOBIE AuthEfficacyOBIE 0 unbounded OBMIAuthenticationEfficacyReportData1
OBIEMIReportData/AuthEfficacyOBIE/MIBrandId MIBrandId 1 1 OBMIBrands1Code Brand Name that an organisation uses to market its products or services to a consumer.
OBIEMIReportData/AuthEfficacyOBIE/MIBrandId/:code:0001 AIBFirstTrustBank AIB First Trust Bank
OBIEMIReportData/AuthEfficacyOBIE/MIBrandId/:code:0002 AIBGroupUK AIB Group (UK) p.l.c.
OBIEMIReportData/AuthEfficacyOBIE/MIBrandId/:code:0003 BankOfIrelandUK Bank of Ireland UK
OBIEMIReportData/AuthEfficacyOBIE/MIBrandId/:code:0004 BankOfScotland Bank of Scotland
OBIEMIReportData/AuthEfficacyOBIE/MIBrandId/:code:0005 Barclays Barclays
OBIEMIReportData/AuthEfficacyOBIE/MIBrandId/:code:0006 DanskeBank Danske Bank
OBIEMIReportData/AuthEfficacyOBIE/MIBrandId/:code:0007 FirstDirect First Direct
OBIEMIReportData/AuthEfficacyOBIE/MIBrandId/:code:0008 Halifax Halifax
OBIEMIReportData/AuthEfficacyOBIE/MIBrandId/:code:0009 HSBC HSBC
OBIEMIReportData/AuthEfficacyOBIE/MIBrandId/:code:0010 Lloyds Lloyds
OBIEMIReportData/AuthEfficacyOBIE/MIBrandId/:code:0011 MAndSBank M&S Bank
OBIEMIReportData/AuthEfficacyOBIE/MIBrandId/:code:0012 NationwideBuildingSociety Nationwide Building Society
OBIEMIReportData/AuthEfficacyOBIE/MIBrandId/:code:0013 Natwest Natwest
OBIEMIReportData/AuthEfficacyOBIE/MIBrandId/:code:0014 RBS RBS
OBIEMIReportData/AuthEfficacyOBIE/MIBrandId/:code:0015 Santander UK plc Santander UK plc
OBIEMIReportData/AuthEfficacyOBIE/MIBrandId/:code:0016 UBN UBN
OBIEMIReportData/AuthEfficacyOBIE/MIBrandId/:code:9999 OTHERBrand Other Brand
OBIEMIReportData/AuthEfficacyOBIE/ReportMonth ReportMonth 1 1 Max6Text 1 6 ^(Jan Feb Mar Apr
OBIEMIReportData/AuthEfficacyOBIE/AuthenticationType AuthenticationType 1 1 OBMIAuthenticationType1Code This is the type of authentication journeys provided by the ASPSP. It will include 'redirection' and where implemented 'decoupled' model. As minimum Redirection data must be provided
OBIEMIReportData/AuthEfficacyOBIE/AuthenticationType/:code:ATDC Decoupled Decoupled
OBIEMIReportData/AuthEfficacyOBIE/AuthenticationType/:code:ATRD Redirection Redirection
OBIEMIReportData/AuthEfficacyOBIE/APIType APIType 1 1 OBMIAPIType1Code This is the type of OBIE services that are being reported for the efficacy of the authentication journey. It includes Account Information Services (AIS), Payment Initiation Services (PIS) and Card Based Payment Instrument Issuers (CBPIIs)
OBIEMIReportData/AuthEfficacyOBIE/APIType/:code:APAI AIS AIS
OBIEMIReportData/AuthEfficacyOBIE/APIType/:code:APCB CBPII CBPII
OBIEMIReportData/AuthEfficacyOBIE/APIType/:code:APPI PIS PIS
OBIEMIReportData/AuthEfficacyOBIE/APIRequestTPPChannel APIRequestTPPChannel 1 1 OBMIAPIRequestTPPChannel1Code This is the reported TPP channel for initiating the AIs, PIS or CBPII consent. This may be provided by TPPs in the endpoint Request Header under the field 'x-customer-user-agent'. The reported value will be free format text however if populated by TPPs it will have well known strings of characters for various popular browsers. If the string cannot be mapped to a browser, then it will probably be a mobile app. Future versions of CEG guidelines may recommend specific values to TPPs to provide in this fields some that better information is provided.
OBIEMIReportData/AuthEfficacyOBIE/APIRequestTPPChannel/:code:TPBR Browser Browser
OBIEMIReportData/AuthEfficacyOBIE/APIRequestTPPChannel/:code:TPNR Non-Browser Non-Browser
OBIEMIReportData/AuthEfficacyOBIE/APIRequestTPPChannel/:code:TPUN Unknown Unknown
OBIEMIReportData/AuthEfficacyOBIE/ASPSPAuthenticationChannel ASPSPAuthenticationChannel 1 1 OBMIASPSPAuthChannel1Code ASPSP Authentication Channel (9.13/9.21/9.28/9.35) This is the reported ASPSP Authentication channel. I can be web based (Web) or using the mobile banking app (App)
OBIEMIReportData/AuthEfficacyOBIE/ASPSPAuthenticationChannel/:code:ACAP App App
OBIEMIReportData/AuthEfficacyOBIE/ASPSPAuthenticationChannel/:code:ACWB Web Web
OBIEMIReportData/AuthEfficacyOBIE/ConsentRequiringAuthentication ConsentRequiringAuthentication 1 1 Number Consents requiring Authentication (9.12/9.20/9.27/9.34) (9.13/9.21/9.28/9.35) The total number of PSU consents requiring authentication at the ASPSP for the particular combination of authentication type, API type, TPP channel and ASPSP authentication channel.
OBIEMIReportData/AuthEfficacyOBIE/AuthenticationsAttemptedByPSUs AuthenticationsAttemptedByPSUs 1 1 Number Authentications Attempted by PSUs (9.14/9.36) The total number of authentications that have been attempted by the PSUs (not abandoned). This means that PSUs have tried to authenticate according to the authentication method required providing biometrics, username, passwords etc. Conditions 1. Consents requiring Authentication >= Authentications Attempted by PSUs 2. Consents requiring Authentication = Authentications Attempted by PSUs + Authentications Abandoned by PSUs
OBIEMIReportData/AuthEfficacyOBIE/AuthenticationsAbandonedByPSUs AuthenticationsAbandonedByPSUs 1 1 Number Authentications Abandoned by PSUs (9.14/9.36) The total number of PSU consents requiring authentication that have been abandoned by the PSUs. This means that PSUs do not undertake the authentication but instead have dropped the journey (they have left, closed the web page or app or allowed the authentication page to time out). Conditions 1. Consents requiring Authentication >= Authentications Abandoned by PSUs 2. Consents requiring Authentication = Authentications Attempted by PSUs + Authentications Abandoned by PSUs
OBIEMIReportData/AuthEfficacyOBIE/AuthenticationsSucceeded AuthenticationsSucceeded 1 1 Number Authentications Succeeded (9.15/9.22/9.29/9.37) The total number of consents requiring authentication that have completed authentications by PSUs and the authentications have succeeded. Conditions 1. Authentications Attempted by PSUs >= Authentications Succeeded 2. Authentications Attempted by PSUs = Authentications Succeeded + Authentications Failed
OBIEMIReportData/AuthEfficacyOBIE/AuthenticationsFailed AuthenticationsFailed 1 1 Number Authentications Failed (9.16/9.23/9.30/9.37) The total number of consents requiring authentication that have completed authentications by PSUs and the authentications have failed. Conditions 1. Authentications Attempted by PSUs >= Authentications Failed 2. Authentications Attempted by PSUs = Authentications Succeeded + Authentications Failed
OBIEMIReportData/AuthEfficacyOBIE/ConfirmationsRequired ConfirmationsRequired 1 1 Number Confirmations Required (9.17/9.24/9.31/9.38) The total number of consents requiring authorisation, that after successful authentication, required a confirmation step. Please refer to Section 2, item #9. Conditions 1. Authentications Succeeded >= Confirmations Required
OBIEMIReportData/AuthEfficacyOBIE/ConfirmationsAcceptedByPSUs ConfirmationsAcceptedByPSUs 1 1 Number Confirmations Accepted by PSUs (9.18/9.25/9.32/9.39) The total number of successful authentications that required a confirmation step and have been accepted by PSUs. This means that the PSU proceeded with the access request or the payment order submission and did not cancel the process. (Please refer to Section 2, item #9). Conditions 1. Confirmations Required >= Confirmations Accepted by PSUs 2. Confirmations Required = Confirmations Accepted by PSUs + Confirmations Rejected by PSUs
OBIEMIReportData/AuthEfficacyOBIE/ConfirmationsRejectedByPSUs ConfirmationsRejectedByPSUs 1 1 Number Confirmations Rejected by PSUs(9.19/9.26/9.33/9.39) The total number of successful authentications that required a confirmation step and have been rejected by PSUs. This means that the PSU cancelled the process and did not proceed with the access request or the payment order submission (Please refer to Section 2, item #9). Conditions 1. Confirmations Required >= Confirmations Rejected by PSUs 2. Confirmations Required = Confirmations Accepted by PSUs + Confirmations Rejected by PSUs
OBIEMIReportData/AuthEfficacyOBIE/Version Version 1 1 OBAPIMajorVersionType1Code The OBIE Standards version of the endpoint implementation by the ASPSP, aggregated at the level of major or minor release, as defined in item#10 of Section 2 key usage instructions.
OBIEMIReportData/AuthEfficacyOBIE/Version/:code:V3.0 V3.0 V3.0
OBIEMIReportData/AuthEfficacyOBIE/Version/:code:V3.1 V3.1 V3.1
OBIEMIReportData/AuthEfficacyOBIE/Version/:code:V3.2 V3.2 V3.2
OBIEMIReportData/AuthEfficacyOBIE/Version/:code:V3.3 V3.3 V3.3
OBIEMIReportData/AuthEfficacyOBIE/Version/:code:V4.0 V4.0 V4.0
OBIEMIReportData/AuthEfficacyOBIE/Version/:code:V4.1 V4.1 V4.1
OBIEMIReportData/AuthEfficacyOBIE/Version/:code:VOTH Other Other version
OBIEMIReportData/AuthEfficacyOBIE/OtherMIBrand OtherMIBrand 0 1 OBMIOtherBrandType1
OBIEMIReportData/AuthEfficacyOBIE/OtherMIBrand/MIBrandId MIBrandId 1 1 OB_CodeMnemonic Other Brand Id which is not available in the published
OBIEMIReportData/AuthEfficacyOBIE/OtherMIBrand/BrandName BrandName 1 1 Max500Text 1 500 Long name associated with the code
OBIEMIReportData/AuthEfficacyOBIE/OtherMIBrand/Description Description 0 1 Max350Text 1 350 Description to describe the purpose of the code
OBIEMIReportData/AuthEfficacyOBIE/OtherVersion OtherVersion 0 1 OBMIOtherVersionType1
OBIEMIReportData/AuthEfficacyOBIE/OtherVersion/Version Version 1 1 OB_CodeMnemonic Other Version which is not available in published list
OBIEMIReportData/AuthEfficacyOBIE/OtherVersion/VersionName VersionName 1 1 Max70Text 1 70 Long name associated with the code
OBIEMIReportData/AuthEfficacyOBIE/OtherVersion/Description Description 0 1 Max350Text 1 350 Description to describe the purpose of the code
OBIEMIReportData/PSUAdoptionOBIE PSUAdoptionOBIE 0 unbounded OBMIPSUsAdoptionMetricsReportData1
OBIEMIReportData/PSUAdoptionOBIE/MIBrandId MIBrandId 1 1 OBMIBrands1Code Brand Name that an organisation uses to market its products or services to a consumer.
OBIEMIReportData/PSUAdoptionOBIE/MIBrandId/:code:0001 AIBFirstTrustBank AIB First Trust Bank
OBIEMIReportData/PSUAdoptionOBIE/MIBrandId/:code:0002 AIBGroupUK AIB Group (UK) p.l.c.
OBIEMIReportData/PSUAdoptionOBIE/MIBrandId/:code:0003 BankOfIrelandUK Bank of Ireland UK
OBIEMIReportData/PSUAdoptionOBIE/MIBrandId/:code:0004 BankOfScotland Bank of Scotland
OBIEMIReportData/PSUAdoptionOBIE/MIBrandId/:code:0005 Barclays Barclays
OBIEMIReportData/PSUAdoptionOBIE/MIBrandId/:code:0006 DanskeBank Danske Bank
OBIEMIReportData/PSUAdoptionOBIE/MIBrandId/:code:0007 FirstDirect First Direct
OBIEMIReportData/PSUAdoptionOBIE/MIBrandId/:code:0008 Halifax Halifax
OBIEMIReportData/PSUAdoptionOBIE/MIBrandId/:code:0009 HSBC HSBC
OBIEMIReportData/PSUAdoptionOBIE/MIBrandId/:code:0010 Lloyds Lloyds
OBIEMIReportData/PSUAdoptionOBIE/MIBrandId/:code:0011 MAndSBank M&S Bank
OBIEMIReportData/PSUAdoptionOBIE/MIBrandId/:code:0012 NationwideBuildingSociety Nationwide Building Society
OBIEMIReportData/PSUAdoptionOBIE/MIBrandId/:code:0013 Natwest Natwest
OBIEMIReportData/PSUAdoptionOBIE/MIBrandId/:code:0014 RBS RBS
OBIEMIReportData/PSUAdoptionOBIE/MIBrandId/:code:0015 Santander UK plc Santander UK plc
OBIEMIReportData/PSUAdoptionOBIE/MIBrandId/:code:0016 UBN UBN
OBIEMIReportData/PSUAdoptionOBIE/MIBrandId/:code:9999 OTHERBrand Other Brand
OBIEMIReportData/PSUAdoptionOBIE/ReportMonth ReportMonth 1 1 Max6Text 1 6 ^(Jan Feb Mar Apr
OBIEMIReportData/PSUAdoptionOBIE/RetailBusinessPSUs RetailBusinessPSUs 1 1 OBMIPSUCategory1Code This identifies Retail and Business PSUs for separate reporting.
OBIEMIReportData/PSUAdoptionOBIE/RetailBusinessPSUs/:code:PCBU Business Business
OBIEMIReportData/PSUAdoptionOBIE/RetailBusinessPSUs/:code:PCRT Retail Retail
OBIEMIReportData/PSUAdoptionOBIE/PSUsAISServicesFirstTime PSUsAISServicesFirstTime 1 1 Number PSUs used AIS Services for the first time(9.9) The number of unique PSUs (customers with one or more accounts with the ASPSP brand) who have authorised access to their account(s) to one or more AISPs for account information services for the first time during the reporting period. For the avoidance of doubt, this refers to new consent/authorisations and not re-authorisations. A PSU providing account access to more than 1 AISP should not be double counted. For business customers, unique PSUs should refer to all employees of the business who have separate authentication credentials and can be identified separately. Multi-banked PSUs cannot be identified so they may be double counted by different ASPSPs.
OBIEMIReportData/PSUAdoptionOBIE/PSUsPISServicesFirstTime PSUsPISServicesFirstTime 1 1 Number PSUs used PIS Services for the first time(9.10) The number of unique PSUs (customers with one or more accounts with the ASPSP brand) who have authorised a payment initiation of any type from any of their account(s) via one or more PISPs for the first time during the reporting period. For the avoidance of doubt, a PSU initiating a payment (e.g. single domestic) using a PISP A from a PCA A and then initiating another payment of different type (e.g. international) using a PISP B from a PCA B within the same ASPSP brand, should not be double counted. For business customers, unique PSUs should refer to all employees of the business who have separate authentication credentials and can be identified separately. Multi-banked PSUs cannot be identified so they may be double counted by different ASPSPs.
OBIEMIReportData/PSUAdoptionOBIE/TotalPSUsAISServices TotalPSUsAISServices 1 1 Number Total PSUs used AIS Services(9.9) The total number of unique PSUs (customers with one or more accounts with the ASPSP brand) who: a. have authorised access to their account(s) to one or more AISPs for account information services during the reporting period for the first time (see Total PSUs used AIS Services) b. have previously authorised access to their account(s) to one or more AISPs for account information services and had their account accessed at least once by any of the AISPs during the reporting period. c. have previously authorised access to their account(s) to one or more AISPs for account information services and had to re-authenticate to refresh the account access at least for one of the AISPs during the reporting period. For the avoidance of doubt, a PSU in case (c) re-authenticating their account access should not be double counted if an AISP accesses their account after re-authentication. For business customers, unique PSUs should refer to all employees of the business who have separate authentication credentials and can be identified separately. Conditions 1. Total PSUs used AIS Services >= PSUs used AIS Services for the first time
OBIEMIReportData/PSUAdoptionOBIE/TotalPSUsPISServices TotalPSUsPISServices 1 1 Number Total PSUs used PIS Services(9.10) The total number of unique PSUs (customers with one or more accounts with the ASPSP brand) who: a. have authorised a payment initiation of any type from any of their account(s) via one or more PISPs for the first time during the reporting period (see Total PSUs used PIS Services) b. have authorised a payment initiation of any type from any of their account(s) via one or more PISPs during the reporting period and have initiated payments using PIS services before. For the avoidance of doubt, a PSU initiating a payment (e.g. single domestic) using a PISP A from a PCA A and then initiating another payment of different type (e.g. international) using a PISP B from a PCA B within the same ASPSP brand, should not be double counted. For business customers, unique PSUs should refer to all employees of the business who have separate authentication credentials and can be identified separately. Conditions 1. Total PSUs used PIS Services >= PSUs used PIS Services for the first time
OBIEMIReportData/PSUAdoptionOBIE/UniquePSUsAISandPISFirstTime UniquePSUsAISandPISFirstTime 1 1 Number Unique PSUs used both AIS and PIS Services for the first time. PSUs accessing both AIS and PIS services using the same authentication credentials. The number of unique PSUs (customers with one or more accounts with the ASPSP brand) who have: a. authorised access to their account(s) to one or more AISPs for account information services for the first time during the reporting period. AND b. authorised a payment initiation of any type from any of their account(s) via one or more PISPs for the first time during the reporting period. For the avoidance of doubt: For the avoidance of doubt: i. for AIS, this refers to new consent/authorisations and not re-authorisations. A PSU providing account access to more than 1 AISPs should not be double counted. For business customers, unique PSUs should refer to all employees of the business who have separate authentication credentials and can be identified separately. ii. for PIS, a PSU initiating a payment (e.g. single domestic) using a PISP A from a PCA A and then initiating another payment of different type (e.g. international) using a PISP B from a PCA B within the same ASPSP brand, should not be double counted. For business customers, unique PSUs should refer to all employees of the business who have separate authentication credentials and can be identified separately. Conditions 1. Unique PSUs used both AIS and PIS Services for the first time >= PSUs used AIS Services for the first time 2. Unique PSUs used both AIS and PIS Services for the first time >= PSUs used PIS Services for the first time 3. Unique PSUs used both AIS and PIS Services for the first time <= PSUs used AIS Services for the first time + PSUs used PIS Services for the first time
OBIEMIReportData/PSUAdoptionOBIE/TotalUniquePSUsAISandPIS TotalUniquePSUsAISandPIS 1 1 Number Total unique PSUs used both AIS and PIS Services PSUs accessing both AIS and PIS services using the same authentication credentials. The total number of unique PSUs (customers with one or more accounts with the ASPSP brand) who: a. have authorised access to their account(s) to one or more AISPs for account information services during the reporting period for the first time (see Total PSUs used AIS Services) b. have previously authorised access to their account(s) to one or more AISPs for account information services and had their account accessed at least once by any of the AISPs during the reporting period. c. have previously authorised access to their account(s) to one or more AISPs for account information services and had to re-authenticate to refresh the account access at least for one of the AISPs during the reporting period. AND d. have authorised a payment initiation of any type from any of their account(s) via one or more PISPs for the first time during the reporting period (see Total PSUs used PIS Services) e. have authorised a payment initiation of any type from any of their account(s) via one or more PISPs during the reporting period and have initiated payments using PIS services before. For the avoidance of doubt: i. For AIS, a PSU in case (c) re-authenticating their account access should not be double counted if an AISP accesses their account after re-authentication. For business customers, unique PSUs should refer to all employees of the business who have separate authentication credentials and can be identified separately. ii. For PIS, a PSU initiating a payment (e.g. single domestic) using a PISP A from a PCA A and then initiating another payment of different type (e.g. international) using a PISP B from a PCA B within the same ASPSP brand, should not be double counted. For business customers, unique PSUs should refer to all employees of the business who have separate authentication credentials and can be identified separately. Conditions 1. Total unique PSUs used both AIS and PIS Services >= Unique PSUs used both AIS and PIS Services for the first time 2. Total unique PSUs used both AIS and PIS Services >= Total PSUs used AIS Services 3. Total unique PSUs used both AIS and PIS Services >= Total PSUs used PIS Services 4. Total unique PSUs used PIS Services <= Total PSUs used AIS Services + Total PSUs used PIS Services
OBIEMIReportData/PSUAdoptionOBIE/TotalNewPSUsOnlineBanking TotalNewPSUsOnlineBanking 1 1 Number Total new PSUs for Online Banking The number of unique PSUs (customers with one or more accounts with the ASPSP brand) who have been granted access to the Online Banking for the first time.
OBIEMIReportData/PSUAdoptionOBIE/TotalNewPSUsMobileBanking TotalNewPSUsMobileBanking 1 1 Number Total new PSUs for Mobile Banking The number of unique PSUs (customers with one or more accounts with the ASPSP brand) who have been granted access to the Mobile Banking for the first time.
OBIEMIReportData/PSUAdoptionOBIE/TotalNumberPSUsOnlineBanking TotalNumberPSUsOnlineBanking 1 1 Number Total number of PSUs used Online Banking The total number of unique PSUs (customers with one or more accounts with the ASPSP brand) who have used the Online Banking service for either accessing account information or initiating a payment. Note: For business customers, unique PSUs should refer to all employees of the business who have separate authentication credentials and can be identified separately. Conditions 1. Total number of PSUs used Online Banking >= Total new PSUs for Online Banking
OBIEMIReportData/PSUAdoptionOBIE/TotalNumberPSUsMobileBanking TotalNumberPSUsMobileBanking 1 1 Number Total number of PSUs used Mobile Banking The total number of unique PSUs (customers with one or more accounts with the ASPSP brand) who have used the Mobile Banking service for either accessing account information or initiating a payment. Note: For business customers, unique PSUs should refer to all employees of the business who have separate authentication credentials and can be identified separately. Conditions 1. Total number of PSUs used Mobile Banking >= Total new PSUs for Mobile Banking
OBIEMIReportData/PSUAdoptionOBIE/Version Version 1 1 OBAPIMajorVersionType1Code The OBIE Standards version of the endpoint implementation by the ASPSP, aggregated at the level of major or minor release, as defined in item#10 of Section 2 key usage instructions.
OBIEMIReportData/PSUAdoptionOBIE/Version/:code:V3.0 V3.0 V3.0
OBIEMIReportData/PSUAdoptionOBIE/Version/:code:V3.1 V3.1 V3.1
OBIEMIReportData/PSUAdoptionOBIE/Version/:code:V3.2 V3.2 V3.2
OBIEMIReportData/PSUAdoptionOBIE/Version/:code:V3.3 V3.3 V3.3
OBIEMIReportData/PSUAdoptionOBIE/Version/:code:V4.0 V4.0 V4.0
OBIEMIReportData/PSUAdoptionOBIE/Version/:code:V4.1 V4.1 V4.1
OBIEMIReportData/PSUAdoptionOBIE/Version/:code:VOTH Other Other version
OBIEMIReportData/PSUAdoptionOBIE/OtherMIBrand OtherMIBrand 0 1 OBMIOtherBrandType1
OBIEMIReportData/PSUAdoptionOBIE/OtherMIBrand/MIBrandId MIBrandId 1 1 OB_CodeMnemonic Other Brand Id which is not available in the published
OBIEMIReportData/PSUAdoptionOBIE/OtherMIBrand/BrandName BrandName 1 1 Max500Text 1 500 Long name associated with the code
OBIEMIReportData/PSUAdoptionOBIE/OtherMIBrand/Description Description 0 1 Max350Text 1 350 Description to describe the purpose of the code
OBIEMIReportData/PSUAdoptionOBIE/OtherVersion OtherVersion 0 1 OBMIOtherVersionType1
OBIEMIReportData/PSUAdoptionOBIE/OtherVersion/Version Version 1 1 OB_CodeMnemonic Other Version which is not available in published list
OBIEMIReportData/PSUAdoptionOBIE/OtherVersion/VersionName VersionName 1 1 Max70Text 1 70 Long name associated with the code
OBIEMIReportData/PSUAdoptionOBIE/OtherVersion/Description Description 0 1 Max350Text 1 350 Description to describe the purpose of the code
OBIEMIReportData/PaymentsAdoptionOBIE PaymentsAdoptionOBIE 0 unbounded OBMIPaymentsAdoptionMetricsReportData1
OBIEMIReportData/PaymentsAdoptionOBIE/MIBrandId MIBrandId 1 1 OBMIBrands1Code Brand Name that an organisation uses to market its products or services to a consumer.
OBIEMIReportData/PaymentsAdoptionOBIE/MIBrandId/:code:0001 AIBFirstTrustBank AIB First Trust Bank
OBIEMIReportData/PaymentsAdoptionOBIE/MIBrandId/:code:0002 AIBGroupUK AIB Group (UK) p.l.c.
OBIEMIReportData/PaymentsAdoptionOBIE/MIBrandId/:code:0003 BankOfIrelandUK Bank of Ireland UK
OBIEMIReportData/PaymentsAdoptionOBIE/MIBrandId/:code:0004 BankOfScotland Bank of Scotland
OBIEMIReportData/PaymentsAdoptionOBIE/MIBrandId/:code:0005 Barclays Barclays
OBIEMIReportData/PaymentsAdoptionOBIE/MIBrandId/:code:0006 DanskeBank Danske Bank
OBIEMIReportData/PaymentsAdoptionOBIE/MIBrandId/:code:0007 FirstDirect First Direct
OBIEMIReportData/PaymentsAdoptionOBIE/MIBrandId/:code:0008 Halifax Halifax
OBIEMIReportData/PaymentsAdoptionOBIE/MIBrandId/:code:0009 HSBC HSBC
OBIEMIReportData/PaymentsAdoptionOBIE/MIBrandId/:code:0010 Lloyds Lloyds
OBIEMIReportData/PaymentsAdoptionOBIE/MIBrandId/:code:0011 MAndSBank M&S Bank
OBIEMIReportData/PaymentsAdoptionOBIE/MIBrandId/:code:0012 NationwideBuildingSociety Nationwide Building Society
OBIEMIReportData/PaymentsAdoptionOBIE/MIBrandId/:code:0013 Natwest Natwest
OBIEMIReportData/PaymentsAdoptionOBIE/MIBrandId/:code:0014 RBS RBS
OBIEMIReportData/PaymentsAdoptionOBIE/MIBrandId/:code:0015 Santander UK plc Santander UK plc
OBIEMIReportData/PaymentsAdoptionOBIE/MIBrandId/:code:0016 UBN UBN
OBIEMIReportData/PaymentsAdoptionOBIE/MIBrandId/:code:9999 OTHERBrand Other Brand
OBIEMIReportData/PaymentsAdoptionOBIE/ReportMonth ReportMonth 1 1 Max6Text 1 6 ^(Jan Feb Mar Apr
OBIEMIReportData/PaymentsAdoptionOBIE/PaymentType PaymentType 1 1 OBMIPaymentType1Code The payment types that a number of adoption metrics need to be reported. Note: It is not required to cover faster payments under this tab. The reason for this is that the number of faster payments can be derived from the overall daily volumetrics, subtracting the number of CHAPS and the Bacs payments, as the single Domestic Payments API endpoint call can be either one of these 3. For future dated payments (Domestic Scheduled and International Scheduled), there are different endpoints in the volumetrics tab, so again there is no need to cover these in this tab. For Standing Orders (both Domestic Standing Orders and International Standing Orders), the endpoint volumes are only providing the SOs setup instructions and there is no visibility of the actual number of SOs that will be generated. However, the MI requirements paper does not cover this, (it was initially included in earlier versions of the paper but was later dropped due to the scope reduction) so there is no justification at the moment to include this information.
OBIEMIReportData/PaymentsAdoptionOBIE/PaymentType/:code:PTBP Bulk Payments Bulk Payments
OBIEMIReportData/PaymentsAdoptionOBIE/PaymentType/:code:PTBS Bacs Bacs
OBIEMIReportData/PaymentsAdoptionOBIE/PaymentType/:code:PTCH CHAPS CHAPS
OBIEMIReportData/PaymentsAdoptionOBIE/PaymentType/:code:PTIN International International
OBIEMIReportData/PaymentsAdoptionOBIE/PSUAuthorisationsSDP PSUAuthorisationsSDP 1 1 Max20AlphaNumericText 1 20 [a-zA-Z0-9]{1,20} PSU Authorisations for single Domestic Payments (9.40/9.41) For single domestic payments, this is the total number of payment orders authorised by PSUs per the available payment type, excluding the default payment type which is Faster Payments. Thus, this item relates only to Bacs and CHAPS single payments. Note: For this item, OBIE is looking to receive the number of payment order consent calls (POST /domestic-payment-consents endpoint calls) which resulted in domestic-payment consent resources with state Authorised. If payment type is Bulk: NULL If payment type is International: NULL
OBIEMIReportData/PaymentsAdoptionOBIE/SuccessfulSDPs SuccessfulSDPs 1 1 Max20AlphaNumericText 1 20 [a-zA-Z0-9]{1,20} Successful single Domestic Payments(9.42/9.43) For single domestic payments, this is the total number of successful single domestic payment orders that have been accepted for execution per the available payment type, excluding the default payment type which is Faster Payments. Thus, this item relates only to Bacs and CHAPS single payments. Note: OBIE is focusing on the initiation of the payments and less the actual core banking transactions outcome. Thus for this item, OBIE is looking to receive the number of payment order calls (POST /domestic-payments endpoint calls) which resulted in domestic-payment resources with state AcceptedSettlementInProgress or AcceptedSettlementCompleted. This means that as a minimum, all preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution. This also assumes that that the payment order consent was also successful and has been authorised and consumed. If payment type is Bulk: NULL If payment type is International: NULL Conditions 1. Successful single Domestic Payments <= PSU Authorisations for single Domestic Payments
OBIEMIReportData/PaymentsAdoptionOBIE/SDPsFailedBusinessReasons SDPsFailedBusinessReasons 1 1 Max20AlphaNumericText 1 20 [a-zA-Z0-9]{1,20} Single Domestic Payments failed for Business Reasons (4xx codes) (9.44/9.45) For single domestic payments, this is the total number of failed single domestic payment initiation endpoint calls that have failed due to business rules reasons (generating an HTPP Status Code of 4xx) per the available payment type, excluding the default payment type which is Faster Payments. Thus, this item relates only to Bacs and CHAPS single payments. Note: OBIE is looking to receive the failed payment initiation endpoint calls at every part of the payment initiation journey, including both the post of the domestic payment consent and post of the domestic payment order. If payment type is Bulk: NULL If payment type is International: NULL
OBIEMIReportData/PaymentsAdoptionOBIE/SDPsFailedTechnicalReasons SDPsFailedTechnicalReasons 1 1 Max20AlphaNumericText 1 20 [a-zA-Z0-9]{1,20} Single Domestic Payments failed for Technical Reasons (500 codes) (9.44/9.45) For single domestic payments, this is the total number of failed single domestic payment initiation endpoint calls that have failed due to technical reasons (generating an HTPP Status Code of 500 Internal Server Error) per the available payment type, excluding the default payment type which is Faster Payments. Thus, this item relates only to Bacs and CHAPS single payments. Note: OBIE is looking to receive the failed payment initiation endpoint calls at every part of the payment initiation journey, including both the post of the domestic payment consent and post of the domestic payment order. If payment type is Bulk: NULL If payment type is International: NULL
OBIEMIReportData/PaymentsAdoptionOBIE/SDPsRejected SDPsRejected 1 1 Max20AlphaNumericText 1 20 [a-zA-Z0-9]{1,20} Single Domestic Payments Rejected (9.44/9.45) For single domestic payments, this is the total number of rejected single domestic payment initiation endpoint calls that have been rejected per the available payment type, excluding the default payment type which is Faster Payments. Thus, this item relates only to Bacs and CHAPS single payments. Note: OBIE is looking to receive the rejected payment initiation endpoint calls at every part of the payment initiation journey, including both the post of the domestic payment consent and post of the domestic payment order. Thus, the item refers to the number of these calls which resulted in: a. domestic payments consent resources in rejected state due to authorisation failing or consent authorisation being rejected b. domestic-payment resources in rejected state due to payment initiation being rejected as part of preceding checks such as technical validation and customer profile. If payment type is Bulk: NULL If payment type is International: NULL Conditions 1. Single Domestic Payments Rejected <= PSU Authorisations for single Domestic Payments 2. (Single Domestic Payments Rejected + Successful single Domestic Payments) <= PSU Authorisations for single Domestic Payments
OBIEMIReportData/PaymentsAdoptionOBIE/TotalPaymentsIncludedBulkBatch TotalPaymentsIncludedBulkBatch 1 1 Max20AlphaNumericText 1 20 [a-zA-Z0-9]{1,20} Total payments included in Bulk/Batch files (9.46) This is the total number of payments (individual payment instructions) included in bulk/batch files sent to the ASPSP brand for payment initiation via PISPs. The number of transactions may be included in the field NumberOfTransactions of the POST /file-payment-consents endpoint call but this field is not mandatory to be populated by PISPs. The total number of transactions may also be included within the file submitted by the PISP and can be extracted from there. Please note that this number refers to the number of transactions included within the file and does not need to exclude any invalid transactions identified during validation. If payment type is Bacs: NULL If payment type is CHAPS: NULL If payment type is International: NULL
OBIEMIReportData/PaymentsAdoptionOBIE/SuccessfulIntPmntsInvolvingCX SuccessfulIntPmntsInvolvingCX 1 1 Max20AlphaNumericText 1 20 [a-zA-Z0-9]{1,20} Successful International payments involving currency conversion (9.47) This is the number of successful international payments initiated via PISPs that involved currency conversion. This is to be expressed as a percentage of the total successful international payments initiated via PISPs. For the avoidance of doubt, successful international payments refer to the number of international payment order calls (POST /international-payments endpoint calls) which resulted in international-payment resources with state AcceptedSettlementInProgress or AcceptedSettlementCompleted. This means that as a minimum, all preceding checks such as technical validation and customer profile were successful and therefore the international payment initiation has been accepted for execution. This also assumes that that the international payment order consent was also successful and has been authorised and consumed. In the context of the reporting template, currency conversion means that required currency for the international payment (e.g. USD) is different from the currency of the initiating (debit) account (e.g. GBP) and thus the ASPSP will perform currency conversion during the processing and execution of the payment. Percentage number with no decimal points with value between 0% and 100% If payment type is Bacs: NULL If payment type is CHAPS: NULL If payment type is Bulk: NULL
OBIEMIReportData/PaymentsAdoptionOBIE/Version Version 1 1 OBAPIMajorVersionType1Code The OBIE Standards version of the endpoint implementation by the ASPSP, aggregated at the level of major or minor release, as defined in item#10 of Section 2 key usage instructions.
OBIEMIReportData/PaymentsAdoptionOBIE/Version/:code:V3.0 V3.0 V3.0
OBIEMIReportData/PaymentsAdoptionOBIE/Version/:code:V3.1 V3.1 V3.1
OBIEMIReportData/PaymentsAdoptionOBIE/Version/:code:V3.2 V3.2 V3.2
OBIEMIReportData/PaymentsAdoptionOBIE/Version/:code:V3.3 V3.3 V3.3
OBIEMIReportData/PaymentsAdoptionOBIE/Version/:code:V4.0 V4.0 V4.0
OBIEMIReportData/PaymentsAdoptionOBIE/Version/:code:V4.1 V4.1 V4.1
OBIEMIReportData/PaymentsAdoptionOBIE/Version/:code:VOTH Other Other version
OBIEMIReportData/PaymentsAdoptionOBIE/OtherMIBrand OtherMIBrand 0 1 OBMIOtherBrandType1
OBIEMIReportData/PaymentsAdoptionOBIE/OtherMIBrand/MIBrandId MIBrandId 1 1 OB_CodeMnemonic Other Brand Id which is not available in the published
OBIEMIReportData/PaymentsAdoptionOBIE/OtherMIBrand/BrandName BrandName 1 1 Max500Text 1 500 Long name associated with the code
OBIEMIReportData/PaymentsAdoptionOBIE/OtherMIBrand/Description Description 0 1 Max350Text 1 350 Description to describe the purpose of the code
OBIEMIReportData/PaymentsAdoptionOBIE/OtherVersion OtherVersion 0 1 OBMIOtherVersionType1
OBIEMIReportData/PaymentsAdoptionOBIE/OtherVersion/Version Version 1 1 OB_CodeMnemonic Other Version which is not available in published list
OBIEMIReportData/PaymentsAdoptionOBIE/OtherVersion/VersionName VersionName 1 1 Max70Text 1 70 Long name associated with the code
OBIEMIReportData/PaymentsAdoptionOBIE/OtherVersion/Description Description 0 1 Max350Text 1 350 Description to describe the purpose of the code
OBIEMIReportData/TPPVolumesOBIE TPPVolumesOBIE 0 unbounded OBMITPPVolumesReportData1
OBIEMIReportData/TPPVolumesOBIE/MIBrandId MIBrandId 1 1 OBMIBrands1Code Brand Name that an organisation uses to market its products or services to a consumer.
OBIEMIReportData/TPPVolumesOBIE/MIBrandId/:code:0001 AIBFirstTrustBank AIB First Trust Bank
OBIEMIReportData/TPPVolumesOBIE/MIBrandId/:code:0002 AIBGroupUK AIB Group (UK) p.l.c.
OBIEMIReportData/TPPVolumesOBIE/MIBrandId/:code:0003 BankOfIrelandUK Bank of Ireland UK
OBIEMIReportData/TPPVolumesOBIE/MIBrandId/:code:0004 BankOfScotland Bank of Scotland
OBIEMIReportData/TPPVolumesOBIE/MIBrandId/:code:0005 Barclays Barclays
OBIEMIReportData/TPPVolumesOBIE/MIBrandId/:code:0006 DanskeBank Danske Bank
OBIEMIReportData/TPPVolumesOBIE/MIBrandId/:code:0007 FirstDirect First Direct
OBIEMIReportData/TPPVolumesOBIE/MIBrandId/:code:0008 Halifax Halifax
OBIEMIReportData/TPPVolumesOBIE/MIBrandId/:code:0009 HSBC HSBC
OBIEMIReportData/TPPVolumesOBIE/MIBrandId/:code:0010 Lloyds Lloyds
OBIEMIReportData/TPPVolumesOBIE/MIBrandId/:code:0011 MAndSBank M&S Bank
OBIEMIReportData/TPPVolumesOBIE/MIBrandId/:code:0012 NationwideBuildingSociety Nationwide Building Society
OBIEMIReportData/TPPVolumesOBIE/MIBrandId/:code:0013 Natwest Natwest
OBIEMIReportData/TPPVolumesOBIE/MIBrandId/:code:0014 RBS RBS
OBIEMIReportData/TPPVolumesOBIE/MIBrandId/:code:0015 Santander UK plc Santander UK plc
OBIEMIReportData/TPPVolumesOBIE/MIBrandId/:code:0016 UBN UBN
OBIEMIReportData/TPPVolumesOBIE/MIBrandId/:code:9999 OTHERBrand Other Brand
OBIEMIReportData/TPPVolumesOBIE/ReportMonth ReportMonth 1 1 Max6Text 1 6 ^(Jan Feb Mar Apr
OBIEMIReportData/TPPVolumesOBIE/TotalAISPsRegistered TotalAISPsRegistered 1 1 Number Total AISPs Registered (at 1st of month) (9.1) This is the cumulative total number of AISP’s, that have been already been on-boarded into the live environment (i.e. production environment) with the ASPSP as at the 1st of the reported month. For the avoidance of doubt OBIE is looking to receive the number of discrete AISPs (grouped by TPP ID i.e. OrgName) and not the number of discrete SSAs (i.e. SoftwareId) onboarded with the ASPSP Conditions 1.Total AISPs Registered (at 1st of month) = Cumulative Monthly number of AISPs (as reported on previous reported month)
OBIEMIReportData/TPPVolumesOBIE/AISPAdditions AISPAdditions 1 1 Number AISP Additions (9.2) This is the number of AISPs that have been on-boarded into live environment (i.e. production environment) during the reported month For the avoidance of doubt OBIE is looking to receive the number of discrete AISPs (grouped by TPP ID i.e. OrgName) and not the number of discrete SSAs (i.e. SoftwareId) onboarded with the ASPSP. However, if a TPP is registering as both an AISP and a PISP, it should be counted separately in each of the AISP and PISP entries
OBIEMIReportData/TPPVolumesOBIE/AISPDeregistrations AISPDeregistrations 1 1 Number AISP Deregistrations (9.3) This is the number of AISPs, that have been deregistered with the ASPSP during the reported month. For the avoidance of doubt OBIE is looking to receive the number of discrete AISPs (grouped by TPP ID i.e. OrgName) and not the number of discrete SSAs (i.e. SoftwareId) onboarded with the ASPSP. Conditions 1.AISP Deregistrations <= Total AISPs Registered (at 1st of month)
OBIEMIReportData/TPPVolumesOBIE/CumulativeMonthlyNumberAISPs CumulativeMonthlyNumberAISPs 1 1 Number Cumulative Monthly number of AISPs (9.4) This is the cumulative total number of AISP’s, that have been already been on-boarded into the live environment (i.e. production environment) with the ASPSP as at the end of the reported month. For the avoidance of doubt OBIE is looking to receive the number of discrete AISPs (grouped by TPP ID) and not the number of discrete SSAs onboarded with the ASPSP. Conditions 1.Cumulative Monthly number of AISPs >= Total AISPs Registered (at 1st of month) 2. Cumulative Monthly number of AISPs = Total AISPs Registered (at 1st of month) + AISP Additions + AISP Deregistrations
OBIEMIReportData/TPPVolumesOBIE/TotalPISPsRegistered TotalPISPsRegistered 1 1 Number Total PISPs Registered (at 1st of month) (9.5) This is the cumulative total number of PISP’s, that have been already been on-boarded into the live environment (i.e. production environment) with the ASPSP as at the 1st of the reported month. For the avoidance of doubt OBIE is looking to receive the number of discrete PISPs (grouped by TPP ID i.e. OrgName) and not the number of discrete SSAs (i.e. SoftwareId) onboarded with the ASPSP. However, if a TPP is registering as both an AISP and a PISP, it should be counted separately in each of the AISP and PISP entries. Conditions 1.Total PISPs Registered (at 1st of month) = Cumulative Monthly number of PISPs (as reported on previous reported month)
OBIEMIReportData/TPPVolumesOBIE/PISPAdditions PISPAdditions 1 1 Number PISP Additions (9.6) This is the number of PISPs that have been on-boarded into live environment (i.e. production environment) during the reported month For the avoidance of doubt OBIE is looking to receive the number of discrete PISPs (grouped by TPP ID i.e. OrgName) and not the number of discrete SSAs (i.e. SoftwareId) onboarded with the ASPSP. However, if a TPP is registering as both an AISP and a PISP, it should be counted separately in each of the AISP and PISP entries
OBIEMIReportData/TPPVolumesOBIE/PISPDeregistrations PISPDeregistrations 1 1 Number PISP Deregistrations (9.7) This is the number of PISPs, that have been deregistered with the ASPSP during the reported month. For the avoidance of doubt OBIE is looking to receive the number of discrete PISPs (grouped by TPP ID) and not the number of discrete SSAs onboarded with the ASPSP. Conditions 1.PISP Deregistrations <= Total PISPs Registered (at 1st of month)
OBIEMIReportData/TPPVolumesOBIE/CumulativeMonthlyNumberPISPs CumulativeMonthlyNumberPISPs 1 1 Number Cumulative Monthly number of PISPs (9.8) This is the cumulative total number of PISP’s, that have been already been on-boarded into the live environment (i.e. production environment) with the ASPSP as at the end of the reported month. For the avoidance of doubt OBIE is looking to receive the number of discrete PISPs (grouped by TPP ID i.e. OrgName) and not the number of discrete SSAs (i.e. SoftwareId) onboarded with the ASPSP. Conditions 1.Cumulative Monthly number of PISPs >= Total PISPs Registered (at 1st of month) 2. Cumulative Monthly number of PISPs = Total PISPs Registered (at 1st of month) + PISP Additions + PISP Deregistrations
OBIEMIReportData/TPPVolumesOBIE/TotalCBPIIsRegistered TotalCBPIIsRegistered 0 1 Number Total CBPIIs Registered (at 1st of month) This is the cumulative total number of CBPIIs, that have been already been on-boarded into the live environment (i.e. production environment) with the ASPSP as at the 1st of the reported month. For the avoidance of doubt OBIE is looking to receive the number of discrete CBPIIs (grouped by TPP ID i.e. OrgName) and not the number of discrete SSAs (i.e. SoftwareId) onboarded with the ASPSP. However, if a TPP is registering as a CBPII, AISP and/or a PISP, it should be counted separately in each of the CBPII, AISP and PISP entries. Conditions 1.Total CBPIIs Registered (at 1st of month) = Cumulative Monthly number of CBPIIs (as reported on previous reported month)
OBIEMIReportData/TPPVolumesOBIE/CBPIIAdditions CBPIIAdditions 0 1 Number This is the number of CBPIIs that have been on-boarded into live environment (i.e. production environment) during the reported month For the avoidance of doubt OBIE is looking to receive the number of discrete CBPIIs (grouped by TPP ID i.e. OrgName) and not the number of discrete SSAs (i.e. SoftwareId) onboarded with the ASPSP. However, if a TPP is registering as a CBPII, AISP and/or a PISP, it should be counted separately in each of the CBPII, AISP and PISP entries.
OBIEMIReportData/TPPVolumesOBIE/CBPIIDeregistrations CBPIIDeregistrations 0 1 Number This is the number of CBPIIs, that have been deregistered with the ASPSP during the reported month. For the avoidance of doubt OBIE is looking to receive the number of discrete CBPIIs (grouped by TPP ID i.e. OrgName) and not the number of discrete SSAs (i.e. SoftwareId) onboarded with the ASPSP. Conditions 1.CBPII Deregistrations <= Total CBPIIs Registered (at 1st of month)
OBIEMIReportData/TPPVolumesOBIE/CumulativeMonthlyNumberCBPIIs CumulativeMonthlyNumberCBPIIs 0 1 Number This is the cumulative total number of CBPIIs, that have been already been on-boarded into the live environment (i.e. production environment) with the ASPSP as at the end of the reported month. For the avoidance of doubt OBIE is looking to receive the number of discrete CBPIIs (grouped by TPP ID i.e. OrgName) and not the number of discrete SSAs (i.e. SoftwareId) onboarded with the ASPSP. Conditions 1.Cumulative Monthly number of CBPIIs >= Total CBPIIs Registered (at 1st of month) 2. Cumulative Monthly number of CBPIIs= Total CBPIIs Registered (at 1st of month) + CBPII Additions + CBPII Deregistrations
OBIEMIReportData/TPPVolumesOBIE/Version Version 1 1 OBAPIMajorVersionType1Code The OBIE Standards version of the endpoint implementation by the ASPSP, aggregated at the level of major or minor release, as defined in item#10 of Section 2 key usage instructions.
OBIEMIReportData/TPPVolumesOBIE/Version/:code:V3.0 V3.0 V3.0
OBIEMIReportData/TPPVolumesOBIE/Version/:code:V3.1 V3.1 V3.1
OBIEMIReportData/TPPVolumesOBIE/Version/:code:V3.2 V3.2 V3.2
OBIEMIReportData/TPPVolumesOBIE/Version/:code:V3.3 V3.3 V3.3
OBIEMIReportData/TPPVolumesOBIE/Version/:code:V4.0 V4.0 V4.0
OBIEMIReportData/TPPVolumesOBIE/Version/:code:V4.1 V4.1 V4.1
OBIEMIReportData/TPPVolumesOBIE/Version/:code:VOTH Other Other version
OBIEMIReportData/TPPVolumesOBIE/OtherMIBrand OtherMIBrand 0 1 OBMIOtherBrandType1
OBIEMIReportData/TPPVolumesOBIE/OtherMIBrand/MIBrandId MIBrandId 1 1 OB_CodeMnemonic Other Brand Id which is not available in the published
OBIEMIReportData/TPPVolumesOBIE/OtherMIBrand/BrandName BrandName 1 1 Max500Text 1 500 Long name associated with the code
OBIEMIReportData/TPPVolumesOBIE/OtherMIBrand/Description Description 0 1 Max350Text 1 350 Description to describe the purpose of the code
OBIEMIReportData/TPPVolumesOBIE/OtherVersion OtherVersion 0 1 OBMIOtherVersionType1
OBIEMIReportData/TPPVolumesOBIE/OtherVersion/Version Version 1 1 OB_CodeMnemonic Other Version which is not available in published list
OBIEMIReportData/TPPVolumesOBIE/OtherVersion/VersionName VersionName 1 1 Max70Text 1 70 Long name associated with the code
OBIEMIReportData/TPPVolumesOBIE/OtherVersion/Description Description 0 1 Max350Text 1 350 Description to describe the purpose of the code
OBIEMIReportData/DailyVolumesOBIE DailyVolumesOBIE 0 unbounded OBMIDailyVolumesReportData1
OBIEMIReportData/DailyVolumesOBIE/MIBrandId MIBrandId 1 1 OBMIBrands1Code Brand Name that an organisation uses to market its products or services to a consumer.
OBIEMIReportData/DailyVolumesOBIE/MIBrandId/:code:0001 AIBFirstTrustBank AIB First Trust Bank
OBIEMIReportData/DailyVolumesOBIE/MIBrandId/:code:0002 AIBGroupUK AIB Group (UK) p.l.c.
OBIEMIReportData/DailyVolumesOBIE/MIBrandId/:code:0003 BankOfIrelandUK Bank of Ireland UK
OBIEMIReportData/DailyVolumesOBIE/MIBrandId/:code:0004 BankOfScotland Bank of Scotland
OBIEMIReportData/DailyVolumesOBIE/MIBrandId/:code:0005 Barclays Barclays
OBIEMIReportData/DailyVolumesOBIE/MIBrandId/:code:0006 DanskeBank Danske Bank
OBIEMIReportData/DailyVolumesOBIE/MIBrandId/:code:0007 FirstDirect First Direct
OBIEMIReportData/DailyVolumesOBIE/MIBrandId/:code:0008 Halifax Halifax
OBIEMIReportData/DailyVolumesOBIE/MIBrandId/:code:0009 HSBC HSBC
OBIEMIReportData/DailyVolumesOBIE/MIBrandId/:code:0010 Lloyds Lloyds
OBIEMIReportData/DailyVolumesOBIE/MIBrandId/:code:0011 MAndSBank M&S Bank
OBIEMIReportData/DailyVolumesOBIE/MIBrandId/:code:0012 NationwideBuildingSociety Nationwide Building Society
OBIEMIReportData/DailyVolumesOBIE/MIBrandId/:code:0013 Natwest Natwest
OBIEMIReportData/DailyVolumesOBIE/MIBrandId/:code:0014 RBS RBS
OBIEMIReportData/DailyVolumesOBIE/MIBrandId/:code:0015 Santander UK plc Santander UK plc
OBIEMIReportData/DailyVolumesOBIE/MIBrandId/:code:0016 UBN UBN
OBIEMIReportData/DailyVolumesOBIE/MIBrandId/:code:9999 OTHERBrand Other Brand
OBIEMIReportData/DailyVolumesOBIE/ReportDate ReportDate 1 1 ISODate A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
OBIEMIReportData/DailyVolumesOBIE/EndPoint EndPoint 1 1 OBMIEndPoint1Code Endpoint used for MI reporting. Note: ASPSPs must only report endpoints that have gone live in their systems.
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0000 OIDC OIDC endpoints for token IDs
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0001 POSTAccountAccessConsents POST /account-access-consents
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0002 POSTAccountAccessConsentsConsentId GET /account-access-consents/{ConsentId}
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0003 DELETEAccountAccessConsentsConsentId DELETE /account-access-consents/{ConsentId}
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0004 GETAccounts GET /accounts
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0005 GETAccountsAccountId GET /accounts/{AccountId}
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0006 GETAccountsAccountIdBalances GET /accounts/{AccountId}/balances
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0007 GETBalances GET /balances
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0008 GETAccountsAccountIdTransactions GET /accounts/{AccountId}/transactions
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0009 GETTransactions GET /transactions
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0010 GETAccountsAccountIdBeneficiaries GET /accounts/{AccountId}/beneficiaries
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0011 GETBeneficiaries GET /beneficiaries
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0012 GETAccountsAccountIdDirectDebits GET /accounts/{AccountId}/direct-debits
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0013 GETDirectDebits GET /direct-debits
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0014 GETAccountsAccountIdStandingOrders GET /accounts/{AccountId}/standing-orders
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0015 GETStandingOrders GET /standing-orders
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0016 GETAccountsAccountIdProduct GET /accounts/{AccountId}/product
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0017 GETProducts GET /products
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0018 GETAccountsAccountIdoffers GET /accounts/{AccountId}/offers
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0019 GETOffers GET /offers
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0020 GETAccountsAccountIdParty GET /accounts/{AccountId}/party
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0021 GETParty GET /party
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0022 GETAccountsAccountIdScheduledPayments GET /accounts/{AccountId}/scheduled-payments
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0023 GETScheduledPayments GET /scheduled-payments
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0024 GETAccountsAccountIdStatements GET /accounts/{AccountId}/statements
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0025 GETAccountsAccountIdStatementsStatementId GET /accounts/{AccountId}/statements/{StatementId}
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0026 GETAccountsAccountIdStatementsStatementIdFile GET /accounts/{AccountId}/statements/{StatementId}/file
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0027 GETAccountsAccountIdStatementsStatementIdTransactions GET /accounts/{AccountId}/statements/{StatementId}/transactions
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0028 GETStatements GET /statements
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0029 POSTDomesticPaymentConsents POST /domestic-payment-consents
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0030 GETDomesticPaymentConsentsConsentId GET /domestic-payment-consents/{ConsentId}
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0031 POSTDomesticPayments POST /domestic-payments
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0032 GETDomesticPaymentsDomesticPaymentId GET /domestic-payments/{DomesticPaymentId}
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0033 POSTDomesticScheduledPaymentConsents POST /domestic-scheduled-payment-consents
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0034 GETDomesticScheduledPaymentConsentsConsentId GET /domestic-scheduled-payment-consents/{ConsentId}
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0035 POSTDomesticScheduledPayments POST /domestic-scheduled-payments
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0036 GETDomesticScheduledPaymentsDomesticScheduledPaymentId GET /domestic-scheduled-payments/{DomesticScheduledPaymentId}
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0037 POSTDomesticStandingOrderConsents POST /domestic-standing-order-consents
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0038 GETDomesticStandingOrderConsentsConsentId GET /domestic-standing-order-consents/{ConsentId}
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0039 POSTDomesticStandingOrders POST /domestic-standing-orders
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0040 GETDomesticStandingOrdersDomesticStandingOrderId GET /domestic-standing-orders/{DomesticStandingOrderId}
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0041 POSTInternationalPaymentConsents POST /international-payment-consents
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0042 GETInternationalPaymentConsentsConsentId GET /international-payment-consents/{ConsentId}
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0043 POSTInternationalPayments POST /international-payments
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0044 GETInternationalPaymentsInternationalPaymentId GET /international-payments/{InternationalPaymentId}
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0045 POSTInternationalScheduledPaymentConsents POST /international-scheduled-payment-consents
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0046 GETInternationalScheduledPaymentConsentsConsentId GET /international-scheduled-payment-consents/{ConsentId}
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0047 POSTInternationalScheduledPayments POST /international-scheduled-payments
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0048 GETInternationalScheduledPaymentsInternationalScheduledPaymentId GET /international-scheduled-payments/{InternationalScheduledPaymentId}
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0049 POSTInternationalStandingOrderConsents POST /international-standing-order-consents
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0050 GETInternationalStandingOrderConsentsConsentId GET /international-standing-order-consents/{ConsentId}
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0051 POSTInternationalStandingOrders POST /international-standing-orders
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0052 GETInternationalStandingOrdersInternationalStandingOrderPaymentId GET /international-standing-orders/{InternationalStandingOrderPaymentId}
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0053 POSTFilePaymentConsents POST /file-payment-consents
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0054 GETFilePaymentConsentsConsentId GET /file-payment-consents/{ConsentId}
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0055 POSTFilePaymentConsentsConsentIdFile POST /file-payment-consents/{ConsentId}/file
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0056 GETFilePaymentConsentsConsentIdFile GET /file-payment-consents/{ConsentId}/file
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0057 POSTFilePayments POST /file-payments
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0058 GETFilePaymentsFilePaymentId GET /file-payments/{FilePaymentId}
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0059 GETFilePaymentsFilePaymentIdReportFile GET /file-payments/{FilePaymentId}/report-file
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0060 POSTFundsConfirmationConsents POST /funds-confirmation-consents
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0061 GETFundsConfirmationConsentsConsentId GET /funds-confirmation-consents/{ConsentId}
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0062 DELETEFundsConfirmationConsentsConsentId DELETE /funds-confirmation-consents/{ConsentId}
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0063 POSTFundsConfirmations POST /funds-confirmations
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0064 POSTPayments POST /payments
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0065 GETPaymentsPaymentId GET /payments/{PaymentId}
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0066 POSTPaymentSubmissions POST /payment-submissions
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0067 GETPaymentSubmissionsPaymentSubmissionId GET /payment-submissions/{PaymentSubmissionId}
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0068 POSTAccountRequests POST /account-requests
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0069 GETAccountRequestsAccountRequestId GET /account-requests/{AccountRequestId}
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0070 DELETEAccountRequestsAccountRequestId DELETE /account-requests/{AccountRequestId}
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0071 POSTcallback-urls POST /callback-urls
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0072 GETcallback-urls GET /callback-urls
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0073 PUTcallback-urlsCallbackUrlId PUT /callback-urls/{CallbackUrlId}
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0074 DELETEcallback-urlsCallbackUrlId DELETE /callback-urls/{CallbackUrlId}
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0075 GET domestic-payment-consentsConsentIdfunds-confirmation GET /domestic-payment-consents/{ConsentId}/funds-confirmation
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0076 GETinternational-payment-consentsConsentIdfunds-confirmation GET /international-payment-consents/{ConsentId}/funds-confirmation
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0077 GETinternational-sch-payment-consentsConsentIdfunds-confirmation GET /international-scheduled-payment-consents/{ConsentId}/funds-confirmation
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0078 GETaccountsAccountIdparties GET /accounts/{AccountId}/parties
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0079 GETdomestic-paymentsDomesticPaymentIdpayment-details GET /domestic-payments/{DomesticPaymentId}/payment-details
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0080 GETdomestic-scheduled-paymentsDomesticSPaymentIdpayment-details GET /domestic-scheduled-payments/{DomesticScheduledPaymentId}/payment-details
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0081 GETdomestic-standing-ordersDomesticSOrderIdpayment-details GET /domestic-standing-orders/{DomesticStandingOrderId}/payment-details
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0082 GETinternational-paymentsInternationalPaymentIdpayment-details GET /international-payments/{InternationalPaymentId}/payment-details
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0083 GETinternational-scheduled-paymentsInternationalSPIdpayment-details GET /international-scheduled-payments/{InternationalScheduledPaymentId}/payment-details
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0084 GETinternational-standing-ordersInternationalSOrderPIdpayment-details GET /international-standing-orders/{InternationalStandingOrderPaymentId}/payment-details
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0085 GETfile-paymentsFilePaymentIdpayment-details GET /file-payments/{FilePaymentId}/payment-details
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0086 POSTevent-subscriptions POST /event-subscriptions
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0087 GETevent-subscriptions GET /event-subscriptions
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0088 PUTevent-subscriptionsEventSubscriptionId PUT /event-subscriptions/{EventSubscriptionId}
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0089 DELETEevent-subscriptionsEventSubscriptionId DELETE /event-subscriptions/{EventSubscriptionId}
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0090 POSTevent-notifications POST /event-notifications
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:0091 POSTevents POST /events
OBIEMIReportData/DailyVolumesOBIE/EndPoint/:code:9999 OTHEREndoint Other End point
OBIEMIReportData/DailyVolumesOBIE/PCAAPICalls PCAAPICalls 0 1 Number PCA API Calls (9.11) This is the number of API endpoint calls for each API endpoint that have been send to the ASPSP Brand for AIS account access, PIS payment initiations or CoF access from PCA accounts. Conditions 1.Total number of API calls for each endpoint >= PCA API Calls
OBIEMIReportData/DailyVolumesOBIE/BCAAPICalls BCAAPICalls 0 1 Max20AlphaNumericText 1 20 [a-zA-Z0-9]{1,20} BCA API Calls (9.11) This is the number of API endpoint calls for each API endpoint that have been send to the ASPSP Brand for AIS account access, PIS payment initiations or CoF access from BCA accounts. Note: ASPSPs that do not support BCA accounts will be reporting in column E PCA only. However they are also required to fill in the BCA F column with NULL. The reporting of this item is optional. If BCA accounts not supported, then value should be NULL Conditions 1.Total number of API calls for each endpoint >= BCA API Calls 2. Total number of API calls for each endpoint >= PCA API Calls + BCA API Calls
OBIEMIReportData/DailyVolumesOBIE/SuccessfulAPICalls SuccessfulAPICalls 1 1 Number Successful API Calls (200, 201 or 204 codes) (10.1/10.2/10.3/10.4) This is the total number of successful endpoint calls for each endpoint that have been received successfully by the ASPSP brand and generated a HTPP Status Code of 200, 201 or 204 depending on the HTTP method of the endpoints.
OBIEMIReportData/DailyVolumesOBIE/FailedAPICallsBusinessReasons FailedAPICallsBusinessReasons 1 1 Number Failed API Calls Business Reasons (4xx codes) (10.5) This is the total number of failed endpoint calls for each endpoint that have been received by the ASPSP brand and failed due to business rules reasons generating an HTPP Status Code of 4xx).
OBIEMIReportData/DailyVolumesOBIE/FailedAPICallsTechnicalReasons FailedAPICallsTechnicalReasons 1 1 Number Failed API Calls Technical Reasons (5xx codes) (10.6) This is the total number of failed endpoint calls for each endpoint that have been received by the ASPSP brand and failed due to technical reasons (generating an HTPP Status Code of 500 Internal Server Error). Conditions 1.Total number of API calls for each endpoint = Successful API Calls + Failed API Calls Business Reasons (4xx codes) + Failed API Calls Technical Reasons (5xx codes) 2.Total number of API calls for each endpoint >= Successful API Calls 3.Total number of API calls for each endpoint >= Failed API Calls Business Reasons (4xx codes) 4.Total number of API calls for each endpoint >= Failed API Calls Technical Reasons (5xx codes)
OBIEMIReportData/DailyVolumesOBIE/APICallsRejectedStatus APICallsRejectedStatus 1 1 Number API Calls Rejected Status (10.7/10.8) This is the total number of rejected endpoint calls that have been rejected for each endpoint. Note: The item refers to the number of endpoint calls which resulted in: a. payments consent resources in rejected state due to authorisation failing or consent authorisation being rejected b. payment resources in rejected state due to payment initiation being rejected as part of proceeding checks such as technical validation and customer profile c. account access consent resources in rejected state due to authorisation failing or consent authorisation being rejected d. funds-confirmation-consent resources in rejected state due to authorisation failing or consent authorisation not agreed. Conditions 1.Total number of API calls for each endpoint >= API Calls Rejected Status 2.Successful API Calls >= API Calls Rejected Status
OBIEMIReportData/DailyVolumesOBIE/TPPsCallingAPIs TPPsCallingAPIs 1 1 Number TPPs Calling APIs (10.9) This is the number of individual TPPs calling each API end-point. For the avoidance of doubt OBIE is looking to receive the number of discrete TPPs (grouped by TPP ID) and not the number of discrete SSAs onboarded with the ASPSP making the endpoint calls.
OBIEMIReportData/DailyVolumesOBIE/APICallsNotAuthorisedPSU APICallsNotAuthorisedPSU 1 1 Max20AlphaNumericText 1 20 [a-zA-Z0-9]{1,20} API Calls Not Authorised by PSU (10.10) This is the total number of successful endpoint calls that have been presented to the PSU for authorisation and the PSU have not authorised. Note: The item refers to the number of endpoint calls which resulted in: a. payments consent resources in AwaitingAuthorisation state that have moved to Rejected state due to PSU not authorising the consent. b. account access consent resources in AwaitingAuthorisation state that have moved to Rejected state due to due to PSU not authorising the consent. c. funds-confirmation-consent resources in AwaitingAuthorisation state that have moved to Rejected state due to due to PSU not authorising the consent. NULL value must be reported for any other endpoint. If HTPP method of endpoint is not POST, then value should be NULL Conditions 1.Total number of API calls for each endpoint >= API Calls Not Authorised by PSU 2.Successful API Calls >= API Calls Not Authorised by PSU 3. API Calls Rejected Status >= API Calls Not Authorised by PSU 4. API Calls Rejected due to validation = API Calls Rejected Status - API Calls Not Authorised by PSU 5. API Calls Requiring PSU Authorisation = Successful API Calls - API Calls Rejected due to validation 6. API Calls Authorised by PSUs = API Calls Requiring PSU Authorisation - API Calls Not Authorised by PSU
OBIEMIReportData/DailyVolumesOBIE/APICallsAuthorisedNotConsumed APICallsAuthorisedNotConsumed 1 1 Max20AlphaNumericText 1 20 [a-zA-Z0-9]{1,20} API Calls Authorised but Not Consumed (10.11) This is the total number of successful endpoint calls that have been authorised by PSUs but the payment order has not been submitted by the PISPs. Note: The item refers to the number of endpoint calls which resulted in: a. payments consent resources in Authorised state that have not moved to Consumed state due to PISP not making a call to the payment order endpoint call. NULL value must be reported for any other endpoint. If endpoint is not a payment consent POST, then value should be NULL. Conditions 1. API Calls Authorised but Not Consumed <= API Calls Authorised by PSUs
OBIEMIReportData/DailyVolumesOBIE/MultiAuthAPICallsSuccessful MultiAuthAPICallsSuccessful 1 1 Max20AlphaNumericText 1 20 [a-zA-Z0-9]{1,20} Multi Auth API Calls Successful (10.12) This is the number of PIS endpoint calls that required multiple authorisations and have been fully authorised successfully. This only applies to payment initiation. In the context of this template reporting, for multi-auth payments, a successful payment initiation occurs once a complete payment order has been submitted to the ASPSP (i.e. once all PSU authorisers have authorised the payment at the ASPSP). Note: Volume of successful and failed payment initiations through PISP for payment orders requiring multi-authorisations. Note: For the avoidance of doubt, this item refers to number of endpoint calls which resulted in the following conditions: a. the payments consent resource in AwaitingAuthorisation state moved to Authorised state due to first authoriser PSU authorising the consent. b. the multi authorisation object status moved from AwatingFurtherAuthorisation to Authorised due to all authoriser PSUs authorising the payment order. If endpoint is not a PIS endpoint, then value should be NULL. Conditions 1. Multi Auth API Calls Successful <= API Calls Authorised by PSUs
OBIEMIReportData/DailyVolumesOBIE/MultiAuthAPICallsFailed MultiAuthAPICallsFailed 1 1 Max20AlphaNumericText 1 20 [a-zA-Z0-9]{1,20} Multi Auth API Calls Failed (10.12) This is the number of PIS endpoint calls that required multiple authorisations and have failed to be fully authorised . This only applies to payment initiation. In the context of this template reporting, for multi-auth payments, a failed payment initiation occurs in circumstances where, after the first PSU has initiated a draft payment order using a PISP, the payment order is subsequently never completed due to other authorisers not authorising the payment within the timeframes (if any) of the multi authorisation process at the ASPSP. Note: For the avoidance of doubt, this item refers to number of endpoint calls which resulted in the following conditions: a. the payments consent resource in AwaitingAuthorisation state moved to Authorised state due to first authoriser PSU authorising the consent. b. the multi authorisation object status moved from AwatingFurtherAuthorisation to Rejected due to one of the authoriser PSUs not authorising the payment order or any other reason for rejection within the ASPSP multi auth process. If endpoint is not a PIS endpoint, then value should be NULL. Conditions 1. Multi Auth API Calls Successful <= API Calls Authorised by PSUs
OBIEMIReportData/DailyVolumesOBIE/Version Version 1 1 OBAPIMajorVersionType1Code The OBIE Standards version of the endpoint implementation by the ASPSP, aggregated at the level of major or minor release, as defined in item#10 of Section 2 key usage instructions.
OBIEMIReportData/DailyVolumesOBIE/Version/:code:V3.0 V3.0 V3.0
OBIEMIReportData/DailyVolumesOBIE/Version/:code:V3.1 V3.1 V3.1
OBIEMIReportData/DailyVolumesOBIE/Version/:code:V3.2 V3.2 V3.2
OBIEMIReportData/DailyVolumesOBIE/Version/:code:V3.3 V3.3 V3.3
OBIEMIReportData/DailyVolumesOBIE/Version/:code:V4.0 V4.0 V4.0
OBIEMIReportData/DailyVolumesOBIE/Version/:code:V4.1 V4.1 V4.1
OBIEMIReportData/DailyVolumesOBIE/Version/:code:VOTH Other Other version
OBIEMIReportData/DailyVolumesOBIE/OtherMIBrand OtherMIBrand 0 1 OBMIOtherBrandType1
OBIEMIReportData/DailyVolumesOBIE/OtherMIBrand/MIBrandId MIBrandId 1 1 OB_CodeMnemonic Other Brand Id which is not available in the published
OBIEMIReportData/DailyVolumesOBIE/OtherMIBrand/BrandName BrandName 1 1 Max500Text 1 500 Long name associated with the code
OBIEMIReportData/DailyVolumesOBIE/OtherMIBrand/Description Description 0 1 Max350Text 1 350 Description to describe the purpose of the code
OBIEMIReportData/DailyVolumesOBIE/OtherEndpoint OtherEndpoint 0 1 OBMIOtherEndpointType1
OBIEMIReportData/DailyVolumesOBIE/OtherEndpoint/EndpointId EndpointId 1 1 OB_CodeMnemonic Other Endpint Id which is not available in the published
OBIEMIReportData/DailyVolumesOBIE/OtherEndpoint/Endpoint Endpoint 1 1 Max500Text 1 500 Long name associated with the code
OBIEMIReportData/DailyVolumesOBIE/OtherEndpoint/Description Description 0 1 Max350Text 1 350 Description to describe the purpose of the code
OBIEMIReportData/DailyVolumesOBIE/OtherVersion OtherVersion 0 1 OBMIOtherVersionType1
OBIEMIReportData/DailyVolumesOBIE/OtherVersion/Version Version 1 1 OB_CodeMnemonic Other Version which is not available in published list
OBIEMIReportData/DailyVolumesOBIE/OtherVersion/VersionName VersionName 1 1 Max70Text 1 70 Long name associated with the code
OBIEMIReportData/DailyVolumesOBIE/OtherVersion/Description Description 0 1 Max350Text 1 350 Description to describe the purpose of the code
OBIEMIReportData/OptionalEndpointsMetrics OptionalEndpointsMetrics 0 1 OBMIOptionalEndpointsMetricsReportData1
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus PaymentStatus 0 1 OBMIPaymentStatusReportData1 Optional Endpoints Metrics - Payment Status
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/MIBrandId MIBrandId 1 1 OBMIBrands1Code Brand Name that an organisation uses to market its products or services to a consumer.
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/MIBrandId/:code:0001 AIBFirstTrustBank AIB First Trust Bank
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/MIBrandId/:code:0002 AIBGroupUK AIB Group (UK) p.l.c.
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/MIBrandId/:code:0003 BankOfIrelandUK Bank of Ireland UK
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/MIBrandId/:code:0004 BankOfScotland Bank of Scotland
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/MIBrandId/:code:0005 Barclays Barclays
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/MIBrandId/:code:0006 DanskeBank Danske Bank
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/MIBrandId/:code:0007 FirstDirect First Direct
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/MIBrandId/:code:0008 Halifax Halifax
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/MIBrandId/:code:0009 HSBC HSBC
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/MIBrandId/:code:0010 Lloyds Lloyds
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/MIBrandId/:code:0011 MAndSBank M&S Bank
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/MIBrandId/:code:0012 NationwideBuildingSociety Nationwide Building Society
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/MIBrandId/:code:0013 Natwest Natwest
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/MIBrandId/:code:0014 RBS RBS
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/MIBrandId/:code:0015 Santander UK plc Santander UK plc
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/MIBrandId/:code:0016 UBN UBN
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/MIBrandId/:code:9999 OTHERBrand Other Brand
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/ReportMonth ReportMonth 1 1 Max6Text 1 6 ^(Jan Feb Mar Apr
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/NumberOfPISPs NumberOfPISPs 1 1 Number Number of PISPs This is the number of individual PISPs initiating payments and checking their payment status. For the avoidance of doubt OBIE is looking to receive the number of discrete PISPs (grouped by TPP ID) and not the number of discrete SSAs onboarded with the ASPSP making the endpoint calls
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/PaymentStatus PaymentStatus 1 1 OBTransactionIndividualStatus1Code This is the status of the payment resource as returned by the response to the payment initiation endpoint call or the subsequent call to the GET endpoint. Note: This status is the terminal status of the resource not a transitional one. Allowed enumeration values: Pending Rejected AcceptedSettlementInProcess AcceptedSettlementCompleted AcceptedCreditSettlementCompleted
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/PaymentStatus/:code:TSCC AcceptedCreditSettlementCompleted Settlement on the creditors account has been completed.
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/PaymentStatus/:code:TSPN Pending Payment initiation or individual transaction included in the payment initiation is pending. Further checks and status update will be performed.
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/PaymentStatus/:code:TSRJ Rejected Payment initiation or individual transaction included in the payment initiation has been rejected.
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/PaymentStatus/:code:TSSC AcceptedSettlementCompleted Settlement on the debtors account has been completed.
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/PaymentStatus/:code:TSSP AcceptedSettlementInProcess All preceding checks such as technical validation and customer profile were successful and therefore the payment initiation has been accepted for execution.
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/VolumeOfPayments VolumeOfPayments 1 1 Max20AlphaNumericText 1 20 [a-zA-Z0-9]{1,20} This is the total number of payments (payment resources) that have been checked for their status and returned a terminal status as defined in the Payment Status column.
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/OtherMIBrand OtherMIBrand 0 1 OBMIOtherBrandType1
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/OtherMIBrand/MIBrandId MIBrandId 1 1 OB_CodeMnemonic Other Brand Id which is not available in the published
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/OtherMIBrand/BrandName BrandName 1 1 Max500Text 1 500 Long name associated with the code
OBIEMIReportData/OptionalEndpointsMetrics/PaymentStatus/OtherMIBrand/Description Description 0 1 Max350Text 1 350 Description to describe the purpose of the code
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions PaymentSCAExemptions 0 1 OBMIPaymentSCAExemptionsReportData1 Optional Endpoints Metrics - Payment SCA Exemptions
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/MIBrandId MIBrandId 1 1 OBMIBrands1Code Brand Name that an organisation uses to market its products or services to a consumer.
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/MIBrandId/:code:0001 AIBFirstTrustBank AIB First Trust Bank
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/MIBrandId/:code:0002 AIBGroupUK AIB Group (UK) p.l.c.
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/MIBrandId/:code:0003 BankOfIrelandUK Bank of Ireland UK
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/MIBrandId/:code:0004 BankOfScotland Bank of Scotland
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/MIBrandId/:code:0005 Barclays Barclays
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/MIBrandId/:code:0006 DanskeBank Danske Bank
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/MIBrandId/:code:0007 FirstDirect First Direct
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/MIBrandId/:code:0008 Halifax Halifax
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/MIBrandId/:code:0009 HSBC HSBC
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/MIBrandId/:code:0010 Lloyds Lloyds
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/MIBrandId/:code:0011 MAndSBank M&S Bank
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/MIBrandId/:code:0012 NationwideBuildingSociety Nationwide Building Society
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/MIBrandId/:code:0013 Natwest Natwest
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/MIBrandId/:code:0014 RBS RBS
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/MIBrandId/:code:0015 Santander UK plc Santander UK plc
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/MIBrandId/:code:0016 UBN UBN
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/MIBrandId/:code:9999 OTHERBrand Other Brand
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/ReportMonth ReportMonth 1 1 Max6Text 1 6 ^(Jan Feb Mar Apr
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/NumberOfPISPs NumberOfPISPs 1 1 Number This is the number of individual PISPs initiating payments and checking their payment status. For the avoidance of doubt OBIE is looking to receive the number of discrete PISPs (grouped by TPP ID) and not the number of discrete SSAs onboarded with the ASPSP making the endpoint calls
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/PaymentExemptionRequested PaymentExemptionRequested 1 1 OBExternalSCAExemptionType1Code This is the status of the payment resource as returned by the response to the payment initiation endpoint call or the subsequent call to the GET endpoint. Example of allowed enumeration values: BillPayment ContactlessTravel EcommerceGoods EcommerceServices Kiosk Parking PartyToParty
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/PaymentExemptionRequested/:code:SCBP BillPayment Bill Payment
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/PaymentExemptionRequested/:code:SCCT ContactlessTravel Contactless Travel
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/PaymentExemptionRequested/:code:SCEG EcommerceGoods Ecommerce Goods
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/PaymentExemptionRequested/:code:SCES EcommerceServices Ecommerce Services
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/PaymentExemptionRequested/:code:SCKK Kiosk Kiosk
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/PaymentExemptionRequested/:code:SCPG Parking Parking
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/PaymentExemptionRequested/:code:SCPP PartyToParty Party To Party
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/VolumeRequestedSCAExemption VolumeRequestedSCAExemption 1 1 Max20AlphaNumericText 1 20 [a-zA-Z0-9]{1,20} Volume of Payments requested SCA exemption This is the total number of payment initiation requests (payment consent endpoints) that have requested an SCA exemption by the PISP to the ASPSP, as per the SCA exemption stated in the Payment Exemption Requested column.
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/VolumeGrantedSCAExemption VolumeGrantedSCAExemption 1 1 Max20AlphaNumericText 1 20 [a-zA-Z0-9]{1,20} Volume of Payments granted SCA exemption This is the total number of payment initiation requests (payment consent endpoints) that have requested an SCA exemption by the PISP to the ASPSP, as per the SCA exemption stated in the Payment Exemption Requested column and the ASPSPs have granted the SCA exemption request and did not apply SCA.
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/OtherMIBrand OtherMIBrand 0 1 OBMIOtherBrandType1
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/OtherMIBrand/MIBrandId MIBrandId 1 1 OB_CodeMnemonic Other Brand Id which is not available in the published
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/OtherMIBrand/BrandName BrandName 1 1 Max500Text 1 500 Long name associated with the code
OBIEMIReportData/OptionalEndpointsMetrics/PaymentSCAExemptions/OtherMIBrand/Description Description 0 1 Max350Text 1 350 Description to describe the purpose of the code
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs RevocationNotificationsFromASPSPs 0 1 OBMIRevoNotfcnsASPSPsReportData1 Optional Endpoints Metrics - Revocation Notifications from ASPSPs
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/MIBrandId MIBrandId 1 1 OBMIBrands1Code Brand Name that an organisation uses to market its products or services to a consumer.
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/MIBrandId/:code:0001 AIBFirstTrustBank AIB First Trust Bank
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/MIBrandId/:code:0002 AIBGroupUK AIB Group (UK) p.l.c.
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/MIBrandId/:code:0003 BankOfIrelandUK Bank of Ireland UK
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/MIBrandId/:code:0004 BankOfScotland Bank of Scotland
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/MIBrandId/:code:0005 Barclays Barclays
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/MIBrandId/:code:0006 DanskeBank Danske Bank
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/MIBrandId/:code:0007 FirstDirect First Direct
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/MIBrandId/:code:0008 Halifax Halifax
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/MIBrandId/:code:0009 HSBC HSBC
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/MIBrandId/:code:0010 Lloyds Lloyds
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/MIBrandId/:code:0011 MAndSBank M&S Bank
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/MIBrandId/:code:0012 NationwideBuildingSociety Nationwide Building Society
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/MIBrandId/:code:0013 Natwest Natwest
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/MIBrandId/:code:0014 RBS RBS
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/MIBrandId/:code:0015 Santander UK plc Santander UK plc
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/MIBrandId/:code:0016 UBN UBN
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/MIBrandId/:code:9999 OTHERBrand Other Brand
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/ReportMonth ReportMonth 1 1 Max6Text 1 6 ^(Jan Feb Mar Apr
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/NumberOfAISPs NumberOfAISPs 1 1 Number This is the number of individual AISPs initiating payments and checking their payment status. For the avoidance of doubt OBIE is looking to receive the number of discrete AISPs (grouped by TPP ID) and not the number of discrete SSAs onboarded with the ASPSP making the endpoint calls
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/NotificationMethodUsed NotificationMethodUsed 1 1 OBMINotificationMethodUsedType1Code This is the various notification methods used by ASPSPs to notify AISPs that a PSU has revoked access via the Access Dashboard. Allowed enumeration values: Basic Polling Aggregated Polling Push Notifications Push Notifications Retries
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/NotificationMethodUsed/:code:NMAP AggregatedPolling Aggregated Polling
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/NotificationMethodUsed/:code:NMBP BasicPolling Basic Polling
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/NotificationMethodUsed/:code:NMPN PushNotifications Push Notifications
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/NotificationMethodUsed/:code:NMPR PushNotificationsRetries Push Notifications Retries
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/VolumeSuccessfulNotfcnsRevocation VolumeSuccessfulNotfcnsRevocation 1 1 Max20AlphaNumericText 1 20 [a-zA-Z0-9]{1,20} Volume of Successful Notification of Revocation This is the total number of successful notification endpoint calls for the notification of revocation of access by PSUs, using the notification method as stated in the Notification Method Used column.
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/VolumeNotificationRevocation VolumeNotificationRevocation 1 1 Max20AlphaNumericText 1 20 [a-zA-Z0-9]{1,20} Volume Notification of Revocation This is the total number of failed notification endpoint calls for the notification of revocation of access by PSUs, using the notification method as stated in the Notification Method Used column.
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/OtherMIBrand OtherMIBrand 0 1 OBMIOtherBrandType1
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/OtherMIBrand/MIBrandId MIBrandId 1 1 OB_CodeMnemonic Other Brand Id which is not available in the published
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/OtherMIBrand/BrandName BrandName 1 1 Max500Text 1 500 Long name associated with the code
OBIEMIReportData/OptionalEndpointsMetrics/RevocationNotificationsFromASPSPs/OtherMIBrand/Description Description 0 1 Max350Text 1 350 Description to describe the purpose of the code
OBIEMIReportData/OptionalEndpointsMetrics/AISCorporateAccountAccess AISCorporateAccountAccess 0 1 OBMIAISCorporateAccAccessReportData1 AIS Corporate Account Access
OBIEMIReportData/OptionalEndpointsMetrics/AISCorporateAccountAccess/MIBrandId MIBrandId 1 1 OBMIBrands1Code Brand Name that an organisation uses to market its products or services to a consumer.
OBIEMIReportData/OptionalEndpointsMetrics/AISCorporateAccountAccess/MIBrandId/:code:0001 AIBFirstTrustBank AIB First Trust Bank
OBIEMIReportData/OptionalEndpointsMetrics/AISCorporateAccountAccess/MIBrandId/:code:0002 AIBGroupUK AIB Group (UK) p.l.c.
OBIEMIReportData/OptionalEndpointsMetrics/AISCorporateAccountAccess/MIBrandId/:code:0003 BankOfIrelandUK Bank of Ireland UK
OBIEMIReportData/OptionalEndpointsMetrics/AISCorporateAccountAccess/MIBrandId/:code:0004 BankOfScotland Bank of Scotland
OBIEMIReportData/OptionalEndpointsMetrics/AISCorporateAccountAccess/MIBrandId/:code:0005 Barclays Barclays
OBIEMIReportData/OptionalEndpointsMetrics/AISCorporateAccountAccess/MIBrandId/:code:0006 DanskeBank Danske Bank
OBIEMIReportData/OptionalEndpointsMetrics/AISCorporateAccountAccess/MIBrandId/:code:0007 FirstDirect First Direct
OBIEMIReportData/OptionalEndpointsMetrics/AISCorporateAccountAccess/MIBrandId/:code:0008 Halifax Halifax
OBIEMIReportData/OptionalEndpointsMetrics/AISCorporateAccountAccess/MIBrandId/:code:0009 HSBC HSBC
OBIEMIReportData/OptionalEndpointsMetrics/AISCorporateAccountAccess/MIBrandId/:code:0010 Lloyds Lloyds
OBIEMIReportData/OptionalEndpointsMetrics/AISCorporateAccountAccess/MIBrandId/:code:0011 MAndSBank M&S Bank
OBIEMIReportData/OptionalEndpointsMetrics/AISCorporateAccountAccess/MIBrandId/:code:0012 NationwideBuildingSociety Nationwide Building Society
OBIEMIReportData/OptionalEndpointsMetrics/AISCorporateAccountAccess/MIBrandId/:code:0013 Natwest Natwest
OBIEMIReportData/OptionalEndpointsMetrics/AISCorporateAccountAccess/MIBrandId/:code:0014 RBS RBS
OBIEMIReportData/OptionalEndpointsMetrics/AISCorporateAccountAccess/MIBrandId/:code:0015 Santander UK plc Santander UK plc
OBIEMIReportData/OptionalEndpointsMetrics/AISCorporateAccountAccess/MIBrandId/:code:0016 UBN UBN
OBIEMIReportData/OptionalEndpointsMetrics/AISCorporateAccountAccess/MIBrandId/:code:9999 OTHERBrand Other Brand
OBIEMIReportData/OptionalEndpointsMetrics/AISCorporateAccountAccess/ReportMonth ReportMonth 1 1 Max6Text 1 6 ^(Jan Feb Mar Apr
OBIEMIReportData/OptionalEndpointsMetrics/AISCorporateAccountAccess/NumberOfAISPs NumberOfAISPs 1 1 Number This is the number of individual AISPs initiating payments and checking their payment status. For the avoidance of doubt OBIE is looking to receive the number of discrete AISPs (grouped by TPP ID) and not the number of discrete SSAs onboarded with the ASPSP making the endpoint calls
OBIEMIReportData/OptionalEndpointsMetrics/AISCorporateAccountAccess/VolumeSuccessfulCorporateAccAccess VolumeSuccessfulCorporateAccAccess 1 1 Max20AlphaNumericText 1 20 [a-zA-Z0-9]{1,20} Volume of Successful Corporate Account Access This is the total number of successful AIS consent requests (account access consent resources) that have been authorised as the PSU had authorisation by thei Corporate to access the corporate accounts.
OBIEMIReportData/OptionalEndpointsMetrics/AISCorporateAccountAccess/VolumeRejectedCorporateAccAccess VolumeRejectedCorporateAccAccess 1 1 Max20AlphaNumericText 1 20 [a-zA-Z0-9]{1,20} Volume of Rejected Corporate Account Access This is the total number of rejected AIS consent requests (account access consent resources) that have not been authorised as the PSU did not have authorisation by thei Corporate to access the corporate accounts.
OBIEMIReportData/OptionalEndpointsMetrics/AISCorporateAccountAccess/OtherMIBrand OtherMIBrand 0 1 OBMIOtherBrandType1
OBIEMIReportData/OptionalEndpointsMetrics/AISCorporateAccountAccess/OtherMIBrand/MIBrandId MIBrandId 1 1 OB_CodeMnemonic Other Brand Id which is not available in the published
OBIEMIReportData/OptionalEndpointsMetrics/AISCorporateAccountAccess/OtherMIBrand/BrandName BrandName 1 1 Max500Text 1 500 Long name associated with the code
OBIEMIReportData/OptionalEndpointsMetrics/AISCorporateAccountAccess/OtherMIBrand/Description Description 0 1 Max350Text 1 350 Description to describe the purpose of the code
OBIEMIReportData/PSUInterfacePerformanceAvailability PSUInterfacePerformanceAvailability 0 1 OBMIPSUInterfacePAndAReportData1
OBIEMIReportData/PSUInterfacePerformanceAvailability/MIBrandId MIBrandId 1 1 OBMIBrands1Code Brand Name that an organisation uses to market its products or services to a consumer.
OBIEMIReportData/PSUInterfacePerformanceAvailability/MIBrandId/:code:0001 AIBFirstTrustBank AIB First Trust Bank
OBIEMIReportData/PSUInterfacePerformanceAvailability/MIBrandId/:code:0002 AIBGroupUK AIB Group (UK) p.l.c.
OBIEMIReportData/PSUInterfacePerformanceAvailability/MIBrandId/:code:0003 BankOfIrelandUK Bank of Ireland UK
OBIEMIReportData/PSUInterfacePerformanceAvailability/MIBrandId/:code:0004 BankOfScotland Bank of Scotland
OBIEMIReportData/PSUInterfacePerformanceAvailability/MIBrandId/:code:0005 Barclays Barclays
OBIEMIReportData/PSUInterfacePerformanceAvailability/MIBrandId/:code:0006 DanskeBank Danske Bank
OBIEMIReportData/PSUInterfacePerformanceAvailability/MIBrandId/:code:0007 FirstDirect First Direct
OBIEMIReportData/PSUInterfacePerformanceAvailability/MIBrandId/:code:0008 Halifax Halifax
OBIEMIReportData/PSUInterfacePerformanceAvailability/MIBrandId/:code:0009 HSBC HSBC
OBIEMIReportData/PSUInterfacePerformanceAvailability/MIBrandId/:code:0010 Lloyds Lloyds
OBIEMIReportData/PSUInterfacePerformanceAvailability/MIBrandId/:code:0011 MAndSBank M&S Bank
OBIEMIReportData/PSUInterfacePerformanceAvailability/MIBrandId/:code:0012 NationwideBuildingSociety Nationwide Building Society
OBIEMIReportData/PSUInterfacePerformanceAvailability/MIBrandId/:code:0013 Natwest Natwest
OBIEMIReportData/PSUInterfacePerformanceAvailability/MIBrandId/:code:0014 RBS RBS
OBIEMIReportData/PSUInterfacePerformanceAvailability/MIBrandId/:code:0015 Santander UK plc Santander UK plc
OBIEMIReportData/PSUInterfacePerformanceAvailability/MIBrandId/:code:0016 UBN UBN
OBIEMIReportData/PSUInterfacePerformanceAvailability/MIBrandId/:code:9999 OTHERBrand Other Brand
OBIEMIReportData/PSUInterfacePerformanceAvailability/ReportDate ReportDate 1 1 ISODate A particular point in the progression of time in a calendar year expressed in the YYYY-MM-DD format. This representation is defined in "XML Schema Part 2: Datatypes Second Edition - W3C Recommendation 28 October 2004" which is aligned with ISO 8601.
OBIEMIReportData/PSUInterfacePerformanceAvailability/PSUChannel PSUChannel 1 1 OBMIPSUChannelType1Code This is the various notification methods used by ASPSPs to notify AISPs that a PSU has revoked access via the Access Dashboard. Allowed enumeration values: Online Banking Mobile Banking
OBIEMIReportData/PSUInterfacePerformanceAvailability/PSUChannel/:code:PCMB MobileBanking Mobile Banking
OBIEMIReportData/PSUInterfacePerformanceAvailability/PSUChannel/:code:PCOB OnlineBanking Online Banking
OBIEMIReportData/PSUInterfacePerformanceAvailability/CoreNonCoreHours CoreNonCoreHours 1 1 OBMICoreNonCoreHours1Code Used for reporting the availability and performance of each individual endpoint during core hours (06.00-0.00) and non-core hours (0.00-06.00) of each calendar day
OBIEMIReportData/PSUInterfacePerformanceAvailability/CoreNonCoreHours/:code:HRCH CoreHours Core Hours (06.00 - 00.00)
OBIEMIReportData/PSUInterfacePerformanceAvailability/CoreNonCoreHours/:code:HRNC NonCoreHours Non Core Hours (00.00 - 06.00)
OBIEMIReportData/PSUInterfacePerformanceAvailability/Uptime Uptime 1 1 Number Uptime per each individual endpoint as a percentage of total seconds in the period of core (06:00 – 24.00) or non-core hours (00.00 – 06.00). Total uptime is calculated as: 1. Core Hours: Uptime = 100% - percentage of total downtime during core hours 2. Non-Core Hours: Uptime = 100% - percentage of total downtime during non-core hours Conditions 1. Core Hours: Uptime + Downtime = 100% 2. Non-Core Hours: Uptime + Downtime = 100%
OBIEMIReportData/PSUInterfacePerformanceAvailability/Downtime Downtime 1 1 Number The total number of concurrent seconds per API call, per the hours in the period of core or and non-core hours, that any element of the dedicated interface is not available divided by the number of seconds in the period (i.e. 64,800 for core-hours and 21,600 for non-core hours) and expressed as a percentage. The clock for unavailability should start immediately after the service becomes unavailable. For the definition of unavailability, please refer to section PSU Interface Downtime. Conditions 1. Core Hours: Uptime + Downtime = 100% 2. Non-Core Hours: Uptime + Downtime = 100%
OBIEMIReportData/PSUInterfacePerformanceAvailability/OtherMIBrand OtherMIBrand 0 1 OBMIOtherBrandType1
OBIEMIReportData/PSUInterfacePerformanceAvailability/OtherMIBrand/MIBrandId MIBrandId 1 1 OB_CodeMnemonic Other Brand Id which is not available in the published
OBIEMIReportData/PSUInterfacePerformanceAvailability/OtherMIBrand/BrandName BrandName 1 1 Max500Text 1 500 Long name associated with the code
OBIEMIReportData/PSUInterfacePerformanceAvailability/OtherMIBrand/Description Description 0 1 Max350Text 1 350 Description to describe the purpose of the code

← MI Data JSON Schema→