How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Square GiftCardActivities API

The GiftCardActivities API from Square — 1 operation(s) for giftcardactivities.

Square GiftCardActivities API is one of 45 APIs that Square publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.

Tagged areas include GiftCardActivities. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 2 operations across 1 path, and defines 32 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://connect.squareup.com.

2 operations 1 paths 32 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Server
https://connect.squareup.com
Authentication
OAuth 2.0, API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 2

Square GiftCardActivities API declares 2 security schemes for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 57 scopes. An API key is passed in the header as Authorization (oauth2ClientSecret).

Paths & Operations 2

Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

GiftCardActivities 2
GET
/v2/gift-cards/activities
Square List Gift Card Activities
ListGiftCardActivities 8 params → 200
POST
/v2/gift-cards/activities
Square Create Gift Card Activity
CreateGiftCardActivity body → 200

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are GiftCardActivity (22 properties), GiftCardActivityLoad (5 properties), GiftCardActivityActivate (5 properties), Error (4 properties). Each schema is shown below with its type and property counts.

Currency
string
Indicates the associated currency for an amount of money. Values correspond to [ISO 4217](https://wikipedia.org/wiki/ISO4217).
GiftCardActivity
object
Represents an action performed on a [gift card](entity:GiftCard) that affects its state or balance. A gift card activity contains information about a specific…
22 properties 2 required
ListGiftCardActivitiesResponse
object
A response that contains a list of GiftCardActivity objects. If the request resulted in errors, the response contains a set of Error objects.
3 properties
GiftCardActivityAdjustDecrementReason
string
Indicates the reason for deducting money from a [gift card](entity:GiftCard).
GiftCardActivityImport
object
Represents details about an IMPORT [gift card activity type](entity:GiftCardActivityType). This activity type is used when Square imports a third-party gift ca…
1 property 1 required
GiftCardActivityDeactivate
object
Represents details about a DEACTIVATE [gift card activity type](entity:GiftCardActivityType).
1 property 1 required
GiftCardActivityRefund
object
Represents details about a REFUND [gift card activity type](entity:GiftCardActivityType).
4 properties
GiftCardActivityClearBalanceReason
string
Indicates the reason for clearing the balance of a [gift card](entity:GiftCard).
GiftCardActivityActivate
object
Represents details about an ACTIVATE [gift card activity type](entity:GiftCardActivityType).
5 properties
GiftCardActivityType
string
Indicates the type of [gift card activity](entity:GiftCardActivity).
GiftCardActivityAdjustIncrementReason
string
Indicates the reason for adding money to a [gift card](entity:GiftCard).
GiftCardActivityAdjustDecrement
object
Represents details about an ADJUSTDECREMENT [gift card activity type](entity:GiftCardActivityType).
2 properties 2 required
Money
object
Represents an amount of money. Money fields can be signed or unsigned. Fields that do not explicitly define whether they are signed or unsigned are considered…
2 properties
GiftCardActivityBlock
object
Represents details about a BLOCK [gift card activity type](entity:GiftCardActivityType).
1 property 1 required
GiftCardActivityRedeem
object
Represents details about a REDEEM [gift card activity type](entity:GiftCardActivityType).
4 properties 1 required
GiftCardActivityDeactivateReason
string
Indicates the reason for deactivating a [gift card](entity:GiftCard).
GiftCardActivityLoad
object
Represents details about a LOAD [gift card activity type](entity:GiftCardActivityType).
5 properties
GiftCardActivityImportReversal
object
Represents details about an IMPORTREVERSAL [gift card activity type](entity:GiftCardActivityType).
1 property 1 required
GiftCardActivityUnlinkedActivityRefund
object
Represents details about an UNLINKEDACTIVITYREFUND [gift card activity type](entity:GiftCardActivityType).
3 properties 1 required
GiftCardActivityAdjustIncrement
object
Represents details about an ADJUSTINCREMENT [gift card activity type](entity:GiftCardActivityType).
2 properties 2 required
CreateGiftCardActivityResponse
object
A response that contains a GiftCardActivity that was created. The response might contain a set of Error objects if the request resulted in errors.
2 properties
GiftCardActivityBlockReason
string
Indicates the reason for blocking a [gift card](entity:GiftCard).
CreateGiftCardActivityRequest
object
A request to create a gift card activity.
2 properties 2 required
GiftCardActivityTransferBalanceFrom
object
Represents details about a TRANSFERBALANCEFROM [gift card activity type](entity:GiftCardActivityType).
2 properties 2 required
Error
object
Represents an error encountered during a request to the Connect API. See [Handling errors](https://developer.squareup.com/docs/build-basics/handling-errors) fo…
4 properties 2 required
ErrorCode
string
Indicates the specific error that occurred during a request to a Square API.
GiftCardActivityUnblockReason
string
Indicates the reason for unblocking a [gift card](entity:GiftCard).
GiftCardActivityClearBalance
object
Represents details about a CLEARBALANCE [gift card activity type](entity:GiftCardActivityType).
1 property 1 required
GiftCardActivityRedeemStatus
string
Indicates the status of a [gift card](entity:GiftCard) redemption. This status is relevant only for redemptions made from Square products (such as Square Point…
GiftCardActivityTransferBalanceTo
object
Represents details about a TRANSFERBALANCETO [gift card activity type](entity:GiftCardActivityType).
2 properties 2 required
GiftCardActivityUnblock
object
Represents details about an UNBLOCK [gift card activity type](entity:GiftCardActivityType).
1 property 1 required
ErrorCategory
string
Indicates which high-level category of error has occurred during a request to the Connect API.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

square-giftcardactivities-api-openapi.yml Raw ↑

Other APIs Square publishes across the network.

Square Reporting API
Square Channels API
Square Transfer Orders API
Square ApplePay API
Square BankAccounts API
Square BookingCustomAttributes API
Square Bookings API
Square Cards API
Square CashDrawers API
Square Catalog API
Square Checkout API
Square CustomerCustomAttributes API
Where this information came from

This is an independent, third-party profile of Square GiftCardActivities API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.