- Square Version:
Webhook Subscriptions API (beta). The Webhook Subscriptions API lets you programmatically manage your webhook subscriptions, including creating, updating, and deleting webhook subscriptions associated with an event. For more information, see Webhook Subscriptions API Overview.
CreateCheckout endpoint. This endpoint is deprecated and replaced by the CreatePaymentLink endpoint. For more information, see Migrate from CreateCheckout to CreatePaymentLink.
CreatePaymentLink endpoint. The following changes apply:
This endpoint now supports adding a shipping fee and an application fee as a checkout option. For more information, see Specify checkout options.
The response now includes a
related_resourcesfield that contains full order details.
Customer Custom Attributes API:
The Customer Custom Attributes API has moved to the general availability (GA) state.
UpsertCustomerCustomAttribute and BulkUpsertCustomerCustomAttributes endpoints. The absolute value of a
Number-type custom attribute provided in the request cannot exceed
(2^63-1)/10^5, or 92233720368547. This constraint applies to all Square versions.
Webhooks. Added new
.visiblewebhooks that allow you to receive notifications about changes to all custom attribute definitions and custom attributes owned by your application or visible to your application. The existing webhooks are deprecated and replaced by the new webhooks. For more information, see Migration notes.
SearchCustomers endpoint. This endpoint now supports searching customer profiles based on the value or last updated date of one or more custom attributes. This feature is in beta. For more information, see Search based on custom attributes.
Gift Card Activities API:
CreateGiftCardActivity endpoint. The
redeem_activity_idfield is now required to create a
REFUNDactivity. This requirement applies when custom payment processing applications refund a gift card payment to the same gift card.
The recommendation for all third-party applications to use the
REFUNDactivity type for all gift card refunds has been revised. Instead, applications that use a custom payment processing system should use the
UNLINKED_ACTIVITY_REFUNDactivity to refund cross-tender payments.
Address object. The following fields that were previously removed are now restored:
The Loyalty API now supports creating and managing loyalty promotions. Loyalty promotions enable customers to earn extra loyalty points. For more information, see Manage Loyalty Promotions. This change introduces the following new endpoints:
AccumulateLoyaltyPoints endpoint. The following changes apply:
eventfield in the response is deprecated and replaced by the
eventsfield. Starting in Square version 2022-08-17,
eventis no longer returned. For more information, see Migration notes.
The response now includes an
ACCUMULATE_PROMOTION_POINTSevent if the specified order qualifies for promotion points. This event type is only supported for applications that use the Orders API to process orders.
CalculateLoyaltyPoints endpoint. The following changes apply:
loyalty_account_idfield to the request, which determines how promotion points are computed for the specified Square order.
promotion_pointsfield to the response, which contains the computed promotion points for the specified Square order.
AdjustLoyaltyPoints endpoint. Added the
allow_negative_balancefield, which indicates whether to allow a negative adjustment to result in a negative point balance.
Webhooks. Added the
Payment object. For PayPay payments, the
Payment.wallet_details.brandfield value is now set to PAYPAY.
CreatePayment endpoint. This endpoint now returns a
PAYMENT_AMOUNT_MISMATCHerror code when the amount provided in the request does not match the expected amount.
PayPay is now available in Japan as a payment source for in-person payments only.
TerminalCheckout object. The
payment_typefield now supports the
PayPayvalue, which allows the Square Terminal to launch the PayPay checkout screen.
PayPay QR Code Payments. Added a topic that explains how to take PayPay payments with the Terminal API.
Test Square APIs in the Sandbox. Added a
device_idthat can be used to test PayPay checkout requests in the Square Sandbox.
If you need more assistance, contact Developer Support or ask for help in the Developer Forums.