Enum
OAuthPermission
When you direct your user to the permissions form, you specify the scope of the permissions your application will have.
Personal access tokens have all available permissions (at the time the application was created) by default.
Important: Never request more than the minimum permissions required for your application to function properly.
Values
BANK_
HTTP Method: Grants read access to bank account information associated with the targeted Square account. For example, to call the Connect v1 ListBankAccounts endpoint. |
CASH_
HTTP Method: Grants read access to cash drawer shift information. For example, to call the ListCashDrawerShifts endpoint. |
CUSTOMERS_
HTTP Method: Grants read access to customer information. For example, to call the ListCustomers endpoint. |
CUSTOMERS_
HTTP Method: Grants write access to customer information. For example, to create and update customer profiles. |
DEVICE_
HTTP Method: Grants read/write access to device credentials information. For example, to call the CreateDeviceCode endpoint. |
EMPLOYEES_
HTTP Method: Grants read access to employee profile information. For example, to call the Connect v1 Employees API. |
EMPLOYEES_
HTTP Method: Grants write access to employee profile information. For example, to create and modify employee profiles. |
INVENTORY_
HTTP Method: Grants read access to inventory information. For example, to call the RetrieveInventoryCount endpoint. |
INVENTORY_
HTTP Method: Grants write access to inventory information. For example, to call the BatchChangeInventory endpoint. |
ITEMS_
HTTP Method: Grants read access to product catalog information. For example, to obtain objects in a product catalog. |
ITEMS_
HTTP Method: Grants write access to product catalog information. For example, to modify or add to a product catalog. |
LOYALTY_
HTTP Method: Grants read access to loyalty information. For example, to call the ListLoyaltyPrograms endpoint. |
LOYALTY_
HTTP Method: Grants write access to loyalty information. For example, to call the CreateLoyaltyAccount endpoint. |
MERCHANT_
HTTP Method: Grants read access to business and location information. For example, to obtain a location ID for subsequent activity. |
ORDERS_
HTTP Method: Grants read access to order information. For example, to call the BatchRetrieveOrders endpoint. |
ORDERS_
HTTP Method: Grants write access to order information. For example, to call the CreateCheckout endpoint. |
PAYMENTS_
HTTP Method: Grants read access to transaction and refund information. For example, to call the RetrieveTransaction endpoint. |
PAYMENTS_
HTTP Method: Grants write access to transaction and refunds information. For example, to process payments with the Payments or Checkout API. |
PAYMENTS_
HTTP Method: Allow third party applications to deduct a portion of each transaction amount. Required to use multiparty transaction functionality with the Payments API. |
PAYMENTS_
HTTP Method: Grants write access to payments and refunds information. For example, to process in-person payments. |
SETTLEMENTS_
HTTP Method: Grants read access to settlement (deposit) information. For example, to call the Connect v1 ListSettlements endpoint. |
TIMECARDS_
HTTP Method: Grants read access to employee timecard information. For example, to call the Connect v2 SearchShifts endpoint. |
TIMECARDS_
HTTP Method: Grants write access to employee shift information. For example, to create and modify employee shifts. |
TIMECARDS_
HTTP Method: Grants read access to employee timecard settings information. For example, to call the GetBreakType endpoint. |
TIMECARDS_
HTTP Method: Grants write access to employee timecard settings information. For example, to call the UpdateBreakType endpoint. |
APPOINTMENTS_
HTTP Method: Grants read access to booking information. For example, to call the RetrieveBooking endpoint. |
APPOINTMENTS_
HTTP Method: Grants write access to booking information. For example, to call the CreateBooking endpoint. |
APPOINTMENTS_
HTTP Method: Grants read access to booking business settings. For example, to call the ListTeamMemberBookingProfiles endpoint. |
INVOICES_
HTTP Method: Grants read access to invoice information. For example, to call the ListInvoices endpoint. |
INVOICES_
HTTP Method: Grants write access to invoice information. For example, to call the CreateInvoice endpoint. |
SUBSCRIPTIONS_
HTTP Method: Grants read access to subscription information. For example, to call the RetrieveSubscription endpoint. |
SUBSCRIPTIONS_
HTTP Method: Grants write access to subscription information. For example, to call the CreateSubscription endpoint. |
DISPUTES_
HTTP Method: Grants read access to dispute information. For example, to call the RetrieveDispute endpoint. |
DISPUTES_
HTTP Method: Grants write access to dispute information. For example, to call the SubmitEvidence endpoint. |
GIFTCARDS_
HTTP Method: Grants read access to gift card information. For example, to call the RetrieveGiftCard endpoint. |
GIFTCARDS_
HTTP Method: Grants write access to gift card information. For example, to call the CreateGiftCard endpoint. |
ONLINE_
HTTP Method: Write access to ECOM online store snippets on published websites. |
ONLINE_
HTTP Method: Read access to ECOM online store snippets on published websites. |
ONLINE_
HTTP Method: Read access to ECOM online store site details. |
PAYMENTS_
HTTP Method: Allows the developer to process payments on behalf of a seller using a shared on file payment method. |
APPOINTMENTS_
HTTP Method: Grants read access to all of a seller's booking information, calendar, and business details.
This permission must be accompanied by the |
APPOINTMENTS_
HTTP Method: Grants write access to all booking details, including double-booking a seller.
This permission must be accompanied by the |
MERCHANT_
HTTP Method: Grants write access to business and location information. For example, to create a new location or update the business hours at an existing location. |
VENDOR_
Beta
HTTP Method: Grants read access to vendor information, for example, when calling the
|
VENDOR_
Beta
HTTP Method: Grants write access to vendor information, for example, when calling the
|
PAYOUTS_
Beta
HTTP Method: Grants read access to payouts and payout entries information. For example,
to call the Connect v2 |