2022-09-21 Changelog

Square GiftCardActivities API Invoices API OAuth API Connect v1

Version Summary

• Square Version: 2022-09-21
• Java: 24.0.0.20220921
• .NET: 22.0.0
• Node.js: 22.0.0
• PHP: 22.0.0.20220921
• Python: 22.0.0.20220921
• Ruby: 23.0.0.20220921

Details

Link to section

API updates

• Gift Card Activities API:

  • GiftCardActivityAdjustDecrementReason enumeration. Added the PURCHASE_WAS_REFUNDED reason. This reason applies when using an ADJUST_DECREMENT activity to decrease the gift card balance after refunding an order that was used to purchase or reload the gift card.

• Invoices API:

  • Invoice object. Added the store_payment_method_enabled field. This field enables customers to choose to save a card on file or bank account on file from the invoice payment page.

• OAuth API:

  • ObtainToken endpoint. The following fields are removed from the response:

    • app_subscription_id

    • app_plan_id

• Square Connect V1 APIs:

  • In the Connect V1 API, some of the deprecated endpoint names conflict with similar names in the Square API. For that reason, the following Connect V1 endpoints have been renamed:

    
    

    API	Old endpoints	New endpoints
    Payments	ListPayments RetrievePayment	V1ListPayments V1RetrievePayment
    Refunds	ListRefunds CreateRefund	V1ListRefunds V1CreateRefund
    Settlements	ListSettlements RetrieveSettlement	V1ListSettlements V1RetrieveSettlement
    Webhooks	ListWebhooks UpdateWebhooks	V1ListWebhooks V1UpdateWebhooks

    
    These endpoints are for backward compatibility only. Square strongly discourages using Connect V1 APIs in most cases.

• Various APIs:

  • Support for null field clearing is now available for the following API objects:

    • Customer

    • Order

    • Location

    • Invoice

    • Subscription

    • TeamMember

    • Vendor

Link to section

SDKs

• Square Python SDK:

  • is_valid_webhook_event_signature method. Added for webhooks signature validation. For the code sample, see Webhook event notification validation - Python.

Link to section

Documentation updates

• V2 Webhook Events Reference. Added the Permission column to show the permissions required for using each Square API.