Gift Cards API

You are viewing an old version of the API

2023-01-19

Version 2023-01-19

• All Versions

Gift Cards API

Retrieve gift card from nonce

Request Body

Example code

Name	Description
nonce string Required	The payment token of the gift card to retrieve. Payment tokens are generated by the Web Payments SDK or In-App Payments SDK. Min Length 1

Response Fields

Name	Description
errors Error [ ]	Any errors that occurred during the request. Show Attributes
gift_card GiftCard	The retrieved gift card. Show Attributes

curl https://connect.squareup.com/v2/gift-cards/from-nonce \
  -X POST \
  -H 'Square-Version: 2023-01-19' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "nonce": "cnon:7783322135245171"
  }'

{
  "gift_card": {
    "id": "gftc:6944163553804e439d89adb47caf806a",
    "type": "DIGITAL",
    "gan_source": "SQUARE",
    "state": "ACTIVE",
    "balance_money": {
      "amount": 5000,
      "currency": "USD"
    },
    "gan": "7783320001001635",
    "created_at": "2021-05-20T22:26:54.000Z"
  }
}

{
  "errors": [
    {
      "code": "CARD_TOKEN_USED",
      "category": "INVALID_REQUEST_ERROR"
    }
  ]
}