Development
  • Guides
  • API Reference
  • API Explorer
  • SDKs
  • Sample apps
  • System status
Support
  • Developer forums
  • Developer blog
  • YouTube
  • X
More
  • Square Home
  • Square Developer
  • App Marketplace
  • Partner with Square
  • Solutions Partner Program
  • Pricing
  • Sales

© 2026 Square, Inc.

  • Developer terms of service
  • Developer Integration and Marketing Agreement
  • Privacy policy
  • Partnerships
  • Sign In
  • Sign In

Objects

  • ACHDetails

  • AcceptedPaymentMethods

  • Address

  • AfterpayDetails

  • ApplicationDetails

  • AppointmentSegment

  • Availability

  • BankAccount

  • BankAccountPaymentDetails

  • BatchRetrieveInventoryChangesSort

  • Booking

  • BookingCreatorDetails

  • Break

  • BreakType

  • BulkCreateCustomerData

  • BulkDeleteOrderCustomAttributesRequestDeleteCustomAttribute

  • BulkPublishScheduledShiftsData

  • BulkUpdateCustomerData

  • BulkUpsertOrderCustomAttributesRequestUpsertCustomAttribute

  • BusinessAppointmentSettings

  • BusinessBookingProfile

  • BusinessHours

  • BusinessHoursPeriod

  • BuyNowPayLaterDetails

  • Card

  • CardForgottenEventCard

  • CardPaymentDetails

  • CardPaymentTimeline

  • CardSurchargeDetails

  • CashAppDetails

  • CashDrawerDevice

  • CashDrawerShift

  • CashDrawerShiftEvent

  • CashDrawerShiftSummary

  • CashPaymentDetails

  • CatalogAvailabilityPeriod

  • CatalogCategory

  • CatalogCustomAttributeDefinition

  • CatalogCustomAttributeDefinitionNumberConfig

  • CatalogCustomAttributeDefinitionSelectionConfig

  • CatalogCustomAttributeDefinitionSelectionConfigCustomAttributeSelection

  • CatalogCustomAttributeDefinitionStringConfig

  • CatalogCustomAttributeValue

  • CatalogDiscount

  • CatalogEcomSeoData

  • CatalogIdMapping

  • CatalogImage

  • CatalogInfoResponseLimits

  • CatalogItem

  • CatalogItemFoodAndBeverageDetails

  • CatalogItemFoodAndBeverageDetailsDietaryPreference

  • CatalogItemFoodAndBeverageDetailsIngredient

  • CatalogItemModifierListInfo

  • CatalogItemOption

  • CatalogItemOptionForItem

  • CatalogItemOptionValue

  • CatalogItemOptionValueForItemVariation

  • CatalogItemVariation

  • CatalogItemVariationVendorInformation

  • CatalogMeasurementUnit

  • CatalogModifier

  • CatalogModifierList

  • CatalogModifierOverride

  • CatalogObject

  • CatalogObjectBatch

  • CatalogObjectCategory

  • CatalogObjectReference

  • CatalogPricingRule

  • CatalogProductSet

  • CatalogQuery

  • CatalogQueryExact

  • CatalogQueryItemVariationsForItemOptionValues

  • CatalogQueryItemsForItemOptions

  • CatalogQueryItemsForModifierList

  • CatalogQueryItemsForTax

  • CatalogQueryModifiersForChildList

  • CatalogQueryPrefix

  • CatalogQueryRange

  • CatalogQuerySet

  • CatalogQuerySortedAttribute

  • CatalogQueryText

  • CatalogQuickAmount

  • CatalogQuickAmountsSettings

  • CatalogStockConversion

  • CatalogSubscriptionPlan

  • CatalogSubscriptionPlanVariation

  • CatalogTax

  • CatalogTimePeriod

  • CatalogV1Id

  • CatalogVersionUpdatedEventCatalogVersion

  • CategoryPathToRootNode

  • Channel

  • Checkout

  • CheckoutLocationSettings

  • CheckoutLocationSettingsBranding

  • CheckoutLocationSettingsCoupons

  • CheckoutLocationSettingsPolicy

  • CheckoutLocationSettingsTipping

  • CheckoutMerchantSettings

  • CheckoutMerchantSettingsPaymentMethods

  • CheckoutMerchantSettingsPaymentMethodsAfterpayClearpay

  • CheckoutMerchantSettingsPaymentMethodsAfterpayClearpayEligibilityRange

  • CheckoutMerchantSettingsPaymentMethodsPaymentMethod

  • CheckoutOptions

  • ClearpayDetails

  • CollectedData

  • Component

  • ConfirmationDecision

  • ConfirmationOptions

  • Coordinates

  • CreateTransferOrderData

  • CreateTransferOrderLineData

  • CustomAttribute

  • CustomAttributeDefinition

  • CustomAttributeDefinitionEventDataObject

  • CustomAttributeEventDataObject

  • CustomAttributeFilter

  • CustomField

  • Customer

  • CustomerAddressFilter

  • CustomerCreatedEventEventContext

  • CustomerCreatedEventEventContextMerge

  • CustomerCreationSourceFilter

  • CustomerCustomAttributeFilter

  • CustomerCustomAttributeFilterValue

  • CustomerCustomAttributeFilters

  • CustomerDeletedEventEventContext

  • CustomerDeletedEventEventContextMerge

  • CustomerDetails

  • CustomerFilter

  • CustomerGroup

  • CustomerPreferences

  • CustomerQuery

  • CustomerSegment

  • CustomerSort

  • CustomerTaxIds

  • CustomerTextFilter

  • DataCollectionOptions

  • DateRange

  • Destination

  • DestinationDetails

  • DestinationDetailsCardRefundDetails

  • DestinationDetailsCashRefundDetails

  • DestinationDetailsExternalRefundDetails

  • Device

  • DeviceAttributes

  • DeviceCheckoutOptions

  • DeviceCode

  • DeviceComponentDetails

  • DeviceComponentDetailsApplicationDetails

  • DeviceComponentDetailsBatteryDetails

  • DeviceComponentDetailsCardReaderDetails

  • DeviceComponentDetailsEthernetDetails

  • DeviceComponentDetailsMeasurement

  • DeviceComponentDetailsNetworkInterfaceDetails

  • DeviceComponentDetailsWiFiDetails

  • DeviceDetails

  • DeviceMetadata

  • DeviceStatus

  • DigitalWalletDetails

  • Dispute

  • DisputeEvidence

  • DisputeEvidenceFile

  • DisputedPayment

  • ElectronicMoneyDetails

  • Error

  • Event

  • EventMetadata

  • EventTypeMetadata

  • ExternalPaymentDetails

  • FelicaDetails

  • FilterValue

  • FloatNumberRange

  • Fulfillment

  • FulfillmentDeliveryDetails

  • FulfillmentFulfillmentEntry

  • FulfillmentFulfillmentStateNotifications

  • FulfillmentInStoreDetails

  • FulfillmentPickupDetails

  • FulfillmentPickupDetailsCurbsidePickupDetails

  • FulfillmentRecipient

  • FulfillmentShipmentDetails

  • GiftCard

  • GiftCardActivity

  • GiftCardActivityActivate

  • GiftCardActivityAdjustDecrement

  • GiftCardActivityAdjustIncrement

  • GiftCardActivityBlock

  • GiftCardActivityClearBalance

  • GiftCardActivityDeactivate

  • GiftCardActivityImport

  • GiftCardActivityImportReversal

  • GiftCardActivityLoad

  • GiftCardActivityRedeem

  • GiftCardActivityRefund

  • GiftCardActivityTransferBalanceFrom

  • GiftCardActivityTransferBalanceTo

  • GiftCardActivityUnblock

  • GiftCardActivityUnlinkedActivityRefund

  • IncludeOptions

  • IncludedResources

  • InventoryAdjustment

  • InventoryAdjustmentGroup

  • InventoryAdjustmentReason

  • InventoryAdjustmentReasonId

  • InventoryChange

  • InventoryCount

  • InventoryPhysicalCount

  • Invoice

  • InvoiceAcceptedPaymentMethods

  • InvoiceAttachment

  • InvoiceCustomField

  • InvoiceFilter

  • InvoicePaymentReminder

  • InvoiceQuery

  • InvoiceRecipient

  • InvoiceRecipientTaxIds

  • InvoiceSort

  • ItemVariationLocationOverrides

  • Job

  • JobAssignment

  • LightningDetails

  • Location

  • LocationBookingProfile

  • LoyaltyAccount

  • LoyaltyAccountExpiringPointDeadline

  • LoyaltyAccountMapping

  • LoyaltyEvent

  • LoyaltyEventAccumulatePoints

  • LoyaltyEventAccumulatePromotionPoints

  • LoyaltyEventAdjustPoints

  • LoyaltyEventCreateReward

  • LoyaltyEventDateTimeFilter

  • LoyaltyEventDeleteReward

  • LoyaltyEventExpirePoints

  • LoyaltyEventFilter

  • LoyaltyEventLocationFilter

  • LoyaltyEventLoyaltyAccountFilter

  • LoyaltyEventOrderFilter

  • LoyaltyEventOther

  • LoyaltyEventQuery

  • LoyaltyEventRedeemReward

  • LoyaltyEventTypeFilter

  • LoyaltyProgram

  • LoyaltyProgramAccrualRule

  • LoyaltyProgramAccrualRuleCategoryData

  • LoyaltyProgramAccrualRuleItemVariationData

  • LoyaltyProgramAccrualRuleSpendData

  • LoyaltyProgramAccrualRuleVisitData

  • LoyaltyProgramExpirationPolicy

  • LoyaltyProgramRewardTier

  • LoyaltyProgramTerminology

  • LoyaltyPromotion

  • LoyaltyPromotionAvailableTimeData

  • LoyaltyPromotionIncentive

  • LoyaltyPromotionIncentivePointsAdditionData

  • LoyaltyPromotionIncentivePointsMultiplierData

  • LoyaltyPromotionTriggerLimit

  • LoyaltyReward

  • MeasurementUnit

  • MeasurementUnitCustom

  • Merchant

  • ModifierLocationOverrides

  • Money

  • OauthAuthorizationRevokedEventRevocationObject

  • Order

  • OrderCreated

  • OrderCreatedObject

  • OrderEntry

  • OrderFulfillment

  • OrderFulfillmentDeliveryDetails

  • OrderFulfillmentFulfillmentEntry

  • OrderFulfillmentPickupDetails

  • OrderFulfillmentPickupDetailsCurbsidePickupDetails

  • OrderFulfillmentRecipient

  • OrderFulfillmentShipmentDetails

  • OrderFulfillmentUpdated

  • OrderFulfillmentUpdatedObject

  • OrderFulfillmentUpdatedUpdate

  • OrderLineItem

  • OrderLineItemAppliedDiscount

  • OrderLineItemAppliedServiceCharge

  • OrderLineItemAppliedTax

  • OrderLineItemDiscount

  • OrderLineItemModifier

  • OrderLineItemPricingBlocklists

  • OrderLineItemPricingBlocklistsBlockedDiscount

  • OrderLineItemPricingBlocklistsBlockedServiceCharge

  • OrderLineItemPricingBlocklistsBlockedTax

  • OrderLineItemTax

  • OrderMoneyAmounts

  • OrderPricingOptions

  • OrderQuantityUnit

  • OrderReturn

  • OrderReturnDiscount

  • OrderReturnLineItem

  • OrderReturnLineItemModifier

  • OrderReturnServiceCharge

  • OrderReturnTax

  • OrderReturnTip

  • OrderReward

  • OrderRoundingAdjustment

  • OrderServiceCharge

  • OrderSource

  • OrderUpdated

  • OrderUpdatedObject

  • PaginationCursor

  • Payment

  • PaymentBalanceActivityAppFeeRefundDetail

  • PaymentBalanceActivityAppFeeRevenueDetail

  • PaymentBalanceActivityAutomaticSavingsDetail

  • PaymentBalanceActivityAutomaticSavingsReversedDetail

  • PaymentBalanceActivityChargeDetail

  • PaymentBalanceActivityDepositFeeDetail

  • PaymentBalanceActivityDepositFeeReversedDetail

  • PaymentBalanceActivityDisputeDetail

  • PaymentBalanceActivityFeeDetail

  • PaymentBalanceActivityFreeProcessingDetail

  • PaymentBalanceActivityHoldAdjustmentDetail

  • PaymentBalanceActivityOpenDisputeDetail

  • PaymentBalanceActivityOtherAdjustmentDetail

  • PaymentBalanceActivityOtherDetail

  • PaymentBalanceActivityRefundDetail

  • PaymentBalanceActivityReleaseAdjustmentDetail

  • PaymentBalanceActivityReserveHoldDetail

  • PaymentBalanceActivityReserveReleaseDetail

  • PaymentBalanceActivitySquareCapitalPaymentDetail

  • PaymentBalanceActivitySquareCapitalReversedPaymentDetail

  • PaymentBalanceActivitySquarePayrollTransferDetail

  • PaymentBalanceActivitySquarePayrollTransferReversedDetail

  • PaymentBalanceActivityTaxOnFeeDetail

  • PaymentBalanceActivityThirdPartyFeeDetail

  • PaymentBalanceActivityThirdPartyFeeRefundDetail

  • PaymentLink

  • PaymentLinkRelatedResources

  • PaymentOptions

  • PaymentRefund

  • Payout

  • PayoutEntry

  • PayoutFee

  • Phase

  • PhaseInput

  • PrePopulatedData

  • ProcessingFee

  • QrCodeOptions

  • QuantityRatio

  • QuickPay

  • Range

  • ReceiptOptions

  • Reference

  • Refund

  • RiskEvaluation

  • SaveCardOptions

  • ScheduledShift

  • ScheduledShiftDetails

  • ScheduledShiftFilter

  • ScheduledShiftQuery

  • ScheduledShiftSort

  • ScheduledShiftWorkday

  • SearchAvailabilityFilter

  • SearchAvailabilityQuery

  • SearchEventsFilter

  • SearchEventsQuery

  • SearchEventsSort

  • SearchLoyaltyAccountsRequestLoyaltyAccountQuery

  • SearchLoyaltyRewardsRequestLoyaltyRewardQuery

  • SearchOrdersCustomerFilter

  • SearchOrdersDateTimeFilter

  • SearchOrdersFilter

  • SearchOrdersFulfillmentFilter

  • SearchOrdersQuery

  • SearchOrdersSort

  • SearchOrdersSourceFilter

  • SearchOrdersStateFilter

  • SearchSubscriptionsFilter

  • SearchSubscriptionsQuery

  • SearchTeamMembersFilter

  • SearchTeamMembersQuery

  • SearchVendorsRequestFilter

  • SearchVendorsRequestSort

  • SegmentFilter

  • SelectOption

  • SelectOptions

  • ShippingFee

  • SignatureImage

  • SignatureOptions

  • Site

  • Snippet

  • SourceApplication

  • SquareAccountDetails

  • StandardUnitDescription

  • StandardUnitDescriptionGroup

  • Subscription

  • SubscriptionAction

  • SubscriptionEvent

  • SubscriptionEventInfo

  • SubscriptionPhase

  • SubscriptionPricing

  • SubscriptionSource

  • SubscriptionTestResult

  • TaxIds

  • TeamMember

  • TeamMemberAssignedLocations

  • TeamMemberBookingProfile

  • TeamMemberWage

  • Tender

  • TenderBankAccountDetails

  • TenderBuyNowPayLaterDetails

  • TenderCardDetails

  • TenderCashDetails

  • TenderSquareAccountDetails

  • TerminalAction

  • TerminalActionQuery

  • TerminalActionQueryFilter

  • TerminalActionQuerySort

  • TerminalCheckout

  • TerminalCheckoutQuery

  • TerminalCheckoutQueryFilter

  • TerminalCheckoutQuerySort

  • TerminalRefund

  • TerminalRefundQuery

  • TerminalRefundQueryFilter

  • TerminalRefundQuerySort

  • TimeRange

  • Timecard

  • TimecardFilter

  • TimecardQuery

  • TimecardSort

  • TimecardWage

  • TimecardWorkday

  • TipSettings

  • TransferOrder

  • TransferOrderFilter

  • TransferOrderGoodsReceipt

  • TransferOrderGoodsReceiptLineItem

  • TransferOrderLine

  • TransferOrderQuery

  • TransferOrderSort

  • UpdateTransferOrderData

  • UpdateTransferOrderLineData

  • Vendor

  • VendorContact

  • WageSetting

  • WebhookSubscription

  • WorkweekConfig

<- Object

Object

All versions ->

Tender

Represents a tender (i.e., a method of payment) used in a Square transaction.

Link to section

Properties

Link to section

id

string

The tender's unique ID. It is the associated payment ID.

Max Length
192
Link to section

location_id

string

The ID of the transaction's associated location.

Max Length
50
Link to section

transaction_id

string

The ID of the tender's associated transaction.

Max Length
192
Link to section

created_at

string

Read only The timestamp for when the tender was created, in RFC 3339 format.

Examples for January 25th, 2020 6:25:34pm Pacific Standard Time:

UTC: 2020-01-26T02:25:34Z

Pacific Standard Time with UTC offset: 2020-01-25T18:25:34-08:00

Max Length
32
Link to section

note

string

An optional note associated with the tender at the time of payment.

Max Length
500
Link to section

amount_money

The total amount of the tender, including tip_money. If the tender has a payment_id, the total_money of the corresponding Payment will be equal to the amount_money of the tender.

Link to section

tip_money

The tip's amount of the tender.

Link to section

processing_fee_money

The amount of any Square processing fees applied to the tender.

This field is not immediately populated when a new transaction is created. It is usually available after about ten seconds.

Link to section

customer_id

string

If the tender is associated with a customer or represents a customer's card on file, this is the ID of the associated customer.

Max Length
191
Link to section

type

string

Required

The type of tender, such as CARD or CASH.

Link to section

card_details

The details of the card tender.

This value is present only if the value of type is CARD.

Link to section

cash_details

The details of the cash tender.

This value is present only if the value of type is CASH.

Link to section

bank_account_details

The details of the bank account tender.

This value is present only if the value of type is BANK_ACCOUNT.

Link to section

buy_now_pay_later_details

The details of a Buy Now Pay Later tender.

This value is present only if the value of type is BUY_NOW_PAY_LATER.

Link to section

square_account_details

The details of a Square Account tender.

This value is present only if the value of type is SQUARE_ACCOUNT.

Link to section

additional_recipients

Deprecated

Additional recipients (other than the merchant) receiving a portion of this tender. For example, fees assessed on the purchase by a third party integration.

Link to section

payment_id

string

The ID of the Payment that corresponds to this tender. This value is only present for payments created with the v2 Payments API.

Max Length
192