Square Checkout API

openapi: 3.2.0
info:
  version: '2.0'
  title: Square ApplePay Checkout 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: Checkout
paths:
  /v2/locations/{location_id}/checkouts:
    post:
      tags:
      - Checkout
      summary: Square Create Checkout
      operationId: CreateCheckout
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: "Links a `checkoutId` to a `checkout_page_url` that customers are\ndirected to in order to provide their payment information using a\npayment processing workflow hosted on connect.squareup.com. \n\n\nNOTE: The Checkout API has been updated with new features. \nFor more information, see [Checkout API highlights](https://developer.squareup.com/docs/checkout-api#checkout-api-highlights)."
      x-release-status: DEPRECATED
      deprecated: true
      x-deprecation:
        deprecationDate: '2022-08-17'
        retirementDate: TBD
        replacedBy: CreatePaymentLink
        guideUrl: https://developer.squareup.com/docs/migrate-from-v1/guides/v1-checkout
      security:
      - oauth2:
        - PAYMENTS_WRITE
        - ORDERS_WRITE
      parameters:
      - name: location_id
        description: The ID of the business location to associate the checkout with.
        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/CreateCheckoutRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCheckoutResponse'
      x-endpoint-errors:
      - error-code: AMOUNT_TOO_HIGH
      - error-code: CARD_PROCESSING_NOT_ENABLED
      - error-code: ORDER_EXPIRED
  /v2/online-checkout/location-settings/{location_id}:
    get:
      tags:
      - Checkout
      summary: Square Retrieve Location Settings
      operationId: RetrieveLocationSettings
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Retrieves the location-level settings for a Square-hosted checkout page.
      x-release-status: BETA
      security:
      - oauth2:
        - MERCHANT_PROFILE_READ
      parameters:
      - name: location_id
        description: The ID of the location for which to retrieve settings.
        schema:
          type: string
        in: path
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveLocationSettingsResponse'
    put:
      tags:
      - Checkout
      summary: Square Update Location Settings
      operationId: UpdateLocationSettings
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Updates the location-level settings for a Square-hosted checkout page.
      x-release-status: BETA
      security:
      - oauth2:
        - MERCHANT_PROFILE_WRITE
        - MERCHANT_PROFILE_READ
      parameters:
      - name: location_id
        description: The ID of the location for which to retrieve settings.
        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/UpdateLocationSettingsRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateLocationSettingsResponse'
  /v2/online-checkout/merchant-settings:
    get:
      tags:
      - Checkout
      summary: Square Retrieve Merchant Settings
      operationId: RetrieveMerchantSettings
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Retrieves the merchant-level settings for a Square-hosted checkout page.
      x-release-status: BETA
      security:
      - oauth2:
        - PAYMENT_METHODS_READ
        - MERCHANT_PROFILE_READ
      parameters: []
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrieveMerchantSettingsResponse'
    put:
      tags:
      - Checkout
      summary: Square Update Merchant Settings
      operationId: UpdateMerchantSettings
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Updates the merchant-level settings for a Square-hosted checkout page.
      x-release-status: BETA
      security:
      - oauth2:
        - MERCHANT_PROFILE_WRITE
        - PAYMENT_METHODS_READ
        - MERCHANT_PROFILE_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/UpdateMerchantSettingsRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateMerchantSettingsResponse'
  /v2/online-checkout/payment-links:
    get:
      tags:
      - Checkout
      summary: Square List Payment Links
      operationId: ListPaymentLinks
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Lists all payment links.
      x-release-status: PUBLIC
      security:
      - oauth2:
        - ORDERS_READ
      parameters:
      - name: cursor
        description: 'A pagination cursor returned by a previous call to this endpoint.

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

          If a cursor is not provided, the endpoint returns the first page of the results.

          For more  information, see [Pagination](https://developer.squareup.com/docs/build-basics/common-api-patterns/pagination).'
        schema:
          type: string
        in: query
        required: false
      - name: limit
        description: 'A limit on the number of results to return per page. The limit is advisory and

          the implementation might return more or less results. If the supplied limit is negative, zero, or

          greater than the maximum limit of 1000, it is ignored.


          Default value: `100`'
        schema:
          type: integer
        in: query
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListPaymentLinksResponse'
    post:
      tags:
      - Checkout
      summary: Square Create Payment Link
      operationId: CreatePaymentLink
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Creates a Square-hosted checkout page. Applications can share the resulting payment link with their buyer to pay for goods and services.
      x-release-status: PUBLIC
      security:
      - oauth2:
        - PAYMENTS_WRITE
        - ORDERS_READ
        - ORDERS_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/CreatePaymentLinkRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreatePaymentLinkResponse'
      x-endpoint-errors:
      - error-code: INVALID_PHONE_NUMBER
      - error-code: INVALID_EMAIL_ADDRESS
      - error-code: MISSING_REQUIRED_PARAMETER
      - error-code: CONFLICTING_PARAMETERS
  /v2/online-checkout/payment-links/{id}:
    delete:
      tags:
      - Checkout
      summary: Square Delete Payment Link
      operationId: DeletePaymentLink
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Deletes a payment link.
      x-release-status: PUBLIC
      security:
      - oauth2:
        - ORDERS_READ
        - ORDERS_WRITE
      parameters:
      - name: id
        description: The ID of the payment link to delete.
        schema:
          type: string
        in: path
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeletePaymentLinkResponse'
    get:
      tags:
      - Checkout
      summary: Square Retrieve Payment Link
      operationId: RetrievePaymentLink
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: Retrieves a payment link.
      x-release-status: PUBLIC
      security:
      - oauth2:
        - ORDERS_READ
      parameters:
      - name: id
        description: The ID of link to retrieve.
        schema:
          type: string
        in: path
        required: true
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RetrievePaymentLinkResponse'
    put:
      tags:
      - Checkout
      summary: Square Update Payment Link
      operationId: UpdatePaymentLink
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Updates a payment link. You can update the `payment_link` fields such as

        `description`, `checkout_options`, and  `pre_populated_data`.

        You cannot update other fields such as the `order_id`, `version`, `URL`, or `timestamp` field.'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - PAYMENTS_WRITE
        - ORDERS_READ
        - ORDERS_WRITE
      parameters:
      - name: id
        description: The ID of the payment link 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/UpdatePaymentLinkRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdatePaymentLinkResponse'
      x-endpoint-errors:
      - error-code: INVALID_PHONE_NUMBER
      - error-code: INVALID_EMAIL_ADDRESS
components:
  schemas:
    Currency:
      type: string
      enum:
      - UNKNOWN_CURRENCY
      - AED
      - AFN
      - ALL
      - AMD
      - ANG
      - AOA
      - ARS
      - AUD
      - AWG
      - AZN
      - BAM
      - BBD
      - BDT
      - BGN
      - BHD
      - BIF
      - BMD
      - BND
      - BOB
      - BOV
      - BRL
      - BSD
      - BTN
      - BWP
      - BYR
      - BZD
      - CAD
      - CDF
      - CHE
      - CHF
      - CHW
      - CLF
      - CLP
      - CNY
      - COP
      - COU
      - CRC
      - CUC
      - CUP
      - CVE
      - CZK
      - DJF
      - DKK
      - DOP
      - DZD
      - EGP
      - ERN
      - ETB
      - EUR
      - FJD
      - FKP
      - GBP
      - GEL
      - GHS
      - GIP
      - GMD
      - GNF
      - GTQ
      - GYD
      - HKD
      - HNL
      - HRK
      - HTG
      - HUF
      - IDR
      - ILS
      - INR
      - IQD
      - IRR
      - ISK
      - JMD
      - JOD
      - JPY
      - KES
      - KGS
      - KHR
      - KMF
      - KPW
      - KRW
      - KWD
      - KYD
      - KZT
      - LAK
      - LBP
      - LKR
      - LRD
      - LSL
      - LTL
      - LVL
      - LYD
      - MAD
      - MDL
      - MGA
      - MKD
      - MMK
      - MNT
      - MOP
      - MRO
      - MUR
      - MVR
      - MWK
      - MXN
      - MXV
      - MYR
      - MZN
      - NAD
      - NGN
      - NIO
      - NOK
      - NPR
      - NZD
      - OMR
      - PAB
      - PEN
      - PGK
      - PHP
      - PKR
      - PLN
      - PYG
      - QAR
      - RON
      - RSD
      - RUB
      - RWF
      - SAR
      - SBD
      - SCR
      - SDG
      - SEK
      - SGD
      - SHP
      - SLL
      - SLE
      - SOS
      - SRD
      - SSP
      - STD
      - SVC
      - SYP
      - SZL
      - THB
      - TJS
      - TMT
      - TND
      - TOP
      - TRY
      - TTD
      - TWD
      - TZS
      - UAH
      - UGX
      - USD
      - USN
      - USS
      - UYI
      - UYU
      - UZS
      - VEF
      - VND
      - VUV
      - WST
      - XAF
      - XAG
      - XAU
      - XBA
      - XBB
      - XBC
      - XBD
      - XCD
      - XDR
      - XOF
      - XPD
      - XPF
      - XPT
      - XTS
      - XXX
      - YER
      - ZAR
      - ZMK
      - ZMW
      - BTC
      - XUS
      x-enum-elements:
      - name: UNKNOWN_CURRENCY
        description: Unknown currency
      - name: AED
        description: United Arab Emirates dirham
      - name: AFN
        description: Afghan afghani
      - name: ALL
        description: Albanian lek
      - name: AMD
        description: Armenian dram
      - name: ANG
        description: Netherlands Antillean guilder
      - name: AOA
        description: Angolan kwanza
      - name: ARS
        description: Argentine peso
      - name: AUD
        description: Australian dollar
      - name: AWG
        description: Aruban florin
      - name: AZN
        description: Azerbaijani manat
      - name: BAM
        description: Bosnia and Herzegovina convertible mark
      - name: BBD
        description: Barbados dollar
      - name: BDT
        description: Bangladeshi taka
      - name: BGN
        description: Bulgarian lev
      - name: BHD
        description: Bahraini dinar
      - name: BIF
        description: Burundian franc
      - name: BMD
        description: Bermudian dollar
      - name: BND
        description: Brunei dollar
      - name: BOB
        description: Boliviano
      - name: BOV
        description: Bolivian Mvdol
      - name: BRL
        description: Brazilian real
      - name: BSD
        description: Bahamian dollar
      - name: BTN
        description: Bhutanese ngultrum
      - name: BWP
        description: Botswana pula
      - name: BYR
        description: Belarusian ruble
      - name: BZD
        description: Belize dollar
      - name: CAD
        description: Canadian dollar
      - name: CDF
        description: Congolese franc
      - name: CHE
        description: WIR Euro
      - name: CHF
        description: Swiss franc
      - name: CHW
        description: WIR Franc
      - name: CLF
        description: Unidad de Fomento
      - name: CLP
        description: Chilean peso
      - name: CNY
        description: Chinese yuan
      - name: COP
        description: Colombian peso
      - name: COU
        description: Unidad de Valor Real
      - name: CRC
        description: Costa Rican colon
      - name: CUC
        description: Cuban convertible peso
      - name: CUP
        description: Cuban peso
      - name: CVE
        description: Cape Verdean escudo
      - name: CZK
        description: Czech koruna
      - name: DJF
        description: Djiboutian franc
      - name: DKK
        description: Danish krone
      - name: DOP
        description: Dominican peso
      - name: DZD
        description: Algerian dinar
      - name: EGP
        description: Egyptian pound
      - name: ERN
        description: Eritrean nakfa
      - name: ETB
        description: Ethiopian birr
      - name: EUR
        description: Euro
      - name: FJD
        description: Fiji dollar
      - name: FKP
        description: Falkland Islands pound
      - name: GBP
        description: Pound sterling
      - name: GEL
        description: Georgian lari
      - name: GHS
        description: Ghanaian cedi
      - name: GIP
        description: Gibraltar pound
      - name: GMD
        description: Gambian dalasi
      - name: GNF
        description: Guinean franc
      - name: GTQ
        description: Guatemalan quetzal
      - name: GYD
        description: Guyanese dollar
      - name: HKD
        description: Hong Kong dollar
      - name: HNL
        description: Honduran lempira
      - name: HRK
        description: Croatian kuna
      - name: HTG
        description: Haitian gourde
      - name: HUF
        description: Hungarian forint
      - name: IDR
        description: Indonesian rupiah
      - name: ILS
        description: Israeli new shekel
      - name: INR
        description: Indian rupee
      - name: IQD
        description: Iraqi dinar
      - name: IRR
        description: Iranian rial
      - name: ISK
        description: Icelandic króna
      - name: JMD
        description: Jamaican dollar
      - name: JOD
        description: Jordanian dinar
      - name: JPY
        description: Japanese yen
      - name: KES
        description: Kenyan shilling
      - name: KGS
        description: Kyrgyzstani som
      - name: KHR
        description: Cambodian riel
      - name: KMF
        description: Comoro franc
      - name: KPW
        description: North Korean won
      - name: KRW
        description: South Korean won
      - name: KWD
        description: Kuwaiti dinar
      - name: KYD
        description: Cayman Islands dollar
      - name: KZT
        description: Kazakhstani tenge
      - name: LAK
        description: Lao kip
      - name: LBP
        description: Lebanese pound
      - name: LKR
        description: Sri Lankan rupee
      - name: LRD
        description: Liberian dollar
      - name: LSL
        description: Lesotho loti
      - name: LTL
        description: Lithuanian litas
      - name: LVL
        description: Latvian lats
      - name: LYD
        description: Libyan dinar
      - name: MAD
        description: Moroccan dirham
      - name: MDL
        description: Moldovan leu
      - name: MGA
        description: Malagasy ariary
      - name: MKD
        description: Macedonian denar
      - name: MMK
        description: Myanmar kyat
      - name: MNT
        description: Mongolian tögrög
      - name: MOP
        description: Macanese pataca
      - name: MRO
        description: Mauritanian ouguiya
      - name: MUR
        description: Mauritian rupee
      - name: MVR
        description: Maldivian rufiyaa
      - name: MWK
        description: Malawian kwacha
      - name: MXN
        description: Mexican peso
      - name: MXV
        description: Mexican Unidad de Inversion
      - name: MYR
        description: Malaysian ringgit
      - name: MZN
        description: Mozambican metical
      - name: NAD
        description: Namibian dollar
      - name: NGN
        description: Nigerian naira
      - name: NIO
        description: Nicaraguan córdoba
      - name: NOK
        description: Norwegian krone
      - name: NPR
        description: Nepalese rupee
      - name: NZD
        description: New Zealand dollar
      - name: OMR
        description: Omani rial
      - name: PAB
        description: Panamanian balboa
      - name: PEN
        description: Peruvian sol
      - name: PGK
        description: Papua New Guinean kina
      - name: PHP
        description: Philippine peso
      - name: PKR
        description: Pakistani rupee
      - name: PLN
        description: Polish zBoty
      - name: PYG
        description: Paraguayan guaraní
      - name: QAR
        description: Qatari riyal
      - name: RON
        description: Romanian leu
      - name: RSD
        description: Serbian dinar
      - name: RUB
        description: Russian ruble
      - name: RWF
        description: Rwandan franc
      - name: SAR
        description: Saudi riyal
      - name: SBD
        description: Solomon Islands dollar
      - name: SCR
        description: Seychelles rupee
      - name: SDG
        description: Sudanese pound
      - name: SEK
        description: Swedish krona
      - name: SGD
        description: Singapore dollar
      - name: SHP
        description: Saint Helena pound
      - name: SLL
        description: Sierra Leonean first leone
      - name: SLE
        description: Sierra Leonean second leone
      - name: SOS
        description: Somali shilling
      - name: SRD
        description: Surinamese dollar
      - name: SSP
        description: South Sudanese pound
      - name: STD
        description: São Tomé and Príncipe dobra
      - name: SVC
        description: Salvadoran colón
      - name: SYP
        description: Syrian pound
      - name: SZL
        description: Swazi lilangeni
      - name: THB
        description: Thai baht
      - name: TJS
        description: Tajikstani somoni
      - name: TMT
        description: Turkmenistan manat
      - name: TND
        description: Tunisian dinar
      - name: TOP
        description: Tongan pa'anga
      - name: TRY
        description: Turkish lira
      - name: TTD
        description: Trinidad and Tobago dollar
      - name: TWD
        description: New Taiwan dollar
      - name: TZS
        description: Tanzanian shilling
      - name: UAH
        description: Ukrainian hryvnia
      - name: UGX
        description: Ugandan shilling
      - name: USD
        description: United States dollar
      - name: USN
        description: United States dollar (next day)
      - name: USS
        description: United States dollar (same day)
      - name: UYI
        description: Uruguay Peso en Unidedades Indexadas
      - name: UYU
        description: Uruguyan peso
      - name: UZS
        description: Uzbekistan som
      - name: VEF
        description: Venezuelan bolívar soberano
      - name: VND
        description: Vietnamese ’Óng
      - name: VUV
        description: Vanuatu vatu
      - name: WST
        description: Samoan tala
      - name: XAF
        description: CFA franc BEAC
      - name: XAG
        description: Silver
      - name: XAU
        description: Gold
      - name: XBA
        description: European Composite Unit
      - name: XBB
        description: European Monetary Unit
      - name: XBC
        description: European Unit of Account 9
      - name: XBD
        description: European Unit of Account 17
      - name: XCD
        description: East Caribbean dollar
      - name: XDR
        description: Special drawing rights (International Monetary Fund)
      - name: XOF
        description: CFA franc BCEAO
      - name: XPD
        description: Palladium
      - name: XPF
        description: CFP franc
      - name: XPT
        description: Platinum
      - name: XTS
        description: Code reserved for testing
      - name: XXX
        description: No currency
      - name: YER
        description: Yemeni rial
      - name: ZAR
        description: South African rand
      - name: ZMK
        description: Zambian kwacha
      - name: ZMW
        description: Zambian kwacha
      - name: BTC
        description: Bitcoin
      - name: XUS
        description: USD Coin
      description: 'Indicates the associated currency for an amount of money. Values correspond

        to [ISO 4217](https://wikipedia.org/wiki/ISO_4217).'
      x-release-status: PUBLIC
    CatalogTimePeriod:
      type: object
      description: Represents a time period - either a single period or a repeating period.
      x-release-status: PUBLIC
      properties:
        event:
          type:
          - string
          - 'null'
          description: 'An iCalendar (RFC 5545) [event](https://tools.ietf.org/html/rfc5545#section-3.6.1), which

            specifies the name, timing, duration and recurrence of this time period.


            Example:


            ```

            DTSTART:20190707T180000

            DURATION:P2H

            RRULE:FREQ=WEEKLY;BYDAY=MO,WE,FR

            ```


            Only `SUMMARY`, `DTSTART`, `DURATION` and `RRULE` fields are supported.

            `DTSTART` must be in local (unzoned) time format. Note that while `BEGIN:VEVENT`

            and `END:VEVENT` is not required in the request. The response will always

            include them.'
    OrderReturnTip:
      type: object
      description: A tip being returned.
      x-release-status: BETA
      properties:
        uid:
          type:
          - string
          - 'null'
          description: A unique ID that identifies the tip only within this order.
          maxLength: 60
        applied_money:
          $ref: '#/components/schemas/Money'
          description: 'The amount of tip being returned

            --'
          readOnly: true
        source_tender_uid:
          type:
          - string
          - 'null'
          description: The tender `uid` from the order that contains the original application of this tip.
          maxLength: 192
        source_tender_id:
          type:
          - string
          - 'null'
          description: The tender `id` from the order that contains the original application of this tip.
          maxLength: 192
    CatalogItemProductType:
      type: string
      enum:
      - REGULAR
      - GIFT_CARD
      - APPOINTMENTS_SERVICE
      - FOOD_AND_BEV
      - EVENT
      - DIGITAL
      - DONATION
      - LEGACY_SQUARE_ONLINE_SERVICE
      - LEGACY_SQUARE_ONLINE_MEMBERSHIP
      x-enum-elements:
      - name: REGULAR
        description: An ordinary item.
      - name: GIFT_CARD
        description: A Square gift card.
      - name: APPOINTMENTS_SERVICE
        description: A service that can be booked using the Square Appointments app.
      - name: FOOD_AND_BEV
        description: A food or beverage item that can be sold by restaurants and other food venues.
      - name: EVENT
        description: An event which tickets can be sold for, including location, address, and times.
      - name: DIGITAL
        description: A digital item like an ebook or song.
      - name: DONATION
        description: A donation which site visitors can send for any cause.
      - name: LEGACY_SQUARE_ONLINE_SERVICE
        description: A legacy Square Online service that is manually fulfilled. This corresponds to the `Other` item type displayed in the Square Seller Dashboard and Square POS apps.
      - name: LEGACY_SQUARE_ONLINE_MEMBERSHIP
        description: A legacy Square Online membership that is manually fulfilled. This corresponds to the `Membership` item type displayed in the Square Seller Dashboard and Square POS apps.
      description: The type of a CatalogItem. Connect V2 only allows the creation of `REGULAR` or `APPOINTMENTS_SERVICE` items.
      x-release-status: PUBLIC
    CatalogItemVariation:
      type: object
      description: 'An item variation, representing a product for sale, in the Catalog object model. Each [item](entity:CatalogItem) must have at least one

        item variation and can have at most 250 item variations.


        An item variation can be sellable, stockable, or both if it has a unit of measure for its count for the sold number of the variation, the stocked

        number of the variation, or both. For example, when a variation representing wine is stocked and sold by the bottle, the variation is both

        stockable and sellable. But when a variation of the wine is sold by the glass, the sold units cannot be used as a measure of the stocked units. This by-the-glass

        variation is sellable, but not stockable. To accurately keep track of the wine''s inventory count at any time, the sellable count must be

        converted to stockable count. Typically, the seller defines this unit conversion. For example, 1 bottle equals 5 glasses. The Square API exposes

        the `stockable_conversion` property on the variation to specify the conversion. Thus, when two glasses of the wine are sold, the sellable count

        decreases by 2, and the stockable count automatically decreases by 0.4 bottle according to the conversion.'
      x-release-status: PUBLIC
      properties:
        item_id:
          type:
          - string
          - 'null'
          description: The ID of the `CatalogItem` associated with this item variation.
        name:
          type:
          - string
          - 'null'
          description: 'The item variation''s name. This is a searchable attribute for use in applicable query filters.


            Its value has a maximum length of 255 Unicode code points. However, when the parent [item](entity:CatalogItem)

            uses [item options](entity:CatalogItemOption), this attribute is auto-generated, read-only, and can be

            longer than 255 Unicode code points.'
        sku:
          type:
          - string
          - 'null'
          description: The item variation's SKU, if any. This is a searchable attribute for use in applicable query filters.
        upc:
          type:
          - string
          - 'null'
          description: 'The universal product code (UPC) of the item variation, if any. This is a searchable attribute for use in applicable query filters.


            The value of this attribute should be a number of 1

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