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

CardPaymentDetails

Reflects the current status of a card payment.

Contains only non-confidential information.

Link to section

Properties

Link to section

status

string

Read only The card payment's current state. The state can be AUTHORIZED, CAPTURED, VOIDED, or FAILED.

Max Length
50
Link to section

card

Read only The credit card's non-confidential details.

Link to section

entry_method

string

Read only The method used to enter the card's details for the payment. The method can be KEYED, SWIPED, EMV, ON_FILE, or CONTACTLESS.

Max Length
50
Link to section

cvv_status

string

Read only The status code returned from the Card Verification Value (CVV) check. The code can be CVV_ACCEPTED, CVV_REJECTED, or CVV_NOT_CHECKED.

Max Length
50
Link to section

avs_status

string

Read only The status code returned from the Address Verification System (AVS) check. The code can be AVS_ACCEPTED, AVS_REJECTED, or AVS_NOT_CHECKED.

Max Length
50
Link to section

auth_result_code

string

Read only The status code returned by the card issuer that describes the payment's authorization status.

Max Length
10
Link to section

application_identifier

string

Read only For EMV payments, the application ID identifies the EMV application used for the payment.

Max Length
32
Link to section

application_name

string

Read only For EMV payments, the human-readable name of the EMV application used for the payment.

Max Length
16
Link to section

application_cryptogram

string

Read only For EMV payments, the cryptogram generated for the payment.

Max Length
16
Link to section

verification_method

string

Read only For EMV payments, the method used to verify the cardholder's identity. The method can be PIN, SIGNATURE, PIN_AND_SIGNATURE, ON_DEVICE, or NONE.

Max Length
50
Link to section

verification_results

string

Read only For EMV payments, the results of the cardholder verification. The result can be SUCCESS, FAILURE, or UNKNOWN.

Max Length
50
Link to section

statement_description

string

Read only The statement description sent to the card networks.

Note: The actual statement description varies and is likely to be truncated and appended with additional information on a per issuer basis.

Max Length
50
Link to section

device_details

Deprecated

Deprecated: Use Payment.device_details instead.

Details about the device that took the payment.

Link to section

card_payment_timeline

Read only The timeline for card payments.

Link to section

refund_requires_card_presence

boolean

Beta

Read only Whether the card must be physically present for the payment to be refunded. If set to true, the card must be present.

Link to section

errors

Read only Information about errors encountered during the request.

Link to section

applied_card_surcharge_details

Read only Additional information about a card_surcharge on the payment.

Link to section

wallet_type

string

Beta

Read only The type of digital wallet used for this card payment, if applicable. Currently only populated for in-person Apple Pay payments. Detection has no false positives but may have false negatives (some Apple Pay payments may not be detected).

For payments with source_type of WALLET, see DigitalWalletDetails instead.

Values: APPLE_PAY

Max Length
50