Gift Cards

Gift card purchases and redemption.

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

typestring · enumRequiredPossible values:

ganstringRequired

Gift card number (GAN)

Example: 5583322479824135

Responses

200

Preview or redeem a gift card

application/json

idstringRequired

Gift card ID

Example: gftc:48e4987649464ccf801948f6bf23b10j

ganstringRequired

Gift card number (GAN)

Example: 5583322479824135

typestring · enumRequired

Gift card request type

Example: PREVIEWPossible values:

balancenumberRequired

Current gift card balance in dollars

Example: 100

amountnumberRequired

Amount requested gift card in dollars

Example: 100

statusstring · enumRequired

Gift card status

Example: ACTIVEPossible values:

currencystringRequired

Currency code

Example: USD

providerstring · enumRequired

Gift card provider

Example: SQUAREPossible values:

422

Unprocessable entity

application/json

post/gift-cards/redeem

POST /apis/v2/gift-cards/redeem HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "type": "PREVIEW",
  "gan": "5583322479824135"
}

{
  "id": "gftc:48e4987649464ccf801948f6bf23b10j",
  "gan": "5583322479824135",
  "type": "PREVIEW",
  "balance": 100,
  "amount": 100,
  "status": "ACTIVE",
  "currency": "USD",
  "errors": [
    {
      "code": "text",
      "message": "text",
      "details": {}
    }
  ],
  "provider": "SQUARE"
}