Module enums

Source

Expand description

Enums live here

Enums§

AchDetailsAccountType: A type of bank account performing a transfer for payment.
ApplicationDetailsExternalSquareProduct: A list of products to return to external callers.
BankAccountPaymentDetailsAccountOwnershipType: An ownership type of a bank account performing a transfer for payment.
BankAccountPaymentDetailsTransferType: A type of bank transfer
CardBrand: Indicates a card’s brand, such as VISA or MASTERCARD.
CardPaymentDetailsAvsStatus: Status code returned from the Address Verification System (AVS) check.
CardPaymentDetailsCvvStatus: Status code returned from the Card Verification Value (CVV) check.
CardPaymentDetailsEntryMethod: Method used to enter a card’s details for payment.
CardPaymentDetailsStatus: Card payment state.
CardPaymentDetailsVerificationMethod: Method to verify cardholder’s identity.
CardPaymentDetailsVerificationResult: Results of cardholder verification.
CardPrepaidType: Indicates a card’s prepaid type, such as NOT_PREPAID or PREPAID.
CardSquareProduct: Model for CardSquareProduct enum
CardType: Indicates a card’s type, such as CREDIT or DEBIT.
CatalogCustomAttributeDefinitionAppVisibility: Defines the visibility of a custom attribute to applications other than their creating application.
CatalogCustomAttributeDefinitionSellerVisibility: Defines the visibility of a custom attribute to sellers in Square client applications, Square APIs or in Square UIs (including Square Point of Sale applications and Square Dashboard).
CatalogCustomAttributeDefinitionType: Defines the possible types for a custom attribute.
CatalogDiscountModifyTaxBasis: Indicates whether this discount should reduce the price used to calculate tax.
CatalogDiscountType: How to apply a CatalogDiscount to a CatalogItem.
CatalogItemProductType: The type of a CatalogItem.
CatalogModifierListSelectionType: Indicates whether a CatalogModifierList supports multiple selections.
CatalogObjectType: Possible types of CatalogObjects returned from the catalog, each containing type-specific properties in the *_data field corresponding to the specfied object type.
CatalogPricingType: Indicates whether the price of a CatalogItemVariation should be entered manually at the time of sale.
CatalogQuickAmountType: Determines the type of a specific Quick Amount.
CatalogQuickAmountsSettingsOption: Determines a seller’s option on Quick Amounts feature.
ChangeTiming: Supported timings when a pending change, as an action, takes place to a subscription.
Country: Indicates the country associated with another entity, such as a business.
Currency: Indicates the associated currency for an amount of money.
CustomerCreationSource: Indicates the method used to create the customer profile.
CustomerCreationSourceRule: The rule to include or exclude a certain set of values.
DayOfWeek: Indicates the specific day of the week.
ErrorCategory: Indicates which high-level category of error has occurred during a request to the Connect API.
ErrorCode: Indicates which high-level category of error has occurred during a request to the Connect API.
ExcludeStrategy: Indicates which products matched by a CatalogPricingRule will be excluded if the pricing rule uses an exclude set.
ExternalPaymentType: The type of external payment the seller received.
GiftCardActivityRedeemStatus: Indicates the status of a gift card redemption.
GiftCardActivityType: Indicates the type of the gift card activity.
GiftCardGANSource: Indicates the source that generated the gift card account number (GAN).
GiftCardStatus: Indicates the gift card state.
GiftCardType: Indicates the gift card type.
InventoryAlertType: Indicates whether Square should alert the merchant when the inventory quantity of a CatalogItemVariation is low.
InventoryChangeType: Indicates how the inventory change is applied.
InventoryState: A type of state for the related quantity of items
InvoiceAutomaticPaymentSource: Indicates the automatic payment method for an invoice payment request.
InvoiceCustomFieldPlacement: Indicates where to render a custom field on the Square-hosted invoice page and in emailed or PDF copies of the invoice.
InvoiceDeliveryMethod: Indicates how Square delivers the [Invoice] to the customer.
InvoicePaymentReminderStatus: The status of a payment request reminder.
InvoiceRequestMethod
InvoiceRequestType: Indicates the type of the payment request.
InvoiceSortField: Indicates the status of an invoice.
InvoiceStatus: Indicates the status of an invoice.
JobAssignmentPayType: Enumerates the possible pay types that a job can be assigned.
Language: A language in BCP 47 format. For more information, see Location language code.
LocationCapability: The capabilities a location might have.
LocationStatus: A location’s status.
LocationType: A location’s type.
MeasurementUnitArea: Unit of area used to measure a quantity.
MeasurementUnitGeneric: Reserved for API integrations that lack the ability to specify a real measurement unit.
MeasurementUnitLength: The unit of length used to measure a quantity.
MeasurementUnitTime: Unit of time used to measure a quantity (a duration).
MeasurementUnitUnitType: Describes the type of this unit and indicates which field contains the unit information.
MeasurementUnitVolume: The unit of volume used to measure a quantity.
MeasurementUnitWeight: Unit of weight used to measure a quantity.
OrderFulfillmentDeliveryDetailsScheduleType: The schedule type of the delivery fulfillment.
OrderFulfillmentFulfillmentLineItemApplication: The line_item_application describes what order line items this fulfillment applies to.
OrderFulfillmentPickupDetailsScheduleType: The schedule type of the pickup fulfillment.
OrderFulfillmentState: The current state of this fulfillment.
OrderFulfillmentType: The type of fulfillment.
OrderLineItemDiscountScope: Indicates whether this is a line-item or order-level discount.
OrderLineItemDiscountType: Indicates how the discount is applied to the associated line item or order.
OrderLineItemItemType: Represents the line item type.
OrderLineItemTaxScope: Indicates whether this is a line-item or order-level tax.
OrderLineItemTaxType: Indicates how the tax is applied to the associated line item or order.
OrderServiceChargeCalculationPhase: Represents a phase in the process of calculating order totals.
OrderServiceChargeType: The type of the service charge.
OrderState: The state of the order.
PaymentCapability: Actions that can be performed on a [Payment]
PaymentDelayAction: Actions that can be applied to [Payment]s when the delay_duration has elapsed.
PaymentRefundStatus: Indicates a refund’s current status.
PaymentSourceType: Sources from which [Payment]s can be taken.
PaymentStatus: The status of a [Payment]
ProcessingFeeType: The type of fee assessed or adjusted.
Product: Indicates the Square product used to generate an inventory change.
RefundStatus: Indicates a refund’s current status.
RegisterDomainResponseStatus: The status of the domain registration.
RiskEvaluationRiskLevel: The risk level associated with a payment.
SearchCatalogItemsRequestStockLevel: Defines supported stock levels of the item inventory.
SearchOrdersSortField: Reserved for API integrations that lack the ability to specify a real measurement unit.
SortCustomersField: Use one or more customer attributes as the sort key to sort searched customer profiles. For example, use the creation date (created_at) of customers or default attributes as the sort key.
SortOrder: The order (e.g., chronological or alphabetical) in which results from a request are returned.
SubscriptionActionType: Supported types of an action as a pending change to a subscription.
SubscriptionCadence: Determines the billing cadence of a [Subscription]
SubscriptionEventInfoCode: Supported info codes of a subscription event.
SubscriptionEventSubscriptionEventType: Supported types of an event occurred to a subscription.
SubscriptionStatus: Supported subscription statuses.
TaxCalculationPhase: When to calculate the taxes due on a cart.
TaxInclusionType: Whether to the tax amount should be additional to or included in the CatalogItem price.
TeamMemberAssignedLocationsAssignmentType: Enumerates the possible assignment types that the team member can have.
TeamMemberStatus: Enumerates the possible statuses the team member can have within a business.
TenderCardDetailsEntryMethod: Indicates the method used to enter the card’s details.
TenderCardDetailsStatus: Indicates the card transaction’s current status.
TenderType: Indicates a tender’s type.
Timezone: An IANA time zone identifier for a time zone.
TransactionProduct: Indicates the Square product used to process a transaction.

Module enumsCopy item path

Enums§

Module enums