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 GiftCards API

The GiftCards API from Square — 6 operation(s) for giftcards.

Square GiftCards 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 Gift Cards. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and an AsyncAPI specification.

This API exposes 7 operations across 6 paths, and defines 21 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.

7 operations 6 paths 21 schemas 2 GET5 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 GiftCards 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 7

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

GiftCards 7
GET
/v2/gift-cards
Square List Gift Cards
ListGiftCards 5 params → 200
POST
/v2/gift-cards
Square Create Gift Card
CreateGiftCard body → 200
POST
/v2/gift-cards/from-gan
Square Retrieve Gift Card from GAN
RetrieveGiftCardFromGAN body → 200
POST
/v2/gift-cards/from-nonce
Square Retrieve Gift Card from Nonce
RetrieveGiftCardFromNonce body → 200
POST
/v2/gift-cards/{gift_card_id}/link-customer
Square Link Customer to Gift Card
LinkCustomerToGiftCard 1 param body → 200
POST
/v2/gift-cards/{gift_card_id}/unlink-customer
Square Unlink Customer from Gift Card
UnlinkCustomerFromGiftCard 1 param body → 200
GET
/v2/gift-cards/{id}
Square Retrieve Gift Card
RetrieveGiftCard 1 param → 200

Schemas 21

The contract defines 21 schemas that model the data the API accepts and returns. The most detailed are GiftCard (8 properties), Error (4 properties), CreateGiftCardRequest (3 properties), ListGiftCardsResponse (3 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).
RetrieveGiftCardFromNonceRequest
object
A request to retrieve a gift card by using a payment token.
1 property 1 required
ListGiftCardsResponse
object
A response that contains a list of GiftCard objects. If the request resulted in errors, the response contains a set of Error objects.
3 properties
LinkCustomerToGiftCardRequest
object
A request to link a customer to a gift card.
1 property 1 required
GiftCardGANSource
string
Indicates the source that generated the gift card account number (GAN).
UnlinkCustomerFromGiftCardRequest
object
A request to unlink a customer from a gift card.
1 property 1 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
CreateGiftCardRequest
object
Represents a [CreateGiftCard](api-endpoint:GiftCards-CreateGiftCard) request.
3 properties 3 required
GiftCardType
string
Indicates the gift card type.
RetrieveGiftCardFromGANResponse
object
A response that contains a GiftCard. This response might contain a set of Error objects if the request resulted in errors.
2 properties
ErrorCategory
string
Indicates which high-level category of error has occurred during a request to the Connect API.
GiftCard
object
Represents a Square gift card.
8 properties 1 required
CreateGiftCardResponse
object
A response that contains a GiftCard. The response might contain a set of Error objects if the request resulted in errors.
2 properties
RetrieveGiftCardFromNonceResponse
object
A response that contains a GiftCard object. If the request resulted in errors, the response contains a set of Error objects.
2 properties
RetrieveGiftCardResponse
object
A response that contains a GiftCard. The response might contain a set of Error objects if the request resulted in errors.
2 properties
UnlinkCustomerFromGiftCardResponse
object
A response that contains the unlinked GiftCard object. If the request resulted in errors, the response contains a set of Error objects.
2 properties
RetrieveGiftCardFromGANRequest
object
A request to retrieve gift cards by their GANs.
1 property 1 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.
LinkCustomerToGiftCardResponse
object
A response that contains the linked GiftCard object. If the request resulted in errors, the response contains a set of Error objects.
2 properties
GiftCardStatus
string
Indicates the gift card state.

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

square-giftcards-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 GiftCards 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.