v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB

GiftCards

RetrieveGiftCardFromNonce

Retrieves a gift card using a secure payment token that represents the gift card.

post/v2/gift-cards/from-nonce

Request body

noncestring required

The payment token of the gift card to retrieve. Payment tokens are generated by the Web Payments SDK or In-App Payments SDK.

Example request

{
  "nonce": "cnon:7783322135245171"
}

Response

Success

Example response

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