The Checkout API allows you to retrieve and update location-level and merchant-level settings for Square-hosted checkout pages.
Client Methods Retrieve Location Settings Retrieves the location-level settings for a Square-hosted checkout page.
client . Checkout . RetrieveLocationSettings ( ctx context . Context , request * square . RetrieveLocationSettingsRequest ) ( * square . RetrieveLocationSettingsResponse , error )
The ID of the location for which to retrieve settings.
response
*square.RetrieveLocationSettingsResponse
Contains the checkout location settings including branding, tipping, and payment options
request := & square . RetrieveLocationSettingsRequest { LocationID : "location_id" , } response , err := client . Checkout . RetrieveLocationSettings ( context . TODO (), request ) if err != nil { log . Fatal ( err ) } // Access location settings if response . LocationSettings != nil { fmt . Printf ( "Branding Enabled: %v \n " , response . LocationSettings . Branding ) fmt . Printf ( "Tipping Enabled: %v \n " , response . LocationSettings . Tipping ) }
Update Location Settings Updates the location-level settings for a Square-hosted checkout page.
client . Checkout . UpdateLocationSettings ( ctx context . Context , request * square . UpdateLocationSettingsRequest ) ( * square . UpdateLocationSettingsResponse , error )
request
*square.UpdateLocationSettingsRequest
required
The ID of the location for which to update settings.
LocationSettings
*square.CheckoutLocationSettings
required
The location settings object containing only the fields that have changed.
response
*square.UpdateLocationSettingsResponse
The updated checkout location settings
request := & square . UpdateLocationSettingsRequest { LocationID : "location_id" , LocationSettings : & square . CheckoutLocationSettings { // Specify only the fields you want to update CustomerNotesEnabled : square . Bool ( true ), }, } response , err := client . Checkout . UpdateLocationSettings ( context . TODO (), request ) if err != nil { log . Fatal ( err ) }
Retrieve Merchant Settings Retrieves the merchant-level settings for a Square-hosted checkout page.
client . Checkout . RetrieveMerchantSettings ( ctx context . Context ) ( * square . RetrieveMerchantSettingsResponse , error )
response
*square.RetrieveMerchantSettingsResponse
Contains the merchant-wide checkout settings
response , err := client . Checkout . RetrieveMerchantSettings ( context . TODO ()) if err != nil { log . Fatal ( err ) } // Access merchant settings if response . MerchantSettings != nil { fmt . Printf ( "Default Payment Methods: %v \n " , response . MerchantSettings . PaymentMethods ) }
Update Merchant Settings Updates the merchant-level settings for a Square-hosted checkout page.
client . Checkout . UpdateMerchantSettings ( ctx context . Context , request * square . UpdateMerchantSettingsRequest ) ( * square . UpdateMerchantSettingsResponse , error )
MerchantSettings
*square.CheckoutMerchantSettings
required
The merchant settings object containing only the fields that have changed.
response
*square.UpdateMerchantSettingsResponse
The updated merchant checkout settings
request := & square . UpdateMerchantSettingsRequest { MerchantSettings : & square . CheckoutMerchantSettings { // Specify only the fields you want to update }, } response , err := client . Checkout . UpdateMerchantSettings ( context . TODO (), request ) if err != nil { log . Fatal ( err ) }
Checkout Settings Location Settings Location-level settings control checkout behavior for a specific location:
Branding : Customize the appearance of checkout pagesTipping : Enable or configure tipping optionsCoupons : Enable coupon supportCustomer Notes : Allow customers to add notes to ordersPayment Methods : Configure accepted payment methods
Merchant Settings Merchant-level settings apply across all locations:
Payment Methods : Default payment methods acceptedPolicies : Terms of service and privacy policy linksCheckout URL : Custom domain for hosted checkout pages
Key Concepts Partial Updates When updating settings, include only the fields you want to change. Omitted fields will retain their current values.
Settings Hierarchy Location-level settings override merchant-level settings for specific locations. This allows you to customize checkout experiences per location while maintaining global defaults.
Learn More 