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 ->

BankAccountPaymentDetails

Additional details about BANK_ACCOUNT type payments.

Link to section

Properties

Link to section

bank_name

string

The name of the bank associated with the bank account.

Max Length
100
Link to section

transfer_type

string

The type of the bank transfer. The type can be ACH or UNKNOWN.

Max Length
50
Link to section

account_ownership_type

string

The ownership type of the bank account performing the transfer. The type can be INDIVIDUAL, COMPANY, or ACCOUNT_TYPE_UNKNOWN.

Max Length
50
Link to section

fingerprint

string

Uniquely identifies the bank account for this seller and can be used to determine if payments are from the same bank account.

Max Length
255
Link to section

country

string

The two-letter ISO code representing the country the bank account is located in.

Min Length
2
Max Length
2
Link to section

statement_description

string

The statement description as sent to the bank.

Max Length
1000
Link to section

ach_details

ACH-specific information about the transfer. The information is only populated if the transfer_type is ACH.

Link to section

errors

Information about errors encountered during the request.