generated: '2026-10-12'
method: derived
generator: derive-vocabulary.py
source:
- openapi/citi-account-notification-api-openapi.yml
- openapi/citi-accounts-api-openapi.yml
- openapi/citi-addonservices-api-openapi.yml
- openapi/citi-authentication-api-openapi.yml
- openapi/citi-authenticationservices-api-openapi.yml
vocabulary:
  name: Citi Domain Vocabulary
  description: 'Terms declared by Citi''s own API contract: its resource groups, objects and enumerations, with the contract''s definitions. Derived,
    not authored.'
  version: '2026-10-12'
  terms:
  - term: Authorization
    definition: Dual Auth Authorization Request and Response
    tags:
    - Resource Group
    source: openapi/citi-authorization-api-openapi.yml
  - term: BankDataSharing
    definition: API services to provide accounts, balances and transactions details.
    tags:
    - Resource Group
    source: openapi/citi-bankdatasharing-api-openapi.yml
  - term: Beneficiary Validation
    definition: Before initiating payment, POST beneficiary validation details to confirm that you are sending to the correct beneficiary.
    tags:
    - Resource Group
    source: openapi/citi-beneficiary-validation-api-openapi.yml
  - term: Blocks & Filters
    definition: API services to provide Block & Filters in an account.
    tags:
    - Resource Group
    source: openapi/citi-blocks-filters-api-openapi.yml
  - term: Certification
    definition: KYC certification submission and retrieval
    tags:
    - Resource Group
    source: openapi/citi-certification-api-openapi.yml
  - term: CobR
    definition: Reúne endpoints destinados a lidar com gerenciamento de cobranças associadas a uma recorrência.
    tags:
    - Resource Group
    source: openapi/citi-cobr-api-openapi.yml
  - term: Consent Management
    definition: API services to create, retrieve, and delete account information consent.
    tags:
    - Resource Group
    source: openapi/citi-consent-management-api-openapi.yml
  - term: Create Dispute request
    definition: Operations related to dispute management
    tags:
    - Resource Group
    source: openapi/citi-create-dispute-request-api-openapi.yml
  - term: Dispute webhook
    definition: Webhook notification to be sent to clients for case status
    tags:
    - Resource Group
    source: openapi/citi-dispute-webhook-api-openapi.yml
  - term: File
    definition: File management
    tags:
    - Resource Group
    source: openapi/citi-file-api-openapi.yml
  - term: FX
    definition: FX Rate Inquiry
    tags:
    - Resource Group
    source: openapi/citi-fx-api-openapi.yml
  - term: FxRateInquiry
    definition: API services to support FX Rate Inquiry
    tags:
    - Resource Group
    source: openapi/citi-fxrateinquiry-api-openapi.yml
  - term: Get Notifications
    definition: Operations for retrieving VCA transaction notifications
    tags:
    - Resource Group
    source: openapi/citi-get-notifications-api-openapi.yml
  - term: Holdings
    definition: Operations related to Holdings
    tags:
    - Resource Group
    source: openapi/citi-holdings-api-openapi.yml
  - term: Investors
    definition: Operations related to Investors
    tags:
    - Resource Group
    source: openapi/citi-investors-api-openapi.yml
  - term: LinkAccount
    definition: Account linkage operations for external payments
    tags:
    - Resource Group
    source: openapi/citi-linkaccount-api-openapi.yml
  - term: Mandate
    definition: Mandate API
    tags:
    - Resource Group
    source: openapi/citi-mandate-api-openapi.yml
  - term: MerchantCreation
    definition: Merchant onboarding and management operations
    tags:
    - Resource Group
    source: openapi/citi-merchantcreation-api-openapi.yml
  - term: Notification
    definition: Dual Auth Notification Request Payload
    tags:
    - Resource Group
    source: openapi/citi-notification-api-openapi.yml
  - term: PayerIdInquiry
    definition: PayerID Inquiry API has an ability to Inquiry API has an ability to inquire statuses of a single payer ID or assignee ID.
    tags:
    - Resource Group
    source: openapi/citi-payeridinquiry-api-openapi.yml
  - term: PayerIdMaintenance
    definition: PayerID Maintenance API has an ability to activate PayerID.
    tags:
    - Resource Group
    source: openapi/citi-payeridmaintenance-api-openapi.yml
  - term: PayerIdReservation
    definition: PayerID Reservations API has an ability to reserve PayerID.
    tags:
    - Resource Group
    source: openapi/citi-payeridreservation-api-openapi.yml
  - term: PayerIdUpdateAccountsandCurrencies
    definition: PayerID Update accounts and currencies API has an ability to update accounts and currency details of the given Payer ID.
    tags:
    - Resource Group
    source: openapi/citi-payeridupdateaccountsandcurrencies-api-openapi.yml
  - term: PayerIdUpdateAssignee
    definition: PayerID Update assignee API has an ability to update, add or remove assignee details of the given Payer ID.
    tags:
    - Resource Group
    source: openapi/citi-payeridupdateassignee-api-openapi.yml
  - term: Payment-Acceptance
    definition: Payment Acceptance API
    tags:
    - Resource Group
    source: openapi/citi-payment-acceptance-api-openapi.yml
  - term: Payment
    definition: Payout and payment query operations
    tags:
    - Resource Group
    source: openapi/citi-payment-api-openapi.yml
  - term: PaymentOrderConsent
    definition: APIs to TPP for payment order consent creation and inquiry.
    tags:
    - Resource Group
    source: openapi/citi-paymentorderconsent-api-openapi.yml
  - term: Pix
    definition: reúne endpoints destinados a lidar com gerenciamento de Pix recebidos.
    tags:
    - Resource Group
    source: openapi/citi-pix-api-openapi.yml
  - term: ProofOfPayment
    definition: APIs for retrieving proof of payment reports.
    tags:
    - Resource Group
    source: openapi/citi-proofofpayment-api-openapi.yml
  - term: Provisioning
    definition: These are operations related to provisioning requests.
    tags:
    - Resource Group
    source: openapi/citi-provisioning-api-openapi.yml
  - term: Push Notifications
    definition: Webhook push notification operations for authorized and clearing transactions
    tags:
    - Resource Group
    source: openapi/citi-push-notifications-api-openapi.yml
  - term: Rec
    definition: Reúne endpoints destinados a lidar com gerenciamento de recorrências.
    tags:
    - Resource Group
    source: openapi/citi-rec-api-openapi.yml
  - term: Refunds
    definition: Refunds API
    tags:
    - Resource Group
    source: openapi/citi-refunds-api-openapi.yml
  - term: Reporting
    definition: Transaction and balance reporting operations
    tags:
    - Resource Group
    source: openapi/citi-reporting-api-openapi.yml
  - term: Request for Information API
    definition: API services to support Request for Information
    tags:
    - Resource Group
    source: openapi/citi-request-for-information-api-api-openapi.yml
  - term: Response to Request for Information API
    definition: API services to support Response to Request for Information
    tags:
    - Resource Group
    source: openapi/citi-response-to-request-for-information-api-api-openapi.yml
  - term: Rfi
    definition: Request for Information operations
    tags:
    - Resource Group
    source: openapi/citi-rfi-api-openapi.yml
  - term: SolicRec
    definition: Reúne endpoints destinados a lidar com gerenciamento de solicitações de recorrências.
    tags:
    - Resource Group
    source: openapi/citi-solicrec-api-openapi.yml
  - term: Statement
    definition: Statement
    tags:
    - Resource Group
    source: openapi/citi-statement-api-openapi.yml
  - term: Statement Services v1
    definition: Statement Services v1
    tags:
    - Resource Group
    source: openapi/citi-statement-services-v1-api-openapi.yml
  - term: Status Enquiry request
    definition: Operations related to dispute status enquiry
    tags:
    - Resource Group
    source: openapi/citi-status-enquiry-request-api-openapi.yml
  - term: submitAction
    definition: Operations related to ETF Order Approval processing
    tags:
    - Resource Group
    source: openapi/citi-submitaction-api-openapi.yml
  - term: submitPlf
    definition: Operations related to ETF basket processing
    tags:
    - Resource Group
    source: openapi/citi-submitplf-api-openapi.yml
  - term: Subscription
    definition: Operations related to event subscriptions
    tags:
    - Resource Group
    source: openapi/citi-subscription-api-openapi.yml
  - term: Tax ID validation
    definition: API to validate taxId status
    tags:
    - Resource Group
    source: openapi/citi-tax-id-validation-api-openapi.yml
  - term: Tokens
    definition: Tokens API
    tags:
    - Resource Group
    source: openapi/citi-tokens-api-openapi.yml
  - term: Transactions
    definition: Operations related to Transactions
    tags:
    - Resource Group
    source: openapi/citi-transactions-api-openapi.yml
  - term: Validations API
    definition: API services to support beneficiary/bank validation initiation
    tags:
    - Resource Group
    source: openapi/citi-validations-api-api-openapi.yml
  - term: Virtual Account Single Entity
    definition: Virtual Account Single Entity
    tags:
    - Resource Group
    source: openapi/citi-virtual-account-single-entity-api-openapi.yml
  - term: Wallet
    definition: Wallet management and balance operations
    tags:
    - Resource Group
    source: openapi/citi-wallet-api-openapi.yml
  - term: Webhook
    definition: Reúne endpoints para gerenciamento de notificações por parte do PSP recebedor ao usuário recebedor.
    tags:
    - Resource Group
    source: openapi/citi-webhook-api-openapi.yml
  - term: WebhookCobR
    definition: Reúne endpoints para gerenciamento de notificações de cobranças recorrentes por parte do PSP recebedor ao usuário recebedor.
    tags:
    - Resource Group
    source: openapi/citi-webhookcobr-api-openapi.yml
  - term: WebhookRec
    definition: Reúne endpoints para gerenciamento de notificações de recorrências por parte do PSP recebedor ao usuário recebedor.
    tags:
    - Resource Group
    source: openapi/citi-webhookrec-api-openapi.yml
  - term: Webhooks
    definition: Operation related to webhook requests.
    tags:
    - Resource Group
    source: openapi/citi-webhooks-api-openapi.yml
  - term: SubscriptionResponse
    definition: 'Object declared by the contract with fields: Info.'
    tags:
    - Object
    source: openapi/citi-account-notification-api-openapi.yml#/components/schemas/SubscriptionResponse
  - term: Error
    definition: 'Object declared by the contract with fields: status, message, correlationId.'
    tags:
    - Object
    source: openapi/citi-account-notification-api-openapi.yml#/components/schemas/Error
  - term: ErrorMessage
    definition: 'Object declared by the contract with fields: httpCode, httpMessage, moreInformation.'
    tags:
    - Object
    source: openapi/citi-account-notification-api-openapi.yml#/components/schemas/ErrorMessage
  - term: SubscriptionReqType
    definition: 'Object declared by the contract with fields: requestType, format, creditDebitIndicator, accountIdentification, branchIdentification,
      fromAmount, toAmount.'
    tags:
    - Object
    source: openapi/citi-account-notification-api-openapi.yml#/components/schemas/SubscriptionReqType
  - term: ResponseCodes400
    definition: 'Object declared by the contract with fields: errors.'
    tags:
    - Object
    source: openapi/citi-accounts-api-openapi.yml#/components/schemas/ResponseCodes400
  - term: AccountBalanceInfo
    definition: 'Object declared by the contract with fields: accountype, limit, currentBalance, outstandingBalance, totalUsage, totalUsagePercentage,
      availableLimit, availableLimitPercentage, currency, temporaryLimitExpiry, permanentLimit, startDate. (1 more)'
    tags:
    - Object
    source: openapi/citi-accounts-api-openapi.yml#/components/schemas/AccountBalanceInfo
  - term: BalInquiryResponse
    definition: 'Object declared by the contract with fields: accountNumber, accountLevel, necessaryAmountAvailableRetail, wtpTierPercentage,
      accountBalanceInfo, wtpTierCode.'
    tags:
    - Object
    source: openapi/citi-accounts-api-openapi.yml#/components/schemas/BalInquiryResponse
  - term: ResponseCode500
    definition: 'Object declared by the contract with fields: errors.'
    tags:
    - Object
    source: openapi/citi-accounts-api-openapi.yml#/components/schemas/ResponseCode500
  - term: ResponseCodes
    definition: 'Object declared by the contract with fields: errorCode, errorDescription.'
    tags:
    - Object
    source: openapi/citi-accounts-api-openapi.yml#/components/schemas/ResponseCodes
  - term: ResponseCode
    definition: 'Object declared by the contract with fields: errorCode, errorDescription.'
    tags:
    - Object
    source: openapi/citi-accounts-api-openapi.yml#/components/schemas/ResponseCode
  - term: BalInquiryRequest
    definition: 'Object declared by the contract with fields: accountNumber, accountLevel, transactionAmount, transactionAmountCurrency.'
    tags:
    - Object
    source: openapi/citi-accounts-api-openapi.yml#/components/schemas/BalInquiryRequest
  - term: StatementResp
    definition: 'Object declared by the contract with fields: startDate, endDate, year, month, currencyCode, baseCurrencyFlag, currentBalance,
      paymentDueDate.'
    tags:
    - Object
    source: openapi/citi-accounts-api-openapi.yml#/components/schemas/StatementResp
  - term: StatementTransactionsInboundRequest
    definition: 'Object declared by the contract with fields: accountNumber, statementCycleStartDate, statementCycleEndDate, currencyCode, languageCode.'
    tags:
    - Object
    source: openapi/citi-accounts-api-openapi.yml#/components/schemas/StatementTransactionsInboundRequest
  - term: AncillaryServiceChargesResp
    definition: 'Object declared by the contract with fields: serviceChargeDescription, serviceChargeAmount.'
    tags:
    - Object
    source: openapi/citi-accounts-api-openapi.yml#/components/schemas/AncillaryServiceChargesResp
  - term: SmryResponse200
    definition: 'Object declared by the contract with fields: errorCode, errorDescription.'
    tags:
    - Object
    source: openapi/citi-accounts-api-openapi.yml#/components/schemas/SmryResponse200
  - term: StatementTransactionsInboundResponse
    definition: 'Object declared by the contract with fields: statementTransactions, errors.'
    tags:
    - Object
    source: openapi/citi-accounts-api-openapi.yml#/components/schemas/StatementTransactionsInboundResponse
  - term: StTxnResponse200
    definition: 'Object declared by the contract with fields: errorCode, errorDescription.'
    tags:
    - Object
    source: openapi/citi-accounts-api-openapi.yml#/components/schemas/StTxnResponse200
  - term: TransactionsResp
    definition: 'Object declared by the contract with fields: unbilledTransactionAmount, transactionPostingCurrencyCode, baseCurrencyFlag, unbilledTransactions.'
    tags:
    - Object
    source: openapi/citi-accounts-api-openapi.yml#/components/schemas/TransactionsResp
  - term: ResponseCodes_2
    definition: 'Object declared by the contract with fields: errorCode, errorDescription.'
    tags:
    - Object
    source: openapi/citi-accounts-api-openapi.yml#/components/schemas/ResponseCodes_2
  - term: ResponseCode_2
    definition: 'Object declared by the contract with fields: errorCode, errorDescription.'
    tags:
    - Object
    source: openapi/citi-accounts-api-openapi.yml#/components/schemas/ResponseCode_2
  - term: TransactionResp
    definition: 'Object declared by the contract with fields: transactionDate, transactionDescription, transactionAmount, ancillaryServiceCharges,
      transactionAmountCurrency, transactionPostingDate, reference, exchangeRate, cardPostingAmount, merchantCity, merchantState, merchantCountry.
      (6 more)'
    tags:
    - Object
    source: openapi/citi-accounts-api-openapi.yml#/components/schemas/TransactionResp
  - term: UnbilledTransactionsInboundRequest
    definition: 'Object declared by the contract with fields: accountNumber, currencyCode, languageCode.'
    tags:
    - Object
    source: openapi/citi-accounts-api-openapi.yml#/components/schemas/UnbilledTransactionsInboundRequest
  - term: UndResponse200
    definition: 'Object declared by the contract with fields: errorCode, errorDescription.'
    tags:
    - Object
    source: openapi/citi-accounts-api-openapi.yml#/components/schemas/UndResponse200
  - term: AccountSummaryInboundRequest
    definition: 'Object declared by the contract with fields: accountNumber.'
    tags:
    - Object
    source: openapi/citi-accounts-api-openapi.yml#/components/schemas/AccountSummaryInboundRequest
  - term: AccountSummaryInboundResponse
    definition: 'Object declared by the contract with fields: statements, errors.'
    tags:
    - Object
    source: openapi/citi-accounts-api-openapi.yml#/components/schemas/AccountSummaryInboundResponse
  - term: UnbilledTransactionsInboundResponse
    definition: 'Object declared by the contract with fields: unbilledTransactionsInfo, lastStatementDate, nextStatement Date, debitCreditIdicatorFlag,
      errors.'
    tags:
    - Object
    source: openapi/citi-accounts-api-openapi.yml#/components/schemas/UnbilledTransactionsInboundResponse