--- swagger: "2.0" info: title: Account Information API V3 (MBNA) description: AISP Channel REST API termsOfService: https://www.openbanking.org.uk/terms contact: name: Service Desk email: ServiceDesk@openbanking.org.uk license: name: open-licence url: https://www.openbanking.org.uk/open-licence version: v3.1.10 x-ibm-name: account-information-mbn basePath: /mbn/open-banking/v3.1/aisp schemes: - https consumes: - application/json; charset=utf-8 produces: - application/json; charset=utf-8 paths: /account-access-consents: post: tags: - Account Access summary: Create Account Access Consents operationId: CreateAccountAccessConsents parameters: - $ref: '#/parameters/OBReadConsent1Param' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/AuthorizationParam' - $ref: '#/parameters/x-customer-user-agent-Param' responses: 201: $ref: '#/responses/201AccountAccessConsentsCreated' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 415: $ref: '#/responses/415ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - TPPOAuth2Security: - accounts /account-access-consents/{ConsentId}: get: tags: - Account Access summary: Get Account Access Consents operationId: GetAccountAccessConsentsConsentId parameters: - $ref: '#/parameters/ConsentId' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/AuthorizationParam' - $ref: '#/parameters/x-customer-user-agent-Param' responses: 200: $ref: '#/responses/200AccountAccessConsentsConsentIdRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - TPPOAuth2Security: - accounts delete: tags: - Account Access summary: Delete Account Access Consents operationId: DeleteAccountAccessConsentsConsentId parameters: - $ref: '#/parameters/ConsentId' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/AuthorizationParam' - $ref: '#/parameters/x-customer-user-agent-Param' responses: 204: $ref: '#/responses/204AccountAccessConsentsConsentIdDeleted' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - TPPOAuth2Security: - accounts /accounts: get: tags: - Accounts summary: Get Accounts operationId: GetAccounts parameters: - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/AuthorizationParam' - $ref: '#/parameters/x-customer-user-agent-Param' responses: 200: $ref: '#/responses/200AccountsRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - PSUOAuth2Security: - accounts /accounts/{AccountId}: get: tags: - Accounts summary: Get Accounts operationId: GetAccountsAccountId parameters: - $ref: '#/parameters/AccountId' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/AuthorizationParam' - $ref: '#/parameters/x-customer-user-agent-Param' responses: 200: $ref: '#/responses/200AccountsAccountIdRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - PSUOAuth2Security: - accounts /accounts/{AccountId}/balances: get: tags: - Balances summary: Get Balances operationId: GetAccountsAccountIdBalances parameters: - $ref: '#/parameters/AccountId' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/AuthorizationParam' - $ref: '#/parameters/x-customer-user-agent-Param' responses: 200: $ref: '#/responses/200AccountsAccountIdBalancesRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - PSUOAuth2Security: - accounts /accounts/{AccountId}/beneficiaries: get: tags: - Beneficiaries summary: Get Beneficiaries operationId: GetAccountsAccountIdBeneficiaries parameters: - $ref: '#/parameters/AccountId' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/AuthorizationParam' - $ref: '#/parameters/x-customer-user-agent-Param' responses: 200: $ref: '#/responses/200AccountsAccountIdBeneficiariesRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - PSUOAuth2Security: - accounts /accounts/{AccountId}/direct-debits: get: tags: - Direct Debits summary: Get Direct Debits operationId: GetAccountsAccountIdDirectDebits parameters: - $ref: '#/parameters/AccountId' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/AuthorizationParam' - $ref: '#/parameters/x-customer-user-agent-Param' responses: 200: $ref: '#/responses/200AccountsAccountIdDirectDebitsRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - PSUOAuth2Security: - accounts /accounts/{AccountId}/product: get: tags: - Products summary: Get Products operationId: GetAccountsAccountIdProduct parameters: - $ref: '#/parameters/AccountId' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/AuthorizationParam' - $ref: '#/parameters/x-customer-user-agent-Param' responses: 200: $ref: '#/responses/200AccountsAccountIdProductRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - PSUOAuth2Security: - accounts /accounts/{AccountId}/scheduled-payments: get: tags: - Scheduled Payments summary: Get Scheduled Payments operationId: GetAccountsAccountIdScheduledPayments parameters: - $ref: '#/parameters/AccountId' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/AuthorizationParam' - $ref: '#/parameters/x-customer-user-agent-Param' responses: 200: $ref: '#/responses/200AccountsAccountIdScheduledPaymentsRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - PSUOAuth2Security: - accounts /accounts/{AccountId}/standing-orders: get: tags: - Standing Orders summary: Get Standing Orders operationId: GetAccountsAccountIdStandingOrders parameters: - $ref: '#/parameters/AccountId' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/AuthorizationParam' - $ref: '#/parameters/x-customer-user-agent-Param' responses: 200: $ref: '#/responses/200AccountsAccountIdStandingOrdersRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - PSUOAuth2Security: - accounts /accounts/{AccountId}/transactions: get: tags: - Transactions summary: Get Transactions operationId: GetAccountsAccountIdTransactions parameters: - $ref: '#/parameters/AccountId' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/AuthorizationParam' - $ref: '#/parameters/FromBookingDateTimeParam' - $ref: '#/parameters/ToBookingDateTimeParam' - $ref: '#/parameters/x-customer-user-agent-Param' responses: 200: $ref: '#/responses/200AccountsAccountIdTransactionsRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - PSUOAuth2Security: - accounts /accounts/{AccountId}/offers: get: tags: - Offers summary: Get Offers operationId: GetAccountsAccountIdOffers parameters: - $ref: '#/parameters/AccountId' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/AuthorizationParam' - $ref: '#/parameters/x-customer-user-agent-Param' responses: 200: $ref: '#/responses/200AccountsAccountIdOffersRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - PSUOAuth2Security: - accounts /accounts/{AccountId}/statements/{StatementId}/file: get: tags: - Statements summary: Get Statements operationId: GetAccountsAccountIdStatementsStatementIdFile produces: - application/pdf parameters: - $ref: '#/parameters/StatementId' - $ref: '#/parameters/AccountId' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/AuthorizationParam' - $ref: '#/parameters/x-customer-user-agent-Param' responses: 200: $ref: '#/responses/200AccountsAccountIdStatementsStatementIdFileRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - PSUOAuth2Security: - accounts /accounts/{AccountId}/statements: get: tags: - Statements summary: Get Statements operationId: GetAccountsAccountIdStatements parameters: - $ref: '#/parameters/AccountId' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/AuthorizationParam' - $ref: '#/parameters/FromStatementDateTimeParam' - $ref: '#/parameters/ToStatementDateTimeParam' - $ref: '#/parameters/x-customer-user-agent-Param' responses: 200: $ref: '#/responses/200AccountsAccountIdStatementsRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - PSUOAuth2Security: - accounts /accounts/{AccountId}/parties: get: tags: - Parties summary: Get Parties operationId: GetAccountsAccountIdParties parameters: - $ref: '#/parameters/AccountId' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/AuthorizationParam' - $ref: '#/parameters/x-customer-user-agent-Param' responses: 200: $ref: '#/responses/200AccountsAccountIdPartiesRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - PSUOAuth2Security: - accounts /accounts/{AccountId}/party: get: tags: - Parties summary: Get Parties operationId: GetAccountsAccountIdParty parameters: - $ref: '#/parameters/AccountId' - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/AuthorizationParam' - $ref: '#/parameters/x-customer-user-agent-Param' responses: 200: $ref: '#/responses/200AccountsAccountIdPartyRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - PSUOAuth2Security: - accounts /party: get: tags: - Parties summary: Get Parties operationId: GetParty parameters: - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/AuthorizationParam' - $ref: '#/parameters/x-customer-user-agent-Param' responses: 200: $ref: '#/responses/200PartyRead' 400: $ref: '#/responses/400ErrorResponse' 401: $ref: '#/responses/401ErrorResponse' 403: $ref: '#/responses/403ErrorResponse' 404: $ref: '#/responses/404ErrorResponse' 405: $ref: '#/responses/405ErrorResponse' 406: $ref: '#/responses/406ErrorResponse' 429: $ref: '#/responses/429ErrorResponse' 500: $ref: '#/responses/500ErrorResponse' security: - PSUOAuth2Security: - accounts parameters: FromStatementDateTimeParam: in: query name: fromStatementDateTime type: string format: date-time description: |- The UTC ISO 8601 Date Time to filter statements FROM NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component. ToStatementDateTimeParam: in: query name: toStatementDateTime type: string format: date-time description: |- The UTC ISO 8601 Date Time to filter statements TO NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component. FromBookingDateTimeParam: in: query name: fromBookingDateTime type: string format: date-time description: |- The UTC ISO 8601 Date Time to filter transactions FROM NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component. ToBookingDateTimeParam: in: query name: toBookingDateTime type: string format: date-time description: |- The UTC ISO 8601 Date Time to filter transactions TO NB Time component is optional - set to 00:00:00 for just Date. If the Date Time contains a timezone, the ASPSP must ignore the timezone component. x-fapi-financial-id-Param: in: header name: x-fapi-financial-id type: string required: true description: The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB. x-fapi-customer-ip-address-Param: in: header name: x-fapi-customer-ip-address type: string required: false description: The PSU's IP address if the PSU is currently logged in with the TPP. x-fapi-interaction-id-Param: in: header name: x-fapi-interaction-id type: string pattern: ^[0-9a-fA-F]{8}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{4}\-[0-9a-fA-F]{12}$ required: false description: An RFC4122 UID used as a correlation id. x-fapi-customer-last-logged-time-Param: in: header name: x-fapi-customer-last-logged-time type: string required: false description: |- The time when the PSU last logged in with the TPP. All dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: Sun, 10 Sep 2017 19:43:31 UTC pattern: ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$ AuthorizationParam: in: header name: Authorization type: string required: true description: An Authorisation Token as per https://tools.ietf.org/html/rfc6750 AccountId: name: AccountId in: path description: AccountId required: true type: string x-fapi-auth-date: in: header name: x-fapi-auth-date type: string required: false description: "The time when the PSU last logged in with the TPP. \nAll dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: \nSun, 10 Sep 2017 19:43:31 UTC" pattern: ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$ x-fapi-customer-ip-address: in: header name: x-fapi-customer-ip-address type: string required: false description: The PSU's IP address if the PSU is currently logged in with the TPP. x-fapi-interaction-id: in: header name: x-fapi-interaction-id type: string required: false description: An RFC4122 UID used as a correlation id. x-customer-user-agent: in: header name: x-customer-user-agent type: string description: Indicates the user-agent that the PSU is using. required: false OBReadConsent1Param: name: OBReadConsent1Param in: body description: Default required: true schema: $ref: '#/definitions/OBReadConsent1' ConsentId: name: ConsentId in: path description: ConsentId required: true type: string StatementId: name: StatementId in: path description: StatementId required: true type: string x-customer-user-agent-Param: in: header name: x-customer-user-agent type: string description: Indicates the user-agent that the PSU is using. required: false responses: 200AccountsAccountIdStatementsRead: description: Statements Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. schema: $ref: '#/definitions/OBReadStatement1' 200AccountsAccountIdProductRead: description: Products Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. schema: $ref: '#/definitions/OBReadProduct2' 200AccountsAccountIdStatementsStatementIdFileRead: description: Statements Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. schema: type: string 200AccountsAccountIdScheduledPaymentsRead: description: Scheduled Payments Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. schema: $ref: '#/definitions/OBReadScheduledPayment2' 201AccountAccessConsentsCreated: description: Account Access Consents Created headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. schema: $ref: '#/definitions/OBReadConsentResponse1' 200AccountAccessConsentsConsentIdRead: description: Account Access Consents Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. schema: $ref: '#/definitions/OBReadConsentResponse1' 204AccountAccessConsentsConsentIdDeleted: description: Account Access Consents Deleted headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. 200AccountsRead: description: Accounts Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. schema: $ref: '#/definitions/OBReadAccount6' 200AccountsAccountIdRead: description: Accounts Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. schema: $ref: '#/definitions/OBReadAccount6' 200AccountsAccountIdTransactionsRead: description: Transactions Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. schema: $ref: '#/definitions/OBReadTransaction6' 200AccountsAccountIdDirectDebitsRead: description: Direct Debits Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. schema: $ref: '#/definitions/OBReadDirectDebit1' 200AccountsAccountIdStandingOrdersRead: description: Standing Orders Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. schema: $ref: '#/definitions/OBReadStandingOrder4' 200AccountsAccountIdBalancesRead: description: Balances Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. schema: $ref: '#/definitions/OBReadBalance1' 200AccountsAccountIdBeneficiariesRead: description: Beneficiaries Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. schema: $ref: '#/definitions/OBReadBeneficiary5' 200AccountsAccountIdOffersRead: description: Account Offers successfully retrieved schema: $ref: '#/definitions/OBReadOffer1' headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. 200PartyRead: description: Parties Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. schema: $ref: '#/definitions/OBReadParty2' 200AccountsAccountIdPartyRead: description: Parties Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. schema: $ref: '#/definitions/OBReadParty2' 200AccountsAccountIdPartiesRead: description: Parties Read headers: x-fapi-interaction-id: type: string description: An RFC4122 UID used as a correlation id. schema: $ref: '#/definitions/OBReadParty3' 400ErrorResponse: description: Bad request schema: $ref: '#/definitions/OBErrorResponse1' 401ErrorResponse: description: Unauthorized 403ErrorResponse: description: Forbidden schema: $ref: '#/definitions/OBErrorResponse1' 404ErrorResponse: description: Not found 405ErrorResponse: description: Method Not Allowed 406ErrorResponse: description: Not Acceptable 415ErrorResponse: description: Unsupported Media Type 429ErrorResponse: description: Too Many Requests headers: Retry-After: description: Number in seconds to wait type: integer 500ErrorResponse: description: Internal Server Error schema: $ref: '#/definitions/OBErrorResponse1' securityDefinitions: PSUOAuth2Security: type: oauth2 flow: accessCode tokenUrl: https://secure-api.mbna.co.uk/prod01/lbg/mbn/oidc-api/v1.1/token authorizationUrl: https://authorise-api.mbna.co.uk/prod01/lbg/mbn/personal/oidc-api/v1.1/authorize scopes: accounts: Ability to read Accounts information openid: Enable OpenID description: OAuth flow, it is required when the PSU needs to perform SCA with the ASPSP when a TPP wants to access an ASPSP resource owned by the PSU. Please refer to the **well known endpoint** or the **Technical Implementation Guide** for any additional information. TPPOAuth2Security: type: oauth2 flow: application tokenUrl: https://secure-api.mbna.co.uk/prod01/lbg/mbn/oidc-api/v1.1/token scopes: accounts: TPP Client Credential Scope for accounts and payments api description: TPP client credential authorisation flow with the ASPSP definitions: AccountId: description: A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. type: string minLength: 1 maxLength: 40 OBAccount6: description: Unambiguous identification of the account to which credit and debit entries are made. type: object properties: AccountId: $ref: '#/definitions/AccountId' Currency: description: |- Identification of the currency in which the account is held. Usage: Currency should only be used in case one and the same account number covers several currencies and the initiating party needs to identify which currency needs to be used for settlement on the account. type: string pattern: ^[A-Z]{3,3}$ AccountType: $ref: '#/definitions/OBExternalAccountType1Code' AccountSubType: $ref: '#/definitions/OBExternalAccountSubType1Code' Description: description: Specifies the description of the account type. type: string minLength: 1 maxLength: 35 Nickname: description: The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account. type: string minLength: 1 maxLength: 70 OpeningDate: description: "Date on which the account and related basic services are effectively operational for the account owner.All dates in the JSON payloads are represented in ISO 8601 date-time format. \n All date-time fields in responses must include the timezone. An example is below:\n 2017-04-05T10:43:07+00:00" format: date-time type: string MaturityDate: description: "Maturity date of the account.All dates in the JSON payloads are represented in ISO 8601 date-time format. \nAll date-time fields in responses must include the timezone. An example is below\n2017-04-05T10:43:07+00:00" type: string format: date-time SwitchStatus: description: Specifies the switch status for the account, in a coded form. type: string x-namespaced-enum: - UK.CASS.NotSwitced - UK.CASS.SwitchCompleted Account: items: $ref: '#/definitions/OBCashAccount5' type: array description: Provides the details to identify an account. Servicer: $ref: '#/definitions/OBBranchAndFinancialInstitutionIdentification5' required: - AccountId additionalProperties: false OBActiveCurrencyAndAmount_SimpleType: description: A number of monetary units specified in an active currency where the unit of currency is explicit and compliant with ISO 4217. type: string pattern: ^\d{1,13}$|^\d{1,13}\.\d{1,5}$ OBActiveOrHistoricCurrencyAndAmount: description: Amount of money of the cash balance after a transaction entry is applied to the account.. type: object properties: Amount: $ref: '#/definitions/OBActiveCurrencyAndAmount_SimpleType' Currency: description: A code allocated to a currency by a Maintenance Agency under an international identification scheme, as described in the latest edition of the international standard ISO 4217 "Codes for the representation of currencies and funds". type: string pattern: ^[A-Z]{3,3}$ required: - Amount - Currency additionalProperties: false OBAddressTypeCode: description: Identifies the nature of the postal address. type: string enum: - Business - Correspondence - DeliveryTo - MailTo - POBox - Postal - Residential - Statement OBBalanceType1Code: description: Balance type, in a coded form. type: string enum: - ClosingAvailable - ClosingBooked - ClosingCleared - Expected - ForwardAvailable - Information - InterimAvailable - InterimBooked - InterimCleared - OpeningAvailable - OpeningBooked - OpeningCleared - PreviouslyClosedBooked OBBankTransactionCodeStructure1: description: Set of elements used to fully identify the type of underlying transaction resulting in an entry. type: object properties: Code: description: Specifies the family within a domain. type: string SubCode: description: Specifies the sub-product family within a specific family. type: string required: - Code - SubCode additionalProperties: false OBBeneficiary5: type: object properties: AccountId: $ref: '#/definitions/AccountId' BeneficiaryId: description: A unique and immutable identifier used to identify the beneficiary resource. This identifier has no meaning to the account owner. type: string minLength: 1 maxLength: 40 BeneficiaryType: description: Specifies the Beneficiary Type. type: string enum: - Trusted - Ordinary Reference: description: |- Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. type: string minLength: 1 maxLength: 35 SupplementaryData: type: object properties: BenificiaryPostalAddress: type: object properties: Country: type: string AddressLine: type: array items: type: string description: Beneficiary supplementary data CreditorAgent: $ref: '#/definitions/OBBranchAndFinancialInstitutionIdentification6' CreditorAccount: $ref: '#/definitions/OBCashAccount5' additionalProperties: false OBCashBalance1: description: Set of elements used to define the balance details. type: object properties: AccountId: $ref: '#/definitions/AccountId' CreditDebitIndicator: type: string enum: - Credit - Debit description: |- Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance. Type: $ref: '#/definitions/OBBalanceType1Code' DateTime: description: |- Indicates the date (and time) of the balance. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time Amount: $ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount' CreditLine: items: $ref: '#/definitions/OBCreditLine1' type: array description: Set of elements used to provide details on the credit line. required: - AccountId - CreditDebitIndicator - Type - DateTime - Amount additionalProperties: false minProperties: 1 OBCreditLine1: description: Set of elements used to provide details on the credit line. type: object properties: Included: description: |- Indicates whether or not the credit line is included in the balance of the account. Usage: If not present, credit line is not included in the balance amount of the account. type: boolean Type: $ref: '#/definitions/OBExternalLimitType1Code' Amount: $ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount' required: - Included additionalProperties: false OBCurrencyExchange5: description: Set of elements used to provide details on the currency exchange. type: object properties: SourceCurrency: description: Currency from which an amount is to be converted in a currency conversion. type: string pattern: ^[A-Z]{3,3}$ TargetCurrency: description: Currency from which an amount is to be converted in a currency conversion. type: string pattern: ^[A-Z]{3,3}$ UnitCurrency: description: Currency from which an amount is to be converted in a currency conversion. type: string pattern: ^[A-Z]{3,3}$ ExchangeRate: description: |- Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency. Usage: ExchangeRate expresses the ratio between UnitCurrency and QuotedCurrency (ExchangeRate = UnitCurrency/QuotedCurrency). type: number ContractIdentification: description: Unique identification to unambiguously identify the foreign exchange contract. type: string minLength: 1 maxLength: 35 QuotationDate: description: |- Date and time at which an exchange rate is quoted. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time InstructedAmount: $ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount' required: - SourceCurrency - ExchangeRate additionalProperties: false OBDirectDebit1: description: Account to or from which a cash entry is made. type: object properties: AccountId: $ref: '#/definitions/AccountId' DirectDebitId: description: A unique and immutable identifier used to identify the direct debit resource. This identifier has no meaning to the account owner. type: string minLength: 1 maxLength: 40 MandateIdentification: description: Direct Debit reference. For AUDDIS service users provide Core Reference. For non AUDDIS service users provide Core reference if possible or last used reference. type: string minLength: 1 maxLength: 35 DirectDebitStatusCode: $ref: '#/definitions/OBExternalDirectDebitStatus1Code' Name: description: Name of Service User. type: string minLength: 1 maxLength: 70 PreviousPaymentDateTime: description: |- Date of most recent direct debit collection. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time Frequency: description: Regularity with which direct debit instructions are to be created and processed. type: string x-namespaced-enum: - UK.OBIE.Annual - UK.OBIE.Daily - UK.OBIE.Fortnightly - UK.OBIE.HalfYearly - UK.OBIE.Monthly - UK.OBIE.NotKnown - UK.OBIE.Quarterly - UK.OBIE.Weekly PreviousPaymentAmount: $ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount' required: - AccountId - MandateIdentification - Name additionalProperties: false OBEntryStatus1Code: description: Status of a transaction entry on the books of the account servicer. type: string enum: - Booked - Pending OBExternalAccountSubType1Code: description: Specifies the sub type of account (product family group). type: string enum: - ChargeCard - CreditCard - CurrentAccount - EMoney - Loan - Mortgage - PrePaidCard - Savings OBExternalAccountType1Code: description: Specifies the type of account (personal or business). type: string enum: - Business - Personal OBExternalCardAuthorisationType1Code: description: The card authorisation type. type: string enum: - ConsumerDevice - Contactless - None - PIN OBExternalCardSchemeType1Code: description: Name of the card scheme. type: string enum: - AmericanExpress - Diners - Discover - MasterCard - VISA OBExternalDirectDebitStatus1Code: description: Specifies the status of the direct debit in code form. type: string enum: - Active - Inactive OBExternalLimitType1Code: description: Limit type, in a coded form. type: string enum: - Available - Credit - Emergency - Pre-Agreed - Temporary OBExternalPermissions1Code: description: Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP. type: string enum: - ReadAccountsBasic - ReadAccountsDetail - ReadBalances - ReadBeneficiariesBasic - ReadBeneficiariesDetail - ReadDirectDebits - ReadOffers - ReadPAN - ReadParty - ReadPartyPSU - ReadProducts - ReadScheduledPaymentsBasic - ReadScheduledPaymentsDetail - ReadStandingOrdersBasic - ReadStandingOrdersDetail - ReadStatementsBasic - ReadStatementsDetail - ReadTransactionsBasic - ReadTransactionsCredits - ReadTransactionsDebits - ReadTransactionsDetail OBExternalRequestStatus1Code: description: Specifies the status of consent resource in code form. type: string enum: - Authorised - AwaitingAuthorisation - Rejected - Revoked OBExternalScheduleType1Code: description: Specifies the scheduled payment date type requested type: string enum: - Arrival - Execution OBExternalStandingOrderStatus1Code: description: Specifies the status of the standing order in code form. type: string enum: - Active - Inactive OBMerchantDetails1: description: Details of the merchant involved in the transaction. type: object properties: MerchantName: description: Name by which the merchant is known. type: string minLength: 1 maxLength: 350 MerchantCategoryCode: description: Category code conform to ISO 18245, related to the type of services or goods the merchant provides for the transaction. type: string minLength: 3 maxLength: 4 additionalProperties: false OBPostalAddress6: description: Information that locates and identifies a specific address, as defined by postal services. type: object properties: AddressType: $ref: '#/definitions/OBAddressTypeCode' Department: description: Identification of a division of a large organisation or building. type: string minLength: 1 maxLength: 70 SubDepartment: description: Identification of a sub-division of a large organisation or building. type: string minLength: 1 maxLength: 70 StreetName: description: Name of a street or thoroughfare. type: string minLength: 1 maxLength: 70 BuildingNumber: description: Number that identifies the position of a building on a street. type: string minLength: 1 maxLength: 16 PostCode: description: Identifier consisting of a group of letters and/or numbers that is added to a postal address to assist the sorting of mail. type: string minLength: 1 maxLength: 16 TownName: description: Name of a built-up area, with defined boundaries, and a local government. type: string minLength: 1 maxLength: 35 CountrySubDivision: description: Identifies a subdivision of a country such as state, region, county. type: string minLength: 1 maxLength: 35 Country: description: Nation with its own government. type: string pattern: ^[A-Z]{2,2}$ AddressLine: items: type: string minLength: 1 maxLength: 70 type: array description: Information that locates and identifies a specific address, as defined by postal services, presented in free format text. minItems: 0 maxItems: 7 additionalProperties: false OBReadAccount6: type: object properties: Data: type: object properties: Account: items: $ref: '#/definitions/OBAccount6' type: array description: Unambiguous identification of the account to which credit and debit entries are made. additionalProperties: false Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' required: - Data - Links - Meta additionalProperties: false OBReadBalance1: type: object properties: Data: type: object properties: Balance: items: $ref: '#/definitions/OBCashBalance1' type: array description: Set of elements used to define the balance details. minItems: 1 required: - Balance additionalProperties: false Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' required: - Data - Links - Meta additionalProperties: false OBReadBeneficiary5: type: object properties: Data: type: object properties: Beneficiary: items: $ref: '#/definitions/OBBeneficiary5' type: array additionalProperties: false Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' required: - Data - Links - Meta additionalProperties: false OBReadConsent1: type: object properties: Data: $ref: '#/definitions/OBReadData1' Risk: $ref: '#/definitions/OBRisk2' required: - Data - Risk additionalProperties: false OBReadConsentResponse1: type: object properties: Data: type: object properties: ConsentId: description: Unique identification as assigned to identify the account access consent resource. type: string minLength: 1 maxLength: 128 CreationDateTime: description: |- Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time Status: $ref: '#/definitions/OBExternalRequestStatus1Code' StatusUpdateDateTime: description: |- Date and time at which the resource status was updated. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time Permissions: items: $ref: '#/definitions/OBExternalPermissions1Code' type: array description: Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP. minItems: 1 ExpirationDateTime: description: |- Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time TransactionFromDateTime: description: |- Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time TransactionToDateTime: description: |- Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time required: - ConsentId - CreationDateTime - Status - StatusUpdateDateTime - Permissions additionalProperties: false Risk: $ref: '#/definitions/OBRisk2' Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' required: - Data - Risk - Links - Meta additionalProperties: false OBReadData1: type: object properties: Permissions: items: $ref: '#/definitions/OBExternalPermissions1Code' type: array description: Specifies the Open Banking account access data types. This is a list of the data clusters being consented by the PSU, and requested for authorisation with the ASPSP. minItems: 1 ExpirationDateTime: description: |- Specified date and time the permissions will expire. If this is not populated, the permissions will be open ended. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time TransactionFromDateTime: description: |- Specified start date and time for the transaction query period. If this is not populated, the start date will be open ended, and data will be returned from the earliest available transaction. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time TransactionToDateTime: description: |- Specified end date and time for the transaction query period. If this is not populated, the end date will be open ended, and data will be returned to the latest available transaction. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time required: - Permissions additionalProperties: false OBReadDirectDebit1: type: object properties: Data: type: object properties: DirectDebit: items: $ref: '#/definitions/OBDirectDebit1' type: array description: Account to or from which a cash entry is made. additionalProperties: false Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' required: - Data - Links - Meta additionalProperties: false OBReadProduct2: type: object properties: Data: type: object additionalProperties: false Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' required: - Data - Links - Meta additionalProperties: false OBReadScheduledPayment2: type: object properties: Data: type: object properties: ScheduledPayment: items: $ref: '#/definitions/OBScheduledPayment2' type: array additionalProperties: false Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' required: - Data - Links - Meta additionalProperties: false OBReadStandingOrder4: type: object properties: Data: type: object properties: StandingOrder: items: $ref: '#/definitions/OBStandingOrder4' type: array additionalProperties: false Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' required: - Data - Links - Meta additionalProperties: false OBReadTransaction6: type: object properties: Data: type: object properties: Transaction: items: $ref: '#/definitions/OBTransaction6' type: array description: Provides further details on an entry in the report. additionalProperties: false Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' required: - Data - Links - Meta additionalProperties: false OBScheduledPayment2: type: object properties: AccountId: $ref: '#/definitions/AccountId' ScheduledPaymentId: description: A unique and immutable identifier used to identify the scheduled payment resource. This identifier has no meaning to the account owner. type: string minLength: 1 maxLength: 40 ScheduledPaymentDateTime: description: |- The date on which the scheduled payment will be made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time ScheduledType: $ref: '#/definitions/OBExternalScheduleType1Code' Reference: description: |- Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. type: string minLength: 1 maxLength: 35 DebtorReference: description: A reference value provided by the PSU to the PISP while setting up the scheduled payment. type: string minLength: 1 maxLength: 35 InstructedAmount: $ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount' CreditorAgent: $ref: '#/definitions/OBBranchAndFinancialInstitutionIdentification5' CreditorAccount: $ref: '#/definitions/OBCashAccount5' required: - AccountId - ScheduledPaymentDateTime - ScheduledType - InstructedAmount additionalProperties: false OBStandingOrder4: type: object properties: AccountId: $ref: '#/definitions/AccountId' StandingOrderId: description: A unique and immutable identifier used to identify the standing order resource. This identifier has no meaning to the account owner. type: string minLength: 1 maxLength: 40 Frequency: description: |- Individual Definitions: EvryDay - Every day EvryWorkgDay - Every working day IntrvlWkDay - An interval specified in weeks (01 to 09), and the day within the week (01 to 07) WkInMnthDay - A monthly interval, specifying the week of the month (01 to 05) and day within the week (01 to 07) IntrvlMnthDay - An interval specified in months (between 01 to 06, 12, 24), specifying the day within the month (-5 to -1, 1 to 31) QtrDay - Quarterly (either ENGLISH, SCOTTISH, or RECEIVED) ENGLISH = Paid on the 25th March, 24th June, 29th September and 25th December. SCOTTISH = Paid on the 2nd February, 15th May, 1st August and 11th November. RECEIVED = Paid on the 20th March, 19th June, 24th September and 20th December. Individual Patterns: EvryDay (ScheduleCode) EvryWorkgDay (ScheduleCode) IntrvlWkDay:IntervalInWeeks:DayInWeek (ScheduleCode + IntervalInWeeks + DayInWeek) WkInMnthDay:WeekInMonth:DayInWeek (ScheduleCode + WeekInMonth + DayInWeek) IntrvlMnthDay:IntervalInMonths:DayInMonth (ScheduleCode + IntervalInMonths + DayInMonth) QtrDay: + either (ENGLISH, SCOTTISH or RECEIVED) ScheduleCode + QuarterDay The regular expression for this element combines five smaller versions for each permitted pattern. To aid legibility - the components are presented individually here: EvryDay EvryWorkgDay IntrvlWkDay:0[1-9]:0[1-7] WkInMnthDay:0[1-5]:0[1-7] IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]) QtrDay:(ENGLISH|SCOTTISH|RECEIVED) Full Regular Expression: ^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$ type: string minLength: 1 maxLength: 35 pattern: ^(EvryDay)$|^(EvryWorkgDay)$|^(IntrvlWkDay:0[1-9]:0[1-7])$|^(WkInMnthDay:0[1-5]:0[1-7])$|^(IntrvlMnthDay:(0[1-6]|12|24):(-0[1-5]|0[1-9]|[12][0-9]|3[01]))$|^(QtrDay:(ENGLISH|SCOTTISH|RECEIVED))$ Reference: description: |- Unique reference, as assigned by the creditor, to unambiguously refer to the payment transaction. Usage: If available, the initiating party should provide this reference in the structured remittance information, to enable reconciliation by the creditor upon receipt of the amount of money. If the business context requires the use of a creditor reference or a payment remit identification, and only one identifier can be passed through the end-to-end chain, the creditor's reference or payment remittance identification should be quoted in the end-to-end transaction identification. type: string minLength: 1 maxLength: 35 FirstPaymentDateTime: description: |- The date on which the first payment for a Standing Order schedule will be made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time NextPaymentDateTime: description: |- The date on which the next payment for a Standing Order schedule will be made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time FinalPaymentDateTime: description: |- The date on which the final payment for a Standing Order schedule will be made. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time StandingOrderStatusCode: $ref: '#/definitions/OBExternalStandingOrderStatus1Code' FirstPaymentAmount: $ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount' NextPaymentAmount: $ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount' FinalPaymentAmount: $ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount' SupplementaryData: $ref: '#/definitions/OBSupplementaryData1' CreditorAgent: $ref: '#/definitions/OBBranchAndFinancialInstitutionIdentification5' CreditorAccount: $ref: '#/definitions/OBCashAccount5' required: - AccountId - Frequency additionalProperties: false OBTransaction6: description: Provides further details on an entry in the report. type: object properties: AccountId: $ref: '#/definitions/AccountId' TransactionId: description: Unique identifier for the transaction within an servicing institution. This identifier is both unique and immutable. type: string minLength: 1 maxLength: 40 TransactionReference: description: Unique reference for the transaction. This reference is optionally populated, and may as an example be the FPID in the Faster Payments context. type: string minLength: 1 maxLength: 210 StatementReference: items: type: string minLength: 1 maxLength: 35 type: array description: Unique reference for the statement. This reference may be optionally populated if available. CreditDebitIndicator: type: string enum: - Credit - Debit description: Indicates whether the transaction is a credit or a debit entry. Status: $ref: '#/definitions/OBEntryStatus1Code' TransactionMutability: description: Specifies the Mutability of the Transaction record. type: string enum: - Mutable - Immutable BookingDateTime: description: |- Date and time when a transaction entry is posted to an account on the account servicer's books. Usage: Booking date is the expected booking date, unless the status is booked, in which case it is the actual booking date. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time ValueDateTime: description: |- Date and time at which assets become available to the account owner in case of a credit entry, or cease to be available to the account owner in case of a debit transaction entry. Usage: If transaction entry status is pending and value date is present, then the value date refers to an expected/requested value date. For transaction entries subject to availability/float and for which availability information is provided, the value date must not be used. In this case the availability component identifies the number of availability days. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time AddressLine: description: Information that locates and identifies a specific address for a transaction entry, that is presented in free format text. type: string minLength: 1 maxLength: 70 Amount: $ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount' ChargeAmount: $ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount' CurrencyExchange: $ref: '#/definitions/OBCurrencyExchange5' BankTransactionCode: $ref: '#/definitions/OBBankTransactionCodeStructure1' ProprietaryBankTransactionCode: description: Set of elements to fully identify a proprietary bank transaction code. type: object properties: Code: description: Proprietary bank transaction code to identify the underlying transaction. type: string minLength: 1 maxLength: 35 Issuer: description: Identification of the issuer of the proprietary bank transaction code. type: string minLength: 1 maxLength: 35 required: - Code additionalProperties: false CardInstrument: $ref: '#/definitions/OBTransactionCardInstrument1' SupplementaryData: $ref: '#/definitions/OBSupplementaryData1' TransactionInformation: $ref: '#/definitions/TransactionInformation' Balance: $ref: '#/definitions/OBTransactionCashBalance' MerchantDetails: $ref: '#/definitions/OBMerchantDetails1' CreditorAgent: $ref: '#/definitions/OBBranchAndFinancialInstitutionIdentification6' CreditorAccount: $ref: '#/definitions/OBCashAccount6' DebtorAgent: $ref: '#/definitions/OBBranchAndFinancialInstitutionIdentification6' DebtorAccount: $ref: '#/definitions/OBCashAccount6' required: - AccountId - CreditDebitIndicator - Status - BookingDateTime - Amount additionalProperties: false OBTransactionCardInstrument1: description: Set of elements to describe the card instrument used in the transaction. type: object properties: CardSchemeName: $ref: '#/definitions/OBExternalCardSchemeType1Code' AuthorisationType: $ref: '#/definitions/OBExternalCardAuthorisationType1Code' Name: description: Name of the cardholder using the card instrument. type: string minLength: 1 maxLength: 70 Identification: description: Identification assigned by an institution to identify the card instrument used in the transaction. This identification is known by the account owner, and may be masked. type: string minLength: 1 maxLength: 34 required: - CardSchemeName additionalProperties: false OBTransactionCashBalance: description: Set of elements used to define the balance as a numerical representation of the net increases and decreases in an account after a transaction entry is applied to the account. type: object properties: CreditDebitIndicator: type: string enum: - Credit - Debit description: |- Indicates whether the balance is a credit or a debit balance. Usage: A zero balance is considered to be a credit balance. Type: $ref: '#/definitions/OBBalanceType1Code' Amount: $ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount' required: - CreditDebitIndicator - Type - Amount additionalProperties: false TransactionInformation: description: |- Further details of the transaction. This is the transaction narrative, which is unstructured text. type: string minLength: 1 maxLength: 500 OBSupplementaryData1: description: Additional information that can not be captured in the structured fields and/or any other specific block. type: object additionalProperties: false OBBranchAndFinancialInstitutionIdentification5: description: |- Party that manages the account on behalf of the account owner, that is manages the registration and booking of entries on the account, calculates balances on the account and provides information about the account. This is the servicer of the beneficiary account. type: object properties: SchemeName: $ref: '#/definitions/OBExternalFinancialInstitutionIdentification4Code' Identification: description: Unique and unambiguous identification of the servicing institution. type: string minLength: 1 maxLength: 35 required: - SchemeName - Identification additionalProperties: false OBExternalFinancialInstitutionIdentification4Code: description: Name of the identification scheme, in a coded form as published in an external list. type: string example: - UK.OBIE.BICFI minLength: 1 maxLength: 40 OBCashAccount5: description: Provides the details to identify the beneficiary account. type: object properties: SchemeName: $ref: '#/definitions/OBExternalAccountIdentification4Code' Identification: description: Beneficiary account identification. type: string minLength: 1 maxLength: 256 Name: description: |- Name of the account, as assigned by the account servicing institution. Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. type: string minLength: 1 maxLength: 350 SecondaryIdentification: description: |- This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). type: string minLength: 1 maxLength: 34 required: - SchemeName - Identification additionalProperties: false OBCashAccount6: description: Unambiguous identification of the account of the debtor, in the case of a crebit transaction. type: object properties: SchemeName: $ref: '#/definitions/OBExternalAccountIdentification4Code' Identification: description: Identification assigned by an institution to identify an account. This identification is known by the account owner. type: string minLength: 1 maxLength: 256 Name: description: |- Name of the account, as assigned by the account servicing institution. Usage: The account name is the name or names of the account owner(s) represented at an account level. The account name is not the product name or the nickname of the account. type: string minLength: 1 maxLength: 350 SecondaryIdentification: description: |- This is secondary identification of the account, as assigned by the account servicing institution. This can be used by building societies to additionally identify accounts with a roll number (in addition to a sort code and account number combination). type: string minLength: 1 maxLength: 34 additionalProperties: false OBExternalAccountIdentification4Code: description: Name of the identification scheme, in a coded form as published in an external list. type: string example: - UK.OBIE.BBAN - UK.OBIE.IBAN - UK.OBIE.PAN - UK.OBIE.Paym - UK.OBIE.SortCodeAccountNumber minLength: 1 maxLength: 40 OBBranchAndFinancialInstitutionIdentification6: description: Financial institution servicing an account for the debtor. type: object properties: SchemeName: $ref: '#/definitions/OBExternalFinancialInstitutionIdentification4Code' Identification: description: Unique and unambiguous identification of a financial institution or a branch of a financial institution. type: string minLength: 1 maxLength: 35 Name: description: Name by which an agent is known and which is usually used to identify that agent. type: string minLength: 1 maxLength: 140 PostalAddress: $ref: '#/definitions/OBPostalAddress6' additionalProperties: false OBOffer1: type: object properties: AccountId: $ref: '#/definitions/AccountId' OffersId: description: Identifier within the parent organisation for the offers. Must be unique in the organisation. type: string OfferType: type: string Description: type: string StartDateTime: type: string format: date-time EndDateTime: type: string format: date-time Rate: description: Rate associated with the offer type. type: string minLength: 1 maxLength: 10 pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ Value: type: integer format: int32 Term: description: Further details of the term of the offer. type: string minLength: 1 maxLength: 500 URL: description: URL (Uniform Resource Locator) where documentation on the offer can be found type: string minLength: 1 maxLength: 256 Amount: $ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount' Fee: $ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount' required: - AccountId - OfferType additionalProperties: false OBReadOffer1: type: object properties: Data: type: object properties: Offer: items: $ref: '#/definitions/OBOffer1' type: array additionalProperties: false Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' required: - Data - Links - Meta additionalProperties: false OBError1: type: object properties: ErrorCode: description: Low level textual error code, e.g., UK.OBIE.Field.Missing type: string minLength: 1 maxLength: 128 Message: description: |- A description of the error that occurred. e.g., 'A mandatory field isn't supplied' or 'RequestedExecutionDateTime must be in future' OBIE doesn't standardise this field type: string minLength: 1 maxLength: 500 Path: description: Recommended but optional reference to the JSON Path of the field with error, e.g., Data.Initiation.InstructedAmount.Currency type: string minLength: 1 maxLength: 500 Url: description: URL to help remediate the problem, or provide more information, or to API Reference, or help etc type: string required: - ErrorCode - Message additionalProperties: false minProperties: 1 OBErrorResponse1: description: An array of detail error codes, and messages, and URLs to documentation to help remediation. type: object properties: Code: description: High level textual error code, to help categorize the errors. type: string minLength: 1 maxLength: 40 Id: description: A unique reference for the error instance, for audit purposes, in case of unknown/unclassified errors. type: string minLength: 1 maxLength: 40 Message: description: Brief Error message, e.g., 'There is something wrong with the request parameters provided' type: string minLength: 1 maxLength: 500 Errors: items: $ref: '#/definitions/OBError1' type: array minItems: 1 required: - Code - Message - Errors additionalProperties: false ISODateTime: description: |- All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00 type: string format: date-time OBReadStatement1: type: object properties: Data: type: object properties: Statement: items: $ref: '#/definitions/OBStatement1' type: array description: Provides further details on a statement resource. additionalProperties: false Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' required: - Data - Links - Meta additionalProperties: false OBStatement1: description: Provides further details on a statement resource. type: object properties: AccountId: $ref: '#/definitions/AccountId' StatementId: description: Unique identifier for the statement resource within an servicing institution. This identifier is both unique and immutable. type: string minLength: 1 maxLength: 40 StatementReference: description: Unique reference for the statement. This reference may be optionally populated if available. type: string minLength: 1 maxLength: 35 Type: $ref: '#/definitions/OBExternalStatementType1Code' StartDateTime: description: 'Date and time at which the statement period starts. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00' type: string format: date-time EndDateTime: description: 'Date and time at which the statement period ends. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00' type: string format: date-time CreationDateTime: description: 'Date and time at which the resource was created. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00' type: string format: date-time StatementDescription: items: type: string minLength: 1 maxLength: 500 type: array description: Other descriptions that may be available for the statement resource. StatementBenefit: items: $ref: '#/definitions/OBStatementBenefit1' type: array description: Set of elements used to provide details of a benefit or reward amount for the statement resource. StatementFee: items: $ref: '#/definitions/OBStatementFee1' type: array description: Set of elements used to provide details of a fee for the statement resource. StatementInterest: items: $ref: '#/definitions/OBStatementInterest1' type: array description: Set of elements used to provide details of a generic interest amount related to the statement resource. StatementDateTime: items: $ref: '#/definitions/OBStatementDateTime1' type: array description: Set of elements used to provide details of a generic date time for the statement resource. StatementRate: items: $ref: '#/definitions/OBStatementRate1' type: array description: Set of elements used to provide details of a generic rate related to the statement resource. StatementValue: items: $ref: '#/definitions/OBStatementValue1' type: array description: Set of elements used to provide details of a generic number value related to the statement resource. StatementAmount: items: $ref: '#/definitions/OBStatementAmount1' type: array description: Set of elements used to provide details of a generic amount for the statement resource. required: - AccountId - Type - StartDateTime - EndDateTime - CreationDateTime additionalProperties: false OBReadParty3: type: object required: - Data properties: Data: type: object properties: Party: type: array items: $ref: '#/definitions/OBParty2' Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' additionalProperties: false OBReadParty2: type: object required: - Data properties: Data: type: object properties: Party: $ref: '#/definitions/OBParty2' Links: $ref: '#/definitions/Links' Meta: $ref: '#/definitions/Meta' additionalProperties: false OBParty2: type: object required: - PartyId properties: PartyId: $ref: '#/definitions/PartyId' PartyNumber: $ref: '#/definitions/PartyNumber' PartyType: $ref: '#/definitions/OBExternalPartyType1Code' Name: $ref: '#/definitions/Name_3' FullLegalName: $ref: '#/definitions/FullLegalName' LegalStructure: $ref: '#/definitions/OBExternalLegalStructureType1Code' BeneficialOwnership: type: boolean AccountRole: $ref: '#/definitions/OBExternalAccountRole1Code' EmailAddress: $ref: '#/definitions/EmailAddress' Phone: $ref: '#/definitions/PhoneNumber_0' Mobile: $ref: '#/definitions/PhoneNumber_1' Relationships: $ref: '#/definitions/OBPartyRelationships1' additionalProperties: false PartyId: description: A unique and immutable identifier used to identify the customer resource. This identifier has no meaning to the account owner. type: string minLength: 1 maxLength: 40 PartyNumber: description: Number assigned by an agent to identify its customer. type: string minLength: 1 maxLength: 35 OBExternalPartyType1Code: description: Party type, in a coded form. type: string enum: - Delegate - Joint - Sole Name_3: description: Name by which a party is known and which is usually used to identify that party. type: string minLength: 1 maxLength: 350 FullLegalName: description: Specifies a character string with a maximum length of 350 characters. type: string minLength: 1 maxLength: 350 OBExternalLegalStructureType1Code: description: Legal standing of the party. type: string x-namespaced-enum: - UK.OBIE.CIC - UK.OBIE.CIO - UK.OBIE.Charity - UK.OBIE.CoOp - UK.OBIE.GeneralPartnership - UK.OBIE.Individual - UK.OBIE.LimitedLiabilityPartnership - UK.OBIE.LimitedPartnership - UK.OBIE.PrivateLimitedCompany - UK.OBIE.PublicLimitedCompany - UK.OBIE.ScottishLimitedPartnership - UK.OBIE.Sole OBExternalAccountRole1Code: description: A party???s role with respect to the related account. type: string x-namespaced-enum: - UK.OBIE.Administrator - UK.OBIE.Beneficiary - UK.OBIE.CustodianForMinor - UK.OBIE.Granter - UK.OBIE.LegalGuardian - UK.OBIE.OtherParty - UK.OBIE.PowerOfAttorney - UK.OBIE.Principal - UK.OBIE.Protector - UK.OBIE.RegisteredShareholderName - UK.OBIE.SecondaryOwner - UK.OBIE.SeniorManagingOfficial - UK.OBIE.Settlor - UK.OBIE.SuccessorOnDeath EmailAddress: description: Address for electronic mail (e-mail). type: string minLength: 1 maxLength: 256 PhoneNumber_0: description: Collection of information that identifies a phone number, as defined by telecom services. type: string pattern: \+[0-9]{1,3}-[0-9()+\-]{1,30} PhoneNumber_1: description: Collection of information that identifies a mobile phone number, as defined by telecom services. type: string pattern: \+[0-9]{1,3}-[0-9()+\-]{1,30} CountryCode: description: Nation with its own government, occupying a particular territory. type: string pattern: ^[A-Z]{2,2}$ OBPartyRelationships1: type: object description: The Party's relationships with other resources. properties: Account: type: object required: - Related - Id description: Relationship to the Account resource. properties: Related: description: Absolute URI to the related resource. type: string format: uri Id: description: Unique identification as assigned by the ASPSP to uniquely identify the related resource. type: string minLength: 1 maxLength: 40 OBExternalStatementType1Code: description: Statement type, in a coded form. type: string enum: - AccountClosure - AccountOpening - Annual - Interim - RegularPeriodic OBStatementBenefit1: description: Set of elements used to provide details of a benefit or reward amount for the statement resource. type: object properties: Type: $ref: '#/definitions/OBExternalStatementBenefitType1Code' Amount: $ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount' required: - Type - Amount additionalProperties: false OBStatementFee1: description: Set of elements used to provide details of a fee for the statement resource. type: object properties: CreditDebitIndicator: type: string enum: - Credit - Debit description: "Indicates whether the amount is a credit or a debit. \nUsage: A zero amount is considered to be a credit amount." Type: $ref: '#/definitions/OBExternalStatementFeeType1Code' Amount: $ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount' required: - CreditDebitIndicator - Type - Amount additionalProperties: false OBStatementInterest1: description: Set of elements used to provide details of a generic interest amount related to the statement resource. type: object properties: CreditDebitIndicator: type: string enum: - Credit - Debit description: "Indicates whether the amount is a credit or a debit. \nUsage: A zero amount is considered to be a credit amount." Type: $ref: '#/definitions/OBExternalStatementInterestType1Code' Amount: $ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount' required: - CreditDebitIndicator - Type - Amount additionalProperties: false OBStatementDateTime1: description: Set of elements used to provide details of a generic date time for the statement resource. type: object properties: DateTime: description: 'Date and time associated with the date time type. All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00' type: string format: date-time Type: $ref: '#/definitions/OBExternalStatementDateTimeType1Code' required: - DateTime - Type additionalProperties: false OBStatementRate1: description: Set of elements used to provide details of a generic rate related to the statement resource. type: object properties: Rate: description: Rate associated with the statement rate type. type: string minLength: 1 maxLength: 10 pattern: ^(-?\d{1,3}){1}(\.\d{1,4}){0,1}$ Type: $ref: '#/definitions/OBExternalStatementRateType1Code' required: - Rate - Type additionalProperties: false OBStatementValue1: description: Set of elements used to provide details of a generic number value related to the statement resource. type: object properties: Value: description: Value associated with the statement value type. type: integer format: int32 Type: $ref: '#/definitions/OBExternalStatementValueType1Code' required: - Value - Type additionalProperties: false OBStatementAmount1: description: Set of elements used to provide details of a generic amount for the statement resource. type: object properties: CreditDebitIndicator: type: string enum: - Credit - Debit description: "Indicates whether the amount is a credit or a debit. \nUsage: A zero amount is considered to be a credit amount." Type: $ref: '#/definitions/OBExternalStatementAmountType1Code' Amount: $ref: '#/definitions/OBActiveOrHistoricCurrencyAndAmount' required: - CreditDebitIndicator - Type - Amount additionalProperties: false OBExternalStatementBenefitType1Code: description: Benefit type, in a coded form. type: string example: - UK.OBIE.Cashback - UK.OBIE.Insurance - UK.OBIE.TravelDiscount - UK.OBIE.TravelInsurance minLength: 1 maxLength: 40 OBExternalStatementFeeType1Code: description: Fee type, in a coded form. type: string example: - UK.OBIE.Annual - UK.OBIE.BalanceTransfer - UK.OBIE.CashAdvance - UK.OBIE.CashTransaction - UK.OBIE.ForeignCashTransaction - UK.OBIE.ForeignTransaction - UK.OBIE.Gambling - UK.OBIE.LatePayment - UK.OBIE.MoneyTransfer - UK.OBIE.Monthly - UK.OBIE.Overlimit - UK.OBIE.PostalOrder - UK.OBIE.PrizeEntry - UK.OBIE.StatementCopy - UK.OBIE.Total minLength: 1 maxLength: 40 OBExternalStatementInterestType1Code: description: Interest amount type, in a coded form. type: string example: - UK.OBIE.BalanceTransfer - UK.OBIE.Cash - UK.OBIE.EstimatedNext - UK.OBIE.Purchase - UK.OBIE.Total minLength: 1 maxLength: 40 OBExternalStatementDateTimeType1Code: description: Date time type, in a coded form. type: string example: - UK.OBIE.BalanceTransferPromoEnd - UK.OBIE.DirectDebitDue - UK.OBIE.LastPayment - UK.OBIE.LastStatement - UK.OBIE.NextStatement - UK.OBIE.PaymentDue - UK.OBIE.PurchasePromoEnd - UK.OBIE.StatementAvailable minLength: 1 maxLength: 40 OBExternalStatementRateType1Code: description: Statement rate type, in a coded form. type: string example: - UK.OBIE.AnnualBalanceTransfer - UK.OBIE.AnnualBalanceTransferAfterPromo - UK.OBIE.AnnualBalanceTransferPromo - UK.OBIE.AnnualCash - UK.OBIE.AnnualPurchase - UK.OBIE.AnnualPurchaseAfterPromo - UK.OBIE.AnnualPurchasePromo - UK.OBIE.MonthlyBalanceTransfer - UK.OBIE.MonthlyCash - UK.OBIE.MonthlyPurchase minLength: 1 maxLength: 40 OBExternalStatementValueType1Code: description: Statement value type, in a coded form. type: string example: - UK.OBIE.AirMilesPoints - UK.OBIE.AirMilesPointsBalance - UK.OBIE.Credits - UK.OBIE.Debits - UK.OBIE.HotelPoints - UK.OBIE.HotelPointsBalance - UK.OBIE.RetailShoppingPoints - UK.OBIE.RetailShoppingPointsBalance minLength: 1 maxLength: 40 OBExternalStatementAmountType1Code: description: Amount type, in a coded form. type: string example: - UK.OBIE.ArrearsClosingBalance - UK.OBIE.AvailableBalance - UK.OBIE.AverageBalanceWhenInCredit - UK.OBIE.AverageBalanceWhenInDebit - UK.OBIE.AverageDailyBalance - UK.OBIE.BalanceTransferClosingBalance - UK.OBIE.CashClosingBalance - UK.OBIE.ClosingBalance - UK.OBIE.CreditLimit - UK.OBIE.CurrentPayment - UK.OBIE.DirectDebitPaymentDue - UK.OBIE.FSCSInsurance - UK.OBIE.MinimumPaymentDue - UK.OBIE.PendingTransactionsBalance - UK.OBIE.PreviousClosingBalance - UK.OBIE.PreviousPayment - UK.OBIE.PurchaseClosingBalance - UK.OBIE.StartingBalance - UK.OBIE.TotalAdjustments - UK.OBIE.TotalCashAdvances - UK.OBIE.TotalCharges - UK.OBIE.TotalCredits - UK.OBIE.TotalDebits - UK.OBIE.TotalPurchases minLength: 1 maxLength: 40 Links: type: object description: Links relevant to the payload properties: Self: type: string format: uri First: type: string format: uri Prev: type: string format: uri Next: type: string format: uri Last: type: string format: uri additionalProperties: false required: - Self Meta: title: MetaData type: object description: Meta Data relevant to the payload properties: TotalPages: type: integer format: int32 FirstAvailableDateTime: $ref: '#/definitions/ISODateTime' LastAvailableDateTime: $ref: '#/definitions/ISODateTime' additionalProperties: false OBRisk2: description: The Risk section is sent by the initiating party to the ASPSP. It is used to specify additional details for risk scoring for Account Info. type: object additionalProperties: false x-ibm-configuration: enforced: true testable: true phase: realized x-ibm-endpoints: - endpointUrl: https://secure-api.lloydsbank.com/prod01/lbg type: - production - endpointUrl: https://secure-api-eidas.halifax.co.uk/prod01/lbg type: - production - endpointUrl: https://secure-api-eidas.bankofscotland.co.uk/prod01/lbg type: - production - endpointUrl: https://secure-api.mbna.co.uk/prod01/lbg type: - production - endpointUrl: https://secure-api.halifax.co.uk/prod01/lbg type: - production - endpointUrl: https://secure-api.bankofscotland.co.uk/prod01/lbg type: - production - endpointUrl: https://secure-api-eidas.mbna.co.uk/prod01/lbg type: - production - endpointUrl: https://secure-api-eidas.lloydsbank.com/prod01/lbg type: - production ...