Square API

You are viewing an old version of the API

2022-09-21

Version 2022-09-21

• All Versions

Square API

Deprecated

---

Checkout

• Create checkout

  DEPRECATED POST /v2/locations/{location_id}/checkouts - Links a checkoutId to a checkout_page_url that customers are directed to in order to provide their payment information using a payment processing workflow hosted on connect.squareup.com.

Customers

• Create customer card

  DEPRECATED POST /v2/customers/{customer_id}/cards - Adds a card on file to an existing customer.

• Delete customer card

  DEPRECATED DELETE /v2/customers/{customer_id}/cards/{card_id} - Removes a card on file from a customer.

Employees

• List employees

  DEPRECATED GET /v2/employees -

• Retrieve employee

  DEPRECATED GET /v2/employees/{id} -

Inventory

• Deprecated retrieve inventory adjustment

  DEPRECATED GET /v2/inventory/adjustment/{adjustment_id} - Deprecated version of RetrieveInventoryAdjustment after the endpoint URL is updated to conform to the standard convention.

• Deprecated batch change inventory

  DEPRECATED POST /v2/inventory/batch-change - Deprecated version of BatchChangeInventory after the endpoint URL is updated to conform to the standard convention.

• Deprecated batch retrieve inventory changes

  DEPRECATED POST /v2/inventory/batch-retrieve-changes - Deprecated version of BatchRetrieveInventoryChanges after the endpoint URL is updated to conform to the standard convention.

• Deprecated batch retrieve inventory counts

  DEPRECATED POST /v2/inventory/batch-retrieve-counts - Deprecated version of BatchRetrieveInventoryCounts after the endpoint URL is updated to conform to the standard convention.

• Deprecated retrieve inventory physical count

  DEPRECATED GET /v2/inventory/physical-count/{physical_count_id} - Deprecated version of RetrieveInventoryPhysicalCount after the endpoint URL is updated to conform to the standard convention.

• Retrieve inventory changes

  DEPRECATED GET /v2/inventory/{catalog_object_id}/changes - Returns a set of physical counts and inventory adjustments for the provided CatalogObject at the requested Locations.

Labor

• List employee wages

  DEPRECATED GET /v2/labor/employee-wages - Returns a paginated list of EmployeeWage instances for a business.

• Get employee wage

  DEPRECATED GET /v2/labor/employee-wages/{id} - Returns a single EmployeeWage specified by id.

Loyalty

• List loyalty programs

  DEPRECATED GET /v2/loyalty/programs - Returns a list of loyalty programs in the seller's account.

OAuth

• Renew token

  DEPRECATED POST /oauth2/clients/{client_id}/access-token/renew - RenewToken is deprecated.

Payments

• V1 list payments

  DEPRECATED GET /v1/{location_id}/payments - Provides summary information for all payments taken for a given Square account during a date range.

  V1

• V1 retrieve payment

  DEPRECATED GET /v1/{location_id}/payments/{payment_id} - Provides comprehensive information for a single payment.

  V1

Refunds

• V1 list refunds

  DEPRECATED GET /v1/{location_id}/refunds - Provides the details for all refunds initiated by a merchant or any of the merchant's mobile staff during a date range.

  V1

• V1 create refund

  DEPRECATED POST /v1/{location_id}/refunds - Issues a refund for a previously processed payment.

  V1

Settlements

• V1 list settlements

  DEPRECATED GET /v1/{location_id}/settlements - Provides summary information for all deposits and withdrawals initiated by Square to a linked bank account during a date range.

  V1

• V1 retrieve settlement

  DEPRECATED GET /v1/{location_id}/settlements/{settlement_id} - Provides comprehensive information for a single settlement.

  V1

Transactions

• List transactions

  DEPRECATED GET /v2/locations/{location_id}/transactions - Lists transactions for a particular location.

• Retrieve transaction

  DEPRECATED GET /v2/locations/{location_id}/transactions/{transaction_id} - Retrieves details for a single transaction.

• Capture transaction

  DEPRECATED POST /v2/locations/{location_id}/transactions/{transaction_id}/capture - Captures a transaction that was created with the Charge endpoint with a delay_capture value of true.

• Void transaction

  DEPRECATED POST /v2/locations/{location_id}/transactions/{transaction_id}/void - Cancels a transaction that was created with the Charge endpoint with a delay_capture value of true.

V1 Batching

• V1 submit batch

  DEPRECATED POST /v1/batch - Bundle multiple requests to Connect V1 API endpoints as a single request.

  V1