Square WebhookSubscriptions API

openapi: 3.2.0
info:
  version: '2.0'
  title: Square ApplePay Webhook Subscriptions 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: WebhookSubscriptions
paths:
  /v2/webhooks/event-types:
    get:
      tags:
      - WebhookSubscriptions
      summary: Square List Webhook Event Types
      operationId: ListWebhookEventTypes
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Lists all webhook event types that can be subscribed to.
      x-release-status: PUBLIC
      security:
      - oauth2: []
      parameters:
      - name: api_version
        description: The API version for which to list event types. Setting this field overrides the default version used by the application.
        schema:
          type: string
        in: query
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWebhookEventTypesResponse'
  /v2/webhooks/subscriptions:
    get:
      tags:
      - WebhookSubscriptions
      summary: Square List Webhook Subscriptions
      operationId: ListWebhookSubscriptions
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Lists all webhook subscriptions owned by your application.
      x-release-status: PUBLIC
      security:
      - oauth2: []
      parameters:
      - name: cursor
        description: 'A pagination cursor returned by a previous call to this endpoint.

          Provide this to retrieve the next set of results for your original query.


          For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).'
        schema:
          type: string
        in: query
        required: false
      - name: include_disabled
        description: 'Includes disabled [Subscription](entity:WebhookSubscription)s.

          By default, all enabled [Subscription](entity:WebhookSubscription)s are returned.'
        schema:
          type: boolean
          default: false
        in: query
        required: false
      - name: sort_order
        description: 'Sorts the returned list by when the [Subscription](entity:WebhookSubscription) was created with the specified order.

          This field defaults to ASC.'
        schema:
          $ref: '#/components/schemas/SortOrder'
        in: query
        required: false
      - name: limit
        description: 'The maximum number of results to be returned in a single page.

          It is possible to receive fewer results than the specified limit on a given page.

          The default value of 100 is also the maximum allowed value.


          Default: 100'
        schema:
          type: integer
        in: query
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListWebhookSubscriptionsResponse'
    post:
      tags:
      - WebhookSubscriptions
      summary: Square Create Webhook Subscription
      operationId: CreateWebhookSubscription
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Creates a webhook subscription.
      x-release-status: PUBLIC
      security:
      - oauth2: []
      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/CreateWebhookSubscriptionRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateWebhookSubscriptionResponse'
  /v2/webhooks/subscriptions/{subscription_id}:
    delete:
      tags:
      - WebhookSubscriptions
      summary: Square Delete Webhook Subscription
      operationId: DeleteWebhookSubscription
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Deletes a webhook subscription.
      x-release-status: PUBLIC
      security:
      - oauth2: []
      parameters:
      - name: subscription_id
        description: '[REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to delete.'
        schema:
          type: string
        in: path
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteWebhookSubscriptionResponse'
    get:
      tags:
      - WebhookSubscriptions
      summary: Square Retrieve Webhook Subscription
      operationId: RetrieveWebhookSubscription
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Retrieves a webhook subscription identified by its ID.
      x-release-status: PUBLIC
      security:
      - oauth2: []
      parameters:
      - name: subscription_id
        description: '[REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to retrieve.'
        schema:
          type: string
        in: path
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveWebhookSubscriptionResponse'
    put:
      tags:
      - WebhookSubscriptions
      summary: Square Update Webhook Subscription
      operationId: UpdateWebhookSubscription
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Updates a webhook subscription.
      x-release-status: PUBLIC
      security:
      - oauth2: []
      parameters:
      - name: subscription_id
        description: '[REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) 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/UpdateWebhookSubscriptionRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateWebhookSubscriptionResponse'
  /v2/webhooks/subscriptions/{subscription_id}/signature-key:
    post:
      tags:
      - WebhookSubscriptions
      summary: Square Update Webhook Subscription Signature Key
      operationId: UpdateWebhookSubscriptionSignatureKey
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Updates a webhook subscription by replacing the existing signature key with a new one.
      x-release-status: PUBLIC
      security:
      - oauth2: []
      parameters:
      - name: subscription_id
        description: '[REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) 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/UpdateWebhookSubscriptionSignatureKeyRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateWebhookSubscriptionSignatureKeyResponse'
  /v2/webhooks/subscriptions/{subscription_id}/test:
    post:
      tags:
      - WebhookSubscriptions
      summary: Square Test Webhook Subscription
      operationId: TestWebhookSubscription
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Tests a webhook subscription by sending a test event to the notification URL.
      x-release-status: PUBLIC
      security:
      - oauth2: []
      parameters:
      - name: subscription_id
        description: '[REQUIRED] The ID of the [Subscription](entity:WebhookSubscription) to test.'
        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/TestWebhookSubscriptionRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestWebhookSubscriptionResponse'
components:
  schemas:
    EventTypeMetadata:
      type: object
      description: Contains the metadata of a webhook event type.
      x-release-status: PUBLIC
      properties:
        event_type:
          type: string
          description: The event type.
          readOnly: true
        api_version_introduced:
          type: string
          description: The API version at which the event type was introduced.
          readOnly: true
        release_status:
          type: string
          description: The release status of the event type.
          readOnly: true
    TestWebhookSubscriptionResponse:
      type: object
      description: 'Defines the fields that are included in the response body of

        a request to the [TestWebhookSubscription](api-endpoint:WebhookSubscriptions-TestWebhookSubscription) endpoint.


        Note: If there are errors processing the request, the [SubscriptionTestResult](entity:SubscriptionTestResult) field is not

        present.'
      x-release-status: PUBLIC
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
          description: Information on errors encountered during the request.
        subscription_test_result:
          $ref: '#/components/schemas/SubscriptionTestResult'
          description: The [SubscriptionTestResult](entity:SubscriptionTestResult).
      example:
        subscription_test_result:
          created_at: 2022-01-11 00:06:48.322945116 +0000 UTC m=+3863.054453746
          id: 23eed5a9-2b12-403e-b212-7e2889aea0f6
          payload: '{"merchant_id":"1ZYMKZY1YFGBW","type":"payment.created","event_id":"23eed5a9-2b12-403e-b212-7e2889aea0f6","created_at":"2022-01-11T00:06:48.322945116Z","data":{"type":"payment","id":"KkAkhdMsgzn59SM8A89WgKwekxLZY","object":{"payment":{"amount_money":{"amount":100,"currency":"USD"},"approved_money":{"amount":100,"currency":"USD"},"capabilities":["EDIT_TIP_AMOUNT","EDIT_TIP_AMOUNT_UP","EDIT_TIP_AMOUNT_DOWN"],"card_details":{"avs_status":"AVS_ACCEPTED","card":{"bin":"540988","card_brand":"MASTERCARD","card_type":"CREDIT","exp_month":11,"exp_year":2022,"fingerprint":"sq-1-Tvruf3vPQxlvI6n0IcKYfBukrcv6IqWr8UyBdViWXU2yzGn5VMJvrsHMKpINMhPmVg","last_4":"9029","prepaid_type":"NOT_PREPAID"},"card_payment_timeline":{"authorized_at":"2020-11-22T21:16:51.198Z"},"cvv_status":"CVV_ACCEPTED","entry_method":"KEYED","statement_description":"SQ *DEFAULT TEST ACCOUNT","status":"AUTHORIZED"},"created_at":"2020-11-22T21:16:51.086Z","delay_action":"CANCEL","delay_duration":"PT168H","delayed_until":"2020-11-29T21:16:51.086Z","id":"hYy9pRFVxpDsO1FB05SunFWUe9JZY","location_id":"S8GWD5R9QB376","order_id":"03O3USaPaAaFnI6kkwB1JxGgBsUZY","receipt_number":"hYy9","risk_evaluation":{"created_at":"2020-11-22T21:16:51.198Z","risk_level":"NORMAL"},"source_type":"CARD","status":"APPROVED","total_money":{"amount":100,"currency":"USD"},"updated_at":"2020-11-22T21:16:51.198Z","version_token":"FfQhQJf9r3VSQIgyWBk1oqhIwiznLwVwJbVVA0bdyEv6o"}}}}'
          status_code: 404
          updated_at: 2022-01-11 00:06:48.322945116 +0000 UTC m=+3863.054453746
    WebhookSubscription:
      type: object
      description: 'Represents the details of a webhook subscription, including notification URL,

        event types, and signature key.'
      x-release-status: PUBLIC
      properties:
        id:
          type: string
          description: A Square-generated unique ID for the subscription.
          maxLength: 64
          readOnly: true
        name:
          type:
          - string
          - 'null'
          description: The name of this subscription.
          maxLength: 64
        enabled:
          type:
          - boolean
          - 'null'
          description: Indicates whether the subscription is enabled (`true`) or not (`false`).
        event_types:
          type:
          - array
          - 'null'
          items:
            type: string
          description: The event types associated with this subscription.
        notification_url:
          type:
          - string
          - 'null'
          description: The URL to which webhooks are sent.
        api_version:
          type:
          - string
          - 'null'
          description: "The API version of the subscription.\nThis field is optional for `CreateWebhookSubscription`. \nThe value defaults to the API version used by the application."
        signature_key:
          type: string
          description: The Square-generated signature key used to validate the origin of the webhook event.
          readOnly: true
        created_at:
          type: string
          description: The timestamp of when the subscription was created, in RFC 3339 format. For example, "2016-09-04T23:59:33.123Z".
          readOnly: true
        updated_at:
          type: string
          description: 'The timestamp of when the subscription was last updated, in RFC 3339 format.

            For example, "2016-09-04T23:59:33.123Z".'
          readOnly: true
    ListWebhookSubscriptionsResponse:
      type: object
      description: 'Defines the fields that are included in the response body of

        a request to the [ListWebhookSubscriptions](api-endpoint:WebhookSubscriptions-ListWebhookSubscriptions) endpoint.


        Note: if there are errors processing the request, the subscriptions field will not be

        present.'
      x-release-status: PUBLIC
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
          description: Information on errors encountered during the request.
        subscriptions:
          type: array
          items:
            $ref: '#/components/schemas/WebhookSubscription'
          description: The requested list of [Subscription](entity:WebhookSubscription)s.
        cursor:
          type: string
          description: 'The pagination cursor to be used in a subsequent request. If empty,

            this is the final response.


            For more information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).'
      example:
        subscriptions:
        - api_version: '2021-12-15'
          created_at: 2022-01-10 23:29:48 +0000 UTC
          enabled: true
          event_types:
          - payment.created
          - payment.updated
          id: wbhk_b35f6b3145074cf9ad513610786c19d5
          name: Example Webhook Subscription
          notification_url: https://example-webhook-url.com
          updated_at: 2022-01-10 23:29:48 +0000 UTC
    RetrieveWebhookSubscriptionResponse:
      type: object
      description: 'Defines the fields that are included in the response body of

        a request to the [RetrieveWebhookSubscription](api-endpoint:WebhookSubscriptions-RetrieveWebhookSubscription) endpoint.


        Note: if there are errors processing the request, the [Subscription](entity:WebhookSubscription) will not be

        present.'
      x-release-status: PUBLIC
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
          description: Information on errors encountered during the request.
        subscription:
          $ref: '#/components/schemas/WebhookSubscription'
          description: The requested [Subscription](entity:WebhookSubscription).
      example:
        subscription:
          api_version: '2021-12-15'
          created_at: 2022-01-10 23:29:48 +0000 UTC
          enabled: true
          event_types:
          - payment.created
          - payment.updated
          id: wbhk_b35f6b3145074cf9ad513610786c19d5
          name: Example Webhook Subscription
          notification_url: https://example-webhook-url.com
          signature_key: 1k9bIJKCeTmSQwyagtNRLg
          updated_at: 2022-01-10 23:29:48 +0000 UTC
    SubscriptionTestResult:
      type: object
      description: 'Represents the details of a webhook subscription, including notification URL,

        event types, and signature key.'
      x-release-status: PUBLIC
      properties:
        id:
          type: string
          description: A Square-generated unique ID for the subscription test result.
          maxLength: 64
          readOnly: true
        status_code:
          type:
          - integer
          - 'null'
          description: The status code returned by the subscription notification URL.
        payload:
          type:
          - string
          - 'null'
          description: An object containing the payload of the test event. For example, a `payment.created` event.
        created_at:
          type: string
          description: "The timestamp of when the subscription was created, in RFC 3339 format. \nFor example, \"2016-09-04T23:59:33.123Z\"."
          readOnly: true
        updated_at:
          type: string
          description: 'The timestamp of when the subscription was updated, in RFC 3339 format. For example, "2016-09-04T23:59:33.123Z".

            Because a subscription test result is unique, this field is the same as the `created_at` field.'
          readOnly: true
    UpdateWebhookSubscriptionResponse:
      type: object
      description: 'Defines the fields that are included in the response body of

        a request to the [UpdateWebhookSubscription](api-endpoint:WebhookSubscriptions-UpdateWebhookSubscription) endpoint.


        Note: If there are errors processing the request, the [Subscription](entity:WebhookSubscription) is not

        present.'
      x-release-status: PUBLIC
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
          description: Information on errors encountered during the request.
        subscription:
          $ref: '#/components/schemas/WebhookSubscription'
          description: The updated [Subscription](entity:WebhookSubscription).
      example:
        subscription:
          api_version: '2021-12-15'
          created_at: 2022-01-10 23:29:48 +0000 UTC
          enabled: false
          event_types:
          - payment.created
          - payment.updated
          id: wbhk_b35f6b3145074cf9ad513610786c19d5
          name: Updated Example Webhook Subscription
          notification_url: https://example-webhook-url.com
          updated_at: 2022-01-10 23:45:51 +0000 UTC
    SortOrder:
      type: string
      enum:
      - DESC
      - ASC
      x-enum-elements:
      - name: DESC
        description: The results are returned in descending (e.g., newest-first or Z-A) order.
      - name: ASC
        description: The results are returned in ascending (e.g., oldest-first or A-Z) order.
      description: The order (e.g., chronological or alphabetical) in which results from a request are returned.
      x-release-status: PUBLIC
    ListWebhookEventTypesResponse:
      type: object
      description: 'Defines the fields that are included in the response body of

        a request to the [ListWebhookEventTypes](api-endpoint:WebhookSubscriptions-ListWebhookEventTypes) endpoint.


        Note: if there are errors processing the request, the event types field will not be

        present.'
      x-release-status: PUBLIC
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
          description: Information on errors encountered during the request.
        event_types:
          type: array
          items:
            type: string
          description: The list of event types.
        metadata:
          type: array
          items:
            $ref: '#/components/schemas/EventTypeMetadata'
          description: Contains the metadata of a webhook event type. For more information, see [EventTypeMetadata](entity:EventTypeMetadata).
      example:
        event_types:
        - inventory.count.updated
        metadata:
        - api_version_introduced: '2018-07-12'
          event_type: inventory.count.updated
          release_status: PUBLIC
    CreateWebhookSubscriptionRequest:
      type: object
      description: Creates a [Subscription](entity:WebhookSubscription).
      x-release-status: PUBLIC
      required:
      - subscription
      properties:
        idempotency_key:
          type: string
          description: A unique string that identifies the [CreateWebhookSubscription](api-endpoint:WebhookSubscriptions-CreateWebhookSubscription) request.
          maxLength: 45
        subscription:
          $ref: '#/components/schemas/WebhookSubscription'
          description: The [Subscription](entity:WebhookSubscription) to create.
      example:
        idempotency_key: 63f84c6c-2200-4c99-846c-2670a1311fbf
        subscription:
          api_version: '2021-12-15'
          event_types:
          - payment.created
          - payment.updated
          name: Example Webhook Subscription
          notification_url: https://example-webhook-url.com
    UpdateWebhookSubscriptionSignatureKeyRequest:
      type: object
      description: Updates a [Subscription](entity:WebhookSubscription) by replacing the existing signature key with a new one.
      x-release-status: PUBLIC
      properties:
        idempotency_key:
          type:
          - string
          - 'null'
          description: A unique string that identifies the [UpdateWebhookSubscriptionSignatureKey](api-endpoint:WebhookSubscriptions-UpdateWebhookSubscriptionSignatureKey) request.
          maxLength: 45
      example:
        idempotency_key: ed80ae6b-0654-473b-bbab-a39aee89a60d
    TestWebhookSubscriptionRequest:
      type: object
      description: Tests a [Subscription](entity:WebhookSubscription) by sending a test event to its notification URL.
      x-release-status: PUBLIC
      properties:
        event_type:
          type:
          - string
          - 'null'
          description: 'The event type that will be used to test the [Subscription](entity:WebhookSubscription). The event type must be

            contained in the list of event types in the [Subscription](entity:WebhookSubscription).'
      example:
        event_type: payment.created
    UpdateWebhookSubscriptionRequest:
      type: object
      description: Updates a [Subscription](entity:WebhookSubscription).
      x-release-status: PUBLIC
      properties:
        subscription:
          $ref: '#/components/schemas/WebhookSubscription'
          description: The [Subscription](entity:WebhookSubscription) to update.
      example:
        subscription:
          enabled: false
          name: Updated Example Webhook Subscription
    Error:
      type: object
      description: 'Represents an error encountered during a request to the Connect API.


        See [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) for more information.'
      x-release-status: PUBLIC
      required:
      - category
      - code
      properties:
        category:
          $ref: '#/components/schemas/ErrorCategory'
          description: 'The high-level category for the error.

            See [ErrorCategory](#type-errorcategory) for possible values'
        code:
          $ref: '#/components/schemas/ErrorCode'
          description: 'The specific code of the error.

            See [ErrorCode](#type-errorcode) for possible values'
        detail:
          type: string
          description: A human-readable description of the error for debugging purposes.
        field:
          type: string
          description: 'The name of the field provided in the original request (if any) that

            the error pertains to.'
    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 provided client has been disabled.
        error-category: AUTHENTICATION_ERROR
      - name: FORBIDDEN
        description: A general access error occurred.
        error-c

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