Version 9.1.0.20210317

Version 9.1.0.20210317 (2021-03-17)

Existing API updates

• Payments API:

  • CreatePayment. Until now, the CreatePayment endpoint supported only taking card payments. In this release, the API now supports cash and external payments. For more information, see Take Payments.
  • UpdatePayment. This new endpoint enables developers to change the payment amount and tip amount after a payment is created. For more information, see Update Payments.

• Invoices API:

  • InvoiceDeliveryMethod enum. Added the read-only SMS value.
  • InvoiceRequestMethod enum (deprecated). Added the read-only SMS, SMS_CHARGE_CARD_ON_FILE, and SMS_CHARGE_BANK_ON_FILE values for backward compatibility.

  These values direct Square to send invoices and receipts to customers using SMS (text message). SMS settings can be configured from first-party Square applications only; they cannot be configured from the Invoices API. Square does not send invoice reminders when using SMS to communicate with customers.

• Terminal API:

  • TerminalCheckout. Previously, TerminalCheckout only supported tapped, dipped, or swiped credit cards. It now supports manual card entry and e-money. Added the payment_type field to denote a request for a manually entered payment card or an e-money payment.
  • TerminalCheckoutPaymentType. A new enum for the Terminal checkout payment types that can be requested.
  • E-money support is now available for Terminal checkout requests in Japan.

SDKs

• Square Java SDK:
  • Updated the OkHttp dependency to version 4.9.0.
  • Fixed a NullPointerException when passing an empty order ID to the UpdateOrder method.

Documentation updates

• Multi-language code examples. Previously, various topics showed only cURL examples for the REST API operations. These topics now show examples in multiple languages. You can use the language drop-down list to choose a language.

• When to Use Connect V1. Content is revised to reflect the most current information about when to use the Con

Version 9.0.0.20210226

Version 9.0.0.20210226 (2021-02-26)

Existing API updates

• Customers API:

  • New webhooks (beta). Square now sends notifications for the following events:
    • customer.created
    • customer.deleted
    • customer.updated

• Orders API:

  • CreateOrder. Removed the location_id field from the request. It was an unused field.

• Payments API:

  • Payment. This type now returns the card_payment_timeline (CardPaymentTimeline) as part of the card_details field.

• v1 Items API:

  • The following endpoints are retired:
    • AdjustInventory: Use the Square Inventory API BatchChangeInventory endpoint.
    • ListInventory: Use the Square Inventory API BatchRetrieveInventoryCounts endpoint.

• v1 Employees.Timecards:

  • The following endpoints are retired:
    • CreateTimecard: Use the Square Labor API CreateShift endpoint.
    • DeleteTimecard: Use the Square Labor API DeleteShift endpoint.
    • ListTimecards: Use the Square Labor API SearchShift endpoint.
    • RetrieveTimecards: Use the Square Labor API GetShift endpoint.
    • UpdateTimecard: Use the Square Labor API UpdateShift endpoint.
    • ListTimecardEvents: No direct replacement. To learn about replacing the v1 functionality, see the migration guide.

• v1 Employees.CashDrawers:

  • The following endpoints are retired:
    • ListCashDrawerShifts: Use the Square CashDrawerShifts API ListCashDrawerShifts endpoint.
    • RetrieveCashDrawerShift: Use the Square CashDrawerShifts API RetrieveCashDrawerShift endpoint.

• v1 Transactions.BankAccounts:

  • The following endpoints are retired:
    • ListBankAccounts: Use the Square Bank Accounts API ListBankAccounts endpoint.
    • RetrieveBankAccount: Use the Square Bank Accounts API GetBankAccount endpoint.

SDKs

• All Square SDKs:

  By default, all SDKs send requests to Square's production (https://connect.squareup.com) or sandbox (https://connect.squareupsandbox.com) hosts based on the client's environment parameter.

  You now have the option to use a custom URL instead. To use a custom URL, follow the example for your language to set the environment parameter to custom and the customUrl parameter to your URL:

  • Java

    new SquareClient.Builder()
      .environment(Environment.CUSTOM)
      .customUrl("https://example.com")

  • .NET

    new Square.SquareClient.Builder()
      .Environment(Environment.Custom)
      .CustomUrl("https://example.com")

  • Node.js

    new Client({
      environment: Environment.Custom,
      customUrl: 'https://example.com'
    });

  • PHP

    new Square\SquareClient([
      'environment' => Environment::CUSTOM,
      'customUrl' => 'https://example.com',
    ]);

  • Python

    Client(
      environment = 'custom',
      custom_url = 'https://example.com',)

  • Ruby

    Square::Client.new(
      environment: 'custom',
      custom_url: 'https://example.com'
    });

• Square .NET SDK:

  Square has overridden the Equals and GetHashCode methods for models:

  • In the Equals override, Square has implemented a field-level comparison.
  • The Square GetHashCode override now ensures that hashes are deterministic and unique for each object.

• Square Node.js SDK:

  Endpoints that return 64-bit integers now return a BigInt object instead of a Number object.

• Connect Node.js SDK: (deprecated)

  The deprecated Connect Node.js SDK is in the security maintenance state. It does not receive any bug fixes or API updates from the Square version 2021-02-26 release. However, the SDK will receive support and security patches until it is retired (end of life) in the second quarter of 2021. For more information, including steps for migrating to the Square Node.js SDK, see the Connect SDK README.

Documentation updates

• Catalog API:

  • Update Catalog Objects. Provides programming guidance to update catalog objects.

• Inventory API:

  • List or retrieve inventory. Migrate the retired v1 endpoint of ListInventory to the v2 endpoint of BatchRetrieveInventoryCounts. Compare and contrast the programming patterns between the v1 endpoint of ListInventory and its v2 counterparts of BatchRetrieveInventoryCounts or RetrieveInventoryCount.
  • Adjust or change inventory. Migrate the retired v1 endpoint of AdjustInventory to the v2 endpoint of BatchChangeInventory. Compare and contrast the programming patterns between the v1 endpoint of AdjustInventory and its v2 counterparts of BatchChangeInventory.

• Get Started topic. Revised the Get Started experience. In addition to clarifications, it now includes the use of the Square Sandbox and API Explorer. These are the tools and environments developers use to explore

Version 8.1.0.20210121

Version 8.1.0.20210121 (2021-01-21T00:00)

Existing API updates

• Invoices API: (beta)

  The InvoicePaymentRequest.request_method field is deprecated, and its current options are separated into two new fields that better represent their scope:

  • Invoice.delivery_method specifies how Square should send invoices, reminders, and receipts to the customer.
  • InvoicePaymentRequest.automatic_payment_source specifies the payment method for an automatic payment.

  As part of this change, the InvoiceDeliveryMethod and InvoiceAutomaticPaymentSource enums are added and the InvoiceRequestMethod enum is deprecated.

  The Invoices API will continue to accept request_method in create and update requests until the field is retired, but starting in this version, request_method is not included in returned Invoice objects. For more information, see the migration notes.

• Locations API:

  • The Locations.MCC field is now updatable (beta). You can use the UpdateLocation endpoint to update the merchant category code (MCC) associated with a seller location. For more information, see Initialize a merchant category code.

SDKs

• Connect Node.js SDK: (deprecated)

  The deprecated Connect Node.js SDK is in the security maintenance state. It will not receive any bug fixes or API updates from the Square version 2021-01-21 release. However, the SDK will receive support and security patches until it is retired (EOL) in Q2, 2021. For more information, including steps for migrating to the Square Node.js SDK, see the Connect SDK README.

Documentation updates

• Catalog API:

  • The Use Item Options to Manage Item Variations topic is added. It demonstrates how item variations are usually used and how item options can be used to enable random access to item variations.

• Inventory API:

  • The Inventory API content is updated. It provides clearer guidance about how to use the API, with a task-oriented TOC and improved cod

Version 8.0.0.20201216

Version 8.0.0.20201216 (2020-12-16T00:00)

Existing API updates

• Orders API:

  • OrderLineItemPricingBlocklists. You can explicitly specify taxes and discounts in an order or automatically apply preconfigured taxes and discounts to an order. In addition, you can now block applying these taxes and discounts to a specific OrderLineItem in an order. You add the pricing_blocklists attribute to individual line items and specify the blocked_discounts and blocked_taxes that you do not want to apply. For more information, see Apply Taxes and Discounts. For example walkthroughs, see Automatically Apply Discounts and Automatically Apply Taxes.

  • OrderPricingOptions. Previously, the pricing_options field in an order supported only auto_apply_discounts to enable the automatic application of preconfigured discounts. Now it also supports auto_apply_taxes to enable the automatic application of preconfigured taxes. For more information, see Automatically apply preconfigured catalog taxes or discounts.

  • OrderLineItemTax. It now includes the new auto_applied field. It indicates whether the tax was automatically applied using a preconfigured CatalogTax.

• Bookings API:

  • The CancelBooking endpoint supports canceling an accepted or pending booking.
  • The booking.created webhook event notifies when a new booking is created by calling the CreateBooking endpoint.
  • The booking.updated webhook event notifies when an existing booking is updated.

• Catalog API:

  • ListCatalog, RetrieveCatalogObject, and BatchRetrieveCatalogObjects now support the catalog_version filter to return catalog objects of the specified version.

• Customers API:

  • SearchCustomers endpoint. The email_address, group_ids, phone_number, and reference_id query filters are now generally available (GA).
  • The Customer Groups API is now GA.
  • The Customer Segments API is now GA.

• Invoices API: (beta)

  • Invoice object. Added the custom_fields field, which contains up to two customer-facing, seller-defined fields to display on the invoice. For more information, see Custom fields.
    As part of this change, the following objects are added:
    • InvoiceCustomField object
    • InvoiceCustomFieldPlacement enum
  • InvoiceRequestMethod enum. Added the read-only CHARGE_BANK_ON_FILE value, which represents a bank transfer automatic payment method for a recurring invoice.

• Loyalty API: (beta)

  • LoyaltyProgramRewardTier object. The definition field in this type is deprecated and replaced by the new pricing_rule_reference field. You can use pricing_rule_reference fields to retrieve catalog objects that define the discount details for the reward tier. For more information, see Get discount details for a reward tier.
    As part of this change, the following APIs are deprecated:
    • LoyaltyProgramRewardDefinition object
    • LoyaltyProgramRewardDefinitionScope enum
    • LoyaltyProgramRewardDefinitionType enum

New SDK release

• Square Node.js SDK:

  The new Square Node.js SDK is now GA and replaces the deprecated Connect Node.js SDK. For migration information, see the Connect SDK README.

Documentation updates

• Get Right-Sized Permissions with Down-Scoped OAuth Tokens. This new OAuth API topic shows how to get an additional reduced-scope OAuth token with a 24-hour expiration by using the refresh token from the Square account authorization OAuth flow.

Version 7.0.0.20201118

New API releases

• Bookings API (beta). This API enables you, as an application developer, to create applications to set up and manage bookings for appointments of fixed duration in which selected staff members of a Square seller provide specified services in supported locations for particular customers.
  • For an overview, see Manage Bookings for Square Sellers.
  • For technical reference, see Bookings API.

Existing API updates

• Payments API:
  • Payment. The object now includes the risk_evaluation field to identify the Square-assigned risk level associated with the payment. Sellers can use this information to provide the goods and services or refund the payment.

New SDK release

• New Square Node.js SDK (beta)

  The new Square Node.js SDK is available in beta and will eventually replace the deprecated Connect Node.js SDK. For migration information, see the Connect SDK README. The following topics are updated to use the new SDK:

  • Walkthrough: Integrate Square Payments in a Website
  • Verify the Buyer When Using a Nonce for an Online Payment
  • Create a Gift Card Payment Endpoint

Documentation Updates

• The Testing topics are moved from the end of the table of contents to the top, in the Home section under Testing your App.
• [Pay for orders.]](https://developer.squareup.com/docs/orders-api/pay-for-order) Topic revised to add clarity when to use Payments API and Orders API to pay for an order. The [Orders Integration]](https://developer.squareup.com/docs/payments-api/take-payments?preview=true#orders-integration) topic in Payments API simplified accordingly.

Version 6.5.0.20201028

Version 6.5.0.20201028 (2020-10-28T00:00)

Existing API updates

• Terminal API. New endpoints to enable sellers in Canada refund Interac payments.

  • New endpoints:

    • CreateTerminalRefund
    • GetTerminalRefund
    • CancelTerminalRefund
    • SearchTerminalRefunds

  • New webhooks:

    • terminal.refund.created. Notification of a new Terminal refund request.
    • terminal.refund.updated. Notification that a Terminal refund request state is changed.

  • New topic Refund Interac Payments.. Describes how to refund Interac payments.

• Loyalty API (beta):

  • SearchLoyaltyAccounts. The endpoint supports a new query parameter to search by customer ID.

• Locations API:

  • Location object. Has a new read-only field,full_format_logo_url, which provides URL of a full-format logo image for the location.
  • Webhooks. The Locations API now supports notifications for when a location is created and when a location is updated.

• Orders API:

  • RetrieveOrder, new endpoint. For more information, see the Retrieve Orders overview.

• Invoices API (beta):

  • Invoice object. The payment_requests field can now contain up to 13 payment requests, with a maximum of 12 INSTALLMENT request types. This is a service-level change that applies to all Square API versions. For more information, see [Payment requests.](https://developer.squareup.com/docs/invoices-api/overview#paym

Version 6.4.0.20200923 (2020-09-23)

Existing API updates

• Invoices API (beta)
  • InvoiceStatus enum. Added the PAYMENT_PENDING value. Previously, the Invoices API returned a PAID or PARTIALLY_PAID status for invoices in a payment pending state. Now, the Invoices API returns a PAYMENT_PENDING status for all invoices in a payment pending state, including those previously returned as PAID or PARTIALLY_PAID.
• Payments API
  • ListPayment. The endpoint now supports the limit parameter.
• Refunds API
  • ListPaymentRefunds. The endpoint now supports the limit parameter.
• DeviceDetails. The object now includes the device_installation_id field.

Documentation updates

• Payment status. Added details about the Payment.status changes and how the status relates to the seller receiving the funds.
• Refund status. Added details about the PaymentRefund.status changes and how the status relates to the cardholder receiving the funds.
• CreateRefund errors. Added documentation for the REFUND_DECLINED error code.

Version 6.3.0.20200826 (2020-08-26)

Existing API updates

• Orders API
  • Order object. The total_tip_money field is now GA.
  • CreateOrder, UpdateOrder, and BatchRetrieveOrders. These APIs now support merchant-scoped endpoints (for example, the CreateOrder endpoint POST /v2/orders). The location-scoped variants of these endpoints (for example, the CreateOrder endpoint POST /v2/locations/{location_id}/orders) continue to work, but these endpoints are now deprecated. You should use the merchant-scoped endpoints (you provide the location information in the request body).
• Labor API
  • Migrate from Employees to Team Members. The Employees API is now deprecated in this release. Accordingly, update references to the Shift.employee_id field to the Shift.team_member_id field of the Labor API.
• v2 Employees API (deprecated)
  • Migrate from the Square Employees API. The v2 Employees API is now deprecated. This topic provides information to migrate to the Team API.
• v1 Employees API (deprecated)
  • Migrate from the v1 Employees API. The v1 Employees API is now deprecated. This topic provides information to migrate to the Team API.

Documentation updates

• Point of Sale API
  • Build on iOS. Corrected the Swift example code in step 7.
• Team API
  • Team API Overview. Documented the limitation related to creating a team member in the Square Sandbox.

All SDKs

SDK technical reference documentation:

• Nulls in SDK documentation example code are replaced with example values.

.NET SDK

Bug fixes:

• The APIException.Errors property was not set on instantiation. Behavior is now corrected to instantiate the class with an empty Errors list.

Version 6.2.0.20200812 (2020-08-12)

API releases

• Subscriptions API (beta):
  • For an overview, see Square Subscriptions.
  • For technical reference, see Subscriptions API.

Existing API updates

• Catalog API
  • CatalogSubscriptionPlan (beta). This catalog type is added in support of the Subscriptions API. Subscription plans are stored as catalog object of the SUBSCRIPTION_PLAN type. For more information, see Set Up and Manage a Subscription Plan.

SqPaymentForm SDK updates

• SqPaymentForm.masterpassImageURL. This function is updated to return a Secure Remote Commerce background image URL.

Documentation updates

• Locations API
  • About the main location. Added clarifying information about the main location concept.
• OAuth API
  • Migrate to the Square API OAuth Flow. Added a new topic to document migration from a v1 location-scoped OAuth access token to the Square seller-scoped OAuth access token.
• Payment Form SDK
  • Renamed the Add a Masterpass Button topic to Add a Secure Remote Commerce Button. Updated the instructions to add a Secure Remote Commerce button to replace a legacy Masterpass button.
  • Payment form technical reference. Updated the reference to show code examples for adding a Secure Remote Commerce button.

Version 6.1.0.20200722 (2020-07-22)

API releases

• Invoices API (beta):
  • For an overview, see Manage Invoices Using the Invoices API.
  • For technical reference, see Invoices API.

Existing API updates

• Catalog API

  • SearchCatalogItems. You can now call the new search endpoint to search for catalog items or item variations, with simplified programming experiences, using one or more of the supported query filters, including the custom attribute value filter.

• Locations API

  • Locations API Overview. Introduced the "main" location concept.
  • RetrieveLocation. You can now specify "main" as the location ID to retrieve the main location information.

• Merchants API

  • RetrieveMerchant and ListMerchants. These endpoints now return a new field, main_location_id.

• Orders API

  • PricingOptions. You can now enable the auto_apply_discounts of the options to have rule-based discounts automatically applied to an Order that is pre-configured with a pricing rule.

• Inventory API

  • Replaced 500 error on max string length exceeded with a max length error message. Max length attribute added to string type fields.

• Terminal API (beta)

  • TerminalCheckout object. The TerminalCheckoutCancelReason field is renamed to ActionCancelReason.

Documentation updates

• Catalog API

  • Search a catalog. New topics added to provide actionable guides to using the existing SearchCatalogObjects endpoint, in addition to the SearchCatalogItems endpoints.

• Orders API

  • Create Orders. Updated existing content with the new pricing option for the automatic application of rule-based discounts.