{"slug":"square-api","name":"Square API","host":"connect.squareup.com","site":"https://squareup.com","category":"payments","docsUrl":null,"sources":[{"kind":"changelog","url":"https://developer.squareup.com/docs/changelog/connect"},{"kind":"openapi","url":"https://raw.githubusercontent.com/square/connect-api-specification/master/api.json"},{"kind":"archive","url":"https://developer.squareup.com/docs/changelog/connect-logs/2025-02-20"},{"kind":"archive","url":"https://developer.squareup.com/docs/changelog/connect-logs/2025-08-20"},{"kind":"archive","url":"https://developer.squareup.com/docs/customers-api/what-it-does"},{"kind":"archive","url":"https://developer.squareup.com/docs/labor-api/what-it-does"},{"kind":"archive","url":"https://developer.squareup.com/docs/payments-api/migrate-from-transactions-api"}],"url":"https://www.okapi.bot/providers/square-api/","json":"https://www.okapi.bot/api/v1/providers/square-api.json","breakingChanges":[{"slug":"post-v2-locations-transactions-stops-working","api":"square-api","title":"POST /v2/locations/{}/transactions stops working","kind":"removal","outcome":"fails","model":null,"announcedAt":null,"effectiveAt":"2026-09-16","scope":null,"calls":["POST /v2/locations/{}/transactions*"],"method":"POST","path":"/v2/locations/{}/transactions*","source":{"url":"https://developer.squareup.com/docs/payments-api/migrate-from-transactions-api","kind":"archive"},"quote":"The Transactions API is deprecated. As of September 16, 2026, its write operations ( Charge, CreateRefund, CaptureTransaction, and VoidTransaction) are retired.","migration":"Charge with POST /v2/payments (CreatePayment), refund with POST /v2/refunds, and for delayed capture use POST /v2/payments/{payment_id}/complete or /cancel.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:25:13.048Z","updatedAt":"2026-10-23T10:25:13.048Z","status":"in_effect","tone":"broken","url":"https://www.okapi.bot/providers/square-api/breaking-changes/post-v2-locations-transactions-stops-working/"},{"slug":"post-mobile-authorization-code-stops-working","api":"square-api","title":"POST /mobile/authorization-code stops working","kind":"removal","outcome":"fails","model":null,"announcedAt":"2025-02-20","effectiveAt":"2025-12-31","scope":null,"calls":["POST /mobile/authorization-code"],"method":"POST","path":"/mobile/authorization-code","source":{"url":"https://developer.squareup.com/docs/changelog/connect-logs/2025-02-20","kind":"archive"},"quote":"The Mobile Authorization API is used by the Reader SDK, which is now deprecated. This API will be retired along with the Reader SDK on December 31, 2025.","migration":"Move the app from the Reader SDK to the Mobile Payments SDK, which authorizes with an OAuth access token and a location ID instead of a mobile authorization code.","migrationChange":null,"needsDecision":"Replacing the Reader SDK with the Mobile Payments SDK is a rewrite of the app's payment flow.","text":null,"publishedAt":"2026-10-23T10:25:11.059Z","updatedAt":"2026-10-23T10:25:11.059Z","status":"in_effect","tone":"broken","url":"https://www.okapi.bot/providers/square-api/breaking-changes/post-mobile-authorization-code-stops-working/"},{"slug":"offline-payment-details-on-post-v2-payments-stops-working","api":"square-api","title":"offline_payment_details on POST /v2/payments stops working","kind":"removal","outcome":"fails","model":null,"announcedAt":"2025-08-20","effectiveAt":"2025-11-19","scope":null,"calls":["POST /v2/payments","body parameter offline_payment_details"],"method":"POST","path":"/v2/payments","source":{"url":"https://developer.squareup.com/docs/changelog/connect-logs/2025-08-20","kind":"archive"},"quote":"The offline_payment_details property of the CreatePayment request is DEPRECATED. It will be retired in 90 days on November 19, 2025","migration":"Stop sending offline_payment_details in CreatePayment requests.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:25:17.730Z","updatedAt":"2026-10-23T10:25:17.730Z","status":"in_effect","tone":"broken","url":"https://www.okapi.bot/providers/square-api/breaking-changes/offline-payment-details-on-post-v2-payments-stops-working/"},{"slug":"v2-customers-cards-is-deprecated","api":"square-api","title":"/v2/customers/{}/cards is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":null,"effectiveAt":null,"scope":null,"calls":["/v2/customers/{}/cards*"],"method":null,"path":"/v2/customers/{}/cards*","source":{"url":"https://developer.squareup.com/docs/customers-api/what-it-does","kind":"archive"},"quote":"The CreateCustomerCard endpoint, DeleteCustomerCard endpoint, and Customer.cards field are deprecated.","migration":"Save cards with the Cards API (POST /v2/cards with the customer_id, POST /v2/cards/{card_id}/disable) and gift cards with the Gift Cards API.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:25:19.724Z","updatedAt":"2026-10-23T10:25:19.724Z","status":"deprecated","tone":"deprecated","url":"https://www.okapi.bot/providers/square-api/breaking-changes/v2-customers-cards-is-deprecated/"},{"slug":"v2-labor-shifts-is-deprecated","api":"square-api","title":"/v2/labor/shifts is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":"2025-05-21","effectiveAt":null,"scope":null,"calls":["/v2/labor/shifts*"],"method":null,"path":"/v2/labor/shifts*","source":{"url":"https://developer.squareup.com/docs/labor-api/what-it-does","kind":"archive"},"quote":"all Shift endpoints ( /v2/labor/shifts/...) are replaced by Timecard endpoints ( /v2/labor/timecards/...) that provide the same functionality.","migration":"Use the Timecard endpoints under /v2/labor/timecards (CreateTimecard, SearchTimecards, RetrieveTimecard, UpdateTimecard, DeleteTimecard).","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:25:21.771Z","updatedAt":"2026-10-23T10:25:21.771Z","status":"deprecated","tone":"deprecated","url":"https://www.okapi.bot/providers/square-api/breaking-changes/v2-labor-shifts-is-deprecated/"},{"slug":"get-v2-locations-transactions-is-deprecated","api":"square-api","title":"GET /v2/locations/{}/transactions is deprecated","kind":"removal","outcome":"fails","model":null,"announcedAt":null,"effectiveAt":null,"scope":null,"calls":["GET /v2/locations/{}/transactions*"],"method":"GET","path":"/v2/locations/{}/transactions*","source":{"url":"https://developer.squareup.com/docs/payments-api/migrate-from-transactions-api","kind":"archive"},"quote":"The Transactions API is deprecated. As of September 16, 2026, its write operations ( Charge, CreateRefund, CaptureTransaction, and VoidTransaction) are retired. Use the Payments API and Refunds API for new payment processing and refunds. Read operations remain available for historical transaction data.","migration":"Read payments with GET /v2/payments and GET /v2/payments/{payment_id}, and refunds with GET /v2/refunds.","migrationChange":null,"needsDecision":null,"text":null,"publishedAt":"2026-10-23T10:25:13.048Z","updatedAt":"2026-10-23T10:25:13.048Z","status":"deprecated","tone":"deprecated","url":"https://www.okapi.bot/providers/square-api/breaking-changes/get-v2-locations-transactions-is-deprecated/"}]}