Square GiftCardActivities API

openapi: 3.2.0
info:
  version: '2.0'
  title: Square ApplePay Gift Card Activities 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: GiftCardActivities
paths:
  /v2/gift-cards/activities:
    get:
      tags:
      - GiftCardActivities
      summary: Square List Gift Card Activities
      operationId: ListGiftCardActivities
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Lists gift card activities. By default, you get gift card activities for all

        gift cards in the seller''s account. You can optionally specify query parameters to

        filter the list. For example, you can get a list of gift card activities for a gift card,

        for all gift cards in a specific region, or for activities within a time window.'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - GIFTCARDS_READ
      parameters:
      - name: gift_card_id
        description: "If a gift card ID is provided, the endpoint returns activities related \nto the specified gift card. Otherwise, the endpoint returns all gift card activities for \nthe seller."
        schema:
          type: string
        in: query
        required: false
      - name: type
        description: "If a [type](entity:GiftCardActivityType) is provided, the endpoint returns gift card activities of the specified type. \nOtherwise, the endpoint returns all types of gift card activities."
        schema:
          type: string
        in: query
        required: false
      - name: location_id
        description: "If a location ID is provided, the endpoint returns gift card activities for the specified location. \nOtherwise, the endpoint returns gift card activities for all locations."
        schema:
          type: string
        in: query
        required: false
      - name: begin_time
        description: 'The timestamp for the beginning of the reporting period, in RFC 3339 format.

          This start time is inclusive. The default value is the current time minus one year.'
        schema:
          type: string
        in: query
        required: false
      - name: end_time
        description: 'The timestamp for the end of the reporting period, in RFC 3339 format.

          This end time is inclusive. The default value is the current time.'
        schema:
          type: string
        in: query
        required: false
      - name: limit
        description: "If a limit is provided, the endpoint returns the specified number \nof results (or fewer) per page. The maximum value is 100. The default value is 50.\nFor more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination)."
        schema:
          type: integer
        in: query
        required: false
      - 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/working-with-apis/pagination).'
        schema:
          type: string
        in: query
        required: false
      - name: sort_order
        description: 'The order in which the endpoint returns the activities, based on `created_at`.

          - `ASC` - Oldest to newest.

          - `DESC` - Newest to oldest (default).'
        schema:
          type: string
        in: query
        required: false
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListGiftCardActivitiesResponse'
    post:
      tags:
      - GiftCardActivities
      summary: Square Create Gift Card Activity
      operationId: CreateGiftCardActivity
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      description: 'Creates a gift card activity to manage the balance or state of a [gift card](entity:GiftCard).

        For example, create an `ACTIVATE` activity to activate a gift card with an initial balance before first use.'
      x-release-status: PUBLIC
      security:
      - oauth2:
        - GIFTCARDS_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/CreateGiftCardActivityRequest'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateGiftCardActivityResponse'
      x-endpoint-errors:
      - error-code: INSUFFICIENT_FUNDS
      - error-code: PAYMENT_LIMIT_EXCEEDED
      - error-code: REFUND_AMOUNT_INVALID
      - error-code: TEMPORARY_ERROR
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
    GiftCardActivity:
      type: object
      description: "Represents an action performed on a [gift card](entity:GiftCard) that affects its state or balance. \nA gift card activity contains information about a specific activity type. For example, a `REDEEM` activity\nincludes a `redeem_activity_details` field that contains information about the redemption."
      x-release-status: PUBLIC
      required:
      - type
      - location_id
      properties:
        id:
          type: string
          description: The Square-assigned ID of the gift card activity.
          readOnly: true
        type:
          $ref: '#/components/schemas/GiftCardActivityType'
          description: 'The type of gift card activity.

            See [Type](#type-type) for possible values'
        location_id:
          type: string
          description: The ID of the [business location](entity:Location) where the activity occurred.
        created_at:
          type: string
          description: The timestamp when the gift card activity was created, in RFC 3339 format.
          readOnly: true
        gift_card_id:
          type:
          - string
          - 'null'
          description: "The gift card ID. When creating a gift card activity, `gift_card_id` is not required if \n`gift_card_gan` is specified."
        gift_card_gan:
          type:
          - string
          - 'null'
          description: "The gift card account number (GAN). When creating a gift card activity, `gift_card_gan` \nis not required if `gift_card_id` is specified."
        gift_card_balance_money:
          $ref: '#/components/schemas/Money'
          description: The final balance on the gift card after the action is completed.
          readOnly: true
        load_activity_details:
          $ref: '#/components/schemas/GiftCardActivityLoad'
          description: Additional details about a `LOAD` activity, which is used to reload money onto a gift card.
        activate_activity_details:
          $ref: '#/components/schemas/GiftCardActivityActivate'
          description: "Additional details about an `ACTIVATE` activity, which is used to activate a gift card with \nan initial balance."
        redeem_activity_details:
          $ref: '#/components/schemas/GiftCardActivityRedeem'
          description: "Additional details about a `REDEEM` activity, which is used to redeem a gift card for a purchase.\n\nFor applications that process payments using the Square Payments API, Square creates a `REDEEM` activity that \nupdates the gift card balance after the corresponding [CreatePayment](api-endpoint:Payments-CreatePayment) \nrequest is completed. Applications that use a custom payment processing system must call \n[CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) to create the `REDEEM` activity."
        clear_balance_activity_details:
          $ref: '#/components/schemas/GiftCardActivityClearBalance'
          description: Additional details about a `CLEAR_BALANCE` activity, which is used to set the balance of a gift card to zero.
        deactivate_activity_details:
          $ref: '#/components/schemas/GiftCardActivityDeactivate'
          description: Additional details about a `DEACTIVATE` activity, which is used to deactivate a gift card.
        adjust_increment_activity_details:
          $ref: '#/components/schemas/GiftCardActivityAdjustIncrement'
          description: "Additional details about an `ADJUST_INCREMENT` activity, which is used to add money to a gift card \noutside of a typical `ACTIVATE`, `LOAD`, or `REFUND` activity flow."
        adjust_decrement_activity_details:
          $ref: '#/components/schemas/GiftCardActivityAdjustDecrement'
          description: "Additional details about an `ADJUST_DECREMENT` activity, which is used to deduct money from a gift \ncard outside of a typical `REDEEM` activity flow."
        refund_activity_details:
          $ref: '#/components/schemas/GiftCardActivityRefund'
          description: "Additional details about a `REFUND` activity, which is used to add money to a gift card when \nrefunding a payment.\n\nFor applications that refund payments to a gift card using the Square Refunds API, Square automatically\ncreates a `REFUND` activity that updates the gift card balance after a [RefundPayment](api-endpoint:Refunds-RefundPayment)\nrequest is completed. Applications that use a custom processing system must call\n[CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) to create the `REFUND` activity."
        unlinked_activity_refund_activity_details:
          $ref: '#/components/schemas/GiftCardActivityUnlinkedActivityRefund'
          description: "Additional details about an `UNLINKED_ACTIVITY_REFUND` activity. This activity is used to add money \nto a gift card when refunding a payment that was processed using a custom payment processing system\nand not linked to the gift card."
        import_activity_details:
          $ref: '#/components/schemas/GiftCardActivityImport'
          description: "Additional details about an `IMPORT` activity, which Square uses to import a third-party \ngift card with a balance."
          readOnly: true
        block_activity_details:
          $ref: '#/components/schemas/GiftCardActivityBlock'
          description: Additional details about a `BLOCK` activity, which Square uses to temporarily block a gift card.
          readOnly: true
        unblock_activity_details:
          $ref: '#/components/schemas/GiftCardActivityUnblock'
          description: Additional details about an `UNBLOCK` activity, which Square uses to unblock a gift card.
          readOnly: true
        import_reversal_activity_details:
          $ref: '#/components/schemas/GiftCardActivityImportReversal'
          description: "Additional details about an `IMPORT_REVERSAL` activity, which Square uses to reverse the \nimport of a third-party gift card."
          readOnly: true
        transfer_balance_to_activity_details:
          $ref: '#/components/schemas/GiftCardActivityTransferBalanceTo'
          description: 'Additional details about a `TRANSFER_BALANCE_TO` activity, which Square uses to add money to

            a gift card as the result of a transfer from another gift card.'
          readOnly: true
        transfer_balance_from_activity_details:
          $ref: '#/components/schemas/GiftCardActivityTransferBalanceFrom'
          description: 'Additional details about a `TRANSFER_BALANCE_FROM` activity, which Square uses to deduct money from

            a gift as the result of a transfer to another gift card.'
          readOnly: true
    ListGiftCardActivitiesResponse:
      type: object
      description: "A response that contains a list of `GiftCardActivity` objects. If the request resulted in errors, \nthe response contains a set of `Error` objects."
      x-release-status: PUBLIC
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
          description: Any errors that occurred during the request.
        gift_card_activities:
          type: array
          items:
            $ref: '#/components/schemas/GiftCardActivity'
          description: The requested gift card activities or an empty object if none are found.
        cursor:
          type: string
          description: 'When a response is truncated, it includes a cursor that you can use in a

            subsequent request to retrieve the next set of activities. If a cursor is not present, this is

            the final response.

            For more information, see [Pagination](https://developer.squareup.com/docs/working-with-apis/pagination).'
      example:
        gift_card_activities:
        - created_at: '2021-06-02T22:26:38.000Z'
          gift_card_balance_money:
            amount: 700
            currency: USD
          gift_card_gan: '7783320002929081'
          gift_card_id: gftc:6d55a72470d940c6ba09c0ab8ad08d20
          id: gcact_897698f894b44b3db46c6147e26a0e19
          location_id: 81FN9BNFZTKS4
          payment_id: dEv2eksNPy6GqdYiLe4ZBNk6HqXZY
          redeem_activity_details:
            amount_money:
              amount: 300
              currency: USD
          status: COMPLETED
          type: REDEEM
        - activate_activity_details:
            amount_money:
              amount: 1000
              currency: USD
            line_item_uid: eIWl7X0nMuO9Ewbh0ChIx
            order_id: jJNGHm4gLI6XkFbwtiSLqK72KkAZY
          created_at: '2021-05-20T22:26:54.000Z'
          gift_card_balance_money:
            amount: 1000
            currency: USD
          gift_card_gan: '7783320002929081'
          gift_card_id: gftc:6d55a72470d940c6ba09c0ab8ad08d20
          id: gcact_b968ebfc7d46437b945be7b9e09123b4
          location_id: 81FN9BNFZTKS4
          type: ACTIVATE
    GiftCardActivityAdjustDecrementReason:
      type: string
      enum:
      - SUSPICIOUS_ACTIVITY
      - BALANCE_ACCIDENTALLY_INCREASED
      - SUPPORT_ISSUE
      - PURCHASE_WAS_REFUNDED
      x-enum-elements:
      - name: SUSPICIOUS_ACTIVITY
        description: 'The balance was decreased because the seller detected suspicious or fraudulent activity

          on the gift card.'
      - name: BALANCE_ACCIDENTALLY_INCREASED
        description: The balance was decreased to reverse an unintentional balance increase.
      - name: SUPPORT_ISSUE
        description: The balance was decreased to accommodate support issues.
      - name: PURCHASE_WAS_REFUNDED
        description: 'The balance was decreased because the order used to purchase or reload the

          gift card was refunded.'
      description: Indicates the reason for deducting money from a [gift card](entity:GiftCard).
      x-release-status: PUBLIC
    GiftCardActivityImport:
      type: object
      description: "Represents details about an `IMPORT` [gift card activity type](entity:GiftCardActivityType).\nThis activity type is used when Square imports a third-party gift card, in which case the \n`gan_source` of the gift card is set to `OTHER`."
      x-release-status: PUBLIC
      required:
      - amount_money
      properties:
        amount_money:
          $ref: '#/components/schemas/Money'
          description: The balance amount on the imported gift card.
    GiftCardActivityDeactivate:
      type: object
      description: Represents details about a `DEACTIVATE` [gift card activity type](entity:GiftCardActivityType).
      x-release-status: PUBLIC
      required:
      - reason
      properties:
        reason:
          $ref: '#/components/schemas/GiftCardActivityDeactivateReason'
          description: 'The reason the gift card was deactivated.

            See [Reason](#type-reason) for possible values'
    GiftCardActivityRefund:
      type: object
      description: Represents details about a `REFUND` [gift card activity type](entity:GiftCardActivityType).
      x-release-status: PUBLIC
      properties:
        redeem_activity_id:
          type:
          - string
          - 'null'
          description: "The ID of the refunded `REDEEM` gift card activity. Square populates this field if the \n`payment_id` in the corresponding [RefundPayment](api-endpoint:Refunds-RefundPayment) request \nrepresents a gift card redemption.\n\nFor applications that use a custom payment processing system, this field is required when creating\na `REFUND` activity. The provided `REDEEM` activity ID must be linked to the same gift card."
        amount_money:
          $ref: '#/components/schemas/Money'
          description: 'The amount added to the gift card for the refund. This value is a positive integer.


            This field is required when creating a `REFUND` activity. The amount can represent a full or partial refund.'
        reference_id:
          type:
          - string
          - 'null'
          description: A client-specified ID that associates the gift card activity with an entity in another system.
        payment_id:
          type: string
          description: "The ID of the refunded payment. Square popul

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