Gift Card Configuration

Gift card settings and denominations.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Returns the Gift Card configuration

application/json

squareAccessTokenstringRequired

Square access token for managing gift cards

Example: sq0atp-********

giftCardsBuyLinkstringRequired

Gift cards buy link

Example: https://www.pingpod.com/gift-cards

isEnabledbooleanRequired

Square gift cards are enabled

Example: true

404

Gift Card configuration not found

get/tenants/{tenantId}/integrations/square

GET /apis/v2/tenants/{tenantId}/integrations/square HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "squareAccessToken": "sq0atp-********",
  "giftCardsBuyLink": "https://www.pingpod.com/gift-cards",
  "isEnabled": true
}

patch

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

squareAccessTokenstringOptional

Square access token for managing gift cards

Example: sq0atp-********

giftCardsBuyLinkstringOptional

Gift cards buy link

Example: https://www.pingpod.com/gift-cards

isEnabledbooleanOptional

Square gift cards are enabled

Example: true

Responses

200

Returns the updated Gift Card configuration

application/json

squareAccessTokenstringRequired

Square access token for managing gift cards

Example: sq0atp-********

giftCardsBuyLinkstringRequired

Gift cards buy link

Example: https://www.pingpod.com/gift-cards

isEnabledbooleanRequired

Square gift cards are enabled

Example: true

422

Returns an ErrorDto in case of validation errors or failures.

patch/tenants/{tenantId}/integrations/square

PATCH /apis/v2/tenants/{tenantId}/integrations/square HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 112

{
  "squareAccessToken": "sq0atp-********",
  "giftCardsBuyLink": "https://www.pingpod.com/gift-cards",
  "isEnabled": true
}

{
  "squareAccessToken": "sq0atp-********",
  "giftCardsBuyLink": "https://www.pingpod.com/gift-cards",
  "isEnabled": true
}