generated: '2026-10-12' method: derived generator: derive-vocabulary.py source: - openapi/barclays-account-access-consents-api-openapi.yml - openapi/barclays-accounts-api-openapi.yml - openapi/barclays-applyproductexternalapi-oas-api-openapi.yml - openapi/barclays-atms-api-openapi.yml - openapi/barclays-balances-api-openapi.yml vocabulary: name: Barclays Domain Vocabulary description: 'Terms declared by Barclays''s own API contract: its resource groups, objects and enumerations, with the contract''s definitions. Derived, not authored.' version: '2026-10-12' terms: - term: Account Access Consents definition: Create Account Access Consents tags: - Resource Group source: openapi/barclays-account-access-consents-api-openapi.yml - term: Accounts definition: Get Accounts tags: - Resource Group source: openapi/barclays-accounts-api-openapi.yml - term: applyProductExternalAPI-OAS definition: Apply Product External API tags: - Resource Group source: openapi/barclays-applyproductexternalapi-oas-api-openapi.yml - term: Balances definition: Get Balances tags: - Resource Group source: openapi/barclays-balances-api-openapi.yml - term: Beneficiaries definition: Get Beneficiaries tags: - Resource Group source: openapi/barclays-beneficiaries-api-openapi.yml - term: card-account-details-inquiry-external-api definition: The card account details inquiry external API is Barclays US’s credit cards acquisitions solution which will orchestrate the Internal API calls providing account information, such as account peek/summary for an account tags: - Resource Group source: openapi/barclays-card-account-details-inquiry-external-api-api-openapi.yml - term: Card Controls API definition: API for locking and unlocking cards and retrieving card lock/unlock status based on account ID with fraud verification. tags: - Resource Group source: openapi/barclays-card-controls-api-api-openapi.yml - term: Cards Activation definition: API for activating cards and retrieving activation status based on account ID with eligibility and fraud verification. tags: - Resource Group source: openapi/barclays-cards-activation-api-openapi.yml - term: Digital Wallet Provision definition: Provisions credit cards to digital wallets with eligibility verification and fraud assessment tags: - Resource Group source: openapi/barclays-digital-wallet-provision-api-openapi.yml - term: Direct Debits definition: Get Direct Debits tags: - Resource Group source: openapi/barclays-direct-debits-api-openapi.yml - term: Domestic Payments definition: Domestic Payments tags: - Resource Group source: openapi/barclays-domestic-payments-api-openapi.yml - term: Domestic Scheduled Payments definition: Domestic Scheduled Payments tags: - Resource Group source: openapi/barclays-domestic-scheduled-payments-api-openapi.yml - term: Domestic Standing Orders definition: Domestic Standing Orders tags: - Resource Group source: openapi/barclays-domestic-standing-orders-api-openapi.yml - term: Domestic VRP Consents definition: Domestic VRP Consents tags: - Resource Group source: openapi/barclays-domestic-vrp-consents-api-openapi.yml - term: Domestic VRPs definition: Domestic VRP tags: - Resource Group source: openapi/barclays-domestic-vrps-api-openapi.yml - term: Event Subscriptions definition: Event Subscriptions tags: - Resource Group source: openapi/barclays-event-subscriptions-api-openapi.yml - term: Events definition: Events tags: - Resource Group source: openapi/barclays-events-api-openapi.yml - term: FCSSRVMBCA definition: Endpoint for getting FCA Business Current Accounts Service Metrics data tags: - Resource Group source: openapi/barclays-fcssrvmbca-api-openapi.yml - term: FCSSRVMPCA definition: Endpoint for getting FCA Personal Current Accounts Service Metrics data tags: - Resource Group source: openapi/barclays-fcssrvmpca-api-openapi.yml - term: File Payments definition: File Payments tags: - Resource Group source: openapi/barclays-file-payments-api-openapi.yml - term: getAuthorizations definition: Authorization transactions operations tags: - Resource Group source: openapi/barclays-getauthorizations-api-openapi.yml - term: International Payments definition: International Payments tags: - Resource Group source: openapi/barclays-international-payments-api-openapi.yml - term: International Scheduled Payments definition: International Scheduled Payments tags: - Resource Group source: openapi/barclays-international-scheduled-payments-api-openapi.yml - term: International Standing Orders definition: International Standing Orders tags: - Resource Group source: openapi/barclays-international-standing-orders-api-openapi.yml - term: key-exchange-fetch-json-web-keys definition: Key Exchange Fetch Operation APIs tags: - Resource Group source: openapi/barclays-key-exchange-fetch-json-web-keys-api-openapi.yml - term: Offers definition: Get Offers tags: - Resource Group source: openapi/barclays-offers-api-openapi.yml - term: Parties definition: Get Parties tags: - Resource Group source: openapi/barclays-parties-api-openapi.yml - term: Payment Details definition: Payment Details tags: - Resource Group source: openapi/barclays-payment-details-api-openapi.yml - term: paymentProductExternalAPI-AutoPay definition: OAS3 External AutoPay APIs tags: - Resource Group source: openapi/barclays-paymentproductexternalapi-autopay-api-openapi.yml - term: paymentProductExternalAPI-ExternalAccount definition: OAS3 External Account APIs tags: - Resource Group source: openapi/barclays-paymentproductexternalapi-externalaccount-api-openapi.yml - term: paymentProductExternalAPI-OneTimePayment definition: OAS3 External Onetime Payment APIs tags: - Resource Group source: openapi/barclays-paymentproductexternalapi-onetimepayment-api-openapi.yml - term: postedTransactionAPI definition: Posted transactions operations tags: - Resource Group source: openapi/barclays-postedtransactionapi-api-openapi.yml - term: Products definition: Get Products tags: - Resource Group source: openapi/barclays-products-api-openapi.yml - term: RewardsEarnHistory definition: Rewards Earn History Details tags: - Resource Group source: openapi/barclays-rewardsearnhistory-api-openapi.yml - term: Scheduled Payments definition: Get Scheduled Payments tags: - Resource Group source: openapi/barclays-scheduled-payments-api-openapi.yml - term: searchOptionsAPI definition: Transaction search options operations tags: - Resource Group source: openapi/barclays-searchoptionsapi-api-openapi.yml - term: Standing Orders definition: Get Standing Orders tags: - Resource Group source: openapi/barclays-standing-orders-api-openapi.yml - term: statementCycleDatesAPI definition: Statement cycle dates operations tags: - Resource Group source: openapi/barclays-statementcycledatesapi-api-openapi.yml - term: Statements definition: Get Statements tags: - Resource Group source: openapi/barclays-statements-api-openapi.yml - term: statements-list definition: Returns list of statements tags: - Resource Group source: openapi/barclays-statements-list-api-openapi.yml - term: Transactions definition: Get Transactions tags: - Resource Group source: openapi/barclays-transactions-api-openapi.yml - term: user-identity-context definition: User identity context API tags: - Resource Group source: openapi/barclays-user-identity-context-api-openapi.yml - term: user-sso-context definition: User sso context API tags: - Resource Group source: openapi/barclays-user-sso-context-api-openapi.yml - term: OBInternalConsentStatus1Code definition: Specifies the status of consent resource in code form. tags: - Enumeration source: openapi/barclays-account-access-consents-api-openapi.yml#/components/schemas/OBInternalConsentStatus1Code - term: Links definition: Links relevant to the payload tags: - Object source: openapi/barclays-account-access-consents-api-openapi.yml#/components/schemas/Links - term: OBStatusReason definition: 'Object declared by the contract with fields: StatusReasonCode, StatusReasonDescription, Path.' tags: - Object source: openapi/barclays-account-access-consents-api-openapi.yml#/components/schemas/OBStatusReason - term: OBErrorResponse1 definition: An array of detail error codes, and messages, and URLs to documentation to help remediation. tags: - Object source: openapi/barclays-account-access-consents-api-openapi.yml#/components/schemas/OBErrorResponse1 - term: OBError1 definition: 'Object declared by the contract with fields: ErrorCode, Message, Path, Url.' tags: - Object source: openapi/barclays-account-access-consents-api-openapi.yml#/components/schemas/OBError1 - term: StatusUpdateDateTime definition: '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' tags: - Object source: openapi/barclays-account-access-consents-api-openapi.yml#/components/schemas/StatusUpdateDateTime - term: OBExternalStatusReason1Code definition: Low level textual error code, for all enum values see `OBExternalStatusReason1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) tags: - Object source: openapi/barclays-account-access-consents-api-openapi.yml#/components/schemas/OBExternalStatusReason1Code - term: MetaData definition: Meta Data relevant to the payload tags: - Object source: openapi/barclays-account-access-consents-api-openapi.yml#/components/schemas/Meta - term: CreationDateTime definition: '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' tags: - Object source: openapi/barclays-account-access-consents-api-openapi.yml#/components/schemas/CreationDateTime - term: OBReadConsent1 definition: 'Object declared by the contract with fields: Data, Risk.' tags: - Object source: openapi/barclays-account-access-consents-api-openapi.yml#/components/schemas/OBReadConsent1 - term: ISODateTime definition: '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' tags: - Object source: openapi/barclays-account-access-consents-api-openapi.yml#/components/schemas/ISODateTime - term: OBReadConsentResponse1 definition: 'Object declared by the contract with fields: Data, Risk, Links, Meta.' tags: - Object source: openapi/barclays-account-access-consents-api-openapi.yml#/components/schemas/OBReadConsentResponse1 - term: OBRisk2 definition: 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. tags: - Object source: openapi/barclays-account-access-consents-api-openapi.yml#/components/schemas/OBRisk2 - term: OBFileFormat definition: For a full list of enumeration values refer to `ExternalDocumentFormat1Code` in *ISO_External_CodeSet* [here](https://github.com/OpenBankingUK/External_internal_CodeSets) tags: - Enumeration source: openapi/barclays-accounts-api-openapi.yml#/components/schemas/OBFileFormat - term: Nickname definition: The nickname of the account, assigned by the account owner in order to provide an additional means of identification of the account. tags: - Object source: openapi/barclays-accounts-api-openapi.yml#/components/schemas/Nickname - term: OBReadAccount6 definition: 'Object declared by the contract with fields: Data, Links, Meta.' tags: - Object source: openapi/barclays-accounts-api-openapi.yml#/components/schemas/OBReadAccount6 - term: OBExternalAccountSubType1Code definition: Specifies the sub type of account (product family group) For a full list of enumeration values refer to `OBExternalCashAccountType1Code` *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) tags: - Enumeration source: openapi/barclays-accounts-api-openapi.yml#/components/schemas/OBExternalAccountSubType1Code - term: AccountId definition: A unique and immutable identifier used to identify the account resource. This identifier has no meaning to the account owner. tags: - Object source: openapi/barclays-accounts-api-openapi.yml#/components/schemas/AccountId - term: CareOf definition: The 'care of' address is used whenever sending mail to a person or organisation who does not actually live or work at the address. They will receive the mail for the individual. tags: - Object source: openapi/barclays-accounts-api-openapi.yml#/components/schemas/CareOf - term: Room definition: Information that locates and identifies a room to form part of an address tags: - Object source: openapi/barclays-accounts-api-openapi.yml#/components/schemas/Room - term: OBInternalAccountStatus1Code definition: Specifies the status of account resource in code form. For a full list of enumeration values refer to `OBInternalAccountStatus1Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) tags: - Enumeration source: openapi/barclays-accounts-api-openapi.yml#/components/schemas/OBInternalAccountStatus1Code - term: OpeningDate definition: '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. All date-time fields in responses must include the timezone. An example is below: 2017-04-05T10:43:07+00:00' tags: - Object source: openapi/barclays-accounts-api-openapi.yml#/components/schemas/OpeningDate - term: Name_0 definition: The account name is the name or names of the account owner(s) represented at an account level, as displayed by the ASPSP's online channels. Note, the account name is not the product name or the nickname of the account. tags: - Object source: openapi/barclays-accounts-api-openapi.yml#/components/schemas/Name_0 - term: OBInternalSwitchStatusCode definition: Specifies the switch status for the account, in a coded form. For a full list of enumeration values refer to `OBInternalSwitchStatusCode` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) tags: - Object source: openapi/barclays-accounts-api-openapi.yml#/components/schemas/OBInternalSwitchStatusCode - term: LEI definition: Legal entity identification as an alternate identification for a party. Legal Entity Identifier is a code allocated to a party as described in ISO 17442 "Financial Services - Legal Entity Identifier (LEI)". tags: - Object source: openapi/barclays-accounts-api-openapi.yml#/components/schemas/LEI - term: OBFrequency2 definition: For a full list of enumeration values refer to `OBFrequency2Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_internal_CodeSets) tags: - Enumeration source: openapi/barclays-accounts-api-openapi.yml#/components/schemas/OBFrequency2 - term: Identification_0 definition: Identification assigned by an institution to identify an account. This identification is known by the account owner. tags: - Object source: openapi/barclays-accounts-api-openapi.yml#/components/schemas/Identification_0 - term: OBInternalAccountIdentification4Code definition: Name of the identification scheme, in a coded form as published in an external list. For a full list of enumeration values refer to `OBInternalAccountIdentification4Code` in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) tags: - Object source: openapi/barclays-accounts-api-openapi.yml#/components/schemas/OBInternalAccountIdentification4Code - term: SecondaryIdentification definition: 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). tags: - Object source: openapi/barclays-accounts-api-openapi.yml#/components/schemas/SecondaryIdentification - term: BuildingNumber definition: Number that identifies the position of a building on a street. tags: - Object source: openapi/barclays-accounts-api-openapi.yml#/components/schemas/BuildingNumber - term: PostBox definition: Information that locates and identifies a box in a post office assigned to a person or organization, where letters for them are kept until called for. tags: - Object source: openapi/barclays-accounts-api-openapi.yml#/components/schemas/PostBox - term: MaturityDate definition: 'Maturity date of the account. 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' tags: - Object source: openapi/barclays-accounts-api-openapi.yml#/components/schemas/MaturityDate - term: TownName definition: Name of a built-up area, with defined boundaries, and a local government. tags: - Object source: openapi/barclays-accounts-api-openapi.yml#/components/schemas/TownName - term: DistrictName definition: Number that of the regional area, known as a district, which forms part of an address tags: - Object source: openapi/barclays-accounts-api-openapi.yml#/components/schemas/DistrictName - term: ActiveOrHistoricCurrencyCode_0 definition: '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.' tags: - Object source: openapi/barclays-accounts-api-openapi.yml#/components/schemas/ActiveOrHistoricCurrencyCode_0 - term: OBBranchAndFinancialInstitutionIdentification5_0 definition: 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. tags: - Object source: openapi/barclays-accounts-api-openapi.yml#/components/schemas/OBBranchAndFinancialInstitutionIdentification5_0 - term: OBInternalAccountType1Code definition: Specifies the type of account (personal or business). For a full list of enumeration values refer to 'OBInternalAccountType1Code' in *OB_Internal_CodeSet* [here](https://github.com/OpenBankingUK/External_Internal_CodeSets) tags: - Enumeration source: openapi/barclays-accounts-api-openapi.yml#/components/schemas/OBInternalAccountType1Code