- Square Version:
2022-10-19
- Java:
25.0.0.20221019
- .NET:
23.0.0
- Node.js:
23.0.0
- PHP:
23.0.0.20221019
- Python:
23.0.0.20221019
- Ruby:
24.0.0.20221019
2022-10-19 Changelog
Square
Customers API
Invoices API
Locations API
Orders API
Payouts API
Refunds API
Customers API:
CreateCustomer and UpdateCustomer endpoints. The following changes apply:
- The
phone_number
provided in the request must be valid. - A
birthday
can be specified usingYYYY-MM-DD
orMM-DD
format and is returned inYYYY-MM-DD
format. - String-type fields provided in the request (except
note
) have a maximum length constraint.
- The
RetrieveCustomer, ListCustomers, and SearchCustomers endpoints. The
birthday
field is returned inYYYY-MM-DD
format.
For more information about these changes, see Migration notes.
Invoices API:
- InvoiceAcceptedPaymentMethods object. Added the
buy_now_pay_later
field, which enables customers to pay invoices using Buy Now Pay Later installment payments. For more information, including requirements and processing limits, see Buy Now Pay Later payments with Afterpay. In Square versions 2021-04-21 and higher, Square now accepts thebuy_now_pay_later
field inCreateInvoice
andUpdateInvoice
requests and includes it in returned invoices.
- InvoiceAcceptedPaymentMethods object. Added the
Locations API:
- LocationCapability object. Added the
UNLINKED_REFUNDS
capability for unlinked refunds support.
- LocationCapability object. Added the
Orders API:
The following new types and enums are introduced to replace existing types and enums:
- Types
- Fulfillment replaces
OrderFulfillment
- FulfillmentFulfillmentEntry replaces
OrderFulfillmentFulfillmentEntry
- FulfillmentPickupDetails replaces
OrderFulfillmentPickupDetails
- FulfillmentPickupDetailsCurbsidePickupDetails replaces
OrderFulfillmentPickupDetailsCurbsidePickupDetails
- FulfillmentRecipient replaces
OrderFulfillmentRecipient
- FulfillmentShipmentDetails replaces
OrderFulfillmentShipmentDetails
- Fulfillment replaces
- ENUMs
- FulfillmentFulfillmentLineitemApplication replaces
OrderFulfillmentFulfillmentLineitemApplication
- FulfillmentState replaces
OrderFulfillmentState
- FulfillmentPickupDetailsScheduleType replaces
OrderFulfillmentPickupDetailsScheduleType
- FulfillmentType replaces
OrderFulfillmentType
- FulfillmentFulfillmentLineitemApplication replaces
- Types
Payouts API:
- PayoutEntry object. Added the
type_app_fee_refund_details
andtype_app_fee_revenue_details
fields. These fields show details related to application fee revenue and application fee refunds.
- PayoutEntry object. Added the
Refunds API:
- Refund object. Added four fields to support unlinked refunds, which allows authorized sellers to refund money to buyers without linking to a prior Square-processed payment:
- destination_id. The payment card to be refunded.
- unlinked.
True
if the refund is unlinked. - location_id. The seller location where the refund was issued.
- customer_id. The customer associated with the card if a refund payment card is saved on file.
- Refund object. Added four fields to support unlinked refunds, which allows authorized sellers to refund money to buyers without linking to a prior Square-processed payment: