OAuth

Permissions Reference

To get a scoped OAuth access token used in calling a Square API endpoint, you need to specify the permissions that your application needs to access Square account resources. The permissions you specify are shown to the user in an authorization dialog box that lets the user grant access to your application.

The following sections list and describe all the Square API services, their endpoints, and the OAuth scopes (permissions) needed to access them.

Bank Accounts Permalink Get a link to this section

The Bank Accounts API lets developers retrieve information about the bank accounts linked to a Square account.

API
Permission
GetBankAccountBANK_ACCOUNTS_READ
ListBankAccountsBANK_ACCOUNTS_READ
GetBankAccountByV1IdBANK_ACCOUNTS_READ

Catalog Permalink Get a link to this section

Sync items to Square Point of Sale to itemize payments consistently across all channels.

API
Permission
BatchDeleteCatalogObjectsITEMS_WRITE
BatchUpsertCatalogObjectsITEMS_WRITE
BatchRetrieveCatalogObjectsITEMS_READ
CatalogInfoITEMS_READ
CreateCatalogImageITEMS_WRITE
DeleteCatalogObjectITEMS_WRITE
ListCatalogITEMS_READ
RetrieveCatalogObjectITEMS_READ
SearchCatalogObjectsITEMS_READ
UpdateItemTaxesITEMS_WRITE
UpdateItemModifierListsITEMS_WRITE
UpsertCatalogObjectITEMS_WRITE

Cash Drawer Shifts Permalink Get a link to this section

Get details about cash drawer shifts.

API
Permission
ListCashDrawerShiftsCASH_DRAWER_READ
ListCashDrawerShiftEventsCASH_DRAWER_READ
RetrieveCashDrawerShiftCASH_DRAWER_READ

Checkout Permalink Get a link to this section

Accept itemized payments on a Square-hosted web page. No frontend experience required.

API
Permission
CreateCheckoutORDERS_WRITE
PAYMENTS_WRITE
PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS

Customers Permalink Get a link to this section

Save cards on file for customers and sync CRM systems with Square.

API
Permission
AddGroupToCustomerCUSTOMERS_WRITE
CreateCustomerCUSTOMERS_WRITE
CreateCustomerCardCUSTOMERS_WRITE
DeleteCustomerCUSTOMERS_WRITE
DeleteCustomerCardCUSTOMERS_WRITE
ListCustomersCUSTOMERS_READ
RemoveGroupFromCustomerCUSTOMERS_WRITE
RetrieveCustomerCUSTOMERS_READ
SearchCustomersCUSTOMERS_READ
UpdateCustomerCUSTOMERS_WRITE

Customer Groups Permalink Get a link to this section

Manage customers by groups.

API
Permission
CreateCustomerGroupCUSTOMERS_WRITE
DeleteCustomerGroupCUSTOMERS_WRITE
ListCustomerGroupsCUSTOMERS_READ
RetrieveCustomerGroupCUSTOMERS_READ
UpdateCustomerGroupCUSTOMERS_READ
CUSTOMERS_WRITE

Customer Segments Permalink Get a link to this section

Manage customers by segments.

API
Permission
ListCustomerSegmentsCUSTOMERS_READ
RetrieveCustomerSegmentCUSTOMERS_READ

Devices Permalink Get a link to this section

Use the Devices API to configure a Square Terminal.

API
Permission
CreateDeviceCodeDEVICE_CREDENTIAL_MANAGEMENT
GetDeviceCodeDEVICE_CREDENTIAL_MANAGEMENT
ListDeviceCodesDEVICE_CREDENTIAL_MANAGEMENT

Disputes Permalink Get a link to this section

Use the Disputes API to manage disputes (chargebacks).

API
Permission
AcceptDisputePAYMENTS_WRITE
CreateDisputeEvidenceFilePAYMENTS_WRITE
CreateDisputeEvidenceTextPAYMENTS_WRITE
ListDisputeEvidencePAYMENTS_READ
ListDisputesPAYMENTS_READ
RemoveDisputeEvidencePAYMENTS_WRITE
RetrieveDisputePAYMENTS_READ
RetrieveDisputeEvidencePAYMENTS_READ
SubmitEvidencePAYMENTS_WRITE

Employees Permalink Get a link to this section

Provides a query endpoint to get a list of the employees for a seller.

API
Permission
ListEmployeesEMPLOYEES_READ
RetrieveEmployeeEMPLOYEES_READ

Inventory Permalink Get a link to this section

Keep an inventory of catalog items in sync across all commerce channels.

API
Permission
BatchChangeInventoryINVENTORY_WRITE
BatchRetrieveInventoryCountsINVENTORY_READ
BatchRetrieveInventoryChangesINVENTORY_READ
RetrieveInventoryAdjustmentINVENTORY_READ
RetrieveInventoryChangesINVENTORY_READ
RetrieveInventoryCountINVENTORY_READ
RetrieveInventoryPhysicalCountINVENTORY_READ

Invoices Permalink Get a link to this section

Use the Invoices API to manage invoices.

API
Permissions
ListInvoicesINVOICES_READ
CreateInvoiceINVOICES_WRITE
ORDERS_WRITE
SearchInvoicesINVOICES_READ
DeleteInvoiceINVOICES_WRITE
ORDERS_WRITE
GetInvoiceINVOICES_READ
UpdateInvoiceINVOICES_WRITE
ORDERS_WRITE
CancelInvoiceINVOICES_WRITE
ORDERS_WRITE
PublishInvoiceINVOICES_WRITE
ORDERS_WRITE

Labor Permalink Get a link to this section

Manage shifts, breaks, and wages for employees in Square Point of Sale.

API
Permission
CreateBreakTypeTIMECARDS_SETTINGS_WRITE
CreateShiftTIMECARDS_WRITE
DeleteBreakTypeTIMECARDS_SETTINGS_WRITE
DeleteShiftTIMECARDS_SETTINGS_WRITE
GetBreakTypeTIMECARDS_SETTINGS_READ
GetEmployeeWageEMPLOYEES_READ
GetShiftTIMECARDS_READ
ListBreakTypesTIMECARDS_SETTINGS_READ
ListEmployeeWagesEMPLOYEES_READ
ListWorkweekConfigsTIMECARDS_SETTINGS_READ
SearchShiftsTIMECARDS_READ
UpdateShiftTIMECARDS_WRITE
TIMECARDS_READ
UpdateWorkweekConfigTIMECARDS_SETTINGS_READ
TIMECARDS_SETTINGS_WRITE
UpdateBreakTypeTIMECARDS_SETTINGS_READ
TIMECARDS_SETTINGS_WRITE

Locations Permalink Get a link to this section

Get a list of a seller's locations.

API
Permission
CreateLocationMERCHANT_PROFILE_WRITE
ListLocationsMERCHANT_PROFILE_READ
RetrieveLocationMERCHANT_PROFILE_READ
UpdateLocationMERCHANT_PROFILE_WRITE

Loyalty Permalink Get a link to this section

Provides endpoints to access the buyer loyalty program.

API
Permission
AccumulateLoyaltyPointsLOYALTY_WRITE
AdjustLoyaltyPointsLOYALTY_WRITE
CalculateLoyaltyPointsLOYALTY_READ
CreateLoyaltyAccountLOYALTY_WRITE
CreateLoyaltyRewardLOYALTY_WRITE
DeleteLoyaltyRewardLOYALTY_WRITE
ListLoyaltyProgramsLOYALTY_READ
RedeemLoyaltyRewardLOYALTY_WRITE
RetrieveLoyaltyAccountLOYALTY_READ
RetrieveLoyaltyRewardLOYALTY_READ
SearchLoyaltyAccountsLOYALTY_READ
SearchLoyaltyEventsLOYALTY_READ
SearchLoyaltyRewardsLOYALTY_READ

Merchants Permalink Get a link to this section

Use the Merchants API to retrieve information about a Square merchant account.

API
Permission
ListMerchantsMERCHANT_PROFILE_READ
RetrieveMerchantMERCHANT_PROFILE_READ

Mobile Authorization Permalink Get a link to this section

Provides an endpoint for getting a mobile authorization code for use in Reader SDK applications.

API
Permission
CreateMobileAuthorizationCodePAYMENTS_WRITE_IN_PERSON

Orders Permalink Get a link to this section

Get sales data for a Square seller, itemize payments, push orders to Point of Sale, and more.

API
Permission
CalculateOrderN/A
CreateOrderORDERS_WRITE
BatchRetrieveOrdersORDERS_READ
PayOrderORDERS_WRITE
PAYMENTS_WRITE
SearchOrdersORDERS_READ
UpdateOrderORDERS_WRITE

Payments and Refunds Permalink Get a link to this section

The Payments API lets developers take and manage payments.

API
Permission
CancelPaymentPAYMENTS_WRITE
CancelPaymentByIdempotencyKeyPAYMENTS_WRITE
CompletePaymentPAYMENTS_WRITE
CreatePaymentPAYMENTS_WRITE
PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS
GetPaymentPAYMENTS_READ
GetPaymentRefundPAYMENTS_READ
ListPaymentsPAYMENTS_READ
ListPaymentRefundsPAYMENTS_READ
RefundPaymentPAYMENTS_WRITE
PAYMENTS_WRITE_ADDITIONAL_RECIPIENTS

Subscriptions Permalink Get a link to this section

Use the Subscriptions API to manage subscriptions. For more information about required permissions to create and update subscriptions, see Requirements and limitations.

API
Permissions
CreateSubscriptionCUSTOMERS_READ
PAYMENTS_WRITE
SUBSCRIPTIONS_WRITE
ITEMS_READ
ORDERS_WRITE
INVOICES_WRITE
SearchSubscriptionsSUBSCRIPTIONS_READ
RetrieveSubscriptionSUBSCRIPTIONS_READ
UpdateSubscriptionCUSTOMERS_READ
PAYMENTS_WRITE
SUBSCRIPTIONS_WRITE
ITEMS_READ
ORDERS_WRITE
INVOICES_WRITE
CancelSubscriptionSUBSCRIPTIONS_WRITE
ListSubscriptionEventsSUBSCRIPTIONS_READ

Team Permalink Get a link to this section

The Team API lets developers manage team members and integrate Square with a third-party payroll system.

API
Permission
BulkCreateTeamMembersEMPLOYEES_WRITE
BulkUpdateTeamMembersEMPLOYEES_WRITE
CreateTeamMemberEMPLOYEES_WRITE
UpdateTeamMemberEMPLOYEES_WRITE
RetrieveTeamMemberEMPLOYEES_READ
RetrieveWageSettingEMPLOYEES_READ
SearchTeamMembersEMPLOYEES_READ
UpdateWageSettingEMPLOYEES_READ

Terminal Permalink Get a link to this section

The Terminal API lets developers request Square Terminal checkouts and process Interac refunds.

API
Permission
CreateTerminalCheckoutPAYMENTS_WRITE
CancelTerminalCheckoutPAYMENTS_WRITE
GetTerminalCheckoutPAYMENTS_READ
SearchTerminalCheckoutsPAYMENTS_READ
CreateTerminalRefundPAYMENTS_WRITE
CancelTerminalRefundPAYMENTS_WRITE
GetTerminalRefundPAYMENTS_READ
SearchTerminalRefundsPAYMENTS_READ