2.8.0

Version 2.8.0 (2018-05-24)

We have added sorting functionality to the Connect v2 Customer API, updated
the Connect v1 Payments API to include information about surcharges and
improvements to the Item data type.

New feature: Customer API (Connect v2)

• ListCustomers endpoint — now provides the ability to sort
  customers by their creation date using the sort_field and
  sort_order parameters.

New features: Payments API (Connect v1)

The Payments API now returns information about surcharges applied to payments.
The new functionality introduces the following new data types:

• SurchargeMoney datatype — The total of all surcharges applied
  to the payment.
• Surcharges datatype — A list of all surcharges associated with
  the payment.
• Surcharge datatype — A surcharge that is applied to the payment.
  One example of a surcharge is auto-gratuity, which is a fixed-rate surcharge
  applied to every payment, often based on party size.

We are constantly evaluating new languages to add. In the meantime, if the
language you need is not supported, you can use our
[Swagger pipeline](<%= articles__client_libraries_path%>#generatingwithswagger)
to generate a custom SDK or continue sending JSON to the endpoint URLs directly.

Improvement: Item (Connect v1)

Item will now provide two new properties:

• category_id — indicates if an item can be added to pickup orders
  from the merchant's online store
• available_for_pickup — indicates the item's category (if any).

2.7.0

Version 2.7.0 (2018-04-26)

New features: Transactions API and Payments API

The Transactions API in Connect v2 now includes payment and refund information from exchanges.

• ListTransactions now includes payment information from sales and exchanges and refund
  information from returns and exchanges.
• ListRefunds now includes refunds that result from exchanges in addition to partial refunds and
  itemized returns through Square's Point of Sale applications.

The Payments API in Connect v1 now includes payment and refund information from exchanges.

• ListPayments now includes refunds that are generated from exchanges to account for the
  value of returned goods.
• ListRefunds now returns an approximate number of refunds (default: 100, max: 200).
  The response may contain more results than the prescribed limit when refunds are made
  simultaneously to multiple tenders in a payment or when refunds are generated from exchanges
  to account for the value of returned goods.
• is_exchange is added to V1Refund and V1Tender. Refunds and tenders marked in this way
  represent the value of returned goods in an exchange, rather than actual money movement.

2.6.1

Version 2.6.1 (2018-03-28)

• Updates user-agent header

2.6.0

Version 2.6.0 (2018-03-27)

Improvements: Orders API

• BatchRetrieveOrders will now return uncharged orders.

New features: Orders API

• For Catalog-backed line items, setting CreateOrderRequestLineItem.base_price_money will now override
  the catalog item variation's price.
• CreateOrderRequestModifiers may now be created ad hoc using the new name and base_price_money fields.

2.5.2

Version 2.5.2 (2018-01-06)

• OTHER enum value is added to Type on V1SettlementEntry

2.5.1

• ordinal is added to CatalogItemVariation
• website_url is added to Location
• tip_money is added to Tender
• Changed object_type and placeholder_type from lists to single values in V1PageCell to mirror data model

2.5.0

New features: Transaction API and Reporting API

The Transaction API now supports the following request objects:

• additional_recipients — data type representing an additional recipient
  (in other words, a recipient other than the merchant or Square) receiving a
  portion of a tender.

The new Reporting API includes two endpoints that let you pull information about distributions you have received as an additional recipient:

• AdditionalRecipientReceivables — returns a list of receivables (across
  all source locations) representing monies credited to the given location ID by
  another Square account using the additional_recipients field in a transaction.

• AdditionalRecipientReceivablesRefunds — returns a list of refunded
  transactions (across all source locations) related to monies credited to the
  given location ID by another Square account using the additional_recipients
  field in a transaction.

2.4

New features: Register Domain for Apple Pay

• RegisterDomain endpoint activates a domain for use with Web Apple Pay.

Other Changes

• Location.type used to indicate whether or not the location object represents a physical space.

2.3.1

New features: Charge Orders

• Charge endpoint can charge a specific Order.

2.3.0

New features: Orders API

• CreateOrder endpoint creates an itemized order which can be referenced in messages to the Charge endpoint.
• BatchRetrieveOrders retrieves order objects referenced in one or more transactions based on the provided order_id.

Note: at this point, BatchRetrieveOrders only returns information on paid orders made through Square's eCommerce APIs (Transactions, Checkout).

Other Changes

• order is removed from Transaction
• order_id is added to Transaction
• OrderLineItemDiscountType.UNKOWN renamed to OrderLineItemDiscountType.UNKOWN_DISCOUNT
• OrderLineItemTaxType.UNKOWN renamed to OrderLineItemDiscountType.UNKOWN_TAX
• ChargeRequest.idempotency_key is restricted to max length 192
• ChargeRequest.card_nonce is restricted to max length 192
• ChargeRequest.customer_card_id is restricted to max length 192
• ChargeRequest.reference_id is restricted to max length 40
• ChargeRequest.note is restricted to max length 60
• ChargeRequest.customer_id is restricted to max length 50
• CreateCheckoutRequest.redirect_url is restricted to max length 800
• Added phone_number and business_name to Location