generated: '2026-10-12'
method: derived
generator: derive-vocabulary.py
source:
- openapi/cash-app-add-cash-app-pay-to-your-site-api-openapi.yml
- openapi/cash-app-api-keys-api-openapi.yml
- openapi/cash-app-balances-api-openapi.yml
- openapi/cash-app-billing-agreements-api-openapi.yml
- openapi/cash-app-billing-agreements-deprecated-api-openapi.yml
vocabulary:
  name: Cash App Domain Vocabulary
  description: 'Terms declared by Cash App''s own API contract: its resource groups, objects and enumerations, with the contract''s definitions.
    Derived, not authored.'
  version: '2026-10-12'
  terms:
  - term: CashGrantDetailsStatus
    definition: Describes whether or not this grant can be used to perform the action associated with it. If `ACTIVE`, it can be used to perform
      the action. If `EXPIRED`, it may no longer be used to perform the action due to the current time being past the "expires_at" time. If `CONSUMED`,
      it was already redeemed to perform the action and cannot be used again. If `REVOKED`, the customer or merchant explicitly una
    tags:
    - Enumeration
    source: openapi/cash-app-add-cash-app-pay-to-your-site-api-openapi.yml#/components/schemas/CashGrantDetailsStatus
  - term: CashGrantDetailsCashapp
    definition: 'Object declared by the contract with fields: customerId, cashtag.'
    tags:
    - Object
    source: openapi/cash-app-add-cash-app-pay-to-your-site-api-openapi.yml#/components/schemas/CashGrantDetailsCashapp
  - term: CashGrant
    definition: Describes a grant provided by Cash App.
    tags:
    - Object
    source: openapi/cash-app-add-cash-app-pay-to-your-site-api-openapi.yml#/components/schemas/CashGrant
  - term: CashGrantIntent
    definition: Either ON_FILE or ONE_TIME
    tags:
    - Enumeration
    source: openapi/cash-app-add-cash-app-pay-to-your-site-api-openapi.yml#/components/schemas/CashGrantIntent
  - term: CashGrantType
    definition: CASHAPP for all Cash App Pay transactions
    tags:
    - Enumeration
    source: openapi/cash-app-add-cash-app-pay-to-your-site-api-openapi.yml#/components/schemas/CashGrantType
  - term: CashGrantDetails
    definition: 'Object declared by the contract with fields: status, cashapp, createdAt, updatedAt, expiresAt.'
    tags:
    - Object
    source: openapi/cash-app-add-cash-app-pay-to-your-site-api-openapi.yml#/components/schemas/CashGrantDetails
  - term: apiKeys_retrieve-api-key_Response_200
    definition: 'Object declared by the contract with fields: api_key.'
    tags:
    - Object
    source: openapi/cash-app-api-keys-api-openapi.yml#/components/schemas/apiKeys_retrieve-api-key_Response_200
  - term: ErrorCategory
    definition: The high-level reason the error occurred
    tags:
    - Enumeration
    source: openapi/cash-app-api-keys-api-openapi.yml#/components/schemas/ErrorCategory
  - term: apiKeys_create-api-key_Response_201
    definition: 'Object declared by the contract with fields: api_key, secret.'
    tags:
    - Object
    source: openapi/cash-app-api-keys-api-openapi.yml#/components/schemas/apiKeys_create-api-key_Response_201
  - term: Error
    definition: Represents an error encountered during a request to the API.
    tags:
    - Object
    source: openapi/cash-app-api-keys-api-openapi.yml#/components/schemas/Error
  - term: apiKeys_list-api-keys_Response_200
    definition: 'Object declared by the contract with fields: api_keys, cursor.'
    tags:
    - Object
    source: openapi/cash-app-api-keys-api-openapi.yml#/components/schemas/apiKeys_list-api-keys_Response_200
  - term: apiKeys_delete-api-key_Response_200
    definition: Empty response body
    tags:
    - Object
    source: openapi/cash-app-api-keys-api-openapi.yml#/components/schemas/apiKeys_delete-api-key_Response_200
  - term: IdempotencyKey
    definition: A unique identifier which can be used by Cash App to de-duplicate retries of this request, making it idempotent. Learn more about
      [idempotency](../docs/api/technical-documentation/api-fundamentals/idempotency) in the API.
    tags:
    - Object
    source: openapi/cash-app-api-keys-api-openapi.yml#/components/schemas/IdempotencyKey
  - term: ErrorResponse
    definition: 'Object declared by the contract with fields: errors.'
    tags:
    - Object
    source: openapi/cash-app-api-keys-api-openapi.yml#/components/schemas/ErrorResponse
  - term: ScopesItems
    definition: 'Enumeration declared by the contract with values: PAYMENTS_READ, PAYMENTS_WRITE, PAYOUTS_READ, PAYOUTS_WRITE, REFUNDS_READ, REFUNDS_WRITE,
      DISPUTES_READ, DISPUTES_WRITE, CUSTOMERS_READ, FEE_PLANS_READ, GRANTS_READ, GRANTS_WRITE. (9 more)'
    tags:
    - Enumeration
    source: openapi/cash-app-api-keys-api-openapi.yml#/components/schemas/ScopesItems
  - term: ApiKeysPostRequestBodyContentApplicationJsonSchemaApiKey
    definition: Details about the API key to create.
    tags:
    - Object
    source: openapi/cash-app-api-keys-api-openapi.yml#/components/schemas/ApiKeysPostRequestBodyContentApplicationJsonSchemaApiKey
  - term: ApiKey
    definition: 'Object declared by the contract with fields: id, created_at, expires_at, scopes, reference_id.'
    tags:
    - Object
    source: openapi/cash-app-api-keys-api-openapi.yml#/components/schemas/ApiKey
  - term: Scopes
    definition: 'An array of permissions granted to the API key. Current values: - `API_KEYS_READ`: Permits listing API keys and retrieving individual
      keys. - `API_KEYS_WRITE`: Permits creating and deleting API keys. - `BRANDS_READ`: Permits listing brands and retrieving individual brands.
      - `BRANDS_WRITE`: Permits creating, upserting, and updating brands. - `CUSTOMERS_READ`: Permits listing customers and retrievi'
    tags:
    - Object
    source: openapi/cash-app-api-keys-api-openapi.yml#/components/schemas/Scopes
  - term: Retrieve-balanceRequestNotFoundError
    definition: 'Object declared by the contract with fields: errors.'
    tags:
    - Object
    source: openapi/cash-app-balances-api-openapi.yml#/components/schemas/Retrieve-balanceRequestNotFoundError
  - term: Currency
    definition: 'Indicates the country associated with an entity. Values are from the [ISO-4217 Alpha-3](https://www.iso.org/iso-4217-currency-codes.html)
      specification. Current values: - `USD`: United States Dollar'
    tags:
    - Enumeration
    source: openapi/cash-app-balances-api-openapi.yml#/components/schemas/Currency
  - term: Balances_list-balances_Response_200
    definition: 'Object declared by the contract with fields: balances, cursor.'
    tags:
    - Object
    source: openapi/cash-app-balances-api-openapi.yml#/components/schemas/Balances_list-balances_Response_200
  - term: BalancesGetParametersType
    definition: 'Enumeration declared by the contract with values: CHECKING.'
    tags:
    - Enumeration
    source: openapi/cash-app-balances-api-openapi.yml#/components/schemas/BalancesGetParametersType
  - term: Balances_retrieve-balance_Response_200
    definition: 'Object declared by the contract with fields: balance.'
    tags:
    - Object
    source: openapi/cash-app-balances-api-openapi.yml#/components/schemas/Balances_retrieve-balance_Response_200
  - term: Balance
    definition: 'Object declared by the contract with fields: id, customer_id, type, currency, amount, created_at, updated_at.'
    tags:
    - Object
    source: openapi/cash-app-balances-api-openapi.yml#/components/schemas/Balance
  - term: BalanceType
    definition: The type of balance.
    tags:
    - Enumeration
    source: openapi/cash-app-balances-api-openapi.yml#/components/schemas/BalanceType
  - term: GetBillingAgreementRequest
    definition: Request to retrieve a billing agreement by token
    tags:
    - Object
    source: openapi/cash-app-billing-agreements-api-openapi.yml#/components/schemas/GetBillingAgreementRequest
  - term: Consumer
    definition: The consumer data model is used for gathering essential user information. It captures details such as the individual's first name,
      represented by `givenNames`, and their last name, captured under `surname`. In addition, it stores the user's contact number under `phoneNumber`
      and their email address under `email`. These fields collectively provide contact and identification details for a user.
    tags:
    - Object
    source: openapi/cash-app-billing-agreements-api-openapi.yml#/components/schemas/Consumer
  - term: CreateAgreementRequest
    definition: 'Object declared by the contract with fields: requestId, token, merchantReference.'
    tags:
    - Object
    source: openapi/cash-app-billing-agreements-api-openapi.yml#/components/schemas/CreateAgreementRequest
  - term: BillingAgreementResponse
    definition: Response type for billing agreements
    tags:
    - Object
    source: openapi/cash-app-billing-agreements-api-openapi.yml#/components/schemas/BillingAgreementResponse
  - term: OffersRequest
    definition: Request to retrieve available billing agreement offers
    tags:
    - Object
    source: openapi/cash-app-billing-agreements-api-openapi.yml#/components/schemas/OffersRequest
  - term: BillingAgreementApprovalRequestMerchant
    definition: 'Object declared by the contract with fields: redirectConfirmUrl, redirectCancelUrl, popupOriginUrl, name.'
    tags:
    - Object
    source: openapi/cash-app-billing-agreements-api-openapi.yml#/components/schemas/BillingAgreementApprovalRequestMerchant
  - term: LinkStartResponse
    definition: Response containing the billing agreement link details
    tags:
    - Object
    source: openapi/cash-app-billing-agreements-api-openapi.yml#/components/schemas/LinkStartResponse
  - term: BillingAgreementResponseType
    definition: Type of agreement
    tags:
    - Enumeration
    source: openapi/cash-app-billing-agreements-api-openapi.yml#/components/schemas/BillingAgreementResponseType
  - term: Offer
    definition: Represents an offer with payment details
    tags:
    - Object
    source: openapi/cash-app-billing-agreements-api-openapi.yml#/components/schemas/Offer
  - term: OffersResponse
    definition: Response containing available offers for the consumer
    tags:
    - Object
    source: openapi/cash-app-billing-agreements-api-openapi.yml#/components/schemas/OffersResponse
  - term: LinkStartResponseDeliveryType
    definition: How the verification code was delivered to the consumer
    tags:
    - Enumeration
    source: openapi/cash-app-billing-agreements-api-openapi.yml#/components/schemas/LinkStartResponseDeliveryType
  - term: BillingAgreementAliasRequest
    definition: Request to create an alias for a billing agreement
    tags:
    - Object
    source: openapi/cash-app-billing-agreements-api-openapi.yml#/components/schemas/BillingAgreementAliasRequest
  - term: BillingAgreementApprovalRequest
    definition: Request body for initiating a billing agreement approval process
    tags:
    - Object
    source: openapi/cash-app-billing-agreements-api-openapi.yml#/components/schemas/BillingAgreementApprovalRequest
  - term: BillingAgreementApprovalResponse
    definition: Response from initiating a billing agreement approval process
    tags:
    - Object
    source: openapi/cash-app-billing-agreements-api-openapi.yml#/components/schemas/BillingAgreementApprovalResponse
  - term: AgreementEventResponseStatus
    definition: Status of the agreement at the time of the event
    tags:
    - Enumeration
    source: openapi/cash-app-billing-agreements-api-openapi.yml#/components/schemas/AgreementEventResponseStatus
  - term: BillingAgreementResponseStatus
    definition: Current status of the agreement
    tags:
    - Enumeration
    source: openapi/cash-app-billing-agreements-api-openapi.yml#/components/schemas/BillingAgreementResponseStatus
  - term: PaymentSchedule
    definition: Represents a scheduled payment installment
    tags:
    - Object
    source: openapi/cash-app-billing-agreements-api-openapi.yml#/components/schemas/PaymentSchedule
  - term: BillingAgreementAliasResponse
    definition: Response containing the payment schedule token and its expiry
    tags:
    - Object
    source: openapi/cash-app-billing-agreements-api-openapi.yml#/components/schemas/BillingAgreementAliasResponse
  - term: AgreementEventResponse
    definition: Response type for agreement events
    tags:
    - Object
    source: openapi/cash-app-billing-agreements-api-openapi.yml#/components/schemas/AgreementEventResponse
  - term: AgreementEventResponseType
    definition: Type of event
    tags:
    - Enumeration
    source: openapi/cash-app-billing-agreements-api-openapi.yml#/components/schemas/AgreementEventResponseType
  - term: LinkStartRequest
    definition: Request to start a billing agreement link flow
    tags:
    - Object
    source: openapi/cash-app-billing-agreements-api-openapi.yml#/components/schemas/LinkStartRequest
  - term: Money
    definition: Object containing amount and currency
    tags:
    - Object
    source: openapi/cash-app-billing-agreements-api-openapi.yml#/components/schemas/Money
  - term: ConsumerOffers
    definition: Consumer offers
    tags:
    - Object
    source: openapi/cash-app-billing-agreements-api-openapi.yml#/components/schemas/ConsumerOffers
  - term: ConsumerOffersNoPaymentUpfront
    definition: Information about the no payment upfront feature eligibility
    tags:
    - Object
    source: openapi/cash-app-billing-agreements-api-openapi.yml#/components/schemas/ConsumerOffersNoPaymentUpfront
  - term: AgreementApprovalType
    definition: Agreement Type for approval.
    tags:
    - Enumeration
    source: openapi/cash-app-billing-agreements-api-openapi.yml#/components/schemas/AgreementApprovalType
  - term: CancelBillingAgreementRequest
    definition: Request to cancel a billing agreement
    tags:
    - Object
    source: openapi/cash-app-billing-agreements-api-openapi.yml#/components/schemas/CancelBillingAgreementRequest
  - term: AgreementApproval
    definition: Details about the agreement to be created.
    tags:
    - Object
    source: openapi/cash-app-billing-agreements-api-openapi.yml#/components/schemas/AgreementApproval
  - term: OfferType
    definition: Type of the offer
    tags:
    - Enumeration
    source: openapi/cash-app-billing-agreements-api-openapi.yml#/components/schemas/OfferType
  - term: MoneyCurrency
    definition: 'Enumeration declared by the contract with values: AUD, NZD, USD, CAD, GBP.'
    tags:
    - Enumeration
    source: openapi/cash-app-billing-agreements-api-openapi.yml#/components/schemas/MoneyCurrency
  - term: WebhooksAgreementStatusUpdatedPayloadContentApplicationJsonSchemaStatus
    definition: Current status of the agreement
    tags:
    - Enumeration
    source: openapi/cash-app-billing-agreements-deprecated-api-openapi.yml#/components/schemas/WebhooksAgreementStatusUpdatedPayloadContentApplicationJsonSchemaStatus
  - term: Brands_list-brands_Response_200
    definition: 'Object declared by the contract with fields: brands, cursor.'
    tags:
    - Object
    source: openapi/cash-app-brands-api-openapi.yml#/components/schemas/Brands_list-brands_Response_200
  - term: Brands_update-brand_Response_200
    definition: 'Object declared by the contract with fields: brand.'
    tags:
    - Object
    source: openapi/cash-app-brands-api-openapi.yml#/components/schemas/Brands_update-brand_Response_200
  - term: BrandsPutRequestBodyContentApplicationJsonSchemaBrand
    definition: Details about the brand to create or update.
    tags:
    - Object
    source: openapi/cash-app-brands-api-openapi.yml#/components/schemas/BrandsPutRequestBodyContentApplicationJsonSchemaBrand
  - term: Brand
    definition: A brand is the entity a customer perceives that they are transacting with.
    tags:
    - Object
    source: openapi/cash-app-brands-api-openapi.yml#/components/schemas/Brand
  - term: BrandsBrandIdPatchRequestBodyContentApplicationJsonSchemaBrand
    definition: Details about the brand to update
    tags:
    - Object
    source: openapi/cash-app-brands-api-openapi.yml#/components/schemas/BrandsBrandIdPatchRequestBodyContentApplicationJsonSchemaBrand
  - term: BrandsPostRequestBodyContentApplicationJsonSchemaBrand
    definition: Details about the brand to create.
    tags:
    - Object
    source: openapi/cash-app-brands-api-openapi.yml#/components/schemas/BrandsPostRequestBodyContentApplicationJsonSchemaBrand
  - term: Brands_create-brand_Response_201
    definition: 'Object declared by the contract with fields: brand.'
    tags:
    - Object
    source: openapi/cash-app-brands-api-openapi.yml#/components/schemas/Brands_create-brand_Response_201
  - term: Metadata
    definition: 'Freeform key-value pairs of arbitrary data associated with this resource. Keys and values must be passed as strings and not contain
      any personally identifiable information (PII). Min keys: `0` Max keys: `50` > Note: Nested keys are not supported.'
    tags:
    - Object
    source: openapi/cash-app-brands-api-openapi.yml#/components/schemas/Metadata
  - term: Brands_retrieve-brand_Response_200
    definition: 'Object declared by the contract with fields: brand.'
    tags:
    - Object
    source: openapi/cash-app-brands-api-openapi.yml#/components/schemas/Brands_retrieve-brand_Response_200
  - term: Brands_upsert-brand_Response_200
    definition: 'Object declared by the contract with fields: brand.'
    tags:
    - Object
    source: openapi/cash-app-brands-api-openapi.yml#/components/schemas/Brands_upsert-brand_Response_200
  - term: get-checkout_Response_200
    definition: 'Object declared by the contract with fields: token, expires, redirectCheckoutUrl, amount, consumer, merchantReference, billing,
      shipping, merchant, items, courier, taxAmount. (4 more)'
    tags:
    - Object
    source: openapi/cash-app-checkouts-api-openapi.yml#/components/schemas/get-checkout_Response_200
  - term: Shipping-Courier
    definition: Essential information for tracking a shipment. The `shippedAt` key represents the date and time when the item was shipped. This
      value follows the [ISO 8601 standard format](https://www.iso.org/iso-8601-date-and-time-format.html) for date and time representations.
      The `name` field indicates the courier service employed to handle the shipment (e.g. FEDEX, UPS). For orders that are picked up in-store
    tags:
    - Object
    source: openapi/cash-app-checkouts-api-openapi.yml#/components/schemas/Shipping-Courier
  - term: Checkout-Request
    definition: Individual Checkout
    tags:
    - Object
    source: openapi/cash-app-checkouts-api-openapi.yml#/components/schemas/Checkout-Request
  - term: ShippingCourierPriority
    definition: 'Enumeration declared by the contract with values: STANDARD, EXPRESS.'
    tags:
    - Enumeration
    source: openapi/cash-app-checkouts-api-openapi.yml#/components/schemas/ShippingCourierPriority
  - term: ContactCountryCode
    definition: 'Enumeration declared by the contract with values: AU, NZ, US, CA, GB.'
    tags:
    - Enumeration
    source: openapi/cash-app-checkouts-api-openapi.yml#/components/schemas/ContactCountryCode
  - term: Contact
    definition: This data model is used for storing an individual's contact information. Mandatory fields such as **name**, **line1**, **area1**,
      **region**, **postcode**, and **countryCode** help in capturing vital information about a user's location. The `line2` and `area2` fields
      provide additional space for extended addresses, while `phoneNumber` can be used to store the user's contact number. The `area1`, `a
    tags:
    - Object
    source: openapi/cash-app-checkouts-api-openapi.yml#/components/schemas/Contact
  - term: Discount
    definition: Discount applied to an order
    tags:
    - Object
    source: openapi/cash-app-checkouts-api-openapi.yml#/components/schemas/Discount
  - term: Item
    definition: This data model is used to store crucial product details. The `price.amount` field represents the unit price of the individual
      item. The `quantity` field shows the number of units of the item. The `name` field denotes the name of the product, while `sku` holds the
      Stock Keeping Unit identifier. 100 is the maximum number of item objects in the items array. It is crucial that the `price.amount` repr
    tags:
    - Object
    source: openapi/cash-app-checkouts-api-openapi.yml#/components/schemas/Item
  - term: CheckoutRequestMerchant
    definition: 'Object declared by the contract with fields: redirectConfirmUrl, redirectCancelUrl, popupOriginUrl, name.'
    tags:
    - Object
    source: openapi/cash-app-checkouts-api-openapi.yml#/components/schemas/CheckoutRequestMerchant
  - term: Checkout-Response
    definition: 'Object declared by the contract with fields: token, expires, redirectCheckoutUrl.'
    tags:
    - Object
    source: openapi/cash-app-checkouts-api-openapi.yml#/components/schemas/Checkout-Response
  - term: ConfigurationMappings
    definition: 'Object declared by the contract with fields: name, externalBrandId.'
    tags:
    - Object
    source: openapi/cash-app-configuration-api-openapi.yml#/components/schemas/ConfigurationMappings
  - term: Get-configuration-mappingsRequestUnauthorizedError
    definition: 'Object declared by the contract with fields: errorCode, errorId, message, httpStatusCode.'
    tags:
    - Object
    source: openapi/cash-app-configuration-api-openapi.yml#/components/schemas/Get-configuration-mappingsRequestUnauthorizedError
  - term: MerchantLimitPayByInstallment
    definition: Returned only when `include=paybyinstallment` is requested and pay by installment is configured for the merchant. Contains the
      eligible order amount range for pay by installment.
    tags:
    - Object
    source: openapi/cash-app-configuration-api-openapi.yml#/components/schemas/MerchantLimitPayByInstallment
  - term: Get-configuration-mappingsRequestForbiddenError
    definition: 'Object declared by the contract with fields: errorCode, errorId, message, httpStatusCode.'
    tags:
    - Object
    source: openapi/cash-app-configuration-api-openapi.yml#/components/schemas/Get-configuration-mappingsRequestForbiddenError
  - term: MerchantLimitConsumerLending
    definition: Returned only when `include=consumerlending` is requested. Indicates whether consumer lending is enabled for the merchant's online
      channel and, when enabled, the eligible order amount range.
    tags:
    - Object
    source: openapi/cash-app-configuration-api-openapi.yml#/components/schemas/MerchantLimitConsumerLending