2021-10-20 Changelog

Transactions API. Three previously deprecated endpoints (ListRefunds, Charge, and CreateRefund) in the Transactions API are removed from Square API version 2021-10-20 and later. These endpoints will work if you are using Square API versions prior to 2021-10-20. However, these endpoints will eventually be retired from all Square versions.

• Instead of the Transactions API Charge endpoint, use the Payments API CreatePayment endpoint.
• Instead of the Transactions API CreateRefund endpoint, use the Refunds API RefundPayment endpoint.
• Instead of the Transactions API ListRefunds endpoint, use the Refunds API ListPaymentRefund endpoint.

Payments API:

• Payment object.

  • Added the device_details read-only field to view details of the device used to take a payment. This Payment-level field provides device information for all types of payments. Previously, device details were only available for card payments (Payment.card_details.device_details), which is now deprecated.

  • Added the team_member_id field that applications can use to view the ID of the TeamMember associated with the payment. Use this field instead of the Payment.employee_id field, which is now deprecated.

  • Added the application_details read-only field to view details of the application that took the payment.

  • These Payment fields have moved to the general availability (GA) state:tip_money, delay_duration, delay_action, delayed_until, and statement_description_identifier.

  • The ACH Bank Transfer Payments feature has moved to the GA state. Accordingly, the bank_account_details field (and its BankAccountPaymentDetails type) are moved to the GA state.

• CreatePayment endpoint.
  • Added the team_member_id request field to record the ID of the team member associated with the payment.
  • The accept_partial_authorization and tip_money request fields have moved to the GA state.
• CompletePayment endpoint. Added the version_token request field to support optimistic concurrency. For more information, see Delayed capture of a card payment.

Refunds API:

• PaymentRefund object.

  • Added the team_member_id field that applications can use to view the ID of the TeamMember associated with the refund.

• RefundPayment endpoint.

  • Added the team_member_id request field to record the ID of the team member associated with the refund.
  • Added the payment_version_token request field to support optimistic concurrency. For more information, see Refund Payment.

Customers API:

• Customer object. Added a new tax_ids field of the CustomerTaxIds type, which can contain the EU VAT ID of the customer. This field is available only for customers of sellers in France, Ireland, or the United Kingdom. For more information, see Customer tax IDs.

• UpdateCustomer endpoint. The Customers API now returns a 400 BAD_REQUEST error if the request body does not contain any fields. For earlier Square versions, the Customers API will continue to return a 200 OK response along with the customer profile. For more information, see Migration notes.

Invoices API:

• InvoiceRecipient object. Added a new, read-only tax_ids field of the InvoiceRecipientTaxIds type, which can contain the EU VAT ID of the invoice recipient. This field is available only for customers of sellers in Ireland or the United Kingdom. If defined, tax_ids is returned for all Square API versions. For more information, see Invoice recipient tax IDs.
• In the Sandbox environment, Square now emails the invoice to the invoice recipient after the invoice is published.

Catalog API:

• CatalogSubscriptionPlan.name can be updated after the subscription plan is created. The change is retroactively applicable to prior versions of the Square API.

Subscriptions API:

• The new SubscriptionSource data type is introduced to encapsulate the source where a subscription is created. The new SubscriptionSource.name value is propagated to the Order.source attribute when an order is made on the subscription. The new feature is retroactively applicable to prior versions of the Square API.
• The new Subscription.source attribute is introduced to indicate the source where the subscription was created. This new feature is retroactively applicable to prior versions of the Square API.
• The new SearchSubscriptionsFilter.source_names query expression is introduced to enable searching for subscriptions by the subscription source name. This new feature is retroactively applicable to prior versions of the Square API.