v1

latestOpenAPI 3.1.02026-07-241080412.6 KB

Verify a gift

Use this endpoint to verify whether a gift code provided by the user is valid. The gift code has to be verified before a gift is redeemed.

get/gifts/{code}/verification

Path parameters

codestring required

A gift code. Min length: 9, max length: 9. Example: 1A2B-3C4D.

Query parameters

customerIpstring required

Customer IP address.

redeemerIdinteger required

The identifier of the person redeeming a gift.

Headers

Content-Typestring

Response

200

redeemableboolean

redeemModestring

{"stackTrail":"paths:/gifts/{code}/verification:get:responses:200:content:application/json:schema:properties:redeemRefusalReason","oasType":"schema","type":"unknown"}

extendedSubscriptionIdinteger

offerIdstring

Example response

{
  "redeemable": true,
  "redeemMode": "EXTEND",
  "extendedSubscriptionId": 123456789,
  "offerId": "S123123123_PL"
}