Square Team API

openapi: 3.0.0
info:
  version: '2.0'
  title: Square ApplePay Team API
  description: 'Supercharge Square for sellers of every size. Our entire connected commerce platform  from elegant hardware to a rich suite of Square APIs  is yours to build with. Whether youre developing an app or composing a bespoke solution, this is the place to make it happen. '
  termsOfService: https://connect.squareup.com/tos
  contact:
    name: Square Developer Platform
    email: developers@squareup.com
    url: https://squareup.com/developers
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  externalDocs:
    description: 'Read the official documentation here:'
    url: https://docs.connect.squareup.com/
  x-server-configuration:
    default-environment: production
    default-server: default
    environments:
    - name: production
      servers:
      - name: default
        url: https://connect.squareup.com
    - name: sandbox
      servers:
      - name: default
        url: https://connect.squareupsandbox.com
    - name: custom
      servers:
      - name: default
        url: '{custom_url}'
    parameters:
    - name: custom_url
      description: Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`
      type: string
      example: https://connect.squareup.com
  x-square-generic-error-codes:
  - ACCESS_TOKEN_EXPIRED
  - ACCESS_TOKEN_REVOKED
  - API_VERSION_INCOMPATIBLE
  - APPLICATION_DISABLED
  - ARRAY_EMPTY
  - ARRAY_LENGTH_TOO_LONG
  - ARRAY_LENGTH_TOO_SHORT
  - BAD_CERTIFICATE
  - BAD_GATEWAY
  - BAD_REQUEST
  - CONFLICT
  - CONFLICTING_PARAMETERS
  - CURRENCY_MISMATCH
  - EXPECTED_ARRAY
  - EXPECTED_BASE64_ENCODED_BYTE_ARRAY
  - EXPECTED_BOOLEAN
  - EXPECTED_FLOAT
  - EXPECTED_INTEGER
  - EXPECTED_JSON_BODY
  - EXPECTED_MAP
  - EXPECTED_OBJECT
  - EXPECTED_STRING
  - FORBIDDEN
  - GATEWAY_TIMEOUT
  - GONE
  - IDEMPOTENCY_KEY_REUSED
  - INCORRECT_TYPE
  - INSUFFICIENT_SCOPES
  - INTERNAL_SERVER_ERROR
  - INVALID_ARRAY_VALUE
  - INVALID_CONTENT_TYPE
  - INVALID_CURSOR
  - INVALID_ENUM_VALUE
  - INVALID_FORM_VALUE
  - INVALID_SORT_ORDER
  - INVALID_SQUARE_VERSION_FORMAT
  - INVALID_TIME
  - INVALID_TIME_RANGE
  - INVALID_VALUE
  - LOCATION_MISMATCH
  - MAP_KEY_LENGTH_TOO_LONG
  - MAP_KEY_LENGTH_TOO_SHORT
  - MERCHANT_SUBSCRIPTION_NOT_FOUND
  - METHOD_NOT_ALLOWED
  - MISSING_REQUIRED_PARAMETER
  - NOT_ACCEPTABLE
  - NOT_FOUND
  - NOT_IMPLEMENTED
  - NO_FIELDS_SET
  - RATE_LIMITED
  - REQUEST_ENTITY_TOO_LARGE
  - REQUEST_TIMEOUT
  - SANDBOX_NOT_SUPPORTED
  - SERVICE_UNAVAILABLE
  - TOO_MANY_MAP_ENTRIES
  - UNAUTHORIZED
  - UNEXPECTED_VALUE
  - UNKNOWN_BODY_PARAMETER
  - UNKNOWN_QUERY_PARAMETER
  - UNPROCESSABLE_ENTITY
  - UNSUPPORTED_MEDIA_TYPE
  - V1_ACCESS_TOKEN
  - V1_APPLICATION
  - VALUE_EMPTY
  - VALUE_REGEX_MISMATCH
  - VALUE_TOO_HIGH
  - VALUE_TOO_LONG
  - VALUE_TOO_LOW
  - VALUE_TOO_SHORT
servers:
- url: https://connect.squareup.com
  variables: {}
tags:
- name: Team
paths:
  /v2/team-members:
    post:
      tags:
      - Team
      summary: Square Create Team Member
      operationId: CreateTeamMember
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Creates a single `TeamMember` object. The `TeamMember` object is returned on successful creates.

        You must provide the following values in your request to this endpoint:

        - `given_name`

        - `family_name`


        Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#createteammember).'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - EMPLOYEES_WRITE
      parameters: []
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateTeamMemberRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateTeamMemberResponse'
      x-endpoint-errors:
      - error-code: INVALID_EMAIL_ADDRESS
      - error-code: BAD_REQUEST
      - error-code: FORBIDDEN
  /v2/team-members/bulk-create:
    post:
      tags:
      - Team
      summary: Square Bulk Create Team Members
      operationId: BulkCreateTeamMembers
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Creates multiple `TeamMember` objects. The created `TeamMember` objects are returned on successful creates.

        This process is non-transactional and processes as much of the request as possible. If one of the creates in

        the request cannot be successfully processed, the request is not marked as failed, but the body of the response

        contains explicit error information for the failed create.


        Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#bulk-create-team-members).'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - EMPLOYEES_WRITE
      parameters: []
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkCreateTeamMembersRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkCreateTeamMembersResponse'
      x-endpoint-errors:
      - error-code: BAD_REQUEST
      - error-code: FORBIDDEN
  /v2/team-members/bulk-update:
    post:
      tags:
      - Team
      summary: Square Bulk Update Team Members
      operationId: BulkUpdateTeamMembers
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Updates multiple `TeamMember` objects. The updated `TeamMember` objects are returned on successful updates.

        This process is non-transactional and processes as much of the request as possible. If one of the updates in

        the request cannot be successfully processed, the request is not marked as failed, but the body of the response

        contains explicit error information for the failed update.

        Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#bulk-update-team-members).'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - EMPLOYEES_WRITE
      parameters: []
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BulkUpdateTeamMembersRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BulkUpdateTeamMembersResponse'
      x-endpoint-errors:
      - error-code: BAD_REQUEST
      - error-code: FORBIDDEN
  /v2/team-members/jobs:
    get:
      tags:
      - Team
      summary: Square List Jobs
      operationId: ListJobs
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Lists jobs in a seller account. Results are sorted by title in ascending order.
      x-release-status: BETA
      security:
      - oauth2:
        - EMPLOYEES_READ
      parameters:
      - name: cursor
        description: 'The pagination cursor returned by the previous call to this endpoint. Provide this

          cursor to retrieve the next page of results for your original request. For more information,

          see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).'
        schema:
          type: string
        in: query
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListJobsResponse'
    post:
      tags:
      - Team
      summary: Square Create Job
      operationId: CreateJob
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Creates a job in a seller account. A job defines a title and tip eligibility. Note that

        compensation is defined in a [job assignment](entity:JobAssignment) in a team member''s wage setting.'
      x-release-status: BETA
      security:
      - oauth2:
        - EMPLOYEES_WRITE
      parameters: []
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateJobRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateJobResponse'
  /v2/team-members/jobs/{job_id}:
    get:
      tags:
      - Team
      summary: Square Retrieve Job
      operationId: RetrieveJob
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Retrieves a specified job.
      x-release-status: BETA
      security:
      - oauth2:
        - EMPLOYEES_READ
      parameters:
      - name: job_id
        description: The ID of the job to retrieve.
        schema:
          type: string
        in: path
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveJobResponse'
    put:
      tags:
      - Team
      summary: Square Update Job
      operationId: UpdateJob
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Updates the title or tip eligibility of a job. Changes to the title propagate to all

        `JobAssignment`, `Shift`, and `TeamMemberWage` objects that reference the job ID. Changes to

        tip eligibility propagate to all `TeamMemberWage` objects that reference the job ID.'
      x-release-status: BETA
      security:
      - oauth2:
        - EMPLOYEES_WRITE
      parameters:
      - name: job_id
        description: The ID of the job to update.
        schema:
          type: string
        in: path
        required: true
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateJobRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateJobResponse'
  /v2/team-members/search:
    post:
      tags:
      - Team
      summary: Square Search Team Members
      operationId: SearchTeamMembers
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: "Returns a paginated list of `TeamMember` objects for a business. \nThe list can be filtered by location IDs, `ACTIVE` or `INACTIVE` status, or whether\nthe team member is the Square account owner."
      x-release-status: PUBLIC
      security:
      - oauth2:
        - EMPLOYEES_READ
      parameters: []
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchTeamMembersRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SearchTeamMembersResponse'
  /v2/team-members/{team_member_id}:
    get:
      tags:
      - Team
      summary: Square Retrieve Team Member
      operationId: RetrieveTeamMember
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Retrieves a `TeamMember` object for the given `TeamMember.id`.

        Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#retrieve-a-team-member).'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - EMPLOYEES_READ
      parameters:
      - name: team_member_id
        description: The ID of the team member to retrieve.
        schema:
          type: string
        in: path
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveTeamMemberResponse'
    put:
      tags:
      - Team
      summary: Square Update Team Member
      operationId: UpdateTeamMember
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Updates a single `TeamMember` object. The `TeamMember` object is returned on successful updates.

        Learn about [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#update-a-team-member).'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - EMPLOYEES_WRITE
      parameters:
      - name: team_member_id
        description: The ID of the team member to update.
        schema:
          type: string
        in: path
        required: true
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateTeamMemberRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateTeamMemberResponse'
      x-endpoint-errors:
      - error-code: INVALID_EMAIL_ADDRESS
      - error-code: BAD_REQUEST
      - error-code: FORBIDDEN
  /v2/team-members/{team_member_id}/wage-setting:
    get:
      tags:
      - Team
      summary: Square Retrieve Wage Setting
      operationId: RetrieveWageSetting
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Retrieves a `WageSetting` object for a team member specified

        by `TeamMember.id`. For more information, see

        [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#retrievewagesetting).


        Square recommends using [RetrieveTeamMember](api-endpoint:Team-RetrieveTeamMember) or [SearchTeamMembers](api-endpoint:Team-SearchTeamMembers)

        to get this information directly from the `TeamMember.wage_setting` field.'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - EMPLOYEES_READ
      parameters:
      - name: team_member_id
        description: The ID of the team member for which to retrieve the wage setting.
        schema:
          type: string
        in: path
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveWageSettingResponse'
    put:
      tags:
      - Team
      summary: Square Update Wage Setting
      operationId: UpdateWageSetting
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Creates or updates a `WageSetting` object. The object is created if a

        `WageSetting` with the specified `team_member_id` doesn''t exist. Otherwise,

        it fully replaces the `WageSetting` object for the team member.

        The `WageSetting` is returned on a successful update. For more information, see

        [Troubleshooting the Team API](https://developer.squareup.com/docs/team/troubleshooting#create-or-update-a-wage-setting).


        Square recommends using [CreateTeamMember](api-endpoint:Team-CreateTeamMember) or [UpdateTeamMember](api-endpoint:Team-UpdateTeamMember)

        to manage the `TeamMember.wage_setting` field directly.'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - EMPLOYEES_WRITE
      parameters:
      - name: team_member_id
        description: The ID of the team member for which to update the `WageSetting` object.
        schema:
          type: string
        in: path
        required: true
      requestBody:
        required: true
        description: 'An object containing the fields to POST for the request.


          See the corresponding object definition for field details.'
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateWageSettingRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateWageSettingResponse'
components:
  schemas:
    CreateTeamMemberRequest:
      type: object
      description: Represents a create request for a `TeamMember` object.
      x-release-status: PUBLIC
      properties:
        idempotency_key:
          type: string
          description: 'A unique string that identifies this `CreateTeamMember` request.

            Keys can be any valid string, but must be unique for every request.

            For more information, see [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).


            The minimum length is 1 and the maximum length is 45.'
        team_member:
          $ref: '#/components/schemas/TeamMember'
          description: '**Required** The data used to create the `TeamMember` object. If you include `wage_setting`, you must provide

            `job_id` for each job assignment. To get job IDs, call [ListJobs](api-endpoint:Team-ListJobs).'
      example:
        idempotency_key: idempotency-key-0
        team_member:
          assigned_locations:
            assignment_type: EXPLICIT_LOCATIONS
            location_ids:
            - YSGH2WBKG94QZ
            - GA2Y9HSJ8KRYT
          email_address: joe_doe@gmail.com
          family_name: Doe
          given_name: Joe
          phone_number: '+14159283333'
          reference_id: reference_id_1
          status: ACTIVE
          wage_setting:
            is_overtime_exempt: true
            job_assignments:
            - annual_rate:
                amount: 3000000
                currency: USD
              job_id: FjS8x95cqHiMenw4f1NAUH4P
              pay_type: SALARY
              weekly_hours: 40
            - hourly_rate:
                amount: 2000
                currency: USD
              job_id: VDNpRv8da51NU8qZFC5zDWpF
              pay_type: HOURLY
    CreateTeamMemberResponse:
      type: object
      description: Represents a response from a create request containing the created `TeamMember` object or error messages.
      x-release-status: PUBLIC
      properties:
        team_member:
          $ref: '#/components/schemas/TeamMember'
          description: The successfully created `TeamMember` object.
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
          description: The errors that occurred during the request.
      example:
        team_member:
          assigned_locations:
            assignment_type: EXPLICIT_LOCATIONS
            location_ids:
            - GA2Y9HSJ8KRYT
            - YSGH2WBKG94QZ
          created_at: '2021-06-11T22:55:45Z'
          email_address: joe_doe@example.com
          family_name: Doe
          given_name: Joe
          id: 1yJlHapkseYnNPETIU1B
          is_owner: false
          phone_number: '+14159283333'
          reference_id: reference_id_1
          status: ACTIVE
          updated_at: '2021-06-11T22:55:45Z'
          wage_setting:
            created_at: '2021-06-11T22:55:45Z'
            is_overtime_exempt: true
            job_assignments:
            - annual_rate:
                amount: 3000000
                currency: USD
              hourly_rate:
                amount: 1443
                currency: USD
              job_id: FjS8x95cqHiMenw4f1NAUH4P
              job_title: Manager
              pay_type: SALARY
              weekly_hours: 40
            - hourly_rate:
                amount: 2000
                currency: USD
              job_id: VDNpRv8da51NU8qZFC5zDWpF
              job_title: Cashier
              pay_type: HOURLY
            team_member_id: 1yJlHapkseYnNPETIU1B
            updated_at: '2021-06-11T22:55:45Z'
            version: 1
    TeamMemberStatus:
      type: string
      enum:
      - ACTIVE
      - INACTIVE
      x-enum-elements:
      - name: ACTIVE
        description: The team member can sign in to Point of Sale and the Seller Dashboard.
      - name: INACTIVE
        description: 'The team member can no longer sign in to Point of Sale or the Seller Dashboard,

          but the team member''s sales reports remain available.'
      description: Enumerates the possible statuses the team member can have within a business.
      x-release-status: PUBLIC
    UpdateTeamMemberRequest:
      type: object
      description: Represents an update request for a `TeamMember` object.
      x-release-status: PUBLIC
      properties:
        team_member:
          $ref: '#/components/schemas/TeamMember'
          description: 'The team member fields to add, change, or clear. Fields can be cleared using a null value. To update

            `wage_setting.job_assignments`, you must provide the complete list of job assignments. If needed, call

            [ListJobs](api-endpoint:Team-ListJobs) to get the required `job_id` values.'
          nullable: true
      example:
        team_member:
          assigned_locations:
            assignment_type: EXPLICIT_LOCATIONS
            location_ids:
            - YSGH2WBKG94QZ
            - GA2Y9HSJ8KRYT
            wage_setting:
              is_overtime_exempt: true
              job_assignments:
              - annual_rate:
                  amount: 3000000
                  currency: USD
                job_id: FjS8x95cqHiMenw4f1NAUH4P
                pay_type: SALARY
                weekly_hours: 40
              - hourly_rate:
                  amount: 1200
                  currency: USD
                job_id: VDNpRv8da51NU8qZFC5zDWpF
                pay_type: HOURLY
          email_address: joe_doe@gmail.com
          family_name: Doe
          given_name: Joe
          phone_number: '+14159283333'
          reference_id: reference_id_1
          status: ACTIVE
    CreateJobRequest:
      type: object
      description: Represents a [CreateJob](api-endpoint:Team-CreateJob) request.
      x-release-status: BETA
      required:
      - job
      - idempotency_key
      properties:
        job:
          $ref: '#/components/schemas/Job'
          description: The job to create. The `title` field is required and `is_tip_eligible` defaults to true.
        idempotency_key:
          type: string
          description: 'A unique identifier for the `CreateJob` request. Keys can be any valid string,

            but must be unique for each request. For more information, see

            [Idempotency](https://developer.squareup.com/docs/build-basics/common-api-patterns/idempotency).'
          minLength: 1
          maxLength: 45
      example:
        idempotency_key: idempotency-key-0
        job:
          is_tip_eligible: true
          title: Cashier
    TeamMemberAssignedLocationsAssignmentType:
      type: string
      enum:
      - ALL_CURRENT_AND_FUTURE_LOCATIONS
      - EXPLICIT_LOCATIONS
      x-enum-elements:
      - name: ALL_CURRENT_AND_FUTURE_LOCATIONS
        description: 'The team member is assigned to all current and future locations. The `location_ids` field

          is empty if the team member has this assignment type.'
      - name: EXPLICIT_LOCATIONS
        description: 'The team member is assigned to an explicit subset of locations. The `location_ids` field

          is the list of locations that the team member is assigned to.'
      description: Enumerates the possible assignment types that the team member can have.
      x-release-status: PUBLIC
    RetrieveJobResponse:
      type: object
      description: 'Represents a [RetrieveJob](api-endpoint:Team-RetrieveJob) response. Either `job` or `errors`

        is present in the response.'
      x-release-status: BETA
      properties:
        job:
          $ref: '#/components/schemas/Job'
          description: The retrieved job.
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
          description: The errors that occurred during the request.
      example:
        job:
          created_at: '2021-06-11T22:55:45Z'
          id: 1yJlHapkseYnNPETIU1B
          is_tip_eligible: true
          title: Cashier 1
          updated_at: '2021-06-11T22:55:45Z'
          version: 2
    ErrorCategory:
      type: string
      enum:
      - API_ERROR
      - AUTHENTICATION_ERROR
      - INVALID_REQUEST_ERROR
      - RATE_LIMIT_ERROR
      - PAYMENT_METHOD_ERROR
      - REFUND_ERROR
      - MERCHANT_SUBSCRIPTION_ERROR
      - EXTERNAL_VENDOR_ERROR
      x-enum-elements:
      - name: API_ERROR
        description: An error occurred with the Connect API itself.
      - name: AUTHENTICATION_ERROR
        description: 'An authentication error occurred. Most commonly, the request had

          a missing, malformed, or otherwise invalid `Authorization` header.'
      - name: INVALID_REQUEST_ERROR
        description: 'The request was invalid. Most commonly, a required parameter was

          missing, or a provided parameter had an invalid value.'
      - name: RATE_LIMIT_ERROR
        description: 'Your application reached the Square API rate limit. You might receive this error if your application sends a high number of requests

          to Square APIs in a short period of time.


          Your application should monitor responses for `429 RATE_LIMITED` errors and use a retry mechanism with an [exponential backoff](https://en.wikipedia.org/wiki/Exponential_backoff)

          schedule to resend the requests at an increasingly slower rate. It is also a good practice to use a randomized delay (jitter) in your retry schedule.'
      - name: PAYMENT_METHOD_ERROR
        description: 'An error occurred while processing a payment method. Most commonly,

          the details of the payment method were invalid (such as a card''s CVV

          or expiration date).'
      - name: REFUND_ERROR
        description: An error occurred while attempting to process a refund.
      - name: MERCHANT_SUBSCRIPTION_ERROR
        description: An error occurred when checking a merchant subscription status
      - name: EXTERNAL_VENDOR_ERROR
        description: An error that is returned from an external vendor's API
      description: 'Indicates which high-level category of error has occurred during a

        request to the Connect API.'
      x-release-status: PUBLIC
    ErrorCode:
      type: string
      enum:
      - INTERNAL_SERVER_ERROR
      - UNAUTHORIZED
      - ACCESS_TOKEN_EXPIRED
      - ACCESS_TOKEN_REVOKED
      - CLIENT_DISABLED
      - FORBIDDEN
      - INSUFFICIENT_SCOPES
      - APPLICATION_DISABLED
      - V1_APPLICATION
      - V1_ACCESS_TOKEN
      - CARD_PROCESSING_NOT_ENABLED
      - MERCHANT_SUBSCRIPTION_NOT_FOUND
      - BAD_REQUEST
      - MISSING_REQUIRED_PARAMETER
      - INCORRECT_TYPE
      - INVALID_TIME
      - INVALID_TIME_RANGE
      - INVALID_VALUE
      - INVALID_CURSOR
      - UNKNOWN_QUERY_PARAMETER
      - CONFLICTING_PARAMETERS
      - EXPECTED_JSON_BODY
      - INVALID_SORT_ORDER
      - VALUE_REGEX_MISMATCH
      - VALUE_TOO_SHORT
      - VALUE_TOO_LONG
      - VALUE_TOO_LOW
      - VALUE_TOO_HIGH
      - VALUE_EMPTY
      - ARRAY_LENGTH_TOO_LONG
      - ARRAY_LENGTH_TOO_SHORT
      - ARRAY_EMPTY
      - EXPECTED_BOOLEAN
      - EXPECTED_INTEGER
      - EXPECTED_FLOAT
      - EXPECTED_STRING
      - EXPECTED_OBJECT
      - EXPECTED_ARRAY
      - EXPECTED_MAP
      - EXPECTED_BASE64_ENCODED_BYTE_ARRAY
      - INVALID_ARRAY_VALUE
      - INVALID_ENUM_VALUE
      - INVALID_CONTENT_TYPE
      - INVALID_FORM_VALUE
      - CUSTOMER_NOT_FOUND
      - ONE_INSTRUMENT_EXPECTED
      - NO_FIELDS_SET
      - TOO_MANY_MAP_ENTRIES
      - MAP_KEY_LENGTH_TOO_SHORT
      - MAP_KEY_LENGTH_TOO_LONG
      - CUSTOMER_MISSING_NAME
      - CUSTOMER_MISSING_EMAIL
      - INVALID_PAUSE_LENGTH
      - INVALID_DATE
      - UNSUPPORTED_COUNTRY
      - UNSUPPORTED_CURRENCY
      - APPLE_TTP_PIN_TOKEN
      - CARD_EXPIRED
      - INVALID_EXPIRATION
      - INVALID_EXPIRATION_YEAR
      - INVALID_EXPIRATION_DATE
      - UNSUPPORTED_CARD_BRAND
      - UNSUPPORTED_ENTRY_METHOD
      - INVALID_ENCRYPTED_CARD
      - INVALID_CARD
      - PAYMENT_AMOUNT_MISMATCH
      - GENERIC_DECLINE
      - CVV_FAILURE
      - ADDRESS_VERIFICATION_FAILURE
      - INVALID_ACCOUNT
      - CURRENCY_MISMATCH
      - INSUFFICIENT_FUNDS
      - INSUFFICIENT_PERMISSIONS
      - CARDHOLDER_INSUFFICIENT_PERMISSIONS
      - INVALID_LOCATION
      - TRANSACTION_LIMIT
      - VOICE_FAILURE
      - PAN_FAILURE
      - EXPIRATION_FAILURE
      - CARD_NOT_SUPPORTED
      - INVALID_PIN
      - MISSING_PIN
      - MISSING_ACCOUNT_TYPE
      - INVALID_POSTAL_CODE
      - INVALID_FEES
      - MANUALLY_ENTERED_PAYMENT_NOT_SUPPORTED
      - PAYMENT_LIMIT_EXCEEDED
      - GIFT_CARD_AVAILABLE_AMOUNT
      - ACCOUNT_UNUSABLE
      - BUYER_REFUSED_PAYMENT
      - DELAYED_TRANSACTION_EXPIRED
      - DELAYED_TRANSACTION_CANCELED
      - DELAYED_TRANSACTION_CAPTURED
      - DELAYED_TRANSACTION_FAILED
      - CARD_TOKEN_EXPIRED
      - CARD_TOKEN_USED
      - AMOUNT_TOO_HIGH
      - UNSUPPORTED_INSTRUMENT_TYPE
      - REFUND_AMOUNT_INVALID
      - REFUND_ALREADY_PENDING
      - PAYMENT_NOT_REFUNDABLE
      - PAYMENT_NOT_REFUNDABLE_DUE_TO_DISPUTE
      - REFUND_DECLINED
      - INSUFFICIENT_PERMISSIONS_FOR_REFUND
      - INVALID_CARD_DATA
      - SOURCE_USED
      - SOURCE_EXPIRED
      - UNSUPPORTED_LOYALTY_REWARD_TIER
      - LOCATION_MISMATCH
      - IDEMPOTENCY_KEY_REUSED
      - UNEXPECTED_VALUE
      - SANDBOX_NOT_SUPPORTED
      - INVALID_EMAIL_ADDRESS
      - INVALID_PHONE_NUMBER
      - CHECKOUT_EXPIRED
      - BAD_CERTIFICATE
      - INVALID_SQUARE_VERSION_FORMAT
      - API_VERSION_INCOMPATIBLE
      - CARD_PRESENCE_REQUIRED
      - UNSUPPORTED_SOURCE_TYPE
      - CARD_MISMATCH
      - PLAID_ERROR
      - PLAID_ERROR_ITEM_LOGIN_REQUIRED
      - PLAID_ERROR_RATE_LIMIT
      - CARD_DECLINED
      - VERIFY_CVV_FAILURE
      - VERIFY_AVS_FAILURE
      - CARD_DECLINED_CALL_ISSUER
      - CARD_DECLINED_VERIFICATION_REQUIRED
      - BAD_EXPIRATION
      - CHIP_INSERTION_REQUIRED
      - ALLOWABLE_PIN_TRIES_EXCEEDED
      - RESERVATION_DECLINED
      - UNKNOWN_BODY_PARAMETER
      - NOT_FOUND
      - APPLE_PAYMENT_PROCESSING_CERTIFICATE_HASH_NOT_FOUND
      - METHOD_NOT_ALLOWED
      - NOT_ACCEPTABLE
      - REQUEST_TIMEOUT
      - CONFLICT
      - GONE
      - REQUEST_ENTITY_TOO_LARGE
      - UNSUPPORTED_MEDIA_TYPE
      - UNPROCESSABLE_ENTITY
      - RATE_LIMITED
      - NOT_IMPLEMENTED
      - BAD_GATEWAY
      - SERVICE_UNAVAILABLE
      - TEMPORARY_ERROR
      - GATEWAY_TIMEOUT
      x-enum-elements:
      - name: INTERNAL_SERVER_ERROR
        description: A general server error occurred.
        error-category: API_ERROR
      - name: UNAUTHORIZED
        description: A general authorization error occurred.
        error-category: AUTHENTICATION_ERROR
      - name: ACCESS_TOKEN_EXPIRED
        description: The provided access token has expired.
        error-category: AUTHENTICATION_ERROR
      - name: ACCESS_TOKEN_REVOKED
        description: The provided access token has been revoked.
        error-category: AUTHENTICATION_ERROR
      - name: CLIENT_DISABLED
        description: The 

# --- truncated at 32 KB (119 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/square/refs/heads/main/openapi/square-team-api-openapi.yml