Connect Laravel Package

Square SDK - PHP

Square is excited to announce the public release of customized SDK for PHP

To align with other Square SDKs generated for SQUARE API version 2020-05-28, the initial version of this PHP SDK is 5.0.0.20200528

API releases

• Loyalty API (beta):
  • For an overview, see Loyalty Program Overview.
  • For technical reference, see Loyalty API.

Existing API updates

• Orders API

  • CalculateOrder (beta) endpoint. Use the endpoint to calculate adjustments (for example, taxes and discounts) to an order for preview purposes. In response, the endpoint returns the order showing the calculated totals. You can use this endpoint with an existing order or an order that has not been created. The endpoint does not update an existing order. It only returns a calculated view of the order that you provided in the request. To create or update an order, use the CreateOrder and UpdateOrder endpoints, respectively.
  • Order type. Two fields are added in support of the Loyalty API integration. For more information, see Deferred reward creation. For an example, see Redeem Points.
    • Order.rewards represents rewards added to an order by calling the CreateLoyaltyReward endpoint.
    • Order.discount.reward_ids indicates that a discount is the result of the specified rewards that were added to an order using the CreateLoyaltyReward endpoint.

• Customers API

  • The Search Customers endpoint supports search by email address, phone number, and reference ID with the following additional query filters:
    • The email_address query filter (beta) supports an exact or fuzzy search for customer profiles by their email addresses.
    • The phone_number query filter (beta) supports an exact or fuzzy search for customer profiles by their phone numbers.
    • The reference_id query filter (beta) supports an exact or fuzzy search for customer profiles by their reference IDs.
  • The created_at, updated_at, and id attributes on the Customer resource are updated to be optional. As a result, they no longer are required input parameters when you call the Square SDKs to create a Customer object. You might need to update the dependent SDKs to the latest version to mediate breaking your existing code.

Square Webhooks

• Square Webhooks (formerly v2 Webhooks). The status is changed from beta to general availability (GA).
• v1 Webhooks. The v1 Inventory and Timecards webooks are now deprecated and replaced by inventory.count.updated and labor.shift.updated.

Existing API updates

• OAuth API
  • Obtain Token endpoint: Removed the scopes property from the request body.

API releases

• Customer Segments API (beta). limit field removed from ListCustomerSegments endpoint.

Note: This release fixes a bug introduced on the April 22, 2020 release of the Square API.

API releases

• Terminal API. The new Terminal API lets a custom third-party POS app integrate with the Square Terminal to send terminal checkout requests to collect payments.

  • For an overview, see Overview.
  • For technical reference, see Terminal API.

• Devices API. The new Devices API lets a custom third-party POS app generate a code used to sign in to a Square Terminal to create a pairing that lets the POS app send terminal checkout requests. For technical reference, see Devices API.

• Customer Groups API (beta). The new Customer Groups API (Beta) enables full CRUD management of customer groups, including the ability to list, retrieve, create, update, and delete customer groups. Previously, this functionality was only available through the Square dashboard and point-of-sale product interfaces.

  • For an overview, see Overview
  • For technical reference, see Customer Groups.

• Customer Segments API (beta). The new Customer Segments API (Beta) lets you list and retrieve customer segment (also called smart groups) information. Coupled with the new segment_ids field on the customer resource, this API lets you better understand and track the customer segments to which a customer belongs.

  • For an overview, see Overview
  • For technical reference, see Customer Segments.

• New webhooks. v2 Webhooks (beta) now supports webhooks for the following APIs:

  • Orders API. order.created, order.updated, and order.fulfillment.updated
  • Terminal API. terminal.checkout.created and terminal.checkout.updated
  • Devices API. device.code.paired

  For more information, see Subscribe to Events.

Existing API updates

• Customers API

  • AddGroupToCustomer endpoint. Added to add customer memberships to a customer group.
  • RemoveGroupFromCustomer endpoint. Added to remove customer memberships from a customer group.
  • Customer object. Updated as follows:
    • group_ids field. Added to designate groups the customer is in.
    • segment_ids field. Added to designate segments the customer is in.
    • groups field. Deprecated to be replaced by group_ids and segment_ids. It remains supported for one year from this release.
  • CustomerQuery object's filter parameter. Updated as follows:
    • group_ids filter. Added to search for customers based on whether they belong to any, all, or none of the specified groups.

• Orders API

  • OrderFulfillmentPickupDetails type updated to support curbside pickup:
    • is_curbside_pickup. This Boolean field indicates curbside pickup.
    • CurbsidePickupDetails. This type provides supporting information for curbside pickup, including a buyer description (for example, "buyer is in a red car") and a timestamp when the buyer arrived for the pickup.

• OAuth API

  • RevokeToken endpoint. Added a new field called revoke_only_access_token. This field allows a client to revoke an access token but leave the parent authorization active.
  • ObtainToken endpoint. Added a new field called scopes. This field lets a client change the set of permissions for an access token when making a request to refresh the token.

• Catalog API

  • CatalogQuickAmountsSettings type. Added to support predefined custom payment amounts in the Square Register checkout dialog box.
  • ENUMCatalogItemProductType. The ENUM value GIFT_CARD is now deprecated.

• Payments API. See Take Payments and Collect Fees for updated information about permission requirements, Square reporting of the application fee collected by an app, and how to collect fees internationally.

Existing API updates

• Payments API. In support of the existing Delayed capture for payments, the following fields are added to the Payment type:
  • delay_duration. In a CreatePayment request, you can set autocomplete to false to get payment approval but not charge the payment source. You can now add this field to specify a time period to complete (or cancel) the payment. For more information, see Delay capture.
  • delay_action. Defines the action that Square takes on the payment when the delay_duration elapses. In this release, the API supports only the cancel payment action.
  • delayed_until. Provides the date and time on Square servers when Square applies delay_action on the payment.

API releases

• GA release: All SDKs have been updated to support the new Bank Accounts and CashDrawerShifts APIs.

• Beta release: All SDKs have been updated to support the new Disputes API.

Documentation Changes

• Minor updates for Payments API descriptions
• Deprecation & retirement dates added for Transactions API endpoints

• Addresses bug that doesn't allow getV1BatchTokenFromHeaders to retrieve batch_token

• New field: The Employee object now has an is_owner field.

• New enumeration: The CardBrand enumeration has a new SQUARE_CAPITAL_CARD enum value to support a Square one-time Installments payment.

• New request body field constraint: The Refund Payment request now requires a payment_id.

Patch user-agent to 2.20191217.1

Square is excited to announce the public release of customized SDKs for Java and .NET. For more information, see Square SDKs.

• GA release: SDKs updated to support new receipt_url and receipt_number fields added to the Payment type.

• Beta release: SDKs updated to support the new CashDrawerShifts API.

• Square now follows the semantic versioning scheme for all SDKs except PHP and Node.js. This versioning scheme uses three numbers to delineate MAJOR, MINOR, and PATCH versions of our SDK. In addition, the SDK version also includes the API version so you know what Square API version the SDK is related to. For more information, see Versioning and SDKs.

• Java, .Net, Python, and Ruby SDKs are now version 4.0.0. Java and .Net SDKs have breaking changes in version 4.0.0. Ruby and Python do not have breaking changes.

• Important: Square has begun the retirement process for Connect v1 APIs. See the Connect v1 Retirement information page for details. !!!

• GA releases: SDKs now support the new modify_tax_basis field to Discounts and v2 Sandbox

• BETA releases: SDKs now support the Shifts API webhooks for Labor shift created, updated, deleted, CreateLocation endpoint, and the ability to customize statement description in Payments API.

• Deprecated: Support for v1Items API and v1Locations API is fully deprecated.

Version 2.20190925.0 (2019-09-25)

• GA release: All SDKs have been updated to support the new Merchants API.

• Beta release: All SDKs have been updated to support the new endpoints (RetrieveLocation, UpdateLocation) added to the Locations API.

• Beta release: All SDKs have been updated to support the new field (mcc) added to the Location type.

• GA release: All SDKs have been updated to support the new field (bin) added to the Card type.

• GA release: All SDKs have been updated to support the new CardPaymentDetails fields (verification_results, statement_description, and verification_method).

• GA release: All SDKs have been updated to support the new Payment field, (employee_id).

Version 2.20190814.2 (2019-08-23)

• Bug fix: Fixed path parameters for UpdateOrder

Version 2.20190814.0 (2019-08-15)

• New functionality: All SDKs have been updated to support the Sandbox v2 BETA release
• Deprecated functionality: All Transactions API functionality is deprecated in favor of Payments API and Refunds API functionality.
• New functionality: All SDKs have been updated to support the Payments API GA.
• New functionality: All SDKs have been updated to support the Refunds API GA.
• New functionality: All SDKs have been updated to support Orders API updates:
  • Pickup Fulfillments, SearchOrders, and ServiceCharges move from BETA to GA.
  • New BETA endpoint: Orders.UpdateOrder — use the UpdateOrder endpoint to update existing orders.
  • New BETA functionality: Create shipment-type fulfillments.
• New functionality: Locations.RetrieveLocation — use the RetrieveLocation endpoint to load details for a specific Location.

Version 2.20190710.0 (2019-07-10)

• Retired functionality — The CatalogItem.image_url field (deprecated under Square-Version YYYYMMDD) is retired and no longer included in Connect SDKs.

• Bug fix: Transaction.Charge and Customers.CreateCustomerCard request objects — now include the verification_token required for Strong Customer Authentication.

• BETA releases:
  • Orders API: supports service charges with a new field and datatype.
  • Catalog API: supports measurement unites for item variation quantities with a new field and datatype.
• New functionality: Order entities — now include a source field that contains details on where the order originated.
• Improved functionality: ListLocations — Expanded business information available through the Locations API, including business hours, contact email, social media handles, and longitude/latitude for physical locations.

Beta functionality: Orders API — support for fractional quantities, expanded metadata, and embedded information on payments, refunds, and returns.

• Beta functionality: Inventory API — support for fractional quantities.
• New functionality: Locations.business_hours — read-only field with information about the business hours at a particular location.

• New functionality: Employees API (Connect v2) — New fields to capture contact information for employee profiles.
• New functionality: V1Tender.CardBrand — New V1 enum to represent brand information for credit cars.

New features: Orders API beta

• The Connect v2 Orders object now includes an OrderSource field (source) that encapsulates the origination details of an order.

Improvement: Connect v2 Catalog IDs in Connect v1 objects

• The following Connect v1 data types now include a v2_id field that makes it easier to link information from Connect v1 endpoints to related Connect v2 Catalog objects:
  • V1Discount
  • V1Fee
  • V1Item
  • V1ModifierList
  • V1ModifierOption
  • V1Variation

Bug Fix: Catalog API

• Add image_id to CatalogObject

Version 2.20190327.0 (2019-03-27)

New features: Catalog API

• Deprecated image_url field in CatalogItem in favor of a richer CatalogImage data type.
• Image information is now set, and returned, at the CatalogObject level.

Bug Fix: Connect v1

• Change timecard_id as path parameter for ListTimecardEvents endpoint
• Change ended_at to string type for V1CashDrawerShift type

Version 2.20190313.0 (2019-03-13)

New API: Labor API

The Labor API now includes functionality that gives a Square account the ability to track and retrieve employee labor hours including multiple hourly wage rates per employee, work shift break tracking, and standardized break templates.

See the Connect v2 Technical Reference.

New API: Employees API

The Employees API includes the ability to list employees for a Square account and retrieve a single employee by ID.

See the Connect v2 Technical Reference.

Improvement: Simplified OAuth access token renewal

The RenewToken endpoint is now deprecated and replaced with new functionality in ObtainToken. ObtainToken now returns a refresh token along with an access token. Refresh tokens are used to renew expired OAuth access tokens.

Version 2.20190213.0 (2019-02-13)

New feature: Order fulfillment BETA

The Orders API now includes beta functionality that supports in-person fulfillment through Square Point of Sale for orders placed online.

Improvement: New CreateOrder request structure

The CreateOrderRequest datatype now groups order details under a single object.

Improvement: CreateOrder requests preserve order-level price adjustment objects

The CreateOrderResponse datatype now retains structure of order-level price adjustments in addition to converting them to scoped, line-item price adjustments. Previously, CreateOrderResponse did not preserve the original order-level price-adjustment objects.

Version 2.13.0 (2018-12-12)

Improvement: ListCustomers return set expanded

Requests to the ListCustomers endpoint now returns all available customer profiles. Previously, ListCustomers only returned customer profiles explicitly created through the Customers API or Square Point of Sale.

Version 2.20181205.0 (2018-12-05)

New feature: Idempotent customer profile creation in Connect v2

Requests to the CreateCustomer endpoint now include a idempotency_key field to ensure idempotent creation of new profiles.

New feature: Refund Adjustment fields for Refunds in Connect v1

The Connect SDK now supports refund adjustments for the Connect v1 Refunds API with the addition of multiple new fields in the Refund data type

Version 2.20180918.1 (2018-10-24)

New feature: Support for Partial Payments in Connect v1

The Connect SDK now supports partial payment functionality for the Connect v1 Transactions API with the addition of a new Payment field:

• Payment.is_partial — Indicates whether or not the payment is only partially paid for. If true, the payment will have the tenders collected so far, but the itemizations will be empty until the payment is completed.

Tender also includes 2 new fields to help resolve timing around payments with multiple tenders. Invoices that involve partial payment (e.g., requiring a deposit) may include tenders settled well before the entire payment is completed:

• Tender.tendered_at — The time when the tender was accepted by the merchant.
• Tender.settled_at — The time when the tender was captured, in ISO 8601 format. Typically the same as (or within moments of) tendered_at unless the tender was part of a delay capture transaction.

The change also makes some behavioral changes to the Connect v1 Payment endpoints:

• Create Refunds rejects requests for invoices that have partial payments pending.
• List Payments takes a new request field, include_partial to indicate whether partial payments should be included in the response.